Blame - camera/docs/docs.html - platform_system_media

2013-12-26 12:06:13 -0800

[diff] [blame]

31

.entry_cont { background-color: #f0f0f0 }

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

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; }

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

37

.toc_deprecated { text-decoration:line-through; }

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

38

39

/* table column sizes */

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

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 }

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

42

.th_name { width: 20% }

43

.th_units { width: 10% }

44

.th_tags { width: 5% }

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

45

.th_details { width: 25% }

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

46

.th_type { width: 17% }

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

47

.th_description { width: 20% }

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

48

.th_range { width: 8% }

49

.th_hal_version { width: 5% }

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

50

td { font-size: 0.9em; }

51

52

/* hide the first thead, we need it there only to enforce column sizes */

53

.thead_dummy { visibility: hidden; }

54

55

/* Entry flair */

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

56

.entry_name { color: #333333; padding-left:1.0em; font-size:1.1em; font-family: monospace; vertical-align:top; }

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

57

.entry_name_deprecated { text-decoration:line-through; }

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

58

59

/* Entry type flair */

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

60

.entry_type_name { font-size:1.1em; color: #669900; font-weight: bold;}

61

.entry_type_name_enum:after { color: #669900; font-weight: bold; content:" (enum)" }

62

.entry_type_visibility { font-weight: bolder; padding-left:1em}

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

63

.entry_type_synthetic { font-weight: bolder; color: #996600; }

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

64

.entry_type_hwlevel { font-weight: bolder; color: #000066; }

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

65

.entry_type_deprecated { font-weight: bolder; color: #4D4D4D; }

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

66

.entry_type_enum_name { font-family: monospace; font-weight: bolder; }

67

.entry_type_enum_notes:before { content:" - " }

Igor Murashkin

2014-01-15 17:05:22 -0800

[diff] [blame]

68

.entry_type_enum_notes>p:first-child { display:inline; }

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

69

.entry_type_enum_value:before { content:" = " }

70

.entry_type_enum_value { font-family: monospace; }

71

.entry ul { margin: 0 0 0 0; list-style-position: inside; padding-left: 0.5em; }

72

.entry ul li { padding: 0 0 0 0; margin: 0 0 0 0;}

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

73

.entry_range_deprecated { font-weight: bolder; }

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

74

75

/* Entry tags flair */

76

.entry_tags ul { list-style-type: none; }

77

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

78

/* Entry details (full docs) flair */

79

.entry_details_header { font-weight: bold; background-color: #dddddd;

80

text-align: center; font-size: 1.1em; margin-left: 0em; margin-right: 0em; }

81

82

/* Entry spacer flair */

83

.entry_spacer { background-color: transparent; border-style: none; height: 0.5em; }

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

84

85

/* TODO: generate abbr element for each tag link? */

86

/* TODO for each x.y.z try to link it to the entry */

</style>

<style>

{

/* broken...

supposedly there is a bug in chrome that it lays out tables before

95

it knows its being printed, so the page-break-* styles are ignored

96

*/

97

tr { page-break-after: always; page-break-inside: avoid; }

}

</style>

</head>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

105

<body>

Eino-Ville Talvala

42165c2

2014-03-25 15:20:16 -0700

[diff] [blame]

106

<h1>Android Camera HAL3.2 Properties</h1>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

107

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

108

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

109

<h2>Table of Contents</h2>

110

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

111

112

<li>

113

<a href="#section_colorCorrection">colorCorrection</a>

<li>

controls

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

118

<li

119

><a href="#controls_android.colorCorrection.mode">android.colorCorrection.mode</a></li>

120

<li

121

><a href="#controls_android.colorCorrection.transform">android.colorCorrection.transform</a></li>

122

<li

123

><a href="#controls_android.colorCorrection.gains">android.colorCorrection.gains</a></li>

Zhijun He

2014-07-01 18:27:42 -0700

[diff] [blame]

124

<li

Zhijun He

2014-08-18 10:55:33 -0700

[diff] [blame]

125

><a href="#controls_android.colorCorrection.aberrationMode">android.colorCorrection.aberrationMode</a></li>

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

</ul>

</li>

<li>

dynamic

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

131

<li

132

><a href="#dynamic_android.colorCorrection.mode">android.colorCorrection.mode</a></li>

133

<li

134

><a href="#dynamic_android.colorCorrection.transform">android.colorCorrection.transform</a></li>

135

<li

136

><a href="#dynamic_android.colorCorrection.gains">android.colorCorrection.gains</a></li>

Zhijun He

2014-07-01 18:27:42 -0700

[diff] [blame]

137

<li

Zhijun He

2014-08-18 10:55:33 -0700

[diff] [blame]

138

><a href="#dynamic_android.colorCorrection.aberrationMode">android.colorCorrection.aberrationMode</a></li>

Zhijun He

2014-07-01 18:27:42 -0700

[diff] [blame]

</ul>

</li>

<li>

static

<li

Zhijun He

2014-08-18 10:55:33 -0700

[diff] [blame]

145

><a href="#static_android.colorCorrection.availableAberrationModes">android.colorCorrection.availableAberrationModes</a></li>

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

146

</ul>

147

</li>

148

</ul>

149

</li>

150

<li>

151

<a href="#section_control">control</a>

<li>

controls

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

156

<li

157

><a href="#controls_android.control.aeAntibandingMode">android.control.aeAntibandingMode</a></li>

158

<li

159

><a href="#controls_android.control.aeExposureCompensation">android.control.aeExposureCompensation</a></li>

160

<li

161

><a href="#controls_android.control.aeLock">android.control.aeLock</a></li>

162

<li

163

><a href="#controls_android.control.aeMode">android.control.aeMode</a></li>

164

<li

165

><a href="#controls_android.control.aeRegions">android.control.aeRegions</a></li>

166

<li

167

><a href="#controls_android.control.aeTargetFpsRange">android.control.aeTargetFpsRange</a></li>

168

<li

169

><a href="#controls_android.control.aePrecaptureTrigger">android.control.aePrecaptureTrigger</a></li>

170

<li

171

><a href="#controls_android.control.afMode">android.control.afMode</a></li>

172

<li

173

><a href="#controls_android.control.afRegions">android.control.afRegions</a></li>

174

<li

175

><a href="#controls_android.control.afTrigger">android.control.afTrigger</a></li>

176

<li

177

><a href="#controls_android.control.awbLock">android.control.awbLock</a></li>

178

<li

179

><a href="#controls_android.control.awbMode">android.control.awbMode</a></li>

180

<li

181

><a href="#controls_android.control.awbRegions">android.control.awbRegions</a></li>

182

<li

183

><a href="#controls_android.control.captureIntent">android.control.captureIntent</a></li>

184

<li

185

><a href="#controls_android.control.effectMode">android.control.effectMode</a></li>

186

<li

187

><a href="#controls_android.control.mode">android.control.mode</a></li>

188

<li

189

><a href="#controls_android.control.sceneMode">android.control.sceneMode</a></li>

190

<li

191

><a href="#controls_android.control.videoStabilizationMode">android.control.videoStabilizationMode</a></li>

Yin-Chia Yeh

2016-01-18 19:14:55 -0800

[diff] [blame]

192

<li

193

><a href="#controls_android.control.postRawSensitivityBoost">android.control.postRawSensitivityBoost</a></li>

Chien-Yu Chen

2017-01-09 15:55:06 -0800

[diff] [blame]

194

<li

195

><a href="#controls_android.control.enableZsl">android.control.enableZsl</a></li>

Shuzhen Wang

2019-07-08 15:03:24 -0700

[diff] [blame]

196

<li

Shuzhen Wang

2020-03-16 11:39:27 -0700

[diff] [blame]

197

><a href="#controls_android.control.extendedSceneMode">android.control.extendedSceneMode</a></li>

Shuzhen Wang

2019-11-07 15:59:22 -0800

[diff] [blame]

198

<li

199

><a href="#controls_android.control.zoomRatio">android.control.zoomRatio</a></li>

Jayant Chowdhary

2021-07-21 11:26:51 -0700

[diff] [blame]

200

<li

201

><a href="#controls_android.control.afRegionsSet">android.control.afRegionsSet</a></li>

202

<li

203

><a href="#controls_android.control.aeRegionsSet">android.control.aeRegionsSet</a></li>

204

<li

205

><a href="#controls_android.control.awbRegionsSet">android.control.awbRegionsSet</a></li>

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

</ul>

</li>

<li>

static

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

211

<li

212

><a href="#static_android.control.aeAvailableAntibandingModes">android.control.aeAvailableAntibandingModes</a></li>

213

<li

214

><a href="#static_android.control.aeAvailableModes">android.control.aeAvailableModes</a></li>

215

<li

216

><a href="#static_android.control.aeAvailableTargetFpsRanges">android.control.aeAvailableTargetFpsRanges</a></li>

217

<li

218

><a href="#static_android.control.aeCompensationRange">android.control.aeCompensationRange</a></li>

219

<li

220

><a href="#static_android.control.aeCompensationStep">android.control.aeCompensationStep</a></li>

221

<li

222

><a href="#static_android.control.afAvailableModes">android.control.afAvailableModes</a></li>

223

<li

224

><a href="#static_android.control.availableEffects">android.control.availableEffects</a></li>

225

<li

226

><a href="#static_android.control.availableSceneModes">android.control.availableSceneModes</a></li>

227

<li

228

><a href="#static_android.control.availableVideoStabilizationModes">android.control.availableVideoStabilizationModes</a></li>

229

<li

230

><a href="#static_android.control.awbAvailableModes">android.control.awbAvailableModes</a></li>

231

<li

232

><a href="#static_android.control.maxRegions">android.control.maxRegions</a></li>

233

<li

Igor Murashkin

2014-05-27 10:51:25 -0700

[diff] [blame]

234

><a href="#static_android.control.maxRegionsAe">android.control.maxRegionsAe</a></li>

235

<li

236

><a href="#static_android.control.maxRegionsAwb">android.control.maxRegionsAwb</a></li>

237

<li

238

><a href="#static_android.control.maxRegionsAf">android.control.maxRegionsAf</a></li>

239

<li

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

240

><a href="#static_android.control.sceneModeOverrides">android.control.sceneModeOverrides</a></li>

Zhijun He

2014-06-10 18:21:34 -0700

[diff] [blame]

241

<li

242

><a href="#static_android.control.availableHighSpeedVideoConfigurations">android.control.availableHighSpeedVideoConfigurations</a></li>

Yin-Chia Yeh

2015-02-20 15:34:14 -0800

[diff] [blame]

243

<li

244

><a href="#static_android.control.aeLockAvailable">android.control.aeLockAvailable</a></li>

245

<li

246

><a href="#static_android.control.awbLockAvailable">android.control.awbLockAvailable</a></li>

247

<li

248

><a href="#static_android.control.availableModes">android.control.availableModes</a></li>

Yin-Chia Yeh

2016-01-18 19:14:55 -0800

[diff] [blame]

249

<li

250

><a href="#static_android.control.postRawSensitivityBoostRange">android.control.postRawSensitivityBoostRange</a></li>

Shuzhen Wang

2019-07-08 15:03:24 -0700

[diff] [blame]

251

<li

Shuzhen Wang

2020-03-16 11:39:27 -0700

[diff] [blame]

252

><a href="#static_android.control.availableExtendedSceneModeMaxSizes">android.control.availableExtendedSceneModeMaxSizes</a></li>

Shuzhen Wang

2019-11-07 15:59:22 -0800

[diff] [blame]

253

<li

Shuzhen Wang

2020-03-16 11:39:27 -0700

[diff] [blame]

254

><a href="#static_android.control.availableExtendedSceneModeZoomRatioRanges">android.control.availableExtendedSceneModeZoomRatioRanges</a></li>

Shuzhen Wang

2019-11-07 15:59:22 -0800

[diff] [blame]

255

<li

Shuzhen Wang

2020-03-16 11:39:27 -0700

[diff] [blame]

256

><a href="#static_android.control.availableExtendedSceneModeCapabilities">android.control.availableExtendedSceneModeCapabilities</a></li>

Shuzhen Wang

2019-11-07 15:59:22 -0800

[diff] [blame]

257

<li

258

><a href="#static_android.control.zoomRatioRange">android.control.zoomRatioRange</a></li>

Jayant Chowdhary

2020-11-09 09:08:31 -0800

[diff] [blame]

259

<li

260

><a href="#static_android.control.availableHighSpeedVideoConfigurationsMaximumResolution">android.control.availableHighSpeedVideoConfigurationsMaximumResolution</a></li>

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

</ul>

</li>

<li>

dynamic

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

266

<li

267

class="toc_deprecated"

268

><a href="#dynamic_android.control.aePrecaptureId">android.control.aePrecaptureId</a></li>

269

<li

270

><a href="#dynamic_android.control.aeAntibandingMode">android.control.aeAntibandingMode</a></li>

271

<li

272

><a href="#dynamic_android.control.aeExposureCompensation">android.control.aeExposureCompensation</a></li>

273

<li

274

><a href="#dynamic_android.control.aeLock">android.control.aeLock</a></li>

275

<li

276

><a href="#dynamic_android.control.aeMode">android.control.aeMode</a></li>

277

<li

278

><a href="#dynamic_android.control.aeRegions">android.control.aeRegions</a></li>

279

<li

280

><a href="#dynamic_android.control.aeTargetFpsRange">android.control.aeTargetFpsRange</a></li>

281

<li

282

><a href="#dynamic_android.control.aePrecaptureTrigger">android.control.aePrecaptureTrigger</a></li>

283

<li

284

><a href="#dynamic_android.control.aeState">android.control.aeState</a></li>

285

<li

286

><a href="#dynamic_android.control.afMode">android.control.afMode</a></li>

287

<li

288

><a href="#dynamic_android.control.afRegions">android.control.afRegions</a></li>

289

<li

290

><a href="#dynamic_android.control.afTrigger">android.control.afTrigger</a></li>

291

<li

292

><a href="#dynamic_android.control.afState">android.control.afState</a></li>

293

<li

294

class="toc_deprecated"

295

><a href="#dynamic_android.control.afTriggerId">android.control.afTriggerId</a></li>

296

<li

297

><a href="#dynamic_android.control.awbLock">android.control.awbLock</a></li>

298

<li

299

><a href="#dynamic_android.control.awbMode">android.control.awbMode</a></li>

300

<li

301

><a href="#dynamic_android.control.awbRegions">android.control.awbRegions</a></li>

302

<li

303

><a href="#dynamic_android.control.captureIntent">android.control.captureIntent</a></li>

304

<li

305

><a href="#dynamic_android.control.awbState">android.control.awbState</a></li>

306

<li

307

><a href="#dynamic_android.control.effectMode">android.control.effectMode</a></li>

308

<li

309

><a href="#dynamic_android.control.mode">android.control.mode</a></li>

310

<li

311

><a href="#dynamic_android.control.sceneMode">android.control.sceneMode</a></li>

312

<li

313

><a href="#dynamic_android.control.videoStabilizationMode">android.control.videoStabilizationMode</a></li>

Yin-Chia Yeh

2016-01-18 19:14:55 -0800

[diff] [blame]

314

<li

315

><a href="#dynamic_android.control.postRawSensitivityBoost">android.control.postRawSensitivityBoost</a></li>

Chien-Yu Chen

2017-01-09 15:55:06 -0800

[diff] [blame]

316

<li

317

><a href="#dynamic_android.control.enableZsl">android.control.enableZsl</a></li>

Chien-Yu Chen

2017-11-27 16:12:38 -0800

[diff] [blame]

318

<li

319

><a href="#dynamic_android.control.afSceneChange">android.control.afSceneChange</a></li>

Shuzhen Wang

2019-07-08 15:03:24 -0700

[diff] [blame]

320

<li

Shuzhen Wang

2020-03-16 11:39:27 -0700

[diff] [blame]

321

><a href="#dynamic_android.control.extendedSceneMode">android.control.extendedSceneMode</a></li>

Shuzhen Wang

2019-11-07 15:59:22 -0800

[diff] [blame]

322

<li

323

><a href="#dynamic_android.control.zoomRatio">android.control.zoomRatio</a></li>

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

324

</ul>

325

</li>

326

</ul>

327

</li>

328

<li>

329

<a href="#section_demosaic">demosaic</a>

<li>

controls

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

334

<li

335

><a href="#controls_android.demosaic.mode">android.demosaic.mode</a></li>

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

336

</ul>

337

</li>

338

</ul>

</li>

<li>

<li>

controls

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

346

<li

347

><a href="#controls_android.edge.mode">android.edge.mode</a></li>

348

<li

349

><a href="#controls_android.edge.strength">android.edge.strength</a></li>

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

350

</ul>

351

</li>

352

<li>

Ruben Brunk

2014-03-04 15:01:25 -0800

[diff] [blame]

353

static

354

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

355

<li

356

><a href="#static_android.edge.availableEdgeModes">android.edge.availableEdgeModes</a></li>

Ruben Brunk

2014-03-04 15:01:25 -0800

[diff] [blame]

357

</ul>

358

</li>

359

<li>

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

360

dynamic

361

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

362

<li

363

><a href="#dynamic_android.edge.mode">android.edge.mode</a></li>

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

364

</ul>

365

</li>

366

</ul>

367

</li>

368

<li>

369

<a href="#section_flash">flash</a>

<li>

controls

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

374

<li

375

><a href="#controls_android.flash.firingPower">android.flash.firingPower</a></li>

376

<li

377

><a href="#controls_android.flash.firingTime">android.flash.firingTime</a></li>

378

<li

379

><a href="#controls_android.flash.mode">android.flash.mode</a></li>

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

</ul>

</li>

<li>

static

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

385

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

386

<li

387

><a href="#static_android.flash.info.available">android.flash.info.available</a></li>

388

<li

389

><a href="#static_android.flash.info.chargeDuration">android.flash.info.chargeDuration</a></li>

Rucha Katakwar

2021-10-12 10:01:29 -0700

[diff] [blame]

390

<li

391

><a href="#static_android.flash.info.strengthMaximumLevel">android.flash.info.strengthMaximumLevel</a></li>

392

<li

393

><a href="#static_android.flash.info.strengthDefaultLevel">android.flash.info.strengthDefaultLevel</a></li>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

394

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

395

<li

396

><a href="#static_android.flash.colorTemperature">android.flash.colorTemperature</a></li>

397

<li

398

><a href="#static_android.flash.maxEnergy">android.flash.maxEnergy</a></li>

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

</ul>

</li>

<li>

dynamic

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

404

<li

405

><a href="#dynamic_android.flash.firingPower">android.flash.firingPower</a></li>

406

<li

407

><a href="#dynamic_android.flash.firingTime">android.flash.firingTime</a></li>

408

<li

409

><a href="#dynamic_android.flash.mode">android.flash.mode</a></li>

410

<li

411

><a href="#dynamic_android.flash.state">android.flash.state</a></li>

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

412

</ul>

413

</li>

414

</ul>

415

</li>

416

<li>

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

417

<a href="#section_hotPixel">hotPixel</a>

<li>

controls

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

422

<li

423

><a href="#controls_android.hotPixel.mode">android.hotPixel.mode</a></li>

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

424

</ul>

425

</li>

426

<li>

Ruben Brunk

2014-03-04 14:09:44 -0800

[diff] [blame]

427

static

428

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

429

<li

430

><a href="#static_android.hotPixel.availableHotPixelModes">android.hotPixel.availableHotPixelModes</a></li>

Ruben Brunk

2014-03-04 14:09:44 -0800

[diff] [blame]

431

</ul>

432

</li>

433

<li>

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

434

dynamic

435

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

436

<li

437

><a href="#dynamic_android.hotPixel.mode">android.hotPixel.mode</a></li>

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

438

</ul>

439

</li>

440

</ul>

</li>

<li>

<li>

controls

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

448

<li

Ruben Brunk

2014-05-27 18:52:49 -0700

[diff] [blame]

449

><a href="#controls_android.jpeg.gpsLocation">android.jpeg.gpsLocation</a></li>

450

<li

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

451

><a href="#controls_android.jpeg.gpsCoordinates">android.jpeg.gpsCoordinates</a></li>

452

<li

453

><a href="#controls_android.jpeg.gpsProcessingMethod">android.jpeg.gpsProcessingMethod</a></li>

454

<li

455

><a href="#controls_android.jpeg.gpsTimestamp">android.jpeg.gpsTimestamp</a></li>

456

<li

457

><a href="#controls_android.jpeg.orientation">android.jpeg.orientation</a></li>

458

<li

459

><a href="#controls_android.jpeg.quality">android.jpeg.quality</a></li>

460

<li

461

><a href="#controls_android.jpeg.thumbnailQuality">android.jpeg.thumbnailQuality</a></li>

462

<li

463

><a href="#controls_android.jpeg.thumbnailSize">android.jpeg.thumbnailSize</a></li>

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

</ul>

</li>

<li>

static

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

469

<li

470

><a href="#static_android.jpeg.availableThumbnailSizes">android.jpeg.availableThumbnailSizes</a></li>

471

<li

472

><a href="#static_android.jpeg.maxSize">android.jpeg.maxSize</a></li>

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

</ul>

</li>

<li>

dynamic

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

478

<li

Ruben Brunk

2014-05-27 18:52:49 -0700

[diff] [blame]

479

><a href="#dynamic_android.jpeg.gpsLocation">android.jpeg.gpsLocation</a></li>

480

<li

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

481

><a href="#dynamic_android.jpeg.gpsCoordinates">android.jpeg.gpsCoordinates</a></li>

482

<li

483

><a href="#dynamic_android.jpeg.gpsProcessingMethod">android.jpeg.gpsProcessingMethod</a></li>

484

<li

485

><a href="#dynamic_android.jpeg.gpsTimestamp">android.jpeg.gpsTimestamp</a></li>

486

<li

487

><a href="#dynamic_android.jpeg.orientation">android.jpeg.orientation</a></li>

488

<li

489

><a href="#dynamic_android.jpeg.quality">android.jpeg.quality</a></li>

490

<li

491

><a href="#dynamic_android.jpeg.size">android.jpeg.size</a></li>

492

<li

493

><a href="#dynamic_android.jpeg.thumbnailQuality">android.jpeg.thumbnailQuality</a></li>

494

<li

495

><a href="#dynamic_android.jpeg.thumbnailSize">android.jpeg.thumbnailSize</a></li>

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

496

</ul>

497

</li>

498

</ul>

</li>

<li>

<li>

controls

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

506

<li

507

><a href="#controls_android.lens.aperture">android.lens.aperture</a></li>

508

<li

509

><a href="#controls_android.lens.filterDensity">android.lens.filterDensity</a></li>

510

<li

511

><a href="#controls_android.lens.focalLength">android.lens.focalLength</a></li>

512

<li

513

><a href="#controls_android.lens.focusDistance">android.lens.focusDistance</a></li>

514

<li

515

><a href="#controls_android.lens.opticalStabilizationMode">android.lens.opticalStabilizationMode</a></li>

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

</ul>

</li>

<li>

static

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

522

<li

523

><a href="#static_android.lens.info.availableApertures">android.lens.info.availableApertures</a></li>

524

<li

525

><a href="#static_android.lens.info.availableFilterDensities">android.lens.info.availableFilterDensities</a></li>

526

<li

527

><a href="#static_android.lens.info.availableFocalLengths">android.lens.info.availableFocalLengths</a></li>

528

<li

529

><a href="#static_android.lens.info.availableOpticalStabilization">android.lens.info.availableOpticalStabilization</a></li>

530

<li

531

><a href="#static_android.lens.info.hyperfocalDistance">android.lens.info.hyperfocalDistance</a></li>

532

<li

533

><a href="#static_android.lens.info.minimumFocusDistance">android.lens.info.minimumFocusDistance</a></li>

534

<li

535

><a href="#static_android.lens.info.shadingMapSize">android.lens.info.shadingMapSize</a></li>

536

<li

537

><a href="#static_android.lens.info.focusDistanceCalibration">android.lens.info.focusDistanceCalibration</a></li>

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

538

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

539

<li

540

><a href="#static_android.lens.facing">android.lens.facing</a></li>

541

<li

Eino-Ville Talvala

2015-02-09 15:47:27 -0800

[diff] [blame]

542

><a href="#static_android.lens.poseRotation">android.lens.poseRotation</a></li>

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

543

<li

Eino-Ville Talvala

2015-02-09 15:47:27 -0800

[diff] [blame]

544

><a href="#static_android.lens.poseTranslation">android.lens.poseTranslation</a></li>

545

<li

546

><a href="#static_android.lens.intrinsicCalibration">android.lens.intrinsicCalibration</a></li>

547

<li

Eino-Ville Talvala

2018-03-13 19:10:23 -0700

[diff] [blame]

548

class="toc_deprecated"

Eino-Ville Talvala

2015-02-09 15:47:27 -0800

[diff] [blame]

549

><a href="#static_android.lens.radialDistortion">android.lens.radialDistortion</a></li>

Eino-Ville Talvala

2017-12-07 13:12:11 -0800

[diff] [blame]

550

<li

551

><a href="#static_android.lens.poseReference">android.lens.poseReference</a></li>

Eino-Ville Talvala

2018-03-13 19:10:23 -0700

[diff] [blame]

552

<li

553

><a href="#static_android.lens.distortion">android.lens.distortion</a></li>

Jayant Chowdhary

2020-11-09 09:08:31 -0800

[diff] [blame]

554

<li

555

><a href="#static_android.lens.distortionMaximumResolution">android.lens.distortionMaximumResolution</a></li>

556

<li

557

><a href="#static_android.lens.intrinsicCalibrationMaximumResolution">android.lens.intrinsicCalibrationMaximumResolution</a></li>

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

</ul>

</li>

<li>

dynamic

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

563

<li

564

><a href="#dynamic_android.lens.aperture">android.lens.aperture</a></li>

565

<li

566

><a href="#dynamic_android.lens.filterDensity">android.lens.filterDensity</a></li>

567

<li

568

><a href="#dynamic_android.lens.focalLength">android.lens.focalLength</a></li>

569

<li

570

><a href="#dynamic_android.lens.focusDistance">android.lens.focusDistance</a></li>

571

<li

572

><a href="#dynamic_android.lens.focusRange">android.lens.focusRange</a></li>

573

<li

574

><a href="#dynamic_android.lens.opticalStabilizationMode">android.lens.opticalStabilizationMode</a></li>

575

<li

576

><a href="#dynamic_android.lens.state">android.lens.state</a></li>

Eino-Ville Talvala

2015-02-09 15:47:27 -0800

[diff] [blame]

577

<li

578

><a href="#dynamic_android.lens.poseRotation">android.lens.poseRotation</a></li>

579

<li

580

><a href="#dynamic_android.lens.poseTranslation">android.lens.poseTranslation</a></li>

581

<li

582

><a href="#dynamic_android.lens.intrinsicCalibration">android.lens.intrinsicCalibration</a></li>

583

<li

Eino-Ville Talvala

2018-03-13 19:10:23 -0700

[diff] [blame]

584

class="toc_deprecated"

Eino-Ville Talvala

2015-02-09 15:47:27 -0800

[diff] [blame]

585

><a href="#dynamic_android.lens.radialDistortion">android.lens.radialDistortion</a></li>

Eino-Ville Talvala

2018-03-13 19:10:23 -0700

[diff] [blame]

586

<li

587

><a href="#dynamic_android.lens.distortion">android.lens.distortion</a></li>

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

588

</ul>

589

</li>

590

</ul>

591

</li>

592

<li>

593

<a href="#section_noiseReduction">noiseReduction</a>

<li>

controls

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

598

<li

599

><a href="#controls_android.noiseReduction.mode">android.noiseReduction.mode</a></li>

600

<li

601

><a href="#controls_android.noiseReduction.strength">android.noiseReduction.strength</a></li>

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

602

</ul>

603

</li>

604

<li>

Ruben Brunk

2014-03-04 15:01:25 -0800

[diff] [blame]

605

static

606

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

607

<li

608

><a href="#static_android.noiseReduction.availableNoiseReductionModes">android.noiseReduction.availableNoiseReductionModes</a></li>

Ruben Brunk

2014-03-04 15:01:25 -0800

[diff] [blame]

609

</ul>

610

</li>

611

<li>

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

612

dynamic

613

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

614

<li

615

><a href="#dynamic_android.noiseReduction.mode">android.noiseReduction.mode</a></li>

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

616

</ul>

617

</li>

618

</ul>

619

</li>

620

<li>

621

<a href="#section_quirks">quirks</a>

<li>

static

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

626

<li

627

class="toc_deprecated"

628

><a href="#static_android.quirks.meteringCropRegion">android.quirks.meteringCropRegion</a></li>

629

<li

630

class="toc_deprecated"

631

><a href="#static_android.quirks.triggerAfWithAuto">android.quirks.triggerAfWithAuto</a></li>

632

<li

633

class="toc_deprecated"

634

><a href="#static_android.quirks.useZslFormat">android.quirks.useZslFormat</a></li>

635

<li

636

class="toc_deprecated"

637

><a href="#static_android.quirks.usePartialResult">android.quirks.usePartialResult</a></li>

Eino-Ville Talvala

2013-10-09 18:21:30 -0700

[diff] [blame]

</ul>

</li>

<li>

dynamic

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

643

<li

644

class="toc_deprecated"

645

><a href="#dynamic_android.quirks.partialResult">android.quirks.partialResult</a></li>

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

646

</ul>

647

</li>

648

</ul>

649

</li>

650

<li>

651

<a href="#section_request">request</a>

<li>

controls

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

656

<li

657

class="toc_deprecated"

658

><a href="#controls_android.request.frameCount">android.request.frameCount</a></li>

659

<li

660

><a href="#controls_android.request.id">android.request.id</a></li>

661

<li

662

class="toc_deprecated"

663

><a href="#controls_android.request.inputStreams">android.request.inputStreams</a></li>

664

<li

665

><a href="#controls_android.request.metadataMode">android.request.metadataMode</a></li>

666

<li

667

class="toc_deprecated"

668

><a href="#controls_android.request.outputStreams">android.request.outputStreams</a></li>

669

<li

670

class="toc_deprecated"

671

><a href="#controls_android.request.type">android.request.type</a></li>

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

</ul>

</li>

<li>

static

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

677

<li

678

><a href="#static_android.request.maxNumOutputStreams">android.request.maxNumOutputStreams</a></li>

679

<li

Igor Murashkin

2014-05-27 10:51:25 -0700

[diff] [blame]

680

><a href="#static_android.request.maxNumOutputRaw">android.request.maxNumOutputRaw</a></li>

681

<li

682

><a href="#static_android.request.maxNumOutputProc">android.request.maxNumOutputProc</a></li>

683

<li

684

><a href="#static_android.request.maxNumOutputProcStalling">android.request.maxNumOutputProcStalling</a></li>

685

<li

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

686

class="toc_deprecated"

687

><a href="#static_android.request.maxNumReprocessStreams">android.request.maxNumReprocessStreams</a></li>

688

<li

689

><a href="#static_android.request.maxNumInputStreams">android.request.maxNumInputStreams</a></li>

690

<li

691

><a href="#static_android.request.pipelineMaxDepth">android.request.pipelineMaxDepth</a></li>

692

<li

693

><a href="#static_android.request.partialResultCount">android.request.partialResultCount</a></li>

694

<li

695

><a href="#static_android.request.availableCapabilities">android.request.availableCapabilities</a></li>

696

<li

697

><a href="#static_android.request.availableRequestKeys">android.request.availableRequestKeys</a></li>

698

<li

699

><a href="#static_android.request.availableResultKeys">android.request.availableResultKeys</a></li>

700

<li

701

><a href="#static_android.request.availableCharacteristicsKeys">android.request.availableCharacteristicsKeys</a></li>

Emilian Peev

2017-11-17 13:20:12 +0000

[diff] [blame]

702

<li

703

><a href="#static_android.request.availableSessionKeys">android.request.availableSessionKeys</a></li>

Emilian Peev

2018-01-18 19:09:57 +0000

[diff] [blame]

704

<li

705

><a href="#static_android.request.availablePhysicalCameraRequestKeys">android.request.availablePhysicalCameraRequestKeys</a></li>

Emilian Peev

98a89c1

2018-08-15 18:20:27 +0100

[diff] [blame]

706

<li

707

><a href="#static_android.request.characteristicKeysNeedingPermission">android.request.characteristicKeysNeedingPermission</a></li>

Emilian Peev

2021-11-12 18:07:39 -0800

[diff] [blame]

708

<li

709

><a href="#static_android.request.availableDynamicRangeProfiles">android.request.availableDynamicRangeProfiles</a></li>

710

<li

711

><a href="#static_android.request.availableDynamicRangeProfilesMap">android.request.availableDynamicRangeProfilesMap</a></li>

712

<li

713

><a href="#static_android.request.recommendedTenBitDynamicRangeProfile">android.request.recommendedTenBitDynamicRangeProfile</a></li>

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

</ul>

</li>

<li>

dynamic

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

719

<li

Igor Murashkin

2014-07-25 16:55:18 -0700

[diff] [blame]

720

class="toc_deprecated"

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

721

><a href="#dynamic_android.request.frameCount">android.request.frameCount</a></li>

722

<li

723

><a href="#dynamic_android.request.id">android.request.id</a></li>

724

<li

725

><a href="#dynamic_android.request.metadataMode">android.request.metadataMode</a></li>

726

<li

727

class="toc_deprecated"

728

><a href="#dynamic_android.request.outputStreams">android.request.outputStreams</a></li>

729

<li

730

><a href="#dynamic_android.request.pipelineDepth">android.request.pipelineDepth</a></li>

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

731

</ul>

732

</li>

733

</ul>

734

</li>

735

<li>

736

<a href="#section_scaler">scaler</a>

<li>

controls

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

741

<li

742

><a href="#controls_android.scaler.cropRegion">android.scaler.cropRegion</a></li>

Eino-Ville Talvala

2020-01-06 13:06:22 -0800

[diff] [blame]

743

<li

744

><a href="#controls_android.scaler.rotateAndCrop">android.scaler.rotateAndCrop</a></li>

Jayant Chowdhary

2021-07-21 11:26:51 -0700

[diff] [blame]

745

<li

746

><a href="#controls_android.scaler.cropRegionSet">android.scaler.cropRegionSet</a></li>

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

</ul>

</li>

<li>

static

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

752

<li

753

class="toc_deprecated"

754

><a href="#static_android.scaler.availableFormats">android.scaler.availableFormats</a></li>

755

<li

756

class="toc_deprecated"

757

><a href="#static_android.scaler.availableJpegMinDurations">android.scaler.availableJpegMinDurations</a></li>

758

<li

759

class="toc_deprecated"

760

><a href="#static_android.scaler.availableJpegSizes">android.scaler.availableJpegSizes</a></li>

761

<li

762

><a href="#static_android.scaler.availableMaxDigitalZoom">android.scaler.availableMaxDigitalZoom</a></li>

763

<li

764

class="toc_deprecated"

765

><a href="#static_android.scaler.availableProcessedMinDurations">android.scaler.availableProcessedMinDurations</a></li>

766

<li

767

class="toc_deprecated"

768

><a href="#static_android.scaler.availableProcessedSizes">android.scaler.availableProcessedSizes</a></li>

769

<li

770

class="toc_deprecated"

771

><a href="#static_android.scaler.availableRawMinDurations">android.scaler.availableRawMinDurations</a></li>

772

<li

773

class="toc_deprecated"

774

><a href="#static_android.scaler.availableRawSizes">android.scaler.availableRawSizes</a></li>

775

<li

776

><a href="#static_android.scaler.availableInputOutputFormatsMap">android.scaler.availableInputOutputFormatsMap</a></li>

777

<li

778

><a href="#static_android.scaler.availableStreamConfigurations">android.scaler.availableStreamConfigurations</a></li>

779

<li

780

><a href="#static_android.scaler.availableMinFrameDurations">android.scaler.availableMinFrameDurations</a></li>

781

<li

782

><a href="#static_android.scaler.availableStallDurations">android.scaler.availableStallDurations</a></li>

783

<li

784

><a href="#static_android.scaler.streamConfigurationMap">android.scaler.streamConfigurationMap</a></li>

Zhijun He

2014-05-21 15:29:07 -0700

[diff] [blame]

785

<li

786

><a href="#static_android.scaler.croppingType">android.scaler.croppingType</a></li>

Emilian Peev

2018-09-18 14:01:55 +0100

[diff] [blame]

787

<li

788

><a href="#static_android.scaler.availableRecommendedStreamConfigurations">android.scaler.availableRecommendedStreamConfigurations</a></li>

789

<li

790

><a href="#static_android.scaler.availableRecommendedInputOutputFormatsMap">android.scaler.availableRecommendedInputOutputFormatsMap</a></li>

Emilian Peev

fdc5563

2018-11-14 17:50:18 +0000

[diff] [blame]

791

<li

792

><a href="#static_android.scaler.mandatoryStreamCombinations">android.scaler.mandatoryStreamCombinations</a></li>

Eino-Ville Talvala

2020-01-06 13:06:22 -0800

[diff] [blame]

793

<li

Jayant Chowdhary

828a020

2020-03-13 13:57:38 -0700

[diff] [blame]

794

><a href="#static_android.scaler.mandatoryConcurrentStreamCombinations">android.scaler.mandatoryConcurrentStreamCombinations</a></li>

795

<li

Eino-Ville Talvala

2020-01-06 13:06:22 -0800

[diff] [blame]

796

><a href="#static_android.scaler.availableRotateAndCropModes">android.scaler.availableRotateAndCropModes</a></li>

Yin-Chia Yeh

8a349d8

2021-02-11 17:10:20 -0800

[diff] [blame]

797

<li

798

><a href="#static_android.scaler.defaultSecureImageSize">android.scaler.defaultSecureImageSize</a></li>

Shuzhen Wang

2020-11-20 15:39:23 -0800

[diff] [blame]

799

<li

800

><a href="#static_android.scaler.physicalCameraMultiResolutionStreamConfigurations">android.scaler.physicalCameraMultiResolutionStreamConfigurations</a></li>

801

<li

802

><a href="#static_android.scaler.multiResolutionStreamConfigurationMap">android.scaler.multiResolutionStreamConfigurationMap</a></li>

Jayant Chowdhary

2020-11-09 09:08:31 -0800

[diff] [blame]

803

<li

804

><a href="#static_android.scaler.availableStreamConfigurationsMaximumResolution">android.scaler.availableStreamConfigurationsMaximumResolution</a></li>

805

<li

806

><a href="#static_android.scaler.availableMinFrameDurationsMaximumResolution">android.scaler.availableMinFrameDurationsMaximumResolution</a></li>

807

<li

808

><a href="#static_android.scaler.availableStallDurationsMaximumResolution">android.scaler.availableStallDurationsMaximumResolution</a></li>

809

<li

810

><a href="#static_android.scaler.streamConfigurationMapMaximumResolution">android.scaler.streamConfigurationMapMaximumResolution</a></li>

811

<li

812

><a href="#static_android.scaler.availableInputOutputFormatsMapMaximumResolution">android.scaler.availableInputOutputFormatsMapMaximumResolution</a></li>

813

<li

814

><a href="#static_android.scaler.mandatoryMaximumResolutionStreamCombinations">android.scaler.mandatoryMaximumResolutionStreamCombinations</a></li>

Shuzhen Wang

2021-04-06 12:44:46 -0700

[diff] [blame]

815

<li

Emilian Peev

2021-11-12 18:07:39 -0800

[diff] [blame]

816

><a href="#static_android.scaler.mandatoryTenBitOutputStreamCombinations">android.scaler.mandatoryTenBitOutputStreamCombinations</a></li>

817

<li

Jayant Chowdhary

3621407

2022-02-09 20:58:54 +0000

[diff] [blame]

818

><a href="#static_android.scaler.mandatoryPreviewStabilizationOutputStreamCombinations">android.scaler.mandatoryPreviewStabilizationOutputStreamCombinations</a></li>

819

<li

Shuzhen Wang

2021-04-06 12:44:46 -0700

[diff] [blame]

820

><a href="#static_android.scaler.multiResolutionStreamSupported">android.scaler.multiResolutionStreamSupported</a></li>

Shuzhen Wang

2021-12-14 20:08:28 -0800

[diff] [blame]

821

<li

822

><a href="#static_android.scaler.availableStreamUseCases">android.scaler.availableStreamUseCases</a></li>

823

<li

824

><a href="#static_android.scaler.mandatoryUseCaseStreamCombinations">android.scaler.mandatoryUseCaseStreamCombinations</a></li>

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

</ul>

</li>

<li>

dynamic

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

830

<li

831

><a href="#dynamic_android.scaler.cropRegion">android.scaler.cropRegion</a></li>

Eino-Ville Talvala

2020-01-06 13:06:22 -0800

[diff] [blame]

832

<li

833

><a href="#dynamic_android.scaler.rotateAndCrop">android.scaler.rotateAndCrop</a></li>

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

834

</ul>

835

</li>

836

</ul>

837

</li>

838

<li>

839

<a href="#section_sensor">sensor</a>

<li>

controls

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

844

<li

845

><a href="#controls_android.sensor.exposureTime">android.sensor.exposureTime</a></li>

846

<li

847

><a href="#controls_android.sensor.frameDuration">android.sensor.frameDuration</a></li>

848

<li

849

><a href="#controls_android.sensor.sensitivity">android.sensor.sensitivity</a></li>

850

<li

851

><a href="#controls_android.sensor.testPatternData">android.sensor.testPatternData</a></li>

852

<li

853

><a href="#controls_android.sensor.testPatternMode">android.sensor.testPatternMode</a></li>

Jayant Chowdhary

2020-11-09 09:08:31 -0800

[diff] [blame]

854

<li

855

><a href="#controls_android.sensor.pixelMode">android.sensor.pixelMode</a></li>

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

</ul>

</li>

<li>

static

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

862

<li

863

><a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a></li>

864

<li

865

><a href="#static_android.sensor.info.sensitivityRange">android.sensor.info.sensitivityRange</a></li>

866

<li

867

><a href="#static_android.sensor.info.colorFilterArrangement">android.sensor.info.colorFilterArrangement</a></li>

868

<li

869

><a href="#static_android.sensor.info.exposureTimeRange">android.sensor.info.exposureTimeRange</a></li>

870

<li

871

><a href="#static_android.sensor.info.maxFrameDuration">android.sensor.info.maxFrameDuration</a></li>

872

<li

873

><a href="#static_android.sensor.info.physicalSize">android.sensor.info.physicalSize</a></li>

874

<li

875

><a href="#static_android.sensor.info.pixelArraySize">android.sensor.info.pixelArraySize</a></li>

876

<li

877

><a href="#static_android.sensor.info.whiteLevel">android.sensor.info.whiteLevel</a></li>

Zhijun He

2014-06-12 10:43:32 -0700

[diff] [blame]

878

<li

Eino-Ville Talvala

2014-07-28 12:49:25 -0700

[diff] [blame]

879

><a href="#static_android.sensor.info.timestampSource">android.sensor.info.timestampSource</a></li>

Yin-Chia Yeh

2015-02-04 10:04:37 -0800

[diff] [blame]

880

<li

881

><a href="#static_android.sensor.info.lensShadingApplied">android.sensor.info.lensShadingApplied</a></li>

Ruben Brunk

2015-07-01 11:32:39 -0700

[diff] [blame]

882

<li

883

><a href="#static_android.sensor.info.preCorrectionActiveArraySize">android.sensor.info.preCorrectionActiveArraySize</a></li>

Jayant Chowdhary

2020-11-09 09:08:31 -0800

[diff] [blame]

884

<li

885

><a href="#static_android.sensor.info.activeArraySizeMaximumResolution">android.sensor.info.activeArraySizeMaximumResolution</a></li>

886

<li

887

><a href="#static_android.sensor.info.pixelArraySizeMaximumResolution">android.sensor.info.pixelArraySizeMaximumResolution</a></li>

888

<li

889

><a href="#static_android.sensor.info.preCorrectionActiveArraySizeMaximumResolution">android.sensor.info.preCorrectionActiveArraySizeMaximumResolution</a></li>

890

<li

891

><a href="#static_android.sensor.info.binningFactor">android.sensor.info.binningFactor</a></li>

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

892

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

893

<li

894

><a href="#static_android.sensor.referenceIlluminant1">android.sensor.referenceIlluminant1</a></li>

895

<li

896

><a href="#static_android.sensor.referenceIlluminant2">android.sensor.referenceIlluminant2</a></li>

897

<li

898

><a href="#static_android.sensor.calibrationTransform1">android.sensor.calibrationTransform1</a></li>

899

<li

900

><a href="#static_android.sensor.calibrationTransform2">android.sensor.calibrationTransform2</a></li>

901

<li

902

><a href="#static_android.sensor.colorTransform1">android.sensor.colorTransform1</a></li>

903

<li

904

><a href="#static_android.sensor.colorTransform2">android.sensor.colorTransform2</a></li>

905

<li

906

><a href="#static_android.sensor.forwardMatrix1">android.sensor.forwardMatrix1</a></li>

907

<li

908

><a href="#static_android.sensor.forwardMatrix2">android.sensor.forwardMatrix2</a></li>

909

<li

910

><a href="#static_android.sensor.baseGainFactor">android.sensor.baseGainFactor</a></li>

911

<li

912

><a href="#static_android.sensor.blackLevelPattern">android.sensor.blackLevelPattern</a></li>

913

<li

914

><a href="#static_android.sensor.maxAnalogSensitivity">android.sensor.maxAnalogSensitivity</a></li>

915

<li

916

><a href="#static_android.sensor.orientation">android.sensor.orientation</a></li>

917

<li

918

><a href="#static_android.sensor.profileHueSatMapDimensions">android.sensor.profileHueSatMapDimensions</a></li>

919

<li

920

><a href="#static_android.sensor.availableTestPatternModes">android.sensor.availableTestPatternModes</a></li>

Zhijun He

2015-11-12 17:27:27 -0800

[diff] [blame]

921

<li

922

><a href="#static_android.sensor.opticalBlackRegions">android.sensor.opticalBlackRegions</a></li>

Yin-Chia Yeh

2015-12-06 21:42:35 -0800

[diff] [blame]

923

<li

924

><a href="#static_android.sensor.opaqueRawSize">android.sensor.opaqueRawSize</a></li>

Jayant Chowdhary

2020-11-09 09:08:31 -0800

[diff] [blame]

925

<li

926

><a href="#static_android.sensor.opaqueRawSizeMaximumResolution">android.sensor.opaqueRawSizeMaximumResolution</a></li>

Shuzhen Wang

ccdf3a3

2022-04-20 10:15:57 -0700

[diff] [blame]

927

<li

928

><a href="#static_android.sensor.readoutTimestamp">android.sensor.readoutTimestamp</a></li>

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

</ul>

</li>

<li>

dynamic

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

934

<li

935

><a href="#dynamic_android.sensor.exposureTime">android.sensor.exposureTime</a></li>

936

<li

937

><a href="#dynamic_android.sensor.frameDuration">android.sensor.frameDuration</a></li>

938

<li

939

><a href="#dynamic_android.sensor.sensitivity">android.sensor.sensitivity</a></li>

940

<li

941

><a href="#dynamic_android.sensor.timestamp">android.sensor.timestamp</a></li>

942

<li

943

><a href="#dynamic_android.sensor.temperature">android.sensor.temperature</a></li>

944

<li

945

><a href="#dynamic_android.sensor.neutralColorPoint">android.sensor.neutralColorPoint</a></li>

946

<li

Ruben Brunk

2014-07-23 15:13:16 -0700

[diff] [blame]

947

><a href="#dynamic_android.sensor.noiseProfile">android.sensor.noiseProfile</a></li>

948

<li

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

949

><a href="#dynamic_android.sensor.profileHueSatMap">android.sensor.profileHueSatMap</a></li>

950

<li

951

><a href="#dynamic_android.sensor.profileToneCurve">android.sensor.profileToneCurve</a></li>

952

<li

953

><a href="#dynamic_android.sensor.greenSplit">android.sensor.greenSplit</a></li>

954

<li

955

><a href="#dynamic_android.sensor.testPatternData">android.sensor.testPatternData</a></li>

956

<li

957

><a href="#dynamic_android.sensor.testPatternMode">android.sensor.testPatternMode</a></li>

Zhijun He

2014-06-11 10:44:53 -0700

[diff] [blame]

958

<li

959

><a href="#dynamic_android.sensor.rollingShutterSkew">android.sensor.rollingShutterSkew</a></li>

Zhijun He

2015-11-12 17:27:27 -0800

[diff] [blame]

960

<li

961

><a href="#dynamic_android.sensor.dynamicBlackLevel">android.sensor.dynamicBlackLevel</a></li>

962

<li

963

><a href="#dynamic_android.sensor.dynamicWhiteLevel">android.sensor.dynamicWhiteLevel</a></li>

Jayant Chowdhary

2020-11-09 09:08:31 -0800

[diff] [blame]

964

<li

965

><a href="#dynamic_android.sensor.pixelMode">android.sensor.pixelMode</a></li>

966

<li

967

><a href="#dynamic_android.sensor.rawBinningFactorUsed">android.sensor.rawBinningFactorUsed</a></li>

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

968

</ul>

969

</li>

970

</ul>

971

</li>

972

<li>

973

<a href="#section_shading">shading</a>

<li>

controls

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

978

<li

979

><a href="#controls_android.shading.mode">android.shading.mode</a></li>

980

<li

981

><a href="#controls_android.shading.strength">android.shading.strength</a></li>

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

</ul>

</li>

<li>

dynamic

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

987

<li

988

><a href="#dynamic_android.shading.mode">android.shading.mode</a></li>

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

989

</ul>

990

</li>

Yin-Chia Yeh

2015-02-04 10:04:37 -0800

[diff] [blame]

<li>

static

<li

><a href="#static_android.shading.availableModes">android.shading.availableModes</a></li>

996

</ul>

997

</li>

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

998

</ul>

999

</li>

1000

<li>

1001

<a href="#section_statistics">statistics</a>

<li>

controls

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

1006

<li

1007

><a href="#controls_android.statistics.faceDetectMode">android.statistics.faceDetectMode</a></li>

1008

<li

1009

><a href="#controls_android.statistics.histogramMode">android.statistics.histogramMode</a></li>

1010

<li

1011

><a href="#controls_android.statistics.sharpnessMapMode">android.statistics.sharpnessMapMode</a></li>

1012

<li

1013

><a href="#controls_android.statistics.hotPixelMapMode">android.statistics.hotPixelMapMode</a></li>

1014

<li

1015

><a href="#controls_android.statistics.lensShadingMapMode">android.statistics.lensShadingMapMode</a></li>

Chien-Yu Chen

2018-01-12 17:38:00 -0800

[diff] [blame]

1016

<li

1017

><a href="#controls_android.statistics.oisDataMode">android.statistics.oisDataMode</a></li>

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

</ul>

</li>

<li>

static

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

1024

<li

1025

><a href="#static_android.statistics.info.availableFaceDetectModes">android.statistics.info.availableFaceDetectModes</a></li>

1026

<li

1027

><a href="#static_android.statistics.info.histogramBucketCount">android.statistics.info.histogramBucketCount</a></li>

1028

<li

1029

><a href="#static_android.statistics.info.maxFaceCount">android.statistics.info.maxFaceCount</a></li>

1030

<li

1031

><a href="#static_android.statistics.info.maxHistogramCount">android.statistics.info.maxHistogramCount</a></li>

1032

<li

1033

><a href="#static_android.statistics.info.maxSharpnessMapValue">android.statistics.info.maxSharpnessMapValue</a></li>

1034

<li

1035

><a href="#static_android.statistics.info.sharpnessMapSize">android.statistics.info.sharpnessMapSize</a></li>

1036

<li

1037

><a href="#static_android.statistics.info.availableHotPixelMapModes">android.statistics.info.availableHotPixelMapModes</a></li>

Yin-Chia Yeh

2015-02-04 10:04:37 -0800

[diff] [blame]

1038

<li

1039

><a href="#static_android.statistics.info.availableLensShadingMapModes">android.statistics.info.availableLensShadingMapModes</a></li>

Chien-Yu Chen

2018-01-12 17:38:00 -0800

[diff] [blame]

1040

<li

1041

><a href="#static_android.statistics.info.availableOisDataModes">android.statistics.info.availableOisDataModes</a></li>

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

</ul>

</li>

<li>

dynamic

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

1048

<li

1049

><a href="#dynamic_android.statistics.faceDetectMode">android.statistics.faceDetectMode</a></li>

1050

<li

1051

><a href="#dynamic_android.statistics.faceIds">android.statistics.faceIds</a></li>

1052

<li

1053

><a href="#dynamic_android.statistics.faceLandmarks">android.statistics.faceLandmarks</a></li>

1054

<li

1055

><a href="#dynamic_android.statistics.faceRectangles">android.statistics.faceRectangles</a></li>

1056

<li

1057

><a href="#dynamic_android.statistics.faceScores">android.statistics.faceScores</a></li>

1058

<li

Igor Murashkin

2014-05-14 17:30:49 -0700

[diff] [blame]

1059

><a href="#dynamic_android.statistics.faces">android.statistics.faces</a></li>

1060

<li

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

1061

><a href="#dynamic_android.statistics.histogram">android.statistics.histogram</a></li>

1062

<li

1063

><a href="#dynamic_android.statistics.histogramMode">android.statistics.histogramMode</a></li>

1064

<li

1065

><a href="#dynamic_android.statistics.sharpnessMap">android.statistics.sharpnessMap</a></li>

1066

<li

1067

><a href="#dynamic_android.statistics.sharpnessMapMode">android.statistics.sharpnessMapMode</a></li>

1068

<li

Ruben Brunk

2014-05-27 18:52:49 -0700

[diff] [blame]

1069

><a href="#dynamic_android.statistics.lensShadingCorrectionMap">android.statistics.lensShadingCorrectionMap</a></li>

1070

<li

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

1071

><a href="#dynamic_android.statistics.lensShadingMap">android.statistics.lensShadingMap</a></li>

1072

<li

1073

class="toc_deprecated"

1074

><a href="#dynamic_android.statistics.predictedColorGains">android.statistics.predictedColorGains</a></li>

1075

<li

1076

class="toc_deprecated"

1077

><a href="#dynamic_android.statistics.predictedColorTransform">android.statistics.predictedColorTransform</a></li>

1078

<li

1079

><a href="#dynamic_android.statistics.sceneFlicker">android.statistics.sceneFlicker</a></li>

1080

<li

1081

><a href="#dynamic_android.statistics.hotPixelMapMode">android.statistics.hotPixelMapMode</a></li>

1082

<li

1083

><a href="#dynamic_android.statistics.hotPixelMap">android.statistics.hotPixelMap</a></li>

1084

<li

1085

><a href="#dynamic_android.statistics.lensShadingMapMode">android.statistics.lensShadingMapMode</a></li>

Chien-Yu Chen

2018-01-12 17:38:00 -0800

[diff] [blame]

1086

<li

1087

><a href="#dynamic_android.statistics.oisDataMode">android.statistics.oisDataMode</a></li>

1088

<li

1089

><a href="#dynamic_android.statistics.oisTimestamps">android.statistics.oisTimestamps</a></li>

1090

<li

1091

><a href="#dynamic_android.statistics.oisXShifts">android.statistics.oisXShifts</a></li>

1092

<li

1093

><a href="#dynamic_android.statistics.oisYShifts">android.statistics.oisYShifts</a></li>

Chien-Yu Chen

2018-02-15 12:34:30 -0800

[diff] [blame]

1094

<li

1095

><a href="#dynamic_android.statistics.oisSamples">android.statistics.oisSamples</a></li>

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

1096

</ul>

1097

</li>

1098

</ul>

1099

</li>

1100

<li>

1101

<a href="#section_tonemap">tonemap</a>

<li>

controls

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

1106

<li

1107

><a href="#controls_android.tonemap.curveBlue">android.tonemap.curveBlue</a></li>

1108

<li

1109

><a href="#controls_android.tonemap.curveGreen">android.tonemap.curveGreen</a></li>

1110

<li

1111

><a href="#controls_android.tonemap.curveRed">android.tonemap.curveRed</a></li>

1112

<li

Yin-Chia Yeh

2014-05-27 09:48:07 -0700

[diff] [blame]

1113

><a href="#controls_android.tonemap.curve">android.tonemap.curve</a></li>

1114

<li

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

1115

><a href="#controls_android.tonemap.mode">android.tonemap.mode</a></li>

Yin-Chia Yeh

2015-02-05 13:19:21 -0800

[diff] [blame]

1116

<li

1117

><a href="#controls_android.tonemap.gamma">android.tonemap.gamma</a></li>

1118

<li

1119

><a href="#controls_android.tonemap.presetCurve">android.tonemap.presetCurve</a></li>

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

</ul>

</li>

<li>

static

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

1125

<li

1126

><a href="#static_android.tonemap.maxCurvePoints">android.tonemap.maxCurvePoints</a></li>

1127

<li

1128

><a href="#static_android.tonemap.availableToneMapModes">android.tonemap.availableToneMapModes</a></li>

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

</ul>

</li>

<li>

dynamic

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

1134

<li

1135

><a href="#dynamic_android.tonemap.curveBlue">android.tonemap.curveBlue</a></li>

1136

<li

1137

><a href="#dynamic_android.tonemap.curveGreen">android.tonemap.curveGreen</a></li>

1138

<li

1139

><a href="#dynamic_android.tonemap.curveRed">android.tonemap.curveRed</a></li>

1140

<li

Yin-Chia Yeh

2014-05-27 09:48:07 -0700

[diff] [blame]

1141

><a href="#dynamic_android.tonemap.curve">android.tonemap.curve</a></li>

1142

<li

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

1143

><a href="#dynamic_android.tonemap.mode">android.tonemap.mode</a></li>

Yin-Chia Yeh

2015-02-05 13:19:21 -0800

[diff] [blame]

1144

<li

1145

><a href="#dynamic_android.tonemap.gamma">android.tonemap.gamma</a></li>

1146

<li

1147

><a href="#dynamic_android.tonemap.presetCurve">android.tonemap.presetCurve</a></li>

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

1148

</ul>

1149

</li>

1150

</ul>

</li>

<li>

<li>

controls

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

1158

<li

1159

><a href="#controls_android.led.transmit">android.led.transmit</a></li>

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

</ul>

</li>

<li>

dynamic

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

1165

<li

1166

><a href="#dynamic_android.led.transmit">android.led.transmit</a></li>

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

</ul>

</li>

<li>

static

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

1172

<li

1173

><a href="#static_android.led.availableLeds">android.led.availableLeds</a></li>

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

1174

</ul>

1175

</li>

1176

</ul>

</li>

<li>

<li>

static

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

1184

<li

1185

><a href="#static_android.info.supportedHardwareLevel">android.info.supportedHardwareLevel</a></li>

Chien-Yu Chen

218925a

2018-01-03 12:04:48 -0800

[diff] [blame]

1186

<li

1187

><a href="#static_android.info.version">android.info.version</a></li>

Yin-Chia Yeh

5fd3886

2018-09-17 11:52:08 -0700

[diff] [blame]

1188

<li

1189

><a href="#static_android.info.supportedBufferManagementVersion">android.info.supportedBufferManagementVersion</a></li>

Emilian Peev

2021-09-24 17:45:05 -0700

[diff] [blame]

1190

<li

Emilian Peev

2021-10-12 13:11:27 -0700

[diff] [blame]

1191

><a href="#static_android.info.deviceStateSensorOrientationMap">android.info.deviceStateSensorOrientationMap</a></li>

Emilian Peev

2021-09-24 17:45:05 -0700

[diff] [blame]

1192

<li

1193

><a href="#static_android.info.deviceStateOrientations">android.info.deviceStateOrientations</a></li>

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

1194

</ul>

1195

</li>

1196

</ul>

1197

</li>

Zhijun He

2013-07-17 09:42:58 -0700

[diff] [blame]

1198

<li>

1199

<a href="#section_blackLevel">blackLevel</a>

<li>

controls

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

1204

<li

1205

><a href="#controls_android.blackLevel.lock">android.blackLevel.lock</a></li>

Zhijun He

2013-07-17 09:42:58 -0700

[diff] [blame]

</ul>

</li>

<li>

dynamic

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

1211

<li

1212

><a href="#dynamic_android.blackLevel.lock">android.blackLevel.lock</a></li>

Zhijun He

2013-07-17 09:42:58 -0700

[diff] [blame]

1213

</ul>

1214

</li>

1215

</ul>

1216

</li>

Igor Murashkin

2014-01-16 17:51:36 -0800

[diff] [blame]

<li>

<li>

dynamic

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

1223

<li

1224

><a href="#dynamic_android.sync.frameNumber">android.sync.frameNumber</a></li>

Igor Murashkin

2014-01-16 17:51:36 -0800

[diff] [blame]

</ul>

</li>

<li>

static

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

1230

<li

1231

><a href="#static_android.sync.maxLatency">android.sync.maxLatency</a></li>

Igor Murashkin

2014-01-16 17:51:36 -0800

[diff] [blame]

1232

</ul>

1233

</li>

1234

</ul>

1235

</li>

Zhijun He

2015-01-15 18:17:24 -0800

[diff] [blame]

1236

<li>

1237

<a href="#section_reprocess">reprocess</a>

<li>

controls

<li

><a href="#controls_android.reprocess.effectiveExposureFactor">android.reprocess.effectiveExposureFactor</a></li>

</ul>

</li>

<li>

dynamic

<li

><a href="#dynamic_android.reprocess.effectiveExposureFactor">android.reprocess.effectiveExposureFactor</a></li>

1251

</ul>

1252

</li>

Zhijun He

2015-04-24 17:59:50 -0700

[diff] [blame]

<li>

static

<li

><a href="#static_android.reprocess.maxCaptureStall">android.reprocess.maxCaptureStall</a></li>

1258

</ul>

1259

</li>

Zhijun He

2015-01-15 18:17:24 -0800

[diff] [blame]

1260

</ul>

1261

</li>

Eino-Ville Talvala

2015-02-23 15:51:58 -0800

[diff] [blame]

1262

<li>

1263

<a href="#section_depth">depth</a>

<li>

static

<li

><a href="#static_android.depth.maxDepthSamples">android.depth.maxDepthSamples</a></li>

1270

<li

1271

><a href="#static_android.depth.availableDepthStreamConfigurations">android.depth.availableDepthStreamConfigurations</a></li>

1272

<li

1273

><a href="#static_android.depth.availableDepthMinFrameDurations">android.depth.availableDepthMinFrameDurations</a></li>

1274

<li

1275

><a href="#static_android.depth.availableDepthStallDurations">android.depth.availableDepthStallDurations</a></li>

Eino-Ville Talvala

2015-04-13 17:28:29 -0700

[diff] [blame]

1276

<li

1277

><a href="#static_android.depth.depthIsExclusive">android.depth.depthIsExclusive</a></li>

Emilian Peev

2018-09-18 14:01:55 +0100

[diff] [blame]

1278

<li

1279

><a href="#static_android.depth.availableRecommendedDepthStreamConfigurations">android.depth.availableRecommendedDepthStreamConfigurations</a></li>

Emilian Peev

65860e4

2019-01-04 17:49:37 +0000

[diff] [blame]

1280

<li

1281

><a href="#static_android.depth.availableDynamicDepthStreamConfigurations">android.depth.availableDynamicDepthStreamConfigurations</a></li>

1282

<li

1283

><a href="#static_android.depth.availableDynamicDepthMinFrameDurations">android.depth.availableDynamicDepthMinFrameDurations</a></li>

1284

<li

1285

><a href="#static_android.depth.availableDynamicDepthStallDurations">android.depth.availableDynamicDepthStallDurations</a></li>

Jayant Chowdhary

2020-11-09 09:08:31 -0800

[diff] [blame]

1286

<li

1287

><a href="#static_android.depth.availableDepthStreamConfigurationsMaximumResolution">android.depth.availableDepthStreamConfigurationsMaximumResolution</a></li>

1288

<li

1289

><a href="#static_android.depth.availableDepthMinFrameDurationsMaximumResolution">android.depth.availableDepthMinFrameDurationsMaximumResolution</a></li>

1290

<li

1291

><a href="#static_android.depth.availableDepthStallDurationsMaximumResolution">android.depth.availableDepthStallDurationsMaximumResolution</a></li>

1292

<li

1293

><a href="#static_android.depth.availableDynamicDepthStreamConfigurationsMaximumResolution">android.depth.availableDynamicDepthStreamConfigurationsMaximumResolution</a></li>

1294

<li

1295

><a href="#static_android.depth.availableDynamicDepthMinFrameDurationsMaximumResolution">android.depth.availableDynamicDepthMinFrameDurationsMaximumResolution</a></li>

1296

<li

1297

><a href="#static_android.depth.availableDynamicDepthStallDurationsMaximumResolution">android.depth.availableDynamicDepthStallDurationsMaximumResolution</a></li>

Eino-Ville Talvala

2015-02-23 15:51:58 -0800

[diff] [blame]

1298

</ul>

1299

</li>

1300

</ul>

1301

</li>

Shuzhen Wang

2017-11-30 12:03:37 -0800

[diff] [blame]

1302

<li>

1303

<a href="#section_logicalMultiCamera">logicalMultiCamera</a>

<li>

static

<li

><a href="#static_android.logicalMultiCamera.physicalIds">android.logicalMultiCamera.physicalIds</a></li>

1310

<li

1311

><a href="#static_android.logicalMultiCamera.sensorSyncType">android.logicalMultiCamera.sensorSyncType</a></li>

1312

</ul>

1313

</li>

Shuzhen Wang

2018-11-19 12:15:18 -0800

[diff] [blame]

<li>

dynamic

<li

><a href="#dynamic_android.logicalMultiCamera.activePhysicalId">android.logicalMultiCamera.activePhysicalId</a></li>

1319

</ul>

1320

</li>

Shuzhen Wang

2017-11-30 12:03:37 -0800

[diff] [blame]

1321

</ul>

1322

</li>

Eino-Ville Talvala

2018-03-13 19:46:57 -0700

[diff] [blame]

1323

<li>

1324

<a href="#section_distortionCorrection">distortionCorrection</a>

<li>

controls

<li

><a href="#controls_android.distortionCorrection.mode">android.distortionCorrection.mode</a></li>

</ul>

</li>

<li>

static

<li

><a href="#static_android.distortionCorrection.availableModes">android.distortionCorrection.availableModes</a></li>

</ul>

</li>

<li>

dynamic

<li

><a href="#dynamic_android.distortionCorrection.mode">android.distortionCorrection.mode</a></li>

1345

</ul>

1346

</li>

1347

</ul>

1348

</li>

Shuzhen Wang

2018-12-28 18:50:53 -0800

[diff] [blame]

<li>

<li>

static

<li

><a href="#static_android.heic.info.supported">android.heic.info.supported</a></li>

1358

<li

1359

><a href="#static_android.heic.info.maxJpegAppSegmentsCount">android.heic.info.maxJpegAppSegmentsCount</a></li>

1360

1361

<li

1362

><a href="#static_android.heic.availableHeicStreamConfigurations">android.heic.availableHeicStreamConfigurations</a></li>

1363

<li

1364

><a href="#static_android.heic.availableHeicMinFrameDurations">android.heic.availableHeicMinFrameDurations</a></li>

1365

<li

1366

><a href="#static_android.heic.availableHeicStallDurations">android.heic.availableHeicStallDurations</a></li>

Jayant Chowdhary

2020-11-09 09:08:31 -0800

[diff] [blame]

1367

<li

1368

><a href="#static_android.heic.availableHeicStreamConfigurationsMaximumResolution">android.heic.availableHeicStreamConfigurationsMaximumResolution</a></li>

1369

<li

1370

><a href="#static_android.heic.availableHeicMinFrameDurationsMaximumResolution">android.heic.availableHeicMinFrameDurationsMaximumResolution</a></li>

1371

<li

1372

><a href="#static_android.heic.availableHeicStallDurationsMaximumResolution">android.heic.availableHeicStallDurationsMaximumResolution</a></li>

Shuzhen Wang

2018-12-28 18:50:53 -0800

[diff] [blame]

1373

</ul>

1374

</li>

1375

</ul>

1376

</li>

Changyeon Jo

2022-01-19 13:51:47 -0800

[diff] [blame]

1377

<li>

1378

<a href="#section_automotive">automotive</a>

<li>

static

<li

><a href="#static_android.automotive.lens.facing">android.automotive.lens.facing</a></li>

1386

1387

<li

1388

><a href="#static_android.automotive.location">android.automotive.location</a></li>

1389

</ul>

1390

</li>

1391

</ul>

1392

</li>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

1393

</ul>

1394

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

1395

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

<h1>Properties</h1>

<tr>

<th class="th_name">Property Name</th>

1402

1403

<th class="th_description">Description</th>

1404

<th class="th_units">Units</th>

1405

<th class="th_range">Range</th>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

1406

<th class="th_hal_version">HIDL HAL version</th>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

1407

1408

</tr>

1409

</thead> <!-- so that the first occurrence of thead is not

1410

above the first occurrence of tr -->

1411

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

1412

<tr><td colspan="7" id="section_colorCorrection" class="section">colorCorrection</td></tr>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

1413

1414

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

1415

<tr><td colspan="7" class="kind">controls</td></tr>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

1416

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

1417

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

1418

<tr>

1419

<th class="th_name">Property Name</th>

1420

1421

<th class="th_description">Description</th>

1422

<th class="th_units">Units</th>

1423

<th class="th_range">Range</th>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

1424

<th class="th_hal_version">Initial HIDL HAL version</th>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</tr>

</thead>

<tbody>

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

1441

<td class="entry_name

Yin-Chia Yeh

2015-04-02 14:00:40 -0700

[diff] [blame]

1442

" rowspan="5">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

1443

android.colorCorrection.mode

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

1444

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

1445

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

1446

byte

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

1447

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

1448

[public]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

1449

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

1450

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

1451

[full]

1452

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

1453

1454

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

1455

1456

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

1457

TRANSFORM_MATRIX (v3.2)

Igor Murashkin

2014-01-15 17:05:22 -0800

[diff] [blame]

1458

Use the <a href="#controls_android.colorCorrection.transform">android.colorCorrection.transform</a> matrix

Igor Murashkin

2014-01-10 15:58:35 -0800

[diff] [blame]

1459

and <a href="#controls_android.colorCorrection.gains">android.colorCorrection.gains</a> to do color conversion.

1460

All advanced white balance adjustments (not specified

1461

by our white balance pipeline) must be disabled.

1462

If AWB is enabled with <code><a href="#controls_android.control.awbMode">android.control.awbMode</a> != OFF</code>, then

1463

TRANSFORM_MATRIX is ignored. The camera device will override

1464

this value to either FAST or HIGH_QUALITY.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

1465

</li>

1466

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

1467

FAST (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

1468

Color correction processing must not slow down

1469

capture rate relative to sensor raw output.

Igor Murashkin

2014-01-10 15:58:35 -0800

[diff] [blame]

1470

Advanced white balance adjustments above and beyond

1471

the specified white balance pipeline may be applied.

1472

If AWB is enabled with <code><a href="#controls_android.control.awbMode">android.control.awbMode</a> != OFF</code>, then

1473

the camera device uses the last frame's AWB values

1474

(or defaults if AWB has never been run).

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

1475

</li>

1476

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

1477

HIGH_QUALITY (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

1478

Color correction processing operates at improved

Yin-Chia Yeh

2015-04-02 14:00:40 -0700

[diff] [blame]

1479

quality but the capture rate might be reduced (relative to sensor

1480

raw output rate)

Igor Murashkin

2014-01-10 15:58:35 -0800

[diff] [blame]

1481

Advanced white balance adjustments above and beyond

1482

the specified white balance pipeline may be applied.

1483

If AWB is enabled with <code><a href="#controls_android.control.awbMode">android.control.awbMode</a> != OFF</code>, then

1484

the camera device uses the last frame's AWB values

1485

(or defaults if AWB has never been run).

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</li>

</ul>

</td>

1490

1491

Igor Murashkin

2014-01-10 15:58:35 -0800

[diff] [blame]

1492

The mode control selects how the image data is converted from the

1493

sensor's native color into linear sRGB color.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

1509

</tr>

1510

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

1511

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

1512

</tr>

1513

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

1514

Eino-Ville Talvala

2014-06-06 14:35:41 -0700

[diff] [blame]

1515

When auto-white balance (AWB) is enabled with <a href="#controls_android.control.awbMode">android.control.awbMode</a>, this

Igor Murashkin

2014-01-10 15:58:35 -0800

[diff] [blame]

1516

control is overridden by the AWB routine. When AWB is disabled, the

1517

application controls how the color mapping is performed.

1518

We define the expected processing pipeline below. For consistency

1519

across devices, this is always the case with TRANSFORM_MATRIX.

Shuzhen Wang

2019-07-08 15:03:24 -0700

[diff] [blame]

1520

When either FAST or HIGH_QUALITY is used, the camera device may

Igor Murashkin

2014-01-10 15:58:35 -0800

[diff] [blame]

1521

do additional processing but <a href="#controls_android.colorCorrection.gains">android.colorCorrection.gains</a> and

1522

<a href="#controls_android.colorCorrection.transform">android.colorCorrection.transform</a> will still be provided by the

1523

camera device (in the results) and be roughly correct.

1524

Switching to TRANSFORM_MATRIX and using the data provided from

1525

FAST or HIGH_QUALITY will yield a picture with the same white point

1526

as what was produced by the camera device in the earlier frame.

1527

The expected processing pipeline is as follows:

1528

1529

The white balance is encoded by two values, a 4-channel white-balance

1530

gain vector (applied in the Bayer domain), and a 3x3 color transform

1531

matrix (applied after demosaic).

1532

The 4-channel white-balance gains are defined as:

1533

<pre><code><a href="#controls_android.colorCorrection.gains">android.colorCorrection.gains</a> = [ R G_even G_odd B ]

1534

</code></pre>

1535

where <code>G_even</code> is the gain for green pixels on even rows of the

1536

output, and <code>G_odd</code> is the gain for green pixels on the odd rows.

1537

These may be identical for a given camera device implementation; if

1538

the camera device does not support a separate gain for even/odd green

1539

channels, it will use the <code>G_even</code> value, and write <code>G_odd</code> equal to

1540

<code>G_even</code> in the output result metadata.

1541

The matrices for color transforms are defined as a 9-entry vector:

1542

<pre><code><a href="#controls_android.colorCorrection.transform">android.colorCorrection.transform</a> = [ I0 I1 I2 I3 I4 I5 I6 I7 I8 ]

1543

</code></pre>

1544

which define a transform from input sensor colors, <code>P_in = [ r g b ]</code>,

1545

to output linear sRGB, <code>P_out = [ r' g' b' ]</code>,

1546

with colors as follows:

1547

<pre><code>r' = I0r + I1g + I2b

g' = I3r + I4g + I5b

b' = I6r + I7g + I8b

</code></pre>

Both the input and output value ranges must match. Overflow/underflow

1552

values are clipped to fit within the range.

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

1553

</td>

1554

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

1555

Yin-Chia Yeh

2015-04-02 14:00:40 -0700

[diff] [blame]

1556

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

1557

<th class="th_details" colspan="6">HAL Implementation Details</th>

Yin-Chia Yeh

2015-04-02 14:00:40 -0700

[diff] [blame]

1558

</tr>

1559

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

1560

Yin-Chia Yeh

2015-04-02 14:00:40 -0700

[diff] [blame]

1561

HAL must support both FAST and HIGH_QUALITY if color correction control is available

1562

on the camera device, but the underlying implementation can be the same for both modes.

1563

That is, if the highest quality implementation on the camera device does not slow down

1564

capture rate, then FAST and HIGH_QUALITY should generate the same output.

1565

</td>

1566

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

1567

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

1568

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

1569

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

1573

<td class="entry_name

1574

" rowspan="3">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

1575

android.colorCorrection.transform

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

1576

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

1577

Zhijun He

2013-07-17 09:42:58 -0700

[diff] [blame]

1578

rational

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

x

3 x 3

Eino-Ville Talvala

2014-05-27 10:50:30 -0700

[diff] [blame]

1584

[public as colorSpaceTransform]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

1585

1586

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

1587

[full]

1588

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

1589

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

1590

<div class="entry_type_notes">3x3 rational matrix in row-major order</div>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

1591

1592

1593

</td>

1594

1595

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

1596

A color transform matrix to use to transform

Eino-Ville Talvala

2014-06-06 14:35:41 -0700

[diff] [blame]

1597

from sensor RGB color space to output linear sRGB color space.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

1601

Unitless scale factors

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

1605

</td>

1606

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

1616

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

1617

</tr>

1618

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

1619

Zhijun He

2014-02-04 16:42:46 -0800

[diff] [blame]

1620

This matrix is either set by the camera device when the request

Eino-Ville Talvala

2014-01-02 16:11:44 -0800

[diff] [blame]

1621

<a href="#controls_android.colorCorrection.mode">android.colorCorrection.mode</a> is not TRANSFORM_MATRIX, or

Igor Murashkin

2013-12-09 12:06:17 -0800

[diff] [blame]

1622

directly by the application in the request when the

Eino-Ville Talvala

2014-01-02 16:11:44 -0800

[diff] [blame]

1623

<a href="#controls_android.colorCorrection.mode">android.colorCorrection.mode</a> is TRANSFORM_MATRIX.

Zhijun He

2014-02-04 16:42:46 -0800

[diff] [blame]

1624

In the latter case, the camera device may round the matrix to account

1625

for precision issues; the final rounded matrix should be reported back

1626

in this matrix result metadata. The transform should keep the magnitude

1627

of the output color values within <code>[0, 1.0]</code> (assuming input color

1628

values is within the normalized range <code>[0, 1.0]</code>), or clipping may occur.

Yin-Chia Yeh

2015-01-28 13:18:31 -0800

[diff] [blame]

1629

The valid range of each matrix element varies on different devices, but

1630

values within [-1.5, 3.0] are guaranteed not to be clipped.

Zhijun He

2013-07-17 09:42:58 -0700

[diff] [blame]

1631

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

1632

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

1633

1634

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

1635

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

1636

Zhijun He

2013-07-17 09:42:58 -0700

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

1640

<td class="entry_name

Eino-Ville Talvala

2014-05-27 10:50:30 -0700

[diff] [blame]

1641

" rowspan="5">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

1642

android.colorCorrection.gains

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

1643

</td>

Zhijun He

2013-07-17 09:42:58 -0700

[diff] [blame]

float

x

4

Eino-Ville Talvala

2014-05-27 10:50:30 -0700

[diff] [blame]

1651

[public as rggbChannelVector]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

1652

1653

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

1654

[full]

1655

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

1656

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

1657

<div class="entry_type_notes">A 1D array of floats for 4 color channel gains</div>

Zhijun He

2013-07-17 09:42:58 -0700

[diff] [blame]

1658

1659

1660

</td>

1661

1662

Igor Murashkin

2014-01-10 15:58:35 -0800

[diff] [blame]

1663

Gains applying to Bayer raw color channels for

Zhijun He

2014-02-24 09:49:37 -0800

[diff] [blame]

1664

white-balance.

Zhijun He

2013-07-17 09:42:58 -0700

[diff] [blame]

</td>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

1668

Unitless gain factors

Zhijun He

2013-07-17 09:42:58 -0700

[diff] [blame]

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

1683

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

1684

</tr>

1685

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

1686

Eino-Ville Talvala

2014-05-27 10:50:30 -0700

[diff] [blame]

1687

These per-channel gains are either set by the camera device

1688

when the request <a href="#controls_android.colorCorrection.mode">android.colorCorrection.mode</a> is not

1689

TRANSFORM_MATRIX, or directly by the application in the

1690

request when the <a href="#controls_android.colorCorrection.mode">android.colorCorrection.mode</a> is

1691

TRANSFORM_MATRIX.

1692

The gains in the result metadata are the gains actually

1693

applied by the camera device to the current frame.

Yin-Chia Yeh

2015-01-28 13:18:31 -0800

[diff] [blame]

1694

The valid range of gains varies on different devices, but gains

1695

between [1.0, 3.0] are guaranteed not to be clipped. Even if a given

1696

device allows gains below 1.0, this is usually not recommended because

1697

this can create color artifacts.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

1698

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

1699

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

1700

Eino-Ville Talvala

2014-05-27 10:50:30 -0700

[diff] [blame]

1701

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

1702

<th class="th_details" colspan="6">HAL Implementation Details</th>

Eino-Ville Talvala

2014-05-27 10:50:30 -0700

[diff] [blame]

1703

</tr>

1704

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

1705

Eino-Ville Talvala

2014-05-27 10:50:30 -0700

[diff] [blame]

1706

The 4-channel white-balance gains are defined in

1707

the order of <code>[R G_even G_odd B]</code>, where <code>G_even</code> is the gain

1708

for green pixels on even rows of the output, and <code>G_odd</code>

1709

is the gain for green pixels on the odd rows.

1710

If a HAL does not support a separate gain for even/odd green

1711

channels, it must use the <code>G_even</code> value, and write

1712

<code>G_odd</code> equal to <code>G_even</code> in the output result metadata.

1713

</td>

1714

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

1715

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

1716

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

1717

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

1718

Zhijun He

2014-07-01 18:27:42 -0700

[diff] [blame]

1719

Zhijun He

2014-08-18 10:55:33 -0700

[diff] [blame]

1720

Zhijun He

2014-07-01 18:27:42 -0700

[diff] [blame]

1721

<td class="entry_name

1722

" rowspan="3">

Zhijun He

2014-08-18 10:55:33 -0700

[diff] [blame]

1723

android.colorCorrection.aberrationMode

Zhijun He

2014-07-01 18:27:42 -0700

[diff] [blame]

</td>

byte

[public]

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

1731

[legacy]

1732

Zhijun He

2014-07-01 18:27:42 -0700

[diff] [blame]

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

1737

OFF (v3.2)

Zhijun He

2014-07-01 18:27:42 -0700

[diff] [blame]

1738

No aberration correction is applied.

1739

</li>

1740

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

1741

FAST (v3.2)

Zhijun He

2014-07-01 18:27:42 -0700

[diff] [blame]

1742

Aberration correction will not slow down capture rate

1743

relative to sensor raw output.

1744

</li>

1745

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

1746

HIGH_QUALITY (v3.2)

Yin-Chia Yeh

2015-04-02 14:00:40 -0700

[diff] [blame]

1747

Aberration correction operates at improved quality but the capture rate might be

1748

reduced (relative to sensor raw output rate)

Zhijun He

2014-07-01 18:27:42 -0700

[diff] [blame]

</li>

</ul>

</td>

1753

1754

1755

Mode of operation for the chromatic aberration correction algorithm.

</td>

</td>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

1762

<a href="#static_android.colorCorrection.availableAberrationModes">android.colorCorrection.availableAberrationModes</a>

Zhijun He

2014-07-01 18:27:42 -0700

[diff] [blame]

1763

</td>

1764

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Zhijun He

2014-07-01 18:27:42 -0700

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

1774

<th class="th_details" colspan="6">Details</th>

Zhijun He

2014-07-01 18:27:42 -0700

[diff] [blame]

1775

</tr>

1776

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

1777

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

1778

Chromatic (color) aberration is caused by the fact that different wavelengths of light

Zhijun He

2014-07-01 18:27:42 -0700

[diff] [blame]

1779

can not focus on the same point after exiting from the lens. This metadata defines

1780

the high level control of chromatic aberration correction algorithm, which aims to

1781

minimize the chromatic artifacts that may occur along the object boundaries in an

1782

image.

1783

FAST/HIGH_QUALITY both mean that camera device determined aberration

1784

correction will be applied. HIGH_QUALITY mode indicates that the camera device will

1785

use the highest-quality aberration correction algorithms, even if it slows down

1786

capture rate. FAST means the camera device will not slow down capture rate when

1787

applying aberration correction.

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

1788

LEGACY devices will always be in FAST mode.

Zhijun He

2014-07-01 18:27:42 -0700

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

1793

Zhijun He

2014-07-01 18:27:42 -0700

[diff] [blame]

1794

1795

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</tbody>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

1800

<tr><td colspan="7" class="kind">dynamic</td></tr>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

1801

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

1802

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

1803

<tr>

1804

<th class="th_name">Property Name</th>

1805

1806

<th class="th_description">Description</th>

1807

<th class="th_units">Units</th>

1808

<th class="th_range">Range</th>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

1809

<th class="th_hal_version">Initial HIDL HAL version</th>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</tr>

</thead>

<tbody>

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

1825

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

1826

<td class="entry_name

Yin-Chia Yeh

2015-04-02 14:00:40 -0700

[diff] [blame]

1827

" rowspan="5">

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

1828

android.colorCorrection.mode

</td>

byte

[public]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

1835

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

1836

[full]

1837

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

1838

1839

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

1840

1841

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

1842

TRANSFORM_MATRIX (v3.2)

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

1843

Use the <a href="#controls_android.colorCorrection.transform">android.colorCorrection.transform</a> matrix

1844

and <a href="#controls_android.colorCorrection.gains">android.colorCorrection.gains</a> to do color conversion.

1845

All advanced white balance adjustments (not specified

1846

by our white balance pipeline) must be disabled.

1847

If AWB is enabled with <code><a href="#controls_android.control.awbMode">android.control.awbMode</a> != OFF</code>, then

1848

TRANSFORM_MATRIX is ignored. The camera device will override

1849

this value to either FAST or HIGH_QUALITY.

1850

</li>

1851

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

1852

FAST (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

1853

Color correction processing must not slow down

1854

capture rate relative to sensor raw output.

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

1855

Advanced white balance adjustments above and beyond

1856

the specified white balance pipeline may be applied.

1857

If AWB is enabled with <code><a href="#controls_android.control.awbMode">android.control.awbMode</a> != OFF</code>, then

1858

the camera device uses the last frame's AWB values

1859

(or defaults if AWB has never been run).

1860

</li>

1861

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

1862

HIGH_QUALITY (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

1863

Color correction processing operates at improved

Yin-Chia Yeh

2015-04-02 14:00:40 -0700

[diff] [blame]

1864

quality but the capture rate might be reduced (relative to sensor

1865

raw output rate)

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

1866

Advanced white balance adjustments above and beyond

1867

the specified white balance pipeline may be applied.

1868

If AWB is enabled with <code><a href="#controls_android.control.awbMode">android.control.awbMode</a> != OFF</code>, then

1869

the camera device uses the last frame's AWB values

1870

(or defaults if AWB has never been run).

</li>

</ul>

</td>

1875

1876

1877

The mode control selects how the image data is converted from the

1878

sensor's native color into linear sRGB color.

</td>

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

1896

<th class="th_details" colspan="6">Details</th>

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

1897

</tr>

1898

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

1899

Eino-Ville Talvala

2014-06-06 14:35:41 -0700

[diff] [blame]

1900

When auto-white balance (AWB) is enabled with <a href="#controls_android.control.awbMode">android.control.awbMode</a>, this

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

1901

control is overridden by the AWB routine. When AWB is disabled, the

1902

application controls how the color mapping is performed.

1903

We define the expected processing pipeline below. For consistency

1904

across devices, this is always the case with TRANSFORM_MATRIX.

Shuzhen Wang

2019-07-08 15:03:24 -0700

[diff] [blame]

1905

When either FAST or HIGH_QUALITY is used, the camera device may

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

1906

do additional processing but <a href="#controls_android.colorCorrection.gains">android.colorCorrection.gains</a> and

1907

<a href="#controls_android.colorCorrection.transform">android.colorCorrection.transform</a> will still be provided by the

1908

camera device (in the results) and be roughly correct.

1909

Switching to TRANSFORM_MATRIX and using the data provided from

1910

FAST or HIGH_QUALITY will yield a picture with the same white point

1911

as what was produced by the camera device in the earlier frame.

1912

The expected processing pipeline is as follows:

1913

1914

The white balance is encoded by two values, a 4-channel white-balance

1915

gain vector (applied in the Bayer domain), and a 3x3 color transform

1916

matrix (applied after demosaic).

1917

The 4-channel white-balance gains are defined as:

1918

<pre><code><a href="#controls_android.colorCorrection.gains">android.colorCorrection.gains</a> = [ R G_even G_odd B ]

1919

</code></pre>

1920

where <code>G_even</code> is the gain for green pixels on even rows of the

1921

output, and <code>G_odd</code> is the gain for green pixels on the odd rows.

1922

These may be identical for a given camera device implementation; if

1923

the camera device does not support a separate gain for even/odd green

1924

channels, it will use the <code>G_even</code> value, and write <code>G_odd</code> equal to

1925

<code>G_even</code> in the output result metadata.

1926

The matrices for color transforms are defined as a 9-entry vector:

1927

<pre><code><a href="#controls_android.colorCorrection.transform">android.colorCorrection.transform</a> = [ I0 I1 I2 I3 I4 I5 I6 I7 I8 ]

1928

</code></pre>

1929

which define a transform from input sensor colors, <code>P_in = [ r g b ]</code>,

1930

to output linear sRGB, <code>P_out = [ r' g' b' ]</code>,

1931

with colors as follows:

1932

<pre><code>r' = I0r + I1g + I2b

g' = I3r + I4g + I5b

b' = I6r + I7g + I8b

</code></pre>

Both the input and output value ranges must match. Overflow/underflow

1937

values are clipped to fit within the range.

</td>

</tr>

Yin-Chia Yeh

2015-04-02 14:00:40 -0700

[diff] [blame]

1941

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

1942

<th class="th_details" colspan="6">HAL Implementation Details</th>

Yin-Chia Yeh

2015-04-02 14:00:40 -0700

[diff] [blame]

1943

</tr>

1944

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

1945

Yin-Chia Yeh

2015-04-02 14:00:40 -0700

[diff] [blame]

1946

HAL must support both FAST and HIGH_QUALITY if color correction control is available

1947

on the camera device, but the underlying implementation can be the same for both modes.

1948

That is, if the highest quality implementation on the camera device does not slow down

1949

capture rate, then FAST and HIGH_QUALITY should generate the same output.

1950

</td>

1951

</tr>

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

1952

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

1953

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

1954

1955

1956

Zhijun He

2013-07-17 09:42:58 -0700

[diff] [blame]

1957

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

1958

<td class="entry_name

1959

" rowspan="3">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

1960

android.colorCorrection.transform

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

1961

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

1962

Zhijun He

2013-07-17 09:42:58 -0700

[diff] [blame]

1963

rational

1964

x

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

1965

Zhijun He

2013-07-17 09:42:58 -0700

[diff] [blame]

3 x 3

Eino-Ville Talvala

2014-05-27 10:50:30 -0700

[diff] [blame]

1969

[public as colorSpaceTransform]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

1970

1971

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

1972

[full]

1973

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

1974

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

1975

<div class="entry_type_notes">3x3 rational matrix in row-major order</div>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

1976

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

1977

1978

</td>

1979

1980

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

1981

A color transform matrix to use to transform

Eino-Ville Talvala

2014-06-06 14:35:41 -0700

[diff] [blame]

1982

from sensor RGB color space to output linear sRGB color space.

Zhijun He

2013-07-17 09:42:58 -0700

[diff] [blame]

</td>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

1986

Unitless scale factors

Zhijun He

2013-07-17 09:42:58 -0700

[diff] [blame]

</td>

Zhijun He

2013-07-17 09:42:58 -0700

[diff] [blame]

1990

</td>

1991

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

2001

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

2002

</tr>

2003

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

2004

Zhijun He

2014-02-04 16:42:46 -0800

[diff] [blame]

2005

This matrix is either set by the camera device when the request

Eino-Ville Talvala

2014-01-02 16:11:44 -0800

[diff] [blame]

2006

<a href="#controls_android.colorCorrection.mode">android.colorCorrection.mode</a> is not TRANSFORM_MATRIX, or

Igor Murashkin

2013-12-09 12:06:17 -0800

[diff] [blame]

2007

directly by the application in the request when the

Eino-Ville Talvala

2014-01-02 16:11:44 -0800

[diff] [blame]

2008

<a href="#controls_android.colorCorrection.mode">android.colorCorrection.mode</a> is TRANSFORM_MATRIX.

Zhijun He

2014-02-04 16:42:46 -0800

[diff] [blame]

2009

In the latter case, the camera device may round the matrix to account

2010

for precision issues; the final rounded matrix should be reported back

2011

in this matrix result metadata. The transform should keep the magnitude

2012

of the output color values within <code>[0, 1.0]</code> (assuming input color

2013

values is within the normalized range <code>[0, 1.0]</code>), or clipping may occur.

Yin-Chia Yeh

2015-01-28 13:18:31 -0800

[diff] [blame]

2014

The valid range of each matrix element varies on different devices, but

2015

values within [-1.5, 3.0] are guaranteed not to be clipped.

Zhijun He

2013-07-17 09:42:58 -0700

[diff] [blame]

2016

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

2017

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

2018

2019

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

2020

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

2021

Zhijun He

2013-07-17 09:42:58 -0700

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

2025

<td class="entry_name

Eino-Ville Talvala

2014-05-27 10:50:30 -0700

[diff] [blame]

2026

" rowspan="5">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

2027

android.colorCorrection.gains

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

2028

</td>

Zhijun He

2013-07-17 09:42:58 -0700

[diff] [blame]

float

x

4

Eino-Ville Talvala

2014-05-27 10:50:30 -0700

[diff] [blame]

2036

[public as rggbChannelVector]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

2037

2038

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

2039

[full]

2040

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

2041

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

2042

<div class="entry_type_notes">A 1D array of floats for 4 color channel gains</div>

Zhijun He

2013-07-17 09:42:58 -0700

[diff] [blame]

2043

2044

2045

</td>

2046

2047

Igor Murashkin

2014-01-10 15:58:35 -0800

[diff] [blame]

2048

Gains applying to Bayer raw color channels for

Zhijun He

2014-02-24 09:49:37 -0800

[diff] [blame]

2049

white-balance.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

2053

Unitless gain factors

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

2068

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

2069

</tr>

2070

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

2071

Eino-Ville Talvala

2014-05-27 10:50:30 -0700

[diff] [blame]

2072

These per-channel gains are either set by the camera device

2073

when the request <a href="#controls_android.colorCorrection.mode">android.colorCorrection.mode</a> is not

2074

TRANSFORM_MATRIX, or directly by the application in the

2075

request when the <a href="#controls_android.colorCorrection.mode">android.colorCorrection.mode</a> is

2076

TRANSFORM_MATRIX.

2077

The gains in the result metadata are the gains actually

2078

applied by the camera device to the current frame.

Yin-Chia Yeh

2015-01-28 13:18:31 -0800

[diff] [blame]

2079

The valid range of gains varies on different devices, but gains

2080

between [1.0, 3.0] are guaranteed not to be clipped. Even if a given

2081

device allows gains below 1.0, this is usually not recommended because

2082

this can create color artifacts.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

2083

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

2084

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

2085

Eino-Ville Talvala

2014-05-27 10:50:30 -0700

[diff] [blame]

2086

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

2087

<th class="th_details" colspan="6">HAL Implementation Details</th>

Eino-Ville Talvala

2014-05-27 10:50:30 -0700

[diff] [blame]

2088

</tr>

2089

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

2090

Eino-Ville Talvala

2014-05-27 10:50:30 -0700

[diff] [blame]

2091

The 4-channel white-balance gains are defined in

2092

the order of <code>[R G_even G_odd B]</code>, where <code>G_even</code> is the gain

2093

for green pixels on even rows of the output, and <code>G_odd</code>

2094

is the gain for green pixels on the odd rows.

2095

If a HAL does not support a separate gain for even/odd green

2096

channels, it must use the <code>G_even</code> value, and write

2097

<code>G_odd</code> equal to <code>G_even</code> in the output result metadata.

2098

</td>

2099

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

2100

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

2101

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

2102

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

2103

Zhijun He

2014-07-01 18:27:42 -0700

[diff] [blame]

2104

Zhijun He

2014-08-18 10:55:33 -0700

[diff] [blame]

2105

Zhijun He

2014-07-01 18:27:42 -0700

[diff] [blame]

2106

<td class="entry_name

2107

" rowspan="3">

Zhijun He

2014-08-18 10:55:33 -0700

[diff] [blame]

2108

android.colorCorrection.aberrationMode

Zhijun He

2014-07-01 18:27:42 -0700

[diff] [blame]

</td>

byte

[public]

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

2116

[legacy]

2117

Zhijun He

2014-07-01 18:27:42 -0700

[diff] [blame]

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

2122

OFF (v3.2)

Zhijun He

2014-07-01 18:27:42 -0700

[diff] [blame]

2123

No aberration correction is applied.

2124

</li>

2125

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

2126

FAST (v3.2)

Zhijun He

2014-07-01 18:27:42 -0700

[diff] [blame]

2127

Aberration correction will not slow down capture rate

2128

relative to sensor raw output.

2129

</li>

2130

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

2131

HIGH_QUALITY (v3.2)

Yin-Chia Yeh

2015-04-02 14:00:40 -0700

[diff] [blame]

2132

Aberration correction operates at improved quality but the capture rate might be

2133

reduced (relative to sensor raw output rate)

Zhijun He

2014-07-01 18:27:42 -0700

[diff] [blame]

</li>

</ul>

</td>

2138

2139

2140

Mode of operation for the chromatic aberration correction algorithm.

</td>

</td>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

2147

<a href="#static_android.colorCorrection.availableAberrationModes">android.colorCorrection.availableAberrationModes</a>

Zhijun He

2014-07-01 18:27:42 -0700

[diff] [blame]

2148

</td>

2149

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Zhijun He

2014-07-01 18:27:42 -0700

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

2159

<th class="th_details" colspan="6">Details</th>

Zhijun He

2014-07-01 18:27:42 -0700

[diff] [blame]

2160

</tr>

2161

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

2162

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

2163

Chromatic (color) aberration is caused by the fact that different wavelengths of light

Zhijun He

2014-07-01 18:27:42 -0700

[diff] [blame]

2164

can not focus on the same point after exiting from the lens. This metadata defines

2165

the high level control of chromatic aberration correction algorithm, which aims to

2166

minimize the chromatic artifacts that may occur along the object boundaries in an

2167

image.

2168

FAST/HIGH_QUALITY both mean that camera device determined aberration

2169

correction will be applied. HIGH_QUALITY mode indicates that the camera device will

2170

use the highest-quality aberration correction algorithms, even if it slows down

2171

capture rate. FAST means the camera device will not slow down capture rate when

2172

applying aberration correction.

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

2173

LEGACY devices will always be in FAST mode.

Zhijun He

2014-07-01 18:27:42 -0700

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

2178

Zhijun He

2014-07-01 18:27:42 -0700

[diff] [blame]

2179

</tbody>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

2185

<tr><td colspan="7" class="kind">static</td></tr>

Zhijun He

2014-07-01 18:27:42 -0700

[diff] [blame]

<tr>

<th class="th_name">Property Name</th>

2190

2191

<th class="th_description">Description</th>

2192

<th class="th_units">Units</th>

2193

<th class="th_range">Range</th>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

2194

<th class="th_hal_version">Initial HIDL HAL version</th>

Zhijun He

2014-07-01 18:27:42 -0700

[diff] [blame]

</tr>

</thead>

<tbody>

Zhijun He

2014-08-18 10:55:33 -0700

[diff] [blame]

2210

Zhijun He

2014-07-01 18:27:42 -0700

[diff] [blame]

2211

<td class="entry_name

Yin-Chia Yeh

2015-04-02 14:00:40 -0700

[diff] [blame]

2212

" rowspan="5">

Zhijun He

2014-08-18 10:55:33 -0700

[diff] [blame]

2213

android.colorCorrection.availableAberrationModes

Zhijun He

2014-07-01 18:27:42 -0700

[diff] [blame]

</td>

byte

x

n

[public as enumList]

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

2225

[legacy]

2226

Zhijun He

2014-07-01 18:27:42 -0700

[diff] [blame]

2227

2228

<div class="entry_type_notes">list of enums</div>

2229

2230

2231

</td>

2232

2233

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

2234

List of aberration correction modes for <a href="#controls_android.colorCorrection.aberrationMode">android.colorCorrection.aberrationMode</a> that are

2235

supported by this camera device.

Zhijun He

2014-07-01 18:27:42 -0700

[diff] [blame]

</td>

</td>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

2242

Any value listed in <a href="#controls_android.colorCorrection.aberrationMode">android.colorCorrection.aberrationMode</a>

Zhijun He

2014-07-01 18:27:42 -0700

[diff] [blame]

2243

</td>

2244

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Zhijun He

2014-07-01 18:27:42 -0700

[diff] [blame]

</ul>

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

2257

<th class="th_details" colspan="6">Details</th>

Zhijun He

2014-07-01 18:27:42 -0700

[diff] [blame]

2258

</tr>

2259

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

2260

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

2261

This key lists the valid modes for <a href="#controls_android.colorCorrection.aberrationMode">android.colorCorrection.aberrationMode</a>. If no

2262

aberration correction modes are available for a device, this list will solely include

Yin-Chia Yeh

aed8cea

2015-01-06 10:30:16 -0800

[diff] [blame]

2263

OFF mode. All camera devices will support either OFF or FAST mode.

2264

Camera devices that support the MANUAL_POST_PROCESSING capability will always list

2265

OFF mode. This includes all FULL level devices.

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

2266

LEGACY devices will always only support FAST mode.

Zhijun He

2014-07-01 18:27:42 -0700

[diff] [blame]

</td>

</tr>

Yin-Chia Yeh

2015-04-02 14:00:40 -0700

[diff] [blame]

2270

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

2271

<th class="th_details" colspan="6">HAL Implementation Details</th>

Yin-Chia Yeh

2015-04-02 14:00:40 -0700

[diff] [blame]

2272

</tr>

2273

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

2274

Yin-Chia Yeh

2015-04-02 14:00:40 -0700

[diff] [blame]

2275

HAL must support both FAST and HIGH_QUALITY if chromatic aberration control is available

2276

on the camera device, but the underlying implementation can be the same for both modes.

2277

That is, if the highest quality implementation on the camera device does not slow down

2278

capture rate, then FAST and HIGH_QUALITY will generate the same output.

2279

</td>

2280

</tr>

Zhijun He

2014-07-01 18:27:42 -0700

[diff] [blame]

2281

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

2282

Zhijun He

2014-07-01 18:27:42 -0700

[diff] [blame]

2283

2284

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</tbody>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

2291

<tr><td colspan="7" id="section_control" class="section">control</td></tr>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

2292

2293

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

2294

<tr><td colspan="7" class="kind">controls</td></tr>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

2295

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

2296

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

2297

<tr>

2298

<th class="th_name">Property Name</th>

2299

2300

<th class="th_description">Description</th>

2301

<th class="th_units">Units</th>

2302

<th class="th_range">Range</th>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

2303

<th class="th_hal_version">Initial HIDL HAL version</th>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</tr>

</thead>

<tbody>

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

2320

<td class="entry_name

2321

" rowspan="5">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

2322

android.control.aeAntibandingMode

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

2323

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

2324

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

2325

byte

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

2326

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

2327

[public]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

2328

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

2329

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

2330

[legacy]

2331

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

2332

2333

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

2334

2335

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

2336

OFF (v3.2)

Igor Murashkin

2014-01-15 17:05:22 -0800

[diff] [blame]

2337

The camera device will not adjust exposure duration to

2338

avoid banding problems.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

2339

</li>

2340

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

2341

50HZ (v3.2)

Igor Murashkin

2014-01-15 17:05:22 -0800

[diff] [blame]

2342

The camera device will adjust exposure duration to

2343

avoid banding problems with 50Hz illumination sources.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

2344

</li>

2345

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

2346

60HZ (v3.2)

Igor Murashkin

2014-01-15 17:05:22 -0800

[diff] [blame]

2347

The camera device will adjust exposure duration to

2348

avoid banding problems with 60Hz illumination

2349

sources.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

2350

</li>

2351

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

2352

AUTO (v3.2)

Igor Murashkin

2014-01-15 17:05:22 -0800

[diff] [blame]

2353

The camera device will automatically adapt its

2354

antibanding routine to the current illumination

Yin-Chia Yeh

2014-11-25 11:51:48 -0800

[diff] [blame]

2355

condition. This is the default mode if AUTO is

2356

available on given camera device.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</li>

</ul>

</td>

2361

2362

Eino-Ville Talvala

2013-12-30 12:03:45 -0800

[diff] [blame]

2363

The desired setting for the camera device's auto-exposure

2364

algorithm's antibanding compensation.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

Eino-Ville Talvala

2014-01-02 16:11:44 -0800

[diff] [blame]

2371

<a href="#static_android.control.aeAvailableAntibandingModes">android.control.aeAvailableAntibandingModes</a>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

2372

</td>

2373

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

2378

Eino-Ville Talvala

2013-12-30 12:03:45 -0800

[diff] [blame]

2379

2380

2381

</ul>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

2382

</td>

2383

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

2384

</tr>

Eino-Ville Talvala

2013-12-30 12:03:45 -0800

[diff] [blame]

2385

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

2386

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-30 12:03:45 -0800

[diff] [blame]

2387

</tr>

2388

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

2389

Eino-Ville Talvala

2013-12-30 12:03:45 -0800

[diff] [blame]

2390

Some kinds of lighting fixtures, such as some fluorescent

2391

lights, flicker at the rate of the power supply frequency

2392

(60Hz or 50Hz, depending on country). While this is

2393

typically not noticeable to a person, it can be visible to

2394

a camera device. If a camera sets its exposure time to the

2395

wrong value, the flicker may become visible in the

2396

viewfinder as flicker or in a final captured image, as a

2397

set of variable-brightness bands across the image.

2398

Therefore, the auto-exposure routines of camera devices

2399

include antibanding routines that ensure that the chosen

2400

exposure value will not cause such banding. The choice of

2401

exposure time depends on the rate of flicker, which the

2402

camera device can detect automatically, or the expected

2403

rate can be selected by the application using this

2404

control.

2405

A given camera device may not support all of the possible

2406

options for the antibanding mode. The

2407

<a href="#static_android.control.aeAvailableAntibandingModes">android.control.aeAvailableAntibandingModes</a> key contains

2408

the available modes for a given camera device.

Yin-Chia Yeh

2014-11-25 11:51:48 -0800

[diff] [blame]

2409

AUTO mode is the default if it is available on given

2410

camera device. When AUTO mode is not available, the

2411

default will be either 50HZ or 60HZ, and both 50HZ

2412

and 60HZ will be available.

Eino-Ville Talvala

2013-12-30 12:03:45 -0800

[diff] [blame]

2413

If manual exposure control is enabled (by setting

2414

<a href="#controls_android.control.aeMode">android.control.aeMode</a> or <a href="#controls_android.control.mode">android.control.mode</a> to OFF),

2415

then this setting has no effect, and the application must

2416

ensure it selects exposure times that do not cause banding

2417

issues. The <a href="#dynamic_android.statistics.sceneFlicker">android.statistics.sceneFlicker</a> key can assist

2418

the application in this.

2419

</td>

2420

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

2421

Eino-Ville Talvala

2013-12-30 12:03:45 -0800

[diff] [blame]

2422

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

2423

<th class="th_details" colspan="6">HAL Implementation Details</th>

Eino-Ville Talvala

2013-12-30 12:03:45 -0800

[diff] [blame]

2424

</tr>

2425

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

2426

Eino-Ville Talvala

2013-12-30 12:03:45 -0800

[diff] [blame]

2427

For all capture request templates, this field must be set

Yin-Chia Yeh

2014-11-25 11:51:48 -0800

[diff] [blame]

2428

to AUTO if AUTO mode is available. If AUTO is not available,

2429

the default must be either 50HZ or 60HZ, and both 50HZ and

2430

60HZ must be available.

Eino-Ville Talvala

2013-12-30 12:03:45 -0800

[diff] [blame]

2431

If manual exposure control is enabled (by setting

2432

<a href="#controls_android.control.aeMode">android.control.aeMode</a> or <a href="#controls_android.control.mode">android.control.mode</a> to OFF),

2433

then the exposure values provided by the application must not be

2434

adjusted for antibanding.

2435

</td>

2436

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

2437

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

2438

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

2439

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

2443

<td class="entry_name

2444

" rowspan="3">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

2445

android.control.aeExposureCompensation

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

2446

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

2447

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

2448

int32

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

2449

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

2450

[public]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

2451

2452

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

2453

[legacy]

2454

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

2458

</td>

2459

2460

Eino-Ville Talvala

2014-06-06 14:35:41 -0700

[diff] [blame]

2461

Adjustment to auto-exposure (AE) target image

2462

brightness.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

2466

Compensation steps

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Eino-Ville Talvala

2014-06-06 14:35:41 -0700

[diff] [blame]

2470

<a href="#static_android.control.aeCompensationRange">android.control.aeCompensationRange</a>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

2471

</td>

2472

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

2477

2478

Igor Murashkin

2012-12-05 14:49:11 -0800

[diff] [blame]

2479

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</ul>

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

2483

</tr>

2484

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

2485

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

2486

</tr>

2487

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

2488

Eino-Ville Talvala

2014-06-06 14:35:41 -0700

[diff] [blame]

2489

The adjustment is measured as a count of steps, with the

2490

step size defined by <a href="#static_android.control.aeCompensationStep">android.control.aeCompensationStep</a> and the

2491

allowed range by <a href="#static_android.control.aeCompensationRange">android.control.aeCompensationRange</a>.

2492

For example, if the exposure value (EV) step is 0.333, '6'

2493

will mean an exposure compensation of +2 EV; -3 will mean an

2494

exposure compensation of -1 EV. One EV represents a doubling

2495

of image brightness. Note that this control will only be

2496

effective if <a href="#controls_android.control.aeMode">android.control.aeMode</a> <code>!=</code> OFF. This control

2497

will take effect even when <a href="#controls_android.control.aeLock">android.control.aeLock</a> <code>== true</code>.

Yin-Chia Yeh

2014-05-05 14:26:03 -0700

[diff] [blame]

2498

In the event of exposure compensation value being changed, camera device

2499

may take several frames to reach the newly requested exposure target.

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

2500

During that time, <a href="#dynamic_android.control.aeState">android.control.aeState</a> field will be in the SEARCHING

Yin-Chia Yeh

2014-05-05 14:26:03 -0700

[diff] [blame]

2501

state. Once the new exposure target is reached, <a href="#dynamic_android.control.aeState">android.control.aeState</a> will

2502

change from SEARCHING to either CONVERGED, LOCKED (if AE lock is enabled), or

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

2503

FLASH_REQUIRED (if the scene is too dark for still capture).

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

2504

</td>

2505

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

2506

2507

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

2508

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

2509

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

2513

<td class="entry_name

2514

" rowspan="3">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

2515

android.control.aeLock

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

2516

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

2517

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

2518

byte

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

2519

Igor Murashkin

2013-07-17 16:29:34 -0700

[diff] [blame]

2520

[public as boolean]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

2521

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

2522

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

2523

[legacy]

2524

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

2525

2526

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

2527

2528

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

2529

OFF (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

2530

Auto-exposure lock is disabled; the AE algorithm

Igor Murashkin

2014-01-15 17:05:22 -0800

[diff] [blame]

2531

is free to update its parameters.

Eino-Ville Talvala

2013-01-11 13:57:19 -0800

[diff] [blame]

2532

</li>

2533

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

2534

ON (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

2535

Auto-exposure lock is enabled; the AE algorithm

Igor Murashkin

2014-01-15 17:05:22 -0800

[diff] [blame]

2536

must not update the exposure and sensitivity parameters

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

2537

while the lock is active.

2538

<a href="#controls_android.control.aeExposureCompensation">android.control.aeExposureCompensation</a> setting changes

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

2539

will still take effect while auto-exposure is locked.

2540

Some rare LEGACY devices may not support

2541

this, in which case the value will always be overridden to OFF.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

2542

</li>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

2543

</ul>

2544

2545

</td>

2546

2547

Eino-Ville Talvala

2014-06-06 14:35:41 -0700

[diff] [blame]

2548

Whether auto-exposure (AE) is currently locked to its latest

Zhijun He

2014-02-04 16:42:46 -0800

[diff] [blame]

2549

calculated values.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

2562

2563

Igor Murashkin

2012-12-05 14:49:11 -0800

[diff] [blame]

2564

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</ul>

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

2568

</tr>

2569

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

2570

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

2571

</tr>

2572

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

2573

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

2574

When set to <code>true</code> (ON), the AE algorithm is locked to its latest parameters,

2575

and will not change exposure settings until the lock is set to <code>false</code> (OFF).

2576

Note that even when AE is locked, the flash may be fired if

2577

the <a href="#controls_android.control.aeMode">android.control.aeMode</a> is ON_AUTO_FLASH /

2578

ON_ALWAYS_FLASH / ON_AUTO_FLASH_REDEYE.

Yin-Chia Yeh

2014-05-05 14:26:03 -0700

[diff] [blame]

2579

When <a href="#controls_android.control.aeExposureCompensation">android.control.aeExposureCompensation</a> is changed, even if the AE lock

2580

is ON, the camera device will still adjust its exposure value.

Zhijun He

2014-02-04 16:42:46 -0800

[diff] [blame]

2581

If AE precapture is triggered (see <a href="#controls_android.control.aePrecaptureTrigger">android.control.aePrecaptureTrigger</a>)

2582

when AE is already locked, the camera device will not change the exposure time

2583

(<a href="#controls_android.sensor.exposureTime">android.sensor.exposureTime</a>) and sensitivity (<a href="#controls_android.sensor.sensitivity">android.sensor.sensitivity</a>)

Eino-Ville Talvala

2014-02-10 12:39:35 -0800

[diff] [blame]

2584

parameters. The flash may be fired if the <a href="#controls_android.control.aeMode">android.control.aeMode</a>

Zhijun He

2014-02-04 16:42:46 -0800

[diff] [blame]

2585

is ON_AUTO_FLASH/ON_AUTO_FLASH_REDEYE and the scene is too dark. If the

Zhijun He

2015-02-05 14:32:57 -0800

[diff] [blame]

2586

<a href="#controls_android.control.aeMode">android.control.aeMode</a> is ON_ALWAYS_FLASH, the scene may become overexposed.

2587

Similarly, AE precapture trigger CANCEL has no effect when AE is already locked.

2588

When an AE precapture sequence is triggered, AE unlock will not be able to unlock

2589

the AE if AE is locked by the camera device internally during precapture metering

2590

sequence In other words, submitting requests with AE unlock has no effect for an

2591

ongoing precapture metering sequence. Otherwise, the precapture metering sequence

2592

will never succeed in a sequence of preview requests where AE lock is always set

2593

to <code>false</code>.

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

2594

Since the camera device has a pipeline of in-flight requests, the settings that

2595

get locked do not necessarily correspond to the settings that were present in the

2596

latest capture result received from the camera device, since additional captures

2597

and AE updates may have occurred even before the result was sent out. If an

2598

application is switching between automatic and manual control and wishes to eliminate

2599

any flicker during the switch, the following procedure is recommended:

2600

<ol>

2601

<li>Starting in auto-AE mode:</li>

2602

2603

<li>Wait for the first result to be output that has the AE locked</li>

2604

<li>Copy exposure settings from that result into a request, set the request to manual AE</li>

2605

<li>Submit the capture request, proceed to run manual AE as desired.</li>

2606

</ol>

Zhijun He

2014-02-04 16:42:46 -0800

[diff] [blame]

2607

See <a href="#dynamic_android.control.aeState">android.control.aeState</a> for AE lock related state transition details.

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

2608

</td>

2609

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

2610

2611

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

2612

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

2613

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

2617

<td class="entry_name

2618

" rowspan="3">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

2619

android.control.aeMode

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

2620

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

2621

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

2622

byte

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

2623

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

2624

[public]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

2625

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

2626

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

2627

[legacy]

2628

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

2629

2630

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

2631

2632

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

2633

OFF (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

2634

The camera device's autoexposure routine is disabled.

2635

The application-selected <a href="#controls_android.sensor.exposureTime">android.sensor.exposureTime</a>,

Igor Murashkin

2014-01-15 17:05:22 -0800

[diff] [blame]

2636

<a href="#controls_android.sensor.sensitivity">android.sensor.sensitivity</a> and

2637

<a href="#controls_android.sensor.frameDuration">android.sensor.frameDuration</a> are used by the camera

2638

device, along with android.flash.* fields, if there's

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

2639

a flash unit for this camera device.

Yin-Chia Yeh

2014-11-12 11:38:10 -0800

[diff] [blame]

2640

Note that auto-white balance (AWB) and auto-focus (AF)

2641

behavior is device dependent when AE is in OFF mode.

2642

To have consistent behavior across different devices,

2643

it is recommended to either set AWB and AF to OFF mode

2644

or lock AWB and AF before setting AE to OFF.

2645

See <a href="#controls_android.control.awbMode">android.control.awbMode</a>, <a href="#controls_android.control.afMode">android.control.afMode</a>,

2646

<a href="#controls_android.control.awbLock">android.control.awbLock</a>, and <a href="#controls_android.control.afTrigger">android.control.afTrigger</a>

2647

for more details.

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

2648

LEGACY devices do not support the OFF mode and will

2649

override attempts to use this value to ON.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

2650

</li>

2651

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

2652

ON (v3.2)

Igor Murashkin

2014-01-15 17:05:22 -0800

[diff] [blame]

2653

The camera device's autoexposure routine is active,

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

2654

with no flash control.

2655

The application's values for

Igor Murashkin

2014-01-15 17:05:22 -0800

[diff] [blame]

2656

<a href="#controls_android.sensor.exposureTime">android.sensor.exposureTime</a>,

2657

<a href="#controls_android.sensor.sensitivity">android.sensor.sensitivity</a>, and

2658

<a href="#controls_android.sensor.frameDuration">android.sensor.frameDuration</a> are ignored. The

2659

application has control over the various

2660

android.flash.* fields.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

2661

</li>

2662

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

2663

ON_AUTO_FLASH (v3.2)

Igor Murashkin

2014-01-15 17:05:22 -0800

[diff] [blame]

2664

Like ON, except that the camera device also controls

2665

the camera's flash unit, firing it in low-light

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

2666

conditions.

2667

The flash may be fired during a precapture sequence

2668

(triggered by <a href="#controls_android.control.aePrecaptureTrigger">android.control.aePrecaptureTrigger</a>) and

2669

may be fired for captures for which the

Igor Murashkin

2014-01-15 17:05:22 -0800

[diff] [blame]

2670

<a href="#controls_android.control.captureIntent">android.control.captureIntent</a> field is set to

2671

STILL_CAPTURE

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

2672

</li>

2673

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

2674

ON_ALWAYS_FLASH (v3.2)

Igor Murashkin

2014-01-15 17:05:22 -0800

[diff] [blame]

2675

Like ON, except that the camera device also controls

2676

the camera's flash unit, always firing it for still

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

2677

captures.

2678

The flash may be fired during a precapture sequence

2679

(triggered by <a href="#controls_android.control.aePrecaptureTrigger">android.control.aePrecaptureTrigger</a>) and

2680

will always be fired for captures for which the

Igor Murashkin

2014-01-15 17:05:22 -0800

[diff] [blame]

2681

<a href="#controls_android.control.captureIntent">android.control.captureIntent</a> field is set to

2682

STILL_CAPTURE

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

2683

</li>

2684

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

2685

ON_AUTO_FLASH_REDEYE (v3.2)

Igor Murashkin

2014-01-15 17:05:22 -0800

[diff] [blame]

2686

Like ON_AUTO_FLASH, but with automatic red eye

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

2687

reduction.

2688

If deemed necessary by the camera device, a red eye

2689

reduction flash will fire during the precapture

2690

sequence.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

2691

</li>

Chien-Yu Chen

2018-01-11 11:32:52 -0800

[diff] [blame]

2692

<li>

2693

ON_EXTERNAL_FLASH (v3.3)

2694

An external flash has been turned on.

2695

It informs the camera device that an external flash has been turned on, and that

2696

metering (and continuous focus if active) should be quickly recaculated to account

2697

for the external flash. Otherwise, this mode acts like ON.

2698

When the external flash is turned off, AE mode should be changed to one of the

2699

other available AE modes.

Chien-Yu Chen

06513f1

2018-03-15 11:17:20 -0700

[diff] [blame]

2700

If the camera device supports AE external flash mode, <a href="#dynamic_android.control.aeState">android.control.aeState</a> must

2701

be FLASH_REQUIRED after the camera device finishes AE scan and it's too dark without

Chien-Yu Chen

2018-01-11 11:32:52 -0800

[diff] [blame]

2702

flash.

2703

</li>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

2704

</ul>

2705

2706

</td>

2707

2708

Eino-Ville Talvala

2014-01-08 16:16:53 -0800

[diff] [blame]

2709

The desired mode for the camera device's

2710

auto-exposure routine.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

Eino-Ville Talvala

2014-01-02 16:11:44 -0800

[diff] [blame]

2717

<a href="#static_android.control.aeAvailableModes">android.control.aeAvailableModes</a>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

2718

</td>

2719

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

</ul>

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

2732

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

2733

</tr>

2734

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

2735

Eino-Ville Talvala

2014-01-08 16:16:53 -0800

[diff] [blame]

2736

This control is only effective if <a href="#controls_android.control.mode">android.control.mode</a> is

2737

AUTO.

2738

When set to any of the ON modes, the camera device's

2739

auto-exposure routine is enabled, overriding the

2740

application's selected exposure time, sensor sensitivity,

2741

and frame duration (<a href="#controls_android.sensor.exposureTime">android.sensor.exposureTime</a>,

2742

<a href="#controls_android.sensor.sensitivity">android.sensor.sensitivity</a>, and

2743

<a href="#controls_android.sensor.frameDuration">android.sensor.frameDuration</a>). If one of the FLASH modes

2744

is selected, the camera device's flash unit controls are

2745

also overridden.

2746

The FLASH modes are only available if the camera device

2747

has a flash unit (<a href="#static_android.flash.info.available">android.flash.info.available</a> is <code>true</code>).

2748

If flash TORCH mode is desired, this field must be set to

2749

ON or OFF, and <a href="#controls_android.flash.mode">android.flash.mode</a> set to TORCH.

2750

When set to any of the ON modes, the values chosen by the

2751

camera device auto-exposure routine for the overridden

2752

fields for a given capture will be available in its

2753

CaptureResult.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

2754

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

2755

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

2756

2757

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

2758

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

2759

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

2763

<td class="entry_name

Yin-Chia Yeh

2014-05-16 15:13:13 -0700

[diff] [blame]

2764

" rowspan="5">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

2765

android.control.aeRegions

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

2766

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

2767

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

2768

int32

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

x

5 x area_count

Yin-Chia Yeh

2014-05-16 15:13:13 -0700

[diff] [blame]

2774

[public as meteringRectangle]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

2775

2776

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

2780

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

2781

</td>

2782

2783

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

2784

List of metering areas to use for auto-exposure adjustment.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Yin-Chia Yeh

2018-06-15 15:35:05 -0700

[diff] [blame]

2788

Pixel coordinates within android.sensor.info.activeArraySize or

2789

android.sensor.info.preCorrectionActiveArraySize depending on

2790

distortion correction capability and mode

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

2794

Coordinates must be between <code>[(0,0), (width, height))</code> of

Yin-Chia Yeh

2018-06-15 15:35:05 -0700

[diff] [blame]

2795

<a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a> or <a href="#static_android.sensor.info.preCorrectionActiveArraySize">android.sensor.info.preCorrectionActiveArraySize</a>

2796

depending on distortion correction capability and mode

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

2797

</td>

2798

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

</ul>

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

2811

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

2812

</tr>

2813

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

2814

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

2815

Not available if <a href="#static_android.control.maxRegionsAe">android.control.maxRegionsAe</a> is 0.

Yin-Chia Yeh

2014-09-04 09:33:34 -0700

[diff] [blame]

2816

Otherwise will always be present.

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

2817

The maximum number of regions supported by the device is determined by the value

2818

of <a href="#static_android.control.maxRegionsAe">android.control.maxRegionsAe</a>.

Yin-Chia Yeh

2018-06-15 15:35:05 -0700

[diff] [blame]

2819

For devices not supporting <a href="#controls_android.distortionCorrection.mode">android.distortionCorrection.mode</a> control, the coordinate

2820

system always follows that of <a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a>, with (0,0) being

2821

the top-left pixel in the active pixel array, and

Eino-Ville Talvala

2014-01-02 16:11:44 -0800

[diff] [blame]

2822

(<a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a>.width - 1,

Yin-Chia Yeh

2018-06-15 15:35:05 -0700

[diff] [blame]

2823

<a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a>.height - 1) being the bottom-right pixel in the

2824

active pixel array.

2825

For devices supporting <a href="#controls_android.distortionCorrection.mode">android.distortionCorrection.mode</a> control, the coordinate

2826

system depends on the mode being set.

2827

When the distortion correction mode is OFF, the coordinate system follows

2828

<a href="#static_android.sensor.info.preCorrectionActiveArraySize">android.sensor.info.preCorrectionActiveArraySize</a>, with

2829

<code>(0, 0)</code> being the top-left pixel of the pre-correction active array, and

2830

(<a href="#static_android.sensor.info.preCorrectionActiveArraySize">android.sensor.info.preCorrectionActiveArraySize</a>.width - 1,

2831

<a href="#static_android.sensor.info.preCorrectionActiveArraySize">android.sensor.info.preCorrectionActiveArraySize</a>.height - 1) being the bottom-right

2832

pixel in the pre-correction active pixel array.

2833

When the distortion correction mode is not OFF, the coordinate system follows

2834

<a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a>, with

2835

<code>(0, 0)</code> being the top-left pixel of the active array, and

2836

(<a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a>.width - 1,

2837

<a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a>.height - 1) being the bottom-right pixel in the

2838

active pixel array.

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

2839

The weight must be within <code>[0, 1000]</code>, and represents a weight

Yin-Chia Yeh

2014-05-14 14:05:20 -0700

[diff] [blame]

2840

for every pixel in the area. This means that a large metering area

2841

with the same weight as a smaller area will have more effect in

2842

the metering result. Metering areas can partially overlap and the

2843

camera device will add the weights in the overlap region.

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

2844

The weights are relative to weights of other exposure metering regions, so if only one

2845

region is used, all non-zero weights will have the same effect. A region with 0

2846

weight is ignored.

2847

If all regions have 0 weight, then no specific metering area needs to be used by the

2848

camera device.

2849

If the metering region is outside the used <a href="#controls_android.scaler.cropRegion">android.scaler.cropRegion</a> returned in

2850

capture result metadata, the camera device will ignore the sections outside the crop

2851

region and output only the intersection rectangle as the metering region in the result

2852

metadata. If the region is entirely outside the crop region, it will be ignored and

2853

not reported in the result metadata.

Shuzhen Wang

2022-03-28 12:41:41 -0700

[diff] [blame]

2854

When setting the AE metering regions, the application must consider the additional

2855

crop resulted from the aspect ratio differences between the preview stream and

2856

<a href="#controls_android.scaler.cropRegion">android.scaler.cropRegion</a>. For example, if the <a href="#controls_android.scaler.cropRegion">android.scaler.cropRegion</a> is the full

2857

active array size with 4:3 aspect ratio, and the preview stream is 16:9,

2858

the boundary of AE regions will be [0, y_crop] and

2859

[active_width, active_height - 2 * y_crop] rather than [0, 0] and

2860

[active_width, active_height], where y_crop is the additional crop due to aspect ratio

2861

mismatch.

Shuzhen Wang

2019-11-07 15:59:22 -0800

[diff] [blame]

2862

Starting from API level 30, the coordinate system of activeArraySize or

2863

preCorrectionActiveArraySize is used to represent post-zoomRatio field of view, not

2864

pre-zoom field of view. This means that the same aeRegions values at different

2865

<a href="#controls_android.control.zoomRatio">android.control.zoomRatio</a> represent different parts of the scene. The aeRegions

2866

coordinates are relative to the activeArray/preCorrectionActiveArray representing the

2867

zoomed field of view. If <a href="#controls_android.control.zoomRatio">android.control.zoomRatio</a> is set to 1.0 (default), the same

2868

aeRegions at different <a href="#controls_android.scaler.cropRegion">android.scaler.cropRegion</a> still represent the same parts of the

2869

scene as they do before. See <a href="#controls_android.control.zoomRatio">android.control.zoomRatio</a> for details. Whether to use

2870

activeArraySize or preCorrectionActiveArraySize still depends on distortion correction

2871

mode.

Jayant Chowdhary

2020-11-09 09:08:31 -0800

[diff] [blame]

2872

For camera devices with the

2873

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraMetadata.html#REQUEST_AVAILABLE_CAPABILITIES_ULTRA_HIGH_RESOLUTION_SENSOR">CameraMetadata#REQUEST_AVAILABLE_CAPABILITIES_ULTRA_HIGH_RESOLUTION_SENSOR</a>

2874

capability,

2875

<a href="#static_android.sensor.info.activeArraySizeMaximumResolution">android.sensor.info.activeArraySizeMaximumResolution</a> /

2876

<a href="#static_android.sensor.info.preCorrectionActiveArraySizeMaximumResolution">android.sensor.info.preCorrectionActiveArraySizeMaximumResolution</a> must be used as the

2877

coordinate system for requests where <a href="#controls_android.sensor.pixelMode">android.sensor.pixelMode</a> is set to

2878

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraMetadata.html#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION">CameraMetadata#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION</a>.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

2879

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

2880

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

2881

Yin-Chia Yeh

2014-05-16 15:13:13 -0700

[diff] [blame]

2882

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

2883

<th class="th_details" colspan="6">HAL Implementation Details</th>

Yin-Chia Yeh

2014-05-16 15:13:13 -0700

[diff] [blame]

2884

</tr>

2885

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

2886

Yin-Chia Yeh

2014-05-16 15:13:13 -0700

[diff] [blame]

2887

The HAL level representation of MeteringRectangle[] is a

2888

int[5 * area_count].

2889

Every five elements represent a metering region of

2890

(xmin, ymin, xmax, ymax, weight).

2891

The rectangle is defined to be inclusive on xmin and ymin, but

Yin-Chia Yeh

2018-06-15 15:35:05 -0700

[diff] [blame]

2892

exclusive on xmax and ymax.

2893

HAL must always report metering regions in the coordinate system of pre-correction

2894

active array.

Yin-Chia Yeh

2014-05-16 15:13:13 -0700

[diff] [blame]

2895

</td>

2896

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

2897

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

2898

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

2899

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

2903

<td class="entry_name

2904

" rowspan="3">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

2905

android.control.aeTargetFpsRange

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

2906

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

2907

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

2908

int32

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

x

2

Igor Murashkin

2014-05-27 10:51:25 -0700

[diff] [blame]

2914

[public as rangeInt]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

2915

2916

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

2917

[legacy]

2918

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

2922

</td>

2923

2924

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

2925

Range over which the auto-exposure routine can

2926

adjust the capture frame rate to maintain good

2927

exposure.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

2931

Frames per second (FPS)

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

2935

Any of the entries in <a href="#static_android.control.aeAvailableTargetFpsRanges">android.control.aeAvailableTargetFpsRanges</a>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

2936

</td>

2937

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

2942

2943

Igor Murashkin

2012-12-05 14:49:11 -0800

[diff] [blame]

2944

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</ul>

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

2948

</tr>

2949

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

2950

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

2951

</tr>

2952

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

2953

Eino-Ville Talvala

2014-06-06 14:35:41 -0700

[diff] [blame]

2954

Only constrains auto-exposure (AE) algorithm, not

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

2955

manual control of <a href="#controls_android.sensor.exposureTime">android.sensor.exposureTime</a> and

2956

<a href="#controls_android.sensor.frameDuration">android.sensor.frameDuration</a>.

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

2957

</td>

2958

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

2959

2960

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

2961

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

2962

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

2963

2964

Eino-Ville Talvala

2013-03-18 09:42:48 -0700

[diff] [blame]

2965

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

2966

<td class="entry_name

Eino-Ville Talvala

2015-06-24 15:17:09 -0700

[diff] [blame]

2967

" rowspan="5">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

2968

android.control.aePrecaptureTrigger

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

2969

</td>

Eino-Ville Talvala

2013-03-18 09:42:48 -0700

[diff] [blame]

byte

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

2973

[public]

Eino-Ville Talvala

2013-03-18 09:42:48 -0700

[diff] [blame]

2974

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

2975

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

2976

[limited]

2977

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

2978

2979

Eino-Ville Talvala

2013-03-18 09:42:48 -0700

[diff] [blame]

2980

2981

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

2982

IDLE (v3.2)

Igor Murashkin

2014-01-15 17:05:22 -0800

[diff] [blame]

2983

The trigger is idle.

Eino-Ville Talvala

2013-03-18 09:42:48 -0700

[diff] [blame]

2984

</li>

2985

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

2986

START (v3.2)

Zhijun He

2014-01-13 16:24:31 -0800

[diff] [blame]

2987

The precapture metering sequence will be started

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

2988

by the camera device.

2989

The exact effect of the precapture trigger depends on

2990

the current AE mode and state.

Eino-Ville Talvala

2013-03-18 09:42:48 -0700

[diff] [blame]

2991

</li>

Zhijun He

2015-02-05 14:32:57 -0800

[diff] [blame]

2992

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

2993

CANCEL (v3.2)

Zhijun He

2015-02-05 14:32:57 -0800

[diff] [blame]

2994

The camera device will cancel any currently active or completed

2995

precapture metering sequence, the auto-exposure routine will return to its

2996

initial state.

2997

</li>

Eino-Ville Talvala

2013-03-18 09:42:48 -0700

[diff] [blame]

2998

</ul>

2999

3000

</td>

3001

3002

Zhijun He

2014-01-13 16:24:31 -0800

[diff] [blame]

3003

Whether the camera device will trigger a precapture

3004

metering sequence when it processes this request.

Eino-Ville Talvala

2013-03-18 09:42:48 -0700

[diff] [blame]

</td>

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

</ul>

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3025

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

3026

</tr>

3027

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3028

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

3029

This entry is normally set to IDLE, or is not

3030

included at all in the request settings. When included and

Zhijun He

2015-02-06 13:42:40 -0800

[diff] [blame]

3031

set to START, the camera device will trigger the auto-exposure (AE)

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

3032

precapture metering sequence.

Zhijun He

2015-02-05 14:32:57 -0800

[diff] [blame]

3033

When set to CANCEL, the camera device will cancel any active

3034

precapture metering trigger, and return to its initial AE state.

3035

If a precapture metering sequence is already completed, and the camera

3036

device has implicitly locked the AE for subsequent still capture, the

3037

CANCEL trigger will unlock the AE and return to its initial AE state.

Zhijun He

2015-02-06 13:42:40 -0800

[diff] [blame]

3038

The precapture sequence should be triggered before starting a

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

3039

high-quality still capture for final metering decisions to

3040

be made, and for firing pre-capture flash pulses to estimate

3041

scene brightness and required final capture flash power, when

3042

the flash is enabled.

3043

Normally, this entry should be set to START for only a

3044

single request, and the application should wait until the

3045

sequence completes before starting a new one.

Zhijun He

2015-02-06 13:42:40 -0800

[diff] [blame]

3046

When a precapture metering sequence is finished, the camera device

3047

may lock the auto-exposure routine internally to be able to accurately expose the

3048

subsequent still capture image (<code><a href="#controls_android.control.captureIntent">android.control.captureIntent</a> == STILL_CAPTURE</code>).

3049

For this case, the AE may not resume normal scan if no subsequent still capture is

3050

submitted. To ensure that the AE routine restarts normal scan, the application should

3051

submit a request with <code><a href="#controls_android.control.aeLock">android.control.aeLock</a> == true</code>, followed by a request

3052

with <code><a href="#controls_android.control.aeLock">android.control.aeLock</a> == false</code>, if the application decides not to submit a

Zhijun He

2015-02-05 14:32:57 -0800

[diff] [blame]

3053

still capture request after the precapture sequence completes. Alternatively, for

3054

API level 23 or newer devices, the CANCEL can be used to unlock the camera device

3055

internally locked AE if the application doesn't submit a still capture request after

3056

the AE precapture trigger. Note that, the CANCEL was added in API level 23, and must not

3057

be used in devices that have earlier API levels.

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

3058

The exact effect of auto-exposure (AE) precapture trigger

3059

depends on the current AE mode and state; see

Eino-Ville Talvala

2014-06-06 14:35:41 -0700

[diff] [blame]

3060

<a href="#dynamic_android.control.aeState">android.control.aeState</a> for AE precapture state transition

3061

details.

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

3062

On LEGACY-level devices, the precapture trigger is not supported;

3063

capturing a high-resolution JPEG image will automatically trigger a

3064

precapture sequence before the high-resolution capture, including

3065

potentially firing a pre-capture flash.

Eino-Ville Talvala

2015-06-24 15:17:09 -0700

[diff] [blame]

3066

Using the precapture trigger and the auto-focus trigger <a href="#controls_android.control.afTrigger">android.control.afTrigger</a>

3067

simultaneously is allowed. However, since these triggers often require cooperation between

3068

the auto-focus and auto-exposure routines (for example, the may need to be enabled for a

3069

focus sweep), the camera device may delay acting on a later trigger until the previous

3070

trigger has been fully handled. This may lead to longer intervals between the trigger and

3071

changes to <a href="#dynamic_android.control.aeState">android.control.aeState</a> indicating the start of the precapture sequence, for

3072

example.

3073

If both the precapture and the auto-focus trigger are activated on the same request, then

3074

the camera device will complete them in the optimal order for that device.

Eino-Ville Talvala

2013-03-18 09:42:48 -0700

[diff] [blame]

3075

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

3076

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

3077

Eino-Ville Talvala

2015-06-24 15:17:09 -0700

[diff] [blame]

3078

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3079

<th class="th_details" colspan="6">HAL Implementation Details</th>

Eino-Ville Talvala

2015-06-24 15:17:09 -0700

[diff] [blame]

3080

</tr>

3081

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3082

Eino-Ville Talvala

2015-06-24 15:17:09 -0700

[diff] [blame]

3083

The HAL must support triggering the AE precapture trigger while an AF trigger is active

3084

(and vice versa), or at the same time as the AF trigger. It is acceptable for the HAL to

3085

treat these as two consecutive triggers, for example handling the AF trigger and then the

3086

AE trigger. Or the HAL may choose to optimize the case with both triggers fired at once,

3087

to minimize the latency for converging both focus and exposure/flash usage.

3088

</td>

3089

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

3090

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3091

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

3092

Eino-Ville Talvala

2013-03-18 09:42:48 -0700

[diff] [blame]

3093

3094

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

3095

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

3096

<td class="entry_name

Zhijun He

2014-05-27 15:06:42 -0700

[diff] [blame]

3097

" rowspan="5">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

3098

android.control.afMode

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

3099

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

3100

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

3101

byte

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

3102

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

3103

[public]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

3104

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

3105

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

3106

[legacy]

3107

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

3108

3109

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

3110

3111

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

3112

OFF (v3.2)

Igor Murashkin

2014-01-15 17:05:22 -0800

[diff] [blame]

3113

The auto-focus routine does not control the lens;

3114

<a href="#controls_android.lens.focusDistance">android.lens.focusDistance</a> is controlled by the

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

3115

application.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

3116

</li>

3117

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

3118

AUTO (v3.2)

Eino-Ville Talvala

2014-06-06 14:35:41 -0700

[diff] [blame]

3119

Basic automatic focus mode.

3120

In this mode, the lens does not move unless

Igor Murashkin

2014-01-15 17:05:22 -0800

[diff] [blame]

3121

the autofocus trigger action is called. When that trigger

Eino-Ville Talvala

2014-06-06 14:35:41 -0700

[diff] [blame]

3122

is activated, AF will transition to ACTIVE_SCAN, then to

Igor Murashkin

2014-01-15 17:05:22 -0800

[diff] [blame]

3123

the outcome of the scan (FOCUSED or NOT_FOCUSED).

Eino-Ville Talvala

2014-06-06 14:35:41 -0700

[diff] [blame]

3124

Always supported if lens is not fixed focus.

3125

Use <a href="#static_android.lens.info.minimumFocusDistance">android.lens.info.minimumFocusDistance</a> to determine if lens

3126

is fixed-focus.

Igor Murashkin

2014-01-15 17:05:22 -0800

[diff] [blame]

3127

Triggering AF_CANCEL resets the lens position to default,

3128

and sets the AF state to INACTIVE.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

3129

</li>

3130

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

3131

MACRO (v3.2)

Eino-Ville Talvala

2014-06-06 14:35:41 -0700

[diff] [blame]

3132

Close-up focusing mode.

3133

In this mode, the lens does not move unless the

3134

autofocus trigger action is called. When that trigger is

3135

activated, AF will transition to ACTIVE_SCAN, then to

3136

the outcome of the scan (FOCUSED or NOT_FOCUSED). This

3137

mode is optimized for focusing on objects very close to

3138

the camera.

3139

When that trigger is activated, AF will transition to

Igor Murashkin

2014-01-15 17:05:22 -0800

[diff] [blame]

3140

ACTIVE_SCAN, then to the outcome of the scan (FOCUSED or

Eino-Ville Talvala

2014-06-06 14:35:41 -0700

[diff] [blame]

3141

NOT_FOCUSED). Triggering cancel AF resets the lens

Igor Murashkin

2014-01-15 17:05:22 -0800

[diff] [blame]

3142

position to default, and sets the AF state to

3143

INACTIVE.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

3144

</li>

3145

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

3146

CONTINUOUS_VIDEO (v3.2)

Igor Murashkin

2014-01-15 17:05:22 -0800

[diff] [blame]

3147

In this mode, the AF algorithm modifies the lens

3148

position continually to attempt to provide a

3149

constantly-in-focus image stream.

3150

The focusing behavior should be suitable for good quality

3151

video recording; typically this means slower focus

3152

movement and no overshoots. When the AF trigger is not

3153

involved, the AF algorithm should start in INACTIVE state,

3154

and then transition into PASSIVE_SCAN and PASSIVE_FOCUSED

3155

states as appropriate. When the AF trigger is activated,

3156

the algorithm should immediately transition into

3157

AF_FOCUSED or AF_NOT_FOCUSED as appropriate, and lock the

3158

lens position until a cancel AF trigger is received.

3159

Once cancel is received, the algorithm should transition

3160

back to INACTIVE and resume passive scan. Note that this

3161

behavior is not identical to CONTINUOUS_PICTURE, since an

3162

ongoing PASSIVE_SCAN must immediately be

3163

canceled.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

3164

</li>

3165

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

3166

CONTINUOUS_PICTURE (v3.2)

Igor Murashkin

2014-01-15 17:05:22 -0800

[diff] [blame]

3167

In this mode, the AF algorithm modifies the lens

3168

position continually to attempt to provide a

3169

constantly-in-focus image stream.

3170

The focusing behavior should be suitable for still image

3171

capture; typically this means focusing as fast as

3172

possible. When the AF trigger is not involved, the AF

3173

algorithm should start in INACTIVE state, and then

3174

transition into PASSIVE_SCAN and PASSIVE_FOCUSED states as

3175

appropriate as it attempts to maintain focus. When the AF

3176

trigger is activated, the algorithm should finish its

3177

PASSIVE_SCAN if active, and then transition into

3178

AF_FOCUSED or AF_NOT_FOCUSED as appropriate, and lock the

3179

lens position until a cancel AF trigger is received.

3180

When the AF cancel trigger is activated, the algorithm

3181

should transition back to INACTIVE and then act as if it

3182

has just been started.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

3183

</li>

3184

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

3185

EDOF (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

3186

Extended depth of field (digital focus) mode.

3187

The camera device will produce images with an extended

3188

depth of field automatically; no special focusing

3189

operations need to be done before taking a picture.

3190

AF triggers are ignored, and the AF state will always be

Igor Murashkin

2014-01-15 17:05:22 -0800

[diff] [blame]

3191

INACTIVE.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</li>

</ul>

</td>

3196

3197

Eino-Ville Talvala

2014-06-06 14:35:41 -0700

[diff] [blame]

3198

Whether auto-focus (AF) is currently enabled, and what

3199

mode it is set to.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

Zhijun He

2014-01-14 16:30:31 -0800

[diff] [blame]

3206

<a href="#static_android.control.afAvailableModes">android.control.afAvailableModes</a>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

3207

</td>

3208

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

3213

3214

Igor Murashkin

2012-12-05 14:49:11 -0800

[diff] [blame]

3215

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</ul>

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

3219

</tr>

3220

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3221

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

3222

</tr>

3223

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3224

Zhijun He

2014-02-24 09:49:37 -0800

[diff] [blame]

3225

Only effective if <a href="#controls_android.control.mode">android.control.mode</a> = AUTO and the lens is not fixed focus

Yin-Chia Yeh

2014-11-12 11:38:10 -0800

[diff] [blame]

3226

(i.e. <code><a href="#static_android.lens.info.minimumFocusDistance">android.lens.info.minimumFocusDistance</a> > 0</code>). Also note that

3227

when <a href="#controls_android.control.aeMode">android.control.aeMode</a> is OFF, the behavior of AF is device

3228

dependent. It is recommended to lock AF by using <a href="#controls_android.control.afTrigger">android.control.afTrigger</a> before

3229

setting <a href="#controls_android.control.aeMode">android.control.aeMode</a> to OFF, or set AF mode to OFF when AE is OFF.

Zhijun He

2014-01-14 09:59:04 -0800

[diff] [blame]

3230

If the lens is controlled by the camera device auto-focus algorithm,

Eino-Ville Talvala

2014-02-10 12:39:35 -0800

[diff] [blame]

3231

the camera device will report the current AF status in <a href="#dynamic_android.control.afState">android.control.afState</a>

Zhijun He

2014-01-14 09:59:04 -0800

[diff] [blame]

3232

in result metadata.

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

3233

</td>

3234

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

3235

Zhijun He

2014-05-27 15:06:42 -0700

[diff] [blame]

3236

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3237

<th class="th_details" colspan="6">HAL Implementation Details</th>

Zhijun He

2014-05-27 15:06:42 -0700

[diff] [blame]

3238

</tr>

3239

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3240

Zhijun He

2014-05-27 15:06:42 -0700

[diff] [blame]

3241

When afMode is AUTO or MACRO, the lens must not move until an AF trigger is sent in a

3242

request (<a href="#controls_android.control.afTrigger">android.control.afTrigger</a> <code>==</code> START). After an AF trigger, the afState will end

3243

up with either FOCUSED_LOCKED or NOT_FOCUSED_LOCKED state (see

3244

<a href="#dynamic_android.control.afState">android.control.afState</a> for detailed state transitions), which indicates that the lens is

3245

locked and will not move. If camera movement (e.g. tilting camera) causes the lens to move

3246

after the lens is locked, the HAL must compensate this movement appropriately such that

3247

the same focal plane remains in focus.

3248

When afMode is one of the continuous auto focus modes, the HAL is free to start a AF

3249

scan whenever it's not locked. When the lens is locked after an AF trigger

3250

(see <a href="#dynamic_android.control.afState">android.control.afState</a> for detailed state transitions), the HAL should maintain the

3251

same lock behavior as above.

3252

When afMode is OFF, the application controls focus manually. The accuracy of the

3253

focus distance control depends on the <a href="#static_android.lens.info.focusDistanceCalibration">android.lens.info.focusDistanceCalibration</a>.

3254

However, the lens must not move regardless of the camera movement for any focus distance

3255

manual control.

3256

To put this in concrete terms, if the camera has lens elements which may move based on

3257

camera orientation or motion (e.g. due to gravity), then the HAL must drive the lens to

3258

remain in a fixed position invariant to the camera's orientation or motion, for example,

3259

by using accelerometer measurements in the lens control logic. This is a typical issue

3260

that will arise on camera modules with open-loop VCMs.

3261

</td>

3262

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

3263

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3264

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

3265

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

3269

<td class="entry_name

Yin-Chia Yeh

2014-05-16 15:13:13 -0700

[diff] [blame]

3270

" rowspan="5">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

3271

android.control.afRegions

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

3272

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

3273

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

3274

int32

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

x

5 x area_count

Yin-Chia Yeh

2014-05-16 15:13:13 -0700

[diff] [blame]

3280

[public as meteringRectangle]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

3281

3282

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

3286

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

3287

</td>

3288

3289

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

3290

List of metering areas to use for auto-focus.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Yin-Chia Yeh

2018-06-15 15:35:05 -0700

[diff] [blame]

3294

Pixel coordinates within android.sensor.info.activeArraySize or

3295

android.sensor.info.preCorrectionActiveArraySize depending on

3296

distortion correction capability and mode

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

3300

Coordinates must be between <code>[(0,0), (width, height))</code> of

Yin-Chia Yeh

2018-06-15 15:35:05 -0700

[diff] [blame]

3301

<a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a> or <a href="#static_android.sensor.info.preCorrectionActiveArraySize">android.sensor.info.preCorrectionActiveArraySize</a>

3302

depending on distortion correction capability and mode

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

3303

</td>

3304

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

</ul>

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3317

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

3318

</tr>

3319

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3320

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

3321

Not available if <a href="#static_android.control.maxRegionsAf">android.control.maxRegionsAf</a> is 0.

Yin-Chia Yeh

2014-09-04 09:33:34 -0700

[diff] [blame]

3322

Otherwise will always be present.

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

3323

The maximum number of focus areas supported by the device is determined by the value

3324

of <a href="#static_android.control.maxRegionsAf">android.control.maxRegionsAf</a>.

Yin-Chia Yeh

2018-06-15 15:35:05 -0700

[diff] [blame]

3325

For devices not supporting <a href="#controls_android.distortionCorrection.mode">android.distortionCorrection.mode</a> control, the coordinate

3326

system always follows that of <a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a>, with (0,0) being

3327

the top-left pixel in the active pixel array, and

Eino-Ville Talvala

2014-01-02 16:11:44 -0800

[diff] [blame]

3328

(<a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a>.width - 1,

Yin-Chia Yeh

2018-06-15 15:35:05 -0700

[diff] [blame]

3329

<a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a>.height - 1) being the bottom-right pixel in the

3330

active pixel array.

3331

For devices supporting <a href="#controls_android.distortionCorrection.mode">android.distortionCorrection.mode</a> control, the coordinate

3332

system depends on the mode being set.

3333

When the distortion correction mode is OFF, the coordinate system follows

3334

<a href="#static_android.sensor.info.preCorrectionActiveArraySize">android.sensor.info.preCorrectionActiveArraySize</a>, with

3335

<code>(0, 0)</code> being the top-left pixel of the pre-correction active array, and

3336

(<a href="#static_android.sensor.info.preCorrectionActiveArraySize">android.sensor.info.preCorrectionActiveArraySize</a>.width - 1,

3337

<a href="#static_android.sensor.info.preCorrectionActiveArraySize">android.sensor.info.preCorrectionActiveArraySize</a>.height - 1) being the bottom-right

3338

pixel in the pre-correction active pixel array.

3339

When the distortion correction mode is not OFF, the coordinate system follows

3340

<a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a>, with

3341

<code>(0, 0)</code> being the top-left pixel of the active array, and

3342

(<a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a>.width - 1,

3343

<a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a>.height - 1) being the bottom-right pixel in the

3344

active pixel array.

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

3345

The weight must be within <code>[0, 1000]</code>, and represents a weight

Yin-Chia Yeh

2014-05-14 14:05:20 -0700

[diff] [blame]

3346

for every pixel in the area. This means that a large metering area

3347

with the same weight as a smaller area will have more effect in

3348

the metering result. Metering areas can partially overlap and the

3349

camera device will add the weights in the overlap region.

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

3350

The weights are relative to weights of other metering regions, so if only one region

3351

is used, all non-zero weights will have the same effect. A region with 0 weight is

3352

ignored.

3353

If all regions have 0 weight, then no specific metering area needs to be used by the

Shuzhen Wang

608e058

2018-02-08 12:03:09 -0800

[diff] [blame]

3354

camera device. The capture result will either be a zero weight region as well, or

3355

the region selected by the camera device as the focus area of interest.

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

3356

If the metering region is outside the used <a href="#controls_android.scaler.cropRegion">android.scaler.cropRegion</a> returned in

3357

capture result metadata, the camera device will ignore the sections outside the crop

3358

region and output only the intersection rectangle as the metering region in the result

3359

metadata. If the region is entirely outside the crop region, it will be ignored and

3360

not reported in the result metadata.

Shuzhen Wang

2022-03-28 12:41:41 -0700

[diff] [blame]

3361

When setting the AF metering regions, the application must consider the additional

3362

crop resulted from the aspect ratio differences between the preview stream and

3363

<a href="#controls_android.scaler.cropRegion">android.scaler.cropRegion</a>. For example, if the <a href="#controls_android.scaler.cropRegion">android.scaler.cropRegion</a> is the full

3364

active array size with 4:3 aspect ratio, and the preview stream is 16:9,

3365

the boundary of AF regions will be [0, y_crop] and

3366

[active_width, active_height - 2 * y_crop] rather than [0, 0] and

3367

[active_width, active_height], where y_crop is the additional crop due to aspect ratio

3368

mismatch.

Shuzhen Wang

2019-11-07 15:59:22 -0800

[diff] [blame]

3369

Starting from API level 30, the coordinate system of activeArraySize or

3370

preCorrectionActiveArraySize is used to represent post-zoomRatio field of view, not

3371

pre-zoom field of view. This means that the same afRegions values at different

3372

<a href="#controls_android.control.zoomRatio">android.control.zoomRatio</a> represent different parts of the scene. The afRegions

3373

coordinates are relative to the activeArray/preCorrectionActiveArray representing the

3374

zoomed field of view. If <a href="#controls_android.control.zoomRatio">android.control.zoomRatio</a> is set to 1.0 (default), the same

3375

afRegions at different <a href="#controls_android.scaler.cropRegion">android.scaler.cropRegion</a> still represent the same parts of the

3376

scene as they do before. See <a href="#controls_android.control.zoomRatio">android.control.zoomRatio</a> for details. Whether to use

3377

activeArraySize or preCorrectionActiveArraySize still depends on distortion correction

3378

mode.

Jayant Chowdhary

2020-11-09 09:08:31 -0800

[diff] [blame]

3379

For camera devices with the

3380

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraMetadata.html#REQUEST_AVAILABLE_CAPABILITIES_ULTRA_HIGH_RESOLUTION_SENSOR">CameraMetadata#REQUEST_AVAILABLE_CAPABILITIES_ULTRA_HIGH_RESOLUTION_SENSOR</a>

3381

capability, <a href="#static_android.sensor.info.activeArraySizeMaximumResolution">android.sensor.info.activeArraySizeMaximumResolution</a> /

3382

<a href="#static_android.sensor.info.preCorrectionActiveArraySizeMaximumResolution">android.sensor.info.preCorrectionActiveArraySizeMaximumResolution</a> must be used as the

3383

coordinate system for requests where <a href="#controls_android.sensor.pixelMode">android.sensor.pixelMode</a> is set to

3384

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraMetadata.html#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION">CameraMetadata#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION</a>.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

3385

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

3386

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

3387

Yin-Chia Yeh

2014-05-16 15:13:13 -0700

[diff] [blame]

3388

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3389

<th class="th_details" colspan="6">HAL Implementation Details</th>

Yin-Chia Yeh

2014-05-16 15:13:13 -0700

[diff] [blame]

3390

</tr>

3391

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3392

Yin-Chia Yeh

2014-05-16 15:13:13 -0700

[diff] [blame]

3393

The HAL level representation of MeteringRectangle[] is a

3394

int[5 * area_count].

3395

Every five elements represent a metering region of

3396

(xmin, ymin, xmax, ymax, weight).

3397

The rectangle is defined to be inclusive on xmin and ymin, but

Yin-Chia Yeh

2018-06-15 15:35:05 -0700

[diff] [blame]

3398

exclusive on xmax and ymax.

3399

HAL must always report metering regions in the coordinate system of pre-correction

3400

active array.

Yin-Chia Yeh

2014-05-16 15:13:13 -0700

[diff] [blame]

3401

</td>

3402

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

3403

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3404

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

3405

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

3406

3407

Eino-Ville Talvala

2013-03-18 09:42:48 -0700

[diff] [blame]

3408

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

3409

<td class="entry_name

Eino-Ville Talvala

2015-06-24 15:17:09 -0700

[diff] [blame]

3410

" rowspan="5">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

3411

android.control.afTrigger

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

3412

</td>

Eino-Ville Talvala

2013-03-18 09:42:48 -0700

[diff] [blame]

byte

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

3416

[public]

Eino-Ville Talvala

2013-03-18 09:42:48 -0700

[diff] [blame]

3417

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

3418

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

3419

[legacy]

3420

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

3421

3422

Eino-Ville Talvala

2013-03-18 09:42:48 -0700

[diff] [blame]

3423

3424

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

3425

IDLE (v3.2)

Igor Murashkin

2014-01-15 17:05:22 -0800

[diff] [blame]

3426

The trigger is idle.

Eino-Ville Talvala

2013-03-18 09:42:48 -0700

[diff] [blame]

3427

</li>

3428

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

3429

START (v3.2)

Zhijun He

2014-01-13 16:24:31 -0800

[diff] [blame]

3430

Autofocus will trigger now.

Eino-Ville Talvala

2013-03-18 09:42:48 -0700

[diff] [blame]

3431

</li>

3432

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

3433

CANCEL (v3.2)

Zhijun He

2014-01-13 16:24:31 -0800

[diff] [blame]

3434

Autofocus will return to its initial

3435

state, and cancel any currently active trigger.

Eino-Ville Talvala

2013-03-18 09:42:48 -0700

[diff] [blame]

</li>

</ul>

</td>

3440

3441

Zhijun He

2014-01-13 16:24:31 -0800

[diff] [blame]

3442

Whether the camera device will trigger autofocus for this request.

Eino-Ville Talvala

2013-03-18 09:42:48 -0700

[diff] [blame]

</td>

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

</ul>

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3463

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

3464

</tr>

3465

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3466

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

3467

This entry is normally set to IDLE, or is not

3468

included at all in the request settings.

Zhijun He

2014-01-13 16:24:31 -0800

[diff] [blame]

3469

When included and set to START, the camera device will trigger the

3470

autofocus algorithm. If autofocus is disabled, this trigger has no effect.

3471

When set to CANCEL, the camera device will cancel any active trigger,

3472

and return to its initial AF state.

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

3473

Generally, applications should set this entry to START or CANCEL for only a

3474

single capture, and then return it to IDLE (or not set at all). Specifying

3475

START for multiple captures in a row means restarting the AF operation over

3476

and over again.

3477

See <a href="#dynamic_android.control.afState">android.control.afState</a> for what the trigger means for each AF mode.

Eino-Ville Talvala

2015-06-24 15:17:09 -0700

[diff] [blame]

3478

Using the autofocus trigger and the precapture trigger <a href="#controls_android.control.aePrecaptureTrigger">android.control.aePrecaptureTrigger</a>

3479

simultaneously is allowed. However, since these triggers often require cooperation between

3480

the auto-focus and auto-exposure routines (for example, the may need to be enabled for a

3481

focus sweep), the camera device may delay acting on a later trigger until the previous

3482

trigger has been fully handled. This may lead to longer intervals between the trigger and

3483

changes to <a href="#dynamic_android.control.afState">android.control.afState</a>, for example.

Eino-Ville Talvala

2013-03-18 09:42:48 -0700

[diff] [blame]

3484

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

3485

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

3486

Eino-Ville Talvala

2015-06-24 15:17:09 -0700

[diff] [blame]

3487

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3488

<th class="th_details" colspan="6">HAL Implementation Details</th>

Eino-Ville Talvala

2015-06-24 15:17:09 -0700

[diff] [blame]

3489

</tr>

3490

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3491

Eino-Ville Talvala

2015-06-24 15:17:09 -0700

[diff] [blame]

3492

The HAL must support triggering the AF trigger while an AE precapture trigger is active

3493

(and vice versa), or at the same time as the AE trigger. It is acceptable for the HAL to

3494

treat these as two consecutive triggers, for example handling the AF trigger and then the

3495

AE trigger. Or the HAL may choose to optimize the case with both triggers fired at once,

3496

to minimize the latency for converging both focus and exposure/flash usage.

3497

</td>

3498

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

3499

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3500

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

3501

Eino-Ville Talvala

2013-03-18 09:42:48 -0700

[diff] [blame]

3502

3503

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

3504

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

3505

<td class="entry_name

3506

" rowspan="3">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

3507

android.control.awbLock

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

3508

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

3509

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

3510

byte

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

3511

Igor Murashkin

2013-07-17 16:29:34 -0700

[diff] [blame]

3512

[public as boolean]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

3513

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

3514

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

3515

[legacy]

3516

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

3517

3518

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

3519

3520

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

3521

OFF (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

3522

Auto-white balance lock is disabled; the AWB

Igor Murashkin

2014-01-15 17:05:22 -0800

[diff] [blame]

3523

algorithm is free to update its parameters if in AUTO

3524

mode.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

3525

</li>

Eino-Ville Talvala

2013-01-11 13:57:19 -0800

[diff] [blame]

3526

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

3527

ON (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

3528

Auto-white balance lock is enabled; the AWB

3529

algorithm will not update its parameters while the lock

Zhijun He

2014-02-06 00:28:22 -0800

[diff] [blame]

3530

is active.

Eino-Ville Talvala

2013-01-11 13:57:19 -0800

[diff] [blame]

3531

</li>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

3532

</ul>

3533

3534

</td>

3535

3536

Eino-Ville Talvala

2014-06-06 14:35:41 -0700

[diff] [blame]

3537

Whether auto-white balance (AWB) is currently locked to its

Zhijun He

2014-02-06 00:28:22 -0800

[diff] [blame]

3538

latest calculated values.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

3551

3552

Igor Murashkin

2012-12-05 14:49:11 -0800

[diff] [blame]

3553

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</ul>

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

3557

</tr>

3558

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3559

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

3560

</tr>

3561

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3562

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

3563

When set to <code>true</code> (ON), the AWB algorithm is locked to its latest parameters,

3564

and will not change color balance settings until the lock is set to <code>false</code> (OFF).

3565

Since the camera device has a pipeline of in-flight requests, the settings that

3566

get locked do not necessarily correspond to the settings that were present in the

3567

latest capture result received from the camera device, since additional captures

3568

and AWB updates may have occurred even before the result was sent out. If an

3569

application is switching between automatic and manual control and wishes to eliminate

3570

any flicker during the switch, the following procedure is recommended:

3571

<ol>

3572

<li>Starting in auto-AWB mode:</li>

3573

3574

<li>Wait for the first result to be output that has the AWB locked</li>

3575

<li>Copy AWB settings from that result into a request, set the request to manual AWB</li>

3576

<li>Submit the capture request, proceed to run manual AWB as desired.</li>

3577

</ol>

3578

Note that AWB lock is only meaningful when

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

3579

<a href="#controls_android.control.awbMode">android.control.awbMode</a> is in the AUTO mode; in other modes,

3580

AWB is already fixed to a specific setting.

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

3581

Some LEGACY devices may not support ON; the value is then overridden to OFF.

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

3582

</td>

3583

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

3584

3585

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3586

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

3587

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

3591

<td class="entry_name

3592

" rowspan="3">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

3593

android.control.awbMode

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

3594

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

3595

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

3596

byte

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

3597

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

3598

[public]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

3599

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

3600

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

3601

[legacy]

3602

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

3603

3604

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

3605

3606

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

3607

OFF (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

3608

The camera device's auto-white balance routine is disabled.

3609

The application-selected color transform matrix

Igor Murashkin

2014-01-15 17:05:22 -0800

[diff] [blame]

3610

(<a href="#controls_android.colorCorrection.transform">android.colorCorrection.transform</a>) and gains

3611

(<a href="#controls_android.colorCorrection.gains">android.colorCorrection.gains</a>) are used by the camera

3612

device for manual white balance control.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

3613

</li>

3614

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

3615

AUTO (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

3616

The camera device's auto-white balance routine is active.

3617

The application's values for <a href="#controls_android.colorCorrection.transform">android.colorCorrection.transform</a>

3618

and <a href="#controls_android.colorCorrection.gains">android.colorCorrection.gains</a> are ignored.

3619

For devices that support the MANUAL_POST_PROCESSING capability, the

3620

values used by the camera device for the transform and gains

3621

will be available in the capture result for this request.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

3622

</li>

3623

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

3624

INCANDESCENT (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

3625

The camera device's auto-white balance routine is disabled;

Igor Murashkin

2014-01-15 17:05:22 -0800

[diff] [blame]

3626

the camera device uses incandescent light as the assumed scene

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

3627

illumination for white balance.

3628

While the exact white balance transforms are up to the

3629

camera device, they will approximately match the CIE

3630

standard illuminant A.

3631

The application's values for <a href="#controls_android.colorCorrection.transform">android.colorCorrection.transform</a>

3632

and <a href="#controls_android.colorCorrection.gains">android.colorCorrection.gains</a> are ignored.

3633

For devices that support the MANUAL_POST_PROCESSING capability, the

3634

values used by the camera device for the transform and gains

3635

will be available in the capture result for this request.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

3636

</li>

3637

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

3638

FLUORESCENT (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

3639

The camera device's auto-white balance routine is disabled;

Igor Murashkin

2014-01-15 17:05:22 -0800

[diff] [blame]

3640

the camera device uses fluorescent light as the assumed scene

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

3641

illumination for white balance.

3642

While the exact white balance transforms are up to the

3643

camera device, they will approximately match the CIE

3644

standard illuminant F2.

3645

The application's values for <a href="#controls_android.colorCorrection.transform">android.colorCorrection.transform</a>

3646

and <a href="#controls_android.colorCorrection.gains">android.colorCorrection.gains</a> are ignored.

3647

For devices that support the MANUAL_POST_PROCESSING capability, the

3648

values used by the camera device for the transform and gains

3649

will be available in the capture result for this request.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

3650

</li>

3651

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

3652

WARM_FLUORESCENT (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

3653

The camera device's auto-white balance routine is disabled;

Igor Murashkin

2014-01-15 17:05:22 -0800

[diff] [blame]

3654

the camera device uses warm fluorescent light as the assumed scene

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

3655

illumination for white balance.

3656

While the exact white balance transforms are up to the

3657

camera device, they will approximately match the CIE

3658

standard illuminant F4.

3659

The application's values for <a href="#controls_android.colorCorrection.transform">android.colorCorrection.transform</a>

3660

and <a href="#controls_android.colorCorrection.gains">android.colorCorrection.gains</a> are ignored.

3661

For devices that support the MANUAL_POST_PROCESSING capability, the

3662

values used by the camera device for the transform and gains

3663

will be available in the capture result for this request.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

3664

</li>

3665

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

3666

DAYLIGHT (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

3667

The camera device's auto-white balance routine is disabled;

Igor Murashkin

2014-01-15 17:05:22 -0800

[diff] [blame]

3668

the camera device uses daylight light as the assumed scene

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

3669

illumination for white balance.

3670

While the exact white balance transforms are up to the

3671

camera device, they will approximately match the CIE

3672

standard illuminant D65.

3673

The application's values for <a href="#controls_android.colorCorrection.transform">android.colorCorrection.transform</a>

3674

and <a href="#controls_android.colorCorrection.gains">android.colorCorrection.gains</a> are ignored.

3675

For devices that support the MANUAL_POST_PROCESSING capability, the

3676

values used by the camera device for the transform and gains

3677

will be available in the capture result for this request.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

3678

</li>

3679

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

3680

CLOUDY_DAYLIGHT (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

3681

The camera device's auto-white balance routine is disabled;

Igor Murashkin

2014-01-15 17:05:22 -0800

[diff] [blame]

3682

the camera device uses cloudy daylight light as the assumed scene

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

3683

illumination for white balance.

3684

The application's values for <a href="#controls_android.colorCorrection.transform">android.colorCorrection.transform</a>

3685

and <a href="#controls_android.colorCorrection.gains">android.colorCorrection.gains</a> are ignored.

3686

For devices that support the MANUAL_POST_PROCESSING capability, the

3687

values used by the camera device for the transform and gains

3688

will be available in the capture result for this request.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

3689

</li>

3690

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

3691

TWILIGHT (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

3692

The camera device's auto-white balance routine is disabled;

Igor Murashkin

2014-01-15 17:05:22 -0800

[diff] [blame]

3693

the camera device uses twilight light as the assumed scene

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

3694

illumination for white balance.

3695

The application's values for <a href="#controls_android.colorCorrection.transform">android.colorCorrection.transform</a>

3696

and <a href="#controls_android.colorCorrection.gains">android.colorCorrection.gains</a> are ignored.

3697

For devices that support the MANUAL_POST_PROCESSING capability, the

3698

values used by the camera device for the transform and gains

3699

will be available in the capture result for this request.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

3700

</li>

3701

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

3702

SHADE (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

3703

The camera device's auto-white balance routine is disabled;

Igor Murashkin

2014-01-15 17:05:22 -0800

[diff] [blame]

3704

the camera device uses shade light as the assumed scene

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

3705

illumination for white balance.

3706

The application's values for <a href="#controls_android.colorCorrection.transform">android.colorCorrection.transform</a>

3707

and <a href="#controls_android.colorCorrection.gains">android.colorCorrection.gains</a> are ignored.

3708

For devices that support the MANUAL_POST_PROCESSING capability, the

3709

values used by the camera device for the transform and gains

3710

will be available in the capture result for this request.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</li>

</ul>

</td>

3715

3716

Eino-Ville Talvala

2014-06-06 14:35:41 -0700

[diff] [blame]

3717

Whether auto-white balance (AWB) is currently setting the color

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

3718

transform fields, and what its illumination target

Zhijun He

2014-02-24 09:49:37 -0800

[diff] [blame]

3719

is.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

Zhijun He

2014-01-14 16:30:31 -0800

[diff] [blame]

3726

<a href="#static_android.control.awbAvailableModes">android.control.awbAvailableModes</a>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

3727

</td>

3728

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

3733

3734

Igor Murashkin

2012-12-05 14:49:11 -0800

[diff] [blame]

3735

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</ul>

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

3739

</tr>

3740

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3741

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

3742

</tr>

3743

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3744

Zhijun He

2014-01-14 16:30:31 -0800

[diff] [blame]

3745

This control is only effective if <a href="#controls_android.control.mode">android.control.mode</a> is AUTO.

Jayant Chowdhary

62a9193

2021-01-06 16:56:26 -0800

[diff] [blame]

3746

When set to the AUTO mode, the camera device's auto-white balance

Zhijun He

2014-01-14 16:30:31 -0800

[diff] [blame]

3747

routine is enabled, overriding the application's selected

3748

<a href="#controls_android.colorCorrection.transform">android.colorCorrection.transform</a>, <a href="#controls_android.colorCorrection.gains">android.colorCorrection.gains</a> and

Yin-Chia Yeh

2014-11-12 11:38:10 -0800

[diff] [blame]

3749

<a href="#controls_android.colorCorrection.mode">android.colorCorrection.mode</a>. Note that when <a href="#controls_android.control.aeMode">android.control.aeMode</a>

Shuzhen Wang

2022-05-03 11:01:26 -0700

[diff] [blame]

3750

is OFF, the behavior of AWB is device dependent. It is recommended to

Yin-Chia Yeh

2014-11-12 11:38:10 -0800

[diff] [blame]

3751

also set AWB mode to OFF or lock AWB by using <a href="#controls_android.control.awbLock">android.control.awbLock</a> before

3752

setting AE mode to OFF.

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

3753

When set to the OFF mode, the camera device's auto-white balance

Zhijun He

2014-02-24 09:49:37 -0800

[diff] [blame]

3754

routine is disabled. The application manually controls the white

Eino-Ville Talvala

2014-02-10 12:39:35 -0800

[diff] [blame]

3755

balance by <a href="#controls_android.colorCorrection.transform">android.colorCorrection.transform</a>, <a href="#controls_android.colorCorrection.gains">android.colorCorrection.gains</a>

Zhijun He

2014-01-14 16:30:31 -0800

[diff] [blame]

3756

and <a href="#controls_android.colorCorrection.mode">android.colorCorrection.mode</a>.

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

3757

When set to any other modes, the camera device's auto-white

3758

balance routine is disabled. The camera device uses each

3759

particular illumination target for white balance

3760

adjustment. The application's values for

3761

<a href="#controls_android.colorCorrection.transform">android.colorCorrection.transform</a>,

3762

<a href="#controls_android.colorCorrection.gains">android.colorCorrection.gains</a> and

3763

<a href="#controls_android.colorCorrection.mode">android.colorCorrection.mode</a> are ignored.

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

3764

</td>

3765

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

3766

3767

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3768

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

3769

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

3773

<td class="entry_name

Yin-Chia Yeh

2014-05-16 15:13:13 -0700

[diff] [blame]

3774

" rowspan="5">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

3775

android.control.awbRegions

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

3776

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

3777

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

3778

int32

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

x

5 x area_count

Yin-Chia Yeh

2014-05-16 15:13:13 -0700

[diff] [blame]

3784

[public as meteringRectangle]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

3785

3786

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

3790

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

3791

</td>

3792

3793

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

3794

List of metering areas to use for auto-white-balance illuminant

Ruben Brunk

76e4c7d

2014-01-31 11:05:30 -0800

[diff] [blame]

3795

estimation.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Yin-Chia Yeh

2018-06-15 15:35:05 -0700

[diff] [blame]

3799

Pixel coordinates within android.sensor.info.activeArraySize or

3800

android.sensor.info.preCorrectionActiveArraySize depending on

3801

distortion correction capability and mode

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

3805

Coordinates must be between <code>[(0,0), (width, height))</code> of

Yin-Chia Yeh

2018-06-15 15:35:05 -0700

[diff] [blame]

3806

<a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a> or <a href="#static_android.sensor.info.preCorrectionActiveArraySize">android.sensor.info.preCorrectionActiveArraySize</a>

3807

depending on distortion correction capability and mode

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

3808

</td>

3809

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

</ul>

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3822

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

3823

</tr>

3824

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3825

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

3826

Not available if <a href="#static_android.control.maxRegionsAwb">android.control.maxRegionsAwb</a> is 0.

Yin-Chia Yeh

2014-09-04 09:33:34 -0700

[diff] [blame]

3827

Otherwise will always be present.

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

3828

The maximum number of regions supported by the device is determined by the value

3829

of <a href="#static_android.control.maxRegionsAwb">android.control.maxRegionsAwb</a>.

Yin-Chia Yeh

2018-06-15 15:35:05 -0700

[diff] [blame]

3830

For devices not supporting <a href="#controls_android.distortionCorrection.mode">android.distortionCorrection.mode</a> control, the coordinate

3831

system always follows that of <a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a>, with (0,0) being

3832

the top-left pixel in the active pixel array, and

Eino-Ville Talvala

2014-01-02 16:11:44 -0800

[diff] [blame]

3833

(<a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a>.width - 1,

Yin-Chia Yeh

2018-06-15 15:35:05 -0700

[diff] [blame]

3834

<a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a>.height - 1) being the bottom-right pixel in the

3835

active pixel array.

3836

For devices supporting <a href="#controls_android.distortionCorrection.mode">android.distortionCorrection.mode</a> control, the coordinate

3837

system depends on the mode being set.

3838

When the distortion correction mode is OFF, the coordinate system follows

3839

<a href="#static_android.sensor.info.preCorrectionActiveArraySize">android.sensor.info.preCorrectionActiveArraySize</a>, with

3840

<code>(0, 0)</code> being the top-left pixel of the pre-correction active array, and

3841

(<a href="#static_android.sensor.info.preCorrectionActiveArraySize">android.sensor.info.preCorrectionActiveArraySize</a>.width - 1,

3842

<a href="#static_android.sensor.info.preCorrectionActiveArraySize">android.sensor.info.preCorrectionActiveArraySize</a>.height - 1) being the bottom-right

3843

pixel in the pre-correction active pixel array.

3844

When the distortion correction mode is not OFF, the coordinate system follows

3845

<a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a>, with

3846

<code>(0, 0)</code> being the top-left pixel of the active array, and

3847

(<a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a>.width - 1,

3848

<a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a>.height - 1) being the bottom-right pixel in the

3849

active pixel array.

Yin-Chia Yeh

2014-05-14 14:05:20 -0700

[diff] [blame]

3850

The weight must range from 0 to 1000, and represents a weight

3851

for every pixel in the area. This means that a large metering area

3852

with the same weight as a smaller area will have more effect in

3853

the metering result. Metering areas can partially overlap and the

3854

camera device will add the weights in the overlap region.

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

3855

The weights are relative to weights of other white balance metering regions, so if

3856

only one region is used, all non-zero weights will have the same effect. A region with

3857

0 weight is ignored.

3858

If all regions have 0 weight, then no specific metering area needs to be used by the

3859

camera device.

3860

If the metering region is outside the used <a href="#controls_android.scaler.cropRegion">android.scaler.cropRegion</a> returned in

3861

capture result metadata, the camera device will ignore the sections outside the crop

3862

region and output only the intersection rectangle as the metering region in the result

3863

metadata. If the region is entirely outside the crop region, it will be ignored and

3864

not reported in the result metadata.

Shuzhen Wang

2022-03-28 12:41:41 -0700

[diff] [blame]

3865

When setting the AWB metering regions, the application must consider the additional

3866

crop resulted from the aspect ratio differences between the preview stream and

3867

<a href="#controls_android.scaler.cropRegion">android.scaler.cropRegion</a>. For example, if the <a href="#controls_android.scaler.cropRegion">android.scaler.cropRegion</a> is the full

3868

active array size with 4:3 aspect ratio, and the preview stream is 16:9,

3869

the boundary of AWB regions will be [0, y_crop] and

3870

[active_width, active_height - 2 * y_crop] rather than [0, 0] and

3871

[active_width, active_height], where y_crop is the additional crop due to aspect ratio

3872

mismatch.

Shuzhen Wang

2019-11-07 15:59:22 -0800

[diff] [blame]

3873

Starting from API level 30, the coordinate system of activeArraySize or

3874

preCorrectionActiveArraySize is used to represent post-zoomRatio field of view, not

3875

pre-zoom field of view. This means that the same awbRegions values at different

3876

<a href="#controls_android.control.zoomRatio">android.control.zoomRatio</a> represent different parts of the scene. The awbRegions

3877

coordinates are relative to the activeArray/preCorrectionActiveArray representing the

3878

zoomed field of view. If <a href="#controls_android.control.zoomRatio">android.control.zoomRatio</a> is set to 1.0 (default), the same

3879

awbRegions at different <a href="#controls_android.scaler.cropRegion">android.scaler.cropRegion</a> still represent the same parts of

3880

the scene as they do before. See <a href="#controls_android.control.zoomRatio">android.control.zoomRatio</a> for details. Whether to use

3881

activeArraySize or preCorrectionActiveArraySize still depends on distortion correction

3882

mode.

Jayant Chowdhary

2020-11-09 09:08:31 -0800

[diff] [blame]

3883

For camera devices with the

3884

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraMetadata.html#REQUEST_AVAILABLE_CAPABILITIES_ULTRA_HIGH_RESOLUTION_SENSOR">CameraMetadata#REQUEST_AVAILABLE_CAPABILITIES_ULTRA_HIGH_RESOLUTION_SENSOR</a>

3885

capability, <a href="#static_android.sensor.info.activeArraySizeMaximumResolution">android.sensor.info.activeArraySizeMaximumResolution</a> /

3886

<a href="#static_android.sensor.info.preCorrectionActiveArraySizeMaximumResolution">android.sensor.info.preCorrectionActiveArraySizeMaximumResolution</a> must be used as the

3887

coordinate system for requests where <a href="#controls_android.sensor.pixelMode">android.sensor.pixelMode</a> is set to

3888

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraMetadata.html#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION">CameraMetadata#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION</a>.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

3889

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

3890

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

3891

Yin-Chia Yeh

2014-05-16 15:13:13 -0700

[diff] [blame]

3892

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3893

<th class="th_details" colspan="6">HAL Implementation Details</th>

Yin-Chia Yeh

2014-05-16 15:13:13 -0700

[diff] [blame]

3894

</tr>

3895

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3896

Yin-Chia Yeh

2014-05-16 15:13:13 -0700

[diff] [blame]

3897

The HAL level representation of MeteringRectangle[] is a

3898

int[5 * area_count].

3899

Every five elements represent a metering region of

3900

(xmin, ymin, xmax, ymax, weight).

3901

The rectangle is defined to be inclusive on xmin and ymin, but

Yin-Chia Yeh

2018-06-15 15:35:05 -0700

[diff] [blame]

3902

exclusive on xmax and ymax.

3903

HAL must always report metering regions in the coordinate system of pre-correction

3904

active array.

Yin-Chia Yeh

2014-05-16 15:13:13 -0700

[diff] [blame]

3905

</td>

3906

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

3907

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3908

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

3909

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

3913

<td class="entry_name

3914

" rowspan="3">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

3915

android.control.captureIntent

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

3916

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

3917

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

3918

byte

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

3919

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

3920

[public]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

3921

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

3922

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

3923

[legacy]

3924

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

3925

3926

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

3927

3928

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

3929

CUSTOM (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

3930

The goal of this request doesn't fall into the other

3931

categories. The camera device will default to preview-like

Igor Murashkin

2014-01-15 17:05:22 -0800

[diff] [blame]

3932

behavior.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

3933

</li>

3934

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

3935

PREVIEW (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

3936

This request is for a preview-like use case.

3937

The precapture trigger may be used to start off a metering

3938

w/flash sequence.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

3939

</li>

3940

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

3941

STILL_CAPTURE (v3.2)

Igor Murashkin

2014-01-15 17:05:22 -0800

[diff] [blame]

3942

This request is for a still capture-type

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

3943

use case.

3944

If the flash unit is under automatic control, it may fire as needed.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

3945

</li>

3946

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

3947

VIDEO_RECORD (v3.2)

Igor Murashkin

2014-01-15 17:05:22 -0800

[diff] [blame]

3948

This request is for a video recording

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

3949

use case.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

3950

</li>

3951

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

3952

VIDEO_SNAPSHOT (v3.2)

Igor Murashkin

2014-01-15 17:05:22 -0800

[diff] [blame]

3953

This request is for a video snapshot (still

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

3954

image while recording video) use case.

3955

The camera device should take the highest-quality image

3956

possible (given the other settings) without disrupting the

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

3957

frame rate of video recording.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

3958

</li>

3959

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

3960

ZERO_SHUTTER_LAG (v3.2)

Igor Murashkin

2014-01-15 17:05:22 -0800

[diff] [blame]

3961

This request is for a ZSL usecase; the

3962

application will stream full-resolution images and

3963

reprocess one or several later for a final

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

3964

capture.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

3965

</li>

Zhijun He

2014-04-09 10:55:50 -0700

[diff] [blame]

3966

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

3967

MANUAL (v3.2)

Zhijun He

2014-04-09 10:55:50 -0700

[diff] [blame]

3968

This request is for manual capture use case where

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

3969

the applications want to directly control the capture parameters.

3970

For example, the application may wish to manually control

3971

<a href="#controls_android.sensor.exposureTime">android.sensor.exposureTime</a>, <a href="#controls_android.sensor.sensitivity">android.sensor.sensitivity</a>, etc.

Zhijun He

2014-04-09 10:55:50 -0700

[diff] [blame]

3972

</li>

Eino-Ville Talvala

2017-12-07 13:12:11 -0800

[diff] [blame]

3973

<li>

3974

MOTION_TRACKING (v3.3)

3975

This request is for a motion tracking use case, where

3976

the application will use camera and inertial sensor data to

3977

locate and track objects in the world.

3978

The camera device auto-exposure routine will limit the exposure time

3979

of the camera to no more than 20 milliseconds, to minimize motion blur.

3980

</li>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

3981

</ul>

3982

3983

</td>

3984

3985

Zhijun He

2014-01-15 13:47:59 -0800

[diff] [blame]

3986

Information to the camera device 3A (auto-exposure,

3987

auto-focus, auto-white balance) routines about the purpose

3988

of this capture, to help the camera device to decide optimal 3A

3989

strategy.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

3996

</td>

3997

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

4002

4003

Igor Murashkin

2012-12-05 14:49:11 -0800

[diff] [blame]

4004

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</ul>

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

4008

</tr>

4009

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

4010

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

4011

</tr>

4012

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

4013

Zhijun He

2014-04-09 10:55:50 -0700

[diff] [blame]

4014

This control (except for MANUAL) is only effective if

4015

<code><a href="#controls_android.control.mode">android.control.mode</a> != OFF</code> and any 3A routine is active.

Shuzhen Wang

2022-05-03 11:01:26 -0700

[diff] [blame]

4016

All intents are supported by all devices, except that:

4017

<ul>

4018

<li>ZERO_SHUTTER_LAG will be supported if <a href="#static_android.request.availableCapabilities">android.request.availableCapabilities</a> contains

4019

PRIVATE_REPROCESSING or YUV_REPROCESSING.</li>

4020

<li>MANUAL will be supported if <a href="#static_android.request.availableCapabilities">android.request.availableCapabilities</a> contains

4021

MANUAL_SENSOR.</li>

4022

<li>MOTION_TRACKING will be supported if <a href="#static_android.request.availableCapabilities">android.request.availableCapabilities</a> contains

4023

MOTION_TRACKING.</li>

4024

</ul>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

4025

</td>

4026

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

4027

4028

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

4029

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

4030

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

4034

<td class="entry_name

4035

" rowspan="3">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

4036

android.control.effectMode

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

4037

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

4038

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

4039

byte

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

4040

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

4041

[public]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

4042

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

4043

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

4044

[legacy]

4045

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

4046

4047

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

4048

4049

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

4050

OFF (v3.2)

Ruben Brunk

2014-01-14 17:17:19 -0800

[diff] [blame]

4051

No color effect will be applied.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

4052

</li>

4053

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

4054

MONO (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

4055

[optional]

Ruben Brunk

2014-01-14 17:17:19 -0800

[diff] [blame]

4056

A "monocolor" effect where the image is mapped into

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

4057

a single color.

4058

This will typically be grayscale.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

4059

</li>

4060

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

4061

NEGATIVE (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

4062

[optional]

Ruben Brunk

2014-01-14 17:17:19 -0800

[diff] [blame]

4063

A "photo-negative" effect where the image's colors

4064

are inverted.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

4065

</li>

4066

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

4067

SOLARIZE (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

4068

[optional]

Ruben Brunk

2014-01-14 17:17:19 -0800

[diff] [blame]

4069

A "solarisation" effect (Sabattier effect) where the

4070

image is wholly or partially reversed in

4071

tone.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

4072

</li>

4073

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

4074

SEPIA (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

4075

[optional]

Ruben Brunk

2014-01-14 17:17:19 -0800

[diff] [blame]

4076

A "sepia" effect where the image is mapped into warm

4077

gray, red, and brown tones.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

4078

</li>

4079

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

4080

POSTERIZE (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

4081

[optional]

Ruben Brunk

2014-01-14 17:17:19 -0800

[diff] [blame]

4082

A "posterization" effect where the image uses

4083

discrete regions of tone rather than a continuous

4084

gradient of tones.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

4085

</li>

4086

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

4087

WHITEBOARD (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

4088

[optional]

Ruben Brunk

2014-01-14 17:17:19 -0800

[diff] [blame]

4089

A "whiteboard" effect where the image is typically displayed

4090

as regions of white, with black or grey details.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

4091

</li>

4092

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

4093

BLACKBOARD (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

4094

[optional]

Ruben Brunk

2014-01-14 17:17:19 -0800

[diff] [blame]

4095

A "blackboard" effect where the image is typically displayed

4096

as regions of black, with white or grey details.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

4097

</li>

4098

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

4099

AQUA (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

4100

[optional]

Ruben Brunk

2014-01-14 17:17:19 -0800

[diff] [blame]

4101

An "aqua" effect where a blue hue is added to the image.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</li>

</ul>

</td>

4106

4107

Ruben Brunk

2014-01-14 17:17:19 -0800

[diff] [blame]

4108

A special color effect to apply.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

Eino-Ville Talvala

2014-01-02 16:11:44 -0800

[diff] [blame]

4115

<a href="#static_android.control.availableEffects">android.control.availableEffects</a>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

4116

</td>

4117

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

4122

4123

Igor Murashkin

2012-12-05 14:49:11 -0800

[diff] [blame]

4124

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</ul>

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

4128

</tr>

Ruben Brunk

2014-01-14 17:17:19 -0800

[diff] [blame]

4129

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

4130

<th class="th_details" colspan="6">Details</th>

Ruben Brunk

2014-01-14 17:17:19 -0800

[diff] [blame]

4131

</tr>

4132

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

4133

Ruben Brunk

2014-01-14 17:17:19 -0800

[diff] [blame]

4134

When this mode is set, a color effect will be applied

4135

to images produced by the camera device. The interpretation

4136

and implementation of these color effects is left to the

4137

implementor of the camera device, and should not be

4138

depended on to be consistent (or present) across all

4139

devices.

Ruben Brunk

2014-01-14 17:17:19 -0800

[diff] [blame]

4140

</td>

4141

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

4142

4143

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

4144

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

4145

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

4149

<td class="entry_name

4150

" rowspan="3">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

4151

android.control.mode

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

4152

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

4153

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

4154

byte

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

4155

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

4156

[public]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

4157

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

4158

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

4159

[legacy]

4160

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

4161

4162

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

4163

4164

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

4165

OFF (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

4166

Full application control of pipeline.

4167

All control by the device's metering and focusing (3A)

4168

routines is disabled, and no other settings in

4169

android.control.* have any effect, except that

4170

<a href="#controls_android.control.captureIntent">android.control.captureIntent</a> may be used by the camera

4171

device to select post-processing values for processing

4172

blocks that do not allow for manual control, or are not

4173

exposed by the camera API.

4174

However, the camera device's 3A routines may continue to

4175

collect statistics and update their internal state so that

4176

when control is switched to AUTO mode, good control values

4177

can be immediately applied.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

4178

</li>

4179

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

4180

AUTO (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

4181

Use settings for each individual 3A routine.

4182

Manual control of capture parameters is disabled. All

Igor Murashkin

2014-01-15 17:05:22 -0800

[diff] [blame]

4183

controls in android.control.* besides sceneMode take

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

4184

effect.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

4185

</li>

4186

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

4187

USE_SCENE_MODE (v3.2)

Yin-Chia Yeh

2015-01-28 13:18:31 -0800

[diff] [blame]

4188

[optional]

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

4189

Use a specific scene mode.

4190

Enabling this disables control.aeMode, control.awbMode and

4191

control.afMode controls; the camera device will ignore

4192

those settings while USE_SCENE_MODE is active (except for

Zhijun He

2015-06-16 19:44:18 -0700

[diff] [blame]

4193

FACE_PRIORITY scene mode). Other control entries are still active.

Eino-Ville Talvala

2015-06-24 15:17:09 -0700

[diff] [blame]

4194

This setting can only be used if scene mode is supported (i.e.

Zhijun He

2015-06-16 19:44:18 -0700

[diff] [blame]

4195

<a href="#static_android.control.availableSceneModes">android.control.availableSceneModes</a>

Shuzhen Wang

2020-03-16 11:39:27 -0700

[diff] [blame]

4196

contain some modes other than DISABLED).

4197

For extended scene modes such as BOKEH, please use USE_EXTENDED_SCENE_MODE instead.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

4198

</li>

Zhijun He

2014-02-06 00:28:22 -0800

[diff] [blame]

4199

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

4200

OFF_KEEP_STATE (v3.2)

Yin-Chia Yeh

2015-01-28 13:18:31 -0800

[diff] [blame]

4201

[optional]

Zhijun He

2014-02-06 00:28:22 -0800

[diff] [blame]

4202

Same as OFF mode, except that this capture will not be

4203

used by camera device background auto-exposure, auto-white balance and

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

4204

auto-focus algorithms (3A) to update their statistics.

4205

Specifically, the 3A routines are locked to the last

4206

values set from a request with AUTO, OFF, or

4207

USE_SCENE_MODE, and any statistics or state updates

4208

collected from manual captures with OFF_KEEP_STATE will be

4209

discarded by the camera device.

Zhijun He

2014-02-06 00:28:22 -0800

[diff] [blame]

4210

</li>

Shuzhen Wang

2020-03-16 11:39:27 -0700

[diff] [blame]

4211

<li>

4212

USE_EXTENDED_SCENE_MODE (v3.5)

4213

[optional]

4214

Use a specific extended scene mode.

4215

When extended scene mode is on, the camera device may override certain control

4216

parameters, such as targetFpsRange, AE, AWB, and AF modes, to achieve best power and

4217

quality tradeoffs. Only the mandatory stream combinations of LIMITED hardware level

4218

are guaranteed.

4219

This setting can only be used if extended scene mode is supported (i.e.

4220

android.control.availableExtendedSceneModes

4221

contains some modes other than DISABLED).

4222

</li>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

4223

</ul>

4224

4225

</td>

4226

4227

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

4228

Overall mode of 3A (auto-exposure, auto-white-balance, auto-focus) control

Zhijun He

2014-02-24 09:49:37 -0800

[diff] [blame]

4229

routines.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

Yin-Chia Yeh

2015-01-28 13:18:31 -0800

[diff] [blame]

4236

<a href="#static_android.control.availableModes">android.control.availableModes</a>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

4237

</td>

4238

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

</ul>

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

4251

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

4252

</tr>

4253

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

4254

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

4255

This is a top-level 3A control switch. When set to OFF, all 3A control

Zhijun He

2014-01-16 12:13:35 -0800

[diff] [blame]

4256

by the camera device is disabled. The application must set the fields for

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

4257

capture parameters itself.

4258

When set to AUTO, the individual algorithm controls in

Eino-Ville Talvala

2014-01-02 16:11:44 -0800

[diff] [blame]

4259

android.control.* are in effect, such as <a href="#controls_android.control.afMode">android.control.afMode</a>.

Shuzhen Wang

2020-03-16 11:39:27 -0700

[diff] [blame]

4260

When set to USE_SCENE_MODE or USE_EXTENDED_SCENE_MODE, the individual controls in

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

4261

android.control.* are mostly disabled, and the camera device

Shuzhen Wang

2020-03-16 11:39:27 -0700

[diff] [blame]

4262

implements one of the scene mode or extended scene mode settings (such as ACTION,

4263

SUNSET, PARTY, or BOKEH) as it wishes. The camera device scene mode

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

4264

3A settings are provided by <a href="https://developer.android.com/reference/android/hardware/camera2/CaptureResult.html">capture results</a>.

Zhijun He

2014-02-06 00:28:22 -0800

[diff] [blame]

4265

When set to OFF_KEEP_STATE, it is similar to OFF mode, the only difference

4266

is that this frame will not be used by camera device background 3A statistics

4267

update, as if this frame is never captured. This mode can be used in the scenario

4268

where the application doesn't want a 3A manual control capture to affect

4269

the subsequent auto 3A capture results.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

4270

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

4271

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

4272

4273

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

4274

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

4275

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

4279

<td class="entry_name

4280

" rowspan="5">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

4281

android.control.sceneMode

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

4282

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

4283

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

4284

byte

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

4285

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

4286

[public]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

4287

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

4288

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

4289

[legacy]

4290

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

4291

4292

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

4293

4294

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

4295

DISABLED (v3.2)

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

4296

0

Ruben Brunk

2014-01-14 18:55:29 -0800

[diff] [blame]

4297

Indicates that no scene modes are set for a given capture request.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

4298

</li>

4299

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

4300

FACE_PRIORITY (v3.2)

Ruben Brunk

2014-01-14 18:55:29 -0800

[diff] [blame]

4301

If face detection support exists, use face

4302

detection data for auto-focus, auto-white balance, and

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

4303

auto-exposure routines.

4304

If face detection statistics are disabled

4305

(i.e. <a href="#controls_android.statistics.faceDetectMode">android.statistics.faceDetectMode</a> is set to OFF),

Ruben Brunk

2014-01-14 18:55:29 -0800

[diff] [blame]

4306

this should still operate correctly (but will not return

4307

face detection statistics to the framework).

4308

Unlike the other scene modes, <a href="#controls_android.control.aeMode">android.control.aeMode</a>,

Eino-Ville Talvala

2014-02-10 12:39:35 -0800

[diff] [blame]

4309

<a href="#controls_android.control.awbMode">android.control.awbMode</a>, and <a href="#controls_android.control.afMode">android.control.afMode</a>

Ruben Brunk

2014-01-14 18:55:29 -0800

[diff] [blame]

4310

remain active when FACE_PRIORITY is set.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

4311

</li>

4312

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

4313

ACTION (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

4314

[optional]

4315

Optimized for photos of quickly moving objects.

4316

Similar to SPORTS.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

4317

</li>

4318

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

4319

PORTRAIT (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

4320

[optional]

Ruben Brunk

2014-01-14 18:55:29 -0800

[diff] [blame]

4321

Optimized for still photos of people.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

4322

</li>

4323

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

4324

LANDSCAPE (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

4325

[optional]

Ruben Brunk

2014-01-14 18:55:29 -0800

[diff] [blame]

4326

Optimized for photos of distant macroscopic objects.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

4327

</li>

4328

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

4329

NIGHT (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

4330

[optional]

Ruben Brunk

2014-01-14 18:55:29 -0800

[diff] [blame]

4331

Optimized for low-light settings.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

4332

</li>

4333

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

4334

NIGHT_PORTRAIT (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

4335

[optional]

Ruben Brunk

2014-01-14 18:55:29 -0800

[diff] [blame]

4336

Optimized for still photos of people in low-light

4337

settings.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

4338

</li>

4339

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

4340

THEATRE (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

4341

[optional]

Ruben Brunk

2014-01-14 18:55:29 -0800

[diff] [blame]

4342

Optimized for dim, indoor settings where flash must

4343

remain off.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

4344

</li>

4345

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

4346

BEACH (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

4347

[optional]

Ruben Brunk

2014-01-14 18:55:29 -0800

[diff] [blame]

4348

Optimized for bright, outdoor beach settings.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

4349

</li>

4350

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

4351

SNOW (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

4352

[optional]

Ruben Brunk

2014-01-14 18:55:29 -0800

[diff] [blame]

4353

Optimized for bright, outdoor settings containing snow.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

4354

</li>

4355

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

4356

SUNSET (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

4357

[optional]

Ruben Brunk

2014-01-14 18:55:29 -0800

[diff] [blame]

4358

Optimized for scenes of the setting sun.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

4359

</li>

4360

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

4361

STEADYPHOTO (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

4362

[optional]

Ruben Brunk

2014-01-14 18:55:29 -0800

[diff] [blame]

4363

Optimized to avoid blurry photos due to small amounts of

4364

device motion (for example: due to hand shake).

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

4365

</li>

4366

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

4367

FIREWORKS (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

4368

[optional]

Ruben Brunk

2014-01-14 18:55:29 -0800

[diff] [blame]

4369

Optimized for nighttime photos of fireworks.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

4370

</li>

4371

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

4372

SPORTS (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

4373

[optional]

4374

Optimized for photos of quickly moving people.

4375

Similar to ACTION.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

4376

</li>

4377

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

4378

PARTY (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

4379

[optional]

Ruben Brunk

2014-01-14 18:55:29 -0800

[diff] [blame]

4380

Optimized for dim, indoor settings with multiple moving

4381

people.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

4382

</li>

4383

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

4384

CANDLELIGHT (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

4385

[optional]

Ruben Brunk

2014-01-14 18:55:29 -0800

[diff] [blame]

4386

Optimized for dim settings where the main light source

Shuzhen Wang

36ad880

2018-10-10 17:58:13 -0700

[diff] [blame]

4387

is a candle.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

4388

</li>

4389

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

4390

BARCODE (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

4391

[optional]

Ruben Brunk

2014-01-14 18:55:29 -0800

[diff] [blame]

4392

Optimized for accurately capturing a photo of barcode

4393

for use by camera applications that wish to read the

4394

barcode value.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

4395

</li>

Zhijun He

2014-06-10 18:21:34 -0700

[diff] [blame]

4396

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

4397

HIGH_SPEED_VIDEO (v3.2)

Zhijun He

2015-05-22 17:04:15 -0700

[diff] [blame]

4398

[deprecated]

Zhijun He

2014-06-10 18:21:34 -0700

[diff] [blame]

4399

[optional]

Eino-Ville Talvala

2021-05-27 14:43:59 -0700

[diff] [blame]

4400

[java_public]

Eino-Ville Talvala

2015-06-30 13:32:09 -0700

[diff] [blame]

4401

This is deprecated, please use <a href="https://developer.android.com/reference/android/hardware/camera2/CameraDevice.html#createConstrainedHighSpeedCaptureSession">CameraDevice#createConstrainedHighSpeedCaptureSession</a>

4402

and <a href="https://developer.android.com/reference/android/hardware/camera2/CameraConstrainedHighSpeedCaptureSession.html#createHighSpeedRequestList">CameraConstrainedHighSpeedCaptureSession#createHighSpeedRequestList</a>

Zhijun He

2015-05-22 17:04:15 -0700

[diff] [blame]

4403

for high speed video recording.

4404

Optimized for high speed video recording (frame rate >=60fps) use case.

Zhijun He

2014-06-10 18:21:34 -0700

[diff] [blame]

4405

The supported high speed video sizes and fps ranges are specified in

4406

<a href="#static_android.control.availableHighSpeedVideoConfigurations">android.control.availableHighSpeedVideoConfigurations</a>. To get desired

4407

output frame rates, the application is only allowed to select video size

4408

and fps range combinations listed in this static metadata. The fps range

4409

can be control via <a href="#controls_android.control.aeTargetFpsRange">android.control.aeTargetFpsRange</a>.

4410

In this mode, the camera device will override aeMode, awbMode, and afMode to

4411

ON, ON, and CONTINUOUS_VIDEO, respectively. All post-processing block mode

4412

controls will be overridden to be FAST. Therefore, no manual control of capture

4413

and post-processing parameters is possible. All other controls operate the

4414

same as when <a href="#controls_android.control.mode">android.control.mode</a> == AUTO. This means that all other

4415

android.control.* fields continue to work, such as

4416

<ul>

4417

<li><a href="#controls_android.control.aeTargetFpsRange">android.control.aeTargetFpsRange</a></li>

4418

<li><a href="#controls_android.control.aeExposureCompensation">android.control.aeExposureCompensation</a></li>

4419

<li><a href="#controls_android.control.aeLock">android.control.aeLock</a></li>

4420

<li><a href="#controls_android.control.awbLock">android.control.awbLock</a></li>

4421

<li><a href="#controls_android.control.effectMode">android.control.effectMode</a></li>

4422

<li><a href="#controls_android.control.aeRegions">android.control.aeRegions</a></li>

4423

<li><a href="#controls_android.control.afRegions">android.control.afRegions</a></li>

4424

<li><a href="#controls_android.control.awbRegions">android.control.awbRegions</a></li>

4425

<li><a href="#controls_android.control.afTrigger">android.control.afTrigger</a></li>

4426

<li><a href="#controls_android.control.aePrecaptureTrigger">android.control.aePrecaptureTrigger</a></li>

Shuzhen Wang

2019-11-07 15:59:22 -0800

[diff] [blame]

4427

<li><a href="#controls_android.control.zoomRatio">android.control.zoomRatio</a></li>

Zhijun He

2014-06-10 18:21:34 -0700

[diff] [blame]

4428

</ul>

4429

Outside of android.control.*, the following controls will work:

4430

<ul>

4431

<li><a href="#controls_android.flash.mode">android.flash.mode</a> (automatic flash for still capture will not work since aeMode is ON)</li>

4432

<li><a href="#controls_android.lens.opticalStabilizationMode">android.lens.opticalStabilizationMode</a> (if it is supported)</li>

4433

<li><a href="#controls_android.scaler.cropRegion">android.scaler.cropRegion</a></li>

4434

<li><a href="#controls_android.statistics.faceDetectMode">android.statistics.faceDetectMode</a></li>

4435

</ul>

4436

For high speed recording use case, the actual maximum supported frame rate may

4437

be lower than what camera can output, depending on the destination Surfaces for

4438

the image data. For example, if the destination surface is from video encoder,

4439

the application need check if the video encoder is capable of supporting the

4440

high frame rate for a given video size, or it will end up with lower recording

4441

frame rate. If the destination surface is from preview window, the preview frame

4442

rate will be bounded by the screen refresh rate.

4443

The camera device will only support up to 2 output high speed streams

4444

(processed non-stalling format defined in <a href="#static_android.request.maxNumOutputStreams">android.request.maxNumOutputStreams</a>)

4445

in this mode. This control will be effective only if all of below conditions are true:

4446

<ul>

4447

<li>The application created no more than maxNumHighSpeedStreams processed non-stalling

4448

format output streams, where maxNumHighSpeedStreams is calculated as

4449

min(2, <a href="#static_android.request.maxNumOutputStreams">android.request.maxNumOutputStreams</a>[Processed (but not-stalling)]).</li>

4450

<li>The stream sizes are selected from the sizes reported by

4451

<a href="#static_android.control.availableHighSpeedVideoConfigurations">android.control.availableHighSpeedVideoConfigurations</a>.</li>

4452

<li>No processed non-stalling or raw streams are configured.</li>

4453

</ul>

Shuzhen Wang

2022-05-03 11:01:26 -0700

[diff] [blame]

4454

When above conditions are NOT satisfied, the controls of this mode and

Zhijun He

2014-06-10 18:21:34 -0700

[diff] [blame]

4455

<a href="#controls_android.control.aeTargetFpsRange">android.control.aeTargetFpsRange</a> will be ignored by the camera device,

4456

the camera device will fall back to <a href="#controls_android.control.mode">android.control.mode</a> <code>==</code> AUTO,

Shuzhen Wang

2022-05-03 11:01:26 -0700

[diff] [blame]

4457

and the returned capture result metadata will give the fps range chosen

Zhijun He

2014-06-10 18:21:34 -0700

[diff] [blame]

4458

by the camera device.

4459

Switching into or out of this mode may trigger some camera ISP/sensor

4460

reconfigurations, which may introduce extra latency. It is recommended that

4461

the application avoids unnecessary scene mode switch as much as possible.

4462

</li>

Ruben Brunk

2014-08-28 17:16:38 -0700

[diff] [blame]

4463

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

4464

HDR (v3.2)

Ruben Brunk

2014-08-28 17:16:38 -0700

[diff] [blame]

4465

[optional]

Eino-Ville Talvala

14cd098

2014-12-05 10:46:45 -0800

[diff] [blame]

4466

Turn on a device-specific high dynamic range (HDR) mode.

4467

In this scene mode, the camera device captures images

4468

that keep a larger range of scene illumination levels

4469

visible in the final image. For example, when taking a

4470

picture of a object in front of a bright window, both

4471

the object and the scene through the window may be

4472

visible when using HDR mode, while in normal AUTO mode,

4473

one or the other may be poorly exposed. As a tradeoff,

4474

HDR mode generally takes much longer to capture a single

4475

image, has no user control, and may have other artifacts

4476

depending on the HDR method used.

4477

Therefore, HDR captures operate at a much slower rate

4478

than regular captures.

4479

In this mode, on LIMITED or FULL devices, when a request

4480

is made with a <a href="#controls_android.control.captureIntent">android.control.captureIntent</a> of

4481

STILL_CAPTURE, the camera device will capture an image

4482

using a high dynamic range capture technique. On LEGACY

4483

devices, captures that target a JPEG-format output will

4484

be captured with HDR, and the capture intent is not

4485

relevant.

4486

The HDR capture may involve the device capturing a burst

4487

of images internally and combining them into one, or it

4488

may involve the device using specialized high dynamic

4489

range capture hardware. In all cases, a single image is

4490

produced in response to a capture request submitted

4491

while in HDR mode.

4492

Since substantial post-processing is generally needed to

Eino-Ville Talvala

1f883d4

2016-04-04 10:47:43 -0700

[diff] [blame]

4493

produce an HDR image, only YUV, PRIVATE, and JPEG

4494

outputs are supported for LIMITED/FULL device HDR

4495

captures, and only JPEG outputs are supported for LEGACY

4496

HDR captures. Using a RAW output for HDR capture is not

4497

supported.

4498

Some devices may also support always-on HDR, which

4499

applies HDR processing at full frame rate. For these

4500

devices, intents other than STILL_CAPTURE will also

4501

produce an HDR output with no frame rate impact compared

4502

to normal operation, though the quality may be lower

4503

than for STILL_CAPTURE intents.

4504

If SCENE_MODE_HDR is used with unsupported output types

4505

or capture intents, the images captured will be as if

4506

the SCENE_MODE was not enabled at all.

Ruben Brunk

2014-08-28 17:16:38 -0700

[diff] [blame]

4507

</li>

Zhijun He

2015-06-16 19:44:18 -0700

[diff] [blame]

4508

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

4509

FACE_PRIORITY_LOW_LIGHT (v3.2)

Zhijun He

2015-06-16 19:44:18 -0700

[diff] [blame]

4510

[optional]

4511

[hidden]

4512

Same as FACE_PRIORITY scene mode, except that the camera

Andy Huibers

2015-07-11 08:36:42 -0700

[diff] [blame]

4513

device will choose higher sensitivity values (<a href="#controls_android.sensor.sensitivity">android.sensor.sensitivity</a>)

Zhijun He

2015-06-16 19:44:18 -0700

[diff] [blame]

4514

under low light conditions.

4515

The camera device may be tuned to expose the images in a reduced

4516

sensitivity range to produce the best quality images. For example,

4517

if the <a href="#static_android.sensor.info.sensitivityRange">android.sensor.info.sensitivityRange</a> gives range of [100, 1600],

4518

the camera device auto-exposure routine tuning process may limit the actual

Andy Huibers

2015-07-11 08:36:42 -0700

[diff] [blame]

4519

exposure sensitivity range to [100, 1200] to ensure that the noise level isn't

Shuzhen Wang

2022-05-03 11:01:26 -0700

[diff] [blame]

4520

excessive in order to preserve the image quality. Under this situation, the image under

Zhijun He

2015-06-16 19:44:18 -0700

[diff] [blame]

4521

low light may be under-exposed when the sensor max exposure time (bounded by the

4522

<a href="#controls_android.control.aeTargetFpsRange">android.control.aeTargetFpsRange</a> when <a href="#controls_android.control.aeMode">android.control.aeMode</a> is one of the

Andy Huibers

2015-07-11 08:36:42 -0700

[diff] [blame]

4523

ON_* modes) and effective max sensitivity are reached. This scene mode allows the

Zhijun He

2015-06-16 19:44:18 -0700

[diff] [blame]

4524

camera device auto-exposure routine to increase the sensitivity up to the max

4525

sensitivity specified by <a href="#static_android.sensor.info.sensitivityRange">android.sensor.info.sensitivityRange</a> when the scene is too

4526

dark and the max exposure time is reached. The captured images may be noisier

Andy Huibers

2015-07-11 08:36:42 -0700

[diff] [blame]

4527

compared with the images captured in normal FACE_PRIORITY mode; therefore, it is

Zhijun He

2015-06-16 19:44:18 -0700

[diff] [blame]

4528

recommended that the application only use this scene mode when it is capable of

4529

reducing the noise level of the captured images.

4530

Unlike the other scene modes, <a href="#controls_android.control.aeMode">android.control.aeMode</a>,

4531

<a href="#controls_android.control.awbMode">android.control.awbMode</a>, and <a href="#controls_android.control.afMode">android.control.afMode</a>

4532

remain active when FACE_PRIORITY_LOW_LIGHT is set.

4533

</li>

Yin-Chia Yeh

2016-03-09 14:44:14 -0800

[diff] [blame]

4534

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

4535

DEVICE_CUSTOM_START (v3.2)

Yin-Chia Yeh

2016-03-09 14:44:14 -0800

[diff] [blame]

[optional]

[hidden]

100

Scene mode values within the range of

4540

<code>[DEVICE_CUSTOM_START, DEVICE_CUSTOM_END]</code> are reserved for device specific

4541

customized scene modes.

4542

</li>

4543

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

4544

DEVICE_CUSTOM_END (v3.2)

Yin-Chia Yeh

2016-03-09 14:44:14 -0800

[diff] [blame]

[optional]

[hidden]

127

Scene mode values within the range of

4549

<code>[DEVICE_CUSTOM_START, DEVICE_CUSTOM_END]</code> are reserved for device specific

4550

customized scene modes.

4551

</li>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

4552

</ul>

4553

4554

</td>

4555

4556

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

4557

Control for which scene mode is currently active.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

Eino-Ville Talvala

2014-01-02 16:11:44 -0800

[diff] [blame]

4564

<a href="#static_android.control.availableSceneModes">android.control.availableSceneModes</a>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

4565

</td>

4566

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

4571

4572

Igor Murashkin

2012-12-05 14:49:11 -0800

[diff] [blame]

4573

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</ul>

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

4577

</tr>

Ruben Brunk

2014-01-14 18:55:29 -0800

[diff] [blame]

4578

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

4579

<th class="th_details" colspan="6">Details</th>

Ruben Brunk

2014-01-14 18:55:29 -0800

[diff] [blame]

4580

</tr>

4581

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

4582

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

4583

Scene modes are custom camera modes optimized for a certain set of conditions and

4584

capture settings.

4585

This is the mode that that is active when

Zhijun He

2015-06-16 19:44:18 -0700

[diff] [blame]

4586

<code><a href="#controls_android.control.mode">android.control.mode</a> == USE_SCENE_MODE</code>. Aside from FACE_PRIORITY, these modes will

4587

disable <a href="#controls_android.control.aeMode">android.control.aeMode</a>, <a href="#controls_android.control.awbMode">android.control.awbMode</a>, and <a href="#controls_android.control.afMode">android.control.afMode</a>

4588

while in use.

Ruben Brunk

2014-01-14 18:55:29 -0800

[diff] [blame]

4589

The interpretation and implementation of these scene modes is left

4590

to the implementor of the camera device. Their behavior will not be

4591

consistent across all devices, and any given device may only implement

4592

a subset of these modes.

4593

</td>

4594

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

4595

Ruben Brunk

2014-01-14 18:55:29 -0800

[diff] [blame]

4596

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

4597

<th class="th_details" colspan="6">HAL Implementation Details</th>

Ruben Brunk

2014-01-14 18:55:29 -0800

[diff] [blame]

4598

</tr>

4599

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

4600

Ruben Brunk

2014-01-14 18:55:29 -0800

[diff] [blame]

4601

HAL implementations that include scene modes are expected to provide

4602

the per-scene settings to use for <a href="#controls_android.control.aeMode">android.control.aeMode</a>,

4603

<a href="#controls_android.control.awbMode">android.control.awbMode</a>, and <a href="#controls_android.control.afMode">android.control.afMode</a> in

4604

<a href="#static_android.control.sceneModeOverrides">android.control.sceneModeOverrides</a>.

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

4605

For HIGH_SPEED_VIDEO mode, if it is included in <a href="#static_android.control.availableSceneModes">android.control.availableSceneModes</a>, the

4606

HAL must list supported video size and fps range in

4607

<a href="#static_android.control.availableHighSpeedVideoConfigurations">android.control.availableHighSpeedVideoConfigurations</a>. For a given size, e.g. 1280x720,

4608

if the HAL has two different sensor configurations for normal streaming mode and high

4609

speed streaming, when this scene mode is set/reset in a sequence of capture requests, the

4610

HAL may have to switch between different sensor modes. This mode is deprecated in legacy

4611

HAL3.3, to support high speed video recording, please implement

Zhijun He

2015-05-22 17:04:15 -0700

[diff] [blame]

4612

<a href="#static_android.control.availableHighSpeedVideoConfigurations">android.control.availableHighSpeedVideoConfigurations</a> and CONSTRAINED_HIGH_SPEED_VIDEO

Shuzhen Wang

2022-05-03 11:01:26 -0700

[diff] [blame]

4613

capability defined in <a href="#static_android.request.availableCapabilities">android.request.availableCapabilities</a>.

Ruben Brunk

2014-01-14 18:55:29 -0800

[diff] [blame]

4614

</td>

4615

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

4616

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

4617

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

4618

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

4622

<td class="entry_name

Jayant Chowdhary

2021-09-28 16:32:07 -0700

[diff] [blame]

4623

" rowspan="5">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

4624

android.control.videoStabilizationMode

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

4625

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

4626

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

4627

byte

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

4628

Zhijun He

036b91c

2014-04-29 15:24:16 -0700

[diff] [blame]

4629

[public]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

4630

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

4631

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

4632

[legacy]

4633

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

4634

4635

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

4636

4637

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

4638

OFF (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

4639

Video stabilization is disabled.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

4640

</li>

4641

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

4642

ON (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

4643

Video stabilization is enabled.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

4644

</li>

Jayant Chowdhary

2021-09-28 16:32:07 -0700

[diff] [blame]

4645

<li>

4646

PREVIEW_STABILIZATION (v3.8)

4647

[optional]

4648

Preview stabilization, where the preview in addition to all other non-RAW streams are

4649

stabilized with the same quality of stabilization, is enabled. This mode aims to give

4650

clients a 'what you see is what you get' effect. In this mode, the FoV reduction will

4651

be a maximum of 20 % both horizontally and vertically

4652

(10% from left, right, top, bottom) for the given zoom ratio / crop region.

4653

The resultant FoV will also be the same across all processed streams

4654

(that have the same aspect ratio).

4655

</li>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

4656

</ul>

4657

4658

</td>

4659

4660

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

4661

Whether video stabilization is

Eino-Ville Talvala

2014-06-06 14:35:41 -0700

[diff] [blame]

4662

active.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

4675

4676

Igor Murashkin

2012-12-05 14:49:11 -0800

[diff] [blame]

4677

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</ul>

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

4681

</tr>

4682

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

4683

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

4684

</tr>

4685

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

4686

Jianing Wei

2015-09-29 14:01:43 -0700

[diff] [blame]

4687

Video stabilization automatically warps images from

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

4688

the camera in order to stabilize motion between consecutive frames.

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

4689

If enabled, video stabilization can modify the

Zhijun He

2014-06-12 10:43:32 -0700

[diff] [blame]

4690

<a href="#controls_android.scaler.cropRegion">android.scaler.cropRegion</a> to keep the video stream stabilized.

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

4691

Switching between different video stabilization modes may take several

4692

frames to initialize, the camera device will report the current mode

4693

in capture result metadata. For example, When "ON" mode is requested,

4694

the video stabilization modes in the first several capture results may

4695

still be "OFF", and it will become "ON" when the initialization is

4696

done.

Jianing Wei

2015-09-29 14:01:43 -0700

[diff] [blame]

4697

In addition, not all recording sizes or frame rates may be supported for

4698

stabilization by a device that reports stabilization support. It is guaranteed

4699

that an output targeting a MediaRecorder or MediaCodec will be stabilized if

4700

the recording resolution is less than or equal to 1920 x 1080 (width less than

4701

or equal to 1920, height less than or equal to 1080), and the recording

4702

frame rate is less than or equal to 30fps. At other sizes, the CaptureResult

4703

<a href="#controls_android.control.videoStabilizationMode">android.control.videoStabilizationMode</a> field will return

4704

OFF if the recording output is not stabilized, or if there are no output

4705

Surface types that can be stabilized.

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

4706

If a camera device supports both this mode and OIS

4707

(<a href="#controls_android.lens.opticalStabilizationMode">android.lens.opticalStabilizationMode</a>), turning both modes on may

4708

produce undesirable interaction, so it is recommended not to enable

4709

both at the same time.

Jayant Chowdhary

2021-09-28 16:32:07 -0700

[diff] [blame]

4710

If video stabilization is set to "PREVIEW_STABILIZATION",

4711

<a href="#controls_android.lens.opticalStabilizationMode">android.lens.opticalStabilizationMode</a> is overridden. The camera sub-system may choose

4712

to turn on hardware based image stabilization in addition to software based stabilization

4713

if it deems that appropriate.

4714

This key may be a part of the available session keys, which camera clients may

4715

query via

4716

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics.html#getAvailableSessionKeys">CameraCharacteristics#getAvailableSessionKeys</a>.

4717

If this is the case, changing this key over the life-time of a capture session may

4718

cause delays / glitches.

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

4719

</td>

4720

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

4721

Jayant Chowdhary

2021-09-28 16:32:07 -0700

[diff] [blame]

4722

4723

<th class="th_details" colspan="6">HAL Implementation Details</th>

</tr>

When this key is set to "PREVIEW_STABILIZATION",

Jayant Chowdhary

316b531

2021-12-15 14:35:14 -0800

[diff] [blame]

4728

for non-stalling buffers returned without errors, the time interval between notify readout

Jayant Chowdhary

2021-09-28 16:32:07 -0700

[diff] [blame]

4729

timestamp and when buffers are returned to the camera framework, must be no more than 1

4730

extra frame interval, relative to the case where this key is set to "OFF".

4731

This is in order for look-ahead time period to be short enough

4732

for preview to match video recording for real-time usage.

4733

</td>

4734

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

4735

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

4736

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

4737

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

4738

Yin-Chia Yeh

2016-01-18 19:14:55 -0800

[diff] [blame]

4739

4740

4741

<td class="entry_name

4742

" rowspan="3">

4743

android.control.postRawSensitivityBoost

</td>

int32

[public]

</td>

4756

4757

Yin-Chia Yeh

2016-04-11 16:37:49 -0700

[diff] [blame]

4758

The amount of additional sensitivity boost applied to output images

Yin-Chia Yeh

2016-01-18 19:14:55 -0800

[diff] [blame]

4759

after RAW sensor data is captured.

</td>

ISO arithmetic units, the same as android.sensor.sensitivity

</td>

<a href="#static_android.control.postRawSensitivityBoostRange">android.control.postRawSensitivityBoostRange</a>

4768

</td>

4769

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Yin-Chia Yeh

2016-01-18 19:14:55 -0800

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

4779

<th class="th_details" colspan="6">Details</th>

Yin-Chia Yeh

2016-01-18 19:14:55 -0800

[diff] [blame]

4780

</tr>

4781

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

4782

Yin-Chia Yeh

2016-01-18 19:14:55 -0800

[diff] [blame]

4783

Some camera devices support additional digital sensitivity boosting in the

4784

camera processing pipeline after sensor RAW image is captured.

4785

Such a boost will be applied to YUV/JPEG format output images but will not

4786

have effect on RAW output formats like RAW_SENSOR, RAW10, RAW12 or RAW_OPAQUE.

Yin-Chia Yeh

2016-04-11 16:37:49 -0700

[diff] [blame]

4787

This key will be <code>null</code> for devices that do not support any RAW format

4788

outputs. For devices that do support RAW format outputs, this key will always

4789

present, and if a device does not support post RAW sensitivity boost, it will

4790

list <code>100</code> in this key.

Yin-Chia Yeh

2016-01-18 19:14:55 -0800

[diff] [blame]

4791

If the camera device cannot apply the exact boost requested, it will reduce the

4792

boost to the nearest supported value.

4793

The final boost value used will be available in the output capture result.

4794

For devices that support post RAW sensitivity boost, the YUV/JPEG output images

4795

of such device will have the total sensitivity of

Yin-Chia Yeh

5a12e62

2016-01-26 13:26:56 -0800

[diff] [blame]

4796

<code><a href="#controls_android.sensor.sensitivity">android.sensor.sensitivity</a> * <a href="#controls_android.control.postRawSensitivityBoost">android.control.postRawSensitivityBoost</a> / 100</code>

Yin-Chia Yeh

2016-01-18 19:14:55 -0800

[diff] [blame]

4797

The sensitivity of RAW format images will always be <code><a href="#controls_android.sensor.sensitivity">android.sensor.sensitivity</a></code>

4798

This control is only effective if <a href="#controls_android.control.aeMode">android.control.aeMode</a> or <a href="#controls_android.control.mode">android.control.mode</a> is set to

4799

OFF; otherwise the auto-exposure algorithm will override this value.

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

4804

Yin-Chia Yeh

2016-01-18 19:14:55 -0800

[diff] [blame]

4805

4806

Chien-Yu Chen

2017-01-09 15:55:06 -0800

[diff] [blame]

4807

4808

4809

<td class="entry_name

4810

" rowspan="5">

4811

android.control.enableZsl

</td>

byte

[public as boolean]

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

4824

FALSE (v3.2)

Chien-Yu Chen

2017-01-09 15:55:06 -0800

[diff] [blame]

4825

Requests with <a href="#controls_android.control.captureIntent">android.control.captureIntent</a> == STILL_CAPTURE must be captured

4826

after previous requests.

4827

</li>

4828

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

4829

TRUE (v3.2)

Chien-Yu Chen

2017-01-09 15:55:06 -0800

[diff] [blame]

4830

Requests with <a href="#controls_android.control.captureIntent">android.control.captureIntent</a> == STILL_CAPTURE may or may not be

4831

captured before previous requests.

</li>

</ul>

</td>

4836

4837

4838

Allow camera device to enable zero-shutter-lag mode for requests with

4839

<a href="#controls_android.control.captureIntent">android.control.captureIntent</a> == STILL_CAPTURE.

</td>

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Chien-Yu Chen

2017-01-09 15:55:06 -0800

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

4857

<th class="th_details" colspan="6">Details</th>

Chien-Yu Chen

2017-01-09 15:55:06 -0800

[diff] [blame]

4858

</tr>

4859

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

4860

Chien-Yu Chen

2017-01-09 15:55:06 -0800

[diff] [blame]

4861

If enableZsl is <code>true</code>, the camera device may enable zero-shutter-lag mode for requests with

4862

STILL_CAPTURE capture intent. The camera device may use images captured in the past to

4863

produce output images for a zero-shutter-lag request. The result metadata including the

4864

<a href="#dynamic_android.sensor.timestamp">android.sensor.timestamp</a> reflects the source frames used to produce output images.

4865

Therefore, the contents of the output images and the result metadata may be out of order

4866

compared to previous regular requests. enableZsl does not affect requests with other

4867

capture intents.

4868

For example, when requests are submitted in the following order:

4869

Request A: enableZsl is ON, <a href="#controls_android.control.captureIntent">android.control.captureIntent</a> is PREVIEW

4870

Request B: enableZsl is ON, <a href="#controls_android.control.captureIntent">android.control.captureIntent</a> is STILL_CAPTURE

4871

The output images for request B may have contents captured before the output images for

4872

request A, and the result metadata for request B may be older than the result metadata for

4873

request A.

Chien-Yu Chen

4727280

2017-04-18 15:17:15 -0700

[diff] [blame]

4874

Note that when enableZsl is <code>true</code>, it is not guaranteed to get output images captured in

4875

the past for requests with STILL_CAPTURE capture intent.

4876

For applications targeting SDK versions O and newer, the value of enableZsl in

4877

TEMPLATE_STILL_CAPTURE template may be <code>true</code>. The value in other templates is always

4878

<code>false</code> if present.

4879

For applications targeting SDK versions older than O, the value of enableZsl in all

4880

capture templates is always <code>false</code> if present.

Chien-Yu Chen

853e0dd

2017-05-03 12:17:47 -0700

[diff] [blame]

4881

For application-operated ZSL, use CAMERA3_TEMPLATE_ZERO_SHUTTER_LAG template.

Chien-Yu Chen

2017-01-09 15:55:06 -0800

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

4886

<th class="th_details" colspan="6">HAL Implementation Details</th>

Chien-Yu Chen

2017-01-09 15:55:06 -0800

[diff] [blame]

4887

</tr>

4888

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

4889

Chien-Yu Chen

2017-01-09 15:55:06 -0800

[diff] [blame]

4890

It is valid for HAL to produce regular output images for requests with STILL_CAPTURE

capture intent.

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

4895

Chien-Yu Chen

2017-01-09 15:55:06 -0800

[diff] [blame]

4896

4897

Shuzhen Wang

2019-07-08 15:03:24 -0700

[diff] [blame]

4898

Shuzhen Wang

2020-03-16 11:39:27 -0700

[diff] [blame]

4899

Shuzhen Wang

2019-07-08 15:03:24 -0700

[diff] [blame]

4900

<td class="entry_name

4901

" rowspan="3">

Shuzhen Wang

2020-03-16 11:39:27 -0700

[diff] [blame]

4902

android.control.extendedSceneMode

Shuzhen Wang

2019-07-08 15:03:24 -0700

[diff] [blame]

</td>

byte

[public]

<li>

Shuzhen Wang

2020-03-16 11:39:27 -0700

[diff] [blame]

4915

DISABLED (v3.5)

4916

0

4917

Extended scene mode is disabled.

Shuzhen Wang

2019-07-08 15:03:24 -0700

[diff] [blame]

4918

</li>

4919

<li>

Shuzhen Wang

2020-03-16 11:39:27 -0700

[diff] [blame]

4920

BOKEH_STILL_CAPTURE (v3.5)

Shuzhen Wang

2019-07-08 15:03:24 -0700

[diff] [blame]

4921

High quality bokeh mode is enabled for all non-raw streams (including YUV,

4922

JPEG, and IMPLEMENTATION_DEFINED) when capture intent is STILL_CAPTURE. Due to the

4923

extra image processing, this mode may introduce additional stall to non-raw streams.

4924

This mode should be used in high quality still capture use case.

4925

</li>

4926

<li>

Shuzhen Wang

2020-03-16 11:39:27 -0700

[diff] [blame]

4927

BOKEH_CONTINUOUS (v3.5)

Shuzhen Wang

2019-07-08 15:03:24 -0700

[diff] [blame]

4928

Bokeh effect must not slow down capture rate relative to sensor raw output,

4929

and the effect is applied to all processed streams no larger than the maximum

4930

streaming dimension. This mode should be used if performance and power are a

4931

priority, such as video recording.

4932

</li>

Shuzhen Wang

2020-03-16 11:39:27 -0700

[diff] [blame]

<li>

VENDOR_START (v3.5)

[hidden]

0x40

Vendor defined extended scene modes. These depend on vendor implementation.

4938

</li>

Shuzhen Wang

2019-07-08 15:03:24 -0700

[diff] [blame]

4939

</ul>

4940

4941

</td>

4942

4943

Shuzhen Wang

2020-03-16 11:39:27 -0700

[diff] [blame]

4944

Whether extended scene mode is enabled for a particular capture request.

Shuzhen Wang

2019-07-08 15:03:24 -0700

[diff] [blame]

</td>

</td>

</td>

3.5

</td>

</td>

</tr>

<th class="th_details" colspan="6">Details</th>

</tr>

With bokeh mode, the camera device may blur out the parts of scene that are not in

4967

focus, creating a bokeh (or shallow depth of field) effect for people or objects.

Shuzhen Wang

2020-03-16 11:39:27 -0700

[diff] [blame]

4968

When set to BOKEH_STILL_CAPTURE mode with STILL_CAPTURE capture intent, due to the extra

Shuzhen Wang

2019-07-08 15:03:24 -0700

[diff] [blame]

4969

processing needed for high quality bokeh effect, the stall may be longer than when

4970

capture intent is not STILL_CAPTURE.

Shuzhen Wang

2020-03-16 11:39:27 -0700

[diff] [blame]

4971

When set to BOKEH_STILL_CAPTURE mode with PREVIEW capture intent,

Shuzhen Wang

2019-07-08 15:03:24 -0700

[diff] [blame]

4972

<ul>

4973

<li>If the camera device has BURST_CAPTURE capability, the frame rate requirement of

4974

BURST_CAPTURE must still be met.</li>

Shuzhen Wang

2020-03-16 11:39:27 -0700

[diff] [blame]

4975

<li>All streams not larger than the maximum streaming dimension for BOKEH_STILL_CAPTURE mode

4976

(queried via <a href="https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics.html#CONTROL_AVAILABLE_EXTENDED_SCENE_MODE_CAPABILITIES">CameraCharacteristics#CONTROL_AVAILABLE_EXTENDED_SCENE_MODE_CAPABILITIES</a>)

Shuzhen Wang

2019-07-08 15:03:24 -0700

[diff] [blame]

4977

will have preview bokeh effect applied.</li>

4978

</ul>

Shuzhen Wang

2020-03-16 11:39:27 -0700

[diff] [blame]

4979

When set to BOKEH_CONTINUOUS mode, configured streams dimension should not exceed this mode's

Shuzhen Wang

2019-07-08 15:03:24 -0700

[diff] [blame]

4980

maximum streaming dimension in order to have bokeh effect applied. Bokeh effect may not

4981

be available for streams larger than the maximum streaming dimension.

Shuzhen Wang

2020-03-16 11:39:27 -0700

[diff] [blame]

4982

Switching between different extended scene modes may involve reconfiguration of the camera

Shuzhen Wang

2019-07-08 15:03:24 -0700

[diff] [blame]

4983

pipeline, resulting in long latency. The application should check this key against the

4984

available session keys queried via

4985

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics.html#getAvailableSessionKeys">CameraCharacteristics#getAvailableSessionKeys</a>.

Shuzhen Wang

2019-07-08 15:03:24 -0700

[diff] [blame]

4986

For a logical multi-camera, bokeh may be implemented by stereo vision from sub-cameras

4987

with different field of view. As a result, when bokeh mode is enabled, the camera device

Shuzhen Wang

2020-03-16 11:39:27 -0700

[diff] [blame]

4988

may override <a href="#controls_android.scaler.cropRegion">android.scaler.cropRegion</a> or <a href="#controls_android.control.zoomRatio">android.control.zoomRatio</a>, and the field of

4989

view may be smaller than when bokeh mode is off.

Shuzhen Wang

2019-07-08 15:03:24 -0700

[diff] [blame]

</td>

</tr>

4996

Shuzhen Wang

2019-11-07 15:59:22 -0800

[diff] [blame]

4997

4998

4999

<td class="entry_name

5000

" rowspan="5">

5001

android.control.zoomRatio

</td>

float

[public]

[limited]

</td>

5015

5016

5017

The desired zoom ratio

</td>

</td>

<a href="#static_android.control.zoomRatioRange">android.control.zoomRatioRange</a>

</td>

3.5

</td>

</td>

</tr>

<th class="th_details" colspan="6">Details</th>

</tr>

Shuzhen Wang

2020-09-14 11:40:07 -0700

[diff] [blame]

5040

Instead of using <a href="#controls_android.scaler.cropRegion">android.scaler.cropRegion</a> for zoom, the application can now choose to

5041

use this tag to specify the desired zoom level.

Shuzhen Wang

2019-11-07 15:59:22 -0800

[diff] [blame]

5042

By using this control, the application gains a simpler way to control zoom, which can

Shuzhen Wang

2020-03-12 21:36:18 -0700

[diff] [blame]

5043

be a combination of optical and digital zoom. For example, a multi-camera system may

5044

contain more than one lens with different focal lengths, and the user can use optical

Eino-Ville Talvala

a5213a2

2020-05-10 16:57:36 -0700

[diff] [blame]

5045

zoom by switching between lenses. Using zoomRatio has benefits in the scenarios below:

5046

<ul>

5047

<li>Zooming in from a wide-angle lens to a telephoto lens: A floating-point ratio provides

5048

better precision compared to an integer value of <a href="#controls_android.scaler.cropRegion">android.scaler.cropRegion</a>.</li>

5049

<li>Zooming out from a wide lens to an ultrawide lens: zoomRatio supports zoom-out whereas

5050

<a href="#controls_android.scaler.cropRegion">android.scaler.cropRegion</a> doesn't.</li>

5051

</ul>

Shuzhen Wang

2020-03-12 21:36:18 -0700

[diff] [blame]

5052

To illustrate, here are several scenarios of different zoom ratios, crop regions,

5053

and output streams, for a hypothetical camera device with an active array of size

5054

<code>(2000,1500)</code>.

Shuzhen Wang

2019-11-07 15:59:22 -0800

[diff] [blame]

5055

<ul>

Shuzhen Wang

2020-03-12 21:36:18 -0700

[diff] [blame]

5056

<li>Camera Configuration:<ul>

5057

<li>Active array size: <code>2000x1500</code> (3 MP, 4:3 aspect ratio)</li>

5058

<li>Output stream #1: <code>640x480</code> (VGA, 4:3 aspect ratio)</li>

5059

<li>Output stream #2: <code>1280x720</code> (720p, 16:9 aspect ratio)</li>

Shuzhen Wang

2019-11-07 15:59:22 -0800

[diff] [blame]

5060

</ul>

Shuzhen Wang

2020-03-12 21:36:18 -0700

[diff] [blame]

5061

</li>

5062

<li>Case #1: 4:3 crop region with 2.0x zoom ratio<ul>

5063

<li>Zoomed field of view: 1/4 of original field of view</li>

5064

<li>Crop region: <code>Rect(0, 0, 2000, 1500) // (left, top, right, bottom)</code> (post zoom)</li>

</ul>

</li>

<li><code>640x480</code> stream source area: <code>(0, 0, 2000, 1500)</code> (equal to crop region)</li>

5069

<li><code>1280x720</code> stream source area: <code>(0, 187, 2000, 1312)</code> (letterboxed)</li>

5070

</ul>

5071

</li>

5072

<li>Case #2: 16:9 crop region with 2.0x zoom.<ul>

5073

<li>Zoomed field of view: 1/4 of original field of view</li>

5074

<li>Crop region: <code>Rect(0, 187, 2000, 1312)</code></li>

5075

5076

<li><code>640x480</code> stream source area: <code>(250, 187, 1750, 1312)</code> (pillarboxed)</li>

5077

<li><code>1280x720</code> stream source area: <code>(0, 187, 2000, 1312)</code> (equal to crop region)</li>

5078

</ul>

5079

</li>

5080

<li>Case #3: 1:1 crop region with 0.5x zoom out to ultrawide lens.<ul>

5081

<li>Zoomed field of view: 4x of original field of view (switched from wide lens to ultrawide lens)</li>

5082

<li>Crop region: <code>Rect(250, 0, 1750, 1500)</code></li>

5083

5084

<li><code>640x480</code> stream source area: <code>(250, 187, 1750, 1312)</code> (letterboxed)</li>

5085

<li><code>1280x720</code> stream source area: <code>(250, 328, 1750, 1172)</code> (letterboxed)</li>

</ul>

</li>

</ul>

As seen from the graphs above, the coordinate system of cropRegion now changes to the

5090

effective after-zoom field-of-view, and is represented by the rectangle of (0, 0,

5091

activeArrayWith, activeArrayHeight). The same applies to AE/AWB/AF regions, and faces.

5092

This coordinate system change isn't applicable to RAW capture and its related

5093

metadata such as intrinsicCalibration and lensShadingMap.

5094

Using the same hypothetical example above, and assuming output stream #1 (640x480) is

5095

the viewfinder stream, the application can achieve 2.0x zoom in one of two ways:

5096

<ul>

5097

<li>zoomRatio = 2.0, scaler.cropRegion = (0, 0, 2000, 1500)</li>

5098

<li>zoomRatio = 1.0 (default), scaler.cropRegion = (500, 375, 1500, 1125)</li>

5099

</ul>

5100

If the application intends to set aeRegions to be top-left quarter of the viewfinder

5101

field-of-view, the <a href="#controls_android.control.aeRegions">android.control.aeRegions</a> should be set to (0, 0, 1000, 750) with

Shuzhen Wang

2019-11-07 15:59:22 -0800

[diff] [blame]

5102

zoomRatio set to 2.0. Alternatively, the application can set aeRegions to the equivalent

Shuzhen Wang

2020-03-12 21:36:18 -0700

[diff] [blame]

5103

region of (500, 375, 1000, 750) for zoomRatio of 1.0. If the application doesn't

Shuzhen Wang

2019-11-07 15:59:22 -0800

[diff] [blame]

5104

explicitly set <a href="#controls_android.control.zoomRatio">android.control.zoomRatio</a>, its value defaults to 1.0.

Shuzhen Wang

2019-11-07 15:59:22 -0800

[diff] [blame]

5105

One limitation of controlling zoom using zoomRatio is that the <a href="#controls_android.scaler.cropRegion">android.scaler.cropRegion</a>

5106

must only be used for letterboxing or pillarboxing of the sensor active array, and no

Shuzhen Wang

0ca6316

2020-11-30 20:11:27 -0800

[diff] [blame]

5107

FREEFORM cropping can be used with <a href="#controls_android.control.zoomRatio">android.control.zoomRatio</a> other than 1.0. If

5108

<a href="#controls_android.control.zoomRatio">android.control.zoomRatio</a> is not 1.0, and <a href="#controls_android.scaler.cropRegion">android.scaler.cropRegion</a> is set to be

5109

windowboxing, the camera framework will override the <a href="#controls_android.scaler.cropRegion">android.scaler.cropRegion</a> to be

5110

the active array.

Shuzhen Wang

bd3ad5f

2021-06-30 16:09:35 -0700

[diff] [blame]

5111

In the capture request, if the application sets <a href="#controls_android.control.zoomRatio">android.control.zoomRatio</a> to a

5112

value != 1.0, the <a href="#controls_android.control.zoomRatio">android.control.zoomRatio</a> tag in the capture result reflects the

5113

effective zoom ratio achieved by the camera device, and the <a href="#controls_android.scaler.cropRegion">android.scaler.cropRegion</a>

5114

adjusts for additional crops that are not zoom related. Otherwise, if the application

5115

sets <a href="#controls_android.control.zoomRatio">android.control.zoomRatio</a> to 1.0, or does not set it at all, the

5116

<a href="#controls_android.control.zoomRatio">android.control.zoomRatio</a> tag in the result metadata will also be 1.0.

5117

When the application requests a physical stream for a logical multi-camera, the

5118

<a href="#controls_android.control.zoomRatio">android.control.zoomRatio</a> in the physical camera result metadata will be 1.0, and

5119

the <a href="#controls_android.scaler.cropRegion">android.scaler.cropRegion</a> tag reflects the amount of zoom and crop done by the

5120

physical camera device.

Shuzhen Wang

2019-11-07 15:59:22 -0800

[diff] [blame]

</td>

</tr>

<th class="th_details" colspan="6">HAL Implementation Details</th>

</tr>

For all capture request templates, this field must be set to 1.0 in order to have

5130

consistent field of views between different modes.

</td>

</tr>

5136

Jayant Chowdhary

2021-07-21 11:26:51 -0700

[diff] [blame]

5137

5138

5139

<td class="entry_name

5140

" rowspan="3">

5141

android.control.afRegionsSet

</td>

byte

[fwk_only as boolean]

<li>

Jayant Chowdhary

2021-07-21 11:26:51 -0700

[diff] [blame]

5154

FALSE (v3.2)

5155

AF regions (<a href="#controls_android.control.afRegions">android.control.afRegions</a>) have not been set by the camera client.

5156

</li>

Jayant Chowdhary

2021-09-13 11:29:10 -0700

[diff] [blame]

5157

<li>

5158

TRUE (v3.2)

5159

AF regions (<a href="#controls_android.control.afRegions">android.control.afRegions</a>) have been set by the camera client.

5160

</li>

Jayant Chowdhary

2021-07-21 11:26:51 -0700

[diff] [blame]

5161

</ul>

5162

5163

</td>

5164

5165

5166

Framework-only private key which informs camera fwk that the AF regions has been set

5167

by the client and those regions need not be corrected when <a href="#controls_android.sensor.pixelMode">android.sensor.pixelMode</a> is

5168

set to MAXIMUM_RESOLUTION.

</td>

</td>

</td>

3.2

</td>

</td>

</tr>

<th class="th_details" colspan="6">Details</th>

</tr>

This must be set to TRUE by the camera2 java fwk when the camera client sets

5191

<a href="#controls_android.control.afRegions">android.control.afRegions</a>.

</td>

</tr>

<td class="entry_name

5202

" rowspan="3">

5203

android.control.aeRegionsSet

</td>

byte

[fwk_only as boolean]

<li>

Jayant Chowdhary

2021-07-21 11:26:51 -0700

[diff] [blame]

5216

FALSE (v3.2)

5217

AE regions (<a href="#controls_android.control.aeRegions">android.control.aeRegions</a>) have not been set by the camera client.

5218

</li>

Jayant Chowdhary

2021-09-13 11:29:10 -0700

[diff] [blame]

5219

<li>

5220

TRUE (v3.2)

5221

AE regions (<a href="#controls_android.control.aeRegions">android.control.aeRegions</a>) have been set by the camera client.

5222

</li>

Jayant Chowdhary

2021-07-21 11:26:51 -0700

[diff] [blame]

5223

</ul>

5224

5225

</td>

5226

5227

5228

Framework-only private key which informs camera fwk that the AE regions has been set

5229

by the client and those regions need not be corrected when <a href="#controls_android.sensor.pixelMode">android.sensor.pixelMode</a> is

5230

set to MAXIMUM_RESOLUTION.

</td>

</td>

</td>

3.2

</td>

</td>

</tr>

<th class="th_details" colspan="6">Details</th>

</tr>

This must be set to TRUE by the camera2 java fwk when the camera client sets

5253

<a href="#controls_android.control.aeRegions">android.control.aeRegions</a>.

</td>

</tr>

<td class="entry_name

5264

" rowspan="3">

5265

android.control.awbRegionsSet

</td>

byte

[fwk_only as boolean]

<li>

Jayant Chowdhary

2021-07-21 11:26:51 -0700

[diff] [blame]

5278

FALSE (v3.2)

5279

AWB regions (<a href="#controls_android.control.awbRegions">android.control.awbRegions</a>) have not been set by the camera client.

5280

</li>

Jayant Chowdhary

2021-09-13 11:29:10 -0700

[diff] [blame]

5281

<li>

5282

TRUE (v3.2)

5283

AWB regions (<a href="#controls_android.control.awbRegions">android.control.awbRegions</a>) have been set by the camera client.

5284

</li>

Jayant Chowdhary

2021-07-21 11:26:51 -0700

[diff] [blame]

5285

</ul>

5286

5287

</td>

5288

5289

5290

Framework-only private key which informs camera fwk that the AF regions has been set

5291

by the client and those regions need not be corrected when <a href="#controls_android.sensor.pixelMode">android.sensor.pixelMode</a> is

5292

set to MAXIMUM_RESOLUTION.

</td>

</td>

</td>

3.2

</td>

</td>

</tr>

<th class="th_details" colspan="6">Details</th>

</tr>

This must be set to TRUE by the camera2 java fwk when the camera client sets

5315

<a href="#controls_android.control.awbRegions">android.control.awbRegions</a>.

</td>

</tr>

5322

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</tbody>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

5327

<tr><td colspan="7" class="kind">static</td></tr>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

5328

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

5329

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

5330

<tr>

5331

<th class="th_name">Property Name</th>

5332

5333

<th class="th_description">Description</th>

5334

<th class="th_units">Units</th>

5335

<th class="th_range">Range</th>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

5336

<th class="th_hal_version">Initial HIDL HAL version</th>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</tr>

</thead>

<tbody>

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

5353

<td class="entry_name

5354

" rowspan="3">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

5355

android.control.aeAvailableAntibandingModes

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

5356

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

5357

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

5358

byte

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

x

n

Eino-Ville Talvala

2014-05-27 10:50:30 -0700

[diff] [blame]

5364

[public as enumList]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

5365

5366

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

5367

[legacy]

5368

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

5369

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

5370

<div class="entry_type_notes">list of enums</div>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

5371

5372

5373

</td>

5374

5375

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

5376

List of auto-exposure antibanding modes for <a href="#controls_android.control.aeAntibandingMode">android.control.aeAntibandingMode</a> that are

Eino-Ville Talvala

2013-12-30 12:03:45 -0800

[diff] [blame]

5377

supported by this camera device.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

5384

Any value listed in <a href="#controls_android.control.aeAntibandingMode">android.control.aeAntibandingMode</a>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

5385

</td>

5386

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

5391

Zhijun He

2014-05-21 17:51:05 -0700

[diff] [blame]

5392

5393

5394

</ul>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

5395

</td>

5396

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

5397

</tr>

Eino-Ville Talvala

2013-12-30 12:03:45 -0800

[diff] [blame]

5398

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

5399

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-30 12:03:45 -0800

[diff] [blame]

5400

</tr>

5401

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

5402

Eino-Ville Talvala

2013-12-30 12:03:45 -0800

[diff] [blame]

5403

Not all of the auto-exposure anti-banding modes may be

5404

supported by a given camera device. This field lists the

5405

valid anti-banding modes that the application may request

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

5406

for this camera device with the

Yin-Chia Yeh

2014-11-25 11:51:48 -0800

[diff] [blame]

5407

<a href="#controls_android.control.aeAntibandingMode">android.control.aeAntibandingMode</a> control.

Eino-Ville Talvala

2013-12-30 12:03:45 -0800

[diff] [blame]

5408

</td>

5409

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

5410

5411

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

5412

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

5413

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

5417

<td class="entry_name

5418

" rowspan="3">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

5419

android.control.aeAvailableModes

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

5420

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

5421

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

5422

byte

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

x

n

Eino-Ville Talvala

2014-05-27 10:50:30 -0700

[diff] [blame]

5428

[public as enumList]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

5429

5430

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

5431

[legacy]

5432

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

5433

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

5434

<div class="entry_type_notes">list of enums</div>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

5435

5436

5437

</td>

5438

5439

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

5440

List of auto-exposure modes for <a href="#controls_android.control.aeMode">android.control.aeMode</a> that are supported by this camera

5441

device.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

5448

Any value listed in <a href="#controls_android.control.aeMode">android.control.aeMode</a>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

5449

</td>

5450

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

5455

Eino-Ville Talvala

2014-01-08 16:16:53 -0800

[diff] [blame]

5456

5457

5458

</ul>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

5459

</td>

5460

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

5461

</tr>

Eino-Ville Talvala

2014-01-08 16:16:53 -0800

[diff] [blame]

5462

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

5463

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2014-01-08 16:16:53 -0800

[diff] [blame]

5464

</tr>

5465

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

5466

Eino-Ville Talvala

2014-01-08 16:16:53 -0800

[diff] [blame]

5467

Not all the auto-exposure modes may be supported by a

5468

given camera device, especially if no flash unit is

5469

available. This entry lists the valid modes for

5470

<a href="#controls_android.control.aeMode">android.control.aeMode</a> for this camera device.

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

5471

All camera devices support ON, and all camera devices with flash

5472

units support ON_AUTO_FLASH and ON_ALWAYS_FLASH.

Ruben Brunk

2014-03-04 14:09:44 -0800

[diff] [blame]

5473

FULL mode camera devices always support OFF mode,

Eino-Ville Talvala

2014-01-08 16:16:53 -0800

[diff] [blame]

5474

which enables application control of camera exposure time,

5475

sensitivity, and frame duration.

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

5476

LEGACY mode camera devices never support OFF mode.

5477

LIMITED mode devices support OFF if they support the MANUAL_SENSOR

5478

capability.

Eino-Ville Talvala

2014-01-08 16:16:53 -0800

[diff] [blame]

5479

</td>

5480

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

5481

5482

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

5483

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

5484

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

5488

<td class="entry_name

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

5489

" rowspan="3">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

5490

android.control.aeAvailableTargetFpsRanges

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

5491

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

5492

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

5493

int32

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

x

2 x n

Igor Murashkin

2014-05-27 10:51:25 -0700

[diff] [blame]

5499

[public as rangeInt]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

5500

5501

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

5502

[legacy]

5503

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

5504

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

5505

<div class="entry_type_notes">list of pairs of frame rates</div>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

5506

5507

5508

</td>

5509

5510

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

5511

List of frame rate ranges for <a href="#controls_android.control.aeTargetFpsRange">android.control.aeTargetFpsRange</a> supported by

5512

this camera device.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

5516

Frames per second (FPS)

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

5526

Zhijun He

2014-05-21 17:51:05 -0700

[diff] [blame]

5527

5528

5529

</ul>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

5530

</td>

5531

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

5532

</tr>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

5533

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

5534

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

5535

</tr>

5536

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

5537

Yin-Chia Yeh

2015-05-21 11:23:48 -0700

[diff] [blame]

5538

For devices at the LEGACY level or above:

5539

<ul>

Yin-Chia Yeh

30bf75b

2015-11-20 15:16:05 -0800

[diff] [blame]

5540

<li>

5541

For constant-framerate recording, for each normal

5542

<a href="https://developer.android.com/reference/android/media/CamcorderProfile.html">CamcorderProfile</a>, that is, a

Yin-Chia Yeh

2015-05-21 11:23:48 -0700

[diff] [blame]

5543

<a href="https://developer.android.com/reference/android/media/CamcorderProfile.html">CamcorderProfile</a> that has

5544

<a href="https://developer.android.com/reference/android/media/CamcorderProfile.html#quality">quality</a> in

5545

the range [<a href="https://developer.android.com/reference/android/media/CamcorderProfile.html#QUALITY_LOW">QUALITY_LOW</a>,

5546

<a href="https://developer.android.com/reference/android/media/CamcorderProfile.html#QUALITY_2160P">QUALITY_2160P</a>], if the profile is

5547

supported by the device and has

5548

<a href="https://developer.android.com/reference/android/media/CamcorderProfile.html#videoFrameRate">videoFrameRate</a> <code>x</code>, this list will

Yin-Chia Yeh

30bf75b

2015-11-20 15:16:05 -0800

[diff] [blame]

5549

always include (<code>x</code>,<code>x</code>).

5550

</li>

5551

<li>

5552

Also, a camera device must either not support any

5553

<a href="https://developer.android.com/reference/android/media/CamcorderProfile.html">CamcorderProfile</a>,

5554

or support at least one

5555

normal <a href="https://developer.android.com/reference/android/media/CamcorderProfile.html">CamcorderProfile</a> that has

5556

<a href="https://developer.android.com/reference/android/media/CamcorderProfile.html#videoFrameRate">videoFrameRate</a> <code>x</code> >= 24.

5557

</li>

Yin-Chia Yeh

2015-05-21 11:23:48 -0700

[diff] [blame]

5558

</ul>

5559

For devices at the LIMITED level or above:

5560

<ul>

Yin-Chia Yeh

56a51f3

2019-06-12 14:45:21 -0700

[diff] [blame]

5561

<li>For devices that advertise NIR color filter arrangement in

5562

<a href="#static_android.sensor.info.colorFilterArrangement">android.sensor.info.colorFilterArrangement</a>, this list will always include

5563

(<code>max</code>, <code>max</code>) where <code>max</code> = the maximum output frame rate of the maximum YUV_420_888

5564

output size.</li>

5565

<li>For devices advertising any color filter arrangement other than NIR, or devices not

5566

advertising color filter arrangement, this list will always include (<code>min</code>, <code>max</code>) and

5567

(<code>max</code>, <code>max</code>) where <code>min</code> <= 15 and <code>max</code> = the maximum output frame rate of the

Yin-Chia Yeh

2015-05-21 11:23:48 -0700

[diff] [blame]

5568

maximum YUV_420_888 output size.</li>

5569

</ul>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

5570

</td>

5571

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

5572

5573

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

5574

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

5575

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

5579

<td class="entry_name

5580

" rowspan="1">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

5581

android.control.aeCompensationRange

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

5582

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

5583

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

5584

int32

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

x

2

Igor Murashkin

2014-05-27 10:51:25 -0700

[diff] [blame]

5590

[public as rangeInt]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

5591

5592

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

5593

[legacy]

5594

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

5598

</td>

5599

5600

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

5601

Maximum and minimum exposure compensation values for

5602

<a href="#controls_android.control.aeExposureCompensation">android.control.aeExposureCompensation</a>, in counts of <a href="#static_android.control.aeCompensationStep">android.control.aeCompensationStep</a>,

5603

that are supported by this camera device.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

Zhijun He

2015-02-04 13:51:22 -0800

[diff] [blame]

5610

Range [0,0] indicates that exposure compensation is not supported.

5611

For LIMITED and FULL devices, range must follow below requirements if exposure

5612

compensation is supported (<code>range != [0, 0]</code>):

5613

<code>Min.exposure compensation * <a href="#static_android.control.aeCompensationStep">android.control.aeCompensationStep</a> <= -2 EV</code>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

5614

<code>Max.exposure compensation * <a href="#static_android.control.aeCompensationStep">android.control.aeCompensationStep</a> >= 2 EV</code>

Zhijun He

fa73c08

2015-02-04 13:51:22 -0800

[diff] [blame]

5615

LEGACY devices may support a smaller range than this.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

5616

</td>

5617

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

5622

5623

Igor Murashkin

2012-12-05 14:49:11 -0800

[diff] [blame]

5624

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</ul>

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

5628

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

5629

5630

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

5631

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

5632

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

5636

<td class="entry_name

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

5637

" rowspan="5">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

5638

android.control.aeCompensationStep

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

5639

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

5640

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

5641

rational

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

5642

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

5643

[public]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

5644

5645

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

5646

[legacy]

5647

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

5651

</td>

5652

5653

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

5654

Smallest step by which the exposure compensation

5655

can be changed.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

5659

Exposure Value (EV)

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

5663

</td>

5664

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

5669

5670

Igor Murashkin

2012-12-05 14:49:11 -0800

[diff] [blame]

5671

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</ul>

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

5675

</tr>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

5676

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

5677

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

5678

</tr>

5679

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

5680

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

5681

This is the unit for <a href="#controls_android.control.aeExposureCompensation">android.control.aeExposureCompensation</a>. For example, if this key has

5682

a value of <code>1/2</code>, then a setting of <code>-2</code> for <a href="#controls_android.control.aeExposureCompensation">android.control.aeExposureCompensation</a> means

5683

that the target EV offset for the auto-exposure routine is -1 EV.

5684

One unit of EV compensation changes the brightness of the captured image by a factor

5685

of two. +1 EV doubles the image brightness, while -1 EV halves the image brightness.

5686

</td>

5687

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

5688

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

5689

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

5690

<th class="th_details" colspan="6">HAL Implementation Details</th>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

5691

</tr>

5692

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

5693

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

5694

This must be less than or equal to 1/2.

5695

</td>

5696

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

5697

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

5698

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

5699

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

5703

<td class="entry_name

5704

" rowspan="3">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

5705

android.control.afAvailableModes

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

5706

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

5707

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

5708

byte

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

x

n

Eino-Ville Talvala

2014-05-27 10:50:30 -0700

[diff] [blame]

5714

[public as enumList]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

5715

5716

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

5717

[legacy]

5718

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

5719

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

5720

<div class="entry_type_notes">List of enums</div>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

5721

5722

5723

</td>

5724

5725

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

5726

List of auto-focus (AF) modes for <a href="#controls_android.control.afMode">android.control.afMode</a> that are

5727

supported by this camera device.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

5734

Any value listed in <a href="#controls_android.control.afMode">android.control.afMode</a>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

5735

</td>

5736

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

5741

5742

Igor Murashkin

2012-12-05 14:49:11 -0800

[diff] [blame]

5743

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</ul>

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

5747

</tr>

Zhijun He

2014-01-14 09:59:04 -0800

[diff] [blame]

5748

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

5749

<th class="th_details" colspan="6">Details</th>

Zhijun He

2014-01-14 09:59:04 -0800

[diff] [blame]

5750

</tr>

5751

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

5752

Zhijun He

2014-01-14 09:59:04 -0800

[diff] [blame]

5753

Not all the auto-focus modes may be supported by a

5754

given camera device. This entry lists the valid modes for

5755

<a href="#controls_android.control.afMode">android.control.afMode</a> for this camera device.

Ruben Brunk

a5bcb40

2014-09-22 16:11:06 -0700

[diff] [blame]

5756

All LIMITED and FULL mode camera devices will support OFF mode, and all

5757

camera devices with adjustable focuser units

5758

(<code><a href="#static_android.lens.info.minimumFocusDistance">android.lens.info.minimumFocusDistance</a> > 0</code>) will support AUTO mode.

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

5759

LEGACY devices will support OFF mode only if they support

5760

focusing to infinity (by also setting <a href="#controls_android.lens.focusDistance">android.lens.focusDistance</a> to

5761

<code>0.0f</code>).

Zhijun He

2014-01-14 09:59:04 -0800

[diff] [blame]

5762

</td>

5763

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

5764

5765

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

5766

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

5767

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

5771

<td class="entry_name

5772

" rowspan="3">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

5773

android.control.availableEffects

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

5774

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

5775

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

5776

byte

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

x

n

Eino-Ville Talvala

2014-05-27 10:50:30 -0700

[diff] [blame]

5782

[public as enumList]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

5783

5784

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

5785

[legacy]

5786

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

5787

Ruben Brunk

2014-01-14 17:17:19 -0800

[diff] [blame]

5788

<div class="entry_type_notes">List of enums (android.control.effectMode).</div>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

5789

5790

5791

</td>

5792

5793

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

5794

List of color effects for <a href="#controls_android.control.effectMode">android.control.effectMode</a> that are supported by this camera

5795

device.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

5802

Any value listed in <a href="#controls_android.control.effectMode">android.control.effectMode</a>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

5803

</td>

5804

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

5809

5810

Igor Murashkin

2012-12-05 14:49:11 -0800

[diff] [blame]

5811

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</ul>

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

5815

</tr>

Ruben Brunk

2014-01-14 17:17:19 -0800

[diff] [blame]

5816

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

5817

<th class="th_details" colspan="6">Details</th>

Ruben Brunk

2014-01-14 17:17:19 -0800

[diff] [blame]

5818

</tr>

5819

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

5820

Ruben Brunk

2014-01-14 17:17:19 -0800

[diff] [blame]

5821

This list contains the color effect modes that can be applied to

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

5822

images produced by the camera device.

Ruben Brunk

2014-01-14 17:17:19 -0800

[diff] [blame]

5823

Implementations are not expected to be consistent across all devices.

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

5824

If no color effect modes are available for a device, this will only list

5825

OFF.

Ruben Brunk

2014-01-14 17:17:19 -0800

[diff] [blame]

5826

A color effect will only be applied if

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

5827

<a href="#controls_android.control.mode">android.control.mode</a> != OFF. OFF is always included in this list.

5828

This control has no effect on the operation of other control routines such

5829

as auto-exposure, white balance, or focus.

Ruben Brunk

2014-01-14 17:17:19 -0800

[diff] [blame]

5830

</td>

5831

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

5832

5833

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

5834

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

5835

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

5839

<td class="entry_name

5840

" rowspan="3">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

5841

android.control.availableSceneModes

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

5842

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

5843

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

5844

byte

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

x

n

Eino-Ville Talvala

2014-05-27 10:50:30 -0700

[diff] [blame]

5850

[public as enumList]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

5851

5852

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

5853

[legacy]

5854

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

5855

Ruben Brunk

2014-01-14 17:46:58 -0800

[diff] [blame]

5856

<div class="entry_type_notes">List of enums (android.control.sceneMode).</div>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

5857

5858

5859

</td>

5860

5861

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

5862

List of scene modes for <a href="#controls_android.control.sceneMode">android.control.sceneMode</a> that are supported by this camera

5863

device.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

5870

Any value listed in <a href="#controls_android.control.sceneMode">android.control.sceneMode</a>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

5871

</td>

5872

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

5877

5878

Igor Murashkin

2012-12-05 14:49:11 -0800

[diff] [blame]

5879

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</ul>

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

5883

</tr>

Ruben Brunk

2014-01-14 17:46:58 -0800

[diff] [blame]

5884

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

5885

<th class="th_details" colspan="6">Details</th>

Ruben Brunk

2014-01-14 17:46:58 -0800

[diff] [blame]

5886

</tr>

5887

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

5888

Ruben Brunk

2014-01-14 17:46:58 -0800

[diff] [blame]

5889

This list contains scene modes that can be set for the camera device.

5890

Only scene modes that have been fully implemented for the

5891

camera device may be included here. Implementations are not expected

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

5892

to be consistent across all devices.

5893

If no scene modes are supported by the camera device, this

5894

will be set to DISABLED. Otherwise DISABLED will not be listed.

5895

FACE_PRIORITY is always listed if face detection is

5896

supported (i.e.<code><a href="#static_android.statistics.info.maxFaceCount">android.statistics.info.maxFaceCount</a> >

5897

0</code>).

Ruben Brunk

2014-01-14 17:46:58 -0800

[diff] [blame]

5898

</td>

5899

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

5900

5901

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

5902

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

5903

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

5907

<td class="entry_name

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

5908

" rowspan="3">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

5909

android.control.availableVideoStabilizationModes

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

5910

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

5911

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

5912

byte

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

x

n

Eino-Ville Talvala

2014-05-27 10:50:30 -0700

[diff] [blame]

5918

[public as enumList]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

5919

5920

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

5921

[legacy]

5922

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

5923

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

5924

<div class="entry_type_notes">List of enums.</div>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

5925

5926

5927

</td>

5928

5929

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

5930

List of video stabilization modes for <a href="#controls_android.control.videoStabilizationMode">android.control.videoStabilizationMode</a>

5931

that are supported by this camera device.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

5938

Any value listed in <a href="#controls_android.control.videoStabilizationMode">android.control.videoStabilizationMode</a>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

5939

</td>

5940

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

5945

5946

Igor Murashkin

2012-12-05 14:49:11 -0800

[diff] [blame]

5947

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</ul>

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

5951

</tr>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

5952

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

5953

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

5954

</tr>

5955

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

5956

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

5957

OFF will always be listed.

5958

</td>

5959

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

5960

5961

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

5962

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

5963

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

5967

<td class="entry_name

5968

" rowspan="3">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

5969

android.control.awbAvailableModes

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

5970

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

5971

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

5972

byte

Alex Ray

a4251d9

2013-04-30 16:43:44 -0700

[diff] [blame]

5973

x

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

5974

Alex Ray

a4251d9

2013-04-30 16:43:44 -0700

[diff] [blame]

n

Eino-Ville Talvala

2014-05-27 10:50:30 -0700

[diff] [blame]

5978

[public as enumList]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

5979

5980

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

5981

[legacy]

5982

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

5983

Zhijun He

2014-01-14 16:30:31 -0800

[diff] [blame]

5984

<div class="entry_type_notes">List of enums</div>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

5985

5986

5987

</td>

5988

5989

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

5990

List of auto-white-balance modes for <a href="#controls_android.control.awbMode">android.control.awbMode</a> that are supported by this

5991

camera device.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

5998

Any value listed in <a href="#controls_android.control.awbMode">android.control.awbMode</a>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

5999

</td>

6000

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

6005

6006

Igor Murashkin

2012-12-05 14:49:11 -0800

[diff] [blame]

6007

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</ul>

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

6011

</tr>

Zhijun He

2014-01-14 16:30:31 -0800

[diff] [blame]

6012

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

6013

<th class="th_details" colspan="6">Details</th>

Zhijun He

2014-01-14 16:30:31 -0800

[diff] [blame]

6014

</tr>

6015

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

6016

Zhijun He

2014-01-14 16:30:31 -0800

[diff] [blame]

6017

Not all the auto-white-balance modes may be supported by a

6018

given camera device. This entry lists the valid modes for

6019

<a href="#controls_android.control.awbMode">android.control.awbMode</a> for this camera device.

6020

All camera devices will support ON mode.

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

6021

Camera devices that support the MANUAL_POST_PROCESSING capability will always support OFF

6022

mode, which enables application control of white balance, by using

6023

<a href="#controls_android.colorCorrection.transform">android.colorCorrection.transform</a> and <a href="#controls_android.colorCorrection.gains">android.colorCorrection.gains</a>(<a href="#controls_android.colorCorrection.mode">android.colorCorrection.mode</a> must be set to TRANSFORM_MATRIX). This includes all FULL

6024

mode camera devices.

Zhijun He

2014-01-14 16:30:31 -0800

[diff] [blame]

6025

</td>

6026

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

6027

6028

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

6029

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

6030

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

6034

<td class="entry_name

6035

" rowspan="1">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

6036

android.control.maxRegions

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

6037

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

6038

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

6039

int32

Ruben Brunk

2014-01-15 15:55:08 -0800

[diff] [blame]

6040

x

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

6041

Ruben Brunk

2014-01-15 15:55:08 -0800

[diff] [blame]

3

Yin-Chia Yeh

2016-04-02 16:30:30 -0700

[diff] [blame]

6045

[ndk_public]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

6046

6047

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

6048

[legacy]

6049

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

6053

</td>

6054

6055

Ruben Brunk

2014-01-15 15:55:08 -0800

[diff] [blame]

6056

List of the maximum number of regions that can be used for metering in

6057

auto-exposure (AE), auto-white balance (AWB), and auto-focus (AF);

Yin-Chia Yeh

2019-10-07 15:16:15 -0700

[diff] [blame]

6058

this corresponds to the maximum number of elements in

Ruben Brunk

2014-01-15 15:55:08 -0800

[diff] [blame]

6059

<a href="#controls_android.control.aeRegions">android.control.aeRegions</a>, <a href="#controls_android.control.awbRegions">android.control.awbRegions</a>,

6060

and <a href="#controls_android.control.afRegions">android.control.afRegions</a>.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

Ruben Brunk

2014-01-15 15:55:08 -0800

[diff] [blame]

6067

Value must be >= 0 for each element. For full-capability devices

6068

this value must be >= 1 for AE and AF. The order of the elements is:

6069

<code>(AE, AWB, AF)</code>.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

6070

</td>

6071

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

6076

6077

Igor Murashkin

2012-12-05 14:49:11 -0800

[diff] [blame]

6078

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</ul>

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

6082

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

6083

6084

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

6085

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

6086

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

6087

6088

Igor Murashkin

2014-05-27 10:51:25 -0700

[diff] [blame]

6089

6090

<td class="entry_name

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

6091

" rowspan="5">

Igor Murashkin

2014-05-27 10:51:25 -0700

[diff] [blame]

6092

android.control.maxRegionsAe

</td>

int32

Yin-Chia Yeh

2016-04-02 16:30:30 -0700

[diff] [blame]

6097

[java_public]

Igor Murashkin

2014-05-27 10:51:25 -0700

[diff] [blame]

[synthetic]

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

6101

[legacy]

6102

Igor Murashkin

2014-05-27 10:51:25 -0700

[diff] [blame]

</td>

6107

6108

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

6109

The maximum number of metering regions that can be used by the auto-exposure (AE)

6110

routine.

Igor Murashkin

2014-05-27 10:51:25 -0700

[diff] [blame]

</td>

</td>

Value will be >= 0. For FULL-capability devices, this

value will be >= 1.

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2014-05-27 10:51:25 -0700

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

6129

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

6130

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

6131

</tr>

6132

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

6133

Yin-Chia Yeh

2019-10-07 15:16:15 -0700

[diff] [blame]

6134

This corresponds to the maximum allowed number of elements in

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

6135

<a href="#controls_android.control.aeRegions">android.control.aeRegions</a>.

6136

</td>

6137

</tr>

Igor Murashkin

2014-05-27 10:51:25 -0700

[diff] [blame]

6138

6139

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

6140

<th class="th_details" colspan="6">HAL Implementation Details</th>

Igor Murashkin

2014-05-27 10:51:25 -0700

[diff] [blame]

6141

</tr>

6142

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

6143

Igor Murashkin

2014-05-27 10:51:25 -0700

[diff] [blame]

6144

This entry is private to the framework. Fill in

6145

maxRegions to have this entry be automatically populated.

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

6149

Igor Murashkin

2014-05-27 10:51:25 -0700

[diff] [blame]

6150

<td class="entry_name

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

6155

" rowspan="5">

Igor Murashkin

2014-05-27 10:51:25 -0700

[diff] [blame]

6156

android.control.maxRegionsAwb

</td>

int32

Yin-Chia Yeh

2016-04-02 16:30:30 -0700

[diff] [blame]

6161

[java_public]

Igor Murashkin

2014-05-27 10:51:25 -0700

[diff] [blame]

[synthetic]

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

6165

[legacy]

6166

Igor Murashkin

2014-05-27 10:51:25 -0700

[diff] [blame]

</td>

6171

6172

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

6173

The maximum number of metering regions that can be used by the auto-white balance (AWB)

6174

routine.

Igor Murashkin

2014-05-27 10:51:25 -0700

[diff] [blame]

</td>

</td>

Value will be >= 0.

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2014-05-27 10:51:25 -0700

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

6192

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

6193

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

6194

</tr>

6195

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

6196

Yin-Chia Yeh

2019-10-07 15:16:15 -0700

[diff] [blame]

6197

This corresponds to the maximum allowed number of elements in

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

6198

<a href="#controls_android.control.awbRegions">android.control.awbRegions</a>.

6199

</td>

6200

</tr>

Igor Murashkin

2014-05-27 10:51:25 -0700

[diff] [blame]

6201

6202

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

6203

<th class="th_details" colspan="6">HAL Implementation Details</th>

Igor Murashkin

2014-05-27 10:51:25 -0700

[diff] [blame]

6204

</tr>

6205

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

6206

Igor Murashkin

2014-05-27 10:51:25 -0700

[diff] [blame]

6207

This entry is private to the framework. Fill in

6208

maxRegions to have this entry be automatically populated.

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

6212

Igor Murashkin

2014-05-27 10:51:25 -0700

[diff] [blame]

6213

<td class="entry_name

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

6218

" rowspan="5">

Igor Murashkin

2014-05-27 10:51:25 -0700

[diff] [blame]

6219

android.control.maxRegionsAf

</td>

int32

Yin-Chia Yeh

2016-04-02 16:30:30 -0700

[diff] [blame]

6224

[java_public]

Igor Murashkin

2014-05-27 10:51:25 -0700

[diff] [blame]

[synthetic]

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

6228

[legacy]

6229

Igor Murashkin

2014-05-27 10:51:25 -0700

[diff] [blame]

</td>

6234

6235

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

6236

The maximum number of metering regions that can be used by the auto-focus (AF) routine.

Igor Murashkin

2014-05-27 10:51:25 -0700

[diff] [blame]

</td>

</td>

Value will be >= 0. For FULL-capability devices, this

value will be >= 1.

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2014-05-27 10:51:25 -0700

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

6255

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

6256

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

6257

</tr>

6258

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

6259

Yin-Chia Yeh

2019-10-07 15:16:15 -0700

[diff] [blame]

6260

This corresponds to the maximum allowed number of elements in

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

6261

<a href="#controls_android.control.afRegions">android.control.afRegions</a>.

6262

</td>

6263

</tr>

Igor Murashkin

2014-05-27 10:51:25 -0700

[diff] [blame]

6264

6265

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

6266

<th class="th_details" colspan="6">HAL Implementation Details</th>

Igor Murashkin

2014-05-27 10:51:25 -0700

[diff] [blame]

6267

</tr>

6268

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

6269

Igor Murashkin

2014-05-27 10:51:25 -0700

[diff] [blame]

6270

This entry is private to the framework. Fill in

6271

maxRegions to have this entry be automatically populated.

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

6275

Igor Murashkin

2014-05-27 10:51:25 -0700

[diff] [blame]

6276

6277

6278

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

6279

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

6280

<td class="entry_name

6281

" rowspan="5">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

6282

android.control.sceneModeOverrides

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

6283

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

6284

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

6285

byte

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

x

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

6289

3 x length(availableSceneModes)

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

6290

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

6291

[system]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

6292

6293

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

6294

[limited]

6295

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

6299

</td>

6300

6301

Ruben Brunk

2014-01-14 19:31:21 -0800

[diff] [blame]

6302

Ordered list of auto-exposure, auto-white balance, and auto-focus

6303

settings to use with each available scene mode.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

Ruben Brunk

2014-01-14 19:31:21 -0800

[diff] [blame]

6310

For each available scene mode, the list must contain three

6311

entries containing the <a href="#controls_android.control.aeMode">android.control.aeMode</a>,

6312

<a href="#controls_android.control.awbMode">android.control.awbMode</a>, and <a href="#controls_android.control.afMode">android.control.afMode</a> values used

6313

by the camera device. The entry order is <code>(aeMode, awbMode, afMode)</code>

6314

where aeMode has the lowest index position.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

6315

</td>

6316

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

</ul>

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

6329

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

6330

</tr>

6331

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

6332

Ruben Brunk

2014-01-14 19:31:21 -0800

[diff] [blame]

6333

When a scene mode is enabled, the camera device is expected

6334

to override <a href="#controls_android.control.aeMode">android.control.aeMode</a>, <a href="#controls_android.control.awbMode">android.control.awbMode</a>,

6335

and <a href="#controls_android.control.afMode">android.control.afMode</a> with its preferred settings for

6336

that scene mode.

6337

The order of this list matches that of availableSceneModes,

6338

with 3 entries for each mode. The overrides listed

Zhijun He

2015-06-16 19:44:18 -0700

[diff] [blame]

6339

for FACE_PRIORITY and FACE_PRIORITY_LOW_LIGHT (if supported) are ignored,

6340

since for that mode the application-set <a href="#controls_android.control.aeMode">android.control.aeMode</a>,

Ruben Brunk

2014-01-14 19:31:21 -0800

[diff] [blame]

6341

<a href="#controls_android.control.awbMode">android.control.awbMode</a>, and <a href="#controls_android.control.afMode">android.control.afMode</a> values are

Eino-Ville Talvala

2014-02-10 12:39:35 -0800

[diff] [blame]

6342

used instead, matching the behavior when <a href="#controls_android.control.mode">android.control.mode</a>

Zhijun He

2015-06-16 19:44:18 -0700

[diff] [blame]

6343

is set to AUTO. It is recommended that the FACE_PRIORITY and

6344

FACE_PRIORITY_LOW_LIGHT (if supported) overrides should be set to 0.

Ruben Brunk

2014-01-14 19:31:21 -0800

[diff] [blame]

6345

For example, if availableSceneModes contains

6346

<code>(FACE_PRIORITY, ACTION, NIGHT)</code>, then the camera framework

6347

expects sceneModeOverrides to have 9 entries formatted like:

6348

<code>(0, 0, 0, ON_AUTO_FLASH, AUTO, CONTINUOUS_PICTURE,

6349

ON_AUTO_FLASH, INCANDESCENT, AUTO)</code>.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

6350

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

6351

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

6352

Ruben Brunk

2014-01-14 19:31:21 -0800

[diff] [blame]

6353

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

6354

<th class="th_details" colspan="6">HAL Implementation Details</th>

Ruben Brunk

2014-01-14 19:31:21 -0800

[diff] [blame]

6355

</tr>

6356

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

6357

Ruben Brunk

2014-01-14 19:31:21 -0800

[diff] [blame]

6358

To maintain backward compatibility, this list will be made available

6359

in the static metadata of the camera service. The camera service will

6360

use these values to set <a href="#controls_android.control.aeMode">android.control.aeMode</a>,

6361

<a href="#controls_android.control.awbMode">android.control.awbMode</a>, and <a href="#controls_android.control.afMode">android.control.afMode</a> when using a scene

Zhijun He

2015-06-16 19:44:18 -0700

[diff] [blame]

6362

mode other than FACE_PRIORITY and FACE_PRIORITY_LOW_LIGHT (if supported).

Ruben Brunk

2014-01-14 19:31:21 -0800

[diff] [blame]

6363

</td>

6364

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

6365

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

6366

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

6367

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

6368

Zhijun He

2014-06-10 18:21:34 -0700

[diff] [blame]

6369

6370

6371

<td class="entry_name

6372

" rowspan="5">

6373

android.control.availableHighSpeedVideoConfigurations

</td>

int32

x

Zhijun He

2015-05-22 17:04:15 -0700

[diff] [blame]

6380

5 x n

Zhijun He

2014-06-10 18:21:34 -0700

[diff] [blame]

6381

Yin-Chia Yeh

35bdd4b

2014-07-15 10:42:05 -0700

[diff] [blame]

6382

[hidden as highSpeedVideoConfiguration]

Zhijun He

2014-06-10 18:21:34 -0700

[diff] [blame]

6383

6384

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

6385

[limited]

6386

Zhijun He

2014-06-10 18:21:34 -0700

[diff] [blame]

</td>

6391

6392

Zhijun He

2015-05-22 17:04:15 -0700

[diff] [blame]

6393

List of available high speed video size, fps range and max batch size configurations

6394

supported by the camera device, in the format of (width, height, fps_min, fps_max, batch_size_max).

Zhijun He

2014-06-10 18:21:34 -0700

[diff] [blame]

</td>

</td>

Zhijun He

2015-05-22 17:04:15 -0700

[diff] [blame]

6401

For each configuration, the fps_max >= 120fps.

Zhijun He

2014-06-10 18:21:34 -0700

[diff] [blame]

6402

</td>

6403

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Zhijun He

2014-06-10 18:21:34 -0700

[diff] [blame]

</ul>

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

6416

<th class="th_details" colspan="6">Details</th>

Zhijun He

2014-06-10 18:21:34 -0700

[diff] [blame]

6417

</tr>

6418

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

6419

Zhijun He

4b466e7

2015-06-23 07:59:24 -0700

[diff] [blame]

6420

When CONSTRAINED_HIGH_SPEED_VIDEO is supported in <a href="#static_android.request.availableCapabilities">android.request.availableCapabilities</a>,

Zhijun He

2015-05-22 17:04:15 -0700

[diff] [blame]

6421

this metadata will list the supported high speed video size, fps range and max batch size

6422

configurations. All the sizes listed in this configuration will be a subset of the sizes

6423

reported by <a href="https://developer.android.com/reference/android/hardware/camera2/params/StreamConfigurationMap.html#getOutputSizes">StreamConfigurationMap#getOutputSizes</a>

6424

for processed non-stalling formats.

6425

For the high speed video use case, the application must

Zhijun He

2014-06-10 18:21:34 -0700

[diff] [blame]

6426

select the video size and fps range from this metadata to configure the recording and

6427

preview streams and setup the recording requests. For example, if the application intends

6428

to do high speed recording, it can select the maximum size reported by this metadata to

6429

configure output streams. Once the size is selected, application can filter this metadata

6430

by selected size and get the supported fps ranges, and use these fps ranges to setup the

Yin-Chia Yeh

35bdd4b

2014-07-15 10:42:05 -0700

[diff] [blame]

6431

recording requests. Note that for the use case of multiple output streams, application

Zhijun He

2015-05-22 17:04:15 -0700

[diff] [blame]

6432

must select one unique size from this metadata to use (e.g., preview and recording streams

6433

must have the same size). Otherwise, the high speed capture session creation will fail.

6434

The min and max fps will be multiple times of 30fps.

Shuzhen Wang

2022-05-03 11:01:26 -0700

[diff] [blame]

6435

High speed video streaming extends significant performance pressure to camera hardware,

Zhijun He

2015-05-22 17:04:15 -0700

[diff] [blame]

6436

to achieve efficient high speed streaming, the camera device may have to aggregate

6437

multiple frames together and send to camera device for processing where the request

6438

controls are same for all the frames in this batch. Max batch size indicates

6439

the max possible number of frames the camera device will group together for this high

6440

speed stream configuration. This max batch size will be used to generate a high speed

6441

recording request list by

Eino-Ville Talvala

2015-06-30 13:32:09 -0700

[diff] [blame]

6442

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraConstrainedHighSpeedCaptureSession.html#createHighSpeedRequestList">CameraConstrainedHighSpeedCaptureSession#createHighSpeedRequestList</a>.

Zhijun He

2015-05-22 17:04:15 -0700

[diff] [blame]

6443

The max batch size for each configuration will satisfy below conditions:

6444

<ul>

6445

<li>Each max batch size will be a divisor of its corresponding fps_max / 30. For example,

6446

if max_fps is 300, max batch size will only be 1, 2, 5, or 10.</li>

6447

<li>The camera device may choose smaller internal batch size for each configuration, but

6448

the actual batch size will be a divisor of max batch size. For example, if the max batch

6449

size is 8, the actual batch size used by camera device will only be 1, 2, 4, or 8.</li>

6450

<li>The max batch size in each configuration entry must be no larger than 32.</li>

6451

</ul>

6452

The camera device doesn't have to support batch mode to achieve high speed video recording,

6453

in such case, batch_size_max will be reported as 1 in each configuration entry.

6454

This fps ranges in this configuration list can only be used to create requests

6455

that are submitted to a high speed camera capture session created by

6456

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraDevice.html#createConstrainedHighSpeedCaptureSession">CameraDevice#createConstrainedHighSpeedCaptureSession</a>.

6457

The fps ranges reported in this metadata must not be used to setup capture requests for

6458

normal capture session, or it will cause request error.

Zhijun He

2014-06-10 18:21:34 -0700

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

6463

<th class="th_details" colspan="6">HAL Implementation Details</th>

Zhijun He

2014-06-10 18:21:34 -0700

[diff] [blame]

6464

</tr>

6465

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

6466

Zhijun He

2014-06-10 18:21:34 -0700

[diff] [blame]

6467

All the sizes listed in this configuration will be a subset of the sizes reported by

Yin-Chia Yeh

35bdd4b

2014-07-15 10:42:05 -0700

[diff] [blame]

6468

<a href="#static_android.scaler.availableStreamConfigurations">android.scaler.availableStreamConfigurations</a> for processed non-stalling output formats.

6469

Note that for all high speed video configurations, HAL must be able to support a minimum

6470

of two streams, though the application might choose to configure just one stream.

Zhijun He

2015-05-22 17:04:15 -0700

[diff] [blame]

6471

The HAL may support multiple sensor modes for high speed outputs, for example, 120fps

6472

sensor mode and 120fps recording, 240fps sensor mode for 240fps recording. The application

6473

usually starts preview first, then starts recording. To avoid sensor mode switch caused

6474

stutter when starting recording as much as possible, the application may want to ensure

6475

the same sensor mode is used for preview and recording. Therefore, The HAL must advertise

6476

the variable fps range [30, fps_max] for each fixed fps range in this configuration list.

6477

For example, if the HAL advertises [120, 120] and [240, 240], the HAL must also advertise

6478

[30, 120] and [30, 240] for each configuration. In doing so, if the application intends to

6479

do 120fps recording, it can select [30, 120] to start preview, and [120, 120] to start

6480

recording. For these variable fps ranges, it's up to the HAL to decide the actual fps

Rucha Katakwar

fe95b88

2022-02-02 16:36:50 -0800

[diff] [blame]

6481

values that are suitable for smooth preview streaming.

6482

If the HAL sees different max_fps values that fall into different sensor modes in a

6483

sequence of requests, the HAL must switch the sensor mode as quick as possible to minimize

6484

the mode switch caused stutter.

6485

HAL can also support 60fps preview during high speed recording session by advertising

6486

[60, max_fps] for preview and [max_fps, max_fps] for recording. However, HAL must not

6487

advertise both 30fps preview and 60fps preview for the same recording frame rate.

Zhijun He

2014-06-10 18:21:34 -0700

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

6491

Zhijun He

2014-06-10 18:21:34 -0700

[diff] [blame]

6492

6493

Yin-Chia Yeh

2015-02-20 15:34:14 -0800

[diff] [blame]

6494

6495

6496

<td class="entry_name

6497

" rowspan="3">

6498

android.control.aeLockAvailable

</td>

byte

[public as boolean]

[legacy]

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

6512

FALSE (v3.2)

Yin-Chia Yeh

2015-02-20 15:34:14 -0800

[diff] [blame]

6513

</li>

6514

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

6515

TRUE (v3.2)

Yin-Chia Yeh

2015-02-20 15:34:14 -0800

[diff] [blame]

</li>

</ul>

</td>

6520

6521

6522

Whether the camera device supports <a href="#controls_android.control.aeLock">android.control.aeLock</a>

</td>

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Yin-Chia Yeh

2015-02-20 15:34:14 -0800

[diff] [blame]

</ul>

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

6543

<th class="th_details" colspan="6">Details</th>

Yin-Chia Yeh

2015-02-20 15:34:14 -0800

[diff] [blame]

6544

</tr>

6545

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

6546

Yin-Chia Yeh

2015-04-02 14:31:53 -0700

[diff] [blame]

6547

Devices with MANUAL_SENSOR capability or BURST_CAPTURE capability will always

6548

list <code>true</code>. This includes FULL devices.

Yin-Chia Yeh

2015-02-20 15:34:14 -0800

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

6553

Yin-Chia Yeh

2015-02-20 15:34:14 -0800

[diff] [blame]

6554

<td class="entry_name

6559

" rowspan="3">

6560

android.control.awbLockAvailable

</td>

byte

[public as boolean]

[legacy]

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

6574

FALSE (v3.2)

Yin-Chia Yeh

2015-02-20 15:34:14 -0800

[diff] [blame]

6575

</li>

6576

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

6577

TRUE (v3.2)

Yin-Chia Yeh

2015-02-20 15:34:14 -0800

[diff] [blame]

</li>

</ul>

</td>

6582

6583

6584

Whether the camera device supports <a href="#controls_android.control.awbLock">android.control.awbLock</a>

</td>

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Yin-Chia Yeh

2015-02-20 15:34:14 -0800

[diff] [blame]

</ul>

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

6605

<th class="th_details" colspan="6">Details</th>

Yin-Chia Yeh

2015-02-20 15:34:14 -0800

[diff] [blame]

6606

</tr>

6607

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

6608

Yin-Chia Yeh

2015-04-02 14:31:53 -0700

[diff] [blame]

6609

Devices with MANUAL_POST_PROCESSING capability or BURST_CAPTURE capability will

6610

always list <code>true</code>. This includes FULL devices.

Yin-Chia Yeh

2015-02-20 15:34:14 -0800

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

6615

Yin-Chia Yeh

2015-02-20 15:34:14 -0800

[diff] [blame]

6616

<td class="entry_name

6621

" rowspan="3">

6622

android.control.availableModes

</td>

byte

x

n

[public as enumList]

[legacy]

<div class="entry_type_notes">List of enums (android.control.mode).</div>

6638

6639

6640

</td>

6641

6642

6643

List of control modes for <a href="#controls_android.control.mode">android.control.mode</a> that are supported by this camera

device.

</td>

</td>

Any value listed in <a href="#controls_android.control.mode">android.control.mode</a>

6652

</td>

6653

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Yin-Chia Yeh

2015-02-20 15:34:14 -0800

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

6663

<th class="th_details" colspan="6">Details</th>

Yin-Chia Yeh

2015-02-20 15:34:14 -0800

[diff] [blame]

6664

</tr>

6665

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

6666

Yin-Chia Yeh

2015-02-20 15:34:14 -0800

[diff] [blame]

6667

This list contains control modes that can be set for the camera device.

6668

LEGACY mode devices will always support AUTO mode. LIMITED and FULL

6669

devices will always support OFF, AUTO modes.

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

6674

Yin-Chia Yeh

2015-02-20 15:34:14 -0800

[diff] [blame]

6675

6676

Yin-Chia Yeh

2016-01-18 19:14:55 -0800

[diff] [blame]

6677

6678

6679

<td class="entry_name

6680

" rowspan="5">

6681

android.control.postRawSensitivityBoostRange

</td>

int32

x

2

[public as rangeInt]

<div class="entry_type_notes">Range of supported post RAW sensitivitiy boosts</div>

6696

6697

6698

</td>

6699

6700

6701

Range of boosts for <a href="#controls_android.control.postRawSensitivityBoost">android.control.postRawSensitivityBoost</a> supported

6702

by this camera device.

</td>

ISO arithmetic units, the same as android.sensor.sensitivity

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Yin-Chia Yeh

2016-01-18 19:14:55 -0800

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

6721

<th class="th_details" colspan="6">Details</th>

Yin-Chia Yeh

2016-01-18 19:14:55 -0800

[diff] [blame]

6722

</tr>

6723

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

6724

Yin-Chia Yeh

2016-01-18 19:14:55 -0800

[diff] [blame]

6725

Devices support post RAW sensitivity boost will advertise

Shuzhen Wang

2022-05-03 11:01:26 -0700

[diff] [blame]

6726

<a href="#controls_android.control.postRawSensitivityBoost">android.control.postRawSensitivityBoost</a> key for controlling

Yin-Chia Yeh

2016-01-18 19:14:55 -0800

[diff] [blame]

6727

post RAW sensitivity boost.

6728

This key will be <code>null</code> for devices that do not support any RAW format

6729

outputs. For devices that do support RAW format outputs, this key will always

6730

present, and if a device does not support post RAW sensitivity boost, it will

6731

list <code>(100, 100)</code> in this key.

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

6736

<th class="th_details" colspan="6">HAL Implementation Details</th>

Yin-Chia Yeh

2016-01-18 19:14:55 -0800

[diff] [blame]

6737

</tr>

6738

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

6739

6740

This key is added in legacy HAL3.4. For legacy HAL3.3 or earlier devices, camera

6741

framework will generate this key as <code>(100, 100)</code> if device supports any of RAW output

6742

formats. All legacy HAL3.4 and above devices should list this key if device supports

6743

any of RAW output formats.

Yin-Chia Yeh

2016-01-18 19:14:55 -0800

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

6747

Yin-Chia Yeh

2016-01-18 19:14:55 -0800

[diff] [blame]

6748

6749

Shuzhen Wang

2019-07-08 15:03:24 -0700

[diff] [blame]

6750

Shuzhen Wang

2020-03-16 11:39:27 -0700

[diff] [blame]

6751

Shuzhen Wang

2019-07-08 15:03:24 -0700

[diff] [blame]

6752

<td class="entry_name

6753

" rowspan="5">

Shuzhen Wang

2020-03-16 11:39:27 -0700

[diff] [blame]

6754

android.control.availableExtendedSceneModeMaxSizes

Shuzhen Wang

2019-07-08 15:03:24 -0700

[diff] [blame]

</td>

int32

x

3 x n

Shuzhen Wang

2019-11-07 15:59:22 -0800

[diff] [blame]

6763

[ndk_public]

Shuzhen Wang

2019-07-08 15:03:24 -0700

[diff] [blame]

[limited]

Shuzhen Wang

2020-03-16 11:39:27 -0700

[diff] [blame]

6769

<div class="entry_type_notes">List of extended scene modes and the corresponding max streaming sizes.</div>

Shuzhen Wang

2019-07-08 15:03:24 -0700

[diff] [blame]

6770

6771

6772

</td>

6773

6774

Shuzhen Wang

2020-03-16 11:39:27 -0700

[diff] [blame]

6775

The list of extended scene modes for <a href="#controls_android.control.extendedSceneMode">android.control.extendedSceneMode</a> that are supported

6776

by this camera device, and each extended scene mode's maximum streaming (non-stall) size

6777

with effect.

Shuzhen Wang

2019-07-08 15:03:24 -0700

[diff] [blame]

</td>

(mode, width, height)

</td>

</td>

3.5

</td>

</td>

</tr>

<th class="th_details" colspan="6">Details</th>

</tr>

Shuzhen Wang

2020-03-16 11:39:27 -0700

[diff] [blame]

6800

For DISABLED mode, the camera behaves normally with no extended scene mode enabled.

6801

For BOKEH_STILL_CAPTURE mode, the maximum streaming dimension specifies the limit

6802

under which bokeh is effective when capture intent is PREVIEW. Note that when capture

6803

intent is PREVIEW, the bokeh effect may not be as high in quality compared to

6804

STILL_CAPTURE intent in order to maintain reasonable frame rate. The maximum streaming

6805

dimension must be one of the YUV_420_888 or PRIVATE resolutions in

6806

availableStreamConfigurations, or (0, 0) if preview bokeh is not supported. If the

6807

application configures a stream larger than the maximum streaming dimension, bokeh

6808

effect may not be applied for this stream for PREVIEW intent.

6809

For BOKEH_CONTINUOUS mode, the maximum streaming dimension specifies the limit under

6810

which bokeh is effective. This dimension must be one of the YUV_420_888 or PRIVATE

6811

resolutions in availableStreamConfigurations, and if the sensor maximum resolution is

6812

larger than or equal to 1080p, the maximum streaming dimension must be at least 1080p.

6813

If the application configures a stream with larger dimension, the stream may not have

6814

bokeh effect applied.

Shuzhen Wang

2019-07-08 15:03:24 -0700

[diff] [blame]

</td>

</tr>

<th class="th_details" colspan="6">HAL Implementation Details</th>

</tr>

Shuzhen Wang

2020-03-16 11:39:27 -0700

[diff] [blame]

6823

For available extended scene modes, DISABLED will always be listed.

6824

HAL must support at list one non-OFF extended scene mode if extendedSceneMode control is

6825

available on the camera device. For DISABLED mode, the maximum streaming resolution must

6826

be set to (0, 0).

Shuzhen Wang

2019-07-08 15:03:24 -0700

[diff] [blame]

</td>

</tr>

6832

Shuzhen Wang

2019-11-07 15:59:22 -0800

[diff] [blame]

6833

Shuzhen Wang

2020-03-16 11:39:27 -0700

[diff] [blame]

6834

Shuzhen Wang

2019-11-07 15:59:22 -0800

[diff] [blame]

6835

<td class="entry_name

6836

" rowspan="3">

Shuzhen Wang

2020-03-16 11:39:27 -0700

[diff] [blame]

6837

android.control.availableExtendedSceneModeZoomRatioRanges

Shuzhen Wang

2019-11-07 15:59:22 -0800

[diff] [blame]

</td>

float

x

2 x n

[ndk_public]

[limited]

Shuzhen Wang

2020-03-16 11:39:27 -0700

[diff] [blame]

6852

<div class="entry_type_notes">Zoom ranges for all supported non-OFF extended scene modes.</div>

Shuzhen Wang

2019-11-07 15:59:22 -0800

[diff] [blame]

6853

6854

6855

</td>

6856

6857

Shuzhen Wang

2020-03-16 11:39:27 -0700

[diff] [blame]

6858

The ranges of supported zoom ratio for non-DISABLED <a href="#controls_android.control.extendedSceneMode">android.control.extendedSceneMode</a>.

Shuzhen Wang

2019-11-07 15:59:22 -0800

[diff] [blame]

</td>

(minZoom, maxZoom)

</td>

</td>

3.5

</td>

</td>

</tr>

<th class="th_details" colspan="6">Details</th>

</tr>

Shuzhen Wang

2020-03-16 11:39:27 -0700

[diff] [blame]

6881

When extended scene mode is set, the camera device may have limited range of zoom ratios

6882

compared to when extended scene mode is DISABLED. This tag lists the zoom ratio ranges

6883

for all supported non-DISABLED extended scene modes, in the same order as in

6884

android.control.availableExtended.

Shuzhen Wang

2019-11-07 15:59:22 -0800

[diff] [blame]

6885

Range [1.0, 1.0] means that no zoom (optical or digital) is supported.

</td>

</tr>

6892

6893

Shuzhen Wang

2020-03-16 11:39:27 -0700

[diff] [blame]

6894

Shuzhen Wang

2019-11-07 15:59:22 -0800

[diff] [blame]

6895

<td class="entry_name

6896

" rowspan="3">

Shuzhen Wang

2020-03-16 11:39:27 -0700

[diff] [blame]

6897

android.control.availableExtendedSceneModeCapabilities

Shuzhen Wang

2019-11-07 15:59:22 -0800

[diff] [blame]

</td>

int32

x

n

[public as capability]

[synthetic]

</td>

6915

6916

Shuzhen Wang

2020-03-16 11:39:27 -0700

[diff] [blame]

6917

The list of extended scene modes for <a href="#controls_android.control.extendedSceneMode">android.control.extendedSceneMode</a> that

6918

are supported by this camera device, and each extended scene mode's capabilities such

6919

as maximum streaming size, and supported zoom ratio ranges.

Shuzhen Wang

2019-11-07 15:59:22 -0800

[diff] [blame]

</td>

</td>

</td>

3.5

</td>

</td>

</tr>

<th class="th_details" colspan="6">Details</th>

</tr>

Jayant Chowdhary

2020-10-26 16:45:45 -0700

[diff] [blame]

6941

For DISABLED mode, the camera behaves normally with no extended scene mode enabled.

Shuzhen Wang

2020-03-16 11:39:27 -0700

[diff] [blame]

6942

For BOKEH_STILL_CAPTURE mode, the maximum streaming dimension specifies the limit

6943

under which bokeh is effective when capture intent is PREVIEW. Note that when capture

6944

intent is PREVIEW, the bokeh effect may not be as high quality compared to STILL_CAPTURE

6945

intent in order to maintain reasonable frame rate. The maximum streaming dimension must

6946

be one of the YUV_420_888 or PRIVATE resolutions in availableStreamConfigurations, or

6947

(0, 0) if preview bokeh is not supported. If the application configures a stream

6948

larger than the maximum streaming dimension, bokeh effect may not be applied for this

6949

stream for PREVIEW intent.

6950

For BOKEH_CONTINUOUS mode, the maximum streaming dimension specifies the limit under

6951

which bokeh is effective. This dimension must be one of the YUV_420_888 or PRIVATE

6952

resolutions in availableStreamConfigurations, and if the sensor maximum resolution is

6953

larger than or equal to 1080p, the maximum streaming dimension must be at least 1080p.

6954

If the application configures a stream with larger dimension, the stream may not have

6955

bokeh effect applied.

6956

When extended scene mode is set, the camera device may have limited range of zoom ratios

6957

compared to when the mode is DISABLED. availableExtendedSceneModeCapabilities lists the

6958

zoom ranges for all supported extended modes. A range of (1.0, 1.0) means that no zoom

Shuzhen Wang

2019-11-07 15:59:22 -0800

[diff] [blame]

6959

(optical or digital) is supported.

</td>

</tr>

<td class="entry_name

6970

" rowspan="5">

6971

android.control.zoomRatioRange

</td>

float

x

2

[public as rangeFloat]

[limited]

<div class="entry_type_notes">The range of zoom ratios that this camera device supports.</div>

6987

6988

6989

</td>

6990

6991

6992

Minimum and maximum zoom ratios supported by this camera device.

</td>

Shuzhen Wang

2020-03-12 21:36:18 -0700

[diff] [blame]

6996

A pair of zoom ratio in floating-points: (minZoom, maxZoom)

Shuzhen Wang

2019-11-07 15:59:22 -0800

[diff] [blame]

</td>

maxZoom >= 1.0 >= minZoom

</td>

3.5

</td>

</td>

</tr>

<th class="th_details" colspan="6">Details</th>

</tr>

If the camera device supports zoom-out from 1x zoom, minZoom will be less than 1.0, and

Eino-Ville Talvala

2020-01-06 16:08:56 -0800

[diff] [blame]

7017

setting <a href="#controls_android.control.zoomRatio">android.control.zoomRatio</a> to values less than 1.0 increases the camera's field

Shuzhen Wang

2019-11-07 15:59:22 -0800

[diff] [blame]

of view.

</td>

</tr>

<th class="th_details" colspan="6">HAL Implementation Details</th>

</tr>

Shuzhen Wang

2020-08-11 16:46:36 -0700

[diff] [blame]

7027

When the key is reported, the camera device's <a href="#static_android.scaler.availableMaxDigitalZoom">android.scaler.availableMaxDigitalZoom</a>

7028

must be less than or equal to maxZoom. The camera framework makes sure to always

7029

control zoom via <a href="#controls_android.control.zoomRatio">android.control.zoomRatio</a>. The <a href="#controls_android.scaler.cropRegion">android.scaler.cropRegion</a> tag is only

7030

used to do horizontal or vertical cropping (but not both) to achieve aspect ratio

7031

different than the camera sensor's native aspect ratio.

Shuzhen Wang

2019-11-07 15:59:22 -0800

[diff] [blame]

7032

For a logical multi-camera device, this key must either be reported for both the logical

7033

camera device and all its physical sub-cameras, or none of them.

7034

When the key is not reported, camera framework derives the application-facing

7035

zoomRatioRange to be (1, <a href="#static_android.scaler.availableMaxDigitalZoom">android.scaler.availableMaxDigitalZoom</a>).

</td>

</tr>

7041

Jayant Chowdhary

2020-11-09 09:08:31 -0800

[diff] [blame]

7042

7043

7044

<td class="entry_name

7045

" rowspan="5">

7046

android.control.availableHighSpeedVideoConfigurationsMaximumResolution

</td>

int32

x

5 x n

[hidden as highSpeedVideoConfiguration]

</td>

7063

7064

7065

List of available high speed video size, fps range and max batch size configurations

7066

supported by the camera device, in the format of

7067

(width, height, fps_min, fps_max, batch_size_max),

7068

when <a href="#controls_android.sensor.pixelMode">android.sensor.pixelMode</a> is set to

7069

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraMetadata.html#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION">CameraMetadata#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION</a>.

</td>

</td>

For each configuration, the fps_max >= 120fps.

</td>

3.6

</td>

</ul>

</td>

</tr>

<th class="th_details" colspan="6">Details</th>

</tr>

Analogous to <a href="#static_android.control.availableHighSpeedVideoConfigurations">android.control.availableHighSpeedVideoConfigurations</a>, for configurations

7096

which are applicable when <a href="#controls_android.sensor.pixelMode">android.sensor.pixelMode</a> is set to

7097

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraMetadata.html#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION">CameraMetadata#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION</a>.

</td>

</tr>

<th class="th_details" colspan="6">HAL Implementation Details</th>

</tr>

Refer to hal details for <a href="#static_android.control.availableHighSpeedVideoConfigurations">android.control.availableHighSpeedVideoConfigurations</a>.

</td>

</tr>

7112

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</tbody>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

7117

<tr><td colspan="7" class="kind">dynamic</td></tr>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

7118

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

7119

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

7120

<tr>

7121

<th class="th_name">Property Name</th>

7122

7123

<th class="th_description">Description</th>

7124

<th class="th_units">Units</th>

7125

<th class="th_range">Range</th>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

7126

<th class="th_hal_version">Initial HIDL HAL version</th>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</tr>

</thead>

<tbody>

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

7143

<td class="entry_name

7144

entry_name_deprecated

7145

" rowspan="3">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

7146

android.control.aePrecaptureId

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

7147

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

7148

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

7149

int32

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

7150

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

[system]

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

7154

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

7155

[deprecated]

7156

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

7157

7158

7159

</td>

7160

7161

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

7162

The ID sent with the latest

7163

CAMERA2_TRIGGER_PRECAPTURE_METERING call

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

7170

Deprecated. Do not use.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

7171

</td>

7172

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

7182

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

7183

</tr>

7184

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

7185

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

7186

Must be 0 if no

7187

CAMERA2_TRIGGER_PRECAPTURE_METERING trigger received yet

7188

by HAL. Always updated even if AE algorithm ignores the

7189

trigger

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

7190

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

7191

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

7192

7193

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

7194

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

7195

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

7196

7197

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

7198

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

7199

<td class="entry_name

7200

" rowspan="5">

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

7201

android.control.aeAntibandingMode

</td>

byte

[public]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

7208

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

7209

[legacy]

7210

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

7211

7212

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

7213

7214

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

7215

OFF (v3.2)

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

7216

The camera device will not adjust exposure duration to

7217

avoid banding problems.

7218

</li>

7219

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

7220

50HZ (v3.2)

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

7221

The camera device will adjust exposure duration to

7222

avoid banding problems with 50Hz illumination sources.

7223

</li>

7224

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

7225

60HZ (v3.2)

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

7226

The camera device will adjust exposure duration to

7227

avoid banding problems with 60Hz illumination

7228

sources.

7229

</li>

7230

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

7231

AUTO (v3.2)

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

7232

The camera device will automatically adapt its

7233

antibanding routine to the current illumination

Yin-Chia Yeh

2014-11-25 11:51:48 -0800

[diff] [blame]

7234

condition. This is the default mode if AUTO is

7235

available on given camera device.

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

</li>

</ul>

</td>

7240

7241

7242

The desired setting for the camera device's auto-exposure

7243

algorithm's antibanding compensation.

</td>

</td>

<a href="#static_android.control.aeAvailableAntibandingModes">android.control.aeAvailableAntibandingModes</a>

7251

</td>

7252

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

</ul>

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

7265

<th class="th_details" colspan="6">Details</th>

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

7266

</tr>

7267

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

7268

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

7269

Some kinds of lighting fixtures, such as some fluorescent

7270

lights, flicker at the rate of the power supply frequency

7271

(60Hz or 50Hz, depending on country). While this is

7272

typically not noticeable to a person, it can be visible to

7273

a camera device. If a camera sets its exposure time to the

7274

wrong value, the flicker may become visible in the

7275

viewfinder as flicker or in a final captured image, as a

7276

set of variable-brightness bands across the image.

7277

Therefore, the auto-exposure routines of camera devices

7278

include antibanding routines that ensure that the chosen

7279

exposure value will not cause such banding. The choice of

7280

exposure time depends on the rate of flicker, which the

7281

camera device can detect automatically, or the expected

7282

rate can be selected by the application using this

7283

control.

7284

A given camera device may not support all of the possible

7285

options for the antibanding mode. The

7286

<a href="#static_android.control.aeAvailableAntibandingModes">android.control.aeAvailableAntibandingModes</a> key contains

7287

the available modes for a given camera device.

Yin-Chia Yeh

2014-11-25 11:51:48 -0800

[diff] [blame]

7288

AUTO mode is the default if it is available on given

7289

camera device. When AUTO mode is not available, the

7290

default will be either 50HZ or 60HZ, and both 50HZ

7291

and 60HZ will be available.

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

7292

If manual exposure control is enabled (by setting

7293

<a href="#controls_android.control.aeMode">android.control.aeMode</a> or <a href="#controls_android.control.mode">android.control.mode</a> to OFF),

7294

then this setting has no effect, and the application must

7295

ensure it selects exposure times that do not cause banding

7296

issues. The <a href="#dynamic_android.statistics.sceneFlicker">android.statistics.sceneFlicker</a> key can assist

7297

the application in this.

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

7302

<th class="th_details" colspan="6">HAL Implementation Details</th>

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

7303

</tr>

7304

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

7305

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

7306

For all capture request templates, this field must be set

Yin-Chia Yeh

2014-11-25 11:51:48 -0800

[diff] [blame]

7307

to AUTO if AUTO mode is available. If AUTO is not available,

7308

the default must be either 50HZ or 60HZ, and both 50HZ and

7309

60HZ must be available.

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

7310

If manual exposure control is enabled (by setting

7311

<a href="#controls_android.control.aeMode">android.control.aeMode</a> or <a href="#controls_android.control.mode">android.control.mode</a> to OFF),

7312

then the exposure values provided by the application must not be

7313

adjusted for antibanding.

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

7317

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

7318

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

7322

<td class="entry_name

7323

" rowspan="3">

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

7324

android.control.aeExposureCompensation

</td>

int32

[public]

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

7332

[legacy]

7333

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

7337

</td>

7338

7339

Eino-Ville Talvala

2014-06-06 14:35:41 -0700

[diff] [blame]

7340

Adjustment to auto-exposure (AE) target image

7341

brightness.

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

</td>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

7345

Compensation steps

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

</td>

Eino-Ville Talvala

2014-06-06 14:35:41 -0700

[diff] [blame]

7349

<a href="#static_android.control.aeCompensationRange">android.control.aeCompensationRange</a>

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

7350

</td>

7351

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

</ul>

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

7364

<th class="th_details" colspan="6">Details</th>

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

7365

</tr>

7366

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

7367

Eino-Ville Talvala

2014-06-06 14:35:41 -0700

[diff] [blame]

7368

The adjustment is measured as a count of steps, with the

7369

step size defined by <a href="#static_android.control.aeCompensationStep">android.control.aeCompensationStep</a> and the

7370

allowed range by <a href="#static_android.control.aeCompensationRange">android.control.aeCompensationRange</a>.

7371

For example, if the exposure value (EV) step is 0.333, '6'

7372

will mean an exposure compensation of +2 EV; -3 will mean an

7373

exposure compensation of -1 EV. One EV represents a doubling

7374

of image brightness. Note that this control will only be

7375

effective if <a href="#controls_android.control.aeMode">android.control.aeMode</a> <code>!=</code> OFF. This control

7376

will take effect even when <a href="#controls_android.control.aeLock">android.control.aeLock</a> <code>== true</code>.

Yin-Chia Yeh

2014-05-05 14:26:03 -0700

[diff] [blame]

7377

In the event of exposure compensation value being changed, camera device

7378

may take several frames to reach the newly requested exposure target.

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

7379

During that time, <a href="#dynamic_android.control.aeState">android.control.aeState</a> field will be in the SEARCHING

Yin-Chia Yeh

2014-05-05 14:26:03 -0700

[diff] [blame]

7380

state. Once the new exposure target is reached, <a href="#dynamic_android.control.aeState">android.control.aeState</a> will

7381

change from SEARCHING to either CONVERGED, LOCKED (if AE lock is enabled), or

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

7382

FLASH_REQUIRED (if the scene is too dark for still capture).

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

7387

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

7388

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

7392

<td class="entry_name

7393

" rowspan="3">

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

7394

android.control.aeLock

</td>

byte

[public as boolean]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

7401

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

7402

[legacy]

7403

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

7404

7405

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

7406

7407

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

7408

OFF (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

7409

Auto-exposure lock is disabled; the AE algorithm

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

7410

is free to update its parameters.

7411

</li>

7412

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

7413

ON (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

7414

Auto-exposure lock is enabled; the AE algorithm

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

7415

must not update the exposure and sensitivity parameters

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

7416

while the lock is active.

7417

<a href="#controls_android.control.aeExposureCompensation">android.control.aeExposureCompensation</a> setting changes

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

7418

will still take effect while auto-exposure is locked.

7419

Some rare LEGACY devices may not support

7420

this, in which case the value will always be overridden to OFF.

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

</li>

</ul>

</td>

7425

7426

Eino-Ville Talvala

2014-06-06 14:35:41 -0700

[diff] [blame]

7427

Whether auto-exposure (AE) is currently locked to its latest

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

calculated values.

</td>

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

</ul>

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

7449

<th class="th_details" colspan="6">Details</th>

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

7450

</tr>

7451

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

7452

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

7453

When set to <code>true</code> (ON), the AE algorithm is locked to its latest parameters,

7454

and will not change exposure settings until the lock is set to <code>false</code> (OFF).

7455

Note that even when AE is locked, the flash may be fired if

7456

the <a href="#controls_android.control.aeMode">android.control.aeMode</a> is ON_AUTO_FLASH /

7457

ON_ALWAYS_FLASH / ON_AUTO_FLASH_REDEYE.

Yin-Chia Yeh

2014-05-05 14:26:03 -0700

[diff] [blame]

7458

When <a href="#controls_android.control.aeExposureCompensation">android.control.aeExposureCompensation</a> is changed, even if the AE lock

7459

is ON, the camera device will still adjust its exposure value.

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

7460

If AE precapture is triggered (see <a href="#controls_android.control.aePrecaptureTrigger">android.control.aePrecaptureTrigger</a>)

7461

when AE is already locked, the camera device will not change the exposure time

7462

(<a href="#controls_android.sensor.exposureTime">android.sensor.exposureTime</a>) and sensitivity (<a href="#controls_android.sensor.sensitivity">android.sensor.sensitivity</a>)

7463

parameters. The flash may be fired if the <a href="#controls_android.control.aeMode">android.control.aeMode</a>

7464

is ON_AUTO_FLASH/ON_AUTO_FLASH_REDEYE and the scene is too dark. If the

Zhijun He

2015-02-05 14:32:57 -0800

[diff] [blame]

7465

<a href="#controls_android.control.aeMode">android.control.aeMode</a> is ON_ALWAYS_FLASH, the scene may become overexposed.

7466

Similarly, AE precapture trigger CANCEL has no effect when AE is already locked.

7467

When an AE precapture sequence is triggered, AE unlock will not be able to unlock

7468

the AE if AE is locked by the camera device internally during precapture metering

7469

sequence In other words, submitting requests with AE unlock has no effect for an

7470

ongoing precapture metering sequence. Otherwise, the precapture metering sequence

7471

will never succeed in a sequence of preview requests where AE lock is always set

7472

to <code>false</code>.

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

7473

Since the camera device has a pipeline of in-flight requests, the settings that

7474

get locked do not necessarily correspond to the settings that were present in the

7475

latest capture result received from the camera device, since additional captures

7476

and AE updates may have occurred even before the result was sent out. If an

7477

application is switching between automatic and manual control and wishes to eliminate

7478

any flicker during the switch, the following procedure is recommended:

7479

<ol>

7480

<li>Starting in auto-AE mode:</li>

7481

7482

<li>Wait for the first result to be output that has the AE locked</li>

7483

<li>Copy exposure settings from that result into a request, set the request to manual AE</li>

7484

<li>Submit the capture request, proceed to run manual AE as desired.</li>

7485

</ol>

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

7486

See <a href="#dynamic_android.control.aeState">android.control.aeState</a> for AE lock related state transition details.

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

7491

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

7492

7493

7494

Eino-Ville Talvala

2014-01-08 16:16:53 -0800

[diff] [blame]

7495

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

7496

<td class="entry_name

7497

" rowspan="3">

Eino-Ville Talvala

2014-01-08 16:16:53 -0800

[diff] [blame]

7498

android.control.aeMode

</td>

byte

[public]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

7505

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

7506

[legacy]

7507

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

7508

7509

Eino-Ville Talvala

2014-01-08 16:16:53 -0800

[diff] [blame]

7510

7511

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

7512

OFF (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

7513

The camera device's autoexposure routine is disabled.

7514

The application-selected <a href="#controls_android.sensor.exposureTime">android.sensor.exposureTime</a>,

Igor Murashkin

2014-01-15 17:05:22 -0800

[diff] [blame]

7515

<a href="#controls_android.sensor.sensitivity">android.sensor.sensitivity</a> and

7516

<a href="#controls_android.sensor.frameDuration">android.sensor.frameDuration</a> are used by the camera

7517

device, along with android.flash.* fields, if there's

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

7518

a flash unit for this camera device.

Yin-Chia Yeh

2014-11-12 11:38:10 -0800

[diff] [blame]

7519

Note that auto-white balance (AWB) and auto-focus (AF)

7520

behavior is device dependent when AE is in OFF mode.

7521

To have consistent behavior across different devices,

7522

it is recommended to either set AWB and AF to OFF mode

7523

or lock AWB and AF before setting AE to OFF.

7524

See <a href="#controls_android.control.awbMode">android.control.awbMode</a>, <a href="#controls_android.control.afMode">android.control.afMode</a>,

7525

<a href="#controls_android.control.awbLock">android.control.awbLock</a>, and <a href="#controls_android.control.afTrigger">android.control.afTrigger</a>

7526

for more details.

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

7527

LEGACY devices do not support the OFF mode and will

7528

override attempts to use this value to ON.

Eino-Ville Talvala

2014-01-08 16:16:53 -0800

[diff] [blame]

7529

</li>

7530

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

7531

ON (v3.2)

Igor Murashkin

2014-01-15 17:05:22 -0800

[diff] [blame]

7532

The camera device's autoexposure routine is active,

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

7533

with no flash control.

7534

The application's values for

Igor Murashkin

2014-01-15 17:05:22 -0800

[diff] [blame]

7535

<a href="#controls_android.sensor.exposureTime">android.sensor.exposureTime</a>,

7536

<a href="#controls_android.sensor.sensitivity">android.sensor.sensitivity</a>, and

7537

<a href="#controls_android.sensor.frameDuration">android.sensor.frameDuration</a> are ignored. The

7538

application has control over the various

7539

android.flash.* fields.

Eino-Ville Talvala

2014-01-08 16:16:53 -0800

[diff] [blame]

7540

</li>

7541

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

7542

ON_AUTO_FLASH (v3.2)

Igor Murashkin

2014-01-15 17:05:22 -0800

[diff] [blame]

7543

Like ON, except that the camera device also controls

7544

the camera's flash unit, firing it in low-light

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

7545

conditions.

7546

The flash may be fired during a precapture sequence

7547

(triggered by <a href="#controls_android.control.aePrecaptureTrigger">android.control.aePrecaptureTrigger</a>) and

7548

may be fired for captures for which the

Igor Murashkin

2014-01-15 17:05:22 -0800

[diff] [blame]

7549

<a href="#controls_android.control.captureIntent">android.control.captureIntent</a> field is set to

7550

STILL_CAPTURE

Eino-Ville Talvala

2014-01-08 16:16:53 -0800

[diff] [blame]

7551

</li>

7552

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

7553

ON_ALWAYS_FLASH (v3.2)

Igor Murashkin

2014-01-15 17:05:22 -0800

[diff] [blame]

7554

Like ON, except that the camera device also controls

7555

the camera's flash unit, always firing it for still

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

7556

captures.

7557

The flash may be fired during a precapture sequence

7558

(triggered by <a href="#controls_android.control.aePrecaptureTrigger">android.control.aePrecaptureTrigger</a>) and

7559

will always be fired for captures for which the

Igor Murashkin

2014-01-15 17:05:22 -0800

[diff] [blame]

7560

<a href="#controls_android.control.captureIntent">android.control.captureIntent</a> field is set to

7561

STILL_CAPTURE

Eino-Ville Talvala

2014-01-08 16:16:53 -0800

[diff] [blame]

7562

</li>

7563

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

7564

ON_AUTO_FLASH_REDEYE (v3.2)

Igor Murashkin

2014-01-15 17:05:22 -0800

[diff] [blame]

7565

Like ON_AUTO_FLASH, but with automatic red eye

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

7566

reduction.

7567

If deemed necessary by the camera device, a red eye

7568

reduction flash will fire during the precapture

7569

sequence.

Eino-Ville Talvala

2014-01-08 16:16:53 -0800

[diff] [blame]

7570

</li>

Chien-Yu Chen

2018-01-11 11:32:52 -0800

[diff] [blame]

7571

<li>

7572

ON_EXTERNAL_FLASH (v3.3)

7573

An external flash has been turned on.

7574

It informs the camera device that an external flash has been turned on, and that

7575

metering (and continuous focus if active) should be quickly recaculated to account

7576

for the external flash. Otherwise, this mode acts like ON.

7577

When the external flash is turned off, AE mode should be changed to one of the

7578

other available AE modes.

Chien-Yu Chen

06513f1

2018-03-15 11:17:20 -0700

[diff] [blame]

7579

If the camera device supports AE external flash mode, <a href="#dynamic_android.control.aeState">android.control.aeState</a> must

7580

be FLASH_REQUIRED after the camera device finishes AE scan and it's too dark without

Chien-Yu Chen

2018-01-11 11:32:52 -0800

[diff] [blame]

7581

flash.

7582

</li>

Eino-Ville Talvala

2014-01-08 16:16:53 -0800

[diff] [blame]

7583

</ul>

7584

7585

</td>

7586

7587

7588

The desired mode for the camera device's

7589

auto-exposure routine.

</td>

</td>

<a href="#static_android.control.aeAvailableModes">android.control.aeAvailableModes</a>

7597

</td>

7598

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Eino-Ville Talvala

2014-01-08 16:16:53 -0800

[diff] [blame]

</ul>

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

7611

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2014-01-08 16:16:53 -0800

[diff] [blame]

7612

</tr>

7613

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

7614

Eino-Ville Talvala

2014-01-08 16:16:53 -0800

[diff] [blame]

7615

This control is only effective if <a href="#controls_android.control.mode">android.control.mode</a> is

7616

AUTO.

7617

When set to any of the ON modes, the camera device's

7618

auto-exposure routine is enabled, overriding the

7619

application's selected exposure time, sensor sensitivity,

7620

and frame duration (<a href="#controls_android.sensor.exposureTime">android.sensor.exposureTime</a>,

7621

<a href="#controls_android.sensor.sensitivity">android.sensor.sensitivity</a>, and

7622

<a href="#controls_android.sensor.frameDuration">android.sensor.frameDuration</a>). If one of the FLASH modes

7623

is selected, the camera device's flash unit controls are

7624

also overridden.

7625

The FLASH modes are only available if the camera device

7626

has a flash unit (<a href="#static_android.flash.info.available">android.flash.info.available</a> is <code>true</code>).

7627

If flash TORCH mode is desired, this field must be set to

7628

ON or OFF, and <a href="#controls_android.flash.mode">android.flash.mode</a> set to TORCH.

7629

When set to any of the ON modes, the values chosen by the

7630

camera device auto-exposure routine for the overridden

7631

fields for a given capture will be available in its

CaptureResult.

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

7637

Eino-Ville Talvala

2014-01-08 16:16:53 -0800

[diff] [blame]

7638

7639

7640

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

7641

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

7642

<td class="entry_name

Yin-Chia Yeh

2014-05-16 15:13:13 -0700

[diff] [blame]

7643

" rowspan="5">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

7644

android.control.aeRegions

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

7645

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

7646

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

7647

int32

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

x

5 x area_count

Yin-Chia Yeh

2014-05-16 15:13:13 -0700

[diff] [blame]

7653

[public as meteringRectangle]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

7654

7655

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

7659

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

7660

</td>

7661

7662

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

7663

List of metering areas to use for auto-exposure adjustment.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Yin-Chia Yeh

2018-06-15 15:35:05 -0700

[diff] [blame]

7667

Pixel coordinates within android.sensor.info.activeArraySize or

7668

android.sensor.info.preCorrectionActiveArraySize depending on

7669

distortion correction capability and mode

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

7673

Coordinates must be between <code>[(0,0), (width, height))</code> of

Yin-Chia Yeh

2018-06-15 15:35:05 -0700

[diff] [blame]

7674

<a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a> or <a href="#static_android.sensor.info.preCorrectionActiveArraySize">android.sensor.info.preCorrectionActiveArraySize</a>

7675

depending on distortion correction capability and mode

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

7676

</td>

7677

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

</ul>

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

7690

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

7691

</tr>

7692

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

7693

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

7694

Not available if <a href="#static_android.control.maxRegionsAe">android.control.maxRegionsAe</a> is 0.

Yin-Chia Yeh

2014-09-04 09:33:34 -0700

[diff] [blame]

7695

Otherwise will always be present.

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

7696

The maximum number of regions supported by the device is determined by the value

7697

of <a href="#static_android.control.maxRegionsAe">android.control.maxRegionsAe</a>.

Yin-Chia Yeh

2018-06-15 15:35:05 -0700

[diff] [blame]

7698

For devices not supporting <a href="#controls_android.distortionCorrection.mode">android.distortionCorrection.mode</a> control, the coordinate

7699

system always follows that of <a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a>, with (0,0) being

7700

the top-left pixel in the active pixel array, and

Eino-Ville Talvala

2014-01-02 16:11:44 -0800

[diff] [blame]

7701

(<a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a>.width - 1,

Yin-Chia Yeh

2018-06-15 15:35:05 -0700

[diff] [blame]

7702

<a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a>.height - 1) being the bottom-right pixel in the

7703

active pixel array.

7704

For devices supporting <a href="#controls_android.distortionCorrection.mode">android.distortionCorrection.mode</a> control, the coordinate

7705

system depends on the mode being set.

7706

When the distortion correction mode is OFF, the coordinate system follows

7707

<a href="#static_android.sensor.info.preCorrectionActiveArraySize">android.sensor.info.preCorrectionActiveArraySize</a>, with

7708

<code>(0, 0)</code> being the top-left pixel of the pre-correction active array, and

7709

(<a href="#static_android.sensor.info.preCorrectionActiveArraySize">android.sensor.info.preCorrectionActiveArraySize</a>.width - 1,

7710

<a href="#static_android.sensor.info.preCorrectionActiveArraySize">android.sensor.info.preCorrectionActiveArraySize</a>.height - 1) being the bottom-right

7711

pixel in the pre-correction active pixel array.

7712

When the distortion correction mode is not OFF, the coordinate system follows

7713

<a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a>, with

7714

<code>(0, 0)</code> being the top-left pixel of the active array, and

7715

(<a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a>.width - 1,

7716

<a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a>.height - 1) being the bottom-right pixel in the

7717

active pixel array.

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

7718

The weight must be within <code>[0, 1000]</code>, and represents a weight

Yin-Chia Yeh

2014-05-14 14:05:20 -0700

[diff] [blame]

7719

for every pixel in the area. This means that a large metering area

7720

with the same weight as a smaller area will have more effect in

7721

the metering result. Metering areas can partially overlap and the

7722

camera device will add the weights in the overlap region.

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

7723

The weights are relative to weights of other exposure metering regions, so if only one

7724

region is used, all non-zero weights will have the same effect. A region with 0

7725

weight is ignored.

7726

If all regions have 0 weight, then no specific metering area needs to be used by the

7727

camera device.

7728

If the metering region is outside the used <a href="#controls_android.scaler.cropRegion">android.scaler.cropRegion</a> returned in

7729

capture result metadata, the camera device will ignore the sections outside the crop

7730

region and output only the intersection rectangle as the metering region in the result

7731

metadata. If the region is entirely outside the crop region, it will be ignored and

7732

not reported in the result metadata.

Shuzhen Wang

2022-03-28 12:41:41 -0700

[diff] [blame]

7733

When setting the AE metering regions, the application must consider the additional

7734

crop resulted from the aspect ratio differences between the preview stream and

7735

<a href="#controls_android.scaler.cropRegion">android.scaler.cropRegion</a>. For example, if the <a href="#controls_android.scaler.cropRegion">android.scaler.cropRegion</a> is the full

7736

active array size with 4:3 aspect ratio, and the preview stream is 16:9,

7737

the boundary of AE regions will be [0, y_crop] and

7738

[active_width, active_height - 2 * y_crop] rather than [0, 0] and

7739

[active_width, active_height], where y_crop is the additional crop due to aspect ratio

7740

mismatch.

Shuzhen Wang

2019-11-07 15:59:22 -0800

[diff] [blame]

7741

Starting from API level 30, the coordinate system of activeArraySize or

7742

preCorrectionActiveArraySize is used to represent post-zoomRatio field of view, not

7743

pre-zoom field of view. This means that the same aeRegions values at different

7744

<a href="#controls_android.control.zoomRatio">android.control.zoomRatio</a> represent different parts of the scene. The aeRegions

7745

coordinates are relative to the activeArray/preCorrectionActiveArray representing the

7746

zoomed field of view. If <a href="#controls_android.control.zoomRatio">android.control.zoomRatio</a> is set to 1.0 (default), the same

7747

aeRegions at different <a href="#controls_android.scaler.cropRegion">android.scaler.cropRegion</a> still represent the same parts of the

7748

scene as they do before. See <a href="#controls_android.control.zoomRatio">android.control.zoomRatio</a> for details. Whether to use

7749

activeArraySize or preCorrectionActiveArraySize still depends on distortion correction

7750

mode.

Jayant Chowdhary

2020-11-09 09:08:31 -0800

[diff] [blame]

7751

For camera devices with the

7752

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraMetadata.html#REQUEST_AVAILABLE_CAPABILITIES_ULTRA_HIGH_RESOLUTION_SENSOR">CameraMetadata#REQUEST_AVAILABLE_CAPABILITIES_ULTRA_HIGH_RESOLUTION_SENSOR</a>

7753

capability,

7754

<a href="#static_android.sensor.info.activeArraySizeMaximumResolution">android.sensor.info.activeArraySizeMaximumResolution</a> /

7755

<a href="#static_android.sensor.info.preCorrectionActiveArraySizeMaximumResolution">android.sensor.info.preCorrectionActiveArraySizeMaximumResolution</a> must be used as the

7756

coordinate system for requests where <a href="#controls_android.sensor.pixelMode">android.sensor.pixelMode</a> is set to

7757

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraMetadata.html#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION">CameraMetadata#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION</a>.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

7758

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

7759

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

7760

Yin-Chia Yeh

2014-05-16 15:13:13 -0700

[diff] [blame]

7761

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

7762

<th class="th_details" colspan="6">HAL Implementation Details</th>

Yin-Chia Yeh

2014-05-16 15:13:13 -0700

[diff] [blame]

7763

</tr>

7764

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

7765

Yin-Chia Yeh

2014-05-16 15:13:13 -0700

[diff] [blame]

7766

The HAL level representation of MeteringRectangle[] is a

7767

int[5 * area_count].

7768

Every five elements represent a metering region of

7769

(xmin, ymin, xmax, ymax, weight).

7770

The rectangle is defined to be inclusive on xmin and ymin, but

Yin-Chia Yeh

2018-06-15 15:35:05 -0700

[diff] [blame]

7771

exclusive on xmax and ymax.

7772

HAL must always report metering regions in the coordinate system of pre-correction

7773

active array.

Yin-Chia Yeh

2014-05-16 15:13:13 -0700

[diff] [blame]

7774

</td>

7775

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

7776

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

7777

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

7778

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

7779

7780

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

7781

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

7782

<td class="entry_name

7783

" rowspan="3">

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

7784

android.control.aeTargetFpsRange

</td>

int32

x

2

Igor Murashkin

2014-05-27 10:51:25 -0700

[diff] [blame]

7793

[public as rangeInt]

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

7794

7795

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

7796

[legacy]

7797

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

7801

</td>

7802

7803

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

7804

Range over which the auto-exposure routine can

7805

adjust the capture frame rate to maintain good

7806

exposure.

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

</td>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

7810

Frames per second (FPS)

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

</td>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

7814

Any of the entries in <a href="#static_android.control.aeAvailableTargetFpsRanges">android.control.aeAvailableTargetFpsRanges</a>

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

7815

</td>

7816

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

</ul>

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

7829

<th class="th_details" colspan="6">Details</th>

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

7830

</tr>

7831

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

7832

Eino-Ville Talvala

2014-06-06 14:35:41 -0700

[diff] [blame]

7833

Only constrains auto-exposure (AE) algorithm, not

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

7834

manual control of <a href="#controls_android.sensor.exposureTime">android.sensor.exposureTime</a> and

7835

<a href="#controls_android.sensor.frameDuration">android.sensor.frameDuration</a>.

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

7840

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

7841

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

7845

<td class="entry_name

Eino-Ville Talvala

2015-06-24 15:17:09 -0700

[diff] [blame]

7846

" rowspan="5">

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

7847

android.control.aePrecaptureTrigger

</td>

byte

[public]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

7854

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

7855

[limited]

7856

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

7857

7858

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

7859

7860

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

7861

IDLE (v3.2)

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

7862

The trigger is idle.

7863

</li>

7864

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

7865

START (v3.2)

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

7866

The precapture metering sequence will be started

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

7867

by the camera device.

7868

The exact effect of the precapture trigger depends on

7869

the current AE mode and state.

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

7870

</li>

Zhijun He

2015-02-05 14:32:57 -0800

[diff] [blame]

7871

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

7872

CANCEL (v3.2)

Zhijun He

2015-02-05 14:32:57 -0800

[diff] [blame]

7873

The camera device will cancel any currently active or completed

7874

precapture metering sequence, the auto-exposure routine will return to its

7875

initial state.

7876

</li>

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

7877

</ul>

7878

7879

</td>

7880

7881

7882

Whether the camera device will trigger a precapture

7883

metering sequence when it processes this request.

</td>

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

</ul>

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

7904

<th class="th_details" colspan="6">Details</th>

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

7905

</tr>

7906

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

7907

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

7908

This entry is normally set to IDLE, or is not

7909

included at all in the request settings. When included and

Zhijun He

2015-02-06 13:42:40 -0800

[diff] [blame]

7910

set to START, the camera device will trigger the auto-exposure (AE)

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

7911

precapture metering sequence.

Zhijun He

2015-02-05 14:32:57 -0800

[diff] [blame]

7912

When set to CANCEL, the camera device will cancel any active

7913

precapture metering trigger, and return to its initial AE state.

7914

If a precapture metering sequence is already completed, and the camera

7915

device has implicitly locked the AE for subsequent still capture, the

7916

CANCEL trigger will unlock the AE and return to its initial AE state.

Zhijun He

2015-02-06 13:42:40 -0800

[diff] [blame]

7917

The precapture sequence should be triggered before starting a

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

7918

high-quality still capture for final metering decisions to

7919

be made, and for firing pre-capture flash pulses to estimate

7920

scene brightness and required final capture flash power, when

7921

the flash is enabled.

7922

Normally, this entry should be set to START for only a

7923

single request, and the application should wait until the

7924

sequence completes before starting a new one.

Zhijun He

2015-02-06 13:42:40 -0800

[diff] [blame]

7925

When a precapture metering sequence is finished, the camera device

7926

may lock the auto-exposure routine internally to be able to accurately expose the

7927

subsequent still capture image (<code><a href="#controls_android.control.captureIntent">android.control.captureIntent</a> == STILL_CAPTURE</code>).

7928

For this case, the AE may not resume normal scan if no subsequent still capture is

7929

submitted. To ensure that the AE routine restarts normal scan, the application should

7930

submit a request with <code><a href="#controls_android.control.aeLock">android.control.aeLock</a> == true</code>, followed by a request

7931

with <code><a href="#controls_android.control.aeLock">android.control.aeLock</a> == false</code>, if the application decides not to submit a

Zhijun He

2015-02-05 14:32:57 -0800

[diff] [blame]

7932

still capture request after the precapture sequence completes. Alternatively, for

7933

API level 23 or newer devices, the CANCEL can be used to unlock the camera device

7934

internally locked AE if the application doesn't submit a still capture request after

7935

the AE precapture trigger. Note that, the CANCEL was added in API level 23, and must not

7936

be used in devices that have earlier API levels.

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

7937

The exact effect of auto-exposure (AE) precapture trigger

7938

depends on the current AE mode and state; see

Eino-Ville Talvala

2014-06-06 14:35:41 -0700

[diff] [blame]

7939

<a href="#dynamic_android.control.aeState">android.control.aeState</a> for AE precapture state transition

7940

details.

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

7941

On LEGACY-level devices, the precapture trigger is not supported;

7942

capturing a high-resolution JPEG image will automatically trigger a

7943

precapture sequence before the high-resolution capture, including

7944

potentially firing a pre-capture flash.

Eino-Ville Talvala

2015-06-24 15:17:09 -0700

[diff] [blame]

7945

Using the precapture trigger and the auto-focus trigger <a href="#controls_android.control.afTrigger">android.control.afTrigger</a>

7946

simultaneously is allowed. However, since these triggers often require cooperation between

7947

the auto-focus and auto-exposure routines (for example, the may need to be enabled for a

7948

focus sweep), the camera device may delay acting on a later trigger until the previous

7949

trigger has been fully handled. This may lead to longer intervals between the trigger and

7950

changes to <a href="#dynamic_android.control.aeState">android.control.aeState</a> indicating the start of the precapture sequence, for

7951

example.

7952

If both the precapture and the auto-focus trigger are activated on the same request, then

7953

the camera device will complete them in the optimal order for that device.

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2015-06-24 15:17:09 -0700

[diff] [blame]

7957

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

7958

<th class="th_details" colspan="6">HAL Implementation Details</th>

Eino-Ville Talvala

2015-06-24 15:17:09 -0700

[diff] [blame]

7959

</tr>

7960

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

7961

Eino-Ville Talvala

2015-06-24 15:17:09 -0700

[diff] [blame]

7962

The HAL must support triggering the AE precapture trigger while an AF trigger is active

7963

(and vice versa), or at the same time as the AF trigger. It is acceptable for the HAL to

7964

treat these as two consecutive triggers, for example handling the AF trigger and then the

7965

AE trigger. Or the HAL may choose to optimize the case with both triggers fired at once,

7966

to minimize the latency for converging both focus and exposure/flash usage.

7967

</td>

7968

</tr>

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

7969

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

7970

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

7971

7972

7973

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

7974

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

7975

<td class="entry_name

7976

" rowspan="3">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

7977

android.control.aeState

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

7978

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

7979

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

7980

byte

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

7981

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

7982

[public]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

7983

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

7984

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

7985

[limited]

7986

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

7987

7988

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

7989

7990

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

7991

INACTIVE (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

7992

AE is off or recently reset.

7993

When a camera device is opened, it starts in

Zhijun He

2014-02-11 17:18:29 -0800

[diff] [blame]

7994

this state. This is a transient state, the camera device may skip reporting

7995

this state in capture result.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

7996

</li>

7997

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

7998

SEARCHING (v3.2)

Igor Murashkin

2014-01-15 17:05:22 -0800

[diff] [blame]

7999

AE doesn't yet have a good set of control values

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

8000

for the current scene.

8001

This is a transient state, the camera device may skip

Zhijun He

2014-02-11 17:18:29 -0800

[diff] [blame]

8002

reporting this state in capture result.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

8003

</li>

8004

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

8005

CONVERGED (v3.2)

Igor Murashkin

2014-01-15 17:05:22 -0800

[diff] [blame]

8006

AE has a good set of control values for the

Zhijun He

2014-01-13 16:24:31 -0800

[diff] [blame]

8007

current scene.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

8008

</li>

8009

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

8010

LOCKED (v3.2)

Zhijun He

2014-01-13 16:24:31 -0800

[diff] [blame]

8011

AE has been locked.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

8012

</li>

8013

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

8014

FLASH_REQUIRED (v3.2)

Igor Murashkin

2014-01-15 17:05:22 -0800

[diff] [blame]

8015

AE has a good set of control values, but flash

8016

needs to be fired for good quality still

Zhijun He

2014-01-13 16:24:31 -0800

[diff] [blame]

8017

capture.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

8018

</li>

8019

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

8020

PRECAPTURE (v3.2)

Igor Murashkin

2014-01-15 17:05:22 -0800

[diff] [blame]

8021

AE has been asked to do a precapture sequence

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

8022

and is currently executing it.

8023

Precapture can be triggered through setting

Zhijun He

2015-02-05 14:32:57 -0800

[diff] [blame]

8024

<a href="#controls_android.control.aePrecaptureTrigger">android.control.aePrecaptureTrigger</a> to START. Currently

8025

active and completed (if it causes camera device internal AE lock) precapture

8026

metering sequence can be canceled through setting

8027

<a href="#controls_android.control.aePrecaptureTrigger">android.control.aePrecaptureTrigger</a> to CANCEL.

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

8028

Once PRECAPTURE completes, AE will transition to CONVERGED

8029

or FLASH_REQUIRED as appropriate. This is a transient

8030

state, the camera device may skip reporting this state in

8031

capture result.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</li>

</ul>

</td>

8036

8037

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

8038

Current state of the auto-exposure (AE) algorithm.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

8056

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

8057

</tr>

8058

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

8059

Zhijun He

2014-01-13 16:24:31 -0800

[diff] [blame]

8060

Switching between or enabling AE modes (<a href="#controls_android.control.aeMode">android.control.aeMode</a>) always

8061

resets the AE state to INACTIVE. Similarly, switching between <a href="#controls_android.control.mode">android.control.mode</a>,

8062

or <a href="#controls_android.control.sceneMode">android.control.sceneMode</a> if <code><a href="#controls_android.control.mode">android.control.mode</a> == USE_SCENE_MODE</code> resets all

8063

the algorithm states to INACTIVE.

8064

The camera device can do several state transitions between two results, if it is

8065

allowed by the state transition table. For example: INACTIVE may never actually be

8066

seen in a result.

8067

The state in the result is the state for this image (in sync with this image): if

8068

AE state becomes CONVERGED, then the image data associated with this result should

8069

be good to use.

8070

Below are state transition tables for different AE modes.

<table>

<thead>

<tr>

<th align="center">State</th>

8075

<th align="center">Transition Cause</th>

8076

<th align="center">New State</th>

8077

<th align="center">Notes</th>

</tr>

</thead>

<tbody>

<tr>

<td align="center">INACTIVE</td>

8083

8084

<td align="center">INACTIVE</td>

8085

<td align="center">Camera device auto exposure algorithm is disabled</td>

8086

</tr>

8087

</tbody>

8088

</table>

Chien-Yu Chen

2018-01-11 11:32:52 -0800

[diff] [blame]

8089

When <a href="#controls_android.control.aeMode">android.control.aeMode</a> is AE_MODE_ON*:

Zhijun He

2014-01-13 16:24:31 -0800

[diff] [blame]

<table>

<thead>

<tr>

<th align="center">State</th>

8094

<th align="center">Transition Cause</th>

8095

<th align="center">New State</th>

8096

<th align="center">Notes</th>

</tr>

</thead>

<tbody>

<tr>

<td align="center">INACTIVE</td>

8102

<td align="center">Camera device initiates AE scan</td>

8103

<td align="center">SEARCHING</td>

8104

<td align="center">Values changing</td>

8105

</tr>

8106

<tr>

8107

<td align="center">INACTIVE</td>

8108

<td align="center"><a href="#controls_android.control.aeLock">android.control.aeLock</a> is ON</td>

8109

<td align="center">LOCKED</td>

8110

<td align="center">Values locked</td>

8111

</tr>

8112

<tr>

8113

<td align="center">SEARCHING</td>

8114

<td align="center">Camera device finishes AE scan</td>

8115

<td align="center">CONVERGED</td>

8116

<td align="center">Good values, not changing</td>

8117

</tr>

8118

<tr>

8119

<td align="center">SEARCHING</td>

8120

<td align="center">Camera device finishes AE scan</td>

8121

<td align="center">FLASH_REQUIRED</td>

8122

<td align="center">Converged but too dark w/o flash</td>

8123

</tr>

8124

<tr>

8125

<td align="center">SEARCHING</td>

8126

<td align="center"><a href="#controls_android.control.aeLock">android.control.aeLock</a> is ON</td>

8127

<td align="center">LOCKED</td>

8128

<td align="center">Values locked</td>

8129

</tr>

8130

<tr>

8131

<td align="center">CONVERGED</td>

8132

<td align="center">Camera device initiates AE scan</td>

8133

<td align="center">SEARCHING</td>

8134

<td align="center">Values changing</td>

8135

</tr>

8136

<tr>

8137

<td align="center">CONVERGED</td>

8138

<td align="center"><a href="#controls_android.control.aeLock">android.control.aeLock</a> is ON</td>

8139

<td align="center">LOCKED</td>

8140

<td align="center">Values locked</td>

8141

</tr>

8142

<tr>

8143

<td align="center">FLASH_REQUIRED</td>

8144

<td align="center">Camera device initiates AE scan</td>

8145

<td align="center">SEARCHING</td>

8146

<td align="center">Values changing</td>

8147

</tr>

8148

<tr>

8149

<td align="center">FLASH_REQUIRED</td>

8150

<td align="center"><a href="#controls_android.control.aeLock">android.control.aeLock</a> is ON</td>

8151

<td align="center">LOCKED</td>

8152

<td align="center">Values locked</td>

8153

</tr>

8154

<tr>

8155

<td align="center">LOCKED</td>

8156

<td align="center"><a href="#controls_android.control.aeLock">android.control.aeLock</a> is OFF</td>

8157

<td align="center">SEARCHING</td>

8158

<td align="center">Values not good after unlock</td>

8159

</tr>

8160

<tr>

8161

<td align="center">LOCKED</td>

8162

<td align="center"><a href="#controls_android.control.aeLock">android.control.aeLock</a> is OFF</td>

8163

<td align="center">CONVERGED</td>

8164

<td align="center">Values good after unlock</td>

8165

</tr>

8166

<tr>

8167

<td align="center">LOCKED</td>

8168

<td align="center"><a href="#controls_android.control.aeLock">android.control.aeLock</a> is OFF</td>

8169

<td align="center">FLASH_REQUIRED</td>

8170

<td align="center">Exposure good, but too dark</td>

8171

</tr>

8172

<tr>

8173

<td align="center">PRECAPTURE</td>

8174

<td align="center">Sequence done. <a href="#controls_android.control.aeLock">android.control.aeLock</a> is OFF</td>

8175

<td align="center">CONVERGED</td>

8176

<td align="center">Ready for high-quality capture</td>

8177

</tr>

8178

<tr>

8179

<td align="center">PRECAPTURE</td>

8180

<td align="center">Sequence done. <a href="#controls_android.control.aeLock">android.control.aeLock</a> is ON</td>

8181

<td align="center">LOCKED</td>

8182

<td align="center">Ready for high-quality capture</td>

8183

</tr>

8184

<tr>

Zhijun He

2015-02-05 14:32:57 -0800

[diff] [blame]

8185

<td align="center">LOCKED</td>

8186

<td align="center">aeLock is ON and aePrecaptureTrigger is START</td>

8187

<td align="center">LOCKED</td>

8188

<td align="center">Precapture trigger is ignored when AE is already locked</td>

8189

</tr>

8190

<tr>

8191

<td align="center">LOCKED</td>

8192

<td align="center">aeLock is ON and aePrecaptureTrigger is CANCEL</td>

8193

<td align="center">LOCKED</td>

8194

<td align="center">Precapture trigger is ignored when AE is already locked</td>

8195

</tr>

8196

<tr>

8197

<td align="center">Any state (excluding LOCKED)</td>

Zhijun He

2014-01-13 16:24:31 -0800

[diff] [blame]

8198

<td align="center"><a href="#controls_android.control.aePrecaptureTrigger">android.control.aePrecaptureTrigger</a> is START</td>

8199

<td align="center">PRECAPTURE</td>

8200

<td align="center">Start AE precapture metering sequence</td>

8201

</tr>

Zhijun He

2015-02-05 14:32:57 -0800

[diff] [blame]

8202

<tr>

8203

<td align="center">Any state (excluding LOCKED)</td>

8204

<td align="center"><a href="#controls_android.control.aePrecaptureTrigger">android.control.aePrecaptureTrigger</a> is CANCEL</td>

8205

<td align="center">INACTIVE</td>

8206

<td align="center">Currently active precapture metering sequence is canceled</td>

8207

</tr>

Zhijun He

2014-01-13 16:24:31 -0800

[diff] [blame]

8208

</tbody>

8209

</table>

Chien-Yu Chen

2018-01-11 11:32:52 -0800

[diff] [blame]

8210

If the camera device supports AE external flash mode (ON_EXTERNAL_FLASH is included in

Chien-Yu Chen

06513f1

2018-03-15 11:17:20 -0700

[diff] [blame]

8211

<a href="#static_android.control.aeAvailableModes">android.control.aeAvailableModes</a>), <a href="#dynamic_android.control.aeState">android.control.aeState</a> must be FLASH_REQUIRED after

8212

the camera device finishes AE scan and it's too dark without flash.

Zhijun He

2014-02-11 17:18:29 -0800

[diff] [blame]

8213

For the above table, the camera device may skip reporting any state changes that happen

8214

without application intervention (i.e. mode switch, trigger, locking). Any state that

8215

can be skipped in that manner is called a transient state.

Chien-Yu Chen

2018-01-11 11:32:52 -0800

[diff] [blame]

8216

For example, for above AE modes (AE_MODE_ON*), in addition to the state transitions

Zhijun He

2014-02-11 17:18:29 -0800

[diff] [blame]

8217

listed in above table, it is also legal for the camera device to skip one or more

8218

transient states between two results. See below table for examples:

<table>

<thead>

<tr>

<th align="center">State</th>

8223

<th align="center">Transition Cause</th>

8224

<th align="center">New State</th>

8225

<th align="center">Notes</th>

</tr>

</thead>

<tbody>

<tr>

<td align="center">INACTIVE</td>

8231

<td align="center">Camera device finished AE scan</td>

8232

<td align="center">CONVERGED</td>

8233

<td align="center">Values are already good, transient states are skipped by camera device.</td>

8234

</tr>

8235

<tr>

Zhijun He

2015-02-05 14:32:57 -0800

[diff] [blame]

8236

<td align="center">Any state (excluding LOCKED)</td>

Zhijun He

2014-02-11 17:18:29 -0800

[diff] [blame]

8237

<td align="center"><a href="#controls_android.control.aePrecaptureTrigger">android.control.aePrecaptureTrigger</a> is START, sequence done</td>

8238

<td align="center">FLASH_REQUIRED</td>

8239

<td align="center">Converged but too dark w/o flash after a precapture sequence, transient states are skipped by camera device.</td>

8240

</tr>

8241

<tr>

Zhijun He

2015-02-05 14:32:57 -0800

[diff] [blame]

8242

<td align="center">Any state (excluding LOCKED)</td>

Zhijun He

2014-02-11 17:18:29 -0800

[diff] [blame]

8243

<td align="center"><a href="#controls_android.control.aePrecaptureTrigger">android.control.aePrecaptureTrigger</a> is START, sequence done</td>

8244

<td align="center">CONVERGED</td>

8245

<td align="center">Converged after a precapture sequence, transient states are skipped by camera device.</td>

8246

</tr>

8247

<tr>

Zhijun He

2015-02-05 14:32:57 -0800

[diff] [blame]

8248

<td align="center">Any state (excluding LOCKED)</td>

8249

<td align="center"><a href="#controls_android.control.aePrecaptureTrigger">android.control.aePrecaptureTrigger</a> is CANCEL, converged</td>

8250

<td align="center">FLASH_REQUIRED</td>

8251

<td align="center">Converged but too dark w/o flash after a precapture sequence is canceled, transient states are skipped by camera device.</td>

8252

</tr>

8253

<tr>

8254

<td align="center">Any state (excluding LOCKED)</td>

8255

<td align="center"><a href="#controls_android.control.aePrecaptureTrigger">android.control.aePrecaptureTrigger</a> is CANCEL, converged</td>

8256

<td align="center">CONVERGED</td>

Shuzhen Wang

2022-05-03 11:01:26 -0700

[diff] [blame]

8257

<td align="center">Converged after a precapture sequences canceled, transient states are skipped by camera device.</td>

Zhijun He

2015-02-05 14:32:57 -0800

[diff] [blame]

8258

</tr>

8259

<tr>

Zhijun He

2014-02-11 17:18:29 -0800

[diff] [blame]

8260

<td align="center">CONVERGED</td>

8261

<td align="center">Camera device finished AE scan</td>

8262

<td align="center">FLASH_REQUIRED</td>

8263

<td align="center">Converged but too dark w/o flash after a new scan, transient states are skipped by camera device.</td>

8264

</tr>

8265

<tr>

8266

<td align="center">FLASH_REQUIRED</td>

8267

<td align="center">Camera device finished AE scan</td>

8268

<td align="center">CONVERGED</td>

8269

<td align="center">Converged after a new scan, transient states are skipped by camera device.</td>

8270

</tr>

8271

</tbody>

8272

</table>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

8273

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

8274

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

8275

8276

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

8277

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

8278

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

8282

<td class="entry_name

Zhijun He

2014-05-27 15:06:42 -0700

[diff] [blame]

8283

" rowspan="5">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

8284

android.control.afMode

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

8285

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

8286

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

8287

byte

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

8288

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

8289

[public]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

8290

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

8291

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

8292

[legacy]

8293

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

8294

8295

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

8296

8297

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

8298

OFF (v3.2)

Igor Murashkin

2014-01-15 17:05:22 -0800

[diff] [blame]

8299

The auto-focus routine does not control the lens;

8300

<a href="#controls_android.lens.focusDistance">android.lens.focusDistance</a> is controlled by the

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

8301

application.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

8302

</li>

8303

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

8304

AUTO (v3.2)

Eino-Ville Talvala

2014-06-06 14:35:41 -0700

[diff] [blame]

8305

Basic automatic focus mode.

8306

In this mode, the lens does not move unless

Igor Murashkin

2014-01-15 17:05:22 -0800

[diff] [blame]

8307

the autofocus trigger action is called. When that trigger

Eino-Ville Talvala

2014-06-06 14:35:41 -0700

[diff] [blame]

8308

is activated, AF will transition to ACTIVE_SCAN, then to

Igor Murashkin

2014-01-15 17:05:22 -0800

[diff] [blame]

8309

the outcome of the scan (FOCUSED or NOT_FOCUSED).

Eino-Ville Talvala

2014-06-06 14:35:41 -0700

[diff] [blame]

8310

Always supported if lens is not fixed focus.

8311

Use <a href="#static_android.lens.info.minimumFocusDistance">android.lens.info.minimumFocusDistance</a> to determine if lens

8312

is fixed-focus.

Igor Murashkin

2014-01-15 17:05:22 -0800

[diff] [blame]

8313

Triggering AF_CANCEL resets the lens position to default,

8314

and sets the AF state to INACTIVE.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

8315

</li>

8316

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

8317

MACRO (v3.2)

Eino-Ville Talvala

2014-06-06 14:35:41 -0700

[diff] [blame]

8318

Close-up focusing mode.

8319

In this mode, the lens does not move unless the

8320

autofocus trigger action is called. When that trigger is

8321

activated, AF will transition to ACTIVE_SCAN, then to

8322

the outcome of the scan (FOCUSED or NOT_FOCUSED). This

8323

mode is optimized for focusing on objects very close to

8324

the camera.

8325

When that trigger is activated, AF will transition to

Igor Murashkin

2014-01-15 17:05:22 -0800

[diff] [blame]

8326

ACTIVE_SCAN, then to the outcome of the scan (FOCUSED or

Eino-Ville Talvala

2014-06-06 14:35:41 -0700

[diff] [blame]

8327

NOT_FOCUSED). Triggering cancel AF resets the lens

Igor Murashkin

2014-01-15 17:05:22 -0800

[diff] [blame]

8328

position to default, and sets the AF state to

8329

INACTIVE.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

8330

</li>

8331

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

8332

CONTINUOUS_VIDEO (v3.2)

Igor Murashkin

2014-01-15 17:05:22 -0800

[diff] [blame]

8333

In this mode, the AF algorithm modifies the lens

8334

position continually to attempt to provide a

8335

constantly-in-focus image stream.

8336

The focusing behavior should be suitable for good quality

8337

video recording; typically this means slower focus

8338

movement and no overshoots. When the AF trigger is not

8339

involved, the AF algorithm should start in INACTIVE state,

8340

and then transition into PASSIVE_SCAN and PASSIVE_FOCUSED

8341

states as appropriate. When the AF trigger is activated,

8342

the algorithm should immediately transition into

8343

AF_FOCUSED or AF_NOT_FOCUSED as appropriate, and lock the

8344

lens position until a cancel AF trigger is received.

8345

Once cancel is received, the algorithm should transition

8346

back to INACTIVE and resume passive scan. Note that this

8347

behavior is not identical to CONTINUOUS_PICTURE, since an

8348

ongoing PASSIVE_SCAN must immediately be

8349

canceled.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

8350

</li>

8351

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

8352

CONTINUOUS_PICTURE (v3.2)

Igor Murashkin

2014-01-15 17:05:22 -0800

[diff] [blame]

8353

In this mode, the AF algorithm modifies the lens

8354

position continually to attempt to provide a

8355

constantly-in-focus image stream.

8356

The focusing behavior should be suitable for still image

8357

capture; typically this means focusing as fast as

8358

possible. When the AF trigger is not involved, the AF

8359

algorithm should start in INACTIVE state, and then

8360

transition into PASSIVE_SCAN and PASSIVE_FOCUSED states as

8361

appropriate as it attempts to maintain focus. When the AF

8362

trigger is activated, the algorithm should finish its

8363

PASSIVE_SCAN if active, and then transition into

8364

AF_FOCUSED or AF_NOT_FOCUSED as appropriate, and lock the

8365

lens position until a cancel AF trigger is received.

8366

When the AF cancel trigger is activated, the algorithm

8367

should transition back to INACTIVE and then act as if it

8368

has just been started.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

8369

</li>

8370

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

8371

EDOF (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

8372

Extended depth of field (digital focus) mode.

8373

The camera device will produce images with an extended

8374

depth of field automatically; no special focusing

8375

operations need to be done before taking a picture.

8376

AF triggers are ignored, and the AF state will always be

Igor Murashkin

2014-01-15 17:05:22 -0800

[diff] [blame]

8377

INACTIVE.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</li>

</ul>

</td>

8382

8383

Eino-Ville Talvala

2014-06-06 14:35:41 -0700

[diff] [blame]

8384

Whether auto-focus (AF) is currently enabled, and what

8385

mode it is set to.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

Zhijun He

2014-01-14 16:30:31 -0800

[diff] [blame]

8392

<a href="#static_android.control.afAvailableModes">android.control.afAvailableModes</a>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

8393

</td>

8394

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

8399

Igor Murashkin

2012-12-05 14:49:11 -0800

[diff] [blame]

8400

8401

8402

</ul>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

8403

</td>

8404

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

8405

</tr>

8406

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

8407

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

8408

</tr>

8409

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

8410

Zhijun He

2014-02-24 09:49:37 -0800

[diff] [blame]

8411

Only effective if <a href="#controls_android.control.mode">android.control.mode</a> = AUTO and the lens is not fixed focus

Yin-Chia Yeh

2014-11-12 11:38:10 -0800

[diff] [blame]

8412

(i.e. <code><a href="#static_android.lens.info.minimumFocusDistance">android.lens.info.minimumFocusDistance</a> > 0</code>). Also note that

8413

when <a href="#controls_android.control.aeMode">android.control.aeMode</a> is OFF, the behavior of AF is device

8414

dependent. It is recommended to lock AF by using <a href="#controls_android.control.afTrigger">android.control.afTrigger</a> before

8415

setting <a href="#controls_android.control.aeMode">android.control.aeMode</a> to OFF, or set AF mode to OFF when AE is OFF.

Zhijun He

2014-01-14 09:59:04 -0800

[diff] [blame]

8416

If the lens is controlled by the camera device auto-focus algorithm,

Eino-Ville Talvala

2014-02-10 12:39:35 -0800

[diff] [blame]

8417

the camera device will report the current AF status in <a href="#dynamic_android.control.afState">android.control.afState</a>

Zhijun He

2014-01-14 09:59:04 -0800

[diff] [blame]

8418

in result metadata.

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

8419

</td>

8420

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

8421

Zhijun He

2014-05-27 15:06:42 -0700

[diff] [blame]

8422

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

8423

<th class="th_details" colspan="6">HAL Implementation Details</th>

Zhijun He

2014-05-27 15:06:42 -0700

[diff] [blame]

8424

</tr>

8425

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

8426

Zhijun He

2014-05-27 15:06:42 -0700

[diff] [blame]

8427

When afMode is AUTO or MACRO, the lens must not move until an AF trigger is sent in a

8428

request (<a href="#controls_android.control.afTrigger">android.control.afTrigger</a> <code>==</code> START). After an AF trigger, the afState will end

8429

up with either FOCUSED_LOCKED or NOT_FOCUSED_LOCKED state (see

8430

<a href="#dynamic_android.control.afState">android.control.afState</a> for detailed state transitions), which indicates that the lens is

8431

locked and will not move. If camera movement (e.g. tilting camera) causes the lens to move

8432

after the lens is locked, the HAL must compensate this movement appropriately such that

8433

the same focal plane remains in focus.

8434

When afMode is one of the continuous auto focus modes, the HAL is free to start a AF

8435

scan whenever it's not locked. When the lens is locked after an AF trigger

8436

(see <a href="#dynamic_android.control.afState">android.control.afState</a> for detailed state transitions), the HAL should maintain the

8437

same lock behavior as above.

8438

When afMode is OFF, the application controls focus manually. The accuracy of the

8439

focus distance control depends on the <a href="#static_android.lens.info.focusDistanceCalibration">android.lens.info.focusDistanceCalibration</a>.

8440

However, the lens must not move regardless of the camera movement for any focus distance

8441

manual control.

8442

To put this in concrete terms, if the camera has lens elements which may move based on

8443

camera orientation or motion (e.g. due to gravity), then the HAL must drive the lens to

8444

remain in a fixed position invariant to the camera's orientation or motion, for example,

8445

by using accelerometer measurements in the lens control logic. This is a typical issue

8446

that will arise on camera modules with open-loop VCMs.

8447

</td>

8448

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

8449

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

8450

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

8451

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

8455

<td class="entry_name

Yin-Chia Yeh

2014-05-16 15:13:13 -0700

[diff] [blame]

8456

" rowspan="5">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

8457

android.control.afRegions

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

8458

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

8459

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

8460

int32

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

x

5 x area_count

Yin-Chia Yeh

2014-05-16 15:13:13 -0700

[diff] [blame]

8466

[public as meteringRectangle]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

8467

8468

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

8472

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

8473

</td>

8474

8475

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

8476

List of metering areas to use for auto-focus.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Yin-Chia Yeh

2018-06-15 15:35:05 -0700

[diff] [blame]

8480

Pixel coordinates within android.sensor.info.activeArraySize or

8481

android.sensor.info.preCorrectionActiveArraySize depending on

8482

distortion correction capability and mode

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

8486

Coordinates must be between <code>[(0,0), (width, height))</code> of

Yin-Chia Yeh

2018-06-15 15:35:05 -0700

[diff] [blame]

8487

<a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a> or <a href="#static_android.sensor.info.preCorrectionActiveArraySize">android.sensor.info.preCorrectionActiveArraySize</a>

8488

depending on distortion correction capability and mode

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

8489

</td>

8490

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

</ul>

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

8503

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

8504

</tr>

8505

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

8506

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

8507

Not available if <a href="#static_android.control.maxRegionsAf">android.control.maxRegionsAf</a> is 0.

Yin-Chia Yeh

2014-09-04 09:33:34 -0700

[diff] [blame]

8508

Otherwise will always be present.

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

8509

The maximum number of focus areas supported by the device is determined by the value

8510

of <a href="#static_android.control.maxRegionsAf">android.control.maxRegionsAf</a>.

Yin-Chia Yeh

2018-06-15 15:35:05 -0700

[diff] [blame]

8511

For devices not supporting <a href="#controls_android.distortionCorrection.mode">android.distortionCorrection.mode</a> control, the coordinate

8512

system always follows that of <a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a>, with (0,0) being

8513

the top-left pixel in the active pixel array, and

Eino-Ville Talvala

2014-01-02 16:11:44 -0800

[diff] [blame]

8514

(<a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a>.width - 1,

Yin-Chia Yeh

2018-06-15 15:35:05 -0700

[diff] [blame]

8515

<a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a>.height - 1) being the bottom-right pixel in the

8516

active pixel array.

8517

For devices supporting <a href="#controls_android.distortionCorrection.mode">android.distortionCorrection.mode</a> control, the coordinate

8518

system depends on the mode being set.

8519

When the distortion correction mode is OFF, the coordinate system follows

8520

<a href="#static_android.sensor.info.preCorrectionActiveArraySize">android.sensor.info.preCorrectionActiveArraySize</a>, with

8521

<code>(0, 0)</code> being the top-left pixel of the pre-correction active array, and

8522

(<a href="#static_android.sensor.info.preCorrectionActiveArraySize">android.sensor.info.preCorrectionActiveArraySize</a>.width - 1,

8523

<a href="#static_android.sensor.info.preCorrectionActiveArraySize">android.sensor.info.preCorrectionActiveArraySize</a>.height - 1) being the bottom-right

8524

pixel in the pre-correction active pixel array.

8525

When the distortion correction mode is not OFF, the coordinate system follows

8526

<a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a>, with

8527

<code>(0, 0)</code> being the top-left pixel of the active array, and

8528

(<a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a>.width - 1,

8529

<a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a>.height - 1) being the bottom-right pixel in the

8530

active pixel array.

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

8531

The weight must be within <code>[0, 1000]</code>, and represents a weight

Yin-Chia Yeh

2014-05-14 14:05:20 -0700

[diff] [blame]

8532

for every pixel in the area. This means that a large metering area

8533

with the same weight as a smaller area will have more effect in

8534

the metering result. Metering areas can partially overlap and the

8535

camera device will add the weights in the overlap region.

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

8536

The weights are relative to weights of other metering regions, so if only one region

8537

is used, all non-zero weights will have the same effect. A region with 0 weight is

8538

ignored.

8539

If all regions have 0 weight, then no specific metering area needs to be used by the

Shuzhen Wang

608e058

2018-02-08 12:03:09 -0800

[diff] [blame]

8540

camera device. The capture result will either be a zero weight region as well, or

8541

the region selected by the camera device as the focus area of interest.

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

8542

If the metering region is outside the used <a href="#controls_android.scaler.cropRegion">android.scaler.cropRegion</a> returned in

8543

capture result metadata, the camera device will ignore the sections outside the crop

8544

region and output only the intersection rectangle as the metering region in the result

8545

metadata. If the region is entirely outside the crop region, it will be ignored and

8546

not reported in the result metadata.

Shuzhen Wang

2022-03-28 12:41:41 -0700

[diff] [blame]

8547

When setting the AF metering regions, the application must consider the additional

8548

crop resulted from the aspect ratio differences between the preview stream and

8549

<a href="#controls_android.scaler.cropRegion">android.scaler.cropRegion</a>. For example, if the <a href="#controls_android.scaler.cropRegion">android.scaler.cropRegion</a> is the full

8550

active array size with 4:3 aspect ratio, and the preview stream is 16:9,

8551

the boundary of AF regions will be [0, y_crop] and

8552

[active_width, active_height - 2 * y_crop] rather than [0, 0] and

8553

[active_width, active_height], where y_crop is the additional crop due to aspect ratio

8554

mismatch.

Shuzhen Wang

2019-11-07 15:59:22 -0800

[diff] [blame]

8555

Starting from API level 30, the coordinate system of activeArraySize or

8556

preCorrectionActiveArraySize is used to represent post-zoomRatio field of view, not

8557

pre-zoom field of view. This means that the same afRegions values at different

8558

<a href="#controls_android.control.zoomRatio">android.control.zoomRatio</a> represent different parts of the scene. The afRegions

8559

coordinates are relative to the activeArray/preCorrectionActiveArray representing the

8560

zoomed field of view. If <a href="#controls_android.control.zoomRatio">android.control.zoomRatio</a> is set to 1.0 (default), the same

8561

afRegions at different <a href="#controls_android.scaler.cropRegion">android.scaler.cropRegion</a> still represent the same parts of the

8562

scene as they do before. See <a href="#controls_android.control.zoomRatio">android.control.zoomRatio</a> for details. Whether to use

8563

activeArraySize or preCorrectionActiveArraySize still depends on distortion correction

8564

mode.

Jayant Chowdhary

2020-11-09 09:08:31 -0800

[diff] [blame]

8565

For camera devices with the

8566

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraMetadata.html#REQUEST_AVAILABLE_CAPABILITIES_ULTRA_HIGH_RESOLUTION_SENSOR">CameraMetadata#REQUEST_AVAILABLE_CAPABILITIES_ULTRA_HIGH_RESOLUTION_SENSOR</a>

8567

capability, <a href="#static_android.sensor.info.activeArraySizeMaximumResolution">android.sensor.info.activeArraySizeMaximumResolution</a> /

8568

<a href="#static_android.sensor.info.preCorrectionActiveArraySizeMaximumResolution">android.sensor.info.preCorrectionActiveArraySizeMaximumResolution</a> must be used as the

8569

coordinate system for requests where <a href="#controls_android.sensor.pixelMode">android.sensor.pixelMode</a> is set to

8570

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraMetadata.html#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION">CameraMetadata#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION</a>.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

8571

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

8572

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

8573

Yin-Chia Yeh

2014-05-16 15:13:13 -0700

[diff] [blame]

8574

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

8575

<th class="th_details" colspan="6">HAL Implementation Details</th>

Yin-Chia Yeh

2014-05-16 15:13:13 -0700

[diff] [blame]

8576

</tr>

8577

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

8578

Yin-Chia Yeh

2014-05-16 15:13:13 -0700

[diff] [blame]

8579

The HAL level representation of MeteringRectangle[] is a

8580

int[5 * area_count].

8581

Every five elements represent a metering region of

8582

(xmin, ymin, xmax, ymax, weight).

8583

The rectangle is defined to be inclusive on xmin and ymin, but

Yin-Chia Yeh

2018-06-15 15:35:05 -0700

[diff] [blame]

8584

exclusive on xmax and ymax.

8585

HAL must always report metering regions in the coordinate system of pre-correction

8586

active array.

Yin-Chia Yeh

2014-05-16 15:13:13 -0700

[diff] [blame]

8587

</td>

8588

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

8589

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

8590

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

8591

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

8592

8593

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

8594

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

8595

<td class="entry_name

Eino-Ville Talvala

2015-06-24 15:17:09 -0700

[diff] [blame]

8596

" rowspan="5">

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

8597

android.control.afTrigger

</td>

byte

[public]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

8604

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

8605

[legacy]

8606

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

8607

8608

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

8609

8610

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

8611

IDLE (v3.2)

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

8612

The trigger is idle.

8613

</li>

8614

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

8615

START (v3.2)

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

8616

Autofocus will trigger now.

8617

</li>

8618

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

8619

CANCEL (v3.2)

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

8620

Autofocus will return to its initial

8621

state, and cancel any currently active trigger.

</li>

</ul>

</td>

8626

8627

8628

Whether the camera device will trigger autofocus for this request.

</td>

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

</ul>

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

8649

<th class="th_details" colspan="6">Details</th>

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

8650

</tr>

8651

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

8652

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

8653

This entry is normally set to IDLE, or is not

8654

included at all in the request settings.

8655

When included and set to START, the camera device will trigger the

8656

autofocus algorithm. If autofocus is disabled, this trigger has no effect.

8657

When set to CANCEL, the camera device will cancel any active trigger,

8658

and return to its initial AF state.

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

8659

Generally, applications should set this entry to START or CANCEL for only a

8660

single capture, and then return it to IDLE (or not set at all). Specifying

8661

START for multiple captures in a row means restarting the AF operation over

8662

and over again.

8663

See <a href="#dynamic_android.control.afState">android.control.afState</a> for what the trigger means for each AF mode.

Eino-Ville Talvala

2015-06-24 15:17:09 -0700

[diff] [blame]

8664

Using the autofocus trigger and the precapture trigger <a href="#controls_android.control.aePrecaptureTrigger">android.control.aePrecaptureTrigger</a>

8665

simultaneously is allowed. However, since these triggers often require cooperation between

8666

the auto-focus and auto-exposure routines (for example, the may need to be enabled for a

8667

focus sweep), the camera device may delay acting on a later trigger until the previous

8668

trigger has been fully handled. This may lead to longer intervals between the trigger and

8669

changes to <a href="#dynamic_android.control.afState">android.control.afState</a>, for example.

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2015-06-24 15:17:09 -0700

[diff] [blame]

8673

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

8674

<th class="th_details" colspan="6">HAL Implementation Details</th>

Eino-Ville Talvala

2015-06-24 15:17:09 -0700

[diff] [blame]

8675

</tr>

8676

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

8677

Eino-Ville Talvala

2015-06-24 15:17:09 -0700

[diff] [blame]

8678

The HAL must support triggering the AF trigger while an AE precapture trigger is active

8679

(and vice versa), or at the same time as the AE trigger. It is acceptable for the HAL to

8680

treat these as two consecutive triggers, for example handling the AF trigger and then the

8681

AE trigger. Or the HAL may choose to optimize the case with both triggers fired at once,

8682

to minimize the latency for converging both focus and exposure/flash usage.

8683

</td>

8684

</tr>

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

8685

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

8686

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

8687

8688

8689

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

8690

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

8691

<td class="entry_name

8692

" rowspan="3">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

8693

android.control.afState

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

8694

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

8695

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

8696

byte

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

8697

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

8698

[public]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

8699

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

8700

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

8701

[legacy]

8702

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

8703

8704

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

8705

8706

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

8707

INACTIVE (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

8708

AF is off or has not yet tried to scan/been asked

8709

to scan.

8710

When a camera device is opened, it starts in this

8711

state. This is a transient state, the camera device may

8712

skip reporting this state in capture

8713

result.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

8714

</li>

8715

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

8716

PASSIVE_SCAN (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

8717

AF is currently performing an AF scan initiated the

8718

camera device in a continuous autofocus mode.

8719

Only used by CONTINUOUS_* AF modes. This is a transient

8720

state, the camera device may skip reporting this state in

8721

capture result.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

8722

</li>

8723

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

8724

PASSIVE_FOCUSED (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

8725

AF currently believes it is in focus, but may

8726

restart scanning at any time.

8727

Only used by CONTINUOUS_* AF modes. This is a transient

8728

state, the camera device may skip reporting this state in

8729

capture result.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

8730

</li>

8731

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

8732

ACTIVE_SCAN (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

8733

AF is performing an AF scan because it was

8734

triggered by AF trigger.

8735

Only used by AUTO or MACRO AF modes. This is a transient

8736

state, the camera device may skip reporting this state in

8737

capture result.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

8738

</li>

8739

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

8740

FOCUSED_LOCKED (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

8741

AF believes it is focused correctly and has locked

8742

focus.

8743

This state is reached only after an explicit START AF trigger has been

8744

sent (<a href="#controls_android.control.afTrigger">android.control.afTrigger</a>), when good focus has been obtained.

8745

The lens will remain stationary until the AF mode (<a href="#controls_android.control.afMode">android.control.afMode</a>) is changed or

8746

a new AF trigger is sent to the camera device (<a href="#controls_android.control.afTrigger">android.control.afTrigger</a>).

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

8747

</li>

8748

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

8749

NOT_FOCUSED_LOCKED (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

8750

AF has failed to focus successfully and has locked

8751

focus.

8752

This state is reached only after an explicit START AF trigger has been

8753

sent (<a href="#controls_android.control.afTrigger">android.control.afTrigger</a>), when good focus cannot be obtained.

8754

The lens will remain stationary until the AF mode (<a href="#controls_android.control.afMode">android.control.afMode</a>) is changed or

8755

a new AF trigger is sent to the camera device (<a href="#controls_android.control.afTrigger">android.control.afTrigger</a>).

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

8756

</li>

Eino-Ville Talvala

492ba7c

2013-09-20 17:24:00 -0700

[diff] [blame]

8757

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

8758

PASSIVE_UNFOCUSED (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

8759

AF finished a passive scan without finding focus,

8760

and may restart scanning at any time.

8761

Only used by CONTINUOUS_* AF modes. This is a transient state, the camera

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

8762

device may skip reporting this state in capture result.

8763

LEGACY camera devices do not support this state. When a passive

8764

scan has finished, it will always go to PASSIVE_FOCUSED.

Eino-Ville Talvala

492ba7c

2013-09-20 17:24:00 -0700

[diff] [blame]

8765

</li>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

8766

</ul>

8767

8768

</td>

8769

8770

Eino-Ville Talvala

2014-06-06 14:35:41 -0700

[diff] [blame]

8771

Current state of auto-focus (AF) algorithm.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

8789

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

8790

</tr>

8791

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

8792

Zhijun He

2014-01-13 16:24:31 -0800

[diff] [blame]

8793

Switching between or enabling AF modes (<a href="#controls_android.control.afMode">android.control.afMode</a>) always

8794

resets the AF state to INACTIVE. Similarly, switching between <a href="#controls_android.control.mode">android.control.mode</a>,

8795

or <a href="#controls_android.control.sceneMode">android.control.sceneMode</a> if <code><a href="#controls_android.control.mode">android.control.mode</a> == USE_SCENE_MODE</code> resets all

8796

the algorithm states to INACTIVE.

8797

The camera device can do several state transitions between two results, if it is

8798

allowed by the state transition table. For example: INACTIVE may never actually be

8799

seen in a result.

8800

The state in the result is the state for this image (in sync with this image): if

8801

AF state becomes FOCUSED, then the image data associated with this result should

8802

be sharp.

8803

Below are state transition tables for different AF modes.

8804

When <a href="#controls_android.control.afMode">android.control.afMode</a> is AF_MODE_OFF or AF_MODE_EDOF:

<table>

<thead>

<tr>

<th align="center">State</th>

8809

<th align="center">Transition Cause</th>

8810

<th align="center">New State</th>

8811

<th align="center">Notes</th>

</tr>

</thead>

<tbody>

<tr>

<td align="center">INACTIVE</td>

8817

8818

<td align="center">INACTIVE</td>

8819

<td align="center">Never changes</td>

</tr>

</tbody>

</table>

When <a href="#controls_android.control.afMode">android.control.afMode</a> is AF_MODE_AUTO or AF_MODE_MACRO:

<table>

<thead>

<tr>

<th align="center">State</th>

8828

<th align="center">Transition Cause</th>

8829

<th align="center">New State</th>

8830

<th align="center">Notes</th>

</tr>

</thead>

<tbody>

<tr>

<td align="center">INACTIVE</td>

8836

<td align="center">AF_TRIGGER</td>

8837

<td align="center">ACTIVE_SCAN</td>

8838

<td align="center">Start AF sweep, Lens now moving</td>

8839

</tr>

8840

<tr>

8841

<td align="center">ACTIVE_SCAN</td>

8842

<td align="center">AF sweep done</td>

8843

<td align="center">FOCUSED_LOCKED</td>

8844

<td align="center">Focused, Lens now locked</td>

8845

</tr>

8846

<tr>

8847

<td align="center">ACTIVE_SCAN</td>

8848

<td align="center">AF sweep done</td>

8849

<td align="center">NOT_FOCUSED_LOCKED</td>

8850

<td align="center">Not focused, Lens now locked</td>

8851

</tr>

8852

<tr>

8853

<td align="center">ACTIVE_SCAN</td>

8854

<td align="center">AF_CANCEL</td>

8855

<td align="center">INACTIVE</td>

8856

<td align="center">Cancel/reset AF, Lens now locked</td>

8857

</tr>

8858

<tr>

8859

<td align="center">FOCUSED_LOCKED</td>

8860

<td align="center">AF_CANCEL</td>

8861

<td align="center">INACTIVE</td>

8862

<td align="center">Cancel/reset AF</td>

8863

</tr>

8864

<tr>

8865

<td align="center">FOCUSED_LOCKED</td>

8866

<td align="center">AF_TRIGGER</td>

8867

<td align="center">ACTIVE_SCAN</td>

8868

<td align="center">Start new sweep, Lens now moving</td>

8869

</tr>

8870

<tr>

8871

<td align="center">NOT_FOCUSED_LOCKED</td>

8872

<td align="center">AF_CANCEL</td>

8873

<td align="center">INACTIVE</td>

8874

<td align="center">Cancel/reset AF</td>

8875

</tr>

8876

<tr>

8877

<td align="center">NOT_FOCUSED_LOCKED</td>

8878

<td align="center">AF_TRIGGER</td>

8879

<td align="center">ACTIVE_SCAN</td>

8880

<td align="center">Start new sweep, Lens now moving</td>

8881

</tr>

8882

<tr>

8883

<td align="center">Any state</td>

8884

<td align="center">Mode change</td>

8885

<td align="center">INACTIVE</td>

</tr>

</tbody>

</table>

Zhijun He

2014-02-11 17:18:29 -0800

[diff] [blame]

8890

For the above table, the camera device may skip reporting any state changes that happen

8891

without application intervention (i.e. mode switch, trigger, locking). Any state that

8892

can be skipped in that manner is called a transient state.

8893

For example, for these AF modes (AF_MODE_AUTO and AF_MODE_MACRO), in addition to the

8894

state transitions listed in above table, it is also legal for the camera device to skip

8895

one or more transient states between two results. See below table for examples:

<table>

<thead>

<tr>

<th align="center">State</th>

8900

<th align="center">Transition Cause</th>

8901

<th align="center">New State</th>

8902

<th align="center">Notes</th>

</tr>

</thead>

<tbody>

<tr>

<td align="center">INACTIVE</td>

8908

<td align="center">AF_TRIGGER</td>

8909

<td align="center">FOCUSED_LOCKED</td>

8910

<td align="center">Focus is already good or good after a scan, lens is now locked.</td>

8911

</tr>

8912

<tr>

8913

<td align="center">INACTIVE</td>

8914

<td align="center">AF_TRIGGER</td>

8915

<td align="center">NOT_FOCUSED_LOCKED</td>

8916

<td align="center">Focus failed after a scan, lens is now locked.</td>

8917

</tr>

8918

<tr>

8919

<td align="center">FOCUSED_LOCKED</td>

8920

<td align="center">AF_TRIGGER</td>

8921

<td align="center">FOCUSED_LOCKED</td>

8922

<td align="center">Focus is already good or good after a scan, lens is now locked.</td>

8923

</tr>

8924

<tr>

8925

<td align="center">NOT_FOCUSED_LOCKED</td>

8926

<td align="center">AF_TRIGGER</td>

8927

<td align="center">FOCUSED_LOCKED</td>

8928

<td align="center">Focus is good after a scan, lens is not locked.</td>

8929

</tr>

8930

</tbody>

8931

</table>

Zhijun He

2014-01-13 16:24:31 -0800

[diff] [blame]

8932

When <a href="#controls_android.control.afMode">android.control.afMode</a> is AF_MODE_CONTINUOUS_VIDEO:

<table>

<thead>

<tr>

<th align="center">State</th>

8937

<th align="center">Transition Cause</th>

8938

<th align="center">New State</th>

8939

<th align="center">Notes</th>

</tr>

</thead>

<tbody>

<tr>

<td align="center">INACTIVE</td>

8945

<td align="center">Camera device initiates new scan</td>

8946

<td align="center">PASSIVE_SCAN</td>

8947

<td align="center">Start AF scan, Lens now moving</td>

8948

</tr>

8949

<tr>

8950

<td align="center">INACTIVE</td>

8951

<td align="center">AF_TRIGGER</td>

8952

<td align="center">NOT_FOCUSED_LOCKED</td>

8953

<td align="center">AF state query, Lens now locked</td>

8954

</tr>

8955

<tr>

8956

<td align="center">PASSIVE_SCAN</td>

8957

<td align="center">Camera device completes current scan</td>

8958

<td align="center">PASSIVE_FOCUSED</td>

8959

<td align="center">End AF scan, Lens now locked</td>

8960

</tr>

8961

<tr>

8962

<td align="center">PASSIVE_SCAN</td>

8963

<td align="center">Camera device fails current scan</td>

8964

<td align="center">PASSIVE_UNFOCUSED</td>

8965

<td align="center">End AF scan, Lens now locked</td>

8966

</tr>

8967

<tr>

8968

<td align="center">PASSIVE_SCAN</td>

8969

<td align="center">AF_TRIGGER</td>

8970

<td align="center">FOCUSED_LOCKED</td>

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

8971

<td align="center">Immediate transition, if focus is good. Lens now locked</td>

Zhijun He

2014-01-13 16:24:31 -0800

[diff] [blame]

8972

</tr>

8973

<tr>

8974

<td align="center">PASSIVE_SCAN</td>

8975

<td align="center">AF_TRIGGER</td>

8976

<td align="center">NOT_FOCUSED_LOCKED</td>

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

8977

<td align="center">Immediate transition, if focus is bad. Lens now locked</td>

Zhijun He

2014-01-13 16:24:31 -0800

[diff] [blame]

8978

</tr>

8979

<tr>

8980

<td align="center">PASSIVE_SCAN</td>

8981

<td align="center">AF_CANCEL</td>

8982

<td align="center">INACTIVE</td>

8983

<td align="center">Reset lens position, Lens now locked</td>

8984

</tr>

8985

<tr>

8986

<td align="center">PASSIVE_FOCUSED</td>

8987

<td align="center">Camera device initiates new scan</td>

8988

<td align="center">PASSIVE_SCAN</td>

8989

<td align="center">Start AF scan, Lens now moving</td>

8990

</tr>

8991

<tr>

8992

<td align="center">PASSIVE_UNFOCUSED</td>

8993

<td align="center">Camera device initiates new scan</td>

8994

<td align="center">PASSIVE_SCAN</td>

8995

<td align="center">Start AF scan, Lens now moving</td>

8996

</tr>

8997

<tr>

8998

<td align="center">PASSIVE_FOCUSED</td>

8999

<td align="center">AF_TRIGGER</td>

9000

<td align="center">FOCUSED_LOCKED</td>

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

9001

<td align="center">Immediate transition, lens now locked</td>

Zhijun He

2014-01-13 16:24:31 -0800

[diff] [blame]

9002

</tr>

9003

<tr>

9004

<td align="center">PASSIVE_UNFOCUSED</td>

9005

<td align="center">AF_TRIGGER</td>

9006

<td align="center">NOT_FOCUSED_LOCKED</td>

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

9007

<td align="center">Immediate transition, lens now locked</td>

Zhijun He

2014-01-13 16:24:31 -0800

[diff] [blame]

9008

</tr>

9009

<tr>

9010

<td align="center">FOCUSED_LOCKED</td>

9011

<td align="center">AF_TRIGGER</td>

9012

<td align="center">FOCUSED_LOCKED</td>

9013

<td align="center">No effect</td>

9014

</tr>

9015

<tr>

9016

<td align="center">FOCUSED_LOCKED</td>

9017

<td align="center">AF_CANCEL</td>

9018

<td align="center">INACTIVE</td>

9019

<td align="center">Restart AF scan</td>

9020

</tr>

9021

<tr>

9022

<td align="center">NOT_FOCUSED_LOCKED</td>

9023

<td align="center">AF_TRIGGER</td>

9024

<td align="center">NOT_FOCUSED_LOCKED</td>

9025

<td align="center">No effect</td>

9026

</tr>

9027

<tr>

9028

<td align="center">NOT_FOCUSED_LOCKED</td>

9029

<td align="center">AF_CANCEL</td>

9030

<td align="center">INACTIVE</td>

9031

<td align="center">Restart AF scan</td>

</tr>

</tbody>

</table>

When <a href="#controls_android.control.afMode">android.control.afMode</a> is AF_MODE_CONTINUOUS_PICTURE:

<table>

<thead>

<tr>

<th align="center">State</th>

9040

<th align="center">Transition Cause</th>

9041

<th align="center">New State</th>

9042

<th align="center">Notes</th>

</tr>

</thead>

<tbody>

<tr>

<td align="center">INACTIVE</td>

9048

<td align="center">Camera device initiates new scan</td>

9049

<td align="center">PASSIVE_SCAN</td>

9050

<td align="center">Start AF scan, Lens now moving</td>

9051

</tr>

9052

<tr>

9053

<td align="center">INACTIVE</td>

9054

<td align="center">AF_TRIGGER</td>

9055

<td align="center">NOT_FOCUSED_LOCKED</td>

9056

<td align="center">AF state query, Lens now locked</td>

9057

</tr>

9058

<tr>

9059

<td align="center">PASSIVE_SCAN</td>

9060

<td align="center">Camera device completes current scan</td>

9061

<td align="center">PASSIVE_FOCUSED</td>

9062

<td align="center">End AF scan, Lens now locked</td>

9063

</tr>

9064

<tr>

9065

<td align="center">PASSIVE_SCAN</td>

9066

<td align="center">Camera device fails current scan</td>

9067

<td align="center">PASSIVE_UNFOCUSED</td>

9068

<td align="center">End AF scan, Lens now locked</td>

9069

</tr>

9070

<tr>

9071

<td align="center">PASSIVE_SCAN</td>

9072

<td align="center">AF_TRIGGER</td>

9073

<td align="center">FOCUSED_LOCKED</td>

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

9074

<td align="center">Eventual transition once the focus is good. Lens now locked</td>

Zhijun He

2014-01-13 16:24:31 -0800

[diff] [blame]

9075

</tr>

9076

<tr>

9077

<td align="center">PASSIVE_SCAN</td>

9078

<td align="center">AF_TRIGGER</td>

9079

<td align="center">NOT_FOCUSED_LOCKED</td>

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

9080

<td align="center">Eventual transition if cannot find focus. Lens now locked</td>

Zhijun He

2014-01-13 16:24:31 -0800

[diff] [blame]

9081

</tr>

9082

<tr>

9083

<td align="center">PASSIVE_SCAN</td>

9084

<td align="center">AF_CANCEL</td>

9085

<td align="center">INACTIVE</td>

9086

<td align="center">Reset lens position, Lens now locked</td>

9087

</tr>

9088

<tr>

9089

<td align="center">PASSIVE_FOCUSED</td>

9090

<td align="center">Camera device initiates new scan</td>

9091

<td align="center">PASSIVE_SCAN</td>

9092

<td align="center">Start AF scan, Lens now moving</td>

9093

</tr>

9094

<tr>

9095

<td align="center">PASSIVE_UNFOCUSED</td>

9096

<td align="center">Camera device initiates new scan</td>

9097

<td align="center">PASSIVE_SCAN</td>

9098

<td align="center">Start AF scan, Lens now moving</td>

9099

</tr>

9100

<tr>

9101

<td align="center">PASSIVE_FOCUSED</td>

9102

<td align="center">AF_TRIGGER</td>

9103

<td align="center">FOCUSED_LOCKED</td>

9104

<td align="center">Immediate trans. Lens now locked</td>

9105

</tr>

9106

<tr>

9107

<td align="center">PASSIVE_UNFOCUSED</td>

9108

<td align="center">AF_TRIGGER</td>

9109

<td align="center">NOT_FOCUSED_LOCKED</td>

9110

<td align="center">Immediate trans. Lens now locked</td>

9111

</tr>

9112

<tr>

9113

<td align="center">FOCUSED_LOCKED</td>

9114

<td align="center">AF_TRIGGER</td>

9115

<td align="center">FOCUSED_LOCKED</td>

9116

<td align="center">No effect</td>

9117

</tr>

9118

<tr>

9119

<td align="center">FOCUSED_LOCKED</td>

9120

<td align="center">AF_CANCEL</td>

9121

<td align="center">INACTIVE</td>

9122

<td align="center">Restart AF scan</td>

9123

</tr>

9124

<tr>

9125

<td align="center">NOT_FOCUSED_LOCKED</td>

9126

<td align="center">AF_TRIGGER</td>

9127

<td align="center">NOT_FOCUSED_LOCKED</td>

9128

<td align="center">No effect</td>

9129

</tr>

9130

<tr>

9131

<td align="center">NOT_FOCUSED_LOCKED</td>

9132

<td align="center">AF_CANCEL</td>

9133

<td align="center">INACTIVE</td>

9134

<td align="center">Restart AF scan</td>

9135

</tr>

9136

</tbody>

9137

</table>

Zhijun He

2014-02-11 17:18:29 -0800

[diff] [blame]

9138

When switch between AF_MODE_CONTINUOUS_* (CAF modes) and AF_MODE_AUTO/AF_MODE_MACRO

9139

(AUTO modes), the initial INACTIVE or PASSIVE_SCAN states may be skipped by the

9140

camera device. When a trigger is included in a mode switch request, the trigger

9141

will be evaluated in the context of the new mode in the request.

9142

See below table for examples:

<table>

<thead>

<tr>

<th align="center">State</th>

9147

<th align="center">Transition Cause</th>

9148

<th align="center">New State</th>

9149

<th align="center">Notes</th>

</tr>

</thead>

<tbody>

<tr>

<td align="center">any state</td>

9155

<td align="center">CAF-->AUTO mode switch</td>

9156

<td align="center">INACTIVE</td>

9157

<td align="center">Mode switch without trigger, initial state must be INACTIVE</td>

9158

</tr>

9159

<tr>

9160

<td align="center">any state</td>

9161

<td align="center">CAF-->AUTO mode switch with AF_TRIGGER</td>

9162

<td align="center">trigger-reachable states from INACTIVE</td>

9163

<td align="center">Mode switch with trigger, INACTIVE is skipped</td>

9164

</tr>

9165

<tr>

9166

<td align="center">any state</td>

9167

<td align="center">AUTO-->CAF mode switch</td>

9168

<td align="center">passively reachable states from INACTIVE</td>

9169

<td align="center">Mode switch without trigger, passive transient state is skipped</td>

9170

</tr>

9171

</tbody>

9172

</table>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

9173

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

9174

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

9175

9176

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

9177

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

9178

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

9182

<td class="entry_name

9183

entry_name_deprecated

9184

" rowspan="3">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

9185

android.control.afTriggerId

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

9186

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

9187

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

9188

int32

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

9189

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

[system]

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

9193

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

9194

[deprecated]

9195

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

9196

9197

9198

</td>

9199

9200

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

9201

The ID sent with the latest

9202

CAMERA2_TRIGGER_AUTOFOCUS call

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

9209

Deprecated. Do not use.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

9210

</td>

9211

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

9221

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

9222

</tr>

9223

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

9224

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

9225

Must be 0 if no CAMERA2_TRIGGER_AUTOFOCUS trigger

9226

received yet by HAL. Always updated even if AF algorithm

9227

ignores the trigger

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

9228

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

9229

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

9230

9231

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

9232

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

9233

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

9234

9235

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

9236

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

9237

<td class="entry_name

9238

" rowspan="3">

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

9239

android.control.awbLock

</td>

byte

[public as boolean]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

9246

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

9247

[legacy]

9248

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

9249

9250

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

9251

9252

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

9253

OFF (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

9254

Auto-white balance lock is disabled; the AWB

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

9255

algorithm is free to update its parameters if in AUTO

9256

mode.

9257

</li>

9258

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

9259

ON (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

9260

Auto-white balance lock is enabled; the AWB

9261

algorithm will not update its parameters while the lock

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

is active.

</li>

</ul>

</td>

9267

9268

Eino-Ville Talvala

2014-06-06 14:35:41 -0700

[diff] [blame]

9269

Whether auto-white balance (AWB) is currently locked to its

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

9270

latest calculated values.

</td>

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

</ul>

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

9291

<th class="th_details" colspan="6">Details</th>

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

9292

</tr>

9293

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

9294

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

9295

When set to <code>true</code> (ON), the AWB algorithm is locked to its latest parameters,

9296

and will not change color balance settings until the lock is set to <code>false</code> (OFF).

9297

Since the camera device has a pipeline of in-flight requests, the settings that

9298

get locked do not necessarily correspond to the settings that were present in the

9299

latest capture result received from the camera device, since additional captures

9300

and AWB updates may have occurred even before the result was sent out. If an

9301

application is switching between automatic and manual control and wishes to eliminate

9302

any flicker during the switch, the following procedure is recommended:

9303

<ol>

9304

<li>Starting in auto-AWB mode:</li>

9305

9306

<li>Wait for the first result to be output that has the AWB locked</li>

9307

<li>Copy AWB settings from that result into a request, set the request to manual AWB</li>

9308

<li>Submit the capture request, proceed to run manual AWB as desired.</li>

9309

</ol>

9310

Note that AWB lock is only meaningful when

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

9311

<a href="#controls_android.control.awbMode">android.control.awbMode</a> is in the AUTO mode; in other modes,

9312

AWB is already fixed to a specific setting.

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

9313

Some LEGACY devices may not support ON; the value is then overridden to OFF.

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

9318

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

9319

9320

9321

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

9322

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

9323

<td class="entry_name

9324

" rowspan="3">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

9325

android.control.awbMode

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

9326

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

9327

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

9328

byte

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

9329

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

9330

[public]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

9331

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

9332

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

9333

[legacy]

9334

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

9335

9336

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

9337

9338

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

9339

OFF (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

9340

The camera device's auto-white balance routine is disabled.

9341

The application-selected color transform matrix

Igor Murashkin

2014-01-15 17:05:22 -0800

[diff] [blame]

9342

(<a href="#controls_android.colorCorrection.transform">android.colorCorrection.transform</a>) and gains

9343

(<a href="#controls_android.colorCorrection.gains">android.colorCorrection.gains</a>) are used by the camera

9344

device for manual white balance control.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

9345

</li>

9346

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

9347

AUTO (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

9348

The camera device's auto-white balance routine is active.

9349

The application's values for <a href="#controls_android.colorCorrection.transform">android.colorCorrection.transform</a>

9350

and <a href="#controls_android.colorCorrection.gains">android.colorCorrection.gains</a> are ignored.

9351

For devices that support the MANUAL_POST_PROCESSING capability, the

9352

values used by the camera device for the transform and gains

9353

will be available in the capture result for this request.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

9354

</li>

9355

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

9356

INCANDESCENT (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

9357

The camera device's auto-white balance routine is disabled;

Igor Murashkin

2014-01-15 17:05:22 -0800

[diff] [blame]

9358

the camera device uses incandescent light as the assumed scene

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

9359

illumination for white balance.

9360

While the exact white balance transforms are up to the

9361

camera device, they will approximately match the CIE

9362

standard illuminant A.

9363

The application's values for <a href="#controls_android.colorCorrection.transform">android.colorCorrection.transform</a>

9364

and <a href="#controls_android.colorCorrection.gains">android.colorCorrection.gains</a> are ignored.

9365

For devices that support the MANUAL_POST_PROCESSING capability, the

9366

values used by the camera device for the transform and gains

9367

will be available in the capture result for this request.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

9368

</li>

9369

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

9370

FLUORESCENT (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

9371

The camera device's auto-white balance routine is disabled;

Igor Murashkin

2014-01-15 17:05:22 -0800

[diff] [blame]

9372

the camera device uses fluorescent light as the assumed scene

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

9373

illumination for white balance.

9374

While the exact white balance transforms are up to the

9375

camera device, they will approximately match the CIE

9376

standard illuminant F2.

9377

The application's values for <a href="#controls_android.colorCorrection.transform">android.colorCorrection.transform</a>

9378

and <a href="#controls_android.colorCorrection.gains">android.colorCorrection.gains</a> are ignored.

9379

For devices that support the MANUAL_POST_PROCESSING capability, the

9380

values used by the camera device for the transform and gains

9381

will be available in the capture result for this request.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

9382

</li>

9383

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

9384

WARM_FLUORESCENT (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

9385

The camera device's auto-white balance routine is disabled;

Igor Murashkin

2014-01-15 17:05:22 -0800

[diff] [blame]

9386

the camera device uses warm fluorescent light as the assumed scene

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

9387

illumination for white balance.

9388

While the exact white balance transforms are up to the

9389

camera device, they will approximately match the CIE

9390

standard illuminant F4.

9391

The application's values for <a href="#controls_android.colorCorrection.transform">android.colorCorrection.transform</a>

9392

and <a href="#controls_android.colorCorrection.gains">android.colorCorrection.gains</a> are ignored.

9393

For devices that support the MANUAL_POST_PROCESSING capability, the

9394

values used by the camera device for the transform and gains

9395

will be available in the capture result for this request.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

9396

</li>

9397

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

9398

DAYLIGHT (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

9399

The camera device's auto-white balance routine is disabled;

Igor Murashkin

2014-01-15 17:05:22 -0800

[diff] [blame]

9400

the camera device uses daylight light as the assumed scene

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

9401

illumination for white balance.

9402

While the exact white balance transforms are up to the

9403

camera device, they will approximately match the CIE

9404

standard illuminant D65.

9405

The application's values for <a href="#controls_android.colorCorrection.transform">android.colorCorrection.transform</a>

9406

and <a href="#controls_android.colorCorrection.gains">android.colorCorrection.gains</a> are ignored.

9407

For devices that support the MANUAL_POST_PROCESSING capability, the

9408

values used by the camera device for the transform and gains

9409

will be available in the capture result for this request.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

9410

</li>

9411

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

9412

CLOUDY_DAYLIGHT (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

9413

The camera device's auto-white balance routine is disabled;

Igor Murashkin

2014-01-15 17:05:22 -0800

[diff] [blame]

9414

the camera device uses cloudy daylight light as the assumed scene

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

9415

illumination for white balance.

9416

The application's values for <a href="#controls_android.colorCorrection.transform">android.colorCorrection.transform</a>

9417

and <a href="#controls_android.colorCorrection.gains">android.colorCorrection.gains</a> are ignored.

9418

For devices that support the MANUAL_POST_PROCESSING capability, the

9419

values used by the camera device for the transform and gains

9420

will be available in the capture result for this request.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

9421

</li>

9422

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

9423

TWILIGHT (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

9424

The camera device's auto-white balance routine is disabled;

Igor Murashkin

2014-01-15 17:05:22 -0800

[diff] [blame]

9425

the camera device uses twilight light as the assumed scene

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

9426

illumination for white balance.

9427

The application's values for <a href="#controls_android.colorCorrection.transform">android.colorCorrection.transform</a>

9428

and <a href="#controls_android.colorCorrection.gains">android.colorCorrection.gains</a> are ignored.

9429

For devices that support the MANUAL_POST_PROCESSING capability, the

9430

values used by the camera device for the transform and gains

9431

will be available in the capture result for this request.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

9432

</li>

9433

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

9434

SHADE (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

9435

The camera device's auto-white balance routine is disabled;

Igor Murashkin

2014-01-15 17:05:22 -0800

[diff] [blame]

9436

the camera device uses shade light as the assumed scene

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

9437

illumination for white balance.

9438

The application's values for <a href="#controls_android.colorCorrection.transform">android.colorCorrection.transform</a>

9439

and <a href="#controls_android.colorCorrection.gains">android.colorCorrection.gains</a> are ignored.

9440

For devices that support the MANUAL_POST_PROCESSING capability, the

9441

values used by the camera device for the transform and gains

9442

will be available in the capture result for this request.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</li>

</ul>

</td>

9447

9448

Eino-Ville Talvala

2014-06-06 14:35:41 -0700

[diff] [blame]

9449

Whether auto-white balance (AWB) is currently setting the color

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

9450

transform fields, and what its illumination target

Zhijun He

2014-02-24 09:49:37 -0800

[diff] [blame]

9451

is.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

Zhijun He

2014-01-14 16:30:31 -0800

[diff] [blame]

9458

<a href="#static_android.control.awbAvailableModes">android.control.awbAvailableModes</a>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

9459

</td>

9460

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

9465

Igor Murashkin

2012-12-05 14:49:11 -0800

[diff] [blame]

9466

9467

Igor Murashkin

2012-12-05 14:49:11 -0800

[diff] [blame]

9468

</ul>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

9469

</td>

9470

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

9471

</tr>

9472

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

9473

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

9474

</tr>

9475

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

9476

Zhijun He

2014-01-14 16:30:31 -0800

[diff] [blame]

9477

This control is only effective if <a href="#controls_android.control.mode">android.control.mode</a> is AUTO.

Jayant Chowdhary

62a9193

2021-01-06 16:56:26 -0800

[diff] [blame]

9478

When set to the AUTO mode, the camera device's auto-white balance

Zhijun He

2014-01-14 16:30:31 -0800

[diff] [blame]

9479

routine is enabled, overriding the application's selected

9480

<a href="#controls_android.colorCorrection.transform">android.colorCorrection.transform</a>, <a href="#controls_android.colorCorrection.gains">android.colorCorrection.gains</a> and

Yin-Chia Yeh

2014-11-12 11:38:10 -0800

[diff] [blame]

9481

<a href="#controls_android.colorCorrection.mode">android.colorCorrection.mode</a>. Note that when <a href="#controls_android.control.aeMode">android.control.aeMode</a>

Shuzhen Wang

2022-05-03 11:01:26 -0700

[diff] [blame]

9482

is OFF, the behavior of AWB is device dependent. It is recommended to

Yin-Chia Yeh

2014-11-12 11:38:10 -0800

[diff] [blame]

9483

also set AWB mode to OFF or lock AWB by using <a href="#controls_android.control.awbLock">android.control.awbLock</a> before

9484

setting AE mode to OFF.

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

9485

When set to the OFF mode, the camera device's auto-white balance

Zhijun He

2014-02-24 09:49:37 -0800

[diff] [blame]

9486

routine is disabled. The application manually controls the white

Eino-Ville Talvala

2014-02-10 12:39:35 -0800

[diff] [blame]

9487

balance by <a href="#controls_android.colorCorrection.transform">android.colorCorrection.transform</a>, <a href="#controls_android.colorCorrection.gains">android.colorCorrection.gains</a>

Zhijun He

2014-01-14 16:30:31 -0800

[diff] [blame]

9488

and <a href="#controls_android.colorCorrection.mode">android.colorCorrection.mode</a>.

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

9489

When set to any other modes, the camera device's auto-white

9490

balance routine is disabled. The camera device uses each

9491

particular illumination target for white balance

9492

adjustment. The application's values for

9493

<a href="#controls_android.colorCorrection.transform">android.colorCorrection.transform</a>,

9494

<a href="#controls_android.colorCorrection.gains">android.colorCorrection.gains</a> and

9495

<a href="#controls_android.colorCorrection.mode">android.colorCorrection.mode</a> are ignored.

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

9496

</td>

9497

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

9498

9499

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

9500

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

9501

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

9505

<td class="entry_name

Yin-Chia Yeh

2014-05-16 15:13:13 -0700

[diff] [blame]

9506

" rowspan="5">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

9507

android.control.awbRegions

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

9508

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

9509

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

9510

int32

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

x

5 x area_count

Yin-Chia Yeh

2014-05-16 15:13:13 -0700

[diff] [blame]

9516

[public as meteringRectangle]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

9517

9518

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

9522

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

9523

</td>

9524

9525

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

9526

List of metering areas to use for auto-white-balance illuminant

Ruben Brunk

76e4c7d

2014-01-31 11:05:30 -0800

[diff] [blame]

9527

estimation.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Yin-Chia Yeh

2018-06-15 15:35:05 -0700

[diff] [blame]

9531

Pixel coordinates within android.sensor.info.activeArraySize or

9532

android.sensor.info.preCorrectionActiveArraySize depending on

9533

distortion correction capability and mode

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

9537

Coordinates must be between <code>[(0,0), (width, height))</code> of

Yin-Chia Yeh

2018-06-15 15:35:05 -0700

[diff] [blame]

9538

<a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a> or <a href="#static_android.sensor.info.preCorrectionActiveArraySize">android.sensor.info.preCorrectionActiveArraySize</a>

9539

depending on distortion correction capability and mode

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

9540

</td>

9541

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

</ul>

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

9554

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

9555

</tr>

9556

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

9557

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

9558

Not available if <a href="#static_android.control.maxRegionsAwb">android.control.maxRegionsAwb</a> is 0.

Yin-Chia Yeh

2014-09-04 09:33:34 -0700

[diff] [blame]

9559

Otherwise will always be present.

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

9560

The maximum number of regions supported by the device is determined by the value

9561

of <a href="#static_android.control.maxRegionsAwb">android.control.maxRegionsAwb</a>.

Yin-Chia Yeh

2018-06-15 15:35:05 -0700

[diff] [blame]

9562

For devices not supporting <a href="#controls_android.distortionCorrection.mode">android.distortionCorrection.mode</a> control, the coordinate

9563

system always follows that of <a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a>, with (0,0) being

9564

the top-left pixel in the active pixel array, and

Eino-Ville Talvala

2014-01-02 16:11:44 -0800

[diff] [blame]

9565

(<a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a>.width - 1,

Yin-Chia Yeh

2018-06-15 15:35:05 -0700

[diff] [blame]

9566

<a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a>.height - 1) being the bottom-right pixel in the

9567

active pixel array.

9568

For devices supporting <a href="#controls_android.distortionCorrection.mode">android.distortionCorrection.mode</a> control, the coordinate

9569

system depends on the mode being set.

9570

When the distortion correction mode is OFF, the coordinate system follows

9571

<a href="#static_android.sensor.info.preCorrectionActiveArraySize">android.sensor.info.preCorrectionActiveArraySize</a>, with

9572

<code>(0, 0)</code> being the top-left pixel of the pre-correction active array, and

9573

(<a href="#static_android.sensor.info.preCorrectionActiveArraySize">android.sensor.info.preCorrectionActiveArraySize</a>.width - 1,

9574

<a href="#static_android.sensor.info.preCorrectionActiveArraySize">android.sensor.info.preCorrectionActiveArraySize</a>.height - 1) being the bottom-right

9575

pixel in the pre-correction active pixel array.

9576

When the distortion correction mode is not OFF, the coordinate system follows

9577

<a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a>, with

9578

<code>(0, 0)</code> being the top-left pixel of the active array, and

9579

(<a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a>.width - 1,

9580

<a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a>.height - 1) being the bottom-right pixel in the

9581

active pixel array.

Yin-Chia Yeh

2014-05-14 14:05:20 -0700

[diff] [blame]

9582

The weight must range from 0 to 1000, and represents a weight

9583

for every pixel in the area. This means that a large metering area

9584

with the same weight as a smaller area will have more effect in

9585

the metering result. Metering areas can partially overlap and the

9586

camera device will add the weights in the overlap region.

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

9587

The weights are relative to weights of other white balance metering regions, so if

9588

only one region is used, all non-zero weights will have the same effect. A region with

9589

0 weight is ignored.

9590

If all regions have 0 weight, then no specific metering area needs to be used by the

9591

camera device.

9592

If the metering region is outside the used <a href="#controls_android.scaler.cropRegion">android.scaler.cropRegion</a> returned in

9593

capture result metadata, the camera device will ignore the sections outside the crop

9594

region and output only the intersection rectangle as the metering region in the result

9595

metadata. If the region is entirely outside the crop region, it will be ignored and

9596

not reported in the result metadata.

Shuzhen Wang

2022-03-28 12:41:41 -0700

[diff] [blame]

9597

When setting the AWB metering regions, the application must consider the additional

9598

crop resulted from the aspect ratio differences between the preview stream and

9599

<a href="#controls_android.scaler.cropRegion">android.scaler.cropRegion</a>. For example, if the <a href="#controls_android.scaler.cropRegion">android.scaler.cropRegion</a> is the full

9600

active array size with 4:3 aspect ratio, and the preview stream is 16:9,

9601

the boundary of AWB regions will be [0, y_crop] and

9602

[active_width, active_height - 2 * y_crop] rather than [0, 0] and

9603

[active_width, active_height], where y_crop is the additional crop due to aspect ratio

9604

mismatch.

Shuzhen Wang

2019-11-07 15:59:22 -0800

[diff] [blame]

9605

Starting from API level 30, the coordinate system of activeArraySize or

9606

preCorrectionActiveArraySize is used to represent post-zoomRatio field of view, not

9607

pre-zoom field of view. This means that the same awbRegions values at different

9608

<a href="#controls_android.control.zoomRatio">android.control.zoomRatio</a> represent different parts of the scene. The awbRegions

9609

coordinates are relative to the activeArray/preCorrectionActiveArray representing the

9610

zoomed field of view. If <a href="#controls_android.control.zoomRatio">android.control.zoomRatio</a> is set to 1.0 (default), the same

9611

awbRegions at different <a href="#controls_android.scaler.cropRegion">android.scaler.cropRegion</a> still represent the same parts of

9612

the scene as they do before. See <a href="#controls_android.control.zoomRatio">android.control.zoomRatio</a> for details. Whether to use

9613

activeArraySize or preCorrectionActiveArraySize still depends on distortion correction

9614

mode.

Jayant Chowdhary

2020-11-09 09:08:31 -0800

[diff] [blame]

9615

For camera devices with the

9616

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraMetadata.html#REQUEST_AVAILABLE_CAPABILITIES_ULTRA_HIGH_RESOLUTION_SENSOR">CameraMetadata#REQUEST_AVAILABLE_CAPABILITIES_ULTRA_HIGH_RESOLUTION_SENSOR</a>

9617

capability, <a href="#static_android.sensor.info.activeArraySizeMaximumResolution">android.sensor.info.activeArraySizeMaximumResolution</a> /

9618

<a href="#static_android.sensor.info.preCorrectionActiveArraySizeMaximumResolution">android.sensor.info.preCorrectionActiveArraySizeMaximumResolution</a> must be used as the

9619

coordinate system for requests where <a href="#controls_android.sensor.pixelMode">android.sensor.pixelMode</a> is set to

9620

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraMetadata.html#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION">CameraMetadata#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION</a>.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

9621

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

9622

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

9623

Yin-Chia Yeh

2014-05-16 15:13:13 -0700

[diff] [blame]

9624

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

9625

<th class="th_details" colspan="6">HAL Implementation Details</th>

Yin-Chia Yeh

2014-05-16 15:13:13 -0700

[diff] [blame]

9626

</tr>

9627

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

9628

Yin-Chia Yeh

2014-05-16 15:13:13 -0700

[diff] [blame]

9629

The HAL level representation of MeteringRectangle[] is a

9630

int[5 * area_count].

9631

Every five elements represent a metering region of

9632

(xmin, ymin, xmax, ymax, weight).

9633

The rectangle is defined to be inclusive on xmin and ymin, but

Yin-Chia Yeh

2018-06-15 15:35:05 -0700

[diff] [blame]

9634

exclusive on xmax and ymax.

9635

HAL must always report metering regions in the coordinate system of pre-correction

9636

active array.

Yin-Chia Yeh

2014-05-16 15:13:13 -0700

[diff] [blame]

9637

</td>

9638

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

9639

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

9640

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

9641

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

9642

9643

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

9644

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

9645

<td class="entry_name

9646

" rowspan="3">

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

9647

android.control.captureIntent

</td>

byte

[public]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

9654

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

9655

[legacy]

9656

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

9657

9658

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

9659

9660

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

9661

CUSTOM (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

9662

The goal of this request doesn't fall into the other

9663

categories. The camera device will default to preview-like

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

9664

behavior.

9665

</li>

9666

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

9667

PREVIEW (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

9668

This request is for a preview-like use case.

9669

The precapture trigger may be used to start off a metering

9670

w/flash sequence.

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

9671

</li>

9672

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

9673

STILL_CAPTURE (v3.2)

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

9674

This request is for a still capture-type

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

9675

use case.

9676

If the flash unit is under automatic control, it may fire as needed.

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

9677

</li>

9678

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

9679

VIDEO_RECORD (v3.2)

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

9680

This request is for a video recording

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

9681

use case.

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

9682

</li>

9683

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

9684

VIDEO_SNAPSHOT (v3.2)

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

9685

This request is for a video snapshot (still

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

9686

image while recording video) use case.

9687

The camera device should take the highest-quality image

9688

possible (given the other settings) without disrupting the

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

9689

frame rate of video recording.

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

9690

</li>

9691

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

9692

ZERO_SHUTTER_LAG (v3.2)

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

9693

This request is for a ZSL usecase; the

9694

application will stream full-resolution images and

9695

reprocess one or several later for a final

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

9696

capture.

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

9697

</li>

9698

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

9699

MANUAL (v3.2)

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

9700

This request is for manual capture use case where

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

9701

the applications want to directly control the capture parameters.

9702

For example, the application may wish to manually control

9703

<a href="#controls_android.sensor.exposureTime">android.sensor.exposureTime</a>, <a href="#controls_android.sensor.sensitivity">android.sensor.sensitivity</a>, etc.

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

9704

</li>

Eino-Ville Talvala

2017-12-07 13:12:11 -0800

[diff] [blame]

9705

<li>

9706

MOTION_TRACKING (v3.3)

9707

This request is for a motion tracking use case, where

9708

the application will use camera and inertial sensor data to

9709

locate and track objects in the world.

9710

The camera device auto-exposure routine will limit the exposure time

9711

of the camera to no more than 20 milliseconds, to minimize motion blur.

9712

</li>

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

9713

</ul>

9714

9715

</td>

9716

9717

9718

Information to the camera device 3A (auto-exposure,

9719

auto-focus, auto-white balance) routines about the purpose

9720

of this capture, to help the camera device to decide optimal 3A

strategy.

</td>

</td>

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

9728

</td>

9729

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

</ul>

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

9742

<th class="th_details" colspan="6">Details</th>

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

9743

</tr>

9744

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

9745

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

9746

This control (except for MANUAL) is only effective if

9747

<code><a href="#controls_android.control.mode">android.control.mode</a> != OFF</code> and any 3A routine is active.

Shuzhen Wang

2022-05-03 11:01:26 -0700

[diff] [blame]

9748

All intents are supported by all devices, except that:

9749

<ul>

9750

<li>ZERO_SHUTTER_LAG will be supported if <a href="#static_android.request.availableCapabilities">android.request.availableCapabilities</a> contains

9751

PRIVATE_REPROCESSING or YUV_REPROCESSING.</li>

9752

<li>MANUAL will be supported if <a href="#static_android.request.availableCapabilities">android.request.availableCapabilities</a> contains

9753

MANUAL_SENSOR.</li>

9754

<li>MOTION_TRACKING will be supported if <a href="#static_android.request.availableCapabilities">android.request.availableCapabilities</a> contains

9755

MOTION_TRACKING.</li>

9756

</ul>

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

9761

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

9762

9763

9764

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

9765

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

9766

<td class="entry_name

9767

" rowspan="3">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

9768

android.control.awbState

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

9769

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

9770

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

9771

byte

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

9772

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

9773

[public]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

9774

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

9775

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

9776

[limited]

9777

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

9778

9779

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

9780

9781

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

9782

INACTIVE (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

9783

AWB is not in auto mode, or has not yet started metering.

9784

When a camera device is opened, it starts in this

9785

state. This is a transient state, the camera device may

9786

skip reporting this state in capture

9787

result.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

9788

</li>

9789

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

9790

SEARCHING (v3.2)

Igor Murashkin

2014-01-15 17:05:22 -0800

[diff] [blame]

9791

AWB doesn't yet have a good set of control

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

9792

values for the current scene.

9793

This is a transient state, the camera device

Zhijun He

2014-02-11 17:18:29 -0800

[diff] [blame]

9794

may skip reporting this state in capture result.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

9795

</li>

9796

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

9797

CONVERGED (v3.2)

Igor Murashkin

2014-01-15 17:05:22 -0800

[diff] [blame]

9798

AWB has a good set of control values for the

Zhijun He

2014-01-13 16:24:31 -0800

[diff] [blame]

9799

current scene.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

9800

</li>

9801

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

9802

LOCKED (v3.2)

Zhijun He

2014-01-13 16:24:31 -0800

[diff] [blame]

9803

AWB has been locked.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</li>

</ul>

</td>

9808

9809

Eino-Ville Talvala

2014-06-06 14:35:41 -0700

[diff] [blame]

9810

Current state of auto-white balance (AWB) algorithm.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

9828

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

9829

</tr>

9830

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

9831

Zhijun He

2014-01-13 16:24:31 -0800

[diff] [blame]

9832

Switching between or enabling AWB modes (<a href="#controls_android.control.awbMode">android.control.awbMode</a>) always

9833

resets the AWB state to INACTIVE. Similarly, switching between <a href="#controls_android.control.mode">android.control.mode</a>,

9834

or <a href="#controls_android.control.sceneMode">android.control.sceneMode</a> if <code><a href="#controls_android.control.mode">android.control.mode</a> == USE_SCENE_MODE</code> resets all

9835

the algorithm states to INACTIVE.

9836

The camera device can do several state transitions between two results, if it is

9837

allowed by the state transition table. So INACTIVE may never actually be seen in

9838

a result.

9839

The state in the result is the state for this image (in sync with this image): if

9840

AWB state becomes CONVERGED, then the image data associated with this result should

9841

be good to use.

9842

Below are state transition tables for different AWB modes.

9843

When <code><a href="#controls_android.control.awbMode">android.control.awbMode</a> != AWB_MODE_AUTO</code>:

<table>

<thead>

<tr>

<th align="center">State</th>

9848

<th align="center">Transition Cause</th>

9849

<th align="center">New State</th>

9850

<th align="center">Notes</th>

</tr>

</thead>

<tbody>

<tr>

<td align="center">INACTIVE</td>

9856

9857

<td align="center">INACTIVE</td>

9858

<td align="center">Camera device auto white balance algorithm is disabled</td>

</tr>

</tbody>

</table>

When <a href="#controls_android.control.awbMode">android.control.awbMode</a> is AWB_MODE_AUTO:

<table>

<thead>

<tr>

<th align="center">State</th>

9867

<th align="center">Transition Cause</th>

9868

<th align="center">New State</th>

9869

<th align="center">Notes</th>

</tr>

</thead>

<tbody>

<tr>

<td align="center">INACTIVE</td>

9875

<td align="center">Camera device initiates AWB scan</td>

9876

<td align="center">SEARCHING</td>

9877

<td align="center">Values changing</td>

9878

</tr>

9879

<tr>

9880

<td align="center">INACTIVE</td>

9881

<td align="center"><a href="#controls_android.control.awbLock">android.control.awbLock</a> is ON</td>

9882

<td align="center">LOCKED</td>

9883

<td align="center">Values locked</td>

9884

</tr>

9885

<tr>

9886

<td align="center">SEARCHING</td>

9887

<td align="center">Camera device finishes AWB scan</td>

9888

<td align="center">CONVERGED</td>

9889

<td align="center">Good values, not changing</td>

9890

</tr>

9891

<tr>

9892

<td align="center">SEARCHING</td>

9893

<td align="center"><a href="#controls_android.control.awbLock">android.control.awbLock</a> is ON</td>

9894

<td align="center">LOCKED</td>

9895

<td align="center">Values locked</td>

9896

</tr>

9897

<tr>

9898

<td align="center">CONVERGED</td>

9899

<td align="center">Camera device initiates AWB scan</td>

9900

<td align="center">SEARCHING</td>

9901

<td align="center">Values changing</td>

9902

</tr>

9903

<tr>

9904

<td align="center">CONVERGED</td>

9905

<td align="center"><a href="#controls_android.control.awbLock">android.control.awbLock</a> is ON</td>

9906

<td align="center">LOCKED</td>

9907

<td align="center">Values locked</td>

9908

</tr>

9909

<tr>

9910

<td align="center">LOCKED</td>

9911

<td align="center"><a href="#controls_android.control.awbLock">android.control.awbLock</a> is OFF</td>

9912

<td align="center">SEARCHING</td>

9913

<td align="center">Values not good after unlock</td>

9914

</tr>

Zhijun He

2014-02-11 17:18:29 -0800

[diff] [blame]

9915

</tbody>

9916

</table>

9917

For the above table, the camera device may skip reporting any state changes that happen

9918

without application intervention (i.e. mode switch, trigger, locking). Any state that

9919

can be skipped in that manner is called a transient state.

9920

For example, for this AWB mode (AWB_MODE_AUTO), in addition to the state transitions

9921

listed in above table, it is also legal for the camera device to skip one or more

9922

transient states between two results. See below table for examples:

<table>

<thead>

<tr>

<th align="center">State</th>

9927

<th align="center">Transition Cause</th>

9928

<th align="center">New State</th>

9929

<th align="center">Notes</th>

</tr>

</thead>

<tbody>

<tr>

<td align="center">INACTIVE</td>

9935

<td align="center">Camera device finished AWB scan</td>

9936

<td align="center">CONVERGED</td>

9937

<td align="center">Values are already good, transient states are skipped by camera device.</td>

9938

</tr>

Zhijun He

2014-01-13 16:24:31 -0800

[diff] [blame]

9939

<tr>

9940

<td align="center">LOCKED</td>

9941

<td align="center"><a href="#controls_android.control.awbLock">android.control.awbLock</a> is OFF</td>

9942

<td align="center">CONVERGED</td>

Zhijun He

2014-02-11 17:18:29 -0800

[diff] [blame]

9943

<td align="center">Values good after unlock, transient states are skipped by camera device.</td>

Zhijun He

2014-01-13 16:24:31 -0800

[diff] [blame]

9944

</tr>

9945

</tbody>

9946

</table>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

9947

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

9948

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

9949

9950

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

9951

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

9952

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

9953

9954

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

9955

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

9956

<td class="entry_name

9957

" rowspan="3">

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

9958

android.control.effectMode

</td>

byte

[public]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

9965

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

9966

[legacy]

9967

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

9968

9969

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

9970

9971

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

9972

OFF (v3.2)

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

9973

No color effect will be applied.

9974

</li>

9975

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

9976

MONO (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

9977

[optional]

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

9978

A "monocolor" effect where the image is mapped into

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

9979

a single color.

9980

This will typically be grayscale.

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

9981

</li>

9982

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

9983

NEGATIVE (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

9984

[optional]

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

9985

A "photo-negative" effect where the image's colors

9986

are inverted.

9987

</li>

9988

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

9989

SOLARIZE (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

9990

[optional]

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

9991

A "solarisation" effect (Sabattier effect) where the

9992

image is wholly or partially reversed in

9993

tone.

9994

</li>

9995

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

9996

SEPIA (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

9997

[optional]

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

9998

A "sepia" effect where the image is mapped into warm

9999

gray, red, and brown tones.

10000

</li>

10001

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

10002

POSTERIZE (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

10003

[optional]

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

10004

A "posterization" effect where the image uses

10005

discrete regions of tone rather than a continuous

10006

gradient of tones.

10007

</li>

10008

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

10009

WHITEBOARD (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

10010

[optional]

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

10011

A "whiteboard" effect where the image is typically displayed

10012

as regions of white, with black or grey details.

10013

</li>

10014

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

10015

BLACKBOARD (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

10016

[optional]

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

10017

A "blackboard" effect where the image is typically displayed

10018

as regions of black, with white or grey details.

10019

</li>

10020

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

10021

AQUA (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

10022

[optional]

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

10023

An "aqua" effect where a blue hue is added to the image.

</li>

</ul>

</td>

10028

10029

10030

A special color effect to apply.

</td>

</td>

<a href="#static_android.control.availableEffects">android.control.availableEffects</a>

10038

</td>

10039

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

</ul>

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

10052

<th class="th_details" colspan="6">Details</th>

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

10053

</tr>

10054

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

10055

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

10056

When this mode is set, a color effect will be applied

10057

to images produced by the camera device. The interpretation

10058

and implementation of these color effects is left to the

10059

implementor of the camera device, and should not be

10060

depended on to be consistent (or present) across all

10061

devices.

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

10066

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

10067

10068

10069

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

10070

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

10071

<td class="entry_name

10072

" rowspan="3">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

10073

android.control.mode

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

10074

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

10075

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

10076

byte

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

10077

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

10078

[public]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

10079

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

10080

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

10081

[legacy]

10082

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

10083

10084

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

10085

10086

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

10087

OFF (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

10088

Full application control of pipeline.

10089

All control by the device's metering and focusing (3A)

10090

routines is disabled, and no other settings in

10091

android.control.* have any effect, except that

10092

<a href="#controls_android.control.captureIntent">android.control.captureIntent</a> may be used by the camera

10093

device to select post-processing values for processing

10094

blocks that do not allow for manual control, or are not

10095

exposed by the camera API.

10096

However, the camera device's 3A routines may continue to

10097

collect statistics and update their internal state so that

10098

when control is switched to AUTO mode, good control values

10099

can be immediately applied.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

10100

</li>

10101

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

10102

AUTO (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

10103

Use settings for each individual 3A routine.

10104

Manual control of capture parameters is disabled. All

Igor Murashkin

2014-01-15 17:05:22 -0800

[diff] [blame]

10105

controls in android.control.* besides sceneMode take

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

10106

effect.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

10107

</li>

10108

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

10109

USE_SCENE_MODE (v3.2)

Yin-Chia Yeh

2015-01-28 13:18:31 -0800

[diff] [blame]

10110

[optional]

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

10111

Use a specific scene mode.

10112

Enabling this disables control.aeMode, control.awbMode and

10113

control.afMode controls; the camera device will ignore

10114

those settings while USE_SCENE_MODE is active (except for

Zhijun He

2015-06-16 19:44:18 -0700

[diff] [blame]

10115

FACE_PRIORITY scene mode). Other control entries are still active.

Eino-Ville Talvala

2015-06-24 15:17:09 -0700

[diff] [blame]

10116

This setting can only be used if scene mode is supported (i.e.

Zhijun He

2015-06-16 19:44:18 -0700

[diff] [blame]

10117

<a href="#static_android.control.availableSceneModes">android.control.availableSceneModes</a>

Shuzhen Wang

2020-03-16 11:39:27 -0700

[diff] [blame]

10118

contain some modes other than DISABLED).

10119

For extended scene modes such as BOKEH, please use USE_EXTENDED_SCENE_MODE instead.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

10120

</li>

Zhijun He

2014-02-06 00:28:22 -0800

[diff] [blame]

10121

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

10122

OFF_KEEP_STATE (v3.2)

Yin-Chia Yeh

2015-01-28 13:18:31 -0800

[diff] [blame]

10123

[optional]

Zhijun He

2014-02-06 00:28:22 -0800

[diff] [blame]

10124

Same as OFF mode, except that this capture will not be

10125

used by camera device background auto-exposure, auto-white balance and

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

10126

auto-focus algorithms (3A) to update their statistics.

10127

Specifically, the 3A routines are locked to the last

10128

values set from a request with AUTO, OFF, or

10129

USE_SCENE_MODE, and any statistics or state updates

10130

collected from manual captures with OFF_KEEP_STATE will be

10131

discarded by the camera device.

Zhijun He

2014-02-06 00:28:22 -0800

[diff] [blame]

10132

</li>

Shuzhen Wang

2020-03-16 11:39:27 -0700

[diff] [blame]

10133

<li>

10134

USE_EXTENDED_SCENE_MODE (v3.5)

10135

[optional]

10136

Use a specific extended scene mode.

10137

When extended scene mode is on, the camera device may override certain control

10138

parameters, such as targetFpsRange, AE, AWB, and AF modes, to achieve best power and

10139

quality tradeoffs. Only the mandatory stream combinations of LIMITED hardware level

10140

are guaranteed.

10141

This setting can only be used if extended scene mode is supported (i.e.

10142

android.control.availableExtendedSceneModes

10143

contains some modes other than DISABLED).

10144

</li>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

10145

</ul>

10146

10147

</td>

10148

10149

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

10150

Overall mode of 3A (auto-exposure, auto-white-balance, auto-focus) control

Zhijun He

2014-02-24 09:49:37 -0800

[diff] [blame]

10151

routines.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

Yin-Chia Yeh

2015-01-28 13:18:31 -0800

[diff] [blame]

10158

<a href="#static_android.control.availableModes">android.control.availableModes</a>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

10159

</td>

10160

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

</ul>

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

10173

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

10174

</tr>

10175

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

10176

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

10177

This is a top-level 3A control switch. When set to OFF, all 3A control

Zhijun He

2014-01-16 12:13:35 -0800

[diff] [blame]

10178

by the camera device is disabled. The application must set the fields for

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

10179

capture parameters itself.

10180

When set to AUTO, the individual algorithm controls in

Eino-Ville Talvala

2014-01-02 16:11:44 -0800

[diff] [blame]

10181

android.control.* are in effect, such as <a href="#controls_android.control.afMode">android.control.afMode</a>.

Shuzhen Wang

2020-03-16 11:39:27 -0700

[diff] [blame]

10182

When set to USE_SCENE_MODE or USE_EXTENDED_SCENE_MODE, the individual controls in

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

10183

android.control.* are mostly disabled, and the camera device

Shuzhen Wang

2020-03-16 11:39:27 -0700

[diff] [blame]

10184

implements one of the scene mode or extended scene mode settings (such as ACTION,

10185

SUNSET, PARTY, or BOKEH) as it wishes. The camera device scene mode

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

10186

3A settings are provided by <a href="https://developer.android.com/reference/android/hardware/camera2/CaptureResult.html">capture results</a>.

Zhijun He

2014-02-06 00:28:22 -0800

[diff] [blame]

10187

When set to OFF_KEEP_STATE, it is similar to OFF mode, the only difference

10188

is that this frame will not be used by camera device background 3A statistics

10189

update, as if this frame is never captured. This mode can be used in the scenario

10190

where the application doesn't want a 3A manual control capture to affect

10191

the subsequent auto 3A capture results.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

10192

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

10193

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

10194

10195

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

10196

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

10197

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

10198

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

10199

10200

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

10201

<td class="entry_name

10202

" rowspan="5">

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

10203

android.control.sceneMode

</td>

byte

[public]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

10210

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

10211

[legacy]

10212

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

10213

10214

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

10215

10216

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

10217

DISABLED (v3.2)

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

10218

0

10219

Indicates that no scene modes are set for a given capture request.

10220

</li>

10221

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

10222

FACE_PRIORITY (v3.2)

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

10223

If face detection support exists, use face

10224

detection data for auto-focus, auto-white balance, and

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

10225

auto-exposure routines.

10226

If face detection statistics are disabled

10227

(i.e. <a href="#controls_android.statistics.faceDetectMode">android.statistics.faceDetectMode</a> is set to OFF),

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

10228

this should still operate correctly (but will not return

10229

face detection statistics to the framework).

10230

Unlike the other scene modes, <a href="#controls_android.control.aeMode">android.control.aeMode</a>,

10231

<a href="#controls_android.control.awbMode">android.control.awbMode</a>, and <a href="#controls_android.control.afMode">android.control.afMode</a>

10232

remain active when FACE_PRIORITY is set.

10233

</li>

10234

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

10235

ACTION (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

10236

[optional]

10237

Optimized for photos of quickly moving objects.

10238

Similar to SPORTS.

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

10239

</li>

10240

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

10241

PORTRAIT (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

10242

[optional]

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

10243

Optimized for still photos of people.

10244

</li>

10245

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

10246

LANDSCAPE (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

10247

[optional]

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

10248

Optimized for photos of distant macroscopic objects.

10249

</li>

10250

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

10251

NIGHT (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

10252

[optional]

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

10253

Optimized for low-light settings.

10254

</li>

10255

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

10256

NIGHT_PORTRAIT (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

10257

[optional]

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

10258

Optimized for still photos of people in low-light

10259

settings.

10260

</li>

10261

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

10262

THEATRE (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

10263

[optional]

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

10264

Optimized for dim, indoor settings where flash must

10265

remain off.

10266

</li>

10267

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

10268

BEACH (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

10269

[optional]

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

10270

Optimized for bright, outdoor beach settings.

10271

</li>

10272

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

10273

SNOW (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

10274

[optional]

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

10275

Optimized for bright, outdoor settings containing snow.

10276

</li>

10277

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

10278

SUNSET (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

10279

[optional]

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

10280

Optimized for scenes of the setting sun.

10281

</li>

10282

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

10283

STEADYPHOTO (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

10284

[optional]

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

10285

Optimized to avoid blurry photos due to small amounts of

10286

device motion (for example: due to hand shake).

10287

</li>

10288

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

10289

FIREWORKS (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

10290

[optional]

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

10291

Optimized for nighttime photos of fireworks.

10292

</li>

10293

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

10294

SPORTS (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

10295

[optional]

10296

Optimized for photos of quickly moving people.

10297

Similar to ACTION.

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

10298

</li>

10299

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

10300

PARTY (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

10301

[optional]

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

10302

Optimized for dim, indoor settings with multiple moving

10303

people.

10304

</li>

10305

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

10306

CANDLELIGHT (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

10307

[optional]

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

10308

Optimized for dim settings where the main light source

Shuzhen Wang

36ad880

2018-10-10 17:58:13 -0700

[diff] [blame]

10309

is a candle.

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

10310

</li>

10311

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

10312

BARCODE (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

10313

[optional]

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

10314

Optimized for accurately capturing a photo of barcode

10315

for use by camera applications that wish to read the

10316

barcode value.

10317

</li>

Zhijun He

2014-06-10 18:21:34 -0700

[diff] [blame]

10318

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

10319

HIGH_SPEED_VIDEO (v3.2)

Zhijun He

2015-05-22 17:04:15 -0700

[diff] [blame]

10320

[deprecated]

Zhijun He

2014-06-10 18:21:34 -0700

[diff] [blame]

10321

[optional]

Eino-Ville Talvala

2021-05-27 14:43:59 -0700

[diff] [blame]

10322

[java_public]

Eino-Ville Talvala

2015-06-30 13:32:09 -0700

[diff] [blame]

10323

This is deprecated, please use <a href="https://developer.android.com/reference/android/hardware/camera2/CameraDevice.html#createConstrainedHighSpeedCaptureSession">CameraDevice#createConstrainedHighSpeedCaptureSession</a>

10324

and <a href="https://developer.android.com/reference/android/hardware/camera2/CameraConstrainedHighSpeedCaptureSession.html#createHighSpeedRequestList">CameraConstrainedHighSpeedCaptureSession#createHighSpeedRequestList</a>

Zhijun He

2015-05-22 17:04:15 -0700

[diff] [blame]

10325

for high speed video recording.

10326

Optimized for high speed video recording (frame rate >=60fps) use case.

Zhijun He

2014-06-10 18:21:34 -0700

[diff] [blame]

10327

The supported high speed video sizes and fps ranges are specified in

10328

<a href="#static_android.control.availableHighSpeedVideoConfigurations">android.control.availableHighSpeedVideoConfigurations</a>. To get desired

10329

output frame rates, the application is only allowed to select video size

10330

and fps range combinations listed in this static metadata. The fps range

10331

can be control via <a href="#controls_android.control.aeTargetFpsRange">android.control.aeTargetFpsRange</a>.

10332

In this mode, the camera device will override aeMode, awbMode, and afMode to

10333

ON, ON, and CONTINUOUS_VIDEO, respectively. All post-processing block mode

10334

controls will be overridden to be FAST. Therefore, no manual control of capture

10335

and post-processing parameters is possible. All other controls operate the

10336

same as when <a href="#controls_android.control.mode">android.control.mode</a> == AUTO. This means that all other

10337

android.control.* fields continue to work, such as

10338

<ul>

10339

<li><a href="#controls_android.control.aeTargetFpsRange">android.control.aeTargetFpsRange</a></li>

10340

<li><a href="#controls_android.control.aeExposureCompensation">android.control.aeExposureCompensation</a></li>

10341

<li><a href="#controls_android.control.aeLock">android.control.aeLock</a></li>

10342

<li><a href="#controls_android.control.awbLock">android.control.awbLock</a></li>

10343

<li><a href="#controls_android.control.effectMode">android.control.effectMode</a></li>

10344

<li><a href="#controls_android.control.aeRegions">android.control.aeRegions</a></li>

10345

<li><a href="#controls_android.control.afRegions">android.control.afRegions</a></li>

10346

<li><a href="#controls_android.control.awbRegions">android.control.awbRegions</a></li>

10347

<li><a href="#controls_android.control.afTrigger">android.control.afTrigger</a></li>

10348

<li><a href="#controls_android.control.aePrecaptureTrigger">android.control.aePrecaptureTrigger</a></li>

Shuzhen Wang

2019-11-07 15:59:22 -0800

[diff] [blame]

10349

<li><a href="#controls_android.control.zoomRatio">android.control.zoomRatio</a></li>

Zhijun He

2014-06-10 18:21:34 -0700

[diff] [blame]

10350

</ul>

10351

Outside of android.control.*, the following controls will work:

10352

<ul>

10353

<li><a href="#controls_android.flash.mode">android.flash.mode</a> (automatic flash for still capture will not work since aeMode is ON)</li>

10354

<li><a href="#controls_android.lens.opticalStabilizationMode">android.lens.opticalStabilizationMode</a> (if it is supported)</li>

10355

<li><a href="#controls_android.scaler.cropRegion">android.scaler.cropRegion</a></li>

10356

<li><a href="#controls_android.statistics.faceDetectMode">android.statistics.faceDetectMode</a></li>

10357

</ul>

10358

For high speed recording use case, the actual maximum supported frame rate may

10359

be lower than what camera can output, depending on the destination Surfaces for

10360

the image data. For example, if the destination surface is from video encoder,

10361

the application need check if the video encoder is capable of supporting the

10362

high frame rate for a given video size, or it will end up with lower recording

10363

frame rate. If the destination surface is from preview window, the preview frame

10364

rate will be bounded by the screen refresh rate.

10365

The camera device will only support up to 2 output high speed streams

10366

(processed non-stalling format defined in <a href="#static_android.request.maxNumOutputStreams">android.request.maxNumOutputStreams</a>)

10367

in this mode. This control will be effective only if all of below conditions are true:

10368

<ul>

10369

<li>The application created no more than maxNumHighSpeedStreams processed non-stalling

10370

format output streams, where maxNumHighSpeedStreams is calculated as

10371

min(2, <a href="#static_android.request.maxNumOutputStreams">android.request.maxNumOutputStreams</a>[Processed (but not-stalling)]).</li>

10372

<li>The stream sizes are selected from the sizes reported by

10373

<a href="#static_android.control.availableHighSpeedVideoConfigurations">android.control.availableHighSpeedVideoConfigurations</a>.</li>

10374

<li>No processed non-stalling or raw streams are configured.</li>

10375

</ul>

Shuzhen Wang

2022-05-03 11:01:26 -0700

[diff] [blame]

10376

When above conditions are NOT satisfied, the controls of this mode and

Zhijun He

2014-06-10 18:21:34 -0700

[diff] [blame]

10377

<a href="#controls_android.control.aeTargetFpsRange">android.control.aeTargetFpsRange</a> will be ignored by the camera device,

10378

the camera device will fall back to <a href="#controls_android.control.mode">android.control.mode</a> <code>==</code> AUTO,

Shuzhen Wang

2022-05-03 11:01:26 -0700

[diff] [blame]

10379

and the returned capture result metadata will give the fps range chosen

Zhijun He

2014-06-10 18:21:34 -0700

[diff] [blame]

10380

by the camera device.

10381

Switching into or out of this mode may trigger some camera ISP/sensor

10382

reconfigurations, which may introduce extra latency. It is recommended that

10383

the application avoids unnecessary scene mode switch as much as possible.

10384

</li>

Ruben Brunk

2014-08-28 17:16:38 -0700

[diff] [blame]

10385

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

10386

HDR (v3.2)

Ruben Brunk

2014-08-28 17:16:38 -0700

[diff] [blame]

10387

[optional]

Eino-Ville Talvala

14cd098

2014-12-05 10:46:45 -0800

[diff] [blame]

10388

Turn on a device-specific high dynamic range (HDR) mode.

10389

In this scene mode, the camera device captures images

10390

that keep a larger range of scene illumination levels

10391

visible in the final image. For example, when taking a

10392

picture of a object in front of a bright window, both

10393

the object and the scene through the window may be

10394

visible when using HDR mode, while in normal AUTO mode,

10395

one or the other may be poorly exposed. As a tradeoff,

10396

HDR mode generally takes much longer to capture a single

10397

image, has no user control, and may have other artifacts

10398

depending on the HDR method used.

10399

Therefore, HDR captures operate at a much slower rate

10400

than regular captures.

10401

In this mode, on LIMITED or FULL devices, when a request

10402

is made with a <a href="#controls_android.control.captureIntent">android.control.captureIntent</a> of

10403

STILL_CAPTURE, the camera device will capture an image

10404

using a high dynamic range capture technique. On LEGACY

10405

devices, captures that target a JPEG-format output will

10406

be captured with HDR, and the capture intent is not

10407

relevant.

10408

The HDR capture may involve the device capturing a burst

10409

of images internally and combining them into one, or it

10410

may involve the device using specialized high dynamic

10411

range capture hardware. In all cases, a single image is

10412

produced in response to a capture request submitted

10413

while in HDR mode.

10414

Since substantial post-processing is generally needed to

Eino-Ville Talvala

1f883d4

2016-04-04 10:47:43 -0700

[diff] [blame]

10415

produce an HDR image, only YUV, PRIVATE, and JPEG

10416

outputs are supported for LIMITED/FULL device HDR

10417

captures, and only JPEG outputs are supported for LEGACY

10418

HDR captures. Using a RAW output for HDR capture is not

10419

supported.

10420

Some devices may also support always-on HDR, which

10421

applies HDR processing at full frame rate. For these

10422

devices, intents other than STILL_CAPTURE will also

10423

produce an HDR output with no frame rate impact compared

10424

to normal operation, though the quality may be lower

10425

than for STILL_CAPTURE intents.

10426

If SCENE_MODE_HDR is used with unsupported output types

10427

or capture intents, the images captured will be as if

10428

the SCENE_MODE was not enabled at all.

Ruben Brunk

2014-08-28 17:16:38 -0700

[diff] [blame]

10429

</li>

Zhijun He

2015-06-16 19:44:18 -0700

[diff] [blame]

10430

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

10431

FACE_PRIORITY_LOW_LIGHT (v3.2)

Zhijun He

2015-06-16 19:44:18 -0700

[diff] [blame]

10432

[optional]

10433

[hidden]

10434

Same as FACE_PRIORITY scene mode, except that the camera

Andy Huibers

2015-07-11 08:36:42 -0700

[diff] [blame]

10435

device will choose higher sensitivity values (<a href="#controls_android.sensor.sensitivity">android.sensor.sensitivity</a>)

Zhijun He

2015-06-16 19:44:18 -0700

[diff] [blame]

10436

under low light conditions.

10437

The camera device may be tuned to expose the images in a reduced

10438

sensitivity range to produce the best quality images. For example,

10439

if the <a href="#static_android.sensor.info.sensitivityRange">android.sensor.info.sensitivityRange</a> gives range of [100, 1600],

10440

the camera device auto-exposure routine tuning process may limit the actual

Andy Huibers

2015-07-11 08:36:42 -0700

[diff] [blame]

10441

exposure sensitivity range to [100, 1200] to ensure that the noise level isn't

Shuzhen Wang

2022-05-03 11:01:26 -0700

[diff] [blame]

10442

excessive in order to preserve the image quality. Under this situation, the image under

Zhijun He

2015-06-16 19:44:18 -0700

[diff] [blame]

10443

low light may be under-exposed when the sensor max exposure time (bounded by the

10444

<a href="#controls_android.control.aeTargetFpsRange">android.control.aeTargetFpsRange</a> when <a href="#controls_android.control.aeMode">android.control.aeMode</a> is one of the

Andy Huibers

2015-07-11 08:36:42 -0700

[diff] [blame]

10445

ON_* modes) and effective max sensitivity are reached. This scene mode allows the

Zhijun He

2015-06-16 19:44:18 -0700

[diff] [blame]

10446

camera device auto-exposure routine to increase the sensitivity up to the max

10447

sensitivity specified by <a href="#static_android.sensor.info.sensitivityRange">android.sensor.info.sensitivityRange</a> when the scene is too

10448

dark and the max exposure time is reached. The captured images may be noisier

Andy Huibers

2015-07-11 08:36:42 -0700

[diff] [blame]

10449

compared with the images captured in normal FACE_PRIORITY mode; therefore, it is

Zhijun He

2015-06-16 19:44:18 -0700

[diff] [blame]

10450

recommended that the application only use this scene mode when it is capable of

10451

reducing the noise level of the captured images.

10452

Unlike the other scene modes, <a href="#controls_android.control.aeMode">android.control.aeMode</a>,

10453

<a href="#controls_android.control.awbMode">android.control.awbMode</a>, and <a href="#controls_android.control.afMode">android.control.afMode</a>

10454

remain active when FACE_PRIORITY_LOW_LIGHT is set.

10455

</li>

Yin-Chia Yeh

2016-03-09 14:44:14 -0800

[diff] [blame]

10456

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

10457

DEVICE_CUSTOM_START (v3.2)

Yin-Chia Yeh

2016-03-09 14:44:14 -0800

[diff] [blame]

[optional]

[hidden]

100

Scene mode values within the range of

10462

<code>[DEVICE_CUSTOM_START, DEVICE_CUSTOM_END]</code> are reserved for device specific

10463

customized scene modes.

10464

</li>

10465

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

10466

DEVICE_CUSTOM_END (v3.2)

Yin-Chia Yeh

2016-03-09 14:44:14 -0800

[diff] [blame]

[optional]

[hidden]

127

Scene mode values within the range of

10471

<code>[DEVICE_CUSTOM_START, DEVICE_CUSTOM_END]</code> are reserved for device specific

10472

customized scene modes.

10473

</li>

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

10474

</ul>

10475

10476

</td>

10477

10478

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

10479

Control for which scene mode is currently active.

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

</td>

</td>

<a href="#static_android.control.availableSceneModes">android.control.availableSceneModes</a>

10487

</td>

10488

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

</ul>

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

10501

<th class="th_details" colspan="6">Details</th>

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

10502

</tr>

10503

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

10504

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

10505

Scene modes are custom camera modes optimized for a certain set of conditions and

10506

capture settings.

10507

This is the mode that that is active when

Zhijun He

2015-06-16 19:44:18 -0700

[diff] [blame]

10508

<code><a href="#controls_android.control.mode">android.control.mode</a> == USE_SCENE_MODE</code>. Aside from FACE_PRIORITY, these modes will

10509

disable <a href="#controls_android.control.aeMode">android.control.aeMode</a>, <a href="#controls_android.control.awbMode">android.control.awbMode</a>, and <a href="#controls_android.control.afMode">android.control.afMode</a>

10510

while in use.

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

10511

The interpretation and implementation of these scene modes is left

10512

to the implementor of the camera device. Their behavior will not be

10513

consistent across all devices, and any given device may only implement

10514

a subset of these modes.

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

10519

<th class="th_details" colspan="6">HAL Implementation Details</th>

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

10520

</tr>

10521

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

10522

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

10523

HAL implementations that include scene modes are expected to provide

10524

the per-scene settings to use for <a href="#controls_android.control.aeMode">android.control.aeMode</a>,

10525

<a href="#controls_android.control.awbMode">android.control.awbMode</a>, and <a href="#controls_android.control.afMode">android.control.afMode</a> in

10526

<a href="#static_android.control.sceneModeOverrides">android.control.sceneModeOverrides</a>.

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

10527

For HIGH_SPEED_VIDEO mode, if it is included in <a href="#static_android.control.availableSceneModes">android.control.availableSceneModes</a>, the

10528

HAL must list supported video size and fps range in

10529

<a href="#static_android.control.availableHighSpeedVideoConfigurations">android.control.availableHighSpeedVideoConfigurations</a>. For a given size, e.g. 1280x720,

10530

if the HAL has two different sensor configurations for normal streaming mode and high

10531

speed streaming, when this scene mode is set/reset in a sequence of capture requests, the

10532

HAL may have to switch between different sensor modes. This mode is deprecated in legacy

10533

HAL3.3, to support high speed video recording, please implement

Zhijun He

2015-05-22 17:04:15 -0700

[diff] [blame]

10534

<a href="#static_android.control.availableHighSpeedVideoConfigurations">android.control.availableHighSpeedVideoConfigurations</a> and CONSTRAINED_HIGH_SPEED_VIDEO

Shuzhen Wang

2022-05-03 11:01:26 -0700

[diff] [blame]

10535

capability defined in <a href="#static_android.request.availableCapabilities">android.request.availableCapabilities</a>.

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

10539

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

10540

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

10544

<td class="entry_name

Jayant Chowdhary

2021-09-28 16:32:07 -0700

[diff] [blame]

10545

" rowspan="5">

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

10546

android.control.videoStabilizationMode

</td>

byte

[public]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

10553

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

10554

[legacy]

10555

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

10556

10557

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

10558

10559

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

10560

OFF (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

10561

Video stabilization is disabled.

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

10562

</li>

10563

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

10564

ON (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

10565

Video stabilization is enabled.

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

10566

</li>

Jayant Chowdhary

2021-09-28 16:32:07 -0700

[diff] [blame]

10567

<li>

10568

PREVIEW_STABILIZATION (v3.8)

10569

[optional]

10570

Preview stabilization, where the preview in addition to all other non-RAW streams are

10571

stabilized with the same quality of stabilization, is enabled. This mode aims to give

10572

clients a 'what you see is what you get' effect. In this mode, the FoV reduction will

10573

be a maximum of 20 % both horizontally and vertically

10574

(10% from left, right, top, bottom) for the given zoom ratio / crop region.

10575

The resultant FoV will also be the same across all processed streams

10576

(that have the same aspect ratio).

10577

</li>

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

10578

</ul>

10579

10580

</td>

10581

10582

10583

Whether video stabilization is

Eino-Ville Talvala

2014-06-06 14:35:41 -0700

[diff] [blame]

10584

active.

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

</td>

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

</ul>

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

10605

<th class="th_details" colspan="6">Details</th>

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

10606

</tr>

10607

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

10608

Jianing Wei

2015-09-29 14:01:43 -0700

[diff] [blame]

10609

Video stabilization automatically warps images from

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

10610

the camera in order to stabilize motion between consecutive frames.

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

10611

If enabled, video stabilization can modify the

Zhijun He

2014-06-12 10:43:32 -0700

[diff] [blame]

10612

<a href="#controls_android.scaler.cropRegion">android.scaler.cropRegion</a> to keep the video stream stabilized.

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

10613

Switching between different video stabilization modes may take several

10614

frames to initialize, the camera device will report the current mode

10615

in capture result metadata. For example, When "ON" mode is requested,

10616

the video stabilization modes in the first several capture results may

10617

still be "OFF", and it will become "ON" when the initialization is

10618

done.

Jianing Wei

2015-09-29 14:01:43 -0700

[diff] [blame]

10619

In addition, not all recording sizes or frame rates may be supported for

10620

stabilization by a device that reports stabilization support. It is guaranteed

10621

that an output targeting a MediaRecorder or MediaCodec will be stabilized if

10622

the recording resolution is less than or equal to 1920 x 1080 (width less than

10623

or equal to 1920, height less than or equal to 1080), and the recording

10624

frame rate is less than or equal to 30fps. At other sizes, the CaptureResult

10625

<a href="#controls_android.control.videoStabilizationMode">android.control.videoStabilizationMode</a> field will return

10626

OFF if the recording output is not stabilized, or if there are no output

10627

Surface types that can be stabilized.

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

10628

If a camera device supports both this mode and OIS

10629

(<a href="#controls_android.lens.opticalStabilizationMode">android.lens.opticalStabilizationMode</a>), turning both modes on may

10630

produce undesirable interaction, so it is recommended not to enable

10631

both at the same time.

Jayant Chowdhary

2021-09-28 16:32:07 -0700

[diff] [blame]

10632

If video stabilization is set to "PREVIEW_STABILIZATION",

10633

<a href="#controls_android.lens.opticalStabilizationMode">android.lens.opticalStabilizationMode</a> is overridden. The camera sub-system may choose

10634

to turn on hardware based image stabilization in addition to software based stabilization

10635

if it deems that appropriate.

10636

This key may be a part of the available session keys, which camera clients may

10637

query via

10638

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics.html#getAvailableSessionKeys">CameraCharacteristics#getAvailableSessionKeys</a>.

10639

If this is the case, changing this key over the life-time of a capture session may

10640

cause delays / glitches.

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

</td>

</tr>

Jayant Chowdhary

2021-09-28 16:32:07 -0700

[diff] [blame]

10644

10645

<th class="th_details" colspan="6">HAL Implementation Details</th>

</tr>

When this key is set to "PREVIEW_STABILIZATION",

Jayant Chowdhary

316b531

2021-12-15 14:35:14 -0800

[diff] [blame]

10650

for non-stalling buffers returned without errors, the time interval between notify readout

Jayant Chowdhary

2021-09-28 16:32:07 -0700

[diff] [blame]

10651

timestamp and when buffers are returned to the camera framework, must be no more than 1

10652

extra frame interval, relative to the case where this key is set to "OFF".

10653

This is in order for look-ahead time period to be short enough

10654

for preview to match video recording for real-time usage.

10655

</td>

10656

</tr>

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

10657

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

10658

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

10659

10660

Yin-Chia Yeh

2016-01-18 19:14:55 -0800

[diff] [blame]

10661

10662

10663

<td class="entry_name

10664

" rowspan="3">

10665

android.control.postRawSensitivityBoost

</td>

int32

[public]

</td>

10678

10679

Yin-Chia Yeh

2016-04-11 16:37:49 -0700

[diff] [blame]

10680

The amount of additional sensitivity boost applied to output images

Yin-Chia Yeh

2016-01-18 19:14:55 -0800

[diff] [blame]

10681

after RAW sensor data is captured.

</td>

ISO arithmetic units, the same as android.sensor.sensitivity

</td>

<a href="#static_android.control.postRawSensitivityBoostRange">android.control.postRawSensitivityBoostRange</a>

10690

</td>

10691

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Yin-Chia Yeh

2016-01-18 19:14:55 -0800

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

10701

<th class="th_details" colspan="6">Details</th>

Yin-Chia Yeh

2016-01-18 19:14:55 -0800

[diff] [blame]

10702

</tr>

10703

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

10704

Yin-Chia Yeh

2016-01-18 19:14:55 -0800

[diff] [blame]

10705

Some camera devices support additional digital sensitivity boosting in the

10706

camera processing pipeline after sensor RAW image is captured.

10707

Such a boost will be applied to YUV/JPEG format output images but will not

10708

have effect on RAW output formats like RAW_SENSOR, RAW10, RAW12 or RAW_OPAQUE.

Yin-Chia Yeh

2016-04-11 16:37:49 -0700

[diff] [blame]

10709

This key will be <code>null</code> for devices that do not support any RAW format

10710

outputs. For devices that do support RAW format outputs, this key will always

10711

present, and if a device does not support post RAW sensitivity boost, it will

10712

list <code>100</code> in this key.

Yin-Chia Yeh

2016-01-18 19:14:55 -0800

[diff] [blame]

10713

If the camera device cannot apply the exact boost requested, it will reduce the

10714

boost to the nearest supported value.

10715

The final boost value used will be available in the output capture result.

10716

For devices that support post RAW sensitivity boost, the YUV/JPEG output images

10717

of such device will have the total sensitivity of

Yin-Chia Yeh

5a12e62

2016-01-26 13:26:56 -0800

[diff] [blame]

10718

<code><a href="#controls_android.sensor.sensitivity">android.sensor.sensitivity</a> * <a href="#controls_android.control.postRawSensitivityBoost">android.control.postRawSensitivityBoost</a> / 100</code>

Yin-Chia Yeh

2016-01-18 19:14:55 -0800

[diff] [blame]

10719

The sensitivity of RAW format images will always be <code><a href="#controls_android.sensor.sensitivity">android.sensor.sensitivity</a></code>

10720

This control is only effective if <a href="#controls_android.control.aeMode">android.control.aeMode</a> or <a href="#controls_android.control.mode">android.control.mode</a> is set to

10721

OFF; otherwise the auto-exposure algorithm will override this value.

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

10726

Yin-Chia Yeh

2016-01-18 19:14:55 -0800

[diff] [blame]

10727

10728

Chien-Yu Chen

2017-01-09 15:55:06 -0800

[diff] [blame]

10729

10730

10731

<td class="entry_name

10732

" rowspan="5">

10733

android.control.enableZsl

</td>

byte

[public as boolean]

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

10746

FALSE (v3.2)

Chien-Yu Chen

2017-01-09 15:55:06 -0800

[diff] [blame]

10747

Requests with <a href="#controls_android.control.captureIntent">android.control.captureIntent</a> == STILL_CAPTURE must be captured

10748

after previous requests.

10749

</li>

10750

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

10751

TRUE (v3.2)

Chien-Yu Chen

2017-01-09 15:55:06 -0800

[diff] [blame]

10752

Requests with <a href="#controls_android.control.captureIntent">android.control.captureIntent</a> == STILL_CAPTURE may or may not be

10753

captured before previous requests.

</li>

</ul>

</td>

10758

10759

10760

Allow camera device to enable zero-shutter-lag mode for requests with

10761

<a href="#controls_android.control.captureIntent">android.control.captureIntent</a> == STILL_CAPTURE.

</td>

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Chien-Yu Chen

2017-01-09 15:55:06 -0800

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

10779

<th class="th_details" colspan="6">Details</th>

Chien-Yu Chen

2017-01-09 15:55:06 -0800

[diff] [blame]

10780

</tr>

10781

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

10782

Chien-Yu Chen

2017-01-09 15:55:06 -0800

[diff] [blame]

10783

If enableZsl is <code>true</code>, the camera device may enable zero-shutter-lag mode for requests with

10784

STILL_CAPTURE capture intent. The camera device may use images captured in the past to

10785

produce output images for a zero-shutter-lag request. The result metadata including the

10786

<a href="#dynamic_android.sensor.timestamp">android.sensor.timestamp</a> reflects the source frames used to produce output images.

10787

Therefore, the contents of the output images and the result metadata may be out of order

10788

compared to previous regular requests. enableZsl does not affect requests with other

10789

capture intents.

10790

For example, when requests are submitted in the following order:

10791

Request A: enableZsl is ON, <a href="#controls_android.control.captureIntent">android.control.captureIntent</a> is PREVIEW

10792

Request B: enableZsl is ON, <a href="#controls_android.control.captureIntent">android.control.captureIntent</a> is STILL_CAPTURE

10793

The output images for request B may have contents captured before the output images for

10794

request A, and the result metadata for request B may be older than the result metadata for

10795

request A.

Chien-Yu Chen

4727280

2017-04-18 15:17:15 -0700

[diff] [blame]

10796

Note that when enableZsl is <code>true</code>, it is not guaranteed to get output images captured in

10797

the past for requests with STILL_CAPTURE capture intent.

10798

For applications targeting SDK versions O and newer, the value of enableZsl in

10799

TEMPLATE_STILL_CAPTURE template may be <code>true</code>. The value in other templates is always

10800

<code>false</code> if present.

10801

For applications targeting SDK versions older than O, the value of enableZsl in all

10802

capture templates is always <code>false</code> if present.

Chien-Yu Chen

853e0dd

2017-05-03 12:17:47 -0700

[diff] [blame]

10803

For application-operated ZSL, use CAMERA3_TEMPLATE_ZERO_SHUTTER_LAG template.

Chien-Yu Chen

2017-01-09 15:55:06 -0800

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

10808

<th class="th_details" colspan="6">HAL Implementation Details</th>

Chien-Yu Chen

2017-01-09 15:55:06 -0800

[diff] [blame]

10809

</tr>

10810

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

10811

Chien-Yu Chen

2017-01-09 15:55:06 -0800

[diff] [blame]

10812

It is valid for HAL to produce regular output images for requests with STILL_CAPTURE

capture intent.

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

10817

Chien-Yu Chen

2017-01-09 15:55:06 -0800

[diff] [blame]

10818

10819

Chien-Yu Chen

2017-11-27 16:12:38 -0800

[diff] [blame]

10820

10821

10822

<td class="entry_name

10823

" rowspan="3">

10824

android.control.afSceneChange

10825

</td>

10826

Chien-Yu Chen

c357faa

2018-01-19 10:50:17 -0800

[diff] [blame]

10827

byte

Chien-Yu Chen

2017-11-27 16:12:38 -0800

[diff] [blame]

[public]

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

10837

NOT_DETECTED (v3.3)

Chien-Yu Chen

2017-11-27 16:12:38 -0800

[diff] [blame]

10838

Scene change is not detected within the AF region(s).

10839

</li>

10840

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

10841

DETECTED (v3.3)

Chien-Yu Chen

2017-11-27 16:12:38 -0800

[diff] [blame]

10842

Scene change is detected within the AF region(s).

</li>

</ul>

</td>

10847

10848

10849

Whether a significant scene change is detected within the currently-set AF

region(s).

</td>

</td>

</td>

3.3

</td>

</td>

</tr>

<th class="th_details" colspan="6">Details</th>

</tr>

When the camera focus routine detects a change in the scene it is looking at,

10873

such as a large shift in camera viewpoint, significant motion in the scene, or a

10874

significant illumination change, this value will be set to DETECTED for a single capture

10875

result. Otherwise the value will be NOT_DETECTED. The threshold for detection is similar

10876

to what would trigger a new passive focus scan to begin in CONTINUOUS autofocus modes.

Chien-Yu Chen

2017-11-27 16:12:38 -0800

[diff] [blame]

10877

This key will be available if the camera device advertises this key via <a href="https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics.html#getAvailableCaptureResultKeys">CameraCharacteristics#getAvailableCaptureResultKeys</a>.

</td>

</tr>

10884

Shuzhen Wang

2019-07-08 15:03:24 -0700

[diff] [blame]

10885

Shuzhen Wang

2020-03-16 11:39:27 -0700

[diff] [blame]

10886

Shuzhen Wang

2019-07-08 15:03:24 -0700

[diff] [blame]

10887

<td class="entry_name

10888

" rowspan="3">

Shuzhen Wang

2020-03-16 11:39:27 -0700

[diff] [blame]

10889

android.control.extendedSceneMode

Shuzhen Wang

2019-07-08 15:03:24 -0700

[diff] [blame]

</td>

byte

[public]

<li>

Shuzhen Wang

2020-03-16 11:39:27 -0700

[diff] [blame]

10902

DISABLED (v3.5)

10903

0

10904

Extended scene mode is disabled.

Shuzhen Wang

2019-07-08 15:03:24 -0700

[diff] [blame]

10905

</li>

10906

<li>

Shuzhen Wang

2020-03-16 11:39:27 -0700

[diff] [blame]

10907

BOKEH_STILL_CAPTURE (v3.5)

Shuzhen Wang

2019-07-08 15:03:24 -0700

[diff] [blame]

10908

High quality bokeh mode is enabled for all non-raw streams (including YUV,

10909

JPEG, and IMPLEMENTATION_DEFINED) when capture intent is STILL_CAPTURE. Due to the

10910

extra image processing, this mode may introduce additional stall to non-raw streams.

10911

This mode should be used in high quality still capture use case.

10912

</li>

10913

<li>

Shuzhen Wang

2020-03-16 11:39:27 -0700

[diff] [blame]

10914

BOKEH_CONTINUOUS (v3.5)

Shuzhen Wang

2019-07-08 15:03:24 -0700

[diff] [blame]

10915

Bokeh effect must not slow down capture rate relative to sensor raw output,

10916

and the effect is applied to all processed streams no larger than the maximum

10917

streaming dimension. This mode should be used if performance and power are a

10918

priority, such as video recording.

10919

</li>

Shuzhen Wang

2020-03-16 11:39:27 -0700

[diff] [blame]

<li>

VENDOR_START (v3.5)

[hidden]

0x40

Vendor defined extended scene modes. These depend on vendor implementation.

10925

</li>

Shuzhen Wang

2019-07-08 15:03:24 -0700

[diff] [blame]

10926

</ul>

10927

10928

</td>

10929

10930

Shuzhen Wang

2020-03-16 11:39:27 -0700

[diff] [blame]

10931

Whether extended scene mode is enabled for a particular capture request.

Shuzhen Wang

2019-07-08 15:03:24 -0700

[diff] [blame]

</td>

</td>

</td>

3.5

</td>

</td>

</tr>

<th class="th_details" colspan="6">Details</th>

</tr>

With bokeh mode, the camera device may blur out the parts of scene that are not in

10954

focus, creating a bokeh (or shallow depth of field) effect for people or objects.

Shuzhen Wang

2020-03-16 11:39:27 -0700

[diff] [blame]

10955

When set to BOKEH_STILL_CAPTURE mode with STILL_CAPTURE capture intent, due to the extra

Shuzhen Wang

2019-07-08 15:03:24 -0700

[diff] [blame]

10956

processing needed for high quality bokeh effect, the stall may be longer than when

10957

capture intent is not STILL_CAPTURE.

Shuzhen Wang

2020-03-16 11:39:27 -0700

[diff] [blame]

10958

When set to BOKEH_STILL_CAPTURE mode with PREVIEW capture intent,

Shuzhen Wang

2019-07-08 15:03:24 -0700

[diff] [blame]

10959

<ul>

10960

<li>If the camera device has BURST_CAPTURE capability, the frame rate requirement of

10961

BURST_CAPTURE must still be met.</li>

Shuzhen Wang

2020-03-16 11:39:27 -0700

[diff] [blame]

10962

<li>All streams not larger than the maximum streaming dimension for BOKEH_STILL_CAPTURE mode

10963

(queried via <a href="https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics.html#CONTROL_AVAILABLE_EXTENDED_SCENE_MODE_CAPABILITIES">CameraCharacteristics#CONTROL_AVAILABLE_EXTENDED_SCENE_MODE_CAPABILITIES</a>)

Shuzhen Wang

2019-07-08 15:03:24 -0700

[diff] [blame]

10964

will have preview bokeh effect applied.</li>

10965

</ul>

Shuzhen Wang

2020-03-16 11:39:27 -0700

[diff] [blame]

10966

When set to BOKEH_CONTINUOUS mode, configured streams dimension should not exceed this mode's

Shuzhen Wang

2019-07-08 15:03:24 -0700

[diff] [blame]

10967

maximum streaming dimension in order to have bokeh effect applied. Bokeh effect may not

10968

be available for streams larger than the maximum streaming dimension.

Shuzhen Wang

2020-03-16 11:39:27 -0700

[diff] [blame]

10969

Switching between different extended scene modes may involve reconfiguration of the camera

Shuzhen Wang

2019-07-08 15:03:24 -0700

[diff] [blame]

10970

pipeline, resulting in long latency. The application should check this key against the

10971

available session keys queried via

10972

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics.html#getAvailableSessionKeys">CameraCharacteristics#getAvailableSessionKeys</a>.

Shuzhen Wang

2019-07-08 15:03:24 -0700

[diff] [blame]

10973

For a logical multi-camera, bokeh may be implemented by stereo vision from sub-cameras

10974

with different field of view. As a result, when bokeh mode is enabled, the camera device

Shuzhen Wang

2020-03-16 11:39:27 -0700

[diff] [blame]

10975

may override <a href="#controls_android.scaler.cropRegion">android.scaler.cropRegion</a> or <a href="#controls_android.control.zoomRatio">android.control.zoomRatio</a>, and the field of

10976

view may be smaller than when bokeh mode is off.

Shuzhen Wang

2019-07-08 15:03:24 -0700

[diff] [blame]

</td>

</tr>

10983

Shuzhen Wang

2019-11-07 15:59:22 -0800

[diff] [blame]

10984

10985

10986

<td class="entry_name

10987

" rowspan="5">

10988

android.control.zoomRatio

</td>

float

[public]

[limited]

</td>

11002

11003

11004

The desired zoom ratio

</td>

</td>

<a href="#static_android.control.zoomRatioRange">android.control.zoomRatioRange</a>

</td>

3.5

</td>

</td>

</tr>

<th class="th_details" colspan="6">Details</th>

</tr>

Shuzhen Wang

2020-09-14 11:40:07 -0700

[diff] [blame]

11027

Instead of using <a href="#controls_android.scaler.cropRegion">android.scaler.cropRegion</a> for zoom, the application can now choose to

11028

use this tag to specify the desired zoom level.

Shuzhen Wang

2019-11-07 15:59:22 -0800

[diff] [blame]

11029

By using this control, the application gains a simpler way to control zoom, which can

Shuzhen Wang

2020-03-12 21:36:18 -0700

[diff] [blame]

11030

be a combination of optical and digital zoom. For example, a multi-camera system may

11031

contain more than one lens with different focal lengths, and the user can use optical

Eino-Ville Talvala

a5213a2

2020-05-10 16:57:36 -0700

[diff] [blame]

11032

zoom by switching between lenses. Using zoomRatio has benefits in the scenarios below:

11033

<ul>

11034

<li>Zooming in from a wide-angle lens to a telephoto lens: A floating-point ratio provides

11035

better precision compared to an integer value of <a href="#controls_android.scaler.cropRegion">android.scaler.cropRegion</a>.</li>

11036

<li>Zooming out from a wide lens to an ultrawide lens: zoomRatio supports zoom-out whereas

11037

<a href="#controls_android.scaler.cropRegion">android.scaler.cropRegion</a> doesn't.</li>

11038

</ul>

Shuzhen Wang

2020-03-12 21:36:18 -0700

[diff] [blame]

11039

To illustrate, here are several scenarios of different zoom ratios, crop regions,

11040

and output streams, for a hypothetical camera device with an active array of size

11041

<code>(2000,1500)</code>.

Shuzhen Wang

2019-11-07 15:59:22 -0800

[diff] [blame]

11042

<ul>

Shuzhen Wang

2020-03-12 21:36:18 -0700

[diff] [blame]

11043

<li>Camera Configuration:<ul>

11044

<li>Active array size: <code>2000x1500</code> (3 MP, 4:3 aspect ratio)</li>

11045

<li>Output stream #1: <code>640x480</code> (VGA, 4:3 aspect ratio)</li>

11046

<li>Output stream #2: <code>1280x720</code> (720p, 16:9 aspect ratio)</li>

Shuzhen Wang

2019-11-07 15:59:22 -0800

[diff] [blame]

11047

</ul>

Shuzhen Wang

2020-03-12 21:36:18 -0700

[diff] [blame]

11048

</li>

11049

<li>Case #1: 4:3 crop region with 2.0x zoom ratio<ul>

11050

<li>Zoomed field of view: 1/4 of original field of view</li>

11051

<li>Crop region: <code>Rect(0, 0, 2000, 1500) // (left, top, right, bottom)</code> (post zoom)</li>

</ul>

</li>

<li><code>640x480</code> stream source area: <code>(0, 0, 2000, 1500)</code> (equal to crop region)</li>

11056

<li><code>1280x720</code> stream source area: <code>(0, 187, 2000, 1312)</code> (letterboxed)</li>

11057

</ul>

11058

</li>

11059

<li>Case #2: 16:9 crop region with 2.0x zoom.<ul>

11060

<li>Zoomed field of view: 1/4 of original field of view</li>

11061

<li>Crop region: <code>Rect(0, 187, 2000, 1312)</code></li>

11062

11063

<li><code>640x480</code> stream source area: <code>(250, 187, 1750, 1312)</code> (pillarboxed)</li>

11064

<li><code>1280x720</code> stream source area: <code>(0, 187, 2000, 1312)</code> (equal to crop region)</li>

11065

</ul>

11066

</li>

11067

<li>Case #3: 1:1 crop region with 0.5x zoom out to ultrawide lens.<ul>

11068

<li>Zoomed field of view: 4x of original field of view (switched from wide lens to ultrawide lens)</li>

11069

<li>Crop region: <code>Rect(250, 0, 1750, 1500)</code></li>

11070

11071

<li><code>640x480</code> stream source area: <code>(250, 187, 1750, 1312)</code> (letterboxed)</li>

11072

<li><code>1280x720</code> stream source area: <code>(250, 328, 1750, 1172)</code> (letterboxed)</li>

</ul>

</li>

</ul>

As seen from the graphs above, the coordinate system of cropRegion now changes to the

11077

effective after-zoom field-of-view, and is represented by the rectangle of (0, 0,

11078

activeArrayWith, activeArrayHeight). The same applies to AE/AWB/AF regions, and faces.

11079

This coordinate system change isn't applicable to RAW capture and its related

11080

metadata such as intrinsicCalibration and lensShadingMap.

11081

Using the same hypothetical example above, and assuming output stream #1 (640x480) is

11082

the viewfinder stream, the application can achieve 2.0x zoom in one of two ways:

11083

<ul>

11084

<li>zoomRatio = 2.0, scaler.cropRegion = (0, 0, 2000, 1500)</li>

11085

<li>zoomRatio = 1.0 (default), scaler.cropRegion = (500, 375, 1500, 1125)</li>

11086

</ul>

11087

If the application intends to set aeRegions to be top-left quarter of the viewfinder

11088

field-of-view, the <a href="#controls_android.control.aeRegions">android.control.aeRegions</a> should be set to (0, 0, 1000, 750) with

Shuzhen Wang

2019-11-07 15:59:22 -0800

[diff] [blame]

11089

zoomRatio set to 2.0. Alternatively, the application can set aeRegions to the equivalent

Shuzhen Wang

2020-03-12 21:36:18 -0700

[diff] [blame]

11090

region of (500, 375, 1000, 750) for zoomRatio of 1.0. If the application doesn't

Shuzhen Wang

2019-11-07 15:59:22 -0800

[diff] [blame]

11091

explicitly set <a href="#controls_android.control.zoomRatio">android.control.zoomRatio</a>, its value defaults to 1.0.

Shuzhen Wang

2019-11-07 15:59:22 -0800

[diff] [blame]

11092

One limitation of controlling zoom using zoomRatio is that the <a href="#controls_android.scaler.cropRegion">android.scaler.cropRegion</a>

11093

must only be used for letterboxing or pillarboxing of the sensor active array, and no

Shuzhen Wang

0ca6316

2020-11-30 20:11:27 -0800

[diff] [blame]

11094

FREEFORM cropping can be used with <a href="#controls_android.control.zoomRatio">android.control.zoomRatio</a> other than 1.0. If

11095

<a href="#controls_android.control.zoomRatio">android.control.zoomRatio</a> is not 1.0, and <a href="#controls_android.scaler.cropRegion">android.scaler.cropRegion</a> is set to be

11096

windowboxing, the camera framework will override the <a href="#controls_android.scaler.cropRegion">android.scaler.cropRegion</a> to be

11097

the active array.

Shuzhen Wang

bd3ad5f

2021-06-30 16:09:35 -0700

[diff] [blame]

11098

In the capture request, if the application sets <a href="#controls_android.control.zoomRatio">android.control.zoomRatio</a> to a

11099

value != 1.0, the <a href="#controls_android.control.zoomRatio">android.control.zoomRatio</a> tag in the capture result reflects the

11100

effective zoom ratio achieved by the camera device, and the <a href="#controls_android.scaler.cropRegion">android.scaler.cropRegion</a>

11101

adjusts for additional crops that are not zoom related. Otherwise, if the application

11102

sets <a href="#controls_android.control.zoomRatio">android.control.zoomRatio</a> to 1.0, or does not set it at all, the

11103

<a href="#controls_android.control.zoomRatio">android.control.zoomRatio</a> tag in the result metadata will also be 1.0.

11104

When the application requests a physical stream for a logical multi-camera, the

11105

<a href="#controls_android.control.zoomRatio">android.control.zoomRatio</a> in the physical camera result metadata will be 1.0, and

11106

the <a href="#controls_android.scaler.cropRegion">android.scaler.cropRegion</a> tag reflects the amount of zoom and crop done by the

11107

physical camera device.

Shuzhen Wang

2019-11-07 15:59:22 -0800

[diff] [blame]

</td>

</tr>

<th class="th_details" colspan="6">HAL Implementation Details</th>

</tr>

For all capture request templates, this field must be set to 1.0 in order to have

11117

consistent field of views between different modes.

</td>

</tr>

11123

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</tbody>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

11130

<tr><td colspan="7" id="section_demosaic" class="section">demosaic</td></tr>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

11131

11132

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

11133

<tr><td colspan="7" class="kind">controls</td></tr>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

11134

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

11135

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

11136

<tr>

11137

<th class="th_name">Property Name</th>

11138

11139

<th class="th_description">Description</th>

11140

<th class="th_units">Units</th>

11141

<th class="th_range">Range</th>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

11142

<th class="th_hal_version">Initial HIDL HAL version</th>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</tr>

</thead>

<tbody>

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

11159

<td class="entry_name

11160

" rowspan="1">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

11161

android.demosaic.mode

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

11162

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

11163

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

11164

byte

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

11165

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

11166

[system]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

11167

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

11171

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

11172

11173

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

11174

FAST (v3.2)

Igor Murashkin

2014-01-15 17:05:22 -0800

[diff] [blame]

11175

Minimal or no slowdown of frame rate compared to

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

11176

Bayer RAW output.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

11177

</li>

11178

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

11179

HIGH_QUALITY (v3.2)

Yin-Chia Yeh

2015-04-02 14:00:40 -0700

[diff] [blame]

11180

Improved processing quality but the frame rate might be slowed down

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

11181

relative to raw output.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</li>

</ul>

</td>

11186

11187

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

11188

Controls the quality of the demosaicing

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

11189

processing.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

11202

11203

Zhijun He

2014-05-23 11:02:34 -0700

[diff] [blame]

11204

<li><a href="#tag_FUTURE">FUTURE</a></li>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</ul>

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

11208

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

11209

11210

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

11211

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

11212

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</tbody>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

11220

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

11221

11222

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

11223

<tr><td colspan="7" class="kind">controls</td></tr>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

11224

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

11225

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

11226

<tr>

11227

<th class="th_name">Property Name</th>

11228

11229

<th class="th_description">Description</th>

11230

<th class="th_units">Units</th>

11231

<th class="th_range">Range</th>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

11232

<th class="th_hal_version">Initial HIDL HAL version</th>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</tr>

</thead>

<tbody>

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

11249

<td class="entry_name

Zhijun He

2015-01-15 18:17:24 -0800

[diff] [blame]

11250

" rowspan="5">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

11251

android.edge.mode

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

11252

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

11253

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

11254

byte

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

11255

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

11256

[public]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

11257

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

11258

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

11259

[full]

11260

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

11261

11262

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

11263

11264

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

11265

OFF (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

11266

No edge enhancement is applied.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

11267

</li>

11268

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

11269

FAST (v3.2)

Chien-Yu Chen

2015-07-14 16:33:58 -0700

[diff] [blame]

11270

Apply edge enhancement at a quality level that does not slow down frame rate

11271

relative to sensor output. It may be the same as OFF if edge enhancement will

11272

slow down frame rate relative to sensor.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

11273

</li>

11274

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

11275

HIGH_QUALITY (v3.2)

Yin-Chia Yeh

2015-04-02 14:00:40 -0700

[diff] [blame]

11276

Apply high-quality edge enhancement, at a cost of possibly reduced output frame rate.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

11277

</li>

Eino-Ville Talvala

2015-07-07 10:40:59 -0700

[diff] [blame]

11278

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

11279

ZERO_SHUTTER_LAG (v3.2)

Eino-Ville Talvala

2015-07-07 10:40:59 -0700

[diff] [blame]

11280

[optional]

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

11281

Edge enhancement is applied at different

11282

levels for different output streams, based on resolution. Streams at maximum recording

11283

resolution (see <a href="https://developer.android.com/reference/android/hardware/camera2/CameraDevice.html#createCaptureSession">CameraDevice#createCaptureSession</a>)

11284

or below have edge enhancement applied, while higher-resolution streams have no edge

11285

enhancement applied. The level of edge enhancement for low-resolution streams is tuned

11286

so that frame rate is not impacted, and the quality is equal to or better than FAST

11287

(since it is only applied to lower-resolution outputs, quality may improve from FAST).

Eino-Ville Talvala

2015-07-07 10:40:59 -0700

[diff] [blame]

11288

This mode is intended to be used by applications operating in a zero-shutter-lag mode

11289

with YUV or PRIVATE reprocessing, where the application continuously captures

11290

high-resolution intermediate buffers into a circular buffer, from which a final image is

11291

produced via reprocessing when a user takes a picture. For such a use case, the

11292

high-resolution buffers must not have edge enhancement applied to maximize efficiency of

11293

preview and to avoid double-applying enhancement when reprocessed, while low-resolution

11294

buffers (used for recording or preview, generally) need edge enhancement applied for

11295

reasonable preview quality.

11296

This mode is guaranteed to be supported by devices that support either the

11297

YUV_REPROCESSING or PRIVATE_REPROCESSING capabilities

Chien-Yu Chen

2015-07-08 11:49:38 -0700

[diff] [blame]

11298

(<a href="#static_android.request.availableCapabilities">android.request.availableCapabilities</a> lists either of those capabilities) and it will

11299

be the default mode for CAMERA3_TEMPLATE_ZERO_SHUTTER_LAG template.

Eino-Ville Talvala

2015-07-07 10:40:59 -0700

[diff] [blame]

11300

</li>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

11301

</ul>

11302

11303

</td>

11304

11305

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

11306

Operation mode for edge

Zhijun He

2014-02-24 09:49:37 -0800

[diff] [blame]

11307

enhancement.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

11314

<a href="#static_android.edge.availableEdgeModes">android.edge.availableEdgeModes</a>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

11315

</td>

11316

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

11321

Ruben Brunk

2014-03-04 15:01:25 -0800

[diff] [blame]

11322

11323

Zhijun He

2015-04-24 17:59:50 -0700

[diff] [blame]

11324

<li><a href="#tag_REPROC">REPROC</a></li>

Ruben Brunk

2014-03-04 15:01:25 -0800

[diff] [blame]

11325

</ul>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

11330

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

11331

</tr>

11332

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

11333

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

11334

Edge enhancement improves sharpness and details in the captured image. OFF means

11335

no enhancement will be applied by the camera device.

Zhijun He

2014-01-16 12:13:35 -0800

[diff] [blame]

11336

FAST/HIGH_QUALITY both mean camera device determined enhancement

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

11337

will be applied. HIGH_QUALITY mode indicates that the

Zhijun He

2014-01-16 12:13:35 -0800

[diff] [blame]

11338

camera device will use the highest-quality enhancement algorithms,

11339

even if it slows down capture rate. FAST means the camera device will

Chien-Yu Chen

2015-07-14 16:33:58 -0700

[diff] [blame]

11340

not slow down capture rate when applying edge enhancement. FAST may be the same as OFF if

11341

edge enhancement will slow down capture rate. Every output stream will have a similar

11342

amount of enhancement applied.

Eino-Ville Talvala

2015-07-07 10:40:59 -0700

[diff] [blame]

11343

ZERO_SHUTTER_LAG is meant to be used by applications that maintain a continuous circular

11344

buffer of high-resolution images during preview and reprocess image(s) from that buffer

11345

into a final capture when triggered by the user. In this mode, the camera device applies

11346

edge enhancement to low-resolution streams (below maximum recording resolution) to

11347

maximize preview quality, but does not apply edge enhancement to high-resolution streams,

11348

since those will be reprocessed later if necessary.

Zhijun He

2015-01-15 18:17:24 -0800

[diff] [blame]

11349

For YUV_REPROCESSING, these FAST/HIGH_QUALITY modes both mean that the camera

11350

device will apply FAST/HIGH_QUALITY YUV-domain edge enhancement, respectively.

Chien-Yu Chen

2015-07-14 16:33:58 -0700

[diff] [blame]

11351

The camera device may adjust its internal edge enhancement parameters for best

Zhijun He

2015-01-15 18:17:24 -0800

[diff] [blame]

11352

image quality based on the <a href="#controls_android.reprocess.effectiveExposureFactor">android.reprocess.effectiveExposureFactor</a>, if it is set.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

11353

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

11354

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

11355

Zhijun He

2015-01-15 18:17:24 -0800

[diff] [blame]

11356

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

11357

<th class="th_details" colspan="6">HAL Implementation Details</th>

Zhijun He

2015-01-15 18:17:24 -0800

[diff] [blame]

11358

</tr>

11359

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

11360

Zhijun He

2015-01-15 18:17:24 -0800

[diff] [blame]

11361

For YUV_REPROCESSING The HAL can use <a href="#controls_android.reprocess.effectiveExposureFactor">android.reprocess.effectiveExposureFactor</a> to

11362

adjust the internal edge enhancement reduction parameters appropriately to get the best

11363

quality images.

11364

</td>

11365

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

11366

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

11367

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

11368

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

11372

<td class="entry_name

11373

" rowspan="1">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

11374

android.edge.strength

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

11375

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

11376

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

11377

byte

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

11378

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

11379

[system]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

11380

11381

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

11385

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

11386

</td>

11387

11388

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

11389

Control the amount of edge enhancement

11390

applied to the images

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

11394

1-10; 10 is maximum sharpening

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

11404

Ruben Brunk

2014-03-04 15:01:25 -0800

[diff] [blame]

11405

Zhijun He

2014-05-23 11:02:34 -0700

[diff] [blame]

11406

<li><a href="#tag_FUTURE">FUTURE</a></li>

Ruben Brunk

2014-03-04 15:01:25 -0800

[diff] [blame]

11407

</ul>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

11408

</td>

11409

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

11410

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

11411

11412

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

11413

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

11414

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</tbody>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

11420

<tr><td colspan="7" class="kind">static</td></tr>

Ruben Brunk

2014-03-04 15:01:25 -0800

[diff] [blame]

<tr>

<th class="th_name">Property Name</th>

11425

11426

<th class="th_description">Description</th>

11427

<th class="th_units">Units</th>

11428

<th class="th_range">Range</th>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

11429

<th class="th_hal_version">Initial HIDL HAL version</th>

Ruben Brunk

2014-03-04 15:01:25 -0800

[diff] [blame]

</tr>

</thead>

<tbody>

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

11446

<td class="entry_name

Yin-Chia Yeh

2015-04-02 14:00:40 -0700

[diff] [blame]

11447

" rowspan="5">

Ruben Brunk

2014-03-04 15:01:25 -0800

[diff] [blame]

11448

android.edge.availableEdgeModes

</td>

byte

x

n

Eino-Ville Talvala

2014-05-27 10:50:30 -0700

[diff] [blame]

11457

[public as enumList]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

11458

11459

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

11460

[full]

11461

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

11462

Ruben Brunk

2014-03-04 15:01:25 -0800

[diff] [blame]

11463

<div class="entry_type_notes">list of enums</div>

11464

11465

11466

</td>

11467

11468

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

11469

List of edge enhancement modes for <a href="#controls_android.edge.mode">android.edge.mode</a> that are supported by this camera

11470

device.

Ruben Brunk

2014-03-04 15:01:25 -0800

[diff] [blame]

</td>

</td>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

11477

Any value listed in <a href="#controls_android.edge.mode">android.edge.mode</a>

Ruben Brunk

2014-03-04 15:01:25 -0800

[diff] [blame]

11478

</td>

11479

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Ruben Brunk

2014-03-04 15:01:25 -0800

[diff] [blame]

Zhijun He

2015-04-24 17:59:50 -0700

[diff] [blame]

11487

<li><a href="#tag_REPROC">REPROC</a></li>

Ruben Brunk

2014-03-04 15:01:25 -0800

[diff] [blame]

</ul>

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

11493

<th class="th_details" colspan="6">Details</th>

Ruben Brunk

2014-03-04 15:01:25 -0800

[diff] [blame]

11494

</tr>

11495

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

11496

Chien-Yu Chen

2015-07-08 11:49:38 -0700

[diff] [blame]

11497

Full-capability camera devices must always support OFF; camera devices that support

11498

YUV_REPROCESSING or PRIVATE_REPROCESSING will list ZERO_SHUTTER_LAG; all devices will

11499

list FAST.

Ruben Brunk

2014-03-04 15:01:25 -0800

[diff] [blame]

</td>

</tr>

Yin-Chia Yeh

2015-04-02 14:00:40 -0700

[diff] [blame]

11503

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

11504

<th class="th_details" colspan="6">HAL Implementation Details</th>

Yin-Chia Yeh

2015-04-02 14:00:40 -0700

[diff] [blame]

11505

</tr>

11506

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

11507

Yin-Chia Yeh

2015-04-02 14:00:40 -0700

[diff] [blame]

11508

HAL must support both FAST and HIGH_QUALITY if edge enhancement control is available

11509

on the camera device, but the underlying implementation can be the same for both modes.

11510

That is, if the highest quality implementation on the camera device does not slow down

11511

capture rate, then FAST and HIGH_QUALITY will generate the same output.

11512

</td>

11513

</tr>

Ruben Brunk

2014-03-04 15:01:25 -0800

[diff] [blame]

11514

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

11515

Ruben Brunk

2014-03-04 15:01:25 -0800

[diff] [blame]

11516

</tbody>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

11522

<tr><td colspan="7" class="kind">dynamic</td></tr>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

11523

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

11524

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

11525

<tr>

11526

<th class="th_name">Property Name</th>

11527

11528

<th class="th_description">Description</th>

11529

<th class="th_units">Units</th>

11530

<th class="th_range">Range</th>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

11531

<th class="th_hal_version">Initial HIDL HAL version</th>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</tr>

</thead>

<tbody>

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

11548

<td class="entry_name

Zhijun He

2015-01-15 18:17:24 -0800

[diff] [blame]

11549

" rowspan="5">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

11550

android.edge.mode

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

11551

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

11552

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

11553

byte

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

11554

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

11555

[public]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

11556

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

11557

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

11558

[full]

11559

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

11560

11561

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

11562

11563

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

11564

OFF (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

11565

No edge enhancement is applied.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

11566

</li>

11567

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

11568

FAST (v3.2)

Chien-Yu Chen

2015-07-14 16:33:58 -0700

[diff] [blame]

11569

Apply edge enhancement at a quality level that does not slow down frame rate

11570

relative to sensor output. It may be the same as OFF if edge enhancement will

11571

slow down frame rate relative to sensor.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

11572

</li>

11573

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

11574

HIGH_QUALITY (v3.2)

Yin-Chia Yeh

2015-04-02 14:00:40 -0700

[diff] [blame]

11575

Apply high-quality edge enhancement, at a cost of possibly reduced output frame rate.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

11576

</li>

Eino-Ville Talvala

2015-07-07 10:40:59 -0700

[diff] [blame]

11577

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

11578

ZERO_SHUTTER_LAG (v3.2)

Eino-Ville Talvala

2015-07-07 10:40:59 -0700

[diff] [blame]

11579

[optional]

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

11580

Edge enhancement is applied at different

11581

levels for different output streams, based on resolution. Streams at maximum recording

11582

resolution (see <a href="https://developer.android.com/reference/android/hardware/camera2/CameraDevice.html#createCaptureSession">CameraDevice#createCaptureSession</a>)

11583

or below have edge enhancement applied, while higher-resolution streams have no edge

11584

enhancement applied. The level of edge enhancement for low-resolution streams is tuned

11585

so that frame rate is not impacted, and the quality is equal to or better than FAST

11586

(since it is only applied to lower-resolution outputs, quality may improve from FAST).

Eino-Ville Talvala

2015-07-07 10:40:59 -0700

[diff] [blame]

11587

This mode is intended to be used by applications operating in a zero-shutter-lag mode

11588

with YUV or PRIVATE reprocessing, where the application continuously captures

11589

high-resolution intermediate buffers into a circular buffer, from which a final image is

11590

produced via reprocessing when a user takes a picture. For such a use case, the

11591

high-resolution buffers must not have edge enhancement applied to maximize efficiency of

11592

preview and to avoid double-applying enhancement when reprocessed, while low-resolution

11593

buffers (used for recording or preview, generally) need edge enhancement applied for

11594

reasonable preview quality.

11595

This mode is guaranteed to be supported by devices that support either the

11596

YUV_REPROCESSING or PRIVATE_REPROCESSING capabilities

Chien-Yu Chen

2015-07-08 11:49:38 -0700

[diff] [blame]

11597

(<a href="#static_android.request.availableCapabilities">android.request.availableCapabilities</a> lists either of those capabilities) and it will

11598

be the default mode for CAMERA3_TEMPLATE_ZERO_SHUTTER_LAG template.

Eino-Ville Talvala

2015-07-07 10:40:59 -0700

[diff] [blame]

11599

</li>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

11600

</ul>

11601

11602

</td>

11603

11604

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

11605

Operation mode for edge

Zhijun He

2014-02-24 09:49:37 -0800

[diff] [blame]

11606

enhancement.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

11613

<a href="#static_android.edge.availableEdgeModes">android.edge.availableEdgeModes</a>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

11614

</td>

11615

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

11620

Ruben Brunk

2014-03-04 15:01:25 -0800

[diff] [blame]

11621

11622

Zhijun He

2015-04-24 17:59:50 -0700

[diff] [blame]

11623

<li><a href="#tag_REPROC">REPROC</a></li>

Ruben Brunk

2014-03-04 15:01:25 -0800

[diff] [blame]

11624

</ul>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

11629

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

11630

</tr>

11631

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

11632

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

11633

Edge enhancement improves sharpness and details in the captured image. OFF means

11634

no enhancement will be applied by the camera device.

Zhijun He

2014-01-16 12:13:35 -0800

[diff] [blame]

11635

FAST/HIGH_QUALITY both mean camera device determined enhancement

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

11636

will be applied. HIGH_QUALITY mode indicates that the

Zhijun He

2014-01-16 12:13:35 -0800

[diff] [blame]

11637

camera device will use the highest-quality enhancement algorithms,

11638

even if it slows down capture rate. FAST means the camera device will

Chien-Yu Chen

2015-07-14 16:33:58 -0700

[diff] [blame]

11639

not slow down capture rate when applying edge enhancement. FAST may be the same as OFF if

11640

edge enhancement will slow down capture rate. Every output stream will have a similar

11641

amount of enhancement applied.

Eino-Ville Talvala

2015-07-07 10:40:59 -0700

[diff] [blame]

11642

ZERO_SHUTTER_LAG is meant to be used by applications that maintain a continuous circular

11643

buffer of high-resolution images during preview and reprocess image(s) from that buffer

11644

into a final capture when triggered by the user. In this mode, the camera device applies

11645

edge enhancement to low-resolution streams (below maximum recording resolution) to

11646

maximize preview quality, but does not apply edge enhancement to high-resolution streams,

11647

since those will be reprocessed later if necessary.

Zhijun He

2015-01-15 18:17:24 -0800

[diff] [blame]

11648

For YUV_REPROCESSING, these FAST/HIGH_QUALITY modes both mean that the camera

11649

device will apply FAST/HIGH_QUALITY YUV-domain edge enhancement, respectively.

Chien-Yu Chen

2015-07-14 16:33:58 -0700

[diff] [blame]

11650

The camera device may adjust its internal edge enhancement parameters for best

Zhijun He

2015-01-15 18:17:24 -0800

[diff] [blame]

11651

image quality based on the <a href="#controls_android.reprocess.effectiveExposureFactor">android.reprocess.effectiveExposureFactor</a>, if it is set.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

11652

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

11653

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

11654

Zhijun He

2015-01-15 18:17:24 -0800

[diff] [blame]

11655

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

11656

<th class="th_details" colspan="6">HAL Implementation Details</th>

Zhijun He

2015-01-15 18:17:24 -0800

[diff] [blame]

11657

</tr>

11658

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

11659

Zhijun He

2015-01-15 18:17:24 -0800

[diff] [blame]

11660

For YUV_REPROCESSING The HAL can use <a href="#controls_android.reprocess.effectiveExposureFactor">android.reprocess.effectiveExposureFactor</a> to

11661

adjust the internal edge enhancement reduction parameters appropriately to get the best

11662

quality images.

11663

</td>

11664

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

11665

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

11666

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

11667

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</tbody>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

11675

<tr><td colspan="7" id="section_flash" class="section">flash</td></tr>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

11676

11677

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

11678

<tr><td colspan="7" class="kind">controls</td></tr>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

11679

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

11680

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

11681

<tr>

11682

<th class="th_name">Property Name</th>

11683

11684

<th class="th_description">Description</th>

11685

<th class="th_units">Units</th>

11686

<th class="th_range">Range</th>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

11687

<th class="th_hal_version">Initial HIDL HAL version</th>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</tr>

</thead>

<tbody>

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

11704

<td class="entry_name

11705

" rowspan="3">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

11706

android.flash.firingPower

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

11707

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

11708

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

11709

byte

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

11710

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

11711

[system]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

11712

11713

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

11717

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

11718

</td>

11719

11720

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

11721

Power for flash firing/torch

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

11725

10 is max power; 0 is no flash. Linear

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Eino-Ville Talvala

2014-01-02 16:11:44 -0800

[diff] [blame]

11729

0 - 10

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

11730

</td>

11731

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

11736

11737

Zhijun He

2014-05-23 11:02:34 -0700

[diff] [blame]

11738

<li><a href="#tag_FUTURE">FUTURE</a></li>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</ul>

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

11742

</tr>

11743

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

11744

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

11745

</tr>

11746

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

11747

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

11748

Power for snapshot may use a different scale than

11749

for torch mode. Only one entry for torch mode will be

11750

used

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

11751

</td>

11752

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

11753

11754

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

11755

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

11756

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

11760

<td class="entry_name

11761

" rowspan="3">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

11762

android.flash.firingTime

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

11763

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

11764

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

11765

int64

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

11766

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

11767

[system]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

11768

11769

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

11773

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

11774

</td>

11775

11776

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

11777

Firing time of flash relative to start of

11778

exposure

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

11782

nanoseconds

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Eino-Ville Talvala

2014-01-02 16:11:44 -0800

[diff] [blame]

11786

0-(exposure time-flash duration)

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

11787

</td>

11788

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

11793

11794

Zhijun He

2014-05-23 11:02:34 -0700

[diff] [blame]

11795

<li><a href="#tag_FUTURE">FUTURE</a></li>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</ul>

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

11799

</tr>

11800

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

11801

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

11802

</tr>

11803

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

11804

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

11805

Clamped to (0, exposure time - flash

11806

duration).

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

11807

</td>

11808

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

11809

11810

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

11811

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

11812

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

11816

<td class="entry_name

11817

" rowspan="3">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

11818

android.flash.mode

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

11819

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

11820

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

11821

byte

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

11822

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

11823

[public]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

11824

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

11825

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

11826

[legacy]

11827

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

11828

11829

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

11830

11831

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

11832

OFF (v3.2)

Zhijun He

2014-01-15 13:47:59 -0800

[diff] [blame]

11833

Do not fire the flash for this capture.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

11834

</li>

11835

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

11836

SINGLE (v3.2)

Zhijun He

2014-01-15 13:47:59 -0800

[diff] [blame]

11837

If the flash is available and charged, fire flash

Zhijun He

2014-05-23 11:02:34 -0700

[diff] [blame]

11838

for this capture.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

11839

</li>

11840

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

11841

TORCH (v3.2)

Zhijun He

2014-01-15 13:47:59 -0800

[diff] [blame]

11842

Transition flash to continuously on.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</li>

</ul>

</td>

11847

11848

Zhijun He

2014-01-15 13:47:59 -0800

[diff] [blame]

11849

The desired mode for for the camera device's flash control.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

11862

11863

Igor Murashkin

2012-12-05 14:49:11 -0800

[diff] [blame]

11864

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</ul>

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

11868

</tr>

Zhijun He

2014-01-15 13:47:59 -0800

[diff] [blame]

11869

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

11870

<th class="th_details" colspan="6">Details</th>

Zhijun He

2014-01-15 13:47:59 -0800

[diff] [blame]

11871

</tr>

11872

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

11873

Zhijun He

2014-01-15 13:47:59 -0800

[diff] [blame]

11874

This control is only effective when flash unit is available

Zhijun He

2014-01-21 18:28:30 -0800

[diff] [blame]

11875

(<code><a href="#static_android.flash.info.available">android.flash.info.available</a> == true</code>).

Zhijun He

2014-01-15 13:47:59 -0800

[diff] [blame]

11876

When this control is used, the <a href="#controls_android.control.aeMode">android.control.aeMode</a> must be set to ON or OFF.

11877

Otherwise, the camera device auto-exposure related flash control (ON_AUTO_FLASH,

11878

ON_ALWAYS_FLASH, or ON_AUTO_FLASH_REDEYE) will override this control.

11879

When set to OFF, the camera device will not fire flash for this capture.

11880

When set to SINGLE, the camera device will fire flash regardless of the camera

11881

device's auto-exposure routine's result. When used in still capture case, this

Eino-Ville Talvala

2014-06-06 14:35:41 -0700

[diff] [blame]

11882

control should be used along with auto-exposure (AE) precapture metering sequence

Zhijun He

2014-01-15 13:47:59 -0800

[diff] [blame]

11883

(<a href="#controls_android.control.aePrecaptureTrigger">android.control.aePrecaptureTrigger</a>), otherwise, the image may be incorrectly exposed.

11884

When set to TORCH, the flash will be on continuously. This mode can be used

11885

for use cases such as preview, auto-focus assist, still capture, or video recording.

Zhijun He

2014-01-24 16:48:25 -0800

[diff] [blame]

11886

The flash status will be reported by <a href="#dynamic_android.flash.state">android.flash.state</a> in the capture result metadata.

Zhijun He

2014-01-15 13:47:59 -0800

[diff] [blame]

11887

</td>

11888

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

11889

11890

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

11891

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

11892

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</tbody>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

11898

<tr><td colspan="7" class="kind">static</td></tr>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

11899

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

11900

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

11901

<tr>

11902

<th class="th_name">Property Name</th>

11903

11904

<th class="th_description">Description</th>

11905

<th class="th_units">Units</th>

11906

<th class="th_range">Range</th>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

11907

<th class="th_hal_version">Initial HIDL HAL version</th>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</tr>

</thead>

<tbody>

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

11926

<td class="entry_name

11927

" rowspan="3">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

11928

android.flash.info.available

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

11929

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

11930

Zhijun He

2014-01-24 16:48:25 -0800

[diff] [blame]

11931

byte

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

11932

Zhijun He

2014-01-24 16:48:25 -0800

[diff] [blame]

11933

[public as boolean]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

11934

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

11935

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

11936

[legacy]

11937

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

11938

11939

Zhijun He

2014-01-24 16:48:25 -0800

[diff] [blame]

11940

11941

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

11942

FALSE (v3.2)

Zhijun He

2014-01-24 16:48:25 -0800

[diff] [blame]

11943

</li>

11944

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

11945

TRUE (v3.2)

Zhijun He

2014-01-24 16:48:25 -0800

[diff] [blame]

11946

</li>

11947

</ul>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

11948

11949

</td>

11950

11951

Zhijun He

2014-01-24 16:48:25 -0800

[diff] [blame]

11952

Whether this camera device has a

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

11953

flash unit.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

11966

11967

Igor Murashkin

2012-12-05 14:49:11 -0800

[diff] [blame]

11968

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</ul>

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

11972

</tr>

11973

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

11974

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

11975

</tr>

11976

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

11977

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

11978

Will be <code>false</code> if no flash is available.

11979

If there is no flash unit, none of the flash controls do

11980

anything.

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

11981

</td>

11982

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

11983

11984

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

11985

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

11986

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

11990

<td class="entry_name

11991

" rowspan="3">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

11992

android.flash.info.chargeDuration

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

11993

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

11994

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

11995

int64

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

11996

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

11997

[system]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

11998

11999

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

12003

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

12004

</td>

12005

12006

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

12007

Time taken before flash can fire

12008

again

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

12012

nanoseconds

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Eino-Ville Talvala

2014-01-02 16:11:44 -0800

[diff] [blame]

12016

0-1e9

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

12017

</td>

12018

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

12023

12024

Zhijun He

2014-05-23 11:02:34 -0700

[diff] [blame]

12025

<li><a href="#tag_FUTURE">FUTURE</a></li>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</ul>

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

12029

</tr>

12030

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

12031

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

12032

</tr>

12033

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

12034

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

12035

1 second too long/too short for recharge? Should

12036

this be power-dependent?

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

12037

</td>

12038

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

12039

12040

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

12041

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

12042

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

12043

Rucha Katakwar

2021-10-12 10:01:29 -0700

[diff] [blame]

12044

12045

12046

<td class="entry_name

12047

" rowspan="3">

12048

android.flash.info.strengthMaximumLevel

</td>

int32

[public]

</td>

12061

12062

12063

Maximum flashlight brightness level.

</td>

</td>

</td>

3.8

</td>

</td>

</tr>

<th class="th_details" colspan="6">Details</th>

</tr>

If this value is greater than 1, then the device supports controlling the

12086

flashlight brightness level via

Shuzhen Wang

2022-05-03 11:01:26 -0700

[diff] [blame]

12087

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraManager.html#turnOnTorchWithStrengthLevel">CameraManager#turnOnTorchWithStrengthLevel</a>.

Rucha Katakwar

2021-10-12 10:01:29 -0700

[diff] [blame]

12088

If this value is equal to 1, flashlight brightness control is not supported.

Rucha Katakwar

4be1516

2022-07-21 14:00:48 -0700

[diff] [blame]

12089

The value for this key will be null for devices with no flash unit.

12090

The maximum value is guaranteed to be safe to use for an indefinite duration in

12091

terms of device flashlight lifespan, but may be too bright for comfort for many

12092

use cases. Use the default torch brightness value to avoid problems with an

12093

over-bright flashlight.

Rucha Katakwar

2021-10-12 10:01:29 -0700

[diff] [blame]

</td>

</tr>

<td class="entry_name

12104

" rowspan="3">

12105

android.flash.info.strengthDefaultLevel

</td>

int32

[public]

</td>

12118

12119

12120

Default flashlight brightness level to be set via

Shuzhen Wang

2022-05-03 11:01:26 -0700

[diff] [blame]

12121

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraManager.html#turnOnTorchWithStrengthLevel">CameraManager#turnOnTorchWithStrengthLevel</a>.

Rucha Katakwar

2021-10-12 10:01:29 -0700

[diff] [blame]

</td>

</td>

</td>

3.8

</td>

</td>

</tr>

<th class="th_details" colspan="6">Details</th>

</tr>

If flash unit is available this will be greater than or equal to 1 and less

Rucha Katakwar

8f032e2

2021-10-21 05:47:53 +0000

[diff] [blame]

12144

or equal to <code><a href="#static_android.flash.info.strengthMaximumLevel">android.flash.info.strengthMaximumLevel</a></code>.

Rucha Katakwar

2021-10-12 10:01:29 -0700

[diff] [blame]

12145

Setting flashlight brightness above the default level

12146

(i.e.<code><a href="#static_android.flash.info.strengthDefaultLevel">android.flash.info.strengthDefaultLevel</a></code>) may make the device more

12147

likely to reach thermal throttling conditions and slow down, or drain the

12148

battery quicker than normal. To minimize such issues, it is recommended to

12149

start the flashlight at this default brightness until a user explicitly requests

Rucha Katakwar

8f032e2

2021-10-21 05:47:53 +0000

[diff] [blame]

12150

a brighter level.

12151

Note that the value for this key will be null for devices with no flash unit.

12152

The default level should always be > 0.

Rucha Katakwar

2021-10-12 10:01:29 -0700

[diff] [blame]

</td>

</tr>

12159

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

12165

<td class="entry_name

12166

" rowspan="1">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

12167

android.flash.colorTemperature

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

12168

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

12169

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

12170

byte

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

12171

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

12172

[system]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

12173

12174

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

12178

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

12179

</td>

12180

12181

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

12182

The x,y whitepoint of the

12183

flash

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

12187

pair of floats

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Eino-Ville Talvala

2014-01-02 16:11:44 -0800

[diff] [blame]

12191

0-1 for both

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

12192

</td>

12193

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

12198

12199

Zhijun He

2014-05-23 11:02:34 -0700

[diff] [blame]

12200

<li><a href="#tag_FUTURE">FUTURE</a></li>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</ul>

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

12204

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

12205

12206

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

12207

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

12208

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

12212

<td class="entry_name

12213

" rowspan="1">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

12214

android.flash.maxEnergy

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

12215

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

12216

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

12217

byte

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

12218

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

12219

[system]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

12220

12221

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

12225

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

12226

</td>

12227

12228

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

12229

Max energy output of the flash for a full

12230

power single flash

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

12234

lumen-seconds

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Igor Murashkin

2014-01-10 15:12:40 -0800

[diff] [blame]

12238

>= 0

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

12239

</td>

12240

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

12245

12246

Zhijun He

2014-05-23 11:02:34 -0700

[diff] [blame]

12247

<li><a href="#tag_FUTURE">FUTURE</a></li>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</ul>

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

12251

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

12252

12253

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

12254

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

12255

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</tbody>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

12261

<tr><td colspan="7" class="kind">dynamic</td></tr>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

12262

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

12263

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

12264

<tr>

12265

<th class="th_name">Property Name</th>

12266

12267

<th class="th_description">Description</th>

12268

<th class="th_units">Units</th>

12269

<th class="th_range">Range</th>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

12270

<th class="th_hal_version">Initial HIDL HAL version</th>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</tr>

</thead>

<tbody>

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

12287

<td class="entry_name

12288

" rowspan="3">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

12289

android.flash.firingPower

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

12290

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

12291

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

12292

byte

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

12293

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

12294

[system]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

12295

12296

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

12300

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

12301

</td>

12302

12303

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

12304

Power for flash firing/torch

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

12308

10 is max power; 0 is no flash. Linear

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Eino-Ville Talvala

2014-01-02 16:11:44 -0800

[diff] [blame]

12312

0 - 10

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

12313

</td>

12314

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

12319

Igor Murashkin

2012-12-05 14:49:11 -0800

[diff] [blame]

12320

Zhijun He

2014-05-23 11:02:34 -0700

[diff] [blame]

12321

<li><a href="#tag_FUTURE">FUTURE</a></li>

Igor Murashkin

2012-12-05 14:49:11 -0800

[diff] [blame]

12322

</ul>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

12323

</td>

12324

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

12325

</tr>

12326

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

12327

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

12328

</tr>

12329

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

12330

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

12331

Power for snapshot may use a different scale than

12332

for torch mode. Only one entry for torch mode will be

12333

used

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

12334

</td>

12335

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

12336

12337

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

12338

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

12339

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

12343

<td class="entry_name

12344

" rowspan="3">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

12345

android.flash.firingTime

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

12346

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

12347

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

12348

int64

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

12349

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

12350

[system]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

12351

12352

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

12356

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

12357

</td>

12358

12359

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

12360

Firing time of flash relative to start of

12361

exposure

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

12365

nanoseconds

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Eino-Ville Talvala

2014-01-02 16:11:44 -0800

[diff] [blame]

12369

0-(exposure time-flash duration)

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

12370

</td>

12371

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

12376

Igor Murashkin

2012-12-05 14:49:11 -0800

[diff] [blame]

12377

Zhijun He

2014-05-23 11:02:34 -0700

[diff] [blame]

12378

<li><a href="#tag_FUTURE">FUTURE</a></li>

Igor Murashkin

2012-12-05 14:49:11 -0800

[diff] [blame]

12379

</ul>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

12380

</td>

12381

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

12382

</tr>

12383

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

12384

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

12385

</tr>

12386

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

12387

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

12388

Clamped to (0, exposure time - flash

12389

duration).

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

12390

</td>

12391

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

12392

12393

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

12394

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

12395

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

12399

<td class="entry_name

12400

" rowspan="3">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

12401

android.flash.mode

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

12402

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

12403

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

12404

byte

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

12405

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

12406

[public]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

12407

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

12408

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

12409

[legacy]

12410

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

12411

12412

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

12413

12414

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

12415

OFF (v3.2)

Zhijun He

2014-01-15 13:47:59 -0800

[diff] [blame]

12416

Do not fire the flash for this capture.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

12417

</li>

12418

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

12419

SINGLE (v3.2)

Zhijun He

2014-01-15 13:47:59 -0800

[diff] [blame]

12420

If the flash is available and charged, fire flash

Zhijun He

2014-05-23 11:02:34 -0700

[diff] [blame]

12421

for this capture.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

12422

</li>

12423

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

12424

TORCH (v3.2)

Zhijun He

2014-01-15 13:47:59 -0800

[diff] [blame]

12425

Transition flash to continuously on.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</li>

</ul>

</td>

12430

12431

Zhijun He

2014-01-15 13:47:59 -0800

[diff] [blame]

12432

The desired mode for for the camera device's flash control.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

12445

Igor Murashkin

2012-12-05 14:49:11 -0800

[diff] [blame]

12446

12447

12448

</ul>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

12449

</td>

12450

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

12451

</tr>

Zhijun He

2014-01-15 13:47:59 -0800

[diff] [blame]

12452

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

12453

<th class="th_details" colspan="6">Details</th>

Zhijun He

2014-01-15 13:47:59 -0800

[diff] [blame]

12454

</tr>

12455

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

12456

Zhijun He

2014-01-15 13:47:59 -0800

[diff] [blame]

12457

This control is only effective when flash unit is available

Zhijun He

2014-01-21 18:28:30 -0800

[diff] [blame]

12458

(<code><a href="#static_android.flash.info.available">android.flash.info.available</a> == true</code>).

Zhijun He

2014-01-15 13:47:59 -0800

[diff] [blame]

12459

When this control is used, the <a href="#controls_android.control.aeMode">android.control.aeMode</a> must be set to ON or OFF.

12460

Otherwise, the camera device auto-exposure related flash control (ON_AUTO_FLASH,

12461

ON_ALWAYS_FLASH, or ON_AUTO_FLASH_REDEYE) will override this control.

12462

When set to OFF, the camera device will not fire flash for this capture.

12463

When set to SINGLE, the camera device will fire flash regardless of the camera

12464

device's auto-exposure routine's result. When used in still capture case, this

Eino-Ville Talvala

2014-06-06 14:35:41 -0700

[diff] [blame]

12465

control should be used along with auto-exposure (AE) precapture metering sequence

Zhijun He

2014-01-15 13:47:59 -0800

[diff] [blame]

12466

(<a href="#controls_android.control.aePrecaptureTrigger">android.control.aePrecaptureTrigger</a>), otherwise, the image may be incorrectly exposed.

12467

When set to TORCH, the flash will be on continuously. This mode can be used

12468

for use cases such as preview, auto-focus assist, still capture, or video recording.

Zhijun He

2014-01-24 16:48:25 -0800

[diff] [blame]

12469

The flash status will be reported by <a href="#dynamic_android.flash.state">android.flash.state</a> in the capture result metadata.

Zhijun He

2014-01-15 13:47:59 -0800

[diff] [blame]

12470

</td>

12471

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

12472

12473

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

12474

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

12475

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

12479

<td class="entry_name

12480

" rowspan="3">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

12481

android.flash.state

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

12482

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

12483

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

12484

byte

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

12485

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

12486

[public]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

12487

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

12488

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

12489

[limited]

12490

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

12491

12492

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

12493

12494

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

12495

UNAVAILABLE (v3.2)

Zhijun He

2014-03-25 11:33:29 -0700

[diff] [blame]

12496

No flash on camera.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

12497

</li>

12498

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

12499

CHARGING (v3.2)

Zhijun He

2014-03-25 11:33:29 -0700

[diff] [blame]

12500

Flash is charging and cannot be fired.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

12501

</li>

12502

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

12503

READY (v3.2)

Zhijun He

2014-03-25 11:33:29 -0700

[diff] [blame]

12504

Flash is ready to fire.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

12505

</li>

12506

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

12507

FIRED (v3.2)

Zhijun He

2014-03-25 11:33:29 -0700

[diff] [blame]

12508

Flash fired for this capture.

12509

</li>

12510

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

12511

PARTIAL (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

12512

Flash partially illuminated this frame.

12513

This is usually due to the next or previous frame having

12514

the flash fire, and the flash spilling into this capture

Zhijun He

2014-03-25 11:33:29 -0700

[diff] [blame]

12515

due to hardware limitations.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</li>

</ul>

</td>

12520

12521

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

12522

Current state of the flash

Zhijun He

2014-01-24 16:48:25 -0800

[diff] [blame]

12523

unit.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

12539

</tr>

Zhijun He

2014-01-24 16:48:25 -0800

[diff] [blame]

12540

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

12541

<th class="th_details" colspan="6">Details</th>

Zhijun He

2014-01-24 16:48:25 -0800

[diff] [blame]

12542

</tr>

12543

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

12544

Zhijun He

2014-01-24 16:48:25 -0800

[diff] [blame]

12545

When the camera device doesn't have flash unit

12546

(i.e. <code><a href="#static_android.flash.info.available">android.flash.info.available</a> == false</code>), this state will always be UNAVAILABLE.

12547

Other states indicate the current flash status.

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

12548

In certain conditions, this will be available on LEGACY devices:

12549

<ul>

12550

<li>Flash-less cameras always return UNAVAILABLE.</li>

12551

<li>Using <a href="#controls_android.control.aeMode">android.control.aeMode</a> <code>==</code> ON_ALWAYS_FLASH

12552

will always return FIRED.</li>

12553

<li>Using <a href="#controls_android.flash.mode">android.flash.mode</a> <code>==</code> TORCH

12554

will always return FIRED.</li>

12555

</ul>

12556

In all other conditions the state will not be available on

12557

LEGACY devices (i.e. it will be <code>null</code>).

Zhijun He

2014-01-24 16:48:25 -0800

[diff] [blame]

12558

</td>

12559

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

12560

12561

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

12562

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

12563

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</tbody>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

12571

<tr><td colspan="7" id="section_hotPixel" class="section">hotPixel</td></tr>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

12572

12573

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

12574

<tr><td colspan="7" class="kind">controls</td></tr>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

12575

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

12576

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

12577

<tr>

12578

<th class="th_name">Property Name</th>

12579

12580

<th class="th_description">Description</th>

12581

<th class="th_units">Units</th>

12582

<th class="th_range">Range</th>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

12583

<th class="th_hal_version">Initial HIDL HAL version</th>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</tr>

</thead>

<tbody>

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

12600

<td class="entry_name

12601

" rowspan="3">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

12602

android.hotPixel.mode

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

12603

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

12604

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

12605

byte

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

12606

Ruben Brunk

2014-01-31 12:38:46 -0800

[diff] [blame]

12607

[public]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

12608

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

12612

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

12613

12614

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

12615

OFF (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

12616

No hot pixel correction is applied.

12617

The frame rate must not be reduced relative to sensor raw output

Ruben Brunk

2014-01-31 12:38:46 -0800

[diff] [blame]

12618

for this option.

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

12619

The hotpixel map may be returned in <a href="#dynamic_android.statistics.hotPixelMap">android.statistics.hotPixelMap</a>.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

12620

</li>

12621

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

12622

FAST (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

12623

Hot pixel correction is applied, without reducing frame

12624

rate relative to sensor raw output.

12625

The hotpixel map may be returned in <a href="#dynamic_android.statistics.hotPixelMap">android.statistics.hotPixelMap</a>.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

12626

</li>

12627

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

12628

HIGH_QUALITY (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

12629

High-quality hot pixel correction is applied, at a cost

Yin-Chia Yeh

2015-04-02 14:00:40 -0700

[diff] [blame]

12630

of possibly reduced frame rate relative to sensor raw output.

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

12631

The hotpixel map may be returned in <a href="#dynamic_android.statistics.hotPixelMap">android.statistics.hotPixelMap</a>.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</li>

</ul>

</td>

12636

12637

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

12638

Operational mode for hot pixel correction.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

12645

<a href="#static_android.hotPixel.availableHotPixelModes">android.hotPixel.availableHotPixelModes</a>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

12646

</td>

12647

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

12652

12653

Igor Murashkin

2012-12-05 14:49:11 -0800

[diff] [blame]

12654

Eino-Ville Talvala

2014-07-15 10:43:01 -0700

[diff] [blame]

12655

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</ul>

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

12659

</tr>

Ruben Brunk

2014-03-04 14:09:44 -0800

[diff] [blame]

12660

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

12661

<th class="th_details" colspan="6">Details</th>

Ruben Brunk

2014-03-04 14:09:44 -0800

[diff] [blame]

12662

</tr>

12663

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

12664

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

12665

Hotpixel correction interpolates out, or otherwise removes, pixels

12666

that do not accurately measure the incoming light (i.e. pixels that

12667

are stuck at an arbitrary value or are oversensitive).

Ruben Brunk

2014-03-04 14:09:44 -0800

[diff] [blame]

12668

</td>

12669

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

12670

12671

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

12672

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

12673

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</tbody>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

12679

<tr><td colspan="7" class="kind">static</td></tr>

Ruben Brunk

2014-03-04 14:09:44 -0800

[diff] [blame]

<tr>

<th class="th_name">Property Name</th>

12684

12685

<th class="th_description">Description</th>

12686

<th class="th_units">Units</th>

12687

<th class="th_range">Range</th>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

12688

<th class="th_hal_version">Initial HIDL HAL version</th>

Ruben Brunk

2014-03-04 14:09:44 -0800

[diff] [blame]

</tr>

</thead>

<tbody>

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

12705

<td class="entry_name

12706

" rowspan="5">

Ruben Brunk

2014-03-04 14:09:44 -0800

[diff] [blame]

12707

android.hotPixel.availableHotPixelModes

</td>

byte

x

n

Eino-Ville Talvala

2014-05-27 10:50:30 -0700

[diff] [blame]

12716

[public as enumList]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

12720

Ruben Brunk

2014-03-04 14:09:44 -0800

[diff] [blame]

12721

<div class="entry_type_notes">list of enums</div>

12722

12723

12724

</td>

12725

12726

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

12727

List of hot pixel correction modes for <a href="#controls_android.hotPixel.mode">android.hotPixel.mode</a> that are supported by this

Ruben Brunk

2014-03-04 14:09:44 -0800

[diff] [blame]

camera device.

</td>

</td>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

12735

Any value listed in <a href="#controls_android.hotPixel.mode">android.hotPixel.mode</a>

Ruben Brunk

2014-03-04 14:09:44 -0800

[diff] [blame]

12736

</td>

12737

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Ruben Brunk

2014-03-04 14:09:44 -0800

[diff] [blame]

12742

12743

Ruben Brunk

2014-03-04 14:09:44 -0800

[diff] [blame]

12744

Eino-Ville Talvala

2014-07-15 10:43:01 -0700

[diff] [blame]

12745

Ruben Brunk

2014-03-04 14:09:44 -0800

[diff] [blame]

</ul>

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

12751

<th class="th_details" colspan="6">Details</th>

Ruben Brunk

2014-03-04 14:09:44 -0800

[diff] [blame]

12752

</tr>

12753

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

12754

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

12755

FULL mode camera devices will always support FAST.

Ruben Brunk

2014-03-04 14:09:44 -0800

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

12760

<th class="th_details" colspan="6">HAL Implementation Details</th>

Ruben Brunk

2014-03-04 14:09:44 -0800

[diff] [blame]

12761

</tr>

12762

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

12763

Ruben Brunk

2014-03-04 14:09:44 -0800

[diff] [blame]

12764

To avoid performance issues, there will be significantly fewer hot

Yin-Chia Yeh

2015-04-02 14:00:40 -0700

[diff] [blame]

12765

pixels than actual pixels on the camera sensor.

12766

HAL must support both FAST and HIGH_QUALITY if hot pixel correction control is available

12767

on the camera device, but the underlying implementation can be the same for both modes.

12768

That is, if the highest quality implementation on the camera device does not slow down

12769

capture rate, then FAST and HIGH_QUALITY will generate the same output.

Ruben Brunk

2014-03-04 14:09:44 -0800

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

12773

Ruben Brunk

2014-03-04 14:09:44 -0800

[diff] [blame]

12774

</tbody>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

12780

<tr><td colspan="7" class="kind">dynamic</td></tr>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

12781

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

12782

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

12783

<tr>

12784

<th class="th_name">Property Name</th>

12785

12786

<th class="th_description">Description</th>

12787

<th class="th_units">Units</th>

12788

<th class="th_range">Range</th>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

12789

<th class="th_hal_version">Initial HIDL HAL version</th>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</tr>

</thead>

<tbody>

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

12806

<td class="entry_name

12807

" rowspan="3">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

12808

android.hotPixel.mode

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

12809

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

12810

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

12811

byte

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

12812

Ruben Brunk

2014-01-31 12:38:46 -0800

[diff] [blame]

12813

[public]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

12814

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

12818

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

12819

12820

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

12821

OFF (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

12822

No hot pixel correction is applied.

12823

The frame rate must not be reduced relative to sensor raw output

Ruben Brunk

2014-01-31 12:38:46 -0800

[diff] [blame]

12824

for this option.

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

12825

The hotpixel map may be returned in <a href="#dynamic_android.statistics.hotPixelMap">android.statistics.hotPixelMap</a>.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

12826

</li>

12827

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

12828

FAST (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

12829

Hot pixel correction is applied, without reducing frame

12830

rate relative to sensor raw output.

12831

The hotpixel map may be returned in <a href="#dynamic_android.statistics.hotPixelMap">android.statistics.hotPixelMap</a>.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

12832

</li>

12833

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

12834

HIGH_QUALITY (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

12835

High-quality hot pixel correction is applied, at a cost

Yin-Chia Yeh

2015-04-02 14:00:40 -0700

[diff] [blame]

12836

of possibly reduced frame rate relative to sensor raw output.

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

12837

The hotpixel map may be returned in <a href="#dynamic_android.statistics.hotPixelMap">android.statistics.hotPixelMap</a>.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</li>

</ul>

</td>

12842

12843

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

12844

Operational mode for hot pixel correction.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

12851

<a href="#static_android.hotPixel.availableHotPixelModes">android.hotPixel.availableHotPixelModes</a>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

12852

</td>

12853

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

12858

12859

Igor Murashkin

2012-12-05 14:49:11 -0800

[diff] [blame]

12860

Eino-Ville Talvala

2014-07-15 10:43:01 -0700

[diff] [blame]

12861

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</ul>

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

12865

</tr>

Ruben Brunk

2014-03-04 14:09:44 -0800

[diff] [blame]

12866

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

12867

<th class="th_details" colspan="6">Details</th>

Ruben Brunk

2014-03-04 14:09:44 -0800

[diff] [blame]

12868

</tr>

12869

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

12870

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

12871

Hotpixel correction interpolates out, or otherwise removes, pixels

12872

that do not accurately measure the incoming light (i.e. pixels that

12873

are stuck at an arbitrary value or are oversensitive).

Ruben Brunk

2014-03-04 14:09:44 -0800

[diff] [blame]

12874

</td>

12875

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

12876

12877

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

12878

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

12879

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</tbody>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

12887

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

12888

12889

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

12890

<tr><td colspan="7" class="kind">controls</td></tr>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

12891

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

12892

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

12893

<tr>

12894

<th class="th_name">Property Name</th>

12895

12896

<th class="th_description">Description</th>

12897

<th class="th_units">Units</th>

12898

<th class="th_range">Range</th>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

12899

<th class="th_hal_version">Initial HIDL HAL version</th>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</tr>

</thead>

<tbody>

Ruben Brunk

2014-05-27 18:52:49 -0700

[diff] [blame]

12915

12916

<td class="entry_name

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

12917

" rowspan="3">

Ruben Brunk

2014-05-27 18:52:49 -0700

[diff] [blame]

12918

android.jpeg.gpsLocation

</td>

byte

Yin-Chia Yeh

2016-04-02 16:30:30 -0700

[diff] [blame]

12923

[java_public as location]

Ruben Brunk

2014-05-27 18:52:49 -0700

[diff] [blame]

[synthetic]

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

12927

[legacy]

12928

Ruben Brunk

2014-05-27 18:52:49 -0700

[diff] [blame]

</td>

12933

12934

12935

A location object to use when generating image GPS metadata.

</td>

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Ruben Brunk

2014-05-27 18:52:49 -0700

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

12952

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

12953

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

12954

</tr>

12955

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

12956

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

12957

Setting a location object in a request will include the GPS coordinates of the location

12958

into any JPEG images captured based on the request. These coordinates can then be

12959

viewed by anyone who receives the JPEG image.

Shuzhen Wang

2018-12-28 18:50:53 -0800

[diff] [blame]

12960

This tag is also used for HEIC image capture.

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

12961

</td>

12962

</tr>

Ruben Brunk

2014-05-27 18:52:49 -0700

[diff] [blame]

12963

12964

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

12965

Ruben Brunk

2014-05-27 18:52:49 -0700

[diff] [blame]

12966

12967

12968

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

12969

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

12970

<td class="entry_name

Shuzhen Wang

2018-12-28 18:50:53 -0800

[diff] [blame]

12971

" rowspan="3">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

12972

android.jpeg.gpsCoordinates

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

12973

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

12974

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

12975

double

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

x

3

Yin-Chia Yeh

2016-04-02 16:30:30 -0700

[diff] [blame]

12981

[ndk_public]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

12982

12983

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

12984

[legacy]

12985

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

12986

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

12987

<div class="entry_type_notes">latitude, longitude, altitude. First two in degrees, the third in meters</div>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

12988

12989

12990

</td>

12991

12992

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

12993

GPS coordinates to include in output JPEG

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

12994

EXIF.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

Eino-Ville Talvala

2014-01-02 16:11:44 -0800

[diff] [blame]

13001

(-180 - 180], [-90,90], [-inf, inf]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

13002

</td>

13003

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

13008

13009

Igor Murashkin

2012-12-05 14:49:11 -0800

[diff] [blame]

13010

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</ul>

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

13014

</tr>

Shuzhen Wang

2018-12-28 18:50:53 -0800

[diff] [blame]

13015

13016

<th class="th_details" colspan="6">Details</th>

</tr>

This tag is also used for HEIC image capture.

13021

</td>

13022

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

13023

13024

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

13025

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

13026

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

13030

<td class="entry_name

Shuzhen Wang

2018-12-28 18:50:53 -0800

[diff] [blame]

13031

" rowspan="3">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

13032

android.jpeg.gpsProcessingMethod

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

13033

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

13034

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

13035

byte

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

13036

Yin-Chia Yeh

2016-04-02 16:30:30 -0700

[diff] [blame]

13037

[ndk_public as string]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

13038

13039

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

13040

[legacy]

13041

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

13045

</td>

13046

13047

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

13048

32 characters describing GPS algorithm to

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

13049

include in EXIF.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

13053

UTF-8 null-terminated string

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

13063

13064

Igor Murashkin

2012-12-05 14:49:11 -0800

[diff] [blame]

13065

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</ul>

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

13069

</tr>

Shuzhen Wang

2018-12-28 18:50:53 -0800

[diff] [blame]

13070

13071

<th class="th_details" colspan="6">Details</th>

</tr>

This tag is also used for HEIC image capture.

13076

</td>

13077

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

13078

13079

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

13080

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

13081

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

13085

<td class="entry_name

Shuzhen Wang

2018-12-28 18:50:53 -0800

[diff] [blame]

13086

" rowspan="3">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

13087

android.jpeg.gpsTimestamp

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

13088

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

13089

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

13090

int64

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

13091

Yin-Chia Yeh

2016-04-02 16:30:30 -0700

[diff] [blame]

13092

[ndk_public]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

13093

13094

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

13095

[legacy]

13096

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

13100

</td>

13101

13102

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

13103

Time GPS fix was made to include in

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

13104

EXIF.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

13108

UTC in seconds since January 1, 1970

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

13118

13119

Igor Murashkin

2012-12-05 14:49:11 -0800

[diff] [blame]

13120

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</ul>

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

13124

</tr>

Shuzhen Wang

2018-12-28 18:50:53 -0800

[diff] [blame]

13125

13126

<th class="th_details" colspan="6">Details</th>

</tr>

This tag is also used for HEIC image capture.

13131

</td>

13132

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

13133

13134

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

13135

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

13136

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

13140

<td class="entry_name

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

13141

" rowspan="3">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

13142

android.jpeg.orientation

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

13143

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

13144

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

13145

int32

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

13146

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

13147

[public]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

13148

13149

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

13150

[legacy]

13151

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

13155

</td>

13156

13157

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

13158

The orientation for a JPEG image.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

13162

Degrees in multiples of 90

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Eino-Ville Talvala

2014-01-02 16:11:44 -0800

[diff] [blame]

13166

0, 90, 180, 270

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

13167

</td>

13168

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

13173

13174

Igor Murashkin

2012-12-05 14:49:11 -0800

[diff] [blame]

13175

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</ul>

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

13179

</tr>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

13180

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

13181

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

13182

</tr>

13183

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

13184

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

13185

The clockwise rotation angle in degrees, relative to the orientation

13186

to the camera, that the JPEG picture needs to be rotated by, to be viewed

13187

upright.

13188

Camera devices may either encode this value into the JPEG EXIF header, or

Yin-Chia Yeh

58a8b19

2015-03-27 13:54:56 -0700

[diff] [blame]

13189

rotate the image data to match this orientation. When the image data is rotated,

13190

the thumbnail data will also be rotated.

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

13191

Note that this orientation is relative to the orientation of the camera sensor, given

13192

by <a href="#static_android.sensor.orientation">android.sensor.orientation</a>.

Emilian Peev

2018-03-28 11:17:14 +0100

[diff] [blame]

13193

To translate from the device orientation given by the Android sensor APIs for camera

13194

sensors which are not EXTERNAL, the following sample code may be used:

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

13195

<pre><code>private int getJpegOrientation(CameraCharacteristics c, int deviceOrientation) {

13196

if (deviceOrientation == android.view.OrientationEventListener.ORIENTATION_UNKNOWN) return 0;

13197

int sensorOrientation = c.get(CameraCharacteristics.SENSOR_ORIENTATION);

13198

13199

// Round device orientation to a multiple of 90

13200

deviceOrientation = (deviceOrientation + 45) / 90 * 90;

13201

13202

// Reverse device orientation for front-facing cameras

13203

boolean facingFront = c.get(CameraCharacteristics.LENS_FACING) == CameraCharacteristics.LENS_FACING_FRONT;

13204

if (facingFront) deviceOrientation = -deviceOrientation;

13205

13206

// Calculate desired JPEG orientation relative to camera orientation to make

13207

// the image upright relative to the device orientation

13208

int jpegOrientation = (sensorOrientation + deviceOrientation + 360) % 360;

13209

13210

return jpegOrientation;

13211

}

13212

</code></pre>

Emilian Peev

2018-03-28 11:17:14 +0100

[diff] [blame]

13213

For EXTERNAL cameras the sensor orientation will always be set to 0 and the facing will

13214

also be set to EXTERNAL. The above code is not relevant in such case.

Shuzhen Wang

2018-12-28 18:50:53 -0800

[diff] [blame]

13215

This tag is also used to describe the orientation of the HEIC image capture, in which

13216

case the rotation is reflected by

13217

<a href="https://developer.android.com/reference/android/media/ExifInterface.html#TAG_ORIENTATION">EXIF orientation flag</a>, and not by

13218

rotating the image data itself.

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

13219

</td>

13220

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

13221

13222

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

13223

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

13224

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

13228

<td class="entry_name

13229

" rowspan="3">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

13230

android.jpeg.quality

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

13231

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

13232

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

13233

byte

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

13234

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

13235

[public]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

13236

13237

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

13238

[legacy]

13239

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

13243

</td>

13244

13245

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

13246

Compression quality of the final JPEG

Eino-Ville Talvala

2014-06-06 14:35:41 -0700

[diff] [blame]

13247

image.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

Eino-Ville Talvala

2014-01-02 16:11:44 -0800

[diff] [blame]

13254

1-100; larger is higher quality

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

13255

</td>

13256

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

13261

13262

Igor Murashkin

2012-12-05 14:49:11 -0800

[diff] [blame]

13263

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</ul>

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

13267

</tr>

13268

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

13269

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

13270

</tr>

13271

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

13272

Shuzhen Wang

2018-12-28 18:50:53 -0800

[diff] [blame]

13273

85-95 is typical usage range. This tag is also used to describe the quality

13274

of the HEIC image capture.

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

13275

</td>

13276

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

13277

13278

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

13279

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

13280

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

13284

<td class="entry_name

Shuzhen Wang

2018-12-28 18:50:53 -0800

[diff] [blame]

13285

" rowspan="3">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

13286

android.jpeg.thumbnailQuality

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

13287

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

13288

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

13289

byte

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

13290

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

13291

[public]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

13292

13293

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

13294

[legacy]

13295

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

13299

</td>

13300

13301

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

13302

Compression quality of JPEG

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

13303

thumbnail.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

Eino-Ville Talvala

2014-01-02 16:11:44 -0800

[diff] [blame]

13310

1-100; larger is higher quality

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

13311

</td>

13312

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

13317

13318

Igor Murashkin

2012-12-05 14:49:11 -0800

[diff] [blame]

13319

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</ul>

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

13323

</tr>

Shuzhen Wang

2018-12-28 18:50:53 -0800

[diff] [blame]

13324

13325

<th class="th_details" colspan="6">Details</th>

</tr>

This tag is also used to describe the quality of the HEIC image capture.

13330

</td>

13331

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

13332

13333

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

13334

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

13335

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

13339

<td class="entry_name

Zhijun He

2014-05-21 17:51:05 -0700

[diff] [blame]

13340

" rowspan="5">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

13341

android.jpeg.thumbnailSize

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

13342

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

13343

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

13344

int32

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

x

2

Igor Murashkin

2013-07-17 16:29:34 -0700

[diff] [blame]

13350

[public as size]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

13351

13352

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

13353

[legacy]

13354

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

13358

</td>

13359

13360

Eino-Ville Talvala

2014-06-06 14:35:41 -0700

[diff] [blame]

13361

Resolution of embedded JPEG thumbnail.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

13368

<a href="#static_android.jpeg.availableThumbnailSizes">android.jpeg.availableThumbnailSizes</a>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

13369

</td>

13370

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

13375

13376

Igor Murashkin

2012-12-05 14:49:11 -0800

[diff] [blame]

13377

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</ul>

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

13381

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

13382

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

13383

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

13384

</tr>

13385

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

13386

Zhijun He

2014-01-16 12:13:35 -0800

[diff] [blame]

13387

When set to (0, 0) value, the JPEG EXIF will not contain thumbnail,

13388

but the captured JPEG will still be a valid image.

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

13389

For best results, when issuing a request for a JPEG image, the thumbnail size selected

13390

should have the same aspect ratio as the main JPEG output.

Zhijun He

2014-05-21 17:51:05 -0700

[diff] [blame]

13391

If the thumbnail image aspect ratio differs from the JPEG primary image aspect

13392

ratio, the camera device creates the thumbnail by cropping it from the primary image.

13393

For example, if the primary image has 4:3 aspect ratio, the thumbnail image has

13394

16:9 aspect ratio, the primary image will be cropped vertically (letterbox) to

13395

generate the thumbnail image. The thumbnail image will always have a smaller Field

13396

Of View (FOV) than the primary image when aspect ratios differ.

Yin-Chia Yeh

2015-06-22 15:50:05 -0700

[diff] [blame]

13397

When an <a href="#controls_android.jpeg.orientation">android.jpeg.orientation</a> of non-zero degree is requested,

13398

the camera device will handle thumbnail rotation in one of the following ways:

13399

<ul>

13400

<li>Set the <a href="https://developer.android.com/reference/android/media/ExifInterface.html#TAG_ORIENTATION">EXIF orientation flag</a>

13401

and keep jpeg and thumbnail image data unrotated.</li>

13402

<li>Rotate the jpeg and thumbnail image data and not set

13403

<a href="https://developer.android.com/reference/android/media/ExifInterface.html#TAG_ORIENTATION">EXIF orientation flag</a>. In this

Shuzhen Wang

2022-05-03 11:01:26 -0700

[diff] [blame]

13404

case, LIMITED or FULL hardware level devices will report rotated thumbnail size in

Yin-Chia Yeh

2015-06-22 15:50:05 -0700

[diff] [blame]

13405

capture result, so the width and height will be interchanged if 90 or 270 degree

13406

orientation is requested. LEGACY device will always report unrotated thumbnail

13407

size.</li>

13408

</ul>

Shuzhen Wang

2018-12-28 18:50:53 -0800

[diff] [blame]

13409

The tag is also used as thumbnail size for HEIC image format capture, in which case the

13410

the thumbnail rotation is reflected by

13411

<a href="https://developer.android.com/reference/android/media/ExifInterface.html#TAG_ORIENTATION">EXIF orientation flag</a>, and not by

13412

rotating the thumbnail data itself.

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

</td>

</tr>

Zhijun He

2014-05-21 17:51:05 -0700

[diff] [blame]

13416

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

13417

<th class="th_details" colspan="6">HAL Implementation Details</th>

Zhijun He

2014-05-21 17:51:05 -0700

[diff] [blame]

13418

</tr>

13419

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

13420

Zhijun He

2014-05-21 17:51:05 -0700

[diff] [blame]

13421

The HAL must not squeeze or stretch the downscaled primary image to generate thumbnail.

Yin-Chia Yeh

2018-06-15 15:35:05 -0700

[diff] [blame]

13422

The cropping must be done on the primary jpeg image rather than the sensor pre-correction

13423

active array. The stream cropping rule specified by "S5. Cropping" in camera3.h doesn't

13424

apply to the thumbnail image cropping.

Zhijun He

2014-05-21 17:51:05 -0700

[diff] [blame]

13425

</td>

13426

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

13427

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

13428

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

13429

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</tbody>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

13435

<tr><td colspan="7" class="kind">static</td></tr>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

13436

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

13437

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

13438

<tr>

13439

<th class="th_name">Property Name</th>

13440

13441

<th class="th_description">Description</th>

13442

<th class="th_units">Units</th>

13443

<th class="th_range">Range</th>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

13444

<th class="th_hal_version">Initial HIDL HAL version</th>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</tr>

</thead>

<tbody>

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

13461

<td class="entry_name

13462

" rowspan="3">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

13463

android.jpeg.availableThumbnailSizes

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

13464

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

13465

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

13466

int32

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

x

2 x n

Igor Murashkin

2013-07-17 16:29:34 -0700

[diff] [blame]

13472

[public as size]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

13473

13474

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

13475

[legacy]

13476

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

13480

</td>

13481

13482

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

13483

List of JPEG thumbnail sizes for <a href="#controls_android.jpeg.thumbnailSize">android.jpeg.thumbnailSize</a> supported by this

13484

camera device.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

13491

</td>

13492

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

13497

13498

Igor Murashkin

2012-12-05 14:49:11 -0800

[diff] [blame]

13499

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</ul>

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

13503

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

13504

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

13505

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

13506

</tr>

13507

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

13508

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

13509

This list will include at least one non-zero resolution, plus <code>(0,0)</code> for indicating no

13510

thumbnail should be generated.

Shuzhen Wang

2022-05-03 11:01:26 -0700

[diff] [blame]

13511

Below conditions will be satisfied for this size list:

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

13512

<ul>

Zhijun He

2014-01-16 12:13:35 -0800

[diff] [blame]

13513

<li>The sizes will be sorted by increasing pixel area (width x height).

13514

If several resolutions have the same area, they will be sorted by increasing width.</li>

13515

<li>The aspect ratio of the largest thumbnail size will be same as the

Igor Murashkin

2014-02-07 14:31:31 -0800

[diff] [blame]

13516

aspect ratio of largest JPEG output size in <a href="#static_android.scaler.availableStreamConfigurations">android.scaler.availableStreamConfigurations</a>.

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

13517

The largest size is defined as the size that has the largest pixel area

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

13518

in a given size list.</li>

Igor Murashkin

2014-02-07 14:31:31 -0800

[diff] [blame]

13519

<li>Each output JPEG size in <a href="#static_android.scaler.availableStreamConfigurations">android.scaler.availableStreamConfigurations</a> will have at least

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

13520

one corresponding size that has the same aspect ratio in availableThumbnailSizes,

13521

and vice versa.</li>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

13522

<li>All non-<code>(0, 0)</code> sizes will have non-zero widths and heights.</li>

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

13523

</ul>

Shuzhen Wang

2018-12-28 18:50:53 -0800

[diff] [blame]

13524

This list is also used as supported thumbnail sizes for HEIC image format capture.

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

13529

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

13530

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

13534

<td class="entry_name

13535

" rowspan="3">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

13536

android.jpeg.maxSize

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

13537

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

13538

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

13539

int32

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

13540

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

13541

[system]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

13542

13543

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

13547

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

13548

</td>

13549

13550

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

13551

Maximum size in bytes for the compressed

Jayant Chowdhary

505f634

2021-07-12 09:26:53 -0700

[diff] [blame]

13552

JPEG buffer, in default sensor pixel mode (see <a href="#controls_android.sensor.pixelMode">android.sensor.pixelMode</a>)

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

Eino-Ville Talvala

2014-01-02 16:11:44 -0800

[diff] [blame]

13559

Must be large enough to fit any JPEG produced by

13560

the camera

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

13561

</td>

13562

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

13570

</tr>

13571

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

13572

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

13573

</tr>

13574

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

13575

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

13576

This is used for sizing the gralloc buffers for

13577

JPEG

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

13578

</td>

13579

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

13580

13581

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

13582

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

13583

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</tbody>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

13589

<tr><td colspan="7" class="kind">dynamic</td></tr>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

13590

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

13591

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

13592

<tr>

13593

<th class="th_name">Property Name</th>

13594

13595

<th class="th_description">Description</th>

13596

<th class="th_units">Units</th>

13597

<th class="th_range">Range</th>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

13598

<th class="th_hal_version">Initial HIDL HAL version</th>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</tr>

</thead>

<tbody>

Ruben Brunk

2014-05-27 18:52:49 -0700

[diff] [blame]

13614

13615

<td class="entry_name

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

13616

" rowspan="3">

Ruben Brunk

2014-05-27 18:52:49 -0700

[diff] [blame]

13617

android.jpeg.gpsLocation

</td>

byte

Yin-Chia Yeh

2016-04-02 16:30:30 -0700

[diff] [blame]

13622

[java_public as location]

Ruben Brunk

2014-05-27 18:52:49 -0700

[diff] [blame]

[synthetic]

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

13626

[legacy]

13627

Ruben Brunk

2014-05-27 18:52:49 -0700

[diff] [blame]

</td>

13632

13633

13634

A location object to use when generating image GPS metadata.

</td>

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Ruben Brunk

2014-05-27 18:52:49 -0700

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

13651

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

13652

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

13653

</tr>

13654

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

13655

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

13656

Setting a location object in a request will include the GPS coordinates of the location

13657

into any JPEG images captured based on the request. These coordinates can then be

13658

viewed by anyone who receives the JPEG image.

Shuzhen Wang

2018-12-28 18:50:53 -0800

[diff] [blame]

13659

This tag is also used for HEIC image capture.

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

13660

</td>

13661

</tr>

Ruben Brunk

2014-05-27 18:52:49 -0700

[diff] [blame]

13662

13663

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

13664

Ruben Brunk

2014-05-27 18:52:49 -0700

[diff] [blame]

13665

13666

13667

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

13668

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

13669

<td class="entry_name

Shuzhen Wang

2018-12-28 18:50:53 -0800

[diff] [blame]

13670

" rowspan="3">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

13671

android.jpeg.gpsCoordinates

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

13672

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

13673

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

13674

double

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

x

3

Yin-Chia Yeh

2016-04-02 16:30:30 -0700

[diff] [blame]

13680

[ndk_public]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

13681

13682

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

13683

[legacy]

13684

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

13685

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

13686

<div class="entry_type_notes">latitude, longitude, altitude. First two in degrees, the third in meters</div>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

13687

13688

13689

</td>

13690

13691

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

13692

GPS coordinates to include in output JPEG

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

13693

EXIF.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

Eino-Ville Talvala

2014-01-02 16:11:44 -0800

[diff] [blame]

13700

(-180 - 180], [-90,90], [-inf, inf]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

13701

</td>

13702

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

13707

Igor Murashkin

2012-12-05 14:49:11 -0800

[diff] [blame]

13708

13709

13710

</ul>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

13711

</td>

13712

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

13713

</tr>

Shuzhen Wang

2018-12-28 18:50:53 -0800

[diff] [blame]

13714

13715

<th class="th_details" colspan="6">Details</th>

</tr>

This tag is also used for HEIC image capture.

13720

</td>

13721

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

13722

13723

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

13724

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

13725

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

13729

<td class="entry_name

Shuzhen Wang

2018-12-28 18:50:53 -0800

[diff] [blame]

13730

" rowspan="3">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

13731

android.jpeg.gpsProcessingMethod

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

13732

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

13733

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

13734

byte

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

13735

Yin-Chia Yeh

2016-04-02 16:30:30 -0700

[diff] [blame]

13736

[ndk_public as string]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

13737

13738

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

13739

[legacy]

13740

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

13744

</td>

13745

13746

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

13747

32 characters describing GPS algorithm to

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

13748

include in EXIF.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

13752

UTF-8 null-terminated string

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

13762

Igor Murashkin

2012-12-05 14:49:11 -0800

[diff] [blame]

13763

13764

13765

</ul>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

13766

</td>

13767

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

13768

</tr>

Shuzhen Wang

2018-12-28 18:50:53 -0800

[diff] [blame]

13769

13770

<th class="th_details" colspan="6">Details</th>

</tr>

This tag is also used for HEIC image capture.

13775

</td>

13776

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

13777

13778

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

13779

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

13780

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

13784

<td class="entry_name

Shuzhen Wang

2018-12-28 18:50:53 -0800

[diff] [blame]

13785

" rowspan="3">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

13786

android.jpeg.gpsTimestamp

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

13787

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

13788

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

13789

int64

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

13790

Yin-Chia Yeh

2016-04-02 16:30:30 -0700

[diff] [blame]

13791

[ndk_public]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

13792

13793

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

13794

[legacy]

13795

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

13799

</td>

13800

13801

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

13802

Time GPS fix was made to include in

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

13803

EXIF.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

13807

UTC in seconds since January 1, 1970

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

13817

Igor Murashkin

2012-12-05 14:49:11 -0800

[diff] [blame]

13818

13819

13820

</ul>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

13821

</td>

13822

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

13823

</tr>

Shuzhen Wang

2018-12-28 18:50:53 -0800

[diff] [blame]

13824

13825

<th class="th_details" colspan="6">Details</th>

</tr>

This tag is also used for HEIC image capture.

13830

</td>

13831

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

13832

13833

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

13834

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

13835

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

13839

<td class="entry_name

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

13840

" rowspan="3">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

13841

android.jpeg.orientation

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

13842

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

13843

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

13844

int32

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

13845

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

13846

[public]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

13847

13848

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

13849

[legacy]

13850

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

13854

</td>

13855

13856

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

13857

The orientation for a JPEG image.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

13861

Degrees in multiples of 90

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Eino-Ville Talvala

2014-01-02 16:11:44 -0800

[diff] [blame]

13865

0, 90, 180, 270

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

13866

</td>

13867

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

13872

Igor Murashkin

2012-12-05 14:49:11 -0800

[diff] [blame]

13873

13874

13875

</ul>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

13876

</td>

13877

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

13878

</tr>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

13879

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

13880

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

13881

</tr>

13882

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

13883

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

13884

The clockwise rotation angle in degrees, relative to the orientation

13885

to the camera, that the JPEG picture needs to be rotated by, to be viewed

13886

upright.

13887

Camera devices may either encode this value into the JPEG EXIF header, or

Yin-Chia Yeh

58a8b19

2015-03-27 13:54:56 -0700

[diff] [blame]

13888

rotate the image data to match this orientation. When the image data is rotated,

13889

the thumbnail data will also be rotated.

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

13890

Note that this orientation is relative to the orientation of the camera sensor, given

13891

by <a href="#static_android.sensor.orientation">android.sensor.orientation</a>.

Emilian Peev

2018-03-28 11:17:14 +0100

[diff] [blame]

13892

To translate from the device orientation given by the Android sensor APIs for camera

13893

sensors which are not EXTERNAL, the following sample code may be used:

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

13894

<pre><code>private int getJpegOrientation(CameraCharacteristics c, int deviceOrientation) {

13895

if (deviceOrientation == android.view.OrientationEventListener.ORIENTATION_UNKNOWN) return 0;

13896

int sensorOrientation = c.get(CameraCharacteristics.SENSOR_ORIENTATION);

13897

13898

// Round device orientation to a multiple of 90

13899

deviceOrientation = (deviceOrientation + 45) / 90 * 90;

13900

13901

// Reverse device orientation for front-facing cameras

13902

boolean facingFront = c.get(CameraCharacteristics.LENS_FACING) == CameraCharacteristics.LENS_FACING_FRONT;

13903

if (facingFront) deviceOrientation = -deviceOrientation;

13904

13905

// Calculate desired JPEG orientation relative to camera orientation to make

13906

// the image upright relative to the device orientation

13907

int jpegOrientation = (sensorOrientation + deviceOrientation + 360) % 360;

13908

13909

return jpegOrientation;

13910

}

13911

</code></pre>

Emilian Peev

2018-03-28 11:17:14 +0100

[diff] [blame]

13912

For EXTERNAL cameras the sensor orientation will always be set to 0 and the facing will

13913

also be set to EXTERNAL. The above code is not relevant in such case.

Shuzhen Wang

2018-12-28 18:50:53 -0800

[diff] [blame]

13914

This tag is also used to describe the orientation of the HEIC image capture, in which

13915

case the rotation is reflected by

13916

<a href="https://developer.android.com/reference/android/media/ExifInterface.html#TAG_ORIENTATION">EXIF orientation flag</a>, and not by

13917

rotating the image data itself.

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

13918

</td>

13919

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

13920

13921

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

13922

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

13923

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

13927

<td class="entry_name

13928

" rowspan="3">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

13929

android.jpeg.quality

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

13930

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

13931

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

13932

byte

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

13933

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

13934

[public]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

13935

13936

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

13937

[legacy]

13938

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

13942

</td>

13943

13944

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

13945

Compression quality of the final JPEG

Eino-Ville Talvala

2014-06-06 14:35:41 -0700

[diff] [blame]

13946

image.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

Eino-Ville Talvala

2014-01-02 16:11:44 -0800

[diff] [blame]

13953

1-100; larger is higher quality

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

13954

</td>

13955

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

13960

Igor Murashkin

2012-12-05 14:49:11 -0800

[diff] [blame]

13961

13962

13963

</ul>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

13964

</td>

13965

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

13966

</tr>

13967

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

13968

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

13969

</tr>

13970

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

13971

Shuzhen Wang

2018-12-28 18:50:53 -0800

[diff] [blame]

13972

85-95 is typical usage range. This tag is also used to describe the quality

13973

of the HEIC image capture.

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

13974

</td>

13975

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

13976

13977

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

13978

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

13979

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

13983

<td class="entry_name

13984

" rowspan="3">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

13985

android.jpeg.size

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

13986

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

13987

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

13988

int32

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

13989

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

13990

[system]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

13991

13992

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

13996

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

13997

</td>

13998

13999

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

14000

The size of the compressed JPEG image, in

14001

bytes

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

Igor Murashkin

2014-01-10 15:12:40 -0800

[diff] [blame]

14008

>= 0

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

14009

</td>

14010

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

14015

Zhijun He

2014-05-23 11:02:34 -0700

[diff] [blame]

14016

14017

<li><a href="#tag_FUTURE">FUTURE</a></li>

14018

</ul>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

14023

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

14024

</tr>

14025

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

14026

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

14027

If no JPEG output is produced for the request,

14028

this must be 0.

14029

Otherwise, this describes the real size of the compressed

14030

JPEG image placed in the output stream. More specifically,

Eino-Ville Talvala

2014-01-02 16:11:44 -0800

[diff] [blame]

14031

if <a href="#static_android.jpeg.maxSize">android.jpeg.maxSize</a> = 1000000, and a specific capture

14032

has <a href="#dynamic_android.jpeg.size">android.jpeg.size</a> = 500000, then the output buffer from

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

14033

the JPEG stream will be 1000000 bytes, of which the first

14034

500000 make up the real data.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

14035

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

14036

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

14037

14038

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

14039

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

14040

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

14044

<td class="entry_name

Shuzhen Wang

2018-12-28 18:50:53 -0800

[diff] [blame]

14045

" rowspan="3">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

14046

android.jpeg.thumbnailQuality

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

14047

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

14048

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

14049

byte

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

14050

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

14051

[public]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

14052

14053

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

14054

[legacy]

14055

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

14059

</td>

14060

14061

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

14062

Compression quality of JPEG

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

14063

thumbnail.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

Eino-Ville Talvala

2014-01-02 16:11:44 -0800

[diff] [blame]

14070

1-100; larger is higher quality

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

14071

</td>

14072

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

14077

Igor Murashkin

2012-12-05 14:49:11 -0800

[diff] [blame]

14078

14079

14080

</ul>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

14081

</td>

14082

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

14083

</tr>

Shuzhen Wang

2018-12-28 18:50:53 -0800

[diff] [blame]

14084

14085

<th class="th_details" colspan="6">Details</th>

</tr>

This tag is also used to describe the quality of the HEIC image capture.

14090

</td>

14091

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

14092

14093

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

14094

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

14095

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

14099

<td class="entry_name

Zhijun He

2014-05-21 17:51:05 -0700

[diff] [blame]

14100

" rowspan="5">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

14101

android.jpeg.thumbnailSize

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

14102

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

14103

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

14104

int32

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

x

2

Igor Murashkin

2013-07-17 16:29:34 -0700

[diff] [blame]

14110

[public as size]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

14111

14112

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

14113

[legacy]

14114

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

14118

</td>

14119

14120

Eino-Ville Talvala

2014-06-06 14:35:41 -0700

[diff] [blame]

14121

Resolution of embedded JPEG thumbnail.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

14128

<a href="#static_android.jpeg.availableThumbnailSizes">android.jpeg.availableThumbnailSizes</a>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

14129

</td>

14130

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

14135

Igor Murashkin

2012-12-05 14:49:11 -0800

[diff] [blame]

14136

14137

14138

</ul>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

14139

</td>

14140

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

14141

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

14142

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

14143

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

14144

</tr>

14145

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

14146

Zhijun He

2014-01-16 12:13:35 -0800

[diff] [blame]

14147

When set to (0, 0) value, the JPEG EXIF will not contain thumbnail,

14148

but the captured JPEG will still be a valid image.

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

14149

For best results, when issuing a request for a JPEG image, the thumbnail size selected

14150

should have the same aspect ratio as the main JPEG output.

Zhijun He

2014-05-21 17:51:05 -0700

[diff] [blame]

14151

If the thumbnail image aspect ratio differs from the JPEG primary image aspect

14152

ratio, the camera device creates the thumbnail by cropping it from the primary image.

14153

For example, if the primary image has 4:3 aspect ratio, the thumbnail image has

14154

16:9 aspect ratio, the primary image will be cropped vertically (letterbox) to

14155

generate the thumbnail image. The thumbnail image will always have a smaller Field

14156

Of View (FOV) than the primary image when aspect ratios differ.

Yin-Chia Yeh

2015-06-22 15:50:05 -0700

[diff] [blame]

14157

When an <a href="#controls_android.jpeg.orientation">android.jpeg.orientation</a> of non-zero degree is requested,

14158

the camera device will handle thumbnail rotation in one of the following ways:

14159

<ul>

14160

<li>Set the <a href="https://developer.android.com/reference/android/media/ExifInterface.html#TAG_ORIENTATION">EXIF orientation flag</a>

14161

and keep jpeg and thumbnail image data unrotated.</li>

14162

<li>Rotate the jpeg and thumbnail image data and not set

14163

<a href="https://developer.android.com/reference/android/media/ExifInterface.html#TAG_ORIENTATION">EXIF orientation flag</a>. In this

Shuzhen Wang

2022-05-03 11:01:26 -0700

[diff] [blame]

14164

case, LIMITED or FULL hardware level devices will report rotated thumbnail size in

Yin-Chia Yeh

2015-06-22 15:50:05 -0700

[diff] [blame]

14165

capture result, so the width and height will be interchanged if 90 or 270 degree

14166

orientation is requested. LEGACY device will always report unrotated thumbnail

14167

size.</li>

14168

</ul>

Shuzhen Wang

2018-12-28 18:50:53 -0800

[diff] [blame]

14169

The tag is also used as thumbnail size for HEIC image format capture, in which case the

14170

the thumbnail rotation is reflected by

14171

<a href="https://developer.android.com/reference/android/media/ExifInterface.html#TAG_ORIENTATION">EXIF orientation flag</a>, and not by

14172

rotating the thumbnail data itself.

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

</td>

</tr>

Zhijun He

2014-05-21 17:51:05 -0700

[diff] [blame]

14176

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

14177

<th class="th_details" colspan="6">HAL Implementation Details</th>

Zhijun He

2014-05-21 17:51:05 -0700

[diff] [blame]

14178

</tr>

14179

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

14180

Zhijun He

2014-05-21 17:51:05 -0700

[diff] [blame]

14181

The HAL must not squeeze or stretch the downscaled primary image to generate thumbnail.

Yin-Chia Yeh

2018-06-15 15:35:05 -0700

[diff] [blame]

14182

The cropping must be done on the primary jpeg image rather than the sensor pre-correction

14183

active array. The stream cropping rule specified by "S5. Cropping" in camera3.h doesn't

14184

apply to the thumbnail image cropping.

Zhijun He

2014-05-21 17:51:05 -0700

[diff] [blame]

14185

</td>

14186

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

14187

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

14188

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

14189

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</tbody>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

14197

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

14198

14199

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

14200

<tr><td colspan="7" class="kind">controls</td></tr>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

14201

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

14202

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

14203

<tr>

14204

<th class="th_name">Property Name</th>

14205

14206

<th class="th_description">Description</th>

14207

<th class="th_units">Units</th>

14208

<th class="th_range">Range</th>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

14209

<th class="th_hal_version">Initial HIDL HAL version</th>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</tr>

</thead>

<tbody>

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

14226

<td class="entry_name

14227

" rowspan="3">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

14228

android.lens.aperture

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

14229

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

14230

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

14231

float

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

14232

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

14233

[public]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

14234

14235

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

14236

[full]

14237

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

14241

</td>

14242

14243

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

14244

The desired lens aperture size, as a ratio of lens focal length to the

14245

effective aperture diameter.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

14249

The f-number (f/N)

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Eino-Ville Talvala

2014-01-02 16:11:44 -0800

[diff] [blame]

14253

<a href="#static_android.lens.info.availableApertures">android.lens.info.availableApertures</a>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

14254

</td>

14255

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

14260

14261

Igor Murashkin

2012-12-05 14:49:11 -0800

[diff] [blame]

14262

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</ul>

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

14266

</tr>

14267

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

14268

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

14269

</tr>

14270

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

14271

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

14272

Setting this value is only supported on the camera devices that have a variable

14273

aperture lens.

Zhijun He

2014-01-10 10:22:53 -0800

[diff] [blame]

14274

When this is supported and <a href="#controls_android.control.aeMode">android.control.aeMode</a> is OFF,

14275

this can be set along with <a href="#controls_android.sensor.exposureTime">android.sensor.exposureTime</a>,

Eino-Ville Talvala

2014-02-10 12:39:35 -0800

[diff] [blame]

14276

<a href="#controls_android.sensor.sensitivity">android.sensor.sensitivity</a>, and <a href="#controls_android.sensor.frameDuration">android.sensor.frameDuration</a>

Zhijun He

2014-01-10 10:22:53 -0800

[diff] [blame]

14277

to achieve manual exposure control.

14278

The requested aperture value may take several frames to reach the

14279

requested value; the camera device will report the current (intermediate)

Zhijun He

2014-01-24 16:48:25 -0800

[diff] [blame]

14280

aperture size in capture result metadata while the aperture is changing.

14281

While the aperture is still changing, <a href="#dynamic_android.lens.state">android.lens.state</a> will be set to MOVING.

Zhijun He

2014-01-10 10:22:53 -0800

[diff] [blame]

14282

When this is supported and <a href="#controls_android.control.aeMode">android.control.aeMode</a> is one of

14283

the ON modes, this will be overridden by the camera device

14284

auto-exposure algorithm, the overridden values are then provided

14285

back to the user in the corresponding result.

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

14286

</td>

14287

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

14288

14289

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

14290

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

14291

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

14295

<td class="entry_name

14296

" rowspan="3">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

14297

android.lens.filterDensity

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

14298

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

14299

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

14300

float

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

14301

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

14302

[public]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

14303

14304

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

14305

[full]

14306

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

14310

</td>

14311

14312

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

14313

The desired setting for the lens neutral density filter(s).

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

14317

Exposure Value (EV)

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Eino-Ville Talvala

2014-01-02 16:11:44 -0800

[diff] [blame]

14321

<a href="#static_android.lens.info.availableFilterDensities">android.lens.info.availableFilterDensities</a>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

14322

</td>

14323

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

14328

14329

Igor Murashkin

2012-12-05 14:49:11 -0800

[diff] [blame]

14330

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</ul>

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

14334

</tr>

14335

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

14336

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

14337

</tr>

14338

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

14339

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

14340

This control will not be supported on most camera devices.

Ruben Brunk

83eb303

2014-01-15 16:12:07 -0800

[diff] [blame]

14341

Lens filters are typically used to lower the amount of light the

14342

sensor is exposed to (measured in steps of EV). As used here, an EV

14343

step is the standard logarithmic representation, which are

14344

non-negative, and inversely proportional to the amount of light

14345

hitting the sensor. For example, setting this to 0 would result

14346

in no reduction of the incoming light, and setting this to 2 would

14347

mean that the filter is set to reduce incoming light by two stops

14348

(allowing 1/4 of the prior amount of light to the sensor).

Zhijun He

2014-01-24 16:48:25 -0800

[diff] [blame]

14349

It may take several frames before the lens filter density changes

14350

to the requested value. While the filter density is still changing,

14351

<a href="#dynamic_android.lens.state">android.lens.state</a> will be set to MOVING.

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

14352

</td>

14353

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

14354

14355

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

14356

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

14357

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

14361

<td class="entry_name

Shuzhen Wang

2018-11-19 12:15:18 -0800

[diff] [blame]

14362

" rowspan="5">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

14363

android.lens.focalLength

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

14364

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

14365

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

14366

float

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

14367

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

14368

[public]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

14369

14370

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

14371

[legacy]

14372

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

14376

</td>

14377

14378

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

14379

The desired lens focal length; used for optical zoom.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

14383

Millimeters

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Ruben Brunk

2014-01-15 18:39:35 -0800

[diff] [blame]

14387

<a href="#static_android.lens.info.availableFocalLengths">android.lens.info.availableFocalLengths</a>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

14388

</td>

14389

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

14394

14395

Igor Murashkin

2012-12-05 14:49:11 -0800

[diff] [blame]

14396

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</ul>

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

14400

</tr>

14401

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

14402

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

14403

</tr>

14404

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

14405

Ruben Brunk

2014-01-15 18:39:35 -0800

[diff] [blame]

14406

This setting controls the physical focal length of the camera

14407

device's lens. Changing the focal length changes the field of

14408

view of the camera device, and is usually used for optical zoom.

14409

Like <a href="#controls_android.lens.focusDistance">android.lens.focusDistance</a> and <a href="#controls_android.lens.aperture">android.lens.aperture</a>, this

14410

setting won't be applied instantaneously, and it may take several

Zhijun He

2014-01-24 16:48:25 -0800

[diff] [blame]

14411

frames before the lens can change to the requested focal length.

Ruben Brunk

2014-01-15 18:39:35 -0800

[diff] [blame]

14412

While the focal length is still changing, <a href="#dynamic_android.lens.state">android.lens.state</a> will

14413

be set to MOVING.

Shuzhen Wang

2020-03-12 21:36:18 -0700

[diff] [blame]

14414

Optical zoom via this control will not be supported on most devices. Starting from API

14415

level 30, the camera device may combine optical and digital zoom through the

14416

<a href="#controls_android.control.zoomRatio">android.control.zoomRatio</a> control.

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

14417

</td>

14418

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

14419

Shuzhen Wang

2018-11-19 12:15:18 -0800

[diff] [blame]

14420

14421

<th class="th_details" colspan="6">HAL Implementation Details</th>

</tr>

For a logical camera device supporting both optical and digital zoom, if focalLength and

14426

cropRegion change in the same request, the camera device must make sure that the new

14427

focalLength and cropRegion take effect in the same frame. This is to make sure that there

14428

is no visible field-of-view jump during zoom. For example, if cropRegion is applied

14429

immediately, but focalLength takes more than 1 frame to take effect, the camera device

14430

will delay the cropRegion so that it's synchronized with focalLength.

Shuzhen Wang

2019-11-07 15:59:22 -0800

[diff] [blame]

14431

Starting from API level 30, it's strongly recommended for HAL to implement the

14432

combination of optical and digital zoom using the new <a href="#controls_android.control.zoomRatio">android.control.zoomRatio</a> API, in

14433

lieu of using <a href="#controls_android.lens.focalLength">android.lens.focalLength</a> and <a href="#controls_android.scaler.cropRegion">android.scaler.cropRegion</a>.

Shuzhen Wang

2018-11-19 12:15:18 -0800

[diff] [blame]

14434

</td>

14435

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

14436

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

14437

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

14438

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

14442

<td class="entry_name

14443

" rowspan="3">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

14444

android.lens.focusDistance

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

14445

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

14446

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

14447

float

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

14448

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

14449

[public]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

14450

14451

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

14452

[full]

14453

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

14457

</td>

14458

14459

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

14460

Desired distance to plane of sharpest focus,

Eino-Ville Talvala

2014-06-06 14:35:41 -0700

[diff] [blame]

14461

measured from frontmost surface of the lens.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

14465

See android.lens.info.focusDistanceCalibration for details

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Igor Murashkin

2014-01-10 15:12:40 -0800

[diff] [blame]

14469

>= 0

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

14470

</td>

14471

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

14476

14477

Igor Murashkin

2012-12-05 14:49:11 -0800

[diff] [blame]

14478

14479

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</ul>

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

14483

</tr>

14484

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

14485

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

14486

</tr>

14487

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

14488

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

14489

This control can be used for setting manual focus, on devices that support

14490

the MANUAL_SENSOR capability and have a variable-focus lens (see

14491

<a href="#static_android.lens.info.minimumFocusDistance">android.lens.info.minimumFocusDistance</a>).

14492

A value of <code>0.0f</code> means infinity focus. The value set will be clamped to

14493

<code>[0.0f, <a href="#static_android.lens.info.minimumFocusDistance">android.lens.info.minimumFocusDistance</a>]</code>.

Zhijun He

2014-01-24 16:48:25 -0800

[diff] [blame]

14494

Like <a href="#controls_android.lens.focalLength">android.lens.focalLength</a>, this setting won't be applied

14495

instantaneously, and it may take several frames before the lens

14496

can move to the requested focus distance. While the lens is still moving,

14497

<a href="#dynamic_android.lens.state">android.lens.state</a> will be set to MOVING.

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

14498

LEGACY devices support at most setting this to <code>0.0f</code>

14499

for infinity focus.

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

14500

</td>

14501

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

14502

14503

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

14504

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

14505

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

14509

<td class="entry_name

14510

" rowspan="3">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

14511

android.lens.opticalStabilizationMode

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

14512

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

14513

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

14514

byte

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

14515

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

14516

[public]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

14517

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

14518

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

14519

[limited]

14520

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

14521

14522

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

14523

14524

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

14525

OFF (v3.2)

Ruben Brunk

2014-01-15 18:09:41 -0800

[diff] [blame]

14526

Optical stabilization is unavailable.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

14527

</li>

14528

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

14529

ON (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

14530

[optional]

Ruben Brunk

2014-01-15 18:09:41 -0800

[diff] [blame]

14531

Optical stabilization is enabled.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</li>

</ul>

</td>

14536

14537

Ruben Brunk

2014-01-15 18:09:41 -0800

[diff] [blame]

14538

Sets whether the camera device uses optical image stabilization (OIS)

14539

when capturing images.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

Ruben Brunk

2014-01-15 18:09:41 -0800

[diff] [blame]

14546

<a href="#static_android.lens.info.availableOpticalStabilization">android.lens.info.availableOpticalStabilization</a>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

14547

</td>

14548

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

14553

14554

Igor Murashkin

2012-12-05 14:49:11 -0800

[diff] [blame]

14555

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</ul>

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

14559

</tr>

14560

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

14561

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

14562

</tr>

14563

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

14564

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

14565

OIS is used to compensate for motion blur due to small

14566

movements of the camera during capture. Unlike digital image

14567

stabilization (<a href="#controls_android.control.videoStabilizationMode">android.control.videoStabilizationMode</a>), OIS

14568

makes use of mechanical elements to stabilize the camera

14569

sensor, and thus allows for longer exposure times before

14570

camera shake becomes apparent.

Zhijun He

2014-06-12 10:43:32 -0700

[diff] [blame]

14571

Switching between different optical stabilization modes may take several

14572

frames to initialize, the camera device will report the current mode in

14573

capture result metadata. For example, When "ON" mode is requested, the

14574

optical stabilization modes in the first several capture results may still

14575

be "OFF", and it will become "ON" when the initialization is done.

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

14576

If a camera device supports both OIS and digital image stabilization

14577

(<a href="#controls_android.control.videoStabilizationMode">android.control.videoStabilizationMode</a>), turning both modes on may produce undesirable

14578

interaction, so it is recommended not to enable both at the same time.

Jayant Chowdhary

2021-09-28 16:32:07 -0700

[diff] [blame]

14579

If <a href="#controls_android.control.videoStabilizationMode">android.control.videoStabilizationMode</a> is set to "PREVIEW_STABILIZATION",

14580

<a href="#controls_android.lens.opticalStabilizationMode">android.lens.opticalStabilizationMode</a> is overridden. The camera sub-system may choose

14581

to turn on hardware based image stabilization in addition to software based stabilization

14582

if it deems that appropriate. This key's value in the capture result will reflect which

14583

OIS mode was chosen.

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

14584

Not all devices will support OIS; see

14585

<a href="#static_android.lens.info.availableOpticalStabilization">android.lens.info.availableOpticalStabilization</a> for

14586

available controls.

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

14587

</td>

14588

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

14589

14590

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

14591

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

14592

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</tbody>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

14598

<tr><td colspan="7" class="kind">static</td></tr>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

14599

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

14600

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

14601

<tr>

14602

<th class="th_name">Property Name</th>

14603

14604

<th class="th_description">Description</th>

14605

<th class="th_units">Units</th>

14606

<th class="th_range">Range</th>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

14607

<th class="th_hal_version">Initial HIDL HAL version</th>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</tr>

</thead>

<tbody>

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

14626

<td class="entry_name

14627

" rowspan="3">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

14628

android.lens.info.availableApertures

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

14629

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

14630

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

14631

float

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

x

n

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

14637

[public]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

14638

14639

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

14640

[full]

14641

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

14645

</td>

14646

14647

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

14648

List of aperture size values for <a href="#controls_android.lens.aperture">android.lens.aperture</a> that are

14649

supported by this camera device.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

14653

The aperture f-number

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

14657

</td>

14658

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

14663

14664

Igor Murashkin

2012-12-05 14:49:11 -0800

[diff] [blame]

14665

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</ul>

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

14669

</tr>

14670

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

14671

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

14672

</tr>

14673

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

14674

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

14675

If the camera device doesn't support a variable lens aperture,

14676

this list will contain only one value, which is the fixed aperture size.

14677

If the camera device supports a variable aperture, the aperture values

Zhijun He

2014-01-10 10:22:53 -0800

[diff] [blame]

14678

in this list will be sorted in ascending order.

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

14679

</td>

14680

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

14681

14682

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

14683

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

14684

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

14688

<td class="entry_name

14689

" rowspan="3">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

14690

android.lens.info.availableFilterDensities

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

14691

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

14692

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

14693

float

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

x

n

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

14699

[public]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

14700

14701

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

14702

[full]

14703

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

14707

</td>

14708

14709

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

14710

List of neutral density filter values for

14711

<a href="#controls_android.lens.filterDensity">android.lens.filterDensity</a> that are supported by this camera device.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

14715

Exposure value (EV)

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

14719

Values are >= 0

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

14720

</td>

14721

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

14726

14727

Igor Murashkin

2012-12-05 14:49:11 -0800

[diff] [blame]

14728

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</ul>

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

14732

</tr>

14733

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

14734

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

14735

</tr>

14736

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

14737

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

14738

If a neutral density filter is not supported by this camera device,

14739

this list will contain only 0. Otherwise, this list will include every

14740

filter density supported by the camera device, in ascending order.

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

14741

</td>

14742

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

14743

14744

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

14745

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

14746

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

14750

<td class="entry_name

14751

" rowspan="3">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

14752

android.lens.info.availableFocalLengths

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

14753

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

14754

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

14755

float

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

x

n

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

14761

[public]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

14762

14763

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

14764

[legacy]

14765

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

14766

Ruben Brunk

2014-01-15 18:39:35 -0800

[diff] [blame]

14767

<div class="entry_type_notes">The list of available focal lengths</div>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

14768

14769

14770

</td>

14771

14772

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

14773

List of focal lengths for <a href="#controls_android.lens.focalLength">android.lens.focalLength</a> that are supported by this camera

14774

device.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

14778

Millimeters

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

14782

Values are > 0

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

14783

</td>

14784

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

14789

14790

Igor Murashkin

2012-12-05 14:49:11 -0800

[diff] [blame]

14791

14792

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</ul>

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

14796

</tr>

14797

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

14798

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

14799

</tr>

14800

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

14801

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

14802

If optical zoom is not supported, this list will only contain

14803

a single value corresponding to the fixed focal length of the

14804

device. Otherwise, this list will include every focal length supported

14805

by the camera device, in ascending order.

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

14806

</td>

14807

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

14808

14809

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

14810

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

14811

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

14815

<td class="entry_name

14816

" rowspan="3">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

14817

android.lens.info.availableOpticalStabilization

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

14818

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

14819

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

14820

byte

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

x

n

Eino-Ville Talvala

2014-05-27 10:50:30 -0700

[diff] [blame]

14826

[public as enumList]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

14827

14828

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

14829

[limited]

14830

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

14831

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

14832

<div class="entry_type_notes">list of enums</div>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

14833

14834

14835

</td>

14836

14837

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

14838

List of optical image stabilization (OIS) modes for

14839

<a href="#controls_android.lens.opticalStabilizationMode">android.lens.opticalStabilizationMode</a> that are supported by this camera device.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

14846

Any value listed in <a href="#controls_android.lens.opticalStabilizationMode">android.lens.opticalStabilizationMode</a>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

14847

</td>

14848

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

14853

14854

Igor Murashkin

2012-12-05 14:49:11 -0800

[diff] [blame]

14855

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</ul>

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

14859

</tr>

Ruben Brunk

2014-01-15 18:09:41 -0800

[diff] [blame]

14860

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

14861

<th class="th_details" colspan="6">Details</th>

Ruben Brunk

2014-01-15 18:09:41 -0800

[diff] [blame]

14862

</tr>

14863

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

14864

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

14865

If OIS is not supported by a given camera device, this list will

Ruben Brunk

2014-01-15 18:09:41 -0800

[diff] [blame]

14866

contain only OFF.

14867

</td>

14868

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

14869

14870

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

14871

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

14872

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

14873

14874

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

14875

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

14876

<td class="entry_name

14877

" rowspan="3">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

14878

android.lens.info.hyperfocalDistance

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

14879

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

14880

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

14881

float

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

14882

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

14883

[public]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

14884

14885

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

14886

[limited]

14887

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

14891

</td>

14892

14893

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

14894

Hyperfocal distance for this lens.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

14898

See android.lens.info.focusDistanceCalibration for details

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

14902

If lens is fixed focus, >= 0. If lens has focuser unit, the value is

14903

within <code>(0.0f, <a href="#static_android.lens.info.minimumFocusDistance">android.lens.info.minimumFocusDistance</a>]</code>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

14904

</td>

14905

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

14910

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

14911

</td>

14912

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

14913

</tr>

14914

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

14915

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

14916

</tr>

14917

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

14918

Zhijun He

27afb78

2014-04-29 19:23:08 -0700

[diff] [blame]

14919

If the lens is not fixed focus, the camera device will report this

Zhijun He

2014-02-06 01:40:35 -0800

[diff] [blame]

14920

field when <a href="#static_android.lens.info.focusDistanceCalibration">android.lens.info.focusDistanceCalibration</a> is APPROXIMATE or CALIBRATED.

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

14921

</td>

14922

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

14923

14924

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

14925

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

14926

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

14930

<td class="entry_name

Igor Murashkin

2014-06-19 15:45:58 -0700

[diff] [blame]

14931

" rowspan="5">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

14932

android.lens.info.minimumFocusDistance

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

14933

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

14934

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

14935

float

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

14936

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

14937

[public]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

14938

14939

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

14940

[limited]

14941

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

14945

</td>

14946

14947

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

14948

Shortest distance from frontmost surface

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

14949

of the lens that can be brought into sharp focus.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

14953

See android.lens.info.focusDistanceCalibration for details

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Igor Murashkin

2014-01-10 15:12:40 -0800

[diff] [blame]

14957

>= 0

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

14958

</td>

14959

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

14964

14965

Igor Murashkin

2012-12-05 14:49:11 -0800

[diff] [blame]

14966

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</ul>

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

14970

</tr>

14971

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

14972

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

14973

</tr>

14974

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

14975

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

14976

If the lens is fixed-focus, this will be

Zhijun He

2014-02-06 01:40:35 -0800

[diff] [blame]

14977

0.

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

14978

</td>

14979

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

14980

Igor Murashkin

2014-06-19 15:45:58 -0700

[diff] [blame]

14981

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

14982

<th class="th_details" colspan="6">HAL Implementation Details</th>

Igor Murashkin

2014-06-19 15:45:58 -0700

[diff] [blame]

14983

</tr>

14984

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

14985

Igor Murashkin

2014-06-19 15:45:58 -0700

[diff] [blame]

14986

Mandatory for FULL devices; LIMITED devices

14987

must always set this value to 0 for fixed-focus; and may omit

14988

the minimum focus distance otherwise.

14989

This field is also mandatory for all devices advertising

14990

the MANUAL_SENSOR capability.

14991

</td>

14992

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

14993

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

14994

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

14995

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

14996

14997

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

14998

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

14999

<td class="entry_name

15000

" rowspan="3">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

15001

android.lens.info.shadingMapSize

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

15002

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

15003

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

15004

int32

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

x

2

Yin-Chia Yeh

2016-04-02 16:30:30 -0700

[diff] [blame]

15010

[ndk_public as size]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

15011

15012

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

15013

[full]

15014

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

15015

Zhijun He

2014-02-24 09:49:37 -0800

[diff] [blame]

15016

<div class="entry_type_notes">width and height (N, M) of lens shading map provided by the camera device.</div>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

15017

15018

15019

</td>

15020

15021

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

15022

Dimensions of lens shading map.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

Eino-Ville Talvala

2014-01-02 16:11:44 -0800

[diff] [blame]

15029

Both values >= 1

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

15030

</td>

15031

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

15036

15037

Igor Murashkin

2012-12-05 14:49:11 -0800

[diff] [blame]

15038

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</ul>

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

15042

</tr>

15043

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

15044

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

15045

</tr>

15046

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

15047

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

15048

The map should be on the order of 30-40 rows and columns, and

15049

must be smaller than 64x64.

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

15050

</td>

15051

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

15052

15053

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

15054

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

15055

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

15056

Zhijun He

2014-02-06 01:40:35 -0800

[diff] [blame]

15057

15058

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

15059

<td class="entry_name

Yin-Chia Yeh

52f6584

2014-08-18 10:44:21 -0700

[diff] [blame]

15060

" rowspan="5">

Zhijun He

2014-02-06 01:40:35 -0800

[diff] [blame]

15061

android.lens.info.focusDistanceCalibration

</td>

byte

[public]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

15068

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

15069

[limited]

15070

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

15071

15072

Zhijun He

2014-02-06 01:40:35 -0800

[diff] [blame]

15073

15074

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

15075

UNCALIBRATED (v3.2)

Zhijun He

2014-02-06 01:40:35 -0800

[diff] [blame]

15076

The lens focus distance is not accurate, and the units used for

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

15077

<a href="#controls_android.lens.focusDistance">android.lens.focusDistance</a> do not correspond to any physical units.

15078

Setting the lens to the same focus distance on separate occasions may

Zhijun He

2014-02-06 01:40:35 -0800

[diff] [blame]

15079

result in a different real focus distance, depending on factors such

15080

as the orientation of the device, the age of the focusing mechanism,

15081

and the device temperature. The focus distance value will still be

15082

in the range of <code>[0, <a href="#static_android.lens.info.minimumFocusDistance">android.lens.info.minimumFocusDistance</a>]</code>, where 0

15083

represents the farthest focus.

15084

</li>

15085

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

15086

APPROXIMATE (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

15087

The lens focus distance is measured in diopters.

15088

However, setting the lens to the same focus distance

15089

on separate occasions may result in a different real

15090

focus distance, depending on factors such as the

15091

orientation of the device, the age of the focusing

15092

mechanism, and the device temperature.

Zhijun He

2014-02-06 01:40:35 -0800

[diff] [blame]

15093

</li>

15094

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

15095

CALIBRATED (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

15096

The lens focus distance is measured in diopters, and

15097

is calibrated.

15098

The lens mechanism is calibrated so that setting the

15099

same focus distance is repeatable on multiple

15100

occasions with good accuracy, and the focus distance

15101

corresponds to the real physical distance to the plane

15102

of best focus.

Zhijun He

2014-02-06 01:40:35 -0800

[diff] [blame]

</li>

</ul>

</td>

15107

15108

15109

The lens focus distance calibration quality.

</td>

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Zhijun He

2014-02-06 01:40:35 -0800

[diff] [blame]

</ul>

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

15130

<th class="th_details" colspan="6">Details</th>

Zhijun He

2014-02-06 01:40:35 -0800

[diff] [blame]

15131

</tr>

15132

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

15133

Zhijun He

2014-02-06 01:40:35 -0800

[diff] [blame]

15134

The lens focus distance calibration quality determines the reliability of

15135

focus related metadata entries, i.e. <a href="#controls_android.lens.focusDistance">android.lens.focusDistance</a>,

15136

<a href="#dynamic_android.lens.focusRange">android.lens.focusRange</a>, <a href="#static_android.lens.info.hyperfocalDistance">android.lens.info.hyperfocalDistance</a>, and

15137

<a href="#static_android.lens.info.minimumFocusDistance">android.lens.info.minimumFocusDistance</a>.

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

15138

APPROXIMATE and CALIBRATED devices report the focus metadata in

15139

units of diopters (1/meter), so <code>0.0f</code> represents focusing at infinity,

15140

and increasing positive numbers represent focusing closer and closer

15141

to the camera device. The focus distance control also uses diopters

15142

on these devices.

15143

UNCALIBRATED devices do not use units that are directly comparable

15144

to any real physical measurement, but <code>0.0f</code> still represents farthest

15145

focus, and <a href="#static_android.lens.info.minimumFocusDistance">android.lens.info.minimumFocusDistance</a> represents the

15146

nearest focus the device can achieve.

Zhijun He

2014-02-06 01:40:35 -0800

[diff] [blame]

</td>

</tr>

Yin-Chia Yeh

2014-08-18 10:44:21 -0700

[diff] [blame]

15150

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

15151

<th class="th_details" colspan="6">HAL Implementation Details</th>

Yin-Chia Yeh

52f6584

2014-08-18 10:44:21 -0700

[diff] [blame]

15152

</tr>

15153

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

15154

Yin-Chia Yeh

52f6584

2014-08-18 10:44:21 -0700

[diff] [blame]

15155

For devices advertise APPROXIMATE quality or higher, diopters 0 (infinity

15156

focus) must work. When autofocus is disabled (<a href="#controls_android.control.afMode">android.control.afMode</a> == OFF)

15157

and the lens focus distance is set to 0 diopters

15158

(<a href="#controls_android.lens.focusDistance">android.lens.focusDistance</a> == 0), the lens will move to focus at infinity

15159

and is stably focused at infinity even if the device tilts. It may take the

15160

lens some time to move; during the move the lens state should be MOVING and

15161

the output diopter value should be changing toward 0.

15162

</td>

15163

</tr>

Zhijun He

2014-02-06 01:40:35 -0800

[diff] [blame]

15164

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

15165

Zhijun He

2014-02-06 01:40:35 -0800

[diff] [blame]

15166

15167

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

15173

<td class="entry_name

15174

" rowspan="1">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

15175

android.lens.facing

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

15176

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

15177

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

15178

byte

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

15179

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

15180

[public]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

15181

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

15182

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

15183

[legacy]

15184

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

15185

15186

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

15187

15188

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

15189

FRONT (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

15190

The camera device faces the same direction as the device's screen.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

15191

</li>

15192

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

15193

BACK (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

15194

The camera device faces the opposite direction as the device's screen.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

15195

</li>

Zhijun He

be30d4f

2015-01-12 15:06:16 -0800

[diff] [blame]

15196

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

15197

EXTERNAL (v3.2)

Zhijun He

be30d4f

2015-01-12 15:06:16 -0800

[diff] [blame]

15198

The camera device is an external camera, and has no fixed facing relative to the

15199

device's screen.

15200

</li>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

15201

</ul>

15202

15203

</td>

15204

15205

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

15206

Direction the camera faces relative to

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

15207

device screen.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

15223

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

15224

15225

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

15226

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

15227

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

15228

15229

Eino-Ville Talvala

2015-02-09 15:47:27 -0800

[diff] [blame]

15230

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

15231

<td class="entry_name

15232

" rowspan="3">

Eino-Ville Talvala

2015-02-09 15:47:27 -0800

[diff] [blame]

15233

android.lens.poseRotation

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

15234

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

15235

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

15236

float

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

x

Eino-Ville Talvala

2015-02-09 15:47:27 -0800

[diff] [blame]

15240

4

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

15241

Eino-Ville Talvala

2015-02-09 15:47:27 -0800

[diff] [blame]

15242

[public]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

15246

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

15247

15248

15249

</td>

15250

15251

Eino-Ville Talvala

2015-02-09 15:47:27 -0800

[diff] [blame]

15252

The orientation of the camera relative to the sensor

15253

coordinate system.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Eino-Ville Talvala

2015-02-09 15:47:27 -0800

[diff] [blame]

15257

Eino-Ville Talvala

2015-08-19 16:09:46 -0700

[diff] [blame]

15258

Quaternion coefficients

Eino-Ville Talvala

2015-02-09 15:47:27 -0800

[diff] [blame]

15259

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

15263

</td>

15264

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

15269

15270

Eino-Ville Talvala

2015-02-09 15:47:27 -0800

[diff] [blame]

15271

<li><a href="#tag_DEPTH">DEPTH</a></li>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

</ul>

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

15277

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

15278

</tr>

15279

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

15280

Eino-Ville Talvala

2015-08-19 16:09:46 -0700

[diff] [blame]

15281

The four coefficients that describe the quaternion

Eino-Ville Talvala

2015-02-09 15:47:27 -0800

[diff] [blame]

15282

rotation from the Android sensor coordinate system to a

15283

camera-aligned coordinate system where the X-axis is

15284

aligned with the long side of the image sensor, the Y-axis

15285

is aligned with the short side of the image sensor, and

15286

the Z-axis is aligned with the optical axis of the sensor.

Eino-Ville Talvala

2015-08-19 16:09:46 -0700

[diff] [blame]

15287

To convert from the quaternion coefficients <code>(x,y,z,w)</code>

Eino-Ville Talvala

2015-02-09 15:47:27 -0800

[diff] [blame]

15288

to the axis of rotation <code>(a_x, a_y, a_z)</code> and rotation

15289

amount <code>theta</code>, the following formulas can be used:

15290

<pre><code> theta = 2 * acos(w)

15291

a_x = x / sin(theta/2)

15292

a_y = y / sin(theta/2)

15293

a_z = z / sin(theta/2)

15294

</code></pre>

15295

To create a 3x3 rotation matrix that applies the rotation

Eino-Ville Talvala

2015-08-19 16:09:46 -0700

[diff] [blame]

15296

defined by this quaternion, the following matrix can be

Eino-Ville Talvala

2015-02-09 15:47:27 -0800

[diff] [blame]

15297

used:

15298

<pre><code>R = [ 1 - 2y^2 - 2z^2, 2xy - 2zw, 2xz + 2yw,

15299

2xy + 2zw, 1 - 2x^2 - 2z^2, 2yz - 2xw,

15300

2xz - 2yw, 2yz + 2xw, 1 - 2x^2 - 2y^2 ]

15301

</code></pre>

15302

This matrix can then be used to apply the rotation to a

15303

column vector point with

15304

15305

where <code>p</code> is in the device sensor coordinate system, and

15306

<code>p'</code> is in the camera-oriented coordinate system.

Shuzhen Wang

2020-01-08 13:05:14 -0800

[diff] [blame]

15307

If <a href="#static_android.lens.poseReference">android.lens.poseReference</a> is UNDEFINED, the quaternion rotation cannot

15308

be accurately represented by the camera device, and will be represented by

15309

default values matching its default facing.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

15310

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

15311

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

15312

15313

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

15314

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

15315

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

15316

15317

Eino-Ville Talvala

2015-02-09 15:47:27 -0800

[diff] [blame]

15318

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

15319

<td class="entry_name

Eino-Ville Talvala

2015-02-09 15:47:27 -0800

[diff] [blame]

15320

" rowspan="3">

15321

android.lens.poseTranslation

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

15322

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

15323

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

15324

float

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

x

Eino-Ville Talvala

2015-02-09 15:47:27 -0800

[diff] [blame]

15328

3

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

15329

Eino-Ville Talvala

2015-02-09 15:47:27 -0800

[diff] [blame]

15330

[public]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

15331

15332

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

15336

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

15337

</td>

15338

15339

Eino-Ville Talvala

2015-02-09 15:47:27 -0800

[diff] [blame]

15340

Position of the camera optical center.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Eino-Ville Talvala

2015-02-09 15:47:27 -0800

[diff] [blame]

15344

Meters

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

15354

15355

Eino-Ville Talvala

2015-02-09 15:47:27 -0800

[diff] [blame]

15356

<li><a href="#tag_DEPTH">DEPTH</a></li>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</ul>

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

15360

</tr>

Eino-Ville Talvala

2015-02-09 15:47:27 -0800

[diff] [blame]

15361

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

15362

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2015-02-09 15:47:27 -0800

[diff] [blame]

15363

</tr>

15364

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

15365

Eino-Ville Talvala

3014c13

2015-05-29 17:15:37 -0700

[diff] [blame]

15366

The position of the camera device's lens optical center,

Eino-Ville Talvala

2017-12-07 13:12:11 -0800

[diff] [blame]

15367

as a three-dimensional vector <code>(x,y,z)</code>.

15368

Prior to Android P, or when <a href="#static_android.lens.poseReference">android.lens.poseReference</a> is PRIMARY_CAMERA, this position

15369

is relative to the optical center of the largest camera device facing in the same

15370

direction as this camera, in the <a href="https://developer.android.com/reference/android/hardware/SensorEvent.html">Android sensor

15371

coordinate axes</a>. Note that only the axis definitions are shared with the sensor

15372

coordinate system, but not the origin.

15373

If this device is the largest or only camera device with a given facing, then this

15374

position will be <code>(0, 0, 0)</code>; a camera device with a lens optical center located 3 cm

15375

from the main sensor along the +X axis (to the right from the user's perspective) will

Eino-Ville Talvala

2018-08-01 15:26:26 -0700

[diff] [blame]

15376

report <code>(0.03, 0, 0)</code>. Note that this means that, for many computer vision

15377

applications, the position needs to be negated to convert it to a translation from the

15378

camera to the origin.

Eino-Ville Talvala

2017-12-07 13:12:11 -0800

[diff] [blame]

15379

To transform a pixel coordinates between two cameras facing the same direction, first

Eino-Ville Talvala

2018-03-13 19:10:23 -0700

[diff] [blame]

15380

the source camera <a href="#static_android.lens.distortion">android.lens.distortion</a> must be corrected for. Then the source

Eino-Ville Talvala

2017-12-07 13:12:11 -0800

[diff] [blame]

15381

camera <a href="#static_android.lens.intrinsicCalibration">android.lens.intrinsicCalibration</a> needs to be applied, followed by the

15382

<a href="#static_android.lens.poseRotation">android.lens.poseRotation</a> of the source camera, the translation of the source camera

15383

relative to the destination camera, the <a href="#static_android.lens.poseRotation">android.lens.poseRotation</a> of the destination

15384

camera, and finally the inverse of <a href="#static_android.lens.intrinsicCalibration">android.lens.intrinsicCalibration</a> of the destination

15385

camera. This obtains a radial-distortion-free coordinate in the destination camera pixel

15386

coordinates.

15387

To compare this against a real image from the destination camera, the destination camera

15388

image then needs to be corrected for radial distortion before comparison or sampling.

15389

When <a href="#static_android.lens.poseReference">android.lens.poseReference</a> is GYROSCOPE, then this position is relative to

Eino-Ville Talvala

2018-08-01 15:26:26 -0700

[diff] [blame]

15390

the center of the primary gyroscope on the device. The axis definitions are the same as

15391

with PRIMARY_CAMERA.

Shuzhen Wang

2020-01-08 13:05:14 -0800

[diff] [blame]

15392

When <a href="#static_android.lens.poseReference">android.lens.poseReference</a> is UNDEFINED, this position cannot be accurately

15393

represented by the camera device, and will be represented as <code>(0, 0, 0)</code>.

Changyeon Jo

2022-01-19 13:51:47 -0800

[diff] [blame]

15394

When <a href="#static_android.lens.poseReference">android.lens.poseReference</a> is AUTOMOTIVE, then this position is relative to the

15395

origin of the automotive sensor coordinate system, which is at the center of the rear

15396

axle.

Eino-Ville Talvala

2015-02-09 15:47:27 -0800

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

15401

Eino-Ville Talvala

2015-02-09 15:47:27 -0800

[diff] [blame]

15402

<td class="entry_name

15407

" rowspan="3">

15408

android.lens.intrinsicCalibration

</td>

float

x

5

[public]

</td>

15425

15426

15427

The parameters for this camera device's intrinsic

calibration.

</td>

Eino-Ville Talvala

2015-06-16 11:36:01 -0700

[diff] [blame]

15433

Pixels in the

15434

android.sensor.info.preCorrectionActiveArraySize

15435

coordinate system.

Eino-Ville Talvala

2015-02-09 15:47:27 -0800

[diff] [blame]

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Eino-Ville Talvala

2015-02-09 15:47:27 -0800

[diff] [blame]

15446

15447

15448

<li><a href="#tag_DEPTH">DEPTH</a></li>

</ul>

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

15454

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2015-02-09 15:47:27 -0800

[diff] [blame]

15455

</tr>

15456

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

15457

Eino-Ville Talvala

2015-02-09 15:47:27 -0800

[diff] [blame]

15458

The five calibration parameters that describe the

15459

transform from camera-centric 3D coordinates to sensor

15460

pixel coordinates:

15461

<pre><code>[f_x, f_y, c_x, c_y, s]

15462

</code></pre>

15463

Where <code>f_x</code> and <code>f_y</code> are the horizontal and vertical

15464

focal lengths, <code>[c_x, c_y]</code> is the position of the optical

15465

axis, and <code>s</code> is a skew parameter for the sensor plane not

15466

being aligned with the lens plane.

15467

These are typically used within a transformation matrix K:

15468

<pre><code>K = [ f_x, s, c_x,

0, f_y, c_y,

0 0, 1 ]

</code></pre>

which can then be combined with the camera pose rotation

15473

<code>R</code> and translation <code>t</code> (<a href="#static_android.lens.poseRotation">android.lens.poseRotation</a> and

Eino-Ville Talvala

2018-08-01 15:26:26 -0700

[diff] [blame]

15474

<a href="#static_android.lens.poseTranslation">android.lens.poseTranslation</a>, respectively) to calculate the

Eino-Ville Talvala

2015-02-09 15:47:27 -0800

[diff] [blame]

15475

complete transform from world coordinates to pixel

15476

coordinates:

Eino-Ville Talvala

2018-08-01 15:26:26 -0700

[diff] [blame]

15477

<pre><code>P = [ K 0 * [ R -Rt

15478

0 1 ] 0 1 ]

Eino-Ville Talvala

2015-02-09 15:47:27 -0800

[diff] [blame]

15479

</code></pre>

Eino-Ville Talvala

2018-08-01 15:26:26 -0700

[diff] [blame]

15480

(Note the negation of poseTranslation when mapping from camera

15481

to world coordinates, and multiplication by the rotation).

15482

With <code>p_w</code> being a point in the world coordinate system

Eino-Ville Talvala

2015-02-09 15:47:27 -0800

[diff] [blame]

15483

and <code>p_s</code> being a point in the camera active pixel array

15484

coordinate system, and with the mapping including the

15485

homogeneous division by z:

15486

<pre><code> p_h = (x_h, y_h, z_h) = P p_w

15487

p_s = p_h / z_h

15488

</code></pre>

15489

so <code>[x_s, y_s]</code> is the pixel coordinates of the world

15490

point, <code>z_s = 1</code>, and <code>w_s</code> is a measurement of disparity

15491

(depth) in pixel coordinates.

Eino-Ville Talvala

2015-06-16 11:36:01 -0700

[diff] [blame]

15492

Note that the coordinate system for this transform is the

15493

<a href="#static_android.sensor.info.preCorrectionActiveArraySize">android.sensor.info.preCorrectionActiveArraySize</a> system,

15494

where <code>(0,0)</code> is the top-left of the

15495

preCorrectionActiveArraySize rectangle. Once the pose and

15496

intrinsic calibration transforms have been applied to a

Eino-Ville Talvala

2018-03-13 19:10:23 -0700

[diff] [blame]

15497

world point, then the <a href="#static_android.lens.distortion">android.lens.distortion</a>

Eino-Ville Talvala

2015-06-16 11:36:01 -0700

[diff] [blame]

15498

transform needs to be applied, and the result adjusted to

15499

be in the <a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a> coordinate

15500

system (where <code>(0, 0)</code> is the top-left of the

15501

activeArraySize rectangle), to determine the final pixel

15502

coordinate of the world point for processed (non-RAW)

15503

output buffers.

Eino-Ville Talvala

2018-08-01 15:26:26 -0700

[diff] [blame]

15504

For camera devices, the center of pixel <code>(x,y)</code> is located at

15505

coordinate <code>(x + 0.5, y + 0.5)</code>. So on a device with a

15506

precorrection active array of size <code>(10,10)</code>, the valid pixel

15507

indices go from <code>(0,0)-(9,9)</code>, and an perfectly-built camera would

15508

have an optical center at the exact center of the pixel grid, at

15509

coordinates <code>(5.0, 5.0)</code>, which is the top-left corner of pixel

15510

<code>(5,5)</code>.

Eino-Ville Talvala

2015-02-09 15:47:27 -0800

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

15515

Eino-Ville Talvala

2015-02-09 15:47:27 -0800

[diff] [blame]

15516

<td class="entry_name

Eino-Ville Talvala

2018-03-13 19:10:23 -0700

[diff] [blame]

15521

entry_name_deprecated

Eino-Ville Talvala

2015-02-09 15:47:27 -0800

[diff] [blame]

15522

" rowspan="3">

15523

android.lens.radialDistortion

</td>

float

x

Ruben Brunk

2015-06-12 10:19:40 -0700

[diff] [blame]

15530

6

Eino-Ville Talvala

2015-02-09 15:47:27 -0800

[diff] [blame]

[public]

Eino-Ville Talvala

2018-03-13 19:10:23 -0700

[diff] [blame]

15536

[deprecated]

Eino-Ville Talvala

2015-02-09 15:47:27 -0800

[diff] [blame]

</td>

15541

15542

15543

The correction coefficients to correct for this camera device's

Eino-Ville Talvala

2015-05-29 16:03:31 -0700

[diff] [blame]

15544

radial and tangential lens distortion.

Eino-Ville Talvala

2015-02-09 15:47:27 -0800

[diff] [blame]

</td>

Eino-Ville Talvala

2015-05-29 16:03:31 -0700

[diff] [blame]

15549

Unitless coefficients.

Eino-Ville Talvala

2015-02-09 15:47:27 -0800

[diff] [blame]

</td>

Eino-Ville Talvala

2018-03-13 19:10:23 -0700

[diff] [blame]

15554

Deprecated. Do not use.

Eino-Ville Talvala

2015-02-09 15:47:27 -0800

[diff] [blame]

15555

</td>

15556

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Eino-Ville Talvala

2015-02-09 15:47:27 -0800

[diff] [blame]

15561

15562

15563

<li><a href="#tag_DEPTH">DEPTH</a></li>

</ul>

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

15569

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2015-02-09 15:47:27 -0800

[diff] [blame]

15570

</tr>

15571

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

15572

Ruben Brunk

2015-06-12 10:19:40 -0700

[diff] [blame]

15573

Four radial distortion coefficients <code>[kappa_0, kappa_1, kappa_2,

Eino-Ville Talvala

2015-05-29 16:03:31 -0700

[diff] [blame]

15574

kappa_3]</code> and two tangential distortion coefficients

15575

<code>[kappa_4, kappa_5]</code> that can be used to correct the

15576

lens's geometric distortion with the mapping equations:

Ruben Brunk

2015-06-12 10:19:40 -0700

[diff] [blame]

15577

<pre><code> x_c = x_i * ( kappa_0 + kappa_1 * r^2 + kappa_2 * r^4 + kappa_3 * r^6 ) +

Eino-Ville Talvala

2015-05-29 16:03:31 -0700

[diff] [blame]

15578

kappa_4 * (2 * x_i * y_i) + kappa_5 * ( r^2 + 2 * x_i^2 )

Ruben Brunk

2015-06-12 10:19:40 -0700

[diff] [blame]

15579

y_c = y_i * ( kappa_0 + kappa_1 * r^2 + kappa_2 * r^4 + kappa_3 * r^6 ) +

Eino-Ville Talvala

2015-05-29 16:03:31 -0700

[diff] [blame]

15580

kappa_5 * (2 * x_i * y_i) + kappa_4 * ( r^2 + 2 * y_i^2 )

Eino-Ville Talvala

2015-02-09 15:47:27 -0800

[diff] [blame]

15581

</code></pre>

Eino-Ville Talvala

2015-05-29 16:03:31 -0700

[diff] [blame]

15582

Here, <code>[x_c, y_c]</code> are the coordinates to sample in the

15583

input image that correspond to the pixel values in the

15584

corrected image at the coordinate <code>[x_i, y_i]</code>:

15585

<pre><code> correctedImage(x_i, y_i) = sample_at(x_c, y_c, inputImage)

15586

</code></pre>

15587

The pixel coordinates are defined in a normalized

15588

coordinate system related to the

Eino-Ville Talvala

2015-08-19 16:09:46 -0700

[diff] [blame]

15589

<a href="#static_android.lens.intrinsicCalibration">android.lens.intrinsicCalibration</a> calibration fields.

Eino-Ville Talvala

2015-05-29 16:03:31 -0700

[diff] [blame]

15590

Both <code>[x_i, y_i]</code> and <code>[x_c, y_c]</code> have <code>(0,0)</code> at the

15591

lens optical center <code>[c_x, c_y]</code>. The maximum magnitudes

15592

of both x and y coordinates are normalized to be 1 at the

15593

edge further from the optical center, so the range

15594

for both dimensions is <code>-1 <= x <= 1</code>.

15595

Finally, <code>r</code> represents the radial distance from the

15596

optical center, <code>r^2 = x_i^2 + y_i^2</code>, and its magnitude

15597

is therefore no larger than <code>|r| <= sqrt(2)</code>.

15598

The distortion model used is the Brown-Conrady model.

Eino-Ville Talvala

2015-02-09 15:47:27 -0800

[diff] [blame]

15599

</td>

15600

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

15601

15602

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

15603

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

15604

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

15605

Eino-Ville Talvala

2017-12-07 13:12:11 -0800

[diff] [blame]

15606

15607

15608

<td class="entry_name

15609

" rowspan="3">

15610

android.lens.poseReference

</td>

byte

[public]

<li>

PRIMARY_CAMERA (v3.3)

15624

The value of <a href="#static_android.lens.poseTranslation">android.lens.poseTranslation</a> is relative to the optical center of

15625

the largest camera device facing the same direction as this camera.

Eino-Ville Talvala

baf8047

2018-02-05 16:26:26 -0800

[diff] [blame]

15626

This is the default value for API levels before Android P.

Eino-Ville Talvala

2017-12-07 13:12:11 -0800

[diff] [blame]

</li>

<li>

GYROSCOPE (v3.3)

The value of <a href="#static_android.lens.poseTranslation">android.lens.poseTranslation</a> is relative to the position of the

Eino-Ville Talvala

baf8047

2018-02-05 16:26:26 -0800

[diff] [blame]

15631

primary gyroscope of this Android device.

Eino-Ville Talvala

2017-12-07 13:12:11 -0800

[diff] [blame]

15632

</li>

Shuzhen Wang

2020-01-08 13:05:14 -0800

[diff] [blame]

15633

<li>

15634

UNDEFINED (v3.5)

15635

The camera device cannot represent the values of <a href="#static_android.lens.poseTranslation">android.lens.poseTranslation</a>

15636

and <a href="#static_android.lens.poseRotation">android.lens.poseRotation</a> accurately enough. One such example is a camera device

15637

on the cover of a foldable phone: in order to measure the pose translation and rotation,

15638

some kind of hinge position sensor would be needed.

15639

The value of <a href="#static_android.lens.poseTranslation">android.lens.poseTranslation</a> must be all zeros, and

15640

<a href="#static_android.lens.poseRotation">android.lens.poseRotation</a> must be values matching its default facing.

15641

</li>

Changyeon Jo

2022-01-19 13:51:47 -0800

[diff] [blame]

15642

<li>

15643

AUTOMOTIVE (v3.8)

15644

The value of <a href="#static_android.lens.poseTranslation">android.lens.poseTranslation</a> is relative to the origin of the

Shuzhen Wang

2022-05-03 11:01:26 -0700

[diff] [blame]

15645

automotive sensor coordinate system, which is at the center of the rear axle.

Changyeon Jo

2022-01-19 13:51:47 -0800

[diff] [blame]

15646

</li>

Eino-Ville Talvala

2017-12-07 13:12:11 -0800

[diff] [blame]

15647

</ul>

15648

15649

</td>

15650

15651

Shuzhen Wang

2020-01-08 13:05:14 -0800

[diff] [blame]

15652

The origin for <a href="#static_android.lens.poseTranslation">android.lens.poseTranslation</a>, and the accuracy of

15653

<a href="#static_android.lens.poseTranslation">android.lens.poseTranslation</a> and <a href="#static_android.lens.poseRotation">android.lens.poseRotation</a>.

Eino-Ville Talvala

2017-12-07 13:12:11 -0800

[diff] [blame]

</td>

</td>

</td>

3.3

</td>

</td>

</tr>

<th class="th_details" colspan="6">Details</th>

</tr>

Different calibration methods and use cases can produce better or worse results

15676

depending on the selected coordinate origin.

Eino-Ville Talvala

2017-12-07 13:12:11 -0800

[diff] [blame]

</td>

</tr>

15683

Eino-Ville Talvala

2018-03-13 19:10:23 -0700

[diff] [blame]

15684

15685

15686

<td class="entry_name

15687

" rowspan="3">

15688

android.lens.distortion

</td>

float

x

5

[public]

</td>

15705

15706

15707

The correction coefficients to correct for this camera device's

15708

radial and tangential lens distortion.

15709

Replaces the deprecated <a href="#static_android.lens.radialDistortion">android.lens.radialDistortion</a> field, which was

15710

inconsistently defined.

</td>

Unitless coefficients.

</td>

</td>

3.3

</td>

<li><a href="#tag_DEPTH">DEPTH</a></li>

</ul>

</td>

</tr>

<th class="th_details" colspan="6">Details</th>

</tr>

Three radial distortion coefficients <code>[kappa_1, kappa_2,

15739

kappa_3]</code> and two tangential distortion coefficients

15740

<code>[kappa_4, kappa_5]</code> that can be used to correct the

15741

lens's geometric distortion with the mapping equations:

15742

<pre><code> x_c = x_i * ( 1 + kappa_1 * r^2 + kappa_2 * r^4 + kappa_3 * r^6 ) +

15743

kappa_4 * (2 * x_i * y_i) + kappa_5 * ( r^2 + 2 * x_i^2 )

15744

y_c = y_i * ( 1 + kappa_1 * r^2 + kappa_2 * r^4 + kappa_3 * r^6 ) +

15745

kappa_5 * (2 * x_i * y_i) + kappa_4 * ( r^2 + 2 * y_i^2 )

15746

</code></pre>

15747

Here, <code>[x_c, y_c]</code> are the coordinates to sample in the

15748

input image that correspond to the pixel values in the

15749

corrected image at the coordinate <code>[x_i, y_i]</code>:

15750

<pre><code> correctedImage(x_i, y_i) = sample_at(x_c, y_c, inputImage)

15751

</code></pre>

15752

The pixel coordinates are defined in a coordinate system

15753

related to the <a href="#static_android.lens.intrinsicCalibration">android.lens.intrinsicCalibration</a>

15754

calibration fields; see that entry for details of the mapping stages.

15755

Both <code>[x_i, y_i]</code> and <code>[x_c, y_c]</code>

15756

have <code>(0,0)</code> at the lens optical center <code>[c_x, c_y]</code>, and

15757

the range of the coordinates depends on the focal length

15758

terms of the intrinsic calibration.

15759

Finally, <code>r</code> represents the radial distance from the

15760

optical center, <code>r^2 = x_i^2 + y_i^2</code>.

15761

The distortion model used is the Brown-Conrady model.

</td>

</tr>

15768

Jayant Chowdhary

2020-11-09 09:08:31 -0800

[diff] [blame]

15769

15770

15771

<td class="entry_name

15772

" rowspan="3">

15773

android.lens.distortionMaximumResolution

</td>

float

x

5

[public]

</td>

15790

15791

15792

The correction coefficients to correct for this camera device's

15793

radial and tangential lens distortion for a

15794

CaptureRequest with <a href="#controls_android.sensor.pixelMode">android.sensor.pixelMode</a> set to

15795

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraMetadata.html#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION">CameraMetadata#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION</a>.

</td>

Unitless coefficients.

</td>

</td>

3.6

</td>

<li><a href="#tag_DEPTH">DEPTH</a></li>

</ul>

</td>

</tr>

<th class="th_details" colspan="6">Details</th>

</tr>

Analogous to <a href="#static_android.lens.distortion">android.lens.distortion</a>, when <a href="#controls_android.sensor.pixelMode">android.sensor.pixelMode</a> is set to

15824

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraMetadata.html#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION">CameraMetadata#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION</a>.

</td>

</tr>

<td class="entry_name

15835

" rowspan="3">

15836

android.lens.intrinsicCalibrationMaximumResolution

</td>

float

x

5

[public]

</td>

15853

15854

15855

The parameters for this camera device's intrinsic

15856

calibration when <a href="#controls_android.sensor.pixelMode">android.sensor.pixelMode</a> is set to

15857

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraMetadata.html#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION">CameraMetadata#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION</a>.

</td>

Pixels in the

android.sensor.info.preCorrectionActiveArraySizeMaximumResolution

coordinate system.

</td>

</td>

3.6

</td>

<li><a href="#tag_DEPTH">DEPTH</a></li>

</ul>

</td>

</tr>

<th class="th_details" colspan="6">Details</th>

</tr>

Analogous to <a href="#static_android.lens.intrinsicCalibration">android.lens.intrinsicCalibration</a>, when <a href="#controls_android.sensor.pixelMode">android.sensor.pixelMode</a> is set to

15888

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraMetadata.html#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION">CameraMetadata#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION</a>.

</td>

</tr>

15895

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</tbody>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

15900

<tr><td colspan="7" class="kind">dynamic</td></tr>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

15901

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

15902

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

15903

<tr>

15904

<th class="th_name">Property Name</th>

15905

15906

<th class="th_description">Description</th>

15907

<th class="th_units">Units</th>

15908

<th class="th_range">Range</th>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

15909

<th class="th_hal_version">Initial HIDL HAL version</th>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</tr>

</thead>

<tbody>

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

15926

<td class="entry_name

15927

" rowspan="3">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

15928

android.lens.aperture

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

15929

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

15930

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

15931

float

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

15932

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

15933

[public]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

15934

15935

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

15936

[full]

15937

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

15941

</td>

15942

15943

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

15944

The desired lens aperture size, as a ratio of lens focal length to the

15945

effective aperture diameter.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

15949

The f-number (f/N)

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Eino-Ville Talvala

2014-01-02 16:11:44 -0800

[diff] [blame]

15953

<a href="#static_android.lens.info.availableApertures">android.lens.info.availableApertures</a>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

15954

</td>

15955

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

15960

15961

Igor Murashkin

2012-12-05 14:49:11 -0800

[diff] [blame]

15962

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</ul>

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

15966

</tr>

15967

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

15968

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

15969

</tr>

15970

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

15971

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

15972

Setting this value is only supported on the camera devices that have a variable

15973

aperture lens.

Zhijun He

2014-01-10 10:22:53 -0800

[diff] [blame]

15974

When this is supported and <a href="#controls_android.control.aeMode">android.control.aeMode</a> is OFF,

15975

this can be set along with <a href="#controls_android.sensor.exposureTime">android.sensor.exposureTime</a>,

Eino-Ville Talvala

2014-02-10 12:39:35 -0800

[diff] [blame]

15976

<a href="#controls_android.sensor.sensitivity">android.sensor.sensitivity</a>, and <a href="#controls_android.sensor.frameDuration">android.sensor.frameDuration</a>

Zhijun He

2014-01-10 10:22:53 -0800

[diff] [blame]

15977

to achieve manual exposure control.

15978

The requested aperture value may take several frames to reach the

15979

requested value; the camera device will report the current (intermediate)

Zhijun He

2014-01-24 16:48:25 -0800

[diff] [blame]

15980

aperture size in capture result metadata while the aperture is changing.

15981

While the aperture is still changing, <a href="#dynamic_android.lens.state">android.lens.state</a> will be set to MOVING.

Zhijun He

2014-01-10 10:22:53 -0800

[diff] [blame]

15982

When this is supported and <a href="#controls_android.control.aeMode">android.control.aeMode</a> is one of

15983

the ON modes, this will be overridden by the camera device

15984

auto-exposure algorithm, the overridden values are then provided

15985

back to the user in the corresponding result.

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

15986

</td>

15987

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

15988

15989

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

15990

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

15991

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

15995

<td class="entry_name

15996

" rowspan="3">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

15997

android.lens.filterDensity

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

15998

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

15999

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

16000

float

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

16001

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

16002

[public]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

16003

16004

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

16005

[full]

16006

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

16010

</td>

16011

16012

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

16013

The desired setting for the lens neutral density filter(s).

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

16017

Exposure Value (EV)

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Eino-Ville Talvala

2014-01-02 16:11:44 -0800

[diff] [blame]

16021

<a href="#static_android.lens.info.availableFilterDensities">android.lens.info.availableFilterDensities</a>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

16022

</td>

16023

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

16028

16029

Igor Murashkin

2012-12-05 14:49:11 -0800

[diff] [blame]

16030

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</ul>

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

16034

</tr>

16035

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

16036

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

16037

</tr>

16038

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

16039

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

16040

This control will not be supported on most camera devices.

Ruben Brunk

83eb303

2014-01-15 16:12:07 -0800

[diff] [blame]

16041

Lens filters are typically used to lower the amount of light the

16042

sensor is exposed to (measured in steps of EV). As used here, an EV

16043

step is the standard logarithmic representation, which are

16044

non-negative, and inversely proportional to the amount of light

16045

hitting the sensor. For example, setting this to 0 would result

16046

in no reduction of the incoming light, and setting this to 2 would

16047

mean that the filter is set to reduce incoming light by two stops

16048

(allowing 1/4 of the prior amount of light to the sensor).

Zhijun He

2014-01-24 16:48:25 -0800

[diff] [blame]

16049

It may take several frames before the lens filter density changes

16050

to the requested value. While the filter density is still changing,

16051

<a href="#dynamic_android.lens.state">android.lens.state</a> will be set to MOVING.

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

16052

</td>

16053

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

16054

16055

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

16056

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

16057

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

16061

<td class="entry_name

Shuzhen Wang

2018-11-19 12:15:18 -0800

[diff] [blame]

16062

" rowspan="5">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

16063

android.lens.focalLength

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

16064

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

16065

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

16066

float

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

16067

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

16068

[public]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

16069

16070

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

16071

[legacy]

16072

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

16076

</td>

16077

16078

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

16079

The desired lens focal length; used for optical zoom.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

16083

Millimeters

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Ruben Brunk

2014-01-15 18:39:35 -0800

[diff] [blame]

16087

<a href="#static_android.lens.info.availableFocalLengths">android.lens.info.availableFocalLengths</a>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

16088

</td>

16089

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

16094

16095

Igor Murashkin

2012-12-05 14:49:11 -0800

[diff] [blame]

16096

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</ul>

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

16100

</tr>

16101

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

16102

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

16103

</tr>

16104

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

16105

Ruben Brunk

2014-01-15 18:39:35 -0800

[diff] [blame]

16106

This setting controls the physical focal length of the camera

16107

device's lens. Changing the focal length changes the field of

16108

view of the camera device, and is usually used for optical zoom.

16109

Like <a href="#controls_android.lens.focusDistance">android.lens.focusDistance</a> and <a href="#controls_android.lens.aperture">android.lens.aperture</a>, this

16110

setting won't be applied instantaneously, and it may take several

Zhijun He

2014-01-24 16:48:25 -0800

[diff] [blame]

16111

frames before the lens can change to the requested focal length.

Ruben Brunk

2014-01-15 18:39:35 -0800

[diff] [blame]

16112

While the focal length is still changing, <a href="#dynamic_android.lens.state">android.lens.state</a> will

16113

be set to MOVING.

Shuzhen Wang

2020-03-12 21:36:18 -0700

[diff] [blame]

16114

Optical zoom via this control will not be supported on most devices. Starting from API

16115

level 30, the camera device may combine optical and digital zoom through the

16116

<a href="#controls_android.control.zoomRatio">android.control.zoomRatio</a> control.

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

16117

</td>

16118

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

16119

Shuzhen Wang

2018-11-19 12:15:18 -0800

[diff] [blame]

16120

16121

<th class="th_details" colspan="6">HAL Implementation Details</th>

</tr>

For a logical camera device supporting both optical and digital zoom, if focalLength and

16126

cropRegion change in the same request, the camera device must make sure that the new

16127

focalLength and cropRegion take effect in the same frame. This is to make sure that there

16128

is no visible field-of-view jump during zoom. For example, if cropRegion is applied

16129

immediately, but focalLength takes more than 1 frame to take effect, the camera device

16130

will delay the cropRegion so that it's synchronized with focalLength.

Shuzhen Wang

2019-11-07 15:59:22 -0800

[diff] [blame]

16131

Starting from API level 30, it's strongly recommended for HAL to implement the

16132

combination of optical and digital zoom using the new <a href="#controls_android.control.zoomRatio">android.control.zoomRatio</a> API, in

16133

lieu of using <a href="#controls_android.lens.focalLength">android.lens.focalLength</a> and <a href="#controls_android.scaler.cropRegion">android.scaler.cropRegion</a>.

Shuzhen Wang

2018-11-19 12:15:18 -0800

[diff] [blame]

16134

</td>

16135

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

16136

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

16137

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

16138

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

16142

<td class="entry_name

16143

" rowspan="3">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

16144

android.lens.focusDistance

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

16145

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

16146

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

16147

float

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

16148

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

16149

[public]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

16150

16151

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

16152

[full]

16153

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

16157

</td>

16158

16159

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

16160

Desired distance to plane of sharpest focus,

Eino-Ville Talvala

2014-06-06 14:35:41 -0700

[diff] [blame]

16161

measured from frontmost surface of the lens.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

16165

See android.lens.info.focusDistanceCalibration for details

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Igor Murashkin

2014-01-10 15:12:40 -0800

[diff] [blame]

16169

>= 0

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

16170

</td>

16171

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

16176

16177

Igor Murashkin

2012-12-05 14:49:11 -0800

[diff] [blame]

16178

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</ul>

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

16182

</tr>

16183

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

16184

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

16185

</tr>

16186

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

16187

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

16188

Should be zero for fixed-focus cameras

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

16189

</td>

16190

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

16191

16192

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

16193

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

16194

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

16198

<td class="entry_name

16199

" rowspan="3">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

16200

android.lens.focusRange

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

16201

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

16202

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

16203

float

Zhijun He

50451ad

2013-09-26 10:27:47 -0700

[diff] [blame]

16204

x

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

16205

Zhijun He

50451ad

2013-09-26 10:27:47 -0700

[diff] [blame]

2

Igor Murashkin

2014-05-30 10:51:40 -0700

[diff] [blame]

16209

[public as pairFloatFloat]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

16210

16211

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

16212

[limited]

16213

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

16214

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

16215

<div class="entry_type_notes">Range of scene distances that are in focus</div>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

16216

16217

16218

</td>

16219

16220

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

16221

The range of scene distances that are in

Eino-Ville Talvala

2014-06-06 14:35:41 -0700

[diff] [blame]

16222

sharp focus (depth of field).

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

16226

A pair of focus distances in diopters: (near,

16227

far); see android.lens.info.focusDistanceCalibration for details.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Igor Murashkin

2014-01-10 15:12:40 -0800

[diff] [blame]

16231

>=0

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

16232

</td>

16233

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

16238

16239

Igor Murashkin

2012-12-05 14:49:11 -0800

[diff] [blame]

16240

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</ul>

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

16244

</tr>

16245

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

16246

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

16247

</tr>

16248

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

16249

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

16250

If variable focus not supported, can still report

16251

fixed depth of field range

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

16252

</td>

16253

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

16254

16255

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

16256

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

16257

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

16261

<td class="entry_name

16262

" rowspan="3">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

16263

android.lens.opticalStabilizationMode

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

16264

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

16265

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

16266

byte

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

16267

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

16268

[public]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

16269

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

16270

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

16271

[limited]

16272

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

16273

16274

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

16275

16276

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

16277

OFF (v3.2)

Ruben Brunk

2014-01-15 18:09:41 -0800

[diff] [blame]

16278

Optical stabilization is unavailable.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

16279

</li>

16280

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

16281

ON (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

16282

[optional]

Ruben Brunk

2014-01-15 18:09:41 -0800

[diff] [blame]

16283

Optical stabilization is enabled.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</li>

</ul>

</td>

16288

16289

Ruben Brunk

2014-01-15 18:09:41 -0800

[diff] [blame]

16290

Sets whether the camera device uses optical image stabilization (OIS)

16291

when capturing images.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

Ruben Brunk

2014-01-15 18:09:41 -0800

[diff] [blame]

16298

<a href="#static_android.lens.info.availableOpticalStabilization">android.lens.info.availableOpticalStabilization</a>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

16299

</td>

16300

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

16305

16306

Igor Murashkin

2012-12-05 14:49:11 -0800

[diff] [blame]

16307

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</ul>

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

16311

</tr>

16312

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

16313

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

16314

</tr>

16315

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

16316

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

16317

OIS is used to compensate for motion blur due to small

16318

movements of the camera during capture. Unlike digital image

16319

stabilization (<a href="#controls_android.control.videoStabilizationMode">android.control.videoStabilizationMode</a>), OIS

16320

makes use of mechanical elements to stabilize the camera

16321

sensor, and thus allows for longer exposure times before

16322

camera shake becomes apparent.

Zhijun He

2014-06-12 10:43:32 -0700

[diff] [blame]

16323

Switching between different optical stabilization modes may take several

16324

frames to initialize, the camera device will report the current mode in

16325

capture result metadata. For example, When "ON" mode is requested, the

16326

optical stabilization modes in the first several capture results may still

16327

be "OFF", and it will become "ON" when the initialization is done.

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

16328

If a camera device supports both OIS and digital image stabilization

16329

(<a href="#controls_android.control.videoStabilizationMode">android.control.videoStabilizationMode</a>), turning both modes on may produce undesirable

16330

interaction, so it is recommended not to enable both at the same time.

Jayant Chowdhary

2021-09-28 16:32:07 -0700

[diff] [blame]

16331

If <a href="#controls_android.control.videoStabilizationMode">android.control.videoStabilizationMode</a> is set to "PREVIEW_STABILIZATION",

16332

<a href="#controls_android.lens.opticalStabilizationMode">android.lens.opticalStabilizationMode</a> is overridden. The camera sub-system may choose

16333

to turn on hardware based image stabilization in addition to software based stabilization

16334

if it deems that appropriate. This key's value in the capture result will reflect which

16335

OIS mode was chosen.

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

16336

Not all devices will support OIS; see

16337

<a href="#static_android.lens.info.availableOpticalStabilization">android.lens.info.availableOpticalStabilization</a> for

16338

available controls.

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

16339

</td>

16340

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

16341

16342

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

16343

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

16344

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

16348

<td class="entry_name

16349

" rowspan="3">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

16350

android.lens.state

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

16351

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

16352

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

16353

byte

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

16354

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

16355

[public]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

16356

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

16357

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

16358

[limited]

16359

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

16360

16361

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

16362

16363

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

16364

STATIONARY (v3.2)

Eino-Ville Talvala

2014-02-10 12:39:35 -0800

[diff] [blame]

16365

The lens parameters (<a href="#controls_android.lens.focalLength">android.lens.focalLength</a>, <a href="#controls_android.lens.focusDistance">android.lens.focusDistance</a>,

16366

<a href="#controls_android.lens.filterDensity">android.lens.filterDensity</a> and <a href="#controls_android.lens.aperture">android.lens.aperture</a>) are not changing.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

16367

</li>

Igor Murashkin

0e323a1

2013-09-06 11:50:48 -0700

[diff] [blame]

16368

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

16369

MOVING (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

16370

One or several of the lens parameters

16371

(<a href="#controls_android.lens.focalLength">android.lens.focalLength</a>, <a href="#controls_android.lens.focusDistance">android.lens.focusDistance</a>,

16372

<a href="#controls_android.lens.filterDensity">android.lens.filterDensity</a> or <a href="#controls_android.lens.aperture">android.lens.aperture</a>) is

16373

currently changing.

Igor Murashkin

0e323a1

2013-09-06 11:50:48 -0700

[diff] [blame]

16374

</li>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

16375

</ul>

16376

16377

</td>

16378

16379

Zhijun He

2014-01-24 16:48:25 -0800

[diff] [blame]

16380

Current lens status.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

16393

16394

Igor Murashkin

2012-12-05 14:49:11 -0800

[diff] [blame]

16395

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</ul>

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

16399

</tr>

Zhijun He

2014-01-24 16:48:25 -0800

[diff] [blame]

16400

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

16401

<th class="th_details" colspan="6">Details</th>

Zhijun He

2014-01-24 16:48:25 -0800

[diff] [blame]

16402

</tr>

16403

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

16404

Zhijun He

2014-01-24 16:48:25 -0800

[diff] [blame]

16405

For lens parameters <a href="#controls_android.lens.focalLength">android.lens.focalLength</a>, <a href="#controls_android.lens.focusDistance">android.lens.focusDistance</a>,

16406

<a href="#controls_android.lens.filterDensity">android.lens.filterDensity</a> and <a href="#controls_android.lens.aperture">android.lens.aperture</a>, when changes are requested,

16407

they may take several frames to reach the requested values. This state indicates

16408

the current status of the lens parameters.

16409

When the state is STATIONARY, the lens parameters are not changing. This could be

16410

either because the parameters are all fixed, or because the lens has had enough

16411

time to reach the most recently-requested values.

Shuzhen Wang

2022-05-03 11:01:26 -0700

[diff] [blame]

16412

If all these lens parameters are not changeable for a camera device, as listed below:

Zhijun He

2014-01-24 16:48:25 -0800

[diff] [blame]

16413

<ul>

16414

<li>Fixed focus (<code><a href="#static_android.lens.info.minimumFocusDistance">android.lens.info.minimumFocusDistance</a> == 0</code>), which means

16415

<a href="#controls_android.lens.focusDistance">android.lens.focusDistance</a> parameter will always be 0.</li>

16416

<li>Fixed focal length (<a href="#static_android.lens.info.availableFocalLengths">android.lens.info.availableFocalLengths</a> contains single value),

16417

which means the optical zoom is not supported.</li>

16418

<li>No ND filter (<a href="#static_android.lens.info.availableFilterDensities">android.lens.info.availableFilterDensities</a> contains only 0).</li>

16419

<li>Fixed aperture (<a href="#static_android.lens.info.availableApertures">android.lens.info.availableApertures</a> contains single value).</li>

16420

</ul>

16421

Then this state will always be STATIONARY.

16422

When the state is MOVING, it indicates that at least one of the lens parameters

16423

is changing.

16424

</td>

16425

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

16426

16427

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

16428

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

16429

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

16430

Eino-Ville Talvala

2015-02-09 15:47:27 -0800

[diff] [blame]

16431

16432

16433

<td class="entry_name

16434

" rowspan="3">

16435

android.lens.poseRotation

</td>

float

x

4

[public]

</td>

16452

16453

16454

The orientation of the camera relative to the sensor

coordinate system.

</td>

Eino-Ville Talvala

2015-08-19 16:09:46 -0700

[diff] [blame]

16460

Quaternion coefficients

Eino-Ville Talvala

2015-02-09 15:47:27 -0800

[diff] [blame]

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Eino-Ville Talvala

2015-02-09 15:47:27 -0800

[diff] [blame]

16471

16472

16473

<li><a href="#tag_DEPTH">DEPTH</a></li>

</ul>

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

16479

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2015-02-09 15:47:27 -0800

[diff] [blame]

16480

</tr>

16481

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

16482

Eino-Ville Talvala

2015-08-19 16:09:46 -0700

[diff] [blame]

16483

The four coefficients that describe the quaternion

Eino-Ville Talvala

2015-02-09 15:47:27 -0800

[diff] [blame]

16484

rotation from the Android sensor coordinate system to a

16485

camera-aligned coordinate system where the X-axis is

16486

aligned with the long side of the image sensor, the Y-axis

16487

is aligned with the short side of the image sensor, and

16488

the Z-axis is aligned with the optical axis of the sensor.

Eino-Ville Talvala

2015-08-19 16:09:46 -0700

[diff] [blame]

16489

To convert from the quaternion coefficients <code>(x,y,z,w)</code>

Eino-Ville Talvala

2015-02-09 15:47:27 -0800

[diff] [blame]

16490

to the axis of rotation <code>(a_x, a_y, a_z)</code> and rotation

16491

amount <code>theta</code>, the following formulas can be used:

16492

<pre><code> theta = 2 * acos(w)

16493

a_x = x / sin(theta/2)

16494

a_y = y / sin(theta/2)

16495

a_z = z / sin(theta/2)

16496

</code></pre>

16497

To create a 3x3 rotation matrix that applies the rotation

Eino-Ville Talvala

2015-08-19 16:09:46 -0700

[diff] [blame]

16498

defined by this quaternion, the following matrix can be

Eino-Ville Talvala

2015-02-09 15:47:27 -0800

[diff] [blame]

16499

used:

16500

<pre><code>R = [ 1 - 2y^2 - 2z^2, 2xy - 2zw, 2xz + 2yw,

16501

2xy + 2zw, 1 - 2x^2 - 2z^2, 2yz - 2xw,

16502

2xz - 2yw, 2yz + 2xw, 1 - 2x^2 - 2y^2 ]

16503

</code></pre>

16504

This matrix can then be used to apply the rotation to a

16505

column vector point with

16506

16507

where <code>p</code> is in the device sensor coordinate system, and

16508

<code>p'</code> is in the camera-oriented coordinate system.

Shuzhen Wang

2020-01-08 13:05:14 -0800

[diff] [blame]

16509

If <a href="#static_android.lens.poseReference">android.lens.poseReference</a> is UNDEFINED, the quaternion rotation cannot

16510

be accurately represented by the camera device, and will be represented by

16511

default values matching its default facing.

Eino-Ville Talvala

2015-02-09 15:47:27 -0800

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

16516

Eino-Ville Talvala

2015-02-09 15:47:27 -0800

[diff] [blame]

16517

<td class="entry_name

16522

" rowspan="3">

16523

android.lens.poseTranslation

</td>

float

x

3

[public]

</td>

16540

16541

16542

Position of the camera optical center.

</td>

Meters

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Eino-Ville Talvala

2015-02-09 15:47:27 -0800

[diff] [blame]

16556

16557

16558

<li><a href="#tag_DEPTH">DEPTH</a></li>

</ul>

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

16564

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2015-02-09 15:47:27 -0800

[diff] [blame]

16565

</tr>

16566

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

16567

Eino-Ville Talvala

3014c13

2015-05-29 17:15:37 -0700

[diff] [blame]

16568

The position of the camera device's lens optical center,

Eino-Ville Talvala

2017-12-07 13:12:11 -0800

[diff] [blame]

16569

as a three-dimensional vector <code>(x,y,z)</code>.

16570

Prior to Android P, or when <a href="#static_android.lens.poseReference">android.lens.poseReference</a> is PRIMARY_CAMERA, this position

16571

is relative to the optical center of the largest camera device facing in the same

16572

direction as this camera, in the <a href="https://developer.android.com/reference/android/hardware/SensorEvent.html">Android sensor

16573

coordinate axes</a>. Note that only the axis definitions are shared with the sensor

16574

coordinate system, but not the origin.

16575

If this device is the largest or only camera device with a given facing, then this

16576

position will be <code>(0, 0, 0)</code>; a camera device with a lens optical center located 3 cm

16577

from the main sensor along the +X axis (to the right from the user's perspective) will

Eino-Ville Talvala

2018-08-01 15:26:26 -0700

[diff] [blame]

16578

report <code>(0.03, 0, 0)</code>. Note that this means that, for many computer vision

16579

applications, the position needs to be negated to convert it to a translation from the

16580

camera to the origin.

Eino-Ville Talvala

2017-12-07 13:12:11 -0800

[diff] [blame]

16581

To transform a pixel coordinates between two cameras facing the same direction, first

Eino-Ville Talvala

2018-03-13 19:10:23 -0700

[diff] [blame]

16582

the source camera <a href="#static_android.lens.distortion">android.lens.distortion</a> must be corrected for. Then the source

Eino-Ville Talvala

2017-12-07 13:12:11 -0800

[diff] [blame]

16583

camera <a href="#static_android.lens.intrinsicCalibration">android.lens.intrinsicCalibration</a> needs to be applied, followed by the

16584

<a href="#static_android.lens.poseRotation">android.lens.poseRotation</a> of the source camera, the translation of the source camera

16585

relative to the destination camera, the <a href="#static_android.lens.poseRotation">android.lens.poseRotation</a> of the destination

16586

camera, and finally the inverse of <a href="#static_android.lens.intrinsicCalibration">android.lens.intrinsicCalibration</a> of the destination

16587

camera. This obtains a radial-distortion-free coordinate in the destination camera pixel

16588

coordinates.

16589

To compare this against a real image from the destination camera, the destination camera

16590

image then needs to be corrected for radial distortion before comparison or sampling.

16591

When <a href="#static_android.lens.poseReference">android.lens.poseReference</a> is GYROSCOPE, then this position is relative to

Eino-Ville Talvala

2018-08-01 15:26:26 -0700

[diff] [blame]

16592

the center of the primary gyroscope on the device. The axis definitions are the same as

16593

with PRIMARY_CAMERA.

Shuzhen Wang

2020-01-08 13:05:14 -0800

[diff] [blame]

16594

When <a href="#static_android.lens.poseReference">android.lens.poseReference</a> is UNDEFINED, this position cannot be accurately

16595

represented by the camera device, and will be represented as <code>(0, 0, 0)</code>.

Changyeon Jo

2022-01-19 13:51:47 -0800

[diff] [blame]

16596

When <a href="#static_android.lens.poseReference">android.lens.poseReference</a> is AUTOMOTIVE, then this position is relative to the

16597

origin of the automotive sensor coordinate system, which is at the center of the rear

16598

axle.

Eino-Ville Talvala

2015-02-09 15:47:27 -0800

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

16603

Eino-Ville Talvala

2015-02-09 15:47:27 -0800

[diff] [blame]

16604

<td class="entry_name

16609

" rowspan="3">

16610

android.lens.intrinsicCalibration

</td>

float

x

5

[public]

</td>

16627

16628

16629

The parameters for this camera device's intrinsic

calibration.

</td>

Eino-Ville Talvala

2015-06-16 11:36:01 -0700

[diff] [blame]

16635

Pixels in the

16636

android.sensor.info.preCorrectionActiveArraySize

16637

coordinate system.

Eino-Ville Talvala

2015-02-09 15:47:27 -0800

[diff] [blame]

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Eino-Ville Talvala

2015-02-09 15:47:27 -0800

[diff] [blame]

16648

16649

16650

<li><a href="#tag_DEPTH">DEPTH</a></li>

</ul>

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

16656

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2015-02-09 15:47:27 -0800

[diff] [blame]

16657

</tr>

16658

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

16659

Eino-Ville Talvala

2015-02-09 15:47:27 -0800

[diff] [blame]

16660

The five calibration parameters that describe the

16661

transform from camera-centric 3D coordinates to sensor

16662

pixel coordinates:

16663

<pre><code>[f_x, f_y, c_x, c_y, s]

16664

</code></pre>

16665

Where <code>f_x</code> and <code>f_y</code> are the horizontal and vertical

16666

focal lengths, <code>[c_x, c_y]</code> is the position of the optical

16667

axis, and <code>s</code> is a skew parameter for the sensor plane not

16668

being aligned with the lens plane.

16669

These are typically used within a transformation matrix K:

16670

<pre><code>K = [ f_x, s, c_x,

0, f_y, c_y,

0 0, 1 ]

</code></pre>

which can then be combined with the camera pose rotation

16675

<code>R</code> and translation <code>t</code> (<a href="#static_android.lens.poseRotation">android.lens.poseRotation</a> and

Eino-Ville Talvala

2018-08-01 15:26:26 -0700

[diff] [blame]

16676

<a href="#static_android.lens.poseTranslation">android.lens.poseTranslation</a>, respectively) to calculate the

Eino-Ville Talvala

2015-02-09 15:47:27 -0800

[diff] [blame]

16677

complete transform from world coordinates to pixel

16678

coordinates:

Eino-Ville Talvala

2018-08-01 15:26:26 -0700

[diff] [blame]

16679

<pre><code>P = [ K 0 * [ R -Rt

16680

0 1 ] 0 1 ]

Eino-Ville Talvala

2015-02-09 15:47:27 -0800

[diff] [blame]

16681

</code></pre>

Eino-Ville Talvala

2018-08-01 15:26:26 -0700

[diff] [blame]

16682

(Note the negation of poseTranslation when mapping from camera

16683

to world coordinates, and multiplication by the rotation).

16684

With <code>p_w</code> being a point in the world coordinate system

Eino-Ville Talvala

2015-02-09 15:47:27 -0800

[diff] [blame]

16685

and <code>p_s</code> being a point in the camera active pixel array

16686

coordinate system, and with the mapping including the

16687

homogeneous division by z:

16688

<pre><code> p_h = (x_h, y_h, z_h) = P p_w

16689

p_s = p_h / z_h

16690

</code></pre>

16691

so <code>[x_s, y_s]</code> is the pixel coordinates of the world

16692

point, <code>z_s = 1</code>, and <code>w_s</code> is a measurement of disparity

16693

(depth) in pixel coordinates.

Eino-Ville Talvala

2015-06-16 11:36:01 -0700

[diff] [blame]

16694

Note that the coordinate system for this transform is the

16695

<a href="#static_android.sensor.info.preCorrectionActiveArraySize">android.sensor.info.preCorrectionActiveArraySize</a> system,

16696

where <code>(0,0)</code> is the top-left of the

16697

preCorrectionActiveArraySize rectangle. Once the pose and

16698

intrinsic calibration transforms have been applied to a

Eino-Ville Talvala

2018-03-13 19:10:23 -0700

[diff] [blame]

16699

world point, then the <a href="#static_android.lens.distortion">android.lens.distortion</a>

Eino-Ville Talvala

2015-06-16 11:36:01 -0700

[diff] [blame]

16700

transform needs to be applied, and the result adjusted to

16701

be in the <a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a> coordinate

16702

system (where <code>(0, 0)</code> is the top-left of the

16703

activeArraySize rectangle), to determine the final pixel

16704

coordinate of the world point for processed (non-RAW)

16705

output buffers.

Eino-Ville Talvala

2018-08-01 15:26:26 -0700

[diff] [blame]

16706

For camera devices, the center of pixel <code>(x,y)</code> is located at

16707

coordinate <code>(x + 0.5, y + 0.5)</code>. So on a device with a

16708

precorrection active array of size <code>(10,10)</code>, the valid pixel

16709

indices go from <code>(0,0)-(9,9)</code>, and an perfectly-built camera would

16710

have an optical center at the exact center of the pixel grid, at

16711

coordinates <code>(5.0, 5.0)</code>, which is the top-left corner of pixel

16712

<code>(5,5)</code>.

Eino-Ville Talvala

2015-02-09 15:47:27 -0800

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

16717

Eino-Ville Talvala

2015-02-09 15:47:27 -0800

[diff] [blame]

16718

<td class="entry_name

Eino-Ville Talvala

2018-03-13 19:10:23 -0700

[diff] [blame]

16723

entry_name_deprecated

Eino-Ville Talvala

2015-02-09 15:47:27 -0800

[diff] [blame]

16724

" rowspan="3">

16725

android.lens.radialDistortion

</td>

float

x

Ruben Brunk

2015-06-12 10:19:40 -0700

[diff] [blame]

16732

6

Eino-Ville Talvala

2015-02-09 15:47:27 -0800

[diff] [blame]

[public]

Eino-Ville Talvala

2018-03-13 19:10:23 -0700

[diff] [blame]

16738

[deprecated]

Eino-Ville Talvala

2015-02-09 15:47:27 -0800

[diff] [blame]

</td>

16743

16744

16745

The correction coefficients to correct for this camera device's

Eino-Ville Talvala

2015-05-29 16:03:31 -0700

[diff] [blame]

16746

radial and tangential lens distortion.

Eino-Ville Talvala

2015-02-09 15:47:27 -0800

[diff] [blame]

</td>

Eino-Ville Talvala

2015-05-29 16:03:31 -0700

[diff] [blame]

16751

Unitless coefficients.

Eino-Ville Talvala

2015-02-09 15:47:27 -0800

[diff] [blame]

</td>

Eino-Ville Talvala

2018-03-13 19:10:23 -0700

[diff] [blame]

16756

Deprecated. Do not use.

Eino-Ville Talvala

2015-02-09 15:47:27 -0800

[diff] [blame]

16757

</td>

16758

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Eino-Ville Talvala

2015-02-09 15:47:27 -0800

[diff] [blame]

16763

16764

16765

<li><a href="#tag_DEPTH">DEPTH</a></li>

</ul>

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

16771

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2015-02-09 15:47:27 -0800

[diff] [blame]

16772

</tr>

16773

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

16774

Ruben Brunk

2015-06-12 10:19:40 -0700

[diff] [blame]

16775

Four radial distortion coefficients <code>[kappa_0, kappa_1, kappa_2,

Eino-Ville Talvala

2015-05-29 16:03:31 -0700

[diff] [blame]

16776

kappa_3]</code> and two tangential distortion coefficients

16777

<code>[kappa_4, kappa_5]</code> that can be used to correct the

16778

lens's geometric distortion with the mapping equations:

Ruben Brunk

2015-06-12 10:19:40 -0700

[diff] [blame]

16779

<pre><code> x_c = x_i * ( kappa_0 + kappa_1 * r^2 + kappa_2 * r^4 + kappa_3 * r^6 ) +

Eino-Ville Talvala

2015-05-29 16:03:31 -0700

[diff] [blame]

16780

kappa_4 * (2 * x_i * y_i) + kappa_5 * ( r^2 + 2 * x_i^2 )

Ruben Brunk

2015-06-12 10:19:40 -0700

[diff] [blame]

16781

y_c = y_i * ( kappa_0 + kappa_1 * r^2 + kappa_2 * r^4 + kappa_3 * r^6 ) +

Eino-Ville Talvala

2015-05-29 16:03:31 -0700

[diff] [blame]

16782

kappa_5 * (2 * x_i * y_i) + kappa_4 * ( r^2 + 2 * y_i^2 )

Eino-Ville Talvala

2015-02-09 15:47:27 -0800

[diff] [blame]

16783

</code></pre>

Eino-Ville Talvala

2015-05-29 16:03:31 -0700

[diff] [blame]

16784

Here, <code>[x_c, y_c]</code> are the coordinates to sample in the

16785

input image that correspond to the pixel values in the

16786

corrected image at the coordinate <code>[x_i, y_i]</code>:

16787

<pre><code> correctedImage(x_i, y_i) = sample_at(x_c, y_c, inputImage)

16788

</code></pre>

16789

The pixel coordinates are defined in a normalized

16790

coordinate system related to the

Eino-Ville Talvala

2015-08-19 16:09:46 -0700

[diff] [blame]

16791

<a href="#static_android.lens.intrinsicCalibration">android.lens.intrinsicCalibration</a> calibration fields.

Eino-Ville Talvala

2015-05-29 16:03:31 -0700

[diff] [blame]

16792

Both <code>[x_i, y_i]</code> and <code>[x_c, y_c]</code> have <code>(0,0)</code> at the

16793

lens optical center <code>[c_x, c_y]</code>. The maximum magnitudes

16794

of both x and y coordinates are normalized to be 1 at the

16795

edge further from the optical center, so the range

16796

for both dimensions is <code>-1 <= x <= 1</code>.

16797

Finally, <code>r</code> represents the radial distance from the

16798

optical center, <code>r^2 = x_i^2 + y_i^2</code>, and its magnitude

16799

is therefore no larger than <code>|r| <= sqrt(2)</code>.

16800

The distortion model used is the Brown-Conrady model.

Eino-Ville Talvala

2015-02-09 15:47:27 -0800

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

16805

Eino-Ville Talvala

2015-02-09 15:47:27 -0800

[diff] [blame]

16806

16807

Eino-Ville Talvala

2018-03-13 19:10:23 -0700

[diff] [blame]

16808

16809

16810

<td class="entry_name

16811

" rowspan="3">

16812

android.lens.distortion

</td>

float

x

5

[public]

</td>

16829

16830

16831

The correction coefficients to correct for this camera device's

16832

radial and tangential lens distortion.

16833

Replaces the deprecated <a href="#static_android.lens.radialDistortion">android.lens.radialDistortion</a> field, which was

16834

inconsistently defined.

</td>

Unitless coefficients.

</td>

</td>

3.3

</td>

<li><a href="#tag_DEPTH">DEPTH</a></li>

</ul>

</td>

</tr>

<th class="th_details" colspan="6">Details</th>

</tr>

Three radial distortion coefficients <code>[kappa_1, kappa_2,

16863

kappa_3]</code> and two tangential distortion coefficients

16864

<code>[kappa_4, kappa_5]</code> that can be used to correct the

16865

lens's geometric distortion with the mapping equations:

16866

<pre><code> x_c = x_i * ( 1 + kappa_1 * r^2 + kappa_2 * r^4 + kappa_3 * r^6 ) +

16867

kappa_4 * (2 * x_i * y_i) + kappa_5 * ( r^2 + 2 * x_i^2 )

16868

y_c = y_i * ( 1 + kappa_1 * r^2 + kappa_2 * r^4 + kappa_3 * r^6 ) +

16869

kappa_5 * (2 * x_i * y_i) + kappa_4 * ( r^2 + 2 * y_i^2 )

16870

</code></pre>

16871

Here, <code>[x_c, y_c]</code> are the coordinates to sample in the

16872

input image that correspond to the pixel values in the

16873

corrected image at the coordinate <code>[x_i, y_i]</code>:

16874

<pre><code> correctedImage(x_i, y_i) = sample_at(x_c, y_c, inputImage)

16875

</code></pre>

16876

The pixel coordinates are defined in a coordinate system

16877

related to the <a href="#static_android.lens.intrinsicCalibration">android.lens.intrinsicCalibration</a>

16878

calibration fields; see that entry for details of the mapping stages.

16879

Both <code>[x_i, y_i]</code> and <code>[x_c, y_c]</code>

16880

have <code>(0,0)</code> at the lens optical center <code>[c_x, c_y]</code>, and

16881

the range of the coordinates depends on the focal length

16882

terms of the intrinsic calibration.

16883

Finally, <code>r</code> represents the radial distance from the

16884

optical center, <code>r^2 = x_i^2 + y_i^2</code>.

16885

The distortion model used is the Brown-Conrady model.

</td>

</tr>

16892

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</tbody>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

16899

<tr><td colspan="7" id="section_noiseReduction" class="section">noiseReduction</td></tr>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

16900

16901

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

16902

<tr><td colspan="7" class="kind">controls</td></tr>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

16903

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

16904

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

16905

<tr>

16906

<th class="th_name">Property Name</th>

16907

16908

<th class="th_description">Description</th>

16909

<th class="th_units">Units</th>

16910

<th class="th_range">Range</th>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

16911

<th class="th_hal_version">Initial HIDL HAL version</th>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</tr>

</thead>

<tbody>

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

16928

<td class="entry_name

Zhijun He

2015-01-15 18:17:24 -0800

[diff] [blame]

16929

" rowspan="5">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

16930

android.noiseReduction.mode

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

16931

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

16932

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

16933

byte

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

16934

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

16935

[public]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

16936

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

16937

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

16938

[full]

16939

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

16940

16941

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

16942

16943

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

16944

OFF (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

16945

No noise reduction is applied.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

16946

</li>

16947

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

16948

FAST (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

16949

Noise reduction is applied without reducing frame rate relative to sensor

Chien-Yu Chen

2015-07-14 16:33:58 -0700

[diff] [blame]

16950

output. It may be the same as OFF if noise reduction will reduce frame rate

16951

relative to sensor.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

16952

</li>

16953

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

16954

HIGH_QUALITY (v3.2)

Yin-Chia Yeh

2015-04-02 14:00:40 -0700

[diff] [blame]

16955

High-quality noise reduction is applied, at the cost of possibly reduced frame

16956

rate relative to sensor output.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

16957

</li>

Zhijun He

2015-01-15 18:17:24 -0800

[diff] [blame]

16958

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

16959

MINIMAL (v3.2)

Zhijun He

2015-01-15 18:17:24 -0800

[diff] [blame]

16960

[optional]

16961

MINIMAL noise reduction is applied without reducing frame rate relative to

16962

sensor output.

16963

</li>

Eino-Ville Talvala

2015-07-07 10:40:59 -0700

[diff] [blame]

16964

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

16965

ZERO_SHUTTER_LAG (v3.2)

Eino-Ville Talvala

2015-07-07 10:40:59 -0700

[diff] [blame]

16966

[optional]

16967

Noise reduction is applied at different levels for different output streams,

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

16968

based on resolution. Streams at maximum recording resolution (see <a href="https://developer.android.com/reference/android/hardware/camera2/CameraDevice.html#createCaptureSession">CameraDevice#createCaptureSession</a>)

16969

or below have noise reduction applied, while higher-resolution streams have MINIMAL (if

16970

supported) or no noise reduction applied (if MINIMAL is not supported.) The degree of

16971

noise reduction for low-resolution streams is tuned so that frame rate is not impacted,

16972

and the quality is equal to or better than FAST (since it is only applied to

16973

lower-resolution outputs, quality may improve from FAST).

Eino-Ville Talvala

2015-07-07 10:40:59 -0700

[diff] [blame]

16974

This mode is intended to be used by applications operating in a zero-shutter-lag mode

16975

with YUV or PRIVATE reprocessing, where the application continuously captures

16976

high-resolution intermediate buffers into a circular buffer, from which a final image is

16977

produced via reprocessing when a user takes a picture. For such a use case, the

16978

high-resolution buffers must not have noise reduction applied to maximize efficiency of

16979

preview and to avoid over-applying noise filtering when reprocessing, while

16980

low-resolution buffers (used for recording or preview, generally) need noise reduction

16981

applied for reasonable preview quality.

16982

This mode is guaranteed to be supported by devices that support either the

16983

YUV_REPROCESSING or PRIVATE_REPROCESSING capabilities

Chien-Yu Chen

2015-07-08 11:49:38 -0700

[diff] [blame]

16984

(<a href="#static_android.request.availableCapabilities">android.request.availableCapabilities</a> lists either of those capabilities) and it will

16985

be the default mode for CAMERA3_TEMPLATE_ZERO_SHUTTER_LAG template.

Eino-Ville Talvala

2015-07-07 10:40:59 -0700

[diff] [blame]

16986

</li>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

16987

</ul>

16988

16989

</td>

16990

16991

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

16992

Mode of operation for the noise reduction algorithm.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

16999

<a href="#static_android.noiseReduction.availableNoiseReductionModes">android.noiseReduction.availableNoiseReductionModes</a>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

17000

</td>

17001

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

Zhijun He

2015-04-24 17:59:50 -0700

[diff] [blame]

17009

<li><a href="#tag_REPROC">REPROC</a></li>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

</ul>

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

17015

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

17016

</tr>

17017

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

17018

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

17019

The noise reduction algorithm attempts to improve image quality by removing

Zhijun He

2015-01-15 18:17:24 -0800

[diff] [blame]

17020

excessive noise added by the capture process, especially in dark conditions.

17021

OFF means no noise reduction will be applied by the camera device, for both raw and

17022

YUV domain.

17023

MINIMAL means that only sensor raw domain basic noise reduction is enabled ,to remove

17024

demosaicing or other processing artifacts. For YUV_REPROCESSING, MINIMAL is same as OFF.

17025

This mode is optional, may not be support by all devices. The application should check

17026

<a href="#static_android.noiseReduction.availableNoiseReductionModes">android.noiseReduction.availableNoiseReductionModes</a> before using it.

Zhijun He

2014-01-16 12:13:35 -0800

[diff] [blame]

17027

FAST/HIGH_QUALITY both mean camera device determined noise filtering

17028

will be applied. HIGH_QUALITY mode indicates that the camera device

17029

will use the highest-quality noise filtering algorithms,

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

17030

even if it slows down capture rate. FAST means the camera device will not

Chien-Yu Chen

2015-07-14 16:33:58 -0700

[diff] [blame]

17031

slow down capture rate when applying noise filtering. FAST may be the same as MINIMAL if

17032

MINIMAL is listed, or the same as OFF if any noise filtering will slow down capture rate.

17033

Every output stream will have a similar amount of enhancement applied.

Eino-Ville Talvala

2015-07-07 10:40:59 -0700

[diff] [blame]

17034

ZERO_SHUTTER_LAG is meant to be used by applications that maintain a continuous circular

17035

buffer of high-resolution images during preview and reprocess image(s) from that buffer

17036

into a final capture when triggered by the user. In this mode, the camera device applies

17037

noise reduction to low-resolution streams (below maximum recording resolution) to maximize

17038

preview quality, but does not apply noise reduction to high-resolution streams, since

17039

those will be reprocessed later if necessary.

Zhijun He

2015-01-15 18:17:24 -0800

[diff] [blame]

17040

For YUV_REPROCESSING, these FAST/HIGH_QUALITY modes both mean that the camera device

17041

will apply FAST/HIGH_QUALITY YUV domain noise reduction, respectively. The camera device

17042

may adjust the noise reduction parameters for best image quality based on the

17043

<a href="#controls_android.reprocess.effectiveExposureFactor">android.reprocess.effectiveExposureFactor</a> if it is set.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

17044

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

17045

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

17046

Zhijun He

2015-01-15 18:17:24 -0800

[diff] [blame]

17047

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

17048

<th class="th_details" colspan="6">HAL Implementation Details</th>

Zhijun He

2015-01-15 18:17:24 -0800

[diff] [blame]

17049

</tr>

17050

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

17051

Zhijun He

2015-01-15 18:17:24 -0800

[diff] [blame]

17052

For YUV_REPROCESSING The HAL can use <a href="#controls_android.reprocess.effectiveExposureFactor">android.reprocess.effectiveExposureFactor</a> to

17053

adjust the internal noise reduction parameters appropriately to get the best quality

17054

images.

17055

</td>

17056

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

17057

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

17058

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

17059

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

17063

<td class="entry_name

17064

" rowspan="1">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

17065

android.noiseReduction.strength

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

17066

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

17067

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

17068

byte

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

17069

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

17070

[system]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

17071

17072

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

17076

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

17077

</td>

17078

17079

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

17080

Control the amount of noise reduction

17081

applied to the images

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

17085

1-10; 10 is max noise reduction

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Eino-Ville Talvala

2014-01-02 16:11:44 -0800

[diff] [blame]

17089

1 - 10

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

17090

</td>

17091

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

17096

Zhijun He

2014-05-23 11:02:34 -0700

[diff] [blame]

17097

17098

<li><a href="#tag_FUTURE">FUTURE</a></li>

17099

</ul>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

17100

</td>

17101

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

17102

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

17103

17104

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

17105

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

17106

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</tbody>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

17112

<tr><td colspan="7" class="kind">static</td></tr>

Ruben Brunk

2014-03-04 15:01:25 -0800

[diff] [blame]

<tr>

<th class="th_name">Property Name</th>

17117

17118

<th class="th_description">Description</th>

17119

<th class="th_units">Units</th>

17120

<th class="th_range">Range</th>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

17121

<th class="th_hal_version">Initial HIDL HAL version</th>

Ruben Brunk

2014-03-04 15:01:25 -0800

[diff] [blame]

</tr>

</thead>

<tbody>

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

17138

<td class="entry_name

Yin-Chia Yeh

2015-04-02 14:00:40 -0700

[diff] [blame]

17139

" rowspan="5">

Ruben Brunk

2014-03-04 15:01:25 -0800

[diff] [blame]

17140

android.noiseReduction.availableNoiseReductionModes

</td>

byte

x

n

Eino-Ville Talvala

2014-05-27 10:50:30 -0700

[diff] [blame]

17149

[public as enumList]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

17150

17151

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

17152

[limited]

17153

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

17154

Ruben Brunk

2014-03-04 15:01:25 -0800

[diff] [blame]

17155

<div class="entry_type_notes">list of enums</div>

17156

17157

17158

</td>

17159

17160

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

17161

List of noise reduction modes for <a href="#controls_android.noiseReduction.mode">android.noiseReduction.mode</a> that are supported

17162

by this camera device.

Ruben Brunk

2014-03-04 15:01:25 -0800

[diff] [blame]

</td>

</td>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

17169

Any value listed in <a href="#controls_android.noiseReduction.mode">android.noiseReduction.mode</a>

Ruben Brunk

2014-03-04 15:01:25 -0800

[diff] [blame]

17170

</td>

17171

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Ruben Brunk

2014-03-04 15:01:25 -0800

[diff] [blame]

Zhijun He

2015-04-24 17:59:50 -0700

[diff] [blame]

17179

<li><a href="#tag_REPROC">REPROC</a></li>

Ruben Brunk

2014-03-04 15:01:25 -0800

[diff] [blame]

</ul>

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

17185

<th class="th_details" colspan="6">Details</th>

Ruben Brunk

2014-03-04 15:01:25 -0800

[diff] [blame]

17186

</tr>

17187

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

17188

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

17189

Full-capability camera devices will always support OFF and FAST.

Chien-Yu Chen

2015-07-08 11:49:38 -0700

[diff] [blame]

17190

Camera devices that support YUV_REPROCESSING or PRIVATE_REPROCESSING will support

17191

ZERO_SHUTTER_LAG.

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

17192

Legacy-capability camera devices will only support FAST mode.

Ruben Brunk

2014-03-04 15:01:25 -0800

[diff] [blame]

</td>

</tr>

Yin-Chia Yeh

2015-04-02 14:00:40 -0700

[diff] [blame]

17196

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

17197

<th class="th_details" colspan="6">HAL Implementation Details</th>

Yin-Chia Yeh

2015-04-02 14:00:40 -0700

[diff] [blame]

17198

</tr>

17199

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

17200

Yin-Chia Yeh

2015-04-02 14:00:40 -0700

[diff] [blame]

17201

HAL must support both FAST and HIGH_QUALITY if noise reduction control is available

17202

on the camera device, but the underlying implementation can be the same for both modes.

17203

That is, if the highest quality implementation on the camera device does not slow down

17204

capture rate, then FAST and HIGH_QUALITY will generate the same output.

17205

</td>

17206

</tr>

Ruben Brunk

2014-03-04 15:01:25 -0800

[diff] [blame]

17207

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

17208

Ruben Brunk

2014-03-04 15:01:25 -0800

[diff] [blame]

17209

</tbody>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

17215

<tr><td colspan="7" class="kind">dynamic</td></tr>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

17216

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

17217

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

17218

<tr>

17219

<th class="th_name">Property Name</th>

17220

17221

<th class="th_description">Description</th>

17222

<th class="th_units">Units</th>

17223

<th class="th_range">Range</th>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

17224

<th class="th_hal_version">Initial HIDL HAL version</th>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</tr>

</thead>

<tbody>

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

17241

<td class="entry_name

Zhijun He

2015-01-15 18:17:24 -0800

[diff] [blame]

17242

" rowspan="5">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

17243

android.noiseReduction.mode

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

17244

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

17245

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

17246

byte

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

17247

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

17248

[public]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

17249

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

17250

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

17251

[full]

17252

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

17253

17254

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

17255

17256

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

17257

OFF (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

17258

No noise reduction is applied.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

17259

</li>

17260

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

17261

FAST (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

17262

Noise reduction is applied without reducing frame rate relative to sensor

Chien-Yu Chen

2015-07-14 16:33:58 -0700

[diff] [blame]

17263

output. It may be the same as OFF if noise reduction will reduce frame rate

17264

relative to sensor.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

17265

</li>

17266

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

17267

HIGH_QUALITY (v3.2)

Yin-Chia Yeh

2015-04-02 14:00:40 -0700

[diff] [blame]

17268

High-quality noise reduction is applied, at the cost of possibly reduced frame

17269

rate relative to sensor output.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

17270

</li>

Zhijun He

2015-01-15 18:17:24 -0800

[diff] [blame]

17271

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

17272

MINIMAL (v3.2)

Zhijun He

2015-01-15 18:17:24 -0800

[diff] [blame]

17273

[optional]

17274

MINIMAL noise reduction is applied without reducing frame rate relative to

17275

sensor output.

17276

</li>

Eino-Ville Talvala

2015-07-07 10:40:59 -0700

[diff] [blame]

17277

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

17278

ZERO_SHUTTER_LAG (v3.2)

Eino-Ville Talvala

2015-07-07 10:40:59 -0700

[diff] [blame]

17279

[optional]

17280

Noise reduction is applied at different levels for different output streams,

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

17281

based on resolution. Streams at maximum recording resolution (see <a href="https://developer.android.com/reference/android/hardware/camera2/CameraDevice.html#createCaptureSession">CameraDevice#createCaptureSession</a>)

17282

or below have noise reduction applied, while higher-resolution streams have MINIMAL (if

17283

supported) or no noise reduction applied (if MINIMAL is not supported.) The degree of

17284

noise reduction for low-resolution streams is tuned so that frame rate is not impacted,

17285

and the quality is equal to or better than FAST (since it is only applied to

17286

lower-resolution outputs, quality may improve from FAST).

Eino-Ville Talvala

2015-07-07 10:40:59 -0700

[diff] [blame]

17287

This mode is intended to be used by applications operating in a zero-shutter-lag mode

17288

with YUV or PRIVATE reprocessing, where the application continuously captures

17289

high-resolution intermediate buffers into a circular buffer, from which a final image is

17290

produced via reprocessing when a user takes a picture. For such a use case, the

17291

high-resolution buffers must not have noise reduction applied to maximize efficiency of

17292

preview and to avoid over-applying noise filtering when reprocessing, while

17293

low-resolution buffers (used for recording or preview, generally) need noise reduction

17294

applied for reasonable preview quality.

17295

This mode is guaranteed to be supported by devices that support either the

17296

YUV_REPROCESSING or PRIVATE_REPROCESSING capabilities

Chien-Yu Chen

2015-07-08 11:49:38 -0700

[diff] [blame]

17297

(<a href="#static_android.request.availableCapabilities">android.request.availableCapabilities</a> lists either of those capabilities) and it will

17298

be the default mode for CAMERA3_TEMPLATE_ZERO_SHUTTER_LAG template.

Eino-Ville Talvala

2015-07-07 10:40:59 -0700

[diff] [blame]

17299

</li>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

17300

</ul>

17301

17302

</td>

17303

17304

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

17305

Mode of operation for the noise reduction algorithm.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

17312

<a href="#static_android.noiseReduction.availableNoiseReductionModes">android.noiseReduction.availableNoiseReductionModes</a>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

17313

</td>

17314

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

Zhijun He

2015-04-24 17:59:50 -0700

[diff] [blame]

17322

<li><a href="#tag_REPROC">REPROC</a></li>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

</ul>

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

17328

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

17329

</tr>

17330

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

17331

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

17332

The noise reduction algorithm attempts to improve image quality by removing

Zhijun He

2015-01-15 18:17:24 -0800

[diff] [blame]

17333

excessive noise added by the capture process, especially in dark conditions.

17334

OFF means no noise reduction will be applied by the camera device, for both raw and

17335

YUV domain.

17336

MINIMAL means that only sensor raw domain basic noise reduction is enabled ,to remove

17337

demosaicing or other processing artifacts. For YUV_REPROCESSING, MINIMAL is same as OFF.

17338

This mode is optional, may not be support by all devices. The application should check

17339

<a href="#static_android.noiseReduction.availableNoiseReductionModes">android.noiseReduction.availableNoiseReductionModes</a> before using it.

Zhijun He

2014-01-16 12:13:35 -0800

[diff] [blame]

17340

FAST/HIGH_QUALITY both mean camera device determined noise filtering

17341

will be applied. HIGH_QUALITY mode indicates that the camera device

17342

will use the highest-quality noise filtering algorithms,

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

17343

even if it slows down capture rate. FAST means the camera device will not

Chien-Yu Chen

2015-07-14 16:33:58 -0700

[diff] [blame]

17344

slow down capture rate when applying noise filtering. FAST may be the same as MINIMAL if

17345

MINIMAL is listed, or the same as OFF if any noise filtering will slow down capture rate.

17346

Every output stream will have a similar amount of enhancement applied.

Eino-Ville Talvala

2015-07-07 10:40:59 -0700

[diff] [blame]

17347

ZERO_SHUTTER_LAG is meant to be used by applications that maintain a continuous circular

17348

buffer of high-resolution images during preview and reprocess image(s) from that buffer

17349

into a final capture when triggered by the user. In this mode, the camera device applies

17350

noise reduction to low-resolution streams (below maximum recording resolution) to maximize

17351

preview quality, but does not apply noise reduction to high-resolution streams, since

17352

those will be reprocessed later if necessary.

Zhijun He

2015-01-15 18:17:24 -0800

[diff] [blame]

17353

For YUV_REPROCESSING, these FAST/HIGH_QUALITY modes both mean that the camera device

17354

will apply FAST/HIGH_QUALITY YUV domain noise reduction, respectively. The camera device

17355

may adjust the noise reduction parameters for best image quality based on the

17356

<a href="#controls_android.reprocess.effectiveExposureFactor">android.reprocess.effectiveExposureFactor</a> if it is set.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

17357

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

17358

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

17359

Zhijun He

2015-01-15 18:17:24 -0800

[diff] [blame]

17360

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

17361

<th class="th_details" colspan="6">HAL Implementation Details</th>

Zhijun He

2015-01-15 18:17:24 -0800

[diff] [blame]

17362

</tr>

17363

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

17364

Zhijun He

2015-01-15 18:17:24 -0800

[diff] [blame]

17365

For YUV_REPROCESSING The HAL can use <a href="#controls_android.reprocess.effectiveExposureFactor">android.reprocess.effectiveExposureFactor</a> to

17366

adjust the internal noise reduction parameters appropriately to get the best quality

17367

images.

17368

</td>

17369

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

17370

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

17371

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

17372

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</tbody>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

17380

<tr><td colspan="7" id="section_quirks" class="section">quirks</td></tr>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

17381

17382

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

17383

<tr><td colspan="7" class="kind">static</td></tr>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

17384

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

17385

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

17386

<tr>

17387

<th class="th_name">Property Name</th>

17388

17389

<th class="th_description">Description</th>

17390

<th class="th_units">Units</th>

17391

<th class="th_range">Range</th>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

17392

<th class="th_hal_version">Initial HIDL HAL version</th>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</tr>

</thead>

<tbody>

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

17409

<td class="entry_name

17410

entry_name_deprecated

17411

" rowspan="3">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

17412

android.quirks.meteringCropRegion

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

17413

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

17414

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

17415

byte

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

17416

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

17417

[system]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

17418

17419

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

17420

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

[deprecated]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

17425

</td>

17426

17427

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

17428

If set to 1, the camera service does not

Igor Murashkin

2013-12-09 12:06:17 -0800

[diff] [blame]

17429

scale 'normalized' coordinates with respect to the crop

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

17430

region. This applies to metering input (a{e,f,wb}Region

17431

and output (face rectangles).

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

17438

Deprecated. Do not use.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

17439

</td>

17440

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

17450

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

17451

</tr>

17452

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

17453

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

17454

Normalized coordinates refer to those in the

17455

(-1000,1000) range mentioned in the

17456

android.hardware.Camera API.

Igor Murashkin

2013-12-09 12:06:17 -0800

[diff] [blame]

17457

HAL implementations should instead always use and emit

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

17458

sensor array-relative coordinates for all region data. Does

17459

not need to be listed in static metadata. Support will be

17460

removed in future versions of camera service.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

17461

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

17462

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

17463

17464

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

17465

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

17466

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

17470

<td class="entry_name

17471

entry_name_deprecated

17472

" rowspan="3">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

17473

android.quirks.triggerAfWithAuto

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

17474

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

17475

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

17476

byte

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

17477

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

17478

[system]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

17479

17480

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

17481

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

[deprecated]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

17486

</td>

17487

17488

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

17489

If set to 1, then the camera service always

17490

switches to FOCUS_MODE_AUTO before issuing a AF

17491

trigger.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

17498

Deprecated. Do not use.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

17499

</td>

17500

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

17510

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

17511

</tr>

17512

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

17513

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

17514

HAL implementations should implement AF trigger

17515

modes for AUTO, MACRO, CONTINUOUS_FOCUS, and

17516

CONTINUOUS_PICTURE modes instead of using this flag. Does

17517

not need to be listed in static metadata. Support will be

17518

removed in future versions of camera service

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

17519

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

17520

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

17521

17522

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

17523

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

17524

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

17528

<td class="entry_name

17529

entry_name_deprecated

17530

" rowspan="3">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

17531

android.quirks.useZslFormat

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

17532

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

17533

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

17534

byte

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

17535

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

17536

[system]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

17537

17538

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

17539

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

[deprecated]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

17544

</td>

17545

17546

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

17547

If set to 1, the camera service uses

17548

CAMERA2_PIXEL_FORMAT_ZSL instead of

17549

HAL_PIXEL_FORMAT_IMPLEMENTATION_DEFINED for the zero

17550

shutter lag stream

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

17557

Deprecated. Do not use.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

17558

</td>

17559

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

17569

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

17570

</tr>

17571

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

17572

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

17573

HAL implementations should use gralloc usage flags

Igor Murashkin

2013-12-09 12:06:17 -0800

[diff] [blame]

17574

to determine that a stream will be used for

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

17575

zero-shutter-lag, instead of relying on an explicit

17576

format setting. Does not need to be listed in static

17577

metadata. Support will be removed in future versions of

17578

camera service.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

17579

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

17580

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

17581

17582

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

17583

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

17584

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

17585

Eino-Ville Talvala

2013-10-09 18:21:30 -0700

[diff] [blame]

17586

17587

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

17588

<td class="entry_name

17589

entry_name_deprecated

17590

" rowspan="5">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

17591

android.quirks.usePartialResult

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

17592

</td>

Eino-Ville Talvala

2013-10-09 18:21:30 -0700

[diff] [blame]

byte

Eino-Ville Talvala

2013-11-07 14:43:43 -0800

[diff] [blame]

17596

[hidden]

Eino-Ville Talvala

2013-10-09 18:21:30 -0700

[diff] [blame]

17597

17598

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

17599

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

[deprecated]

Eino-Ville Talvala

2013-10-09 18:21:30 -0700

[diff] [blame]

17604

</td>

17605

17606

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

17607

If set to 1, the HAL will always split result

17608

metadata for a single capture into multiple buffers,

17609

returned using multiple process_capture_result calls.

Eino-Ville Talvala

2013-10-09 18:21:30 -0700

[diff] [blame]

</td>

</td>

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

17616

Deprecated. Do not use.

Eino-Ville Talvala

2013-10-09 18:21:30 -0700

[diff] [blame]

17617

</td>

17618

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

17628

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

17629

</tr>

17630

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

17631

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

17632

Does not need to be listed in static

17633

metadata. Support for partial results will be reworked in

17634

future versions of camera service. This quirk will stop

Igor Murashkin

2013-12-09 12:06:17 -0800

[diff] [blame]

17635

working at that point; DO NOT USE without careful

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

17636

consideration of future support.

Eino-Ville Talvala

2013-10-09 18:21:30 -0700

[diff] [blame]

17637

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

17638

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

17639

Igor Murashkin

2014-01-27 16:06:38 -0800

[diff] [blame]

17640

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

17641

<th class="th_details" colspan="6">HAL Implementation Details</th>

Igor Murashkin

2014-01-27 16:06:38 -0800

[diff] [blame]

17642

</tr>

17643

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

17644

Igor Murashkin

2014-01-27 16:06:38 -0800

[diff] [blame]

17645

Refer to <code>camera3_capture_result::partial_result</code>

17646

for information on how to implement partial results.

17647

</td>

17648

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

17649

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

17650

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

17651

Eino-Ville Talvala

2013-10-09 18:21:30 -0700

[diff] [blame]

</tbody>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

17657

<tr><td colspan="7" class="kind">dynamic</td></tr>

Eino-Ville Talvala

2013-10-09 18:21:30 -0700

[diff] [blame]

<tr>

<th class="th_name">Property Name</th>

17662

17663

<th class="th_description">Description</th>

17664

<th class="th_units">Units</th>

17665

<th class="th_range">Range</th>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

17666

<th class="th_hal_version">Initial HIDL HAL version</th>

Eino-Ville Talvala

2013-10-09 18:21:30 -0700

[diff] [blame]

</tr>

</thead>

<tbody>

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

17683

<td class="entry_name

17684

entry_name_deprecated

17685

" rowspan="5">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

17686

android.quirks.partialResult

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

17687

</td>

Eino-Ville Talvala

2013-10-09 18:21:30 -0700

[diff] [blame]

byte

Eino-Ville Talvala

2013-11-07 14:43:43 -0800

[diff] [blame]

17691

[hidden as boolean]

Eino-Ville Talvala

2013-10-09 18:21:30 -0700

[diff] [blame]

17692

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

17693

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

17694

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

[deprecated]

Eino-Ville Talvala

2013-10-09 18:21:30 -0700

[diff] [blame]

17698

17699

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

17700

FINAL (v3.2)

Igor Murashkin

2014-01-15 17:05:22 -0800

[diff] [blame]

17701

The last or only metadata result buffer

17702

for this capture.

Eino-Ville Talvala

2013-10-09 18:21:30 -0700

[diff] [blame]

17703

</li>

17704

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

17705

PARTIAL (v3.2)

Igor Murashkin

2014-01-15 17:05:22 -0800

[diff] [blame]

17706

A partial buffer of result metadata for this

17707

capture. More result buffers for this capture will be sent

Zhijun He

2014-02-24 09:49:37 -0800

[diff] [blame]

17708

by the camera device, the last of which will be marked

Igor Murashkin

2014-01-15 17:05:22 -0800

[diff] [blame]

17709

FINAL.

Eino-Ville Talvala

2013-10-09 18:21:30 -0700

[diff] [blame]

</li>

</ul>

</td>

17714

17715

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

17716

Whether a result given to the framework is the

17717

final one for the capture, or only a partial that contains a

Igor Murashkin

2013-12-09 12:06:17 -0800

[diff] [blame]

17718

subset of the full set of dynamic metadata

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

17719

values.

Eino-Ville Talvala

2013-10-09 18:21:30 -0700

[diff] [blame]

</td>

</td>

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

17726

Deprecated. Do not use.

17727

Optional. Default value is FINAL.

Eino-Ville Talvala

2013-10-09 18:21:30 -0700

[diff] [blame]

17728

</td>

17729

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

17739

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

17740

</tr>

17741

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

17742

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

17743

The entries in the result metadata buffers for a

17744

single capture may not overlap, except for this entry. The

Igor Murashkin

2013-12-09 12:06:17 -0800

[diff] [blame]

17745

FINAL buffers must retain FIFO ordering relative to the

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

17746

requests that generate them, so the FINAL buffer for frame 3 must

17747

always be sent to the framework after the FINAL buffer for frame 2, and

17748

before the FINAL buffer for frame 4. PARTIAL buffers may be returned

17749

in any order relative to other frames, but all PARTIAL buffers for a given

17750

capture must arrive before the FINAL buffer for that capture. This entry may

Zhijun He

2014-02-24 09:49:37 -0800

[diff] [blame]

17751

only be used by the camera device if quirks.usePartialResult is set to 1.

Eino-Ville Talvala

2013-10-09 18:21:30 -0700

[diff] [blame]

17752

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

17753

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

17754

Igor Murashkin

2014-01-27 16:06:38 -0800

[diff] [blame]

17755

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

17756

<th class="th_details" colspan="6">HAL Implementation Details</th>

Igor Murashkin

2014-01-27 16:06:38 -0800

[diff] [blame]

17757

</tr>

17758

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

17759

Igor Murashkin

2014-01-27 16:06:38 -0800

[diff] [blame]

17760

Refer to <code>camera3_capture_result::partial_result</code>

17761

for information on how to implement partial results.

17762

</td>

17763

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

17764

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

17765

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

17766

Eino-Ville Talvala

2013-10-09 18:21:30 -0700

[diff] [blame]

17767

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</tbody>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

17774

<tr><td colspan="7" id="section_request" class="section">request</td></tr>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

17775

17776

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

17777

<tr><td colspan="7" class="kind">controls</td></tr>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

17778

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

17779

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

17780

<tr>

17781

<th class="th_name">Property Name</th>

17782

17783

<th class="th_description">Description</th>

17784

<th class="th_units">Units</th>

17785

<th class="th_range">Range</th>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

17786

<th class="th_hal_version">Initial HIDL HAL version</th>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</tr>

</thead>

<tbody>

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

17803

<td class="entry_name

17804

entry_name_deprecated

17805

" rowspan="1">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

17806

android.request.frameCount

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

17807

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

17808

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

17809

int32

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

17810

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

17811

[system]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

17812

17813

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

17814

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

[deprecated]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

17819

</td>

17820

17821

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

17822

A frame counter set by the framework. Must

17823

be maintained unchanged in output frame. This value monotonically

17824

increases with every new result (that is, each new result has a unique

17825

frameCount value).

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

17829

incrementing integer

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

17833

Deprecated. Do not use.

17834

Any int.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

17835

</td>

17836

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

17844

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

17845

17846

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

17847

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

17848

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

17852

<td class="entry_name

17853

" rowspan="1">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

17854

android.request.id

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

17855

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

17856

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

17857

int32

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

17858

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

17859

[hidden]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

17860

17861

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

17865

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

17866

</td>

17867

17868

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

17869

An application-specified ID for the current

17870

request. Must be maintained unchanged in output

17871

frame

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

17875

arbitrary integer assigned by application

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Eino-Ville Talvala

2014-01-02 16:11:44 -0800

[diff] [blame]

17879

Any int

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

17880

</td>

17881

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

17886

17887

Igor Murashkin

2012-12-05 14:49:11 -0800

[diff] [blame]

17888

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</ul>

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

17892

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

17893

17894

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

17895

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

17896

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

17900

<td class="entry_name

17901

entry_name_deprecated

17902

" rowspan="3">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

17903

android.request.inputStreams

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

17904

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

17905

Zhijun He

e36cdbe

2013-09-06 14:28:37 -0700

[diff] [blame]

17906

int32

Eino-Ville Talvala

2013-07-12 17:02:27 -0700

[diff] [blame]

17907

x

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

17908

Eino-Ville Talvala

2013-07-12 17:02:27 -0700

[diff] [blame]

n

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

17912

[system]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

17913

17914

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

17915

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

[deprecated]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

17920

</td>

17921

17922

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

17923

List which camera reprocess stream is used

17924

for the source of reprocessing data.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

17928

List of camera reprocess stream IDs

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

17932

Deprecated. Do not use.

17933

Typically, only one entry allowed, must be a valid reprocess stream ID.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

17934

</td>

17935

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

17940

Eino-Ville Talvala

2013-07-12 17:02:27 -0700

[diff] [blame]

17941

17942

17943

</ul>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

17944

</td>

17945

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

17946

</tr>

17947

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

17948

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

17949

</tr>

17950

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

17951

Eino-Ville Talvala

2014-01-02 16:11:44 -0800

[diff] [blame]

17952

Only meaningful when <a href="#controls_android.request.type">android.request.type</a> ==

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

17953

REPROCESS. Ignored otherwise

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

17954

</td>

17955

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

17956

17957

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

17958

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

17959

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

17963

<td class="entry_name

17964

" rowspan="1">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

17965

android.request.metadataMode

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

17966

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

17967

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

17968

byte

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

17969

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

17970

[system]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

17971

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

17975

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

17976

17977

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

17978

NONE (v3.2)

Igor Murashkin

2014-01-15 17:05:22 -0800

[diff] [blame]

17979

No metadata should be produced on output, except

17980

for application-bound buffer data. If no

17981

application-bound streams exist, no frame should be

17982

placed in the output frame queue. If such streams

17983

exist, a frame should be placed on the output queue

17984

with null metadata but with the necessary output buffer

17985

information. Timestamp information should still be

17986

included with any output stream buffers

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

17987

</li>

17988

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

17989

FULL (v3.2)

Igor Murashkin

2014-01-15 17:05:22 -0800

[diff] [blame]

17990

All metadata should be produced. Statistics will

17991

only be produced if they are separately

17992

enabled

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</li>

</ul>

</td>

17997

17998

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

17999

How much metadata to produce on

18000

output

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

18013

Zhijun He

2014-05-23 11:02:34 -0700

[diff] [blame]

18014

18015

<li><a href="#tag_FUTURE">FUTURE</a></li>

18016

</ul>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

18017

</td>

18018

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

18019

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

18020

18021

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

18022

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

18023

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

18027

<td class="entry_name

18028

entry_name_deprecated

18029

" rowspan="3">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

18030

android.request.outputStreams

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

18031

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

18032

Zhijun He

e36cdbe

2013-09-06 14:28:37 -0700

[diff] [blame]

18033

int32

Eino-Ville Talvala

2013-07-12 17:02:27 -0700

[diff] [blame]

18034

x

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

18035

Eino-Ville Talvala

2013-07-12 17:02:27 -0700

[diff] [blame]

n

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

18039

[system]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

18040

18041

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

18042

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

[deprecated]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

18047

</td>

18048

18049

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

18050

Lists which camera output streams image data

18051

from this capture must be sent to

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

18055

List of camera stream IDs

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

18059

Deprecated. Do not use.

18060

List must only include streams that have been

Eino-Ville Talvala

2014-01-02 16:11:44 -0800

[diff] [blame]

18061

created

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

18062

</td>

18063

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

18068

Eino-Ville Talvala

2013-07-12 17:02:27 -0700

[diff] [blame]

18069

18070

18071

</ul>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

18072

</td>

18073

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

18074

</tr>

18075

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

18076

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

18077

</tr>

18078

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

18079

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

18080

If no output streams are listed, then the image

18081

data should simply be discarded. The image data must

18082

still be captured for metadata and statistics production,

18083

and the lens and flash must operate as requested.

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

18084

</td>

18085

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

18086

18087

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

18088

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

18089

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

18093

<td class="entry_name

18094

entry_name_deprecated

18095

" rowspan="1">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

18096

android.request.type

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

18097

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

18098

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

18099

byte

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

18100

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

18101

[system]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

18102

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

18103

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

18104

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

[deprecated]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

18108

18109

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

18110

CAPTURE (v3.2)

Igor Murashkin

2014-01-15 17:05:22 -0800

[diff] [blame]

18111

Capture a new image from the imaging hardware,

18112

and process it according to the

18113

settings

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

18114

</li>

18115

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

18116

REPROCESS (v3.2)

Igor Murashkin

2014-01-15 17:05:22 -0800

[diff] [blame]

18117

Process previously captured data; the

Eino-Ville Talvala

2014-02-10 12:39:35 -0800

[diff] [blame]

18118

<a href="#controls_android.request.inputStreams">android.request.inputStreams</a> parameter determines the

Igor Murashkin

2014-01-15 17:05:22 -0800

[diff] [blame]

18119

source reprocessing stream. TODO: Mark dynamic metadata

18120

needed for reprocessing with [RP]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</li>

</ul>

</td>

18125

18126

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

18127

The type of the request; either CAPTURE or

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

18128

REPROCESS. For legacy HAL3, this tag is redundant.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

18135

Deprecated. Do not use.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

18136

</td>

18137

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

18142

Eino-Ville Talvala

2013-07-12 17:02:27 -0700

[diff] [blame]

18143

18144

18145

</ul>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

18146

</td>

18147

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

18148

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

18149

18150

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

18151

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

18152

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</tbody>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

18158

<tr><td colspan="7" class="kind">static</td></tr>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

18159

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

18160

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

18161

<tr>

18162

<th class="th_name">Property Name</th>

18163

18164

<th class="th_description">Description</th>

18165

<th class="th_units">Units</th>

18166

<th class="th_range">Range</th>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

18167

<th class="th_hal_version">Initial HIDL HAL version</th>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</tr>

</thead>

<tbody>

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

18184

<td class="entry_name

18185

" rowspan="3">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

18186

android.request.maxNumOutputStreams

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

18187

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

18188

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

18189

int32

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

x

3

Yin-Chia Yeh

2016-04-02 16:30:30 -0700

[diff] [blame]

18195

[ndk_public]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

18196

18197

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

18198

[legacy]

18199

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

18203

</td>

18204

18205

Zhijun He

2014-01-22 15:58:57 -0800

[diff] [blame]

18206

The maximum numbers of different types of output streams

18207

that can be configured and used simultaneously by a camera device.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Zhijun He

2014-04-24 11:17:25 -0700

[diff] [blame]

18214

For processed (and stalling) format streams, >= 1.

18215

For Raw format (either stalling or non-stalling) streams, >= 0.

18216

For processed (but not stalling) format streams, >= 3

Zhijun He

2e76d00

2014-02-12 13:37:03 -0800

[diff] [blame]

18217

for FULL mode devices (<code><a href="#static_android.info.supportedHardwareLevel">android.info.supportedHardwareLevel</a> == FULL</code>);

18218

>= 2 for LIMITED mode devices (<code><a href="#static_android.info.supportedHardwareLevel">android.info.supportedHardwareLevel</a> == LIMITED</code>).

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

18219

</td>

18220

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

18225

18226

Igor Murashkin

2012-12-05 14:49:11 -0800

[diff] [blame]

18227

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</ul>

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

18231

</tr>

18232

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

18233

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

18234

</tr>

18235

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

18236

Zhijun He

2014-01-22 15:58:57 -0800

[diff] [blame]

18237

This is a 3 element tuple that contains the max number of output simultaneous

Zhijun He

2014-04-24 11:17:25 -0700

[diff] [blame]

18238

streams for raw sensor, processed (but not stalling), and processed (and stalling)

18239

formats respectively. For example, assuming that JPEG is typically a processed and

18240

stalling stream, if max raw sensor format output stream number is 1, max YUV streams

Zhijun He

2014-01-22 15:58:57 -0800

[diff] [blame]

18241

number is 3, and max JPEG stream number is 2, then this tuple should be <code>(1, 3, 2)</code>.

18242

This lists the upper bound of the number of output streams supported by

18243

the camera device. Using more streams simultaneously may require more hardware and

Igor Murashkin

2014-05-27 10:51:25 -0700

[diff] [blame]

18244

CPU resources that will consume more power. The image format for an output stream can

Zhijun He

2014-04-24 11:17:25 -0700

[diff] [blame]

18245

be any supported format provided by <a href="#static_android.scaler.availableStreamConfigurations">android.scaler.availableStreamConfigurations</a>.

Shuzhen Wang

2022-05-03 11:01:26 -0700

[diff] [blame]

18246

The formats defined in <a href="#static_android.scaler.availableStreamConfigurations">android.scaler.availableStreamConfigurations</a> can be categorized

Zhijun He

2014-04-24 11:17:25 -0700

[diff] [blame]

18247

into the 3 stream types as below:

Zhijun He

2014-01-22 15:58:57 -0800

[diff] [blame]

18248

<ul>

Zhijun He

2014-04-24 11:17:25 -0700

[diff] [blame]

18249

<li>Processed (but stalling): any non-RAW format with a stallDurations > 0.

Eino-Ville Talvala

2015-04-16 13:49:52 -0700

[diff] [blame]

18250

Typically <a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#JPEG">JPEG format</a>.</li>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

18251

<li>Raw formats: <a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#RAW_SENSOR">RAW_SENSOR</a>, <a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#RAW10">RAW10</a>, or

18252

18253

<li>Processed (but not-stalling): any non-RAW format without a stall duration. Typically

18254

<a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#YUV_420_888">YUV_420_888</a>,

Shuzhen Wang

2018-09-27 15:50:01 -0700

[diff] [blame]

18255

Zhijun He

2014-01-22 15:58:57 -0800

[diff] [blame]

18256

</ul>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

18257

</td>

18258

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

18259

18260

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

18261

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

18262

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

18263

18264

Igor Murashkin

2014-05-27 10:51:25 -0700

[diff] [blame]

18265

18266

<td class="entry_name

18267

" rowspan="3">

18268

android.request.maxNumOutputRaw

</td>

int32

Yin-Chia Yeh

2016-04-02 16:30:30 -0700

[diff] [blame]

18273

[java_public]

Igor Murashkin

2014-05-27 10:51:25 -0700

[diff] [blame]

[synthetic]

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

18277

[legacy]

18278

Igor Murashkin

2014-05-27 10:51:25 -0700

[diff] [blame]

</td>

18283

18284

18285

The maximum numbers of different types of output streams

18286

that can be configured and used simultaneously by a camera device

18287

for any <code>RAW</code> formats.

</td>

</td>

>= 0

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2014-05-27 10:51:25 -0700

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

18306

<th class="th_details" colspan="6">Details</th>

Igor Murashkin

2014-05-27 10:51:25 -0700

[diff] [blame]

18307

</tr>

18308

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

18309

Igor Murashkin

2014-05-27 10:51:25 -0700

[diff] [blame]

18310

This value contains the max number of output simultaneous

18311

streams from the raw sensor.

18312

This lists the upper bound of the number of output streams supported by

18313

the camera device. Using more streams simultaneously may require more hardware and

18314

CPU resources that will consume more power. The image format for this kind of an output stream can

18315

be any <code>RAW</code> and supported format provided by <a href="#static_android.scaler.streamConfigurationMap">android.scaler.streamConfigurationMap</a>.

18316

In particular, a <code>RAW</code> format is typically one of:

18317

<ul>

Eino-Ville Talvala

2015-04-16 13:49:52 -0700

[diff] [blame]

18318

<li><a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#RAW_SENSOR">RAW_SENSOR</a></li>

18319

18320

Igor Murashkin

2014-05-27 10:51:25 -0700

[diff] [blame]

18321

</ul>

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

18322

LEGACY mode devices (<a href="#static_android.info.supportedHardwareLevel">android.info.supportedHardwareLevel</a> <code>==</code> LEGACY)

18323

never support raw streams.

Igor Murashkin

2014-05-27 10:51:25 -0700

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

18328

Igor Murashkin

2014-05-27 10:51:25 -0700

[diff] [blame]

18329

<td class="entry_name

18334

" rowspan="3">

18335

android.request.maxNumOutputProc

</td>

int32

Yin-Chia Yeh

2016-04-02 16:30:30 -0700

[diff] [blame]

18340

[java_public]

Igor Murashkin

2014-05-27 10:51:25 -0700

[diff] [blame]

[synthetic]

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

18344

[legacy]

18345

Igor Murashkin

2014-05-27 10:51:25 -0700

[diff] [blame]

</td>

18350

18351

18352

The maximum numbers of different types of output streams

18353

that can be configured and used simultaneously by a camera device

18354

for any processed (but not-stalling) formats.

</td>

</td>

>= 3

for FULL mode devices (<code><a href="#static_android.info.supportedHardwareLevel">android.info.supportedHardwareLevel</a> == FULL</code>);

18363

>= 2 for LIMITED mode devices (<code><a href="#static_android.info.supportedHardwareLevel">android.info.supportedHardwareLevel</a> == LIMITED</code>).

18364

</td>

18365

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2014-05-27 10:51:25 -0700

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

18375

<th class="th_details" colspan="6">Details</th>

Igor Murashkin

2014-05-27 10:51:25 -0700

[diff] [blame]

18376

</tr>

18377

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

18378

Igor Murashkin

2014-05-27 10:51:25 -0700

[diff] [blame]

18379

This value contains the max number of output simultaneous

18380

streams for any processed (but not-stalling) formats.

18381

This lists the upper bound of the number of output streams supported by

18382

the camera device. Using more streams simultaneously may require more hardware and

18383

CPU resources that will consume more power. The image format for this kind of an output stream can

18384

be any non-<code>RAW</code> and supported format provided by <a href="#static_android.scaler.streamConfigurationMap">android.scaler.streamConfigurationMap</a>.

18385

Processed (but not-stalling) is defined as any non-RAW format without a stall duration.

18386

Typically:

18387

<ul>

Eino-Ville Talvala

2015-04-16 13:49:52 -0700

[diff] [blame]

<li>Implementation-defined formats, i.e. <a href="https://developer.android.com/reference/android/hardware/camera2/params/StreamConfigurationMap.html#isOutputSupportedFor(Class)">StreamConfigurationMap#isOutputSupportedFor(Class)</a></li>

Shuzhen Wang

2018-09-27 15:50:01 -0700

[diff] [blame]

18392

Igor Murashkin

2014-05-27 10:51:25 -0700

[diff] [blame]

18393

</ul>

Eino-Ville Talvala

2015-04-16 13:49:52 -0700

[diff] [blame]

18394

For full guarantees, query <a href="https://developer.android.com/reference/android/hardware/camera2/params/StreamConfigurationMap.html#getOutputStallDuration">StreamConfigurationMap#getOutputStallDuration</a> with a

18395

processed format -- it will return 0 for a non-stalling stream.

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

18396

LEGACY devices will support at least 2 processing/non-stalling streams.

Igor Murashkin

2014-05-27 10:51:25 -0700

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

18401

Igor Murashkin

2014-05-27 10:51:25 -0700

[diff] [blame]

18402

<td class="entry_name

18407

" rowspan="3">

18408

android.request.maxNumOutputProcStalling

</td>

int32

Yin-Chia Yeh

2016-04-02 16:30:30 -0700

[diff] [blame]

18413

[java_public]

Igor Murashkin

2014-05-27 10:51:25 -0700

[diff] [blame]

[synthetic]

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

18417

[legacy]

18418

Igor Murashkin

2014-05-27 10:51:25 -0700

[diff] [blame]

</td>

18423

18424

18425

The maximum numbers of different types of output streams

18426

that can be configured and used simultaneously by a camera device

18427

for any processed (and stalling) formats.

</td>

</td>

>= 1

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2014-05-27 10:51:25 -0700

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

18446

<th class="th_details" colspan="6">Details</th>

Igor Murashkin

2014-05-27 10:51:25 -0700

[diff] [blame]

18447

</tr>

18448

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

18449

Igor Murashkin

2014-05-27 10:51:25 -0700

[diff] [blame]

18450

This value contains the max number of output simultaneous

18451

streams for any processed (but not-stalling) formats.

18452

This lists the upper bound of the number of output streams supported by

18453

the camera device. Using more streams simultaneously may require more hardware and

18454

CPU resources that will consume more power. The image format for this kind of an output stream can

18455

be any non-<code>RAW</code> and supported format provided by <a href="#static_android.scaler.streamConfigurationMap">android.scaler.streamConfigurationMap</a>.

Eino-Ville Talvala

2015-04-16 13:49:52 -0700

[diff] [blame]

18456

A processed and stalling format is defined as any non-RAW format with a stallDurations

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

18457

> 0. Typically only the <a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#JPEG">JPEG format</a> is a stalling format.

Eino-Ville Talvala

2015-04-16 13:49:52 -0700

[diff] [blame]

18458

For full guarantees, query <a href="https://developer.android.com/reference/android/hardware/camera2/params/StreamConfigurationMap.html#getOutputStallDuration">StreamConfigurationMap#getOutputStallDuration</a> with a

18459

processed format -- it will return a non-0 value for a stalling stream.

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

18460

LEGACY devices will support up to 1 processing/stalling stream.

Igor Murashkin

2014-05-27 10:51:25 -0700

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

18465

Igor Murashkin

2014-05-27 10:51:25 -0700

[diff] [blame]

18466

18467

18468

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

18469

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

18470

<td class="entry_name

18471

entry_name_deprecated

18472

" rowspan="3">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

18473

android.request.maxNumReprocessStreams

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

18474

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

18475

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

18476

int32

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

x

1

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

18482

[system]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

18483

18484

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

18485

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

[deprecated]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

18490

</td>

18491

18492

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

18493

How many reprocessing streams of any type

Zhijun He

2014-01-22 15:58:57 -0800

[diff] [blame]

18494

can be allocated at the same time.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

18501

Deprecated. Do not use.

Zhijun He

2014-01-22 15:58:57 -0800

[diff] [blame]

>= 0

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Zhijun He

2014-01-22 15:58:57 -0800

[diff] [blame]

</ul>

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

18517

<th class="th_details" colspan="6">Details</th>

Zhijun He

2014-01-22 15:58:57 -0800

[diff] [blame]

18518

</tr>

18519

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

18520

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

18521

Only used by HAL2.x.

Zhijun He

2014-01-22 15:58:57 -0800

[diff] [blame]

18522

When set to 0, it means no reprocess stream is supported.

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

18527

Zhijun He

2014-01-22 15:58:57 -0800

[diff] [blame]

18528

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

18532

<td class="entry_name

Zhijun He

2015-01-15 18:17:24 -0800

[diff] [blame]

18533

" rowspan="5">

Zhijun He

2014-01-22 15:58:57 -0800

[diff] [blame]

18534

android.request.maxNumInputStreams

</td>

int32

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

18539

[java_public]

Zhijun He

2014-01-22 15:58:57 -0800

[diff] [blame]

18540

18541

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

18542

[full]

18543

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Zhijun He

2014-01-22 15:58:57 -0800

[diff] [blame]

18547

</td>

18548

18549

18550

The maximum numbers of any type of input streams

18551

that can be configured and used simultaneously by a camera device.

</td>

</td>

Zhijun He

2014-06-25 08:35:53 -0700

[diff] [blame]

18558

0 or 1.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

18559

</td>

18560

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

18565

Zhijun He

2015-04-24 17:59:50 -0700

[diff] [blame]

18566

18567

<li><a href="#tag_REPROC">REPROC</a></li>

18568

</ul>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

18569

</td>

18570

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

18571

</tr>

Zhijun He

2014-01-22 15:58:57 -0800

[diff] [blame]

18572

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

18573

<th class="th_details" colspan="6">Details</th>

Zhijun He

2014-01-22 15:58:57 -0800

[diff] [blame]

18574

</tr>

18575

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

18576

Zhijun He

2014-01-22 15:58:57 -0800

[diff] [blame]

18577

When set to 0, it means no input stream is supported.

Eino-Ville Talvala

2015-04-16 13:49:52 -0700

[diff] [blame]

18578

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>. When using an

18579

input stream, there must be at least one output stream configured to to receive the

18580

reprocessed images.

Zhijun He

2015-01-15 18:17:24 -0800

[diff] [blame]

18581

When an input stream and some output streams are used in a reprocessing request,

18582

only the input buffer will be used to produce these output stream buffers, and a

18583

new sensor image will not be captured.

Zhijun He

2014-01-22 15:58:57 -0800

[diff] [blame]

18584

For example, for Zero Shutter Lag (ZSL) still capture use case, the input

Chien-Yu Chen

2015-05-12 15:13:00 -0700

[diff] [blame]

18585

stream image format will be PRIVATE, the associated output stream image format

Zhijun He

2014-01-22 15:58:57 -0800

[diff] [blame]

18586

should be JPEG.

18587

</td>

18588

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

18589

Zhijun He

2015-01-15 18:17:24 -0800

[diff] [blame]

18590

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

18591

<th class="th_details" colspan="6">HAL Implementation Details</th>

Zhijun He

2015-01-15 18:17:24 -0800

[diff] [blame]

18592

</tr>

18593

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

18594

Zhijun He

2015-01-15 18:17:24 -0800

[diff] [blame]

18595

For the reprocessing flow and controls, see

18596

hardware/libhardware/include/hardware/camera3.h Section 10 for more details.

18597

</td>

18598

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

18599

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

18600

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

18601

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

18602

Igor Murashkin

2014-01-09 17:43:38 -0800

[diff] [blame]

18603

18604

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

18605

<td class="entry_name

18606

" rowspan="5">

Igor Murashkin

2014-01-09 17:43:38 -0800

[diff] [blame]

18607

android.request.pipelineMaxDepth

</td>

byte

[public]

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

18615

[legacy]

18616

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2014-01-09 17:43:38 -0800

[diff] [blame]

18620

</td>

18621

18622

18623

Specifies the number of maximum pipeline stages a frame

18624

has to go through from when it's exposed to when it's available

to the framework.

</td>

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2014-01-09 17:43:38 -0800

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

18643

<th class="th_details" colspan="6">Details</th>

Igor Murashkin

2014-01-09 17:43:38 -0800

[diff] [blame]

18644

</tr>

18645

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

18646

Igor Murashkin

2014-01-09 17:43:38 -0800

[diff] [blame]

18647

A typical minimum value for this is 2 (one stage to expose,

18648

one stage to readout) from the sensor. The ISP then usually adds

18649

its own stages to do custom HW processing. Further stages may be

18650

added by SW processing.

18651

Depending on what settings are used (e.g. YUV, JPEG) and what

18652

processing is enabled (e.g. face detection), the actual pipeline

18653

depth (specified by <a href="#dynamic_android.request.pipelineDepth">android.request.pipelineDepth</a>) may be less than

18654

the max pipeline depth.

18655

A pipeline depth of X stages is equivalent to a pipeline latency of

18656

X frame intervals.

Zhijun He

2015-05-22 17:04:15 -0700

[diff] [blame]

18657

This value will normally be 8 or less, however, for high speed capture session,

18658

the max pipeline depth will be up to 8 x size of high speed capture request list.

Igor Murashkin

2014-01-09 17:43:38 -0800

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

18663

<th class="th_details" colspan="6">HAL Implementation Details</th>

Igor Murashkin

2014-01-09 17:43:38 -0800

[diff] [blame]

18664

</tr>

18665

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

18666

Zhijun He

2015-05-22 17:04:15 -0700

[diff] [blame]

18667

This value should be 4 or less, expect for the high speed recording session, where the

18668

max batch sizes may be larger than 1.

Igor Murashkin

2014-01-09 17:43:38 -0800

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

18672

Igor Murashkin

2014-01-09 17:43:38 -0800

[diff] [blame]

18673

18674

Igor Murashkin

2014-01-10 14:18:30 -0800

[diff] [blame]

18675

18676

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

18677

<td class="entry_name

18678

" rowspan="3">

Igor Murashkin

2014-01-10 14:18:30 -0800

[diff] [blame]

18679

android.request.partialResultCount

</td>

int32

[public]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

18690

Igor Murashkin

2014-01-10 14:18:30 -0800

[diff] [blame]

18691

</td>

18692

18693

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

18694

Defines how many sub-components

Igor Murashkin

2014-01-10 14:18:30 -0800

[diff] [blame]

18695

a result will be composed of.

</td>

</td>

>= 1

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2014-01-10 14:18:30 -0800

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

18714

<th class="th_details" colspan="6">Details</th>

Igor Murashkin

2014-01-10 14:18:30 -0800

[diff] [blame]

18715

</tr>

18716

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

18717

Igor Murashkin

2014-01-10 14:18:30 -0800

[diff] [blame]

18718

In order to combat the pipeline latency, partial results

18719

may be delivered to the application layer from the camera device as

18720

soon as they are available.

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

18721

Optional; defaults to 1. A value of 1 means that partial

18722

results are not supported, and only the final TotalCaptureResult will

18723

be produced by the camera device.

Eino-Ville Talvala

2014-06-06 14:35:41 -0700

[diff] [blame]

18724

A typical use case for this might be: after requesting an

18725

auto-focus (AF) lock the new AF state might be available 50%

18726

of the way through the pipeline. The camera device could

18727

then immediately dispatch this state via a partial result to

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

18728

the application, and the rest of the metadata via later

18729

partial results.

Igor Murashkin

2014-01-10 14:18:30 -0800

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

18734

Igor Murashkin

2014-01-10 14:18:30 -0800

[diff] [blame]

18735

18736

Igor Murashkin

2014-02-06 15:35:37 -0800

[diff] [blame]

18737

18738

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

18739

<td class="entry_name

18740

" rowspan="5">

Igor Murashkin

2014-02-06 15:35:37 -0800

[diff] [blame]

18741

android.request.availableCapabilities

18742

</td>

18743

18744

byte

Zhijun He

c593aee

2014-05-29 13:31:49 -0700

[diff] [blame]

18745

x

Igor Murashkin

2014-02-06 15:35:37 -0800

[diff] [blame]

18746

Zhijun He

c593aee

2014-05-29 13:31:49 -0700

[diff] [blame]

n

Igor Murashkin

2014-02-06 15:35:37 -0800

[diff] [blame]

18750

[public]

18751

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

18752

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

18753

[legacy]

18754

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

18755

18756

Igor Murashkin

2014-02-06 15:35:37 -0800

[diff] [blame]

18757

18758

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

18759

BACKWARD_COMPATIBLE (v3.2)

Igor Murashkin

2014-02-06 15:35:37 -0800

[diff] [blame]

18760

The minimal set of capabilities that every camera

18761

device (regardless of <a href="#static_android.info.supportedHardwareLevel">android.info.supportedHardwareLevel</a>)

Eino-Ville Talvala

2014-07-09 09:34:05 -0700

[diff] [blame]

18762

supports.

Eino-Ville Talvala

2015-04-13 17:28:29 -0700

[diff] [blame]

18763

This capability is listed by all normal devices, and

Eino-Ville Talvala

2014-07-09 09:34:05 -0700

[diff] [blame]

18764

indicates that the camera device has a feature set

18765

that's comparable to the baseline requirements for the

Eino-Ville Talvala

2015-04-13 17:28:29 -0700

[diff] [blame]

18766

older android.hardware.Camera API.

18767

Devices with the DEPTH_OUTPUT capability might not list this

18768

capability, indicating that they support only depth measurement,

18769

not standard color output.

Igor Murashkin

2014-02-06 15:35:37 -0800

[diff] [blame]

18770

</li>

18771

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

18772

MANUAL_SENSOR (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

18773

[optional]

Igor Murashkin

2014-02-06 15:35:37 -0800

[diff] [blame]

18774

The camera device can be manually controlled (3A algorithms such

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

18775

as auto-exposure, and auto-focus can be bypassed).

Zhijun He

2014-05-21 17:51:05 -0700

[diff] [blame]

18776

The camera device supports basic manual control of the sensor image

18777

acquisition related stages. This means the following controls are

18778

guaranteed to be supported:

Igor Murashkin

2014-02-06 15:35:37 -0800

[diff] [blame]

18779

<ul>

Zhijun He

2014-05-21 17:51:05 -0700

[diff] [blame]

18780

<li>Manual frame duration control<ul>

18781

<li><a href="#controls_android.sensor.frameDuration">android.sensor.frameDuration</a></li>

18782

<li><a href="#static_android.sensor.info.maxFrameDuration">android.sensor.info.maxFrameDuration</a></li>

Zhijun He

2014-05-21 17:51:05 -0700

[diff] [blame]

18783

</ul>

18784

</li>

Igor Murashkin

2014-02-06 15:35:37 -0800

[diff] [blame]

18785

<li>Manual exposure control<ul>

18786

<li><a href="#controls_android.sensor.exposureTime">android.sensor.exposureTime</a></li>

18787

<li><a href="#static_android.sensor.info.exposureTimeRange">android.sensor.info.exposureTimeRange</a></li>

18788

</ul>

18789

</li>

18790

<li>Manual sensitivity control<ul>

18791

<li><a href="#controls_android.sensor.sensitivity">android.sensor.sensitivity</a></li>

18792

<li><a href="#static_android.sensor.info.sensitivityRange">android.sensor.info.sensitivityRange</a></li>

Igor Murashkin

2014-02-06 15:35:37 -0800

[diff] [blame]

18793

</ul>

18794

</li>

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

18795

<li>Manual lens control (if the lens is adjustable)<ul>

Igor Murashkin

2014-02-06 15:35:37 -0800

[diff] [blame]

18796

<li>android.lens.*</li>

18797

</ul>

18798

</li>

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

18799

<li>Manual flash control (if a flash unit is present)<ul>

Igor Murashkin

2014-02-06 15:35:37 -0800

[diff] [blame]

18800

<li>android.flash.*</li>

18801

</ul>

18802

</li>

18803

<li>Manual black level locking<ul>

18804

<li><a href="#controls_android.blackLevel.lock">android.blackLevel.lock</a></li>

18805

</ul>

18806

</li>

Yin-Chia Yeh

2015-04-02 14:31:53 -0700

[diff] [blame]

18807

<li>Auto exposure lock<ul>

18808

<li><a href="#controls_android.control.aeLock">android.control.aeLock</a></li>

18809

</ul>

18810

</li>

Igor Murashkin

2014-02-06 15:35:37 -0800

[diff] [blame]

18811

</ul>

18812

If any of the above 3A algorithms are enabled, then the camera

18813

device will accurately report the values applied by 3A in the

Zhijun He

2014-05-21 17:51:05 -0700

[diff] [blame]

18814

result.

18815

A given camera device may also support additional manual sensor controls,

Ruben Brunk

6285c4d

2014-06-18 17:13:19 -0700

[diff] [blame]

18816

but this capability only covers the above list of controls.

18817

If this is supported, <a href="#static_android.scaler.streamConfigurationMap">android.scaler.streamConfigurationMap</a> will

18818

additionally return a min frame duration that is greater than

Shuzhen Wang

2018-11-19 12:15:18 -0800

[diff] [blame]

18819

zero for each supported size-format combination.

18820

For camera devices with LOGICAL_MULTI_CAMERA capability, when the underlying active

18821

physical camera switches, exposureTime, sensitivity, and lens properties may change

18822

even if AE/AF is locked. However, the overall auto exposure and auto focus experience

18823

for users will be consistent. Refer to LOGICAL_MULTI_CAMERA capability for details.

Igor Murashkin

2014-02-06 15:35:37 -0800

[diff] [blame]

18824

</li>

18825

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

18826

MANUAL_POST_PROCESSING (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

18827

[optional]

Zhijun He

2014-05-21 17:51:05 -0700

[diff] [blame]

18828

The camera device post-processing stages can be manually controlled.

18829

The camera device supports basic manual control of the image post-processing

18830

stages. This means the following controls are guaranteed to be supported:

Igor Murashkin

2014-02-06 15:35:37 -0800

[diff] [blame]

18831

<ul>

Yin-Chia Yeh

2015-02-05 13:19:21 -0800

[diff] [blame]

18832

<li>

18833

Manual tonemap control

18834

<ul>

Yin-Chia Yeh

2014-05-27 09:48:07 -0700

[diff] [blame]

18835

<li><a href="#controls_android.tonemap.curve">android.tonemap.curve</a></li>

Igor Murashkin

2014-02-06 15:35:37 -0800

[diff] [blame]

18836

<li><a href="#controls_android.tonemap.mode">android.tonemap.mode</a></li>

18837

<li><a href="#static_android.tonemap.maxCurvePoints">android.tonemap.maxCurvePoints</a></li>

Yin-Chia Yeh

2015-05-05 23:49:07 -0700

[diff] [blame]

18838

<li><a href="#controls_android.tonemap.gamma">android.tonemap.gamma</a></li>

18839

<li><a href="#controls_android.tonemap.presetCurve">android.tonemap.presetCurve</a></li>

Igor Murashkin

2014-02-06 15:35:37 -0800

[diff] [blame]

18840

</ul>

18841

</li>

Yin-Chia Yeh

2015-02-05 13:19:21 -0800

[diff] [blame]

18842

<li>

18843

Manual white balance control

18844

<ul>

Igor Murashkin

2014-02-06 15:35:37 -0800

[diff] [blame]

18845

<li><a href="#controls_android.colorCorrection.transform">android.colorCorrection.transform</a></li>

18846

<li><a href="#controls_android.colorCorrection.gains">android.colorCorrection.gains</a></li>

18847

</ul>

18848

</li>

Zhijun He

df726fa

2014-06-25 08:35:53 -0700

[diff] [blame]

18849

<li>Manual lens shading map control<ul>

18850

<li><a href="#controls_android.shading.mode">android.shading.mode</a></li>

18851

<li><a href="#controls_android.statistics.lensShadingMapMode">android.statistics.lensShadingMapMode</a></li>

Igor Murashkin

2014-02-06 15:35:37 -0800

[diff] [blame]

18852

<li><a href="#dynamic_android.statistics.lensShadingMap">android.statistics.lensShadingMap</a></li>

18853

<li><a href="#static_android.lens.info.shadingMapSize">android.lens.info.shadingMapSize</a></li>

18854

</ul>

18855

</li>

Zhijun He

2014-07-01 18:27:42 -0700

[diff] [blame]

18856

<li>Manual aberration correction control (if aberration correction is supported)<ul>

Zhijun He

2014-08-18 10:55:33 -0700

[diff] [blame]

18857

<li><a href="#controls_android.colorCorrection.aberrationMode">android.colorCorrection.aberrationMode</a></li>

18858

<li><a href="#static_android.colorCorrection.availableAberrationModes">android.colorCorrection.availableAberrationModes</a></li>

Zhijun He

2014-07-01 18:27:42 -0700

[diff] [blame]

18859

</ul>

18860

</li>

Yin-Chia Yeh

2015-04-02 14:31:53 -0700

[diff] [blame]

18861

<li>Auto white balance lock<ul>

18862

<li><a href="#controls_android.control.awbLock">android.control.awbLock</a></li>

18863

</ul>

18864

</li>

Igor Murashkin

2014-02-06 15:35:37 -0800

[diff] [blame]

18865

</ul>

18866

If auto white balance is enabled, then the camera device

18867

will accurately report the values applied by AWB in the result.

Zhijun He

2014-05-21 17:51:05 -0700

[diff] [blame]

18868

A given camera device may also support additional post-processing

Shuzhen Wang

2018-11-19 12:15:18 -0800

[diff] [blame]

18869

controls, but this capability only covers the above list of controls.

18870

For camera devices with LOGICAL_MULTI_CAMERA capability, when underlying active

18871

physical camera switches, tonemap, white balance, and shading map may change even if

18872

awb is locked. However, the overall post-processing experience for users will be

18873

consistent. Refer to LOGICAL_MULTI_CAMERA capability for details.

Igor Murashkin

2014-02-06 15:35:37 -0800

[diff] [blame]

18874

</li>

18875

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

18876

RAW (v3.2)

Eino-Ville Talvala

2014-07-09 09:34:05 -0700

[diff] [blame]

18877

[optional]

Eino-Ville Talvala

2014-07-15 10:43:01 -0700

[diff] [blame]

18878

The camera device supports outputting RAW buffers and

18879

metadata for interpreting them.

18880

Devices supporting the RAW capability allow both for

18881

saving DNG files, and for direct application processing of

18882

raw sensor images.

Eino-Ville Talvala

2014-07-09 09:34:05 -0700

[diff] [blame]

18883

<ul>

18884

<li>RAW_SENSOR is supported as an output format.</li>

18885

<li>The maximum available resolution for RAW_SENSOR streams

18886

will match either the value in

18887

<a href="#static_android.sensor.info.pixelArraySize">android.sensor.info.pixelArraySize</a> or

Eino-Ville Talvala

0429269

2015-11-08 18:58:27 -0800

[diff] [blame]

18888

<a href="#static_android.sensor.info.preCorrectionActiveArraySize">android.sensor.info.preCorrectionActiveArraySize</a>.</li>

Eino-Ville Talvala

2014-07-09 09:34:05 -0700

[diff] [blame]

18889

<li>All DNG-related optional metadata entries are provided

18890

by the camera device.</li>

18891

</ul>

18892

</li>

18893

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

18894

PRIVATE_REPROCESSING (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

18895

[optional]

Eino-Ville Talvala

2021-05-27 14:43:59 -0700

[diff] [blame]

18896

[java_public]

Zhijun He

2015-01-15 18:17:24 -0800

[diff] [blame]

18897

The camera device supports the Zero Shutter Lag reprocessing use case.

Igor Murashkin

2014-02-06 15:35:37 -0800

[diff] [blame]

18898

<ul>

Zhijun He

2015-01-15 18:17:24 -0800

[diff] [blame]

18899

<li>One input stream is supported, that is, <code><a href="#static_android.request.maxNumInputStreams">android.request.maxNumInputStreams</a> == 1</code>.</li>

Eino-Ville Talvala

2015-04-16 13:49:52 -0700

[diff] [blame]

18900

<li><a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#PRIVATE">ImageFormat#PRIVATE</a> is supported as an output/input format,

18901

that is, <a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#PRIVATE">ImageFormat#PRIVATE</a> is included in the lists of

18902

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>.</li>

18903

<li><a href="https://developer.android.com/reference/android/hardware/camera2/params/StreamConfigurationMap.html#getValidOutputFormatsForInput">StreamConfigurationMap#getValidOutputFormatsForInput</a>

Jayant Chowdhary

2020-11-09 09:08:31 -0800

[diff] [blame]

18904

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>.</li>

Eino-Ville Talvala

2015-04-16 13:49:52 -0700

[diff] [blame]

18905

<li>Each size returned by <a href="https://developer.android.com/reference/android/hardware/camera2/params/StreamConfigurationMap.html#getInputSizes">getInputSizes(ImageFormat.PRIVATE)</a> is also included in <a href="https://developer.android.com/reference/android/hardware/camera2/params/StreamConfigurationMap.html#getOutputSizes">getOutputSizes(ImageFormat.PRIVATE)</a></li>

18906

<li>Using <a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#PRIVATE">ImageFormat#PRIVATE</a> does not cause a frame rate drop

18907

relative to the sensor's maximum capture rate (at that resolution).</li>

18908

<li><a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#PRIVATE">ImageFormat#PRIVATE</a> will be reprocessable into both

18909

<a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#YUV_420_888">ImageFormat#YUV_420_888</a> and

18910

<a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#JPEG">ImageFormat#JPEG</a> formats.</li>

Shuzhen Wang

2018-09-27 15:50:01 -0700

[diff] [blame]

18911

<li>For a MONOCHROME camera supporting Y8 format, <a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#PRIVATE">ImageFormat#PRIVATE</a> will be reprocessable into

18912

<a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#Y8">ImageFormat#Y8</a>.</li>

Chien-Yu Chen

2015-05-12 15:13:00 -0700

[diff] [blame]

18913

<li>The maximum available resolution for PRIVATE streams

Igor Murashkin

2014-02-06 15:35:37 -0800

[diff] [blame]

18914

(both input/output) will match the maximum available

18915

resolution of JPEG streams.</li>

Zhijun He

2015-04-24 17:59:50 -0700

[diff] [blame]

18916

<li>Static metadata <a href="#static_android.reprocess.maxCaptureStall">android.reprocess.maxCaptureStall</a>.</li>

Zhijun He

2015-01-15 18:17:24 -0800

[diff] [blame]

18917

<li>Only below controls are effective for reprocessing requests and

18918

will be present in capture results, other controls in reprocess

18919

requests will be ignored by the camera device.<ul>

18920

<li>android.jpeg.*</li>

18921

<li><a href="#controls_android.noiseReduction.mode">android.noiseReduction.mode</a></li>

18922

<li><a href="#controls_android.edge.mode">android.edge.mode</a></li>

18923

</ul>

18924

</li>

Eino-Ville Talvala

2015-07-07 10:40:59 -0700

[diff] [blame]

18925

<li><a href="#static_android.noiseReduction.availableNoiseReductionModes">android.noiseReduction.availableNoiseReductionModes</a> and

18926

<a href="#static_android.edge.availableEdgeModes">android.edge.availableEdgeModes</a> will both list ZERO_SHUTTER_LAG as a supported mode.</li>

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

18927

</ul>

Igor Murashkin

2014-02-06 15:35:37 -0800

[diff] [blame]

18928

</li>

Ruben Brunk

a43690a

2014-11-11 11:47:03 -0800

[diff] [blame]

18929

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

18930

READ_SENSOR_SETTINGS (v3.2)

Ruben Brunk

a43690a

2014-11-11 11:47:03 -0800

[diff] [blame]

18931

[optional]

18932

The camera device supports accurately reporting the sensor settings for many of

18933

the sensor controls while the built-in 3A algorithm is running. This allows

18934

reporting of sensor settings even when these settings cannot be manually changed.

18935

The values reported for the following controls are guaranteed to be available

18936

in the CaptureResult, including when 3A is enabled:

18937

<ul>

18938

<li>Exposure control<ul>

18939

<li><a href="#controls_android.sensor.exposureTime">android.sensor.exposureTime</a></li>

18940

</ul>

18941

</li>

18942

<li>Sensitivity control<ul>

18943

<li><a href="#controls_android.sensor.sensitivity">android.sensor.sensitivity</a></li>

18944

</ul>

18945

</li>

18946

<li>Lens controls (if the lens is adjustable)<ul>

18947

<li><a href="#controls_android.lens.focusDistance">android.lens.focusDistance</a></li>

18948

<li><a href="#controls_android.lens.aperture">android.lens.aperture</a></li>

</ul>

</li>

</ul>

This capability is a subset of the MANUAL_SENSOR control capability, and will

18953

always be included if the MANUAL_SENSOR capability is available.

18954

</li>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

18955

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

18956

BURST_CAPTURE (v3.2)

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

18957

[optional]

Eino-Ville Talvala

a92c2b7

2015-06-17 11:32:55 -0700

[diff] [blame]

18958

The camera device supports capturing high-resolution images at >= 20 frames per

Shuzhen Wang

77acdde

2019-04-09 22:11:40 -0700

[diff] [blame]

18959

second, in at least the uncompressed YUV format, when post-processing settings are

18960

set to FAST. Additionally, all image resolutions less than 24 megapixels can be

18961

captured at >= 10 frames per second. Here, 'high resolution' means at least 8

18962

megapixels, or the maximum resolution of the device, whichever is smaller.

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

18963

</li>

Zhijun He

2015-01-15 18:17:24 -0800

[diff] [blame]

18964

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

18965

YUV_REPROCESSING (v3.2)

Zhijun He

2015-01-15 18:17:24 -0800

[diff] [blame]

18966

[optional]

Eino-Ville Talvala

2021-05-27 14:43:59 -0700

[diff] [blame]

18967

[java_public]

Chien-Yu Chen

9e48beb

2015-03-18 18:33:17 -0700

[diff] [blame]

18968

The camera device supports the YUV_420_888 reprocessing use case, similar as

Chien-Yu Chen

2015-05-12 15:13:00 -0700

[diff] [blame]

18969

PRIVATE_REPROCESSING, This capability requires the camera device to support the

Zhijun He

2015-01-15 18:17:24 -0800

[diff] [blame]

18970

following:

18971

<ul>

18972

<li>One input stream is supported, that is, <code><a href="#static_android.request.maxNumInputStreams">android.request.maxNumInputStreams</a> == 1</code>.</li>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

18973

<li><a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#YUV_420_888">ImageFormat#YUV_420_888</a> is supported as an output/input

18974

format, that is, YUV_420_888 is included in the lists of 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>.</li>

Eino-Ville Talvala

2015-04-16 13:49:52 -0700

[diff] [blame]

18975

<li><a href="https://developer.android.com/reference/android/hardware/camera2/params/StreamConfigurationMap.html#getValidOutputFormatsForInput">StreamConfigurationMap#getValidOutputFormatsForInput</a>

18976

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>.</li>

18977

<li>Each size returned by <a href="https://developer.android.com/reference/android/hardware/camera2/params/StreamConfigurationMap.html#getInputSizes">getInputSizes(YUV_420_888)</a> is also included in <a href="https://developer.android.com/reference/android/hardware/camera2/params/StreamConfigurationMap.html#getOutputSizes">getOutputSizes(YUV_420_888)</a></li>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

18978

<li>Using <a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#YUV_420_888">ImageFormat#YUV_420_888</a> does not cause a frame rate

18979

drop relative to the sensor's maximum capture rate (at that resolution).</li>

Eino-Ville Talvala

2015-04-16 13:49:52 -0700

[diff] [blame]

18980

<li><a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#YUV_420_888">ImageFormat#YUV_420_888</a> will be reprocessable into both

18981

<a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#YUV_420_888">ImageFormat#YUV_420_888</a> and <a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#JPEG">ImageFormat#JPEG</a> formats.</li>

18982

<li>The maximum available resolution for <a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#YUV_420_888">ImageFormat#YUV_420_888</a> streams (both input/output) will match the

18983

maximum available resolution of <a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#JPEG">ImageFormat#JPEG</a> streams.</li>

Shuzhen Wang

2018-09-27 15:50:01 -0700

[diff] [blame]

18984

<li>For a MONOCHROME camera with Y8 format support, all the requirements mentioned

18985

above for YUV_420_888 apply for Y8 format as well.</li>

Zhijun He

2015-04-24 17:59:50 -0700

[diff] [blame]

18986

<li>Static metadata <a href="#static_android.reprocess.maxCaptureStall">android.reprocess.maxCaptureStall</a>.</li>

Eino-Ville Talvala

2015-04-16 13:49:52 -0700

[diff] [blame]

18987

<li>Only the below controls are effective for reprocessing requests and will be present

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

18988

in capture results. The reprocess requests are from the original capture results

18989

that are associated with the intermediate <a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#YUV_420_888">ImageFormat#YUV_420_888</a> output buffers. All other controls in the

18990

reprocess requests will be ignored by the camera device.<ul>

Zhijun He

2015-01-15 18:17:24 -0800

[diff] [blame]

18991

<li>android.jpeg.*</li>

18992

<li><a href="#controls_android.noiseReduction.mode">android.noiseReduction.mode</a></li>

18993

<li><a href="#controls_android.edge.mode">android.edge.mode</a></li>

18994

<li><a href="#controls_android.reprocess.effectiveExposureFactor">android.reprocess.effectiveExposureFactor</a></li>

18995

</ul>

18996

</li>

Eino-Ville Talvala

2015-07-07 10:40:59 -0700

[diff] [blame]

18997

<li><a href="#static_android.noiseReduction.availableNoiseReductionModes">android.noiseReduction.availableNoiseReductionModes</a> and

18998

<a href="#static_android.edge.availableEdgeModes">android.edge.availableEdgeModes</a> will both list ZERO_SHUTTER_LAG as a supported mode.</li>

Zhijun He

2015-01-15 18:17:24 -0800

[diff] [blame]

18999

</ul>

19000

</li>

Eino-Ville Talvala

2015-04-13 17:28:29 -0700

[diff] [blame]

19001

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

19002

DEPTH_OUTPUT (v3.2)

Eino-Ville Talvala

2015-04-13 17:28:29 -0700

[diff] [blame]

19003

[optional]

19004

The camera device can produce depth measurements from its field of view.

19005

This capability requires the camera device to support the following:

19006

<ul>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

19007

<li><a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#DEPTH16">ImageFormat#DEPTH16</a> is supported as

19008

an output format.</li>

19009

<li><a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#DEPTH_POINT_CLOUD">ImageFormat#DEPTH_POINT_CLOUD</a> is

19010

optionally supported as an output format.</li>

19011

<li>This camera device, and all camera devices with the same <a href="#static_android.lens.facing">android.lens.facing</a>, will

19012

list the following calibration metadata entries in both <a href="https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics.html">CameraCharacteristics</a>

19013

and <a href="https://developer.android.com/reference/android/hardware/camera2/CaptureResult.html">CaptureResult</a>:<ul>

Eino-Ville Talvala

2015-04-13 17:28:29 -0700

[diff] [blame]

19014

<li><a href="#static_android.lens.poseTranslation">android.lens.poseTranslation</a></li>

19015

<li><a href="#static_android.lens.poseRotation">android.lens.poseRotation</a></li>

Eino-Ville Talvala

2015-08-19 16:09:46 -0700

[diff] [blame]

19016

<li><a href="#static_android.lens.intrinsicCalibration">android.lens.intrinsicCalibration</a></li>

Eino-Ville Talvala

2018-03-13 19:10:23 -0700

[diff] [blame]

19017

<li><a href="#static_android.lens.distortion">android.lens.distortion</a></li>

Eino-Ville Talvala

2015-04-13 17:28:29 -0700

[diff] [blame]

19018

</ul>

19019

</li>

19020

<li>The <a href="#static_android.depth.depthIsExclusive">android.depth.depthIsExclusive</a> entry is listed by this device.</li>

Eino-Ville Talvala

2017-12-07 13:12:11 -0800

[diff] [blame]

19021

<li>As of Android P, the <a href="#static_android.lens.poseReference">android.lens.poseReference</a> entry is listed by this device.</li>

Eino-Ville Talvala

2015-04-13 17:28:29 -0700

[diff] [blame]

19022

<li>A LIMITED camera with only the DEPTH_OUTPUT capability does not have to support

Shuzhen Wang

2018-09-27 15:50:01 -0700

[diff] [blame]

19023

normal YUV_420_888, Y8, JPEG, and PRIV-format outputs. It only has to support the

19024

DEPTH16 format.</li>

Eino-Ville Talvala

2015-04-13 17:28:29 -0700

[diff] [blame]

19025

</ul>

19026

Generally, depth output operates at a slower frame rate than standard color capture,

19027

so the DEPTH16 and DEPTH_POINT_CLOUD formats will commonly have a stall duration that

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

19028

should be accounted for (see <a href="https://developer.android.com/reference/android/hardware/camera2/params/StreamConfigurationMap.html#getOutputStallDuration">StreamConfigurationMap#getOutputStallDuration</a>).

Eino-Ville Talvala

2015-04-16 13:49:52 -0700

[diff] [blame]

19029

On a device that supports both depth and color-based output, to enable smooth preview,

19030

using a repeating burst is recommended, where a depth-output target is only included

19031

once every N frames, where N is the ratio between preview output rate and depth output

Eino-Ville Talvala

2015-04-13 17:28:29 -0700

[diff] [blame]

19032

rate, including depth stall time.

19033

</li>

Zhijun He

2015-05-22 17:04:15 -0700

[diff] [blame]

19034

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

19035

CONSTRAINED_HIGH_SPEED_VIDEO (v3.2)

Zhijun He

2015-05-22 17:04:15 -0700

[diff] [blame]

19036

[optional]

Eino-Ville Talvala

2021-05-27 14:43:59 -0700

[diff] [blame]

19037

[java_public]

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

19038

The device supports constrained high speed video recording (frame rate >=120fps) use

19039

case. The camera device will support high speed capture session created by <a href="https://developer.android.com/reference/android/hardware/camera2/CameraDevice.html#createConstrainedHighSpeedCaptureSession">CameraDevice#createConstrainedHighSpeedCaptureSession</a>, which

19040

only accepts high speed request lists created by <a href="https://developer.android.com/reference/android/hardware/camera2/CameraConstrainedHighSpeedCaptureSession.html#createHighSpeedRequestList">CameraConstrainedHighSpeedCaptureSession#createHighSpeedRequestList</a>.

19041

A camera device can still support high speed video streaming by advertising the high

19042

speed FPS ranges in <a href="#static_android.control.aeAvailableTargetFpsRanges">android.control.aeAvailableTargetFpsRanges</a>. For this case, all

19043

normal capture request per frame control and synchronization requirements will apply

19044

to the high speed fps ranges, the same as all other fps ranges. This capability

19045

describes the capability of a specialized operating mode with many limitations (see

19046

below), which is only targeted at high speed video recording.

19047

The supported high speed video sizes and fps ranges are specified in <a href="https://developer.android.com/reference/android/hardware/camera2/params/StreamConfigurationMap.html#getHighSpeedVideoFpsRanges">StreamConfigurationMap#getHighSpeedVideoFpsRanges</a>.

19048

To get desired output frame rates, the application is only allowed to select video

19049

size and FPS range combinations provided by <a href="https://developer.android.com/reference/android/hardware/camera2/params/StreamConfigurationMap.html#getHighSpeedVideoSizes">StreamConfigurationMap#getHighSpeedVideoSizes</a>. The

19050

fps range can be controlled via <a href="#controls_android.control.aeTargetFpsRange">android.control.aeTargetFpsRange</a>.

Zhijun He

2015-05-22 17:04:15 -0700

[diff] [blame]

19051

In this capability, the camera device will override aeMode, awbMode, and afMode to

Zhijun He

2015-06-16 19:44:18 -0700

[diff] [blame]

19052

ON, AUTO, and CONTINUOUS_VIDEO, respectively. All post-processing block mode

Zhijun He

2015-05-22 17:04:15 -0700

[diff] [blame]

19053

controls will be overridden to be FAST. Therefore, no manual control of capture

19054

and post-processing parameters is possible. All other controls operate the

19055

same as when <a href="#controls_android.control.mode">android.control.mode</a> == AUTO. This means that all other

19056

android.control.* fields continue to work, such as

19057

<ul>

19058

<li><a href="#controls_android.control.aeTargetFpsRange">android.control.aeTargetFpsRange</a></li>

19059

<li><a href="#controls_android.control.aeExposureCompensation">android.control.aeExposureCompensation</a></li>

19060

<li><a href="#controls_android.control.aeLock">android.control.aeLock</a></li>

19061

<li><a href="#controls_android.control.awbLock">android.control.awbLock</a></li>

19062

<li><a href="#controls_android.control.effectMode">android.control.effectMode</a></li>

19063

<li><a href="#controls_android.control.aeRegions">android.control.aeRegions</a></li>

19064

<li><a href="#controls_android.control.afRegions">android.control.afRegions</a></li>

19065

<li><a href="#controls_android.control.awbRegions">android.control.awbRegions</a></li>

19066

<li><a href="#controls_android.control.afTrigger">android.control.afTrigger</a></li>

19067

<li><a href="#controls_android.control.aePrecaptureTrigger">android.control.aePrecaptureTrigger</a></li>

Shuzhen Wang

2019-11-07 15:59:22 -0800

[diff] [blame]

19068

<li><a href="#controls_android.control.zoomRatio">android.control.zoomRatio</a></li>

Zhijun He

2015-05-22 17:04:15 -0700

[diff] [blame]

19069

</ul>

19070

Outside of android.control.*, the following controls will work:

19071

<ul>

19072

<li><a href="#controls_android.flash.mode">android.flash.mode</a> (TORCH mode only, automatic flash for still capture will not

19073

work since aeMode is ON)</li>

19074

<li><a href="#controls_android.lens.opticalStabilizationMode">android.lens.opticalStabilizationMode</a> (if it is supported)</li>

19075

<li><a href="#controls_android.scaler.cropRegion">android.scaler.cropRegion</a></li>

19076

<li><a href="#controls_android.statistics.faceDetectMode">android.statistics.faceDetectMode</a> (if it is supported)</li>

19077

</ul>

19078

For high speed recording use case, the actual maximum supported frame rate may

19079

be lower than what camera can output, depending on the destination Surfaces for

19080

the image data. For example, if the destination surface is from video encoder,

19081

the application need check if the video encoder is capable of supporting the

19082

high frame rate for a given video size, or it will end up with lower recording

19083

frame rate. If the destination surface is from preview window, the actual preview frame

19084

rate will be bounded by the screen refresh rate.

19085

The camera device will only support up to 2 high speed simultaneous output surfaces

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

19086

(preview and recording surfaces) in this mode. Above controls will be effective only

19087

if all of below conditions are true:

Zhijun He

2015-05-22 17:04:15 -0700

[diff] [blame]

19088

<ul>

19089

<li>The application creates a camera capture session with no more than 2 surfaces via

19090

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraDevice.html#createConstrainedHighSpeedCaptureSession">CameraDevice#createConstrainedHighSpeedCaptureSession</a>. The

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

19091

targeted surfaces must be preview surface (either from <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 recording

19092

surface(either from <a href="https://developer.android.com/reference/android/media/MediaRecorder.html#getSurface">MediaRecorder#getSurface</a> or <a href="https://developer.android.com/reference/android/media/MediaCodec.html#createInputSurface">MediaCodec#createInputSurface</a>).</li>

Zhijun He

2015-05-22 17:04:15 -0700

[diff] [blame]

19093

<li>The stream sizes are selected from the sizes reported by

19094

<a href="https://developer.android.com/reference/android/hardware/camera2/params/StreamConfigurationMap.html#getHighSpeedVideoSizes">StreamConfigurationMap#getHighSpeedVideoSizes</a>.</li>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

19095

<li>The FPS ranges are selected from <a href="https://developer.android.com/reference/android/hardware/camera2/params/StreamConfigurationMap.html#getHighSpeedVideoFpsRanges">StreamConfigurationMap#getHighSpeedVideoFpsRanges</a>.</li>

Zhijun He

2015-05-22 17:04:15 -0700

[diff] [blame]

19096

</ul>

Shuzhen Wang

2022-05-03 11:01:26 -0700

[diff] [blame]

19097

When above conditions are NOT satisfied,

Zhijun He

2015-05-22 17:04:15 -0700

[diff] [blame]

19098

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraDevice.html#createConstrainedHighSpeedCaptureSession">CameraDevice#createConstrainedHighSpeedCaptureSession</a>

Eino-Ville Talvala

2015-06-30 13:32:09 -0700

[diff] [blame]

19099

will fail.

Zhijun He

2015-05-22 17:04:15 -0700

[diff] [blame]

19100

Switching to a FPS range that has different maximum FPS may trigger some camera device

19101

reconfigurations, which may introduce extra latency. It is recommended that

19102

the application avoids unnecessary maximum target FPS changes as much as possible

19103

during high speed streaming.

19104

</li>

Eino-Ville Talvala

2017-12-07 13:12:11 -0800

[diff] [blame]

19105

<li>

19106

MOTION_TRACKING (v3.3)

19107

[optional]

Eino-Ville Talvala

baf8047

2018-02-05 16:26:26 -0800

[diff] [blame]

19108

The camera device supports the MOTION_TRACKING value for

19109

<a href="#controls_android.control.captureIntent">android.control.captureIntent</a>, which limits maximum exposure time to 20 ms.

19110

This limits the motion blur of capture images, resulting in better image tracking

19111

results for use cases such as image stabilization or augmented reality.

Eino-Ville Talvala

2017-12-07 13:12:11 -0800

[diff] [blame]

19112

</li>

Shuzhen Wang

2017-11-30 12:03:37 -0800

[diff] [blame]

19113

<li>

19114

LOGICAL_MULTI_CAMERA (v3.3)

19115

[optional]

Shuzhen Wang

2019-03-07 08:38:51 -0800

[diff] [blame]

19116

The camera device is a logical camera backed by two or more physical cameras.

19117

In API level 28, the physical cameras must also be exposed to the application via

19118

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraManager.html#getCameraIdList">CameraManager#getCameraIdList</a>.

Shuzhen Wang

0a8b07e

2020-01-20 10:27:02 -0800

[diff] [blame]

19119

Starting from API level 29:

19120

<ul>

19121

<li>Some or all physical cameras may not be independently exposed to the application,

19122

in which case the physical camera IDs will not be available in

19123

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraManager.html#getCameraIdList">CameraManager#getCameraIdList</a>. But the

Shuzhen Wang

2019-03-07 08:38:51 -0800

[diff] [blame]

19124

application can still query the physical cameras' characteristics by calling

Shuzhen Wang

0a8b07e

2020-01-20 10:27:02 -0800

[diff] [blame]

19125

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraManager.html#getCameraCharacteristics">CameraManager#getCameraCharacteristics</a>.</li>

19126

<li>If a physical camera is hidden from camera ID list, the mandatory stream

19127

combinations for that physical camera must be supported through the logical camera

19128

using physical streams. One exception is that in API level 30, a physical camera

19129

may become unavailable via

19130

<a href="https://developer.android.com/reference/CameraManager/AvailabilityCallback.html#onPhysicalCameraUnavailable">AvailabilityCallback#onPhysicalCameraUnavailable</a>

19131

callback.</li>

19132

</ul>

Shuzhen Wang

2019-03-07 08:38:51 -0800

[diff] [blame]

19133

Combinations of logical and physical streams, or physical streams from different

19134

physical cameras are not guaranteed. However, if the camera device supports

19135

<a href="https://developer.android.com/reference/CameraDevice.html#isSessionConfigurationSupported">CameraDevice#isSessionConfigurationSupported</a>,

19136

application must be able to query whether a stream combination involving physical

19137

streams is supported by calling

19138

<a href="https://developer.android.com/reference/CameraDevice.html#isSessionConfigurationSupported">CameraDevice#isSessionConfigurationSupported</a>.

Shuzhen Wang

2018-05-23 09:07:11 -0700

[diff] [blame]

19139

Camera application shouldn't assume that there are at most 1 rear camera and 1 front

19140

camera in the system. For an application that switches between front and back cameras,

19141

the recommendation is to switch between the first rear camera and the first front

19142

camera in the list of supported camera devices.

Shuzhen Wang

2017-11-30 12:03:37 -0800

[diff] [blame]

19143

This capability requires the camera device to support the following:

19144

<ul>

Shuzhen Wang

7c30d45

2018-08-15 13:56:29 -0700

[diff] [blame]

19145

<li>The IDs of underlying physical cameras are returned via

19146

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics.html#getPhysicalCameraIds">CameraCharacteristics#getPhysicalCameraIds</a>.</li>

19147

<li>This camera device must list static metadata

19148

<a href="#static_android.logicalMultiCamera.sensorSyncType">android.logicalMultiCamera.sensorSyncType</a> in

19149

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics.html">CameraCharacteristics</a>.</li>

Shuzhen Wang

2017-11-30 12:03:37 -0800

[diff] [blame]

19150

<li>The underlying physical cameras' static metadata must list the following entries,

19151

so that the application can correlate pixels from the physical streams:<ul>

19152

<li><a href="#static_android.lens.poseReference">android.lens.poseReference</a></li>

19153

<li><a href="#static_android.lens.poseRotation">android.lens.poseRotation</a></li>

19154

<li><a href="#static_android.lens.poseTranslation">android.lens.poseTranslation</a></li>

19155

<li><a href="#static_android.lens.intrinsicCalibration">android.lens.intrinsicCalibration</a></li>

Eino-Ville Talvala

2018-03-13 19:10:23 -0700

[diff] [blame]

19156

<li><a href="#static_android.lens.distortion">android.lens.distortion</a></li>

Shuzhen Wang

2017-11-30 12:03:37 -0800

[diff] [blame]

19157

</ul>

19158

</li>

Shuzhen Wang

d24b970

2018-01-25 13:23:03 -0800

[diff] [blame]

19159

<li>The SENSOR_INFO_TIMESTAMP_SOURCE of the logical device and physical devices must be

19160

the same.</li>

Shuzhen Wang

2018-11-19 12:15:18 -0800

[diff] [blame]

19161

<li>The logical camera must be LIMITED or higher device.</li>

Shuzhen Wang

2017-11-30 12:03:37 -0800

[diff] [blame]

19162

</ul>

Shuzhen Wang

2018-11-19 12:15:18 -0800

[diff] [blame]

19163

A logical camera device's dynamic metadata may contain

19164

<a href="#dynamic_android.logicalMultiCamera.activePhysicalId">android.logicalMultiCamera.activePhysicalId</a> to notify the application of the current

19165

active physical camera Id. An active physical camera is the physical camera from which

19166

the logical camera's main image data outputs (YUV or RAW) and metadata come from.

19167

In addition, this serves as an indication which physical camera is used to output to

19168

a RAW stream, or in case only physical cameras support RAW, which physical RAW stream

19169

the application should request.

19170

Logical camera's static metadata tags below describe the default active physical

19171

camera. An active physical camera is default if it's used when application directly

19172

uses requests built from a template. All templates will default to the same active

19173

physical camera.

19174

<ul>

19175

<li><a href="#static_android.sensor.info.sensitivityRange">android.sensor.info.sensitivityRange</a></li>

19176

<li><a href="#static_android.sensor.info.colorFilterArrangement">android.sensor.info.colorFilterArrangement</a></li>

19177

<li><a href="#static_android.sensor.info.exposureTimeRange">android.sensor.info.exposureTimeRange</a></li>

19178

<li><a href="#static_android.sensor.info.maxFrameDuration">android.sensor.info.maxFrameDuration</a></li>

19179

<li><a href="#static_android.sensor.info.physicalSize">android.sensor.info.physicalSize</a></li>

19180

<li><a href="#static_android.sensor.info.whiteLevel">android.sensor.info.whiteLevel</a></li>

19181

<li><a href="#static_android.sensor.info.lensShadingApplied">android.sensor.info.lensShadingApplied</a></li>

19182

<li><a href="#static_android.sensor.referenceIlluminant1">android.sensor.referenceIlluminant1</a></li>

19183

<li><a href="#static_android.sensor.referenceIlluminant2">android.sensor.referenceIlluminant2</a></li>

19184

<li><a href="#static_android.sensor.calibrationTransform1">android.sensor.calibrationTransform1</a></li>

19185

<li><a href="#static_android.sensor.calibrationTransform2">android.sensor.calibrationTransform2</a></li>

19186

<li><a href="#static_android.sensor.colorTransform1">android.sensor.colorTransform1</a></li>

19187

<li><a href="#static_android.sensor.colorTransform2">android.sensor.colorTransform2</a></li>

19188

<li><a href="#static_android.sensor.forwardMatrix1">android.sensor.forwardMatrix1</a></li>

19189

<li><a href="#static_android.sensor.forwardMatrix2">android.sensor.forwardMatrix2</a></li>

19190

<li><a href="#static_android.sensor.blackLevelPattern">android.sensor.blackLevelPattern</a></li>

19191

<li><a href="#static_android.sensor.maxAnalogSensitivity">android.sensor.maxAnalogSensitivity</a></li>

19192

<li><a href="#static_android.sensor.opticalBlackRegions">android.sensor.opticalBlackRegions</a></li>

19193

<li><a href="#static_android.sensor.availableTestPatternModes">android.sensor.availableTestPatternModes</a></li>

19194

<li><a href="#static_android.lens.info.hyperfocalDistance">android.lens.info.hyperfocalDistance</a></li>

19195

<li><a href="#static_android.lens.info.minimumFocusDistance">android.lens.info.minimumFocusDistance</a></li>

19196

<li><a href="#static_android.lens.info.focusDistanceCalibration">android.lens.info.focusDistanceCalibration</a></li>

19197

<li><a href="#static_android.lens.poseRotation">android.lens.poseRotation</a></li>

19198

<li><a href="#static_android.lens.poseTranslation">android.lens.poseTranslation</a></li>

19199

<li><a href="#static_android.lens.intrinsicCalibration">android.lens.intrinsicCalibration</a></li>

19200

<li><a href="#static_android.lens.poseReference">android.lens.poseReference</a></li>

19201

<li><a href="#static_android.lens.distortion">android.lens.distortion</a></li>

19202

</ul>

Shuzhen Wang

f8139f9

2020-06-05 13:34:23 -0700

[diff] [blame]

19203

The field of view of non-RAW physical streams must not be smaller than that of the

19204

non-RAW logical streams, or the maximum field-of-view of the physical camera,

19205

whichever is smaller. The application should check the physical capture result

19206

metadata for how the physical streams are cropped or zoomed. More specifically, given

19207

the physical camera result metadata, the effective horizontal field-of-view of the

19208

physical camera is:

19209

<pre><code>fov = 2 * atan2(cropW * sensorW / (2 * zoomRatio * activeArrayW), focalLength)

19210

</code></pre>

19211

where the equation parameters are the physical camera's crop region width, physical

19212

sensor width, zoom ratio, active array width, and focal length respectively. Typically

19213

the physical stream of active physical camera has the same field-of-view as the

19214

logical streams. However, the same may not be true for physical streams from

19215

non-active physical cameras. For example, if the logical camera has a wide-ultrawide

19216

configuration where the wide lens is the default, when the crop region is set to the

19217

logical camera's active array size, (and the zoom ratio set to 1.0 starting from

Shuzhen Wang

2022-05-03 11:01:26 -0700

[diff] [blame]

19218

Android 11), a physical stream for the ultrawide camera may prefer outputting images

Shuzhen Wang

f8139f9

2020-06-05 13:34:23 -0700

[diff] [blame]

19219

with larger field-of-view than that of the wide camera for better stereo matching

19220

margin or more robust motion tracking. At the same time, the physical non-RAW streams'

19221

field of view must not be smaller than the requested crop region and zoom ratio, as

19222

long as it's within the physical lens' capability. For example, for a logical camera

19223

with wide-tele lens configuration where the wide lens is the default, if the logical

19224

camera's crop region is set to maximum size, and zoom ratio set to 1.0, the physical

19225

stream for the tele lens will be configured to its maximum size crop region (no zoom).

19226

Deprecated: Prior to Android 11, the field of view of all non-RAW physical streams

19227

cannot be larger than that of non-RAW logical streams. If the logical camera has a

19228

wide-ultrawide lens configuration where the wide lens is the default, when the logical

19229

camera's crop region is set to maximum size, the FOV of the physical streams for the

19230

ultrawide lens will be the same as the logical stream, by making the crop region

19231

smaller than its active array size to compensate for the smaller focal length.

Shuzhen Wang

08a9974

2021-06-25 15:02:36 -0700

[diff] [blame]

19232

There are two ways for the application to capture RAW images from a logical camera

19233

with RAW capability:

19234

<ul>

19235

<li>Because the underlying physical cameras may have different RAW capabilities (such

19236

as resolution or CFA pattern), to maintain backward compatibility, when a RAW stream

19237

is configured, the camera device makes sure the default active physical camera remains

19238

active and does not switch to other physical cameras. (One exception is that, if the

19239

logical camera consists of identical image sensors and advertises multiple focalLength

19240

due to different lenses, the camera device may generate RAW images from different

19241

physical cameras based on the focalLength being set by the application.) This

19242

backward-compatible approach usually results in loss of optical zoom, to telephoto

19243

lens or to ultrawide lens.</li>

19244

<li>Alternatively, to take advantage of the full zoomRatio range of the logical camera,

19245

the application should use <a href="https://developer.android.com/reference/android/hardware/camera2/MultiResolutionImageReader.html">MultiResolutionImageReader</a>

19246

to capture RAW images from the currently active physical camera. Because different

19247

physical camera may have different RAW characteristics, the application needs to use

19248

the characteristics and result metadata of the active physical camera for the

19249

relevant RAW metadata.</li>

19250

</ul>

Shuzhen Wang

fb7587f

2019-06-26 13:45:12 -0700

[diff] [blame]

19251

The capture request and result metadata tags required for backward compatible camera

Shuzhen Wang

08a9974

2021-06-25 15:02:36 -0700

[diff] [blame]

19252

functionalities will be solely based on the logical camera capability. On the other

Shuzhen Wang

fb7587f

2019-06-26 13:45:12 -0700

[diff] [blame]

19253

hand, the use of manual capture controls (sensor or post-processing) with a

19254

logical camera may result in unexpected behavior when the HAL decides to switch

19255

between physical cameras with different characteristics under the hood. For example,

19256

when the application manually sets exposure time and sensitivity while zooming in,

19257

the brightness of the camera images may suddenly change because HAL switches from one

19258

physical camera to the other.

Shuzhen Wang

2017-11-30 12:03:37 -0800

[diff] [blame]

19259

</li>

Shuzhen Wang

2018-03-20 19:04:06 -0700

[diff] [blame]

<li>

MONOCHROME (v3.3)

[optional]

The camera device is a monochrome camera that doesn't contain a color filter array,

Shuzhen Wang

2018-10-15 12:00:13 -0700

[diff] [blame]

19264

and for YUV_420_888 stream, the pixel values on U and V planes are all 128.

Shuzhen Wang

2018-09-27 15:50:01 -0700

[diff] [blame]

19265

A MONOCHROME camera must support the guaranteed stream combinations required for

19266

its device level and capabilities. Additionally, if the monochrome camera device

19267

supports Y8 format, all mandatory stream combination requirements related to <a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#YUV_420_888">YUV_420_888</a> apply

Shuzhen Wang

2018-10-15 12:00:13 -0700

[diff] [blame]

19268

to <a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#Y8">Y8</a> as well. There are no

19269

mandatory stream combination requirements with regard to

19270

<a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#Y8">Y8</a> for Bayer camera devices.

19271

Starting from Android Q, the SENSOR_INFO_COLOR_FILTER_ARRANGEMENT of a MONOCHROME

19272

camera will be either MONO or NIR.

Shuzhen Wang

2018-03-20 19:04:06 -0700

[diff] [blame]

19273

</li>

Jayant Chowdhary

12ee7bf

2019-01-24 17:47:05 -0800

[diff] [blame]

19274

<li>

19275

SECURE_IMAGE_DATA (v3.4)

19276

[optional]

19277

The camera device is capable of writing image data into a region of memory

19278

inaccessible to Android userspace or the Android kernel, and only accessible to

19279

trusted execution environments (TEE).

19280

</li>

Jayant Chowdhary

9d6bd01

2019-07-18 17:43:21 -0700

[diff] [blame]

<li>

SYSTEM_CAMERA (v3.5)

[optional]

The camera device is only accessible by Android's system components and privileged

19285

applications. Processes need to have the android.permission.SYSTEM_CAMERA in

19286

addition to android.permission.CAMERA in order to connect to this camera device.

19287

</li>

Yin-Chia Yeh

2019-10-07 15:16:15 -0700

[diff] [blame]

19288

<li>

19289

OFFLINE_PROCESSING (v3.5)

19290

[optional]

Eino-Ville Talvala

2021-05-27 14:43:59 -0700

[diff] [blame]

19291

[java_public]

Yin-Chia Yeh

2019-10-07 15:16:15 -0700

[diff] [blame]

19292

The camera device supports the OFFLINE_PROCESSING use case.

19293

With OFFLINE_PROCESSING capability, the application can switch an ongoing

19294

capture session to offline mode by calling the

19295

CameraCaptureSession#switchToOffline method and specify streams to be kept in offline

19296

mode. The camera will then stop currently active repeating requests, prepare for

19297

some requests to go into offline mode, and return an offline session object. After

19298

the switchToOffline call returns, the original capture session is in closed state as

19299

if the CameraCaptureSession#close method has been called.

19300

In the offline mode, all inflight requests will continue to be processed in the

19301

background, and the application can immediately close the camera or create a new

19302

capture session without losing those requests' output images and capture results.

19303

While the camera device is processing offline requests, it

19304

might not be able to support all stream configurations it can support

19305

without offline requests. When that happens, the createCaptureSession

19306

method call will fail. The following stream configurations are guaranteed to work

19307

without hitting the resource busy exception:

19308

<ul>

19309

<li>One ongoing offline session: target one output surface of YUV or

19310

JPEG format, any resolution.</li>

19311

<li>The active camera capture session:<ol>

19312

<li>One preview surface (SurfaceView or SurfaceTexture) up to 1920 width</li>

19313

<li>One YUV ImageReader surface up to 1920 width</li>

19314

<li>One Jpeg ImageReader, any resolution: the camera device is

19315

allowed to slow down JPEG output speed by 50% if there is any ongoing offline

19316

session.</li>

Yin-Chia Yeh

fc30a53

2020-03-17 09:38:54 -0700

[diff] [blame]

19317

<li>If the device supports PRIVATE_REPROCESSING, one pair of ImageWriter/ImageReader

19318

surfaces of private format, with the same resolution that is larger or equal to

19319

the JPEG ImageReader resolution above.</li>

Yin-Chia Yeh

2019-10-07 15:16:15 -0700

[diff] [blame]

19320

</ol>

19321

</li>

19322

<li>Alternatively, the active camera session above can be replaced by an legacy

19323

<a href="https://developer.android.com/reference/android/hardware/Camera.html">Camera</a> with the following parameter settings:<ol>

19324

<li>Preview size up to 1920 width</li>

19325

<li>Preview callback size up to 1920 width</li>

19326

<li>Video size up to 1920 width</li>

19327

<li>Picture size, any resolution: the camera device is

19328

allowed to slow down JPEG output speed by 50% if there is any ongoing offline

session.</li>

</ol>

</li>

</ul>

</li>

Jayant Chowdhary

2020-11-09 09:08:31 -0800

[diff] [blame]

19334

<li>

19335

ULTRA_HIGH_RESOLUTION_SENSOR (v3.6)

19336

[optional]

19337

This camera device is capable of producing ultra high resolution images in

19338

addition to the image sizes described in the

19339

<a href="#static_android.scaler.streamConfigurationMap">android.scaler.streamConfigurationMap</a>.

19340

It can operate in 'default' mode and 'max resolution' mode. It generally does this

19341

by binning pixels in 'default' mode and not binning them in 'max resolution' mode.

19342

<code><a href="#static_android.scaler.streamConfigurationMap">android.scaler.streamConfigurationMap</a></code> describes the streams supported in 'default'

19343

mode.

19344

The stream configurations supported in 'max resolution' mode are described by

Jayant Chowdhary

e66a1c2

2021-08-09 23:40:40 +0000

[diff] [blame]

19345

<code><a href="#static_android.scaler.streamConfigurationMapMaximumResolution">android.scaler.streamConfigurationMapMaximumResolution</a></code>.

19346

The maximum resolution mode pixel array size of a camera device

19347

(<code><a href="#static_android.sensor.info.pixelArraySize">android.sensor.info.pixelArraySize</a></code>) with this capability,

19348

will be at least 24 megapixels.

Jayant Chowdhary

2020-11-09 09:08:31 -0800

[diff] [blame]

19349

</li>

19350

<li>

19351

REMOSAIC_REPROCESSING (v3.6)

19352

[optional]

Eino-Ville Talvala

2021-05-27 14:43:59 -0700

[diff] [blame]

19353

[java_public]

Jayant Chowdhary

2020-11-09 09:08:31 -0800

[diff] [blame]

19354

The device supports reprocessing from the <code>RAW_SENSOR</code> format with a bayer pattern

19355

given by <a href="#static_android.sensor.info.binningFactor">android.sensor.info.binningFactor</a> (m x n group of pixels with the same

19356

color filter) to a remosaiced regular bayer pattern.

19357

This capability will only be present for devices with

19358

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraMetadata.html#REQUEST_AVAILABLE_CAPABILITIES_ULTRA_HIGH_RESOLUTION_SENSOR">CameraMetadata#REQUEST_AVAILABLE_CAPABILITIES_ULTRA_HIGH_RESOLUTION_SENSOR</a>

19359

capability. When

19360

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraMetadata.html#REQUEST_AVAILABLE_CAPABILITIES_ULTRA_HIGH_RESOLUTION_SENSOR">CameraMetadata#REQUEST_AVAILABLE_CAPABILITIES_ULTRA_HIGH_RESOLUTION_SENSOR</a>

19361

devices do not advertise this capability,

19362

<a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#RAW_SENSOR">ImageFormat#RAW_SENSOR</a> images will already have a

19363

regular bayer pattern.

19364

If a <code>RAW_SENSOR</code> stream is requested along with another non-RAW stream in a

19365

<a href="https://developer.android.com/reference/android/hardware/camera2/CaptureRequest.html">CaptureRequest</a> (if multiple streams are supported

19366

when <a href="#controls_android.sensor.pixelMode">android.sensor.pixelMode</a> is set to

19367

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraMetadata.html#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION">CameraMetadata#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION</a>),

19368

the <code>RAW_SENSOR</code> stream will have a regular bayer pattern.

Shuzhen Wang

2022-05-03 11:01:26 -0700

[diff] [blame]

19369

This capability requires the camera device to support the following :

19370

<ul>

19371

<li>The <a href="https://developer.android.com/reference/android/hardware/camera2/params/StreamConfigurationMap.html">StreamConfigurationMap</a> mentioned below

Jayant Chowdhary

2020-11-09 09:08:31 -0800

[diff] [blame]

19372

refers to the one, described by

Shuzhen Wang

2022-05-03 11:01:26 -0700

[diff] [blame]

19373

<code><a href="#static_android.scaler.streamConfigurationMapMaximumResolution">android.scaler.streamConfigurationMapMaximumResolution</a></code>.</li>

19374

<li>One input stream is supported, that is, <code><a href="#static_android.request.maxNumInputStreams">android.request.maxNumInputStreams</a> == 1</code>.</li>

19375

<li><a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#RAW_SENSOR">ImageFormat#RAW_SENSOR</a> is supported as an output/input

Jayant Chowdhary

2020-11-09 09:08:31 -0800

[diff] [blame]

19376

format, that is, <a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#RAW_SENSOR">ImageFormat#RAW_SENSOR</a> is included in the

Shuzhen Wang

2022-05-03 11:01:26 -0700

[diff] [blame]

19377

lists of 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>.</li>

19378

<li><a href="https://developer.android.com/reference/android/hardware/camera2/params/StreamConfigurationMap.html#getValidOutputFormatsForInput">StreamConfigurationMap#getValidOutputFormatsForInput</a>

19379

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>.</li>

19380

<li>Each size returned by <a href="https://developer.android.com/reference/android/hardware/camera2/params/StreamConfigurationMap.html#getInputSizes">getInputSizes(ImageFormat.RAW_SENSOR)</a> is also included in <a href="https://developer.android.com/reference/android/hardware/camera2/params/StreamConfigurationMap.html#getOutputSizes">getOutputSizes(ImageFormat.RAW_SENSOR)</a></li>

19381

<li>Using <a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#RAW_SENSOR">ImageFormat#RAW_SENSOR</a> does not cause a frame rate

19382

drop relative to the sensor's maximum capture rate (at that resolution).</li>

19383

<li>No CaptureRequest controls will be applicable when a request has an input target

19384

with <a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#RAW_SENSOR">ImageFormat#RAW_SENSOR</a> format.</li>

19385

</ul>

Jayant Chowdhary

2020-11-09 09:08:31 -0800

[diff] [blame]

19386

</li>

Emilian Peev

2021-11-12 18:07:39 -0800

[diff] [blame]

19387

<li>

19388

DYNAMIC_RANGE_TEN_BIT (v3.8)

19389

[optional]

19390

[java_public]

19391

The device supports one or more 10-bit camera outputs according to the dynamic range

19392

profiles specified in

19393

<a href="https://developer.android.com/reference/android/hardware/camera2/params/DynamicRangeProfiles.html#getSupportedProfiles">DynamicRangeProfiles#getSupportedProfiles</a>.

19394

They can be configured as part of the capture session initialization via

19395

<a href="https://developer.android.com/reference/android/hardware/camera2/params/OutputConfiguration.html#setDynamicRangeProfile">OutputConfiguration#setDynamicRangeProfile</a>.

Shuzhen Wang

2022-05-03 11:01:26 -0700

[diff] [blame]

19396

Cameras that enable this capability must also support the following:

19397

<ul>

19398

<li>Profile <a href="https://developer.android.com/reference/android/hardware/camera2/params/DynamicRangeProfiles.html#HLG10">DynamicRangeProfiles#HLG10</a></li>

19399

<li>All mandatory stream combinations for this specific capability as per

19400

documentation <a href="https://developer.android.com/reference/android/hardware/camera2/CameraDevice.html#createCaptureSession">CameraDevice#createCaptureSession</a></li>

19401

<li>In case the device is not able to capture some combination of supported

Emilian Peev

2021-11-12 18:07:39 -0800

[diff] [blame]

19402

standard 8-bit and/or 10-bit dynamic range profiles within the same capture request,

19403

then those constraints must be listed in

Shuzhen Wang

2022-05-03 11:01:26 -0700

[diff] [blame]

19404

<a href="https://developer.android.com/reference/android/hardware/camera2/params/DynamicRangeProfiles.html#getProfileCaptureRequestConstraints">DynamicRangeProfiles#getProfileCaptureRequestConstraints</a></li>

19405

<li>Recommended dynamic range profile listed in

19406

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics.html#REQUEST_RECOMMENDED_TEN_BIT_DYNAMIC_RANGE_PROFILE">CameraCharacteristics#REQUEST_RECOMMENDED_TEN_BIT_DYNAMIC_RANGE_PROFILE</a>.</li>

19407

</ul>

Emilian Peev

2021-11-12 18:07:39 -0800

[diff] [blame]

19408

</li>

Shuzhen Wang

2021-12-14 20:08:28 -0800

[diff] [blame]

19409

<li>

19410

STREAM_USE_CASE (v3.8)

19411

[optional]

19412

The camera device supports selecting a per-stream use case via

19413

<a href="https://developer.android.com/reference/android/hardware/camera2/params/OutputConfiguration.html#setStreamUseCase">OutputConfiguration#setStreamUseCase</a>

19414

so that the device can optimize camera pipeline parameters such as tuning, sensor

19415

mode, or ISP settings for a specific user scenario.

Shuzhen Wang

2022-05-03 11:01:26 -0700

[diff] [blame]

19416

Some sample usages of this capability are:

19417

<ul>

19418

<li>Distinguish high quality YUV captures from a regular YUV stream where

19419

the image quality may not be as good as the JPEG stream, or</li>

19420

<li>Use one stream to serve multiple purposes: viewfinder, video recording and

Shuzhen Wang

2021-12-14 20:08:28 -0800

[diff] [blame]

19421

still capture. This is common with applications that wish to apply edits equally

Shuzhen Wang

2022-05-03 11:01:26 -0700

[diff] [blame]

19422

to preview, saved images, and saved videos.</li>

19423

</ul>

Shuzhen Wang

2021-12-14 20:08:28 -0800

[diff] [blame]

19424

This capability requires the camera device to support the following

Shuzhen Wang

2022-05-03 11:01:26 -0700

[diff] [blame]

19425

stream use cases:

19426

<ul>

19427

<li>DEFAULT for backward compatibility where the application doesn't set

19428

a stream use case</li>

19429

<li>PREVIEW for live viewfinder and in-app image analysis</li>

19430

<li>STILL_CAPTURE for still photo capture</li>

19431

<li>VIDEO_RECORD for recording video clips</li>

19432

<li>PREVIEW_VIDEO_STILL for one single stream used for viewfinder, video

19433

recording, and still capture.</li>

19434

<li>VIDEO_CALL for long running video calls</li>

19435

</ul>

Shuzhen Wang

2021-12-14 20:08:28 -0800

[diff] [blame]

19436

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics.html#SCALER_AVAILABLE_STREAM_USE_CASES">CameraCharacteristics#SCALER_AVAILABLE_STREAM_USE_CASES</a>

19437

lists all of the supported stream use cases.

19438

Refer to <a href="https://developer.android.com/reference/android/hardware/camera2/CameraDevice.html#createCaptureSession">CameraDevice#createCaptureSession</a> for the

19439

mandatory stream combinations involving stream use cases, which can also be queried

19440

via <a href="https://developer.android.com/reference/android/hardware/camera2/params/MandatoryStreamCombination.html">MandatoryStreamCombination</a>.

19441

</li>

Igor Murashkin

2014-02-06 15:35:37 -0800

[diff] [blame]

19442

</ul>

19443

19444

</td>

19445

19446

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

19447

List of capabilities that this camera device

Igor Murashkin

2014-02-06 15:35:37 -0800

[diff] [blame]

19448

advertises as fully supporting.

</td>

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2014-02-06 15:35:37 -0800

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

19466

<th class="th_details" colspan="6">Details</th>

Igor Murashkin

2014-02-06 15:35:37 -0800

[diff] [blame]

19467

</tr>

19468

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

19469

Igor Murashkin

2014-02-06 15:35:37 -0800

[diff] [blame]

19470

A capability is a contract that the camera device makes in order

19471

to be able to satisfy one or more use cases.

19472

Listing a capability guarantees that the whole set of features

19473

required to support a common use will all be available.

19474

Using a subset of the functionality provided by an unsupported

19475

capability may be possible on a specific camera device implementation;

19476

to do this query each of <a href="#static_android.request.availableRequestKeys">android.request.availableRequestKeys</a>,

19477

<a href="#static_android.request.availableResultKeys">android.request.availableResultKeys</a>,

19478

<a href="#static_android.request.availableCharacteristicsKeys">android.request.availableCharacteristicsKeys</a>.

Igor Murashkin

2014-02-06 15:35:37 -0800

[diff] [blame]

19479

The following capabilities are guaranteed to be available on

19480

<a href="#static_android.info.supportedHardwareLevel">android.info.supportedHardwareLevel</a> <code>==</code> FULL devices:

19481

<ul>

19482

<li>MANUAL_SENSOR</li>

Zhijun He

5a1276a

2014-06-02 16:46:03 -0700

[diff] [blame]

19483

<li>MANUAL_POST_PROCESSING</li>

Igor Murashkin

2014-02-06 15:35:37 -0800

[diff] [blame]

19484

</ul>

19485

Other capabilities may be available on either FULL or LIMITED

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

19486

devices, but the application should query this key to be sure.

Igor Murashkin

2014-02-06 15:35:37 -0800

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

19491

<th class="th_details" colspan="6">HAL Implementation Details</th>

Igor Murashkin

2014-02-06 15:35:37 -0800

[diff] [blame]

19492

</tr>

19493

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

19494

Igor Murashkin

2014-02-06 15:35:37 -0800

[diff] [blame]

19495

Additional constraint details per-capability will be available

19496

in the Compatibility Test Suite.

Eino-Ville Talvala

2014-07-09 09:34:05 -0700

[diff] [blame]

19497

Minimum baseline requirements required for the

19498

BACKWARD_COMPATIBLE capability are not explicitly listed.

Igor Murashkin

2014-02-06 15:35:37 -0800

[diff] [blame]

19499

Instead refer to "BC" tags and the camera CTS tests in the

Eino-Ville Talvala

2014-07-09 09:34:05 -0700

[diff] [blame]

19500

android.hardware.camera2.cts package.

Igor Murashkin

2014-02-06 15:35:37 -0800

[diff] [blame]

19501

Listed controls that can be either request or result (e.g.

19502

<a href="#controls_android.sensor.exposureTime">android.sensor.exposureTime</a>) must be available both in the

19503

request and the result in order to be considered to be

19504

capability-compliant.

19505

For example, if the HAL claims to support MANUAL control,

19506

then exposure time must be configurable via the request and

19507

the actual exposure applied must be available via

19508

the result.

Ruben Brunk

6285c4d

2014-06-18 17:13:19 -0700

[diff] [blame]

19509

If MANUAL_SENSOR is omitted, the HAL may choose to omit the

19510

<a href="#static_android.scaler.availableMinFrameDurations">android.scaler.availableMinFrameDurations</a> static property entirely.

Chien-Yu Chen

2015-05-12 15:13:00 -0700

[diff] [blame]

19511

For PRIVATE_REPROCESSING and YUV_REPROCESSING capabilities, see

Zhijun He

2015-01-15 18:17:24 -0800

[diff] [blame]

19512

hardware/libhardware/include/hardware/camera3.h Section 10 for more information.

Yin-Chia Yeh

fa2a867

2015-04-24 16:52:26 -0700

[diff] [blame]

19513

Devices that support the MANUAL_SENSOR capability must support the

19514

CAMERA3_TEMPLATE_MANUAL template defined in camera3.h.

Chien-Yu Chen

2015-05-12 15:13:00 -0700

[diff] [blame]

19515

Devices that support the PRIVATE_REPROCESSING capability or the

Yin-Chia Yeh

fa2a867

2015-04-24 16:52:26 -0700

[diff] [blame]

19516

YUV_REPROCESSING capability must support the

19517

CAMERA3_TEMPLATE_ZERO_SHUTTER_LAG template defined in camera3.h.

Eino-Ville Talvala

2015-04-13 17:28:29 -0700

[diff] [blame]

19518

For DEPTH_OUTPUT, the depth-format keys

19519

<a href="#static_android.depth.availableDepthStreamConfigurations">android.depth.availableDepthStreamConfigurations</a>,

19520

<a href="#static_android.depth.availableDepthMinFrameDurations">android.depth.availableDepthMinFrameDurations</a>,

19521

<a href="#static_android.depth.availableDepthStallDurations">android.depth.availableDepthStallDurations</a> must be available, in

19522

addition to the other keys explicitly mentioned in the DEPTH_OUTPUT

19523

enum notes. The entry <a href="#static_android.depth.maxDepthSamples">android.depth.maxDepthSamples</a> must be available

19524

if the DEPTH_POINT_CLOUD format is supported (HAL pixel format BLOB, dataspace

19525

DEPTH).

Shuzhen Wang

2017-11-30 12:03:37 -0800

[diff] [blame]

19526

For a camera device with LOGICAL_MULTI_CAMERA capability, it should operate in the

19527

same way as a physical camera device based on its hardware level and capabilities.

19528

It's recommended that its feature set is superset of that of individual physical cameras.

Shuzhen Wang

2018-05-23 09:07:11 -0700

[diff] [blame]

19529

<ul>

19530

<li>

Shuzhen Wang

fb440de

2019-03-27 15:27:24 -0700

[diff] [blame]

19531

In camera1 API, to maintain application compatibility, for each camera facing, there

19532

may be one or more {logical_camera_id, physical_camera_1_id, physical_camera_2_id, ...}

19533

combinations, where logical_camera_id is composed of physical_camera_N_id, camera

19534

framework will only advertise one camera id

19535

(within the combinations for the particular facing) that is frontmost in the HAL

19536

published camera id list.

19537

For example, if HAL advertises 6 back facing camera IDs (ID0 to ID5), among which ID4

19538

and ID5 are logical cameras backed by ID0+ID1 and ID2+ID3 respectively. In this case,

19539

only ID0 will be available for camera1 API to use.

Shuzhen Wang

2018-05-23 09:07:11 -0700

[diff] [blame]

19540

</li>

19541

<li>

19542

Camera HAL is strongly recommended to advertise camera devices with best feature,

19543

power, performance, and latency tradeoffs at the front of the camera id list.

19544

</li>

Shuzhen Wang

2018-11-19 12:15:18 -0800

[diff] [blame]

19545

<li>

Shuzhen Wang

2019-11-07 15:59:22 -0800

[diff] [blame]

19546

Camera HAL may switch between physical cameras depending on focalLength, cropRegion, or

19547

zoomRatio. If physical cameras have different sizes, HAL must maintain a single logical

19548

camera activeArraySize/pixelArraySize/preCorrectionActiveArraySize, and must do proper

19549

mapping between logical camera and underlying physical cameras for all related metadata

19550

tags, such as crop region, zoomRatio, 3A regions, and intrinsicCalibration.

Shuzhen Wang

2018-11-19 12:15:18 -0800

[diff] [blame]

19551

</li>

Shuzhen Wang

2019-03-07 08:38:51 -0800

[diff] [blame]

19552

<li>

19553

Starting from HIDL ICameraDevice version 3.5, camera HAL must support

19554

isStreamCombinationSupported for application to query whether a particular logical and

19555

physical streams combination are supported.

19556

</li>

Shuzhen Wang

2018-05-23 09:07:11 -0700

[diff] [blame]

19557

</ul>

Shuzhen Wang

2018-10-15 12:00:13 -0700

[diff] [blame]

19558

A MONOCHROME camera device must also advertise BACKWARD_COMPATIBLE capability, and must

19559

not advertise MANUAL_POST_PROCESSING capability.

Shuzhen Wang

2018-03-20 19:04:06 -0700

[diff] [blame]

19560

<ul>

19561

<li>

19562

To maintain backward compatibility, the camera device must support all

19563

BACKWARD_COMPATIBLE required keys. The <a href="#static_android.control.awbAvailableModes">android.control.awbAvailableModes</a> key only contains

19564

AUTO, and <a href="#dynamic_android.control.awbState">android.control.awbState</a> are either CONVERGED or LOCKED depending on

19565

<a href="#controls_android.control.awbLock">android.control.awbLock</a>.

19566

</li>

19567

<li>

Shuzhen Wang

2018-03-20 19:04:06 -0700

[diff] [blame]

19568

<a href="#controls_android.colorCorrection.mode">android.colorCorrection.mode</a>, <a href="#controls_android.colorCorrection.transform">android.colorCorrection.transform</a>, and

Shuzhen Wang

2018-10-15 12:00:13 -0700

[diff] [blame]

19569

<a href="#controls_android.colorCorrection.gains">android.colorCorrection.gains</a> must not be in available request and result keys.

19570

As a result, the camera device cannot be a FULL device. However, the HAL can

Shuzhen Wang

2022-05-03 11:01:26 -0700

[diff] [blame]

19571

still advertise other individual capabilities.

Shuzhen Wang

2018-03-20 19:04:06 -0700

[diff] [blame]

19572

</li>

19573

<li>

19574

If the device supports tonemap control, only <a href="#controls_android.tonemap.curveRed">android.tonemap.curveRed</a> is used.

19575

CurveGreen and curveBlue are no-ops.

19576

</li>

19577

</ul>

Shuzhen Wang

2018-10-15 12:00:13 -0700

[diff] [blame]

19578

In Android API level 28, a MONOCHROME camera device must not have RAW capability. From

19579

API level 29, a camera is allowed to have both MONOCHROME and RAW capabilities.

Yin-Chia Yeh

2019-10-07 15:16:15 -0700

[diff] [blame]

19580

To support the legacy API to ICameraDevice 3.x shim layer, devices advertising

19581

OFFLINE_PROCESSING capability must also support configuring an input stream of the same

19582

size as the picture size if:

19583

<ul>

19584

<li>The device supports PRIVATE_REPROCESSING capability</li>

19585

<li>The device's maximal JPEG resolution can reach 30 FPS min frame duration</li>

19586

<li>The device does not support HAL based ZSL (<a href="#controls_android.control.enableZsl">android.control.enableZsl</a>)</li>

19587

</ul>

Jayant Chowdhary

2e943b5

2020-03-20 14:01:03 -0700

[diff] [blame]

19588

For devices which support SYSTEM_CAMERA and LOGICAL_MULTI_CAMERA capabilities:

19589

Hidden physical camera ids[1] must not be be shared[2] between public camera devices

19590

and camera devices advertising SYSTEM_CAMERA capability.

19591

[1] - Camera device ids which are advertised in the

19592

ANDROID_LOGICAL_MULTI_CAMERA_PHYSICAL_IDS list, and not available through

19593

ICameraProvider.getCameraIdList().

19594

[2] - The ANDROID_LOGICAL_MULTI_CAMERA_PHYSICAL_IDS lists, must not have common

19595

camera ids.

Igor Murashkin

2014-02-06 15:35:37 -0800

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

19599

Igor Murashkin

2014-02-06 15:35:37 -0800

[diff] [blame]

19600

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

19604

<td class="entry_name

19605

" rowspan="5">

Igor Murashkin

2014-02-06 15:35:37 -0800

[diff] [blame]

19606

android.request.availableRequestKeys

</td>

int32

x

n

Yin-Chia Yeh

2016-04-02 16:30:30 -0700

[diff] [blame]

19615

[ndk_public]

Igor Murashkin

2014-02-06 15:35:37 -0800

[diff] [blame]

19616

19617

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

19618

[legacy]

19619

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2014-02-06 15:35:37 -0800

[diff] [blame]

19623

</td>

19624

19625

19626

A list of all keys that the camera device has available

Eino-Ville Talvala

2015-04-16 13:49:52 -0700

[diff] [blame]

19627

to use with <a href="https://developer.android.com/reference/android/hardware/camera2/CaptureRequest.html">CaptureRequest</a>.

Igor Murashkin

2014-02-06 15:35:37 -0800

[diff] [blame]

</td>

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2014-02-06 15:35:37 -0800

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

19645

<th class="th_details" colspan="6">Details</th>

Igor Murashkin

2014-02-06 15:35:37 -0800

[diff] [blame]

19646

</tr>

19647

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

19648

Igor Murashkin

2014-02-06 15:35:37 -0800

[diff] [blame]

19649

Attempting to set a key into a CaptureRequest that is not

19650

listed here will result in an invalid request and will be rejected

19651

by the camera device.

19652

This field can be used to query the feature set of a camera device

19653

at a more granular level than capabilities. This is especially

19654

important for optional keys that are not listed under any capability

19655

in <a href="#static_android.request.availableCapabilities">android.request.availableCapabilities</a>.

Igor Murashkin

2014-02-06 15:35:37 -0800

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

19660

<th class="th_details" colspan="6">HAL Implementation Details</th>

Igor Murashkin

2014-02-06 15:35:37 -0800

[diff] [blame]

19661

</tr>

19662

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

19663

Emilian Peev

3984754

2017-09-25 09:17:04 +0100

[diff] [blame]

19664

Vendor tags can be listed here. Vendor tag metadata should also

19665

use the extensions C api (refer to camera3.h for more details).

Igor Murashkin

2014-02-06 15:35:37 -0800

[diff] [blame]

19666

Setting/getting vendor tags will be checked against the metadata

19667

vendor extensions API and not against this field.

19668

The HAL must not consume any request tags that are not listed either

19669

here or in the vendor tag list.

19670

The public camera2 API will always make the vendor tags visible

Eino-Ville Talvala

2015-04-16 13:49:52 -0700

[diff] [blame]

19671

via

19672

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics.html#getAvailableCaptureRequestKeys">CameraCharacteristics#getAvailableCaptureRequestKeys</a>.

Igor Murashkin

2014-02-06 15:35:37 -0800

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

19676

Igor Murashkin

2014-02-06 15:35:37 -0800

[diff] [blame]

19677

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

19681

<td class="entry_name

19682

" rowspan="5">

Igor Murashkin

2014-02-06 15:35:37 -0800

[diff] [blame]

19683

android.request.availableResultKeys

</td>

int32

x

n

Yin-Chia Yeh

2016-04-02 16:30:30 -0700

[diff] [blame]

19692

[ndk_public]

Igor Murashkin

2014-02-06 15:35:37 -0800

[diff] [blame]

19693

19694

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

19695

[legacy]

19696

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2014-02-06 15:35:37 -0800

[diff] [blame]

19700

</td>

19701

19702

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

19703

A list of all keys that the camera device has available to use with <a href="https://developer.android.com/reference/android/hardware/camera2/CaptureResult.html">CaptureResult</a>.

Igor Murashkin

2014-02-06 15:35:37 -0800

[diff] [blame]

</td>

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2014-02-06 15:35:37 -0800

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

19721

<th class="th_details" colspan="6">Details</th>

Igor Murashkin

2014-02-06 15:35:37 -0800

[diff] [blame]

19722

</tr>

19723

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

19724

Igor Murashkin

2014-02-06 15:35:37 -0800

[diff] [blame]

19725

Attempting to get a key from a CaptureResult that is not

19726

listed here will always return a <code>null</code> value. Getting a key from

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

19727

a CaptureResult that is listed here will generally never return a <code>null</code>

Igor Murashkin

2014-02-06 15:35:37 -0800

[diff] [blame]

19728

value.

19729

The following keys may return <code>null</code> unless they are enabled:

19730

<ul>

19731

<li><a href="#dynamic_android.statistics.lensShadingMap">android.statistics.lensShadingMap</a> (non-null iff <a href="#controls_android.statistics.lensShadingMapMode">android.statistics.lensShadingMapMode</a> == ON)</li>

19732

</ul>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

19733

(Those sometimes-null keys will nevertheless be listed here

Igor Murashkin

2014-02-06 15:35:37 -0800

[diff] [blame]

19734

if they are available.)

19735

This field can be used to query the feature set of a camera device

19736

at a more granular level than capabilities. This is especially

19737

important for optional keys that are not listed under any capability

19738

in <a href="#static_android.request.availableCapabilities">android.request.availableCapabilities</a>.

Igor Murashkin

2014-02-06 15:35:37 -0800

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

19743

<th class="th_details" colspan="6">HAL Implementation Details</th>

Igor Murashkin

2014-02-06 15:35:37 -0800

[diff] [blame]

19744

</tr>

19745

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

19746

Igor Murashkin

2014-02-06 15:35:37 -0800

[diff] [blame]

19747

Tags listed here must always have an entry in the result metadata,

19748

even if that size is 0 elements. Only array-type tags (e.g. lists,

19749

matrices, strings) are allowed to have 0 elements.

Emilian Peev

3984754

2017-09-25 09:17:04 +0100

[diff] [blame]

19750

Vendor tags can be listed here. Vendor tag metadata should also

19751

use the extensions C api (refer to camera3.h for more details).

Igor Murashkin

2014-02-06 15:35:37 -0800

[diff] [blame]

19752

Setting/getting vendor tags will be checked against the metadata

19753

vendor extensions API and not against this field.

19754

The HAL must not produce any result tags that are not listed either

19755

here or in the vendor tag list.

Eino-Ville Talvala

2015-04-16 13:49:52 -0700

[diff] [blame]

19756

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>.

Igor Murashkin

2014-02-06 15:35:37 -0800

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

19760

Igor Murashkin

2014-02-06 15:35:37 -0800

[diff] [blame]

19761

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

19765

<td class="entry_name

19766

" rowspan="5">

Igor Murashkin

2014-02-06 15:35:37 -0800

[diff] [blame]

19767

android.request.availableCharacteristicsKeys

</td>

int32

x

n

Yin-Chia Yeh

2016-04-02 16:30:30 -0700

[diff] [blame]

19776

[ndk_public]

Igor Murashkin

2014-02-06 15:35:37 -0800

[diff] [blame]

19777

19778

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

19779

[legacy]

19780

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2014-02-06 15:35:37 -0800

[diff] [blame]

19784

</td>

19785

19786

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

19787

A list of all keys that the camera device has available to use with <a href="https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics.html">CameraCharacteristics</a>.

Igor Murashkin

2014-02-06 15:35:37 -0800

[diff] [blame]

</td>

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2014-02-06 15:35:37 -0800

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

19805

<th class="th_details" colspan="6">Details</th>

Igor Murashkin

2014-02-06 15:35:37 -0800

[diff] [blame]

19806

</tr>

19807

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

19808

Igor Murashkin

2014-02-06 15:35:37 -0800

[diff] [blame]

19809

This entry follows the same rules as

19810

<a href="#static_android.request.availableResultKeys">android.request.availableResultKeys</a> (except that it applies for

19811

CameraCharacteristics instead of CaptureResult). See above for more

19812

details.

Igor Murashkin

2014-02-06 15:35:37 -0800

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

19817

<th class="th_details" colspan="6">HAL Implementation Details</th>

Igor Murashkin

2014-02-06 15:35:37 -0800

[diff] [blame]

19818

</tr>

19819

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

19820

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

19821

Keys listed here must always have an entry in the static info metadata,

Igor Murashkin

2014-02-06 15:35:37 -0800

[diff] [blame]

19822

even if that size is 0 elements. Only array-type tags (e.g. lists,

19823

matrices, strings) are allowed to have 0 elements.

Emilian Peev

3984754

2017-09-25 09:17:04 +0100

[diff] [blame]

19824

Vendor tags can listed here. Vendor tag metadata should also use

19825

the extensions C api (refer to camera3.h for more details).

Igor Murashkin

2014-02-06 15:35:37 -0800

[diff] [blame]

19826

Setting/getting vendor tags will be checked against the metadata

19827

vendor extensions API and not against this field.

19828

The HAL must not have any tags in its static info that are not listed

19829

either here or in the vendor tag list.

19830

The public camera2 API will always make the vendor tags visible

Eino-Ville Talvala

2015-04-16 13:49:52 -0700

[diff] [blame]

19831

via <a href="https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics.html#getKeys">CameraCharacteristics#getKeys</a>.

Igor Murashkin

2014-02-06 15:35:37 -0800

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

19835

Igor Murashkin

2014-02-06 15:35:37 -0800

[diff] [blame]

19836

19837

Emilian Peev

2017-11-17 13:20:12 +0000

[diff] [blame]

19838

19839

19840

<td class="entry_name

19841

" rowspan="5">

19842

android.request.availableSessionKeys

</td>

int32

x

n

[ndk_public]

[legacy]

</td>

19860

19861

19862

A subset of the available request keys that the camera device

19863

can pass as part of the capture session initialization.

</td>

</td>

</td>

Emilian Peev

2018-01-10 13:47:40 +0000

[diff] [blame]

19873

3.3

Emilian Peev

2017-11-17 13:20:12 +0000

[diff] [blame]

</td>

</td>

</tr>

<th class="th_details" colspan="6">Details</th>

</tr>

This is a subset of <a href="#static_android.request.availableRequestKeys">android.request.availableRequestKeys</a> which

19886

contains a list of keys that are difficult to apply per-frame and

19887

can result in unexpected delays when modified during the capture session

19888

lifetime. Typical examples include parameters that require a

19889

time-consuming hardware re-configuration or internal camera pipeline

19890

change. For performance reasons we advise clients to pass their initial

Chien-Yu Chen

2018-01-11 11:32:52 -0800

[diff] [blame]

19891

values as part of

Eino-Ville Talvala

2017-12-07 13:12:11 -0800

[diff] [blame]

19892

<a href="https://developer.android.com/reference/SessionConfiguration.html#setSessionParameters">SessionConfiguration#setSessionParameters</a>.

Emilian Peev

2017-11-17 13:20:12 +0000

[diff] [blame]

19893

Once the camera capture session is enabled it is also recommended to avoid

19894

changing them from their initial values set in

19895

<a href="https://developer.android.com/reference/SessionConfiguration.html#setSessionParameters">SessionConfiguration#setSessionParameters</a>.

19896

Control over session parameters can still be exerted in capture requests

19897

but clients should be aware and expect delays during their application.

19898

An example usage scenario could look like this:

19899

<ul>

Shuzhen Wang

2022-05-03 11:01:26 -0700

[diff] [blame]

19900

<li>The camera client starts by querying the session parameter key list via

Emilian Peev

2017-11-17 13:20:12 +0000

[diff] [blame]

19901

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics.html#getAvailableSessionKeys">CameraCharacteristics#getAvailableSessionKeys</a>.</li>

19902

<li>Before triggering the capture session create sequence, a capture request

19903

must be built via

19904

<a href="https://developer.android.com/reference/CameraDevice.html#createCaptureRequest">CameraDevice#createCaptureRequest</a>

19905

using an appropriate template matching the particular use case.</li>

19906

<li>The client should go over the list of session parameters and check

19907

whether some of the keys listed matches with the parameters that

19908

they intend to modify as part of the first capture request.</li>

19909

<li>If there is no such match, the capture request can be passed

19910

unmodified to

19911

<a href="https://developer.android.com/reference/SessionConfiguration.html#setSessionParameters">SessionConfiguration#setSessionParameters</a>.</li>

19912

<li>If matches do exist, the client should update the respective values

19913

and pass the request to

19914

<a href="https://developer.android.com/reference/SessionConfiguration.html#setSessionParameters">SessionConfiguration#setSessionParameters</a>.</li>

19915

<li>After the capture session initialization completes the session parameter

19916

key list can continue to serve as reference when posting or updating

19917

further requests. As mentioned above further changes to session

19918

parameters should ideally be avoided, if updates are necessary

19919

however clients could expect a delay/glitch during the

19920

parameter switch.</li>

</ul>

</td>

</tr>

<th class="th_details" colspan="6">HAL Implementation Details</th>

</tr>

Emilian Peev

2018-05-15 11:18:04 +0100

[diff] [blame]

19930

If <a href="#controls_android.control.aeTargetFpsRange">android.control.aeTargetFpsRange</a> is part of the session parameters and constrained high

19931

speed mode is enabled, then only modifications of the maximum framerate value will be

19932

monitored by the framework and can trigger camera re-configuration. For more information

19933

about framerate ranges during constrained high speed sessions see

19934

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraDevice.html#createConstrainedHighSpeedCaptureSession">CameraDevice#createConstrainedHighSpeedCaptureSession</a>.

19935

Vendor tags can be listed here. Vendor tag metadata should also

Emilian Peev

2017-11-17 13:20:12 +0000

[diff] [blame]

19936

use the extensions C api (refer to

19937

android.hardware.camera.device.V3_4.StreamConfiguration.sessionParams for more details).

19938

Setting/getting vendor tags will be checked against the metadata

19939

vendor extensions API and not against this field.

19940

The HAL must not consume any request tags in the session parameters that

19941

are not listed either here or in the vendor tag list.

19942

The public camera2 API will always make the vendor tags visible

19943

via

19944

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics.html#getAvailableSessionKeys">CameraCharacteristics#getAvailableSessionKeys</a>.

</td>

</tr>

19950

Emilian Peev

2018-01-18 19:09:57 +0000

[diff] [blame]

19951

19952

19953

<td class="entry_name

19954

" rowspan="5">

19955

android.request.availablePhysicalCameraRequestKeys

</td>

int32

x

n

Shuzhen Wang

2019-02-19 14:50:37 -0800

[diff] [blame]

19964

[ndk_public]

Emilian Peev

2018-01-18 19:09:57 +0000

[diff] [blame]

[limited]

</td>

19973

19974

Shuzhen Wang

e396c46

2018-10-11 10:17:33 -0700

[diff] [blame]

19975

A subset of the available request keys that can be overridden for

Emilian Peev

2018-01-18 19:09:57 +0000

[diff] [blame]

19976

physical devices backing a logical multi-camera.

</td>

</td>

</td>

3.3

</td>

</td>

</tr>

<th class="th_details" colspan="6">Details</th>

</tr>

This is a subset of <a href="#static_android.request.availableRequestKeys">android.request.availableRequestKeys</a> which contains a list

Shuzhen Wang

2022-06-13 09:42:11 -0700

[diff] [blame]

19999

of keys that can be overridden using

20000

<a href="https://developer.android.com/reference/android/hardware/camera2/CaptureRequest.Builder.html#setPhysicalCameraKey">Builder#setPhysicalCameraKey</a>.

Emilian Peev

2018-01-18 19:09:57 +0000

[diff] [blame]

20001

The respective value of such request key can be obtained by calling

Shuzhen Wang

2022-06-13 09:42:11 -0700

[diff] [blame]

20002

<a href="https://developer.android.com/reference/android/hardware/camera2/CaptureRequest.Builder.html#getPhysicalCameraKey">Builder#getPhysicalCameraKey</a>.

20003

Capture requests that contain individual physical device requests must be built via

Emilian Peev

62d01d5

2018-02-06 16:08:38 +0000

[diff] [blame]

20004

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraDevice.html#createCaptureRequest(int,">Set)</a>.

Emilian Peev

2018-01-18 19:09:57 +0000

[diff] [blame]

</td>

</tr>

<th class="th_details" colspan="6">HAL Implementation Details</th>

</tr>

Vendor tags can be listed here. Vendor tag metadata should also

20014

use the extensions C api (refer to

20015

android.hardware.camera.device.V3_4.CaptureRequest.physicalCameraSettings for more

20016

details).

20017

Setting/getting vendor tags will be checked against the metadata

20018

vendor extensions API and not against this field.

20019

The HAL must not consume any request tags in the session parameters that

20020

are not listed either here or in the vendor tag list.

Emilian Peev

62d01d5

2018-02-06 16:08:38 +0000

[diff] [blame]

20021

There should be no overlap between this set of keys and the available session keys

20022

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics.html#getAvailableSessionKeys">CameraCharacteristics#getAvailableSessionKeys</a> along

20023

with any other controls that can have impact on the dual-camera sync.

Emilian Peev

2018-01-18 19:09:57 +0000

[diff] [blame]

20024

The public camera2 API will always make the vendor tags visible

20025

via

20026

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics.html#getAvailablePhysicalCameraRequestKeys">CameraCharacteristics#getAvailablePhysicalCameraRequestKeys</a>.

</td>

</tr>

20032

Emilian Peev

98a89c1

2018-08-15 18:20:27 +0100

[diff] [blame]

20033

20034

20035

<td class="entry_name

20036

" rowspan="5">

20037

android.request.characteristicKeysNeedingPermission

</td>

int32

x

n

[hidden]

[legacy]

</td>

20055

20056

20057

A list of camera characteristics keys that are only available

20058

in case the camera client has camera permission.

</td>

</td>

</td>

3.4

</td>

</td>

</tr>

<th class="th_details" colspan="6">Details</th>

</tr>

The entry contains a subset of

20081

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics.html#getKeys">CameraCharacteristics#getKeys</a> that require camera clients

20082

to acquire the <a href="https://developer.android.com/reference/android/Manifest/permission.html#CAMERA">permission#CAMERA</a> permission before calling

20083

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraManager.html#getCameraCharacteristics">CameraManager#getCameraCharacteristics</a>. If the

Shuzhen Wang

2022-05-03 11:01:26 -0700

[diff] [blame]

20084

permission is not held by the camera client, then the values of the respective properties

Emilian Peev

98a89c1

2018-08-15 18:20:27 +0100

[diff] [blame]

20085

will not be present in <a href="https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics.html">CameraCharacteristics</a>.

</td>

</tr>

<th class="th_details" colspan="6">HAL Implementation Details</th>

</tr>

Do not set this property directly, camera service will overwrite any previous values.

</td>

</tr>

20100

Emilian Peev

2021-11-12 18:07:39 -0800

[diff] [blame]

20101

20102

20103

<td class="entry_name

20104

" rowspan="3">

20105

android.request.availableDynamicRangeProfiles

</td>

int32

[java_public as dynamicRangeProfiles]

[synthetic]

</td>

20119

20120

20121

Devices supporting the 10-bit output capability

20122

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics.html#REQUEST_AVAILABLE_CAPABILITIES_DYNAMIC_RANGE_TEN_BIT">CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES_DYNAMIC_RANGE_TEN_BIT</a>

20123

must list their supported dynamic range profiles along with capture request

20124

constraints for specific profile combinations.

</td>

</td>

</td>

3.2

</td>

</td>

</tr>

<th class="th_details" colspan="6">Details</th>

</tr>

Camera clients can retrieve the list of supported 10-bit dynamic range profiles by calling

20147

<a href="https://developer.android.com/reference/android/hardware/camera2/params/DynamicRangeProfiles.html#getSupportedProfiles">DynamicRangeProfiles#getSupportedProfiles</a>.

20148

Any of them can be configured by setting OutputConfiguration dynamic range profile in

20149

<a href="https://developer.android.com/reference/android/hardware/camera2/params/OutputConfiguration.html#setDynamicRangeProfile">OutputConfiguration#setDynamicRangeProfile</a>.

20150

Clients can also check if there are any constraints that limit the combination

20151

of supported profiles that can be referenced within a single capture request by calling

20152

<a href="https://developer.android.com/reference/android/hardware/camera2/params/DynamicRangeProfiles.html#getProfileCaptureRequestConstraints">DynamicRangeProfiles#getProfileCaptureRequestConstraints</a>.

</td>

</tr>

<td class="entry_name

20163

" rowspan="5">

20164

android.request.availableDynamicRangeProfilesMap

20165

</td>

20166

Emilian Peev

2022-02-14 16:12:49 -0800

[diff] [blame]

20167

int64

Emilian Peev

2021-11-12 18:07:39 -0800

[diff] [blame]

x

Emilian Peev

2022-02-14 16:12:49 -0800

[diff] [blame]

20171

n x 3

Emilian Peev

2021-11-12 18:07:39 -0800

[diff] [blame]

[ndk_public]

<li>

STANDARD (v3.8)

0x1

8-bit SDR profile which is the default for all non 10-bit output capable devices.

</li>

<li>

HLG10 (v3.8)

0x2

10-bit pixel samples encoded using the Hybrid log-gamma transfer function.

</li>

<li>

HDR10 (v3.8)

0x4

10-bit pixel samples encoded using the SMPTE ST 2084 transfer function.

20194

This profile utilizes internal static metadata to increase the quality

of the capture.

</li>

<li>

HDR10_PLUS (v3.8)

0x8

10-bit pixel samples encoded using the SMPTE ST 2084 transfer function.

20201

In contrast to HDR10, this profile uses internal per-frame metadata

20202

to further enhance the quality of the capture.

20203

</li>

20204

<li>

20205

DOLBY_VISION_10B_HDR_REF (v3.8)

20206

0x10

20207

This is a camera mode for Dolby Vision capture optimized for a more scene

20208

accurate capture. This would typically differ from what a specific device

20209

might want to tune for a consumer optimized Dolby Vision general capture.

20210

</li>

20211

<li>

20212

DOLBY_VISION_10B_HDR_REF_PO (v3.8)

20213

0x20

20214

This is the power optimized mode for 10-bit Dolby Vision HDR Reference Mode.

20215

</li>

20216

<li>

20217

DOLBY_VISION_10B_HDR_OEM (v3.8)

20218

0x40

20219

This is the camera mode for the default Dolby Vision capture mode for the

20220

specific device. This would be tuned by each specific device for consumer

20221

pleasing results that resonate with their particular audience. We expect

20222

that each specific device would have a different look for their default

20223

Dolby Vision capture.

20224

</li>

20225

<li>

20226

DOLBY_VISION_10B_HDR_OEM_PO (v3.8)

20227

0x80

20228

This is the power optimized mode for 10-bit Dolby Vision HDR device specific

capture Mode.

</li>

<li>

DOLBY_VISION_8B_HDR_REF (v3.8)

20233

0x100

20234

This is the 8-bit version of the Dolby Vision reference capture mode optimized

for scene accuracy.

</li>

<li>

DOLBY_VISION_8B_HDR_REF_PO (v3.8)

20239

0x200

20240

This is the power optimized mode for 8-bit Dolby Vision HDR Reference Mode.

20241

</li>

20242

<li>

20243

DOLBY_VISION_8B_HDR_OEM (v3.8)

20244

0x400

20245

This is the 8-bit version of device specific tuned and optimized Dolby Vision

capture mode.

</li>

<li>

DOLBY_VISION_8B_HDR_OEM_PO (v3.8)

20250

0x800

20251

This is the power optimized mode for 8-bit Dolby Vision HDR device specific

capture Mode.

</li>

<li>

MAX (v3.8)

0x1000

</li>

</ul>

</td>

20262

20263

20264

A map of all available 10-bit dynamic range profiles along with their

20265

capture request constraints.

</td>

</td>

</td>

3.8

</td>

</td>

</tr>

<th class="th_details" colspan="6">Details</th>

</tr>

Devices supporting the 10-bit output capability

20288

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics.html#REQUEST_AVAILABLE_CAPABILITIES_DYNAMIC_RANGE_TEN_BIT">CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES_DYNAMIC_RANGE_TEN_BIT</a>

20289

must list their supported dynamic range profiles. In case the camera is not able to

20290

support every possible profile combination within a single capture request, then the

20291

constraints must be listed here as well.

</td>

</tr>

<th class="th_details" colspan="6">HAL Implementation Details</th>

</tr>

Emilian Peev

2022-02-14 16:12:49 -0800

[diff] [blame]

20300

The array contains three entries per supported profile:

Emilian Peev

2021-11-12 18:07:39 -0800

[diff] [blame]

20301

1) The supported dynamic profile value. Do note that

20302

ANDROID_REQUEST_AVAILABLE_DYNAMIC_RANGE_PROFILES_STANDARD is assumed to be always

20303

present and must not be listed.

20304

2) A bitmap combination of all supported profiles that can be referenced at the same

20305

time within a single capture request. Do note that a value of 0 means that there are

Emilian Peev

2022-02-14 16:12:49 -0800

[diff] [blame]

20306

no constraints and all combinations are supported.

20307

3) A flag indicating the presence of an internal lookahead functionality that

20308

can increase the streaming latency by more than 3 buffers. The value 0 will indicate

20309

that latency doesn't exceed 3 buffers, everything different than 0 will indicate

20310

latency that is beyond 3 buffers. In case the flag is set, then Camera clients will be

20311

advised to avoid configuring this profile for camera latency sensitive outputs such as

Emilian Peev

511bf34

2022-03-03 11:09:20 -0800

[diff] [blame]

20312

preview. Do note, that such extra latency must not be present for the HLG10 profile.

Emilian Peev

2021-11-12 18:07:39 -0800

[diff] [blame]

20313

For example if we assume that a device exists that can only support HLG10, HDR10 and

20314

HDR10_PLUS from the possible 10-bit profiles with the following capture constraints:

20315

1) HLG10 can be included in any capture request without constraints.

Emilian Peev

511bf34

2022-03-03 11:09:20 -0800

[diff] [blame]

20316

2) HDR10 and HDR10_PLUS can only be referenced together and/or with HLG10 but not with

Emilian Peev

2021-11-12 18:07:39 -0800

[diff] [blame]

20317

STANDARD.

Emilian Peev

2022-02-14 16:12:49 -0800

[diff] [blame]

20318

In the same example, HLG10 and HDR10 will not have additional lookahead latency, and

20319

HDR10+ will have latency that exceeds 3 buffers.

Emilian Peev

2021-11-12 18:07:39 -0800

[diff] [blame]

20320

The resulting array should look like this:

Emilian Peev

2022-02-14 16:12:49 -0800

[diff] [blame]

20321

[ANDROID_REQUEST_AVAILABLE_DYNAMIC_RANGE_PROFILES_HLG10, 0, 0,

Emilian Peev

2021-11-12 18:07:39 -0800

[diff] [blame]

20322

ANDROID_REQUEST_AVAILABLE_DYNAMIC_RANGE_PROFILES_HDR10,

20323

(ANDROID_REQUEST_AVAILABLE_DYNAMIC_RANGE_PROFILES_HDR10 |

20324

ANDROID_REQUEST_AVAILABLE_DYNAMIC_RANGE_PROFILES_HLG10 |

Emilian Peev

2022-02-14 16:12:49 -0800

[diff] [blame]

20325

ANDROID_REQUEST_AVAILABLE_DYNAMIC_RANGE_PROFILES_HDR10_PLUS), 0,

Emilian Peev

2021-11-12 18:07:39 -0800

[diff] [blame]

20326

ANDROID_REQUEST_AVAILABLE_DYNAMIC_RANGE_PROFILES_HDR10_PLUS,

20327

(ANDROID_REQUEST_AVAILABLE_DYNAMIC_RANGE_PROFILES_HDR10_PLUS |

20328

ANDROID_REQUEST_AVAILABLE_DYNAMIC_RANGE_PROFILES_HLG10 |

Emilian Peev

2022-02-14 16:12:49 -0800

[diff] [blame]

20329

ANDROID_REQUEST_AVAILABLE_DYNAMIC_RANGE_PROFILES_HDR10), 1]

Emilian Peev

2021-11-12 18:07:39 -0800

[diff] [blame]

20330

Camera providers must ensure that each processed buffer from a stream configured with the

20331

HDR10 dynamic range profile includes SMPTE ST 2086 static metadata by calling

20332

'android::hardware::graphics::mapper::V4_0::IMapper::set' before returning the buffer.

20333

Camera providers must ensure that each processed buffer from a stream configured

20334

with HDR10_PLUS dynamic range profile includes SMPTE ST 2094-40 dynamic

20335

metadata by calling 'android::hardware::graphics::mapper::V4_0::IMapper::set' before

20336

returning the buffer.

20337

Camera providers must ensure that each processed buffer from a stream configured

20338

with any of the 10-bit Dolby Vision dynamic range profiles includes SMPTE ST 2094-10

20339

dynamic metadata by calling 'android::hardware::graphics::mapper::V4_0::IMapper::set'

20340

before returning the buffer.

</td>

</tr>

<td class="entry_name

20350

" rowspan="3">

20351

android.request.recommendedTenBitDynamicRangeProfile

20352

</td>

20353

Emilian Peev

2022-02-14 16:12:49 -0800

[diff] [blame]

20354

int64

Emilian Peev

2021-11-12 18:07:39 -0800

[diff] [blame]

[java_public]

</td>

20364

20365

20366

Recommended 10-bit dynamic range profile.

</td>

</td>

</td>

3.8

</td>

</td>

</tr>

<th class="th_details" colspan="6">Details</th>

</tr>

Devices supporting the 10-bit output capability

20389

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics.html#REQUEST_AVAILABLE_CAPABILITIES_DYNAMIC_RANGE_TEN_BIT">CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES_DYNAMIC_RANGE_TEN_BIT</a>

20390

must list a 10-bit supported dynamic range profile that is expected to perform

20391

optimally in terms of image quality, power and performance.

20392

The value advertised can be used as a hint by camera clients when configuring the dynamic

20393

range profile when calling

20394

<a href="https://developer.android.com/reference/android/hardware/camera2/params/OutputConfiguration.html#setDynamicRangeProfile">OutputConfiguration#setDynamicRangeProfile</a>.

</td>

</tr>

20401

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</tbody>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

20406

<tr><td colspan="7" class="kind">dynamic</td></tr>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

20407

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

20408

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

20409

<tr>

20410

<th class="th_name">Property Name</th>

20411

20412

<th class="th_description">Description</th>

20413

<th class="th_units">Units</th>

20414

<th class="th_range">Range</th>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

20415

<th class="th_hal_version">Initial HIDL HAL version</th>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</tr>

</thead>

<tbody>

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

20432

<td class="entry_name

Igor Murashkin

2014-07-25 16:55:18 -0700

[diff] [blame]

20433

entry_name_deprecated

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

20434

" rowspan="3">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

20435

android.request.frameCount

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

20436

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

20437

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

20438

int32

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

20439

Igor Murashkin

2014-07-25 16:55:18 -0700

[diff] [blame]

20440

[hidden]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

20441

20442

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

20443

Igor Murashkin

2014-07-25 16:55:18 -0700

[diff] [blame]

20444

[deprecated]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

20448

</td>

20449

20450

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

20451

A frame counter set by the framework. This value monotonically

20452

increases with every new result (that is, each new result has a unique

20453

frameCount value).

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

20457

count of frames

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Igor Murashkin

2014-07-25 16:55:18 -0700

[diff] [blame]

20461

Deprecated. Do not use.

Igor Murashkin

6cb7c2c

2014-01-10 15:12:40 -0800

[diff] [blame]

20462

> 0

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

20463

</td>

20464

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

20472

</tr>

20473

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

20474

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

20475

</tr>

20476

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

20477

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

20478

Reset on release()

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

20479

</td>

20480

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

20481

20482

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

20483

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

20484

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

20488

<td class="entry_name

20489

" rowspan="1">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

20490

android.request.id

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

20491

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

20492

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

20493

int32

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

20494

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

20495

[hidden]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

20496

20497

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

20501

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

20502

</td>

20503

20504

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

20505

An application-specified ID for the current

20506

request. Must be maintained unchanged in output

20507

frame

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

20511

arbitrary integer assigned by application

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Eino-Ville Talvala

2014-01-02 16:11:44 -0800

[diff] [blame]

20515

Any int

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

20516

</td>

20517

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

20522

Igor Murashkin

2012-12-05 14:49:11 -0800

[diff] [blame]

20523

20524

20525

</ul>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

20526

</td>

20527

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

20528

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

20529

20530

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

20531

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

20532

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

20536

<td class="entry_name

20537

" rowspan="1">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

20538

android.request.metadataMode

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

20539

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

20540

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

20541

byte

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

20542

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

20543

[system]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

20544

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

20548

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

20549

20550

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

20551

NONE (v3.2)

Igor Murashkin

2014-01-15 17:05:22 -0800

[diff] [blame]

20552

No metadata should be produced on output, except

20553

for application-bound buffer data. If no

20554

application-bound streams exist, no frame should be

20555

placed in the output frame queue. If such streams

20556

exist, a frame should be placed on the output queue

20557

with null metadata but with the necessary output buffer

20558

information. Timestamp information should still be

20559

included with any output stream buffers

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

20560

</li>

20561

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

20562

FULL (v3.2)

Igor Murashkin

2014-01-15 17:05:22 -0800

[diff] [blame]

20563

All metadata should be produced. Statistics will

20564

only be produced if they are separately

20565

enabled

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</li>

</ul>

</td>

20570

20571

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

20572

How much metadata to produce on

20573

output

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

20586

Zhijun He

2014-05-23 11:02:34 -0700

[diff] [blame]

20587

20588

<li><a href="#tag_FUTURE">FUTURE</a></li>

20589

</ul>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

20590

</td>

20591

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

20592

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

20593

20594

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

20595

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

20596

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

20600

<td class="entry_name

20601

entry_name_deprecated

20602

" rowspan="3">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

20603

android.request.outputStreams

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

20604

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

20605

Zhijun He

e36cdbe

2013-09-06 14:28:37 -0700

[diff] [blame]

20606

int32

Eino-Ville Talvala

2013-07-12 17:02:27 -0700

[diff] [blame]

20607

x

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

20608

Eino-Ville Talvala

2013-07-12 17:02:27 -0700

[diff] [blame]

n

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

20612

[system]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

20613

20614

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

20615

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

[deprecated]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

20620

</td>

20621

20622

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

20623

Lists which camera output streams image data

20624

from this capture must be sent to

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

20628

List of camera stream IDs

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

20632

Deprecated. Do not use.

20633

List must only include streams that have been

Eino-Ville Talvala

2014-01-02 16:11:44 -0800

[diff] [blame]

20634

created

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

20635

</td>

20636

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

20641

Eino-Ville Talvala

2013-07-12 17:02:27 -0700

[diff] [blame]

20642

20643

20644

</ul>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

20645

</td>

20646

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

20647

</tr>

20648

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

20649

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

20650

</tr>

20651

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

20652

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

20653

If no output streams are listed, then the image

20654

data should simply be discarded. The image data must

20655

still be captured for metadata and statistics production,

20656

and the lens and flash must operate as requested.

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

20657

</td>

20658

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

20659

20660

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

20661

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

20662

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

20663

Igor Murashkin

2014-01-09 17:43:38 -0800

[diff] [blame]

20664

20665

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

20666

<td class="entry_name

20667

" rowspan="5">

Igor Murashkin

2014-01-09 17:43:38 -0800

[diff] [blame]

20668

android.request.pipelineDepth

</td>

byte

[public]

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

20676

[legacy]

20677

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2014-01-09 17:43:38 -0800

[diff] [blame]

20681

</td>

20682

20683

20684

Specifies the number of pipeline stages the frame went

20685

through from when it was exposed to when the final completed result

20686

was available to the framework.

</td>

</td>

<= <a href="#static_android.request.pipelineMaxDepth">android.request.pipelineMaxDepth</a>

20694

</td>

20695

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2014-01-09 17:43:38 -0800

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

20705

<th class="th_details" colspan="6">Details</th>

Igor Murashkin

2014-01-09 17:43:38 -0800

[diff] [blame]

20706

</tr>

20707

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

20708

Igor Murashkin

2014-01-09 17:43:38 -0800

[diff] [blame]

20709

Depending on what settings are used in the request, and

20710

what streams are configured, the data may undergo less processing,

20711

and some pipeline stages skipped.

20712

See <a href="#static_android.request.pipelineMaxDepth">android.request.pipelineMaxDepth</a> for more details.

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

20717

<th class="th_details" colspan="6">HAL Implementation Details</th>

Igor Murashkin

2014-01-09 17:43:38 -0800

[diff] [blame]

20718

</tr>

20719

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

20720

Igor Murashkin

2014-01-09 17:43:38 -0800

[diff] [blame]

20721

This value must always represent the accurate count of how many

20722

pipeline stages were actually used.

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

20726

Igor Murashkin

2014-01-09 17:43:38 -0800

[diff] [blame]

20727

20728

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</tbody>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

20735

<tr><td colspan="7" id="section_scaler" class="section">scaler</td></tr>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

20736

20737

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

20738

<tr><td colspan="7" class="kind">controls</td></tr>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

20739

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

20740

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

20741

<tr>

20742

<th class="th_name">Property Name</th>

20743

20744

<th class="th_description">Description</th>

20745

<th class="th_units">Units</th>

20746

<th class="th_range">Range</th>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

20747

<th class="th_hal_version">Initial HIDL HAL version</th>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</tr>

</thead>

<tbody>

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

20764

<td class="entry_name

Eino-Ville Talvala

2014-06-06 14:35:41 -0700

[diff] [blame]

20765

" rowspan="5">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

20766

android.scaler.cropRegion

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

20767

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

20768

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

20769

int32

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

x

Eino-Ville Talvala

2013-04-16 15:35:18 -0700

[diff] [blame]

20773

4

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

20774

Igor Murashkin

2013-07-17 16:29:34 -0700

[diff] [blame]

20775

[public as rectangle]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

20776

20777

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

20778

[legacy]

20779

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

20783

</td>

20784

20785

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

20786

The desired region of the sensor to read out for this capture.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

20790

Pixel coordinates relative to

Yin-Chia Yeh

2018-06-15 15:35:05 -0700

[diff] [blame]

20791

android.sensor.info.activeArraySize or

20792

android.sensor.info.preCorrectionActiveArraySize depending on distortion correction

20793

capability and mode

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

</ul>

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

20811

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

20812

</tr>

20813

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

20814

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

20815

This control can be used to implement digital zoom.

Yin-Chia Yeh

2018-06-15 15:35:05 -0700

[diff] [blame]

20816

For devices not supporting <a href="#controls_android.distortionCorrection.mode">android.distortionCorrection.mode</a> control, the coordinate

20817

system always follows that of <a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a>, with <code>(0, 0)</code> being

20818

the top-left pixel of the active array.

Eino-Ville Talvala

2020-01-06 16:08:56 -0800

[diff] [blame]

20819

For devices supporting <a href="#controls_android.distortionCorrection.mode">android.distortionCorrection.mode</a> control, the coordinate system

20820

depends on the mode being set. When the distortion correction mode is OFF, the

20821

coordinate system follows <a href="#static_android.sensor.info.preCorrectionActiveArraySize">android.sensor.info.preCorrectionActiveArraySize</a>, with <code>(0,

20822

0)</code> being the top-left pixel of the pre-correction active array. When the distortion

20823

correction mode is not OFF, the coordinate system follows

20824

<a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a>, with <code>(0, 0)</code> being the top-left pixel of the

20825

active array.

20826

Output streams use this rectangle to produce their output, cropping to a smaller region

20827

if necessary to maintain the stream's aspect ratio, then scaling the sensor input to

Eino-Ville Talvala

2014-06-06 14:35:41 -0700

[diff] [blame]

20828

match the output's configured resolution.

Eino-Ville Talvala

2020-01-06 16:08:56 -0800

[diff] [blame]

20829

The crop region is applied after the RAW to other color space (e.g. YUV)

20830

conversion. Since raw streams (e.g. RAW16) don't have the conversion stage, they are not

Eino-Ville Talvala

2014-06-06 14:35:41 -0700

[diff] [blame]

20831

croppable. The crop region will be ignored by raw streams.

Eino-Ville Talvala

2020-01-06 16:08:56 -0800

[diff] [blame]

20832

For non-raw streams, any additional per-stream cropping will be done to maximize the

20833

final pixel area of the stream.

20834

For example, if the crop region is set to a 4:3 aspect ratio, then 4:3 streams will use

20835

the exact crop region. 16:9 streams will further crop vertically (letterbox).

20836

Conversely, if the crop region is set to a 16:9, then 4:3 outputs will crop horizontally

20837

(pillarbox), and 16:9 streams will match exactly. These additional crops will be

20838

centered within the crop region.

20839

To illustrate, here are several scenarios of different crop regions and output streams,

20840

for a hypothetical camera device with an active array of size <code>(2000,1500)</code>. Note that

20841

several of these examples use non-centered crop regions for ease of illustration; such

20842

regions are only supported on devices with FREEFORM capability

20843

(<a href="#static_android.scaler.croppingType">android.scaler.croppingType</a> <code>== FREEFORM</code>), but this does not affect the way the crop

20844

rules work otherwise.

20845

<ul>

20846

<li>Camera Configuration:<ul>

20847

<li>Active array size: <code>2000x1500</code> (3 MP, 4:3 aspect ratio)</li>

20848

<li>Output stream #1: <code>640x480</code> (VGA, 4:3 aspect ratio)</li>

20849

<li>Output stream #2: <code>1280x720</code> (720p, 16:9 aspect ratio)</li>

20850

</ul>

20851

</li>

20852

<li>Case #1: 4:3 crop region with 2x digital zoom<ul>

20853

<li>Crop region: <code>Rect(500, 375, 1500, 1125) // (left, top, right, bottom)</code></li>

20854

20855

<li><code>640x480</code> stream source area: <code>(500, 375, 1500, 1125)</code> (equal to crop region)</li>

20856

<li><code>1280x720</code> stream source area: <code>(500, 469, 1500, 1031)</code> (letterboxed)</li>

20857

</ul>

20858

</li>

20859

<li>Case #2: 16:9 crop region with ~1.5x digital zoom.<ul>

20860

<li>Crop region: <code>Rect(500, 375, 1833, 1125)</code></li>

20861

20862

<li><code>640x480</code> stream source area: <code>(666, 375, 1666, 1125)</code> (pillarboxed)</li>

20863

<li><code>1280x720</code> stream source area: <code>(500, 375, 1833, 1125)</code> (equal to crop region)</li>

20864

</ul>

20865

</li>

20866

<li>Case #3: 1:1 crop region with ~2.6x digital zoom.<ul>

20867

<li>Crop region: <code>Rect(500, 375, 1250, 1125)</code></li>

20868

20869

<li><code>640x480</code> stream source area: <code>(500, 469, 1250, 1031)</code> (letterboxed)</li>

20870

<li><code>1280x720</code> stream source area: <code>(500, 543, 1250, 957)</code> (letterboxed)</li>

20871

</ul>

20872

</li>

20873

<li>Case #4: Replace <code>640x480</code> stream with <code>1024x1024</code> stream, with 4:3 crop region:<ul>

20874

<li>Crop region: <code>Rect(500, 375, 1500, 1125)</code></li>

20875

20876

<li><code>1024x1024</code> stream source area: <code>(625, 375, 1375, 1125)</code> (pillarboxed)</li>

20877

<li><code>1280x720</code> stream source area: <code>(500, 469, 1500, 1031)</code> (letterboxed)</li>

20878

<li>Note that in this case, neither of the two outputs is a subset of the other, with

20879

each containing image data the other doesn't have.</li>

20880

</ul>

20881

</li>

20882

</ul>

Eino-Ville Talvala

2018-08-01 15:26:26 -0700

[diff] [blame]

20883

If the coordinate system is <a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a>, the width and height

Yin-Chia Yeh

2018-06-15 15:35:05 -0700

[diff] [blame]

20884

of the crop region cannot be set to be smaller than

Eino-Ville Talvala

2014-06-06 14:35:41 -0700

[diff] [blame]

20885

<code>floor( activeArraySize.width / <a href="#static_android.scaler.availableMaxDigitalZoom">android.scaler.availableMaxDigitalZoom</a> )</code> and

20886

<code>floor( activeArraySize.height / <a href="#static_android.scaler.availableMaxDigitalZoom">android.scaler.availableMaxDigitalZoom</a> )</code>, respectively.

Yin-Chia Yeh

2018-06-15 15:35:05 -0700

[diff] [blame]

20887

If the coordinate system is <a href="#static_android.sensor.info.preCorrectionActiveArraySize">android.sensor.info.preCorrectionActiveArraySize</a>, the width

20888

and height of the crop region cannot be set to be smaller than

20889

<code>floor( preCorrectionActiveArraySize.width / <a href="#static_android.scaler.availableMaxDigitalZoom">android.scaler.availableMaxDigitalZoom</a> )</code>

20890

and

20891

<code>floor( preCorrectionActiveArraySize.height / <a href="#static_android.scaler.availableMaxDigitalZoom">android.scaler.availableMaxDigitalZoom</a> )</code>,

20892

respectively.

Eino-Ville Talvala

2020-01-06 16:08:56 -0800

[diff] [blame]

20893

The camera device may adjust the crop region to account for rounding and other hardware

20894

requirements; the final crop region used will be included in the output capture result.

Shuzhen Wang

2020-09-14 11:40:07 -0700

[diff] [blame]

20895

The camera sensor output aspect ratio depends on factors such as output stream

20896

combination and <a href="#controls_android.control.aeTargetFpsRange">android.control.aeTargetFpsRange</a>, and shouldn't be adjusted by using

20897

this control. And the camera device will treat different camera sensor output sizes

20898

(potentially with in-sensor crop) as the same crop of

20899

<a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a>. As a result, the application shouldn't assume the

20900

maximum crop region always maps to the same aspect ratio or field of view for the

20901

sensor output.

Shuzhen Wang

2019-11-07 15:59:22 -0800

[diff] [blame]

20902

Starting from API level 30, it's strongly recommended to use <a href="#controls_android.control.zoomRatio">android.control.zoomRatio</a>

20903

to take advantage of better support for zoom with logical multi-camera. The benefits

20904

include better precision with optical-digital zoom combination, and ability to do

20905

zoom-out from 1.0x. When using <a href="#controls_android.control.zoomRatio">android.control.zoomRatio</a> for zoom, the crop region in

Shuzhen Wang

2020-09-14 11:40:07 -0700

[diff] [blame]

20906

the capture request should be left as the default activeArray size. The

Shuzhen Wang

2019-11-07 15:59:22 -0800

[diff] [blame]

20907

coordinate system is post-zoom, meaning that the activeArraySize or

Eino-Ville Talvala

2020-01-06 16:08:56 -0800

[diff] [blame]

20908

preCorrectionActiveArraySize covers the camera device's field of view "after" zoom. See

20909

<a href="#controls_android.control.zoomRatio">android.control.zoomRatio</a> for details.

Jayant Chowdhary

2020-11-09 09:08:31 -0800

[diff] [blame]

20910

For camera devices with the

20911

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraMetadata.html#REQUEST_AVAILABLE_CAPABILITIES_ULTRA_HIGH_RESOLUTION_SENSOR">CameraMetadata#REQUEST_AVAILABLE_CAPABILITIES_ULTRA_HIGH_RESOLUTION_SENSOR</a>

20912

capability, <a href="#static_android.sensor.info.activeArraySizeMaximumResolution">android.sensor.info.activeArraySizeMaximumResolution</a> /

20913

<a href="#static_android.sensor.info.preCorrectionActiveArraySizeMaximumResolution">android.sensor.info.preCorrectionActiveArraySizeMaximumResolution</a> must be used as the

20914

coordinate system for requests where <a href="#controls_android.sensor.pixelMode">android.sensor.pixelMode</a> is set to

20915

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraMetadata.html#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION">CameraMetadata#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION</a>.

Eino-Ville Talvala

2014-06-06 14:35:41 -0700

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

20920

<th class="th_details" colspan="6">HAL Implementation Details</th>

Eino-Ville Talvala

2014-06-06 14:35:41 -0700

[diff] [blame]

20921

</tr>

20922

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

20923

Eino-Ville Talvala

2014-06-06 14:35:41 -0700

[diff] [blame]

20924

The output streams must maintain square pixels at all

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

20925

times, no matter what the relative aspect ratios of the

20926

crop region and the stream are. Negative values for

Igor Murashkin

2013-12-09 12:06:17 -0800

[diff] [blame]

20927

corner are allowed for raw output if full pixel array is

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

20928

larger than active pixel array. Width and height may be

20929

rounded to nearest larger supportable width, especially

20930

for raw output, where only a few fixed scales may be

Eino-Ville Talvala

2014-06-06 14:35:41 -0700

[diff] [blame]

20931

possible.

Shuzhen Wang

2019-11-07 15:59:22 -0800

[diff] [blame]

20932

If <a href="#controls_android.control.zoomRatio">android.control.zoomRatio</a> is supported by the HAL, the HAL must report the zoom

20933

ratio via <a href="#controls_android.control.zoomRatio">android.control.zoomRatio</a>, and change the coordinate system such that

20934

<a href="#static_android.sensor.info.preCorrectionActiveArraySize">android.sensor.info.preCorrectionActiveArraySize</a> or <a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a>(depending on whether <a href="#controls_android.distortionCorrection.mode">android.distortionCorrection.mode</a> is supported) is used to

20935

represent the camera field-of-view after zoom. see <a href="#controls_android.control.zoomRatio">android.control.zoomRatio</a> for

20936

details.

Eino-Ville Talvala

2014-06-06 14:35:41 -0700

[diff] [blame]

20937

HAL2.x uses only (x, y, width)

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

20938

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

20939

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

20940

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

20941

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

20942

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

20943

Eino-Ville Talvala

2020-01-06 13:06:22 -0800

[diff] [blame]

20944

20945

20946

<td class="entry_name

20947

" rowspan="5">

20948

android.scaler.rotateAndCrop

</td>

byte

[public]

<li>

NONE (v3.5)

No rotate and crop is applied. Processed outputs are in the sensor orientation.

</li>

<li>

90 (v3.5)

Processed images are rotated by 90 degrees clockwise, and then cropped

20967

to the original aspect ratio.

</li>

<li>

180 (v3.5)

Processed images are rotated by 180 degrees. Since the aspect ratio does not

20972

change, no cropping is performed.

</li>

<li>

270 (v3.5)

Processed images are rotated by 270 degrees clockwise, and then cropped

20977

to the original aspect ratio.

</li>

<li>

AUTO (v3.5)

The camera API automatically selects the best concrete value for

20982

rotate-and-crop based on the application's support for resizability and the current

20983

multi-window mode.

20984

If the application does not support resizing but the display mode for its main

20985

Activity is not in a typical orientation, the camera API will set <code>ROTATE_AND_CROP_90</code>

20986

or some other supported rotation value, depending on device configuration,

20987

to ensure preview and captured images are correctly shown to the user. Otherwise,

20988

<code>ROTATE_AND_CROP_NONE</code> will be selected.

20989

When a value other than NONE is selected, several metadata fields will also be parsed

20990

differently to ensure that coordinates are correctly handled for features like drawing

20991

face detection boxes or passing in tap-to-focus coordinates. The camera API will

20992

convert positions in the active array coordinate system to/from the cropped-and-rotated

20993

coordinate system to make the operation transparent for applications.

20994

No coordinate mapping will be done when the application selects a non-AUTO mode.

</li>

</ul>

</td>

20999

21000

21001

Whether a rotation-and-crop operation is applied to processed

21002

outputs from the camera.

</td>

</td>

<a href="#static_android.scaler.availableRotateAndCropModes">android.scaler.availableRotateAndCropModes</a>

</td>

3.5

</td>

</td>

</tr>

<th class="th_details" colspan="6">Details</th>

</tr>

This control is primarily intended to help camera applications with no support for

21026

multi-window modes to work correctly on devices where multi-window scenarios are

21027

unavoidable, such as foldables or other devices with variable display geometry or more

21028

free-form window placement (such as laptops, which often place portrait-orientation apps

21029

in landscape with pillarboxing).

21030

If supported, the default value is <code>ROTATE_AND_CROP_AUTO</code>, which allows the camera API

21031

to enable backwards-compatibility support for applications that do not support resizing

21032

/ multi-window modes, when the device is in fact in a multi-window mode (such as inset

21033

portrait on laptops, or on a foldable device in some fold states). In addition,

21034

<code>ROTATE_AND_CROP_NONE</code> and <code>ROTATE_AND_CROP_90</code> will always be available if this control

21035

is supported by the device. If not supported, devices API level 30 or higher will always

21036

list only <code>ROTATE_AND_CROP_NONE</code>.

21037

When <code>CROP_AUTO</code> is in use, and the camera API activates backward-compatibility mode,

21038

several metadata fields will also be parsed differently to ensure that coordinates are

21039

correctly handled for features like drawing face detection boxes or passing in

21040

tap-to-focus coordinates. The camera API will convert positions in the active array

21041

coordinate system to/from the cropped-and-rotated coordinate system to make the

21042

operation transparent for applications. The following controls are affected:

21043

<ul>

21044

<li><a href="#controls_android.control.aeRegions">android.control.aeRegions</a></li>

21045

<li><a href="#controls_android.control.afRegions">android.control.afRegions</a></li>

21046

<li><a href="#controls_android.control.awbRegions">android.control.awbRegions</a></li>

21047

<li><a href="#dynamic_android.statistics.faces">android.statistics.faces</a></li>

21048

</ul>

21049

Capture results will contain the actual value selected by the API;

21050

<code>ROTATE_AND_CROP_AUTO</code> will never be seen in a capture result.

21051

Applications can also select their preferred cropping mode, either to opt out of the

21052

backwards-compatibility treatment, or to use the cropping feature themselves as needed.

21053

In this case, no coordinate translation will be done automatically, and all controls

21054

will continue to use the normal active array coordinates.

21055

Cropping and rotating is done after the application of digital zoom (via either

21056

<a href="#controls_android.scaler.cropRegion">android.scaler.cropRegion</a> or <a href="#controls_android.control.zoomRatio">android.control.zoomRatio</a>), but before each individual

21057

output is further cropped and scaled. It only affects processed outputs such as

21058

YUV, PRIVATE, and JPEG. It has no effect on RAW outputs.

21059

When <code>CROP_90</code> or <code>CROP_270</code> are selected, there is a significant loss to the field of

21060

view. For example, with a 4:3 aspect ratio output of 1600x1200, <code>CROP_90</code> will still

21061

produce 1600x1200 output, but these buffers are cropped from a vertical 3:4 slice at the

21062

center of the 4:3 area, then rotated to be 4:3, and then upscaled to 1600x1200. Only

21063

56.25% of the original FOV is still visible. In general, for an aspect ratio of <code>w:h</code>,

21064

the crop and rotate operation leaves <code>(h/w)^2</code> of the field of view visible. For 16:9,

21065

this is ~31.6%.

21066

As a visual example, the figure below shows the effect of <code>ROTATE_AND_CROP_90</code> on the

21067

outputs for the following parameters:

21068

<ul>

21069

<li>Sensor active array: <code>2000x1500</code></li>

21070

<li>Crop region: top-left: <code>(500, 375)</code>, size: <code>(1000, 750)</code> (4:3 aspect ratio)</li>

21071

<li>Output streams: YUV <code>640x480</code> and YUV <code>1280x720</code></li>

21072

<li><code>ROTATE_AND_CROP_90</code></li>

21073

</ul>

21074

21075

With these settings, the regions of the active array covered by the output streams are:

21076

<ul>

21077

<li>640x480 stream crop: top-left: <code>(219, 375)</code>, size: <code>(562, 750)</code></li>

21078

<li>1280x720 stream crop: top-left: <code>(289, 375)</code>, size: <code>(422, 750)</code></li>

21079

</ul>

21080

Since the buffers are rotated, the buffers as seen by the application are:

21081

<ul>

21082

<li>640x480 stream: top-left: <code>(781, 375)</code> on active array, size: <code>(640, 480)</code>, downscaled 1.17x from sensor pixels</li>

21083

<li>1280x720 stream: top-left: <code>(711, 375)</code> on active array, size: <code>(1280, 720)</code>, upscaled 1.71x from sensor pixels</li>

</ul>

</td>

</tr>

<th class="th_details" colspan="6">HAL Implementation Details</th>

</tr>

ROTATE_AND_CROP_AUTO will never be sent to the HAL, though it must be set as the default

21094

value in all the capture request templates by the HAL. The camera service will

21095

translate AUTO to a specific rotation value based on the current application's

21096

multi-window state and its support of resizability.

21097

The HAL also does not need to consider coordinate transforms for ROTATE_AND_CROP - all

21098

capture request and result fields should be kept in the active array coordinate frame.

21099

Any translation required to implement ROTATE_AND_CROP_AUTO will be handled by the camera

service.

</td>

</tr>

21106

Jayant Chowdhary

2021-07-21 11:26:51 -0700

[diff] [blame]

21107

21108

21109

<td class="entry_name

21110

" rowspan="3">

21111

android.scaler.cropRegionSet

</td>

byte

[fwk_only as boolean]

<li>

Jayant Chowdhary

2021-09-13 11:29:10 -0700

[diff] [blame]

21124

FALSE (v3.2)

21125

Crop region (<a href="#controls_android.scaler.cropRegion">android.scaler.cropRegion</a>) has not been set by the

Jayant Chowdhary

2021-07-21 11:26:51 -0700

[diff] [blame]

21126

camera client.

21127

</li>

21128

<li>

Jayant Chowdhary

2021-09-13 11:29:10 -0700

[diff] [blame]

21129

TRUE (v3.2)

21130

Scaler crop regions (<a href="#controls_android.scaler.cropRegion">android.scaler.cropRegion</a>) has been set by the camera

Jayant Chowdhary

2021-07-21 11:26:51 -0700

[diff] [blame]

client.

</li>

</ul>

</td>

21136

21137

21138

Framework-only private key which informs camera fwk that the scaler crop region

21139

(<a href="#controls_android.scaler.cropRegion">android.scaler.cropRegion</a>) has been set by the client and it need

21140

not be corrected when <a href="#controls_android.sensor.pixelMode">android.sensor.pixelMode</a> is set to MAXIMUM_RESOLUTION.

</td>

</td>

</td>

3.2

</td>

</td>

</tr>

<th class="th_details" colspan="6">Details</th>

</tr>

This must be set to TRUE by the camera2 java fwk when the camera client sets

21163

<a href="#controls_android.scaler.cropRegion">android.scaler.cropRegion</a>.

</td>

</tr>

21170

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</tbody>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

21175

<tr><td colspan="7" class="kind">static</td></tr>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

21176

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

21177

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

21178

<tr>

21179

<th class="th_name">Property Name</th>

21180

21181

<th class="th_description">Description</th>

21182

<th class="th_units">Units</th>

21183

<th class="th_range">Range</th>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

21184

<th class="th_hal_version">Initial HIDL HAL version</th>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</tr>

</thead>

<tbody>

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

21201

<td class="entry_name

21202

entry_name_deprecated

21203

" rowspan="5">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

21204

android.scaler.availableFormats

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

21205

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

21206

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

21207

int32

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

x

n

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

21213

[hidden as imageFormat]

21214

21215

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

21216

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

21217

[deprecated]

21218

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

21219

21220

21221

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

21222

RAW16 (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

21223

[optional]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

21224

0x20

Ruben Brunk

2014-02-04 18:27:20 -0800

[diff] [blame]

21225

RAW16 is a standard, cross-platform format for raw image

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

21226

buffers with 16-bit pixels.

21227

Buffers of this format are typically expected to have a

Shuzhen Wang

2018-10-15 12:00:13 -0700

[diff] [blame]

21228

Color Filter Array (CFA) layout, which is given in

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

21229

<a href="#static_android.sensor.info.colorFilterArrangement">android.sensor.info.colorFilterArrangement</a>. Sensors with

21230

CFAs that are not representable by a format in

21231

<a href="#static_android.sensor.info.colorFilterArrangement">android.sensor.info.colorFilterArrangement</a> should not

21232

use this format.

Ruben Brunk

2014-02-04 18:27:20 -0800

[diff] [blame]

21233

Buffers of this format will also follow the constraints given for

21234

RAW_OPAQUE buffers, but with relaxed performance constraints.

Ruben Brunk

ae4f9c0

2015-06-12 16:43:51 -0700

[diff] [blame]

21235

This format is intended to give users access to the full contents

21236

of the buffers coming directly from the image sensor prior to any

21237

cropping or scaling operations, and all coordinate systems for

21238

metadata used for this format are relative to the size of the

21239

active region of the image sensor before any geometric distortion

21240

correction has been applied (i.e.

Eino-Ville Talvala

2015-06-16 11:36:01 -0700

[diff] [blame]

21241

<a href="#static_android.sensor.info.preCorrectionActiveArraySize">android.sensor.info.preCorrectionActiveArraySize</a>). Supported

Ruben Brunk

ae4f9c0

2015-06-12 16:43:51 -0700

[diff] [blame]

21242

dimensions for this format are limited to the full dimensions of

21243

the sensor (e.g. either <a href="#static_android.sensor.info.pixelArraySize">android.sensor.info.pixelArraySize</a> or

Eino-Ville Talvala

2015-06-16 11:36:01 -0700

[diff] [blame]

21244

<a href="#static_android.sensor.info.preCorrectionActiveArraySize">android.sensor.info.preCorrectionActiveArraySize</a> will be the

Ruben Brunk

ae4f9c0

2015-06-12 16:43:51 -0700

[diff] [blame]

21245

only supported output size).

Eino-Ville Talvala

2014-02-10 12:39:35 -0800

[diff] [blame]

21246

See <a href="#static_android.scaler.availableInputOutputFormatsMap">android.scaler.availableInputOutputFormatsMap</a> for

21247

the full set of performance guarantees.

Ruben Brunk

2014-02-04 18:27:20 -0800

[diff] [blame]

21248

</li>

21249

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

21250

RAW_OPAQUE (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

21251

[optional]

Ruben Brunk

2014-02-04 18:27:20 -0800

[diff] [blame]

21252

0x24

Yin-Chia Yeh

2015-12-06 21:42:35 -0800

[diff] [blame]

21253

RAW_OPAQUE (or

21254

<a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#RAW_PRIVATE">RAW_PRIVATE</a>

21255

as referred in public API) is a format for raw image buffers

21256

coming from an image sensor.

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

21257

The actual structure of buffers of this format is

Ruben Brunk

2014-02-04 18:27:20 -0800

[diff] [blame]

21258

platform-specific, but must follow several constraints:

21259

<ol>

21260

<li>No image post-processing operations may have been applied to

21261

buffers of this type. These buffers contain raw image data coming

21262

directly from the image sensor.</li>

21263

<li>If a buffer of this format is passed to the camera device for

21264

reprocessing, the resulting images will be identical to the images

21265

produced if the buffer had come directly from the sensor and was

21266

processed with the same settings.</li>

21267

</ol>

21268

The intended use for this format is to allow access to the native

21269

raw format buffers coming directly from the camera sensor without

21270

any additional conversions or decrease in framerate.

Eino-Ville Talvala

2014-02-10 12:39:35 -0800

[diff] [blame]

21271

See <a href="#static_android.scaler.availableInputOutputFormatsMap">android.scaler.availableInputOutputFormatsMap</a> for the full set of

Ruben Brunk

2014-02-04 18:27:20 -0800

[diff] [blame]

21272

performance guarantees.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

21273

</li>

21274

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

21275

YV12 (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

21276

[optional]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

21277

0x32315659

Igor Murashkin

2014-01-15 17:05:22 -0800

[diff] [blame]

21278

YCrCb 4:2:0 Planar

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

21279

</li>

21280

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

21281

YCrCb_420_SP (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

21282

[optional]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

21283

0x11

Igor Murashkin

2014-01-15 17:05:22 -0800

[diff] [blame]

21284

NV21

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

21285

</li>

21286

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

21287

IMPLEMENTATION_DEFINED (v3.2)

Zhijun He

2013-05-16 17:49:35 -0700

[diff] [blame]

21288

0x22

Zhijun He

2014-01-16 09:47:07 -0800

[diff] [blame]

21289

System internal format, not application-accessible

Zhijun He

2013-05-16 17:49:35 -0700

[diff] [blame]

21290

</li>

21291

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

21292

YCbCr_420_888 (v3.2)

Zhijun He

2013-05-16 17:49:35 -0700

[diff] [blame]

21293

0x23

Igor Murashkin

2014-01-15 17:05:22 -0800

[diff] [blame]

21294

Flexible YUV420 Format

Zhijun He

2013-05-16 17:49:35 -0700

[diff] [blame]

21295

</li>

21296

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

21297

BLOB (v3.2)

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

21298

0x21

Zhijun He

2014-01-16 09:47:07 -0800

[diff] [blame]

21299

JPEG format

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

21300

</li>

Shuzhen Wang

2018-09-27 15:50:01 -0700

[diff] [blame]

<li>

RAW10 (v3.4)

0x25

RAW10

</li>

<li>

RAW12 (v3.4)

0x26

RAW12

</li>

<li>

Y8 (v3.4)

0x20203859

Y8

</li>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

21316

</ul>

21317

21318

</td>

21319

21320

Zhijun He

2014-01-16 09:47:07 -0800

[diff] [blame]

21321

The list of image formats that are supported by this

Igor Murashkin

2014-02-04 18:02:27 -0800

[diff] [blame]

21322

camera device for output streams.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

21329

Deprecated. Do not use.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

21330

</td>

21331

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

21336

21337

Igor Murashkin

2012-12-05 14:49:11 -0800

[diff] [blame]

21338

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</ul>

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

21342

</tr>

Zhijun He

2014-01-16 09:47:07 -0800

[diff] [blame]

21343

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

21344

<th class="th_details" colspan="6">Details</th>

Zhijun He

2014-01-16 09:47:07 -0800

[diff] [blame]

21345

</tr>

21346

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

21347

Zhijun He

2014-01-16 09:47:07 -0800

[diff] [blame]

21348

All camera devices will support JPEG and YUV_420_888 formats.

21349

When set to YUV_420_888, application can access the YUV420 data directly.

21350

</td>

21351

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

21352

Zhijun He

2014-01-16 09:47:07 -0800

[diff] [blame]

21353

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

21354

<th class="th_details" colspan="6">HAL Implementation Details</th>

Zhijun He

2014-01-16 09:47:07 -0800

[diff] [blame]

21355

</tr>

21356

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

21357

Zhijun He

2014-01-16 09:47:07 -0800

[diff] [blame]

21358

These format values are from HAL_PIXEL_FORMAT_* in

Jayant Chowdhary

2020-11-09 09:08:31 -0800

[diff] [blame]

21359

system/core/libsystem/include/system/graphics-base.h.

Zhijun He

2014-01-16 09:47:07 -0800

[diff] [blame]

21360

When IMPLEMENTATION_DEFINED is used, the platform

21361

gralloc module will select a format based on the usage flags provided

21362

by the camera HAL device and the other endpoint of the stream. It is

21363

usually used by preview and recording streams, where the application doesn't

21364

need access the image data.

21365

YCbCr_420_888 format must be supported by the HAL. When an image stream

Shuzhen Wang

2018-10-15 12:00:13 -0700

[diff] [blame]

21366

needs CPU/application direct access, this format will be used. For a MONOCHROME

21367

camera device, the pixel value of Cb and Cr planes is 128.

Zhijun He

2014-01-16 09:47:07 -0800

[diff] [blame]

21368

The BLOB format must be supported by the HAL. This is used for the JPEG stream.

Ruben Brunk

2014-02-04 18:27:20 -0800

[diff] [blame]

21369

A RAW_OPAQUE buffer should contain only pixel data. It is strongly

21370

recommended that any information used by the camera device when

21371

processing images is fully expressed by the result metadata

21372

for that image buffer.

Zhijun He

2014-01-16 09:47:07 -0800

[diff] [blame]

21373

</td>

21374

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

21375

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

21376

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

21377

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

21381

<td class="entry_name

21382

entry_name_deprecated

21383

" rowspan="3">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

21384

android.scaler.availableJpegMinDurations

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

21385

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

21386

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

21387

int64

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

x

n

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

[hidden]

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

21396

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

21397

[deprecated]

21398

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

21399

21400

21401

</td>

21402

21403

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

21404

The minimum frame duration that is supported

Igor Murashkin

2014-01-13 17:22:58 -0800

[diff] [blame]

21405

for each resolution in <a href="#static_android.scaler.availableJpegSizes">android.scaler.availableJpegSizes</a>.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

21409

Nanoseconds

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

21413

Deprecated. Do not use.

21414

TODO: Remove property.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

21415

</td>

21416

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

21421

21422

Igor Murashkin

2012-12-05 14:49:11 -0800

[diff] [blame]

21423

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</ul>

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

21427

</tr>

21428

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

21429

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

21430

</tr>

21431

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

21432

Igor Murashkin

2014-01-13 17:22:58 -0800

[diff] [blame]

21433

This corresponds to the minimum steady-state frame duration when only

21434

that JPEG stream is active and captured in a burst, with all

21435

processing (typically in android.*.mode) set to FAST.

21436

When multiple streams are configured, the minimum

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

21437

frame duration will be >= max(individual stream min

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

21438

durations)

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

21439

</td>

21440

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

21441

21442

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

21443

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

21444

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

21448

<td class="entry_name

21449

entry_name_deprecated

21450

" rowspan="5">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

21451

android.scaler.availableJpegSizes

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

21452

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

21453

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

21454

int32

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

x

n x 2

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

[hidden as size]

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

21463

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

21464

[deprecated]

21465

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

21466

21467

21468

</td>

21469

21470

Zhijun He

2014-01-16 09:47:07 -0800

[diff] [blame]

21471

The JPEG resolutions that are supported by this camera device.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

21478

Deprecated. Do not use.

21479

TODO: Remove property.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

21480

</td>

21481

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

21486

21487

Igor Murashkin

2012-12-05 14:49:11 -0800

[diff] [blame]

21488

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</ul>

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

21492

</tr>

Zhijun He

2014-01-16 09:47:07 -0800

[diff] [blame]

21493

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

21494

<th class="th_details" colspan="6">Details</th>

Zhijun He

2014-01-16 09:47:07 -0800

[diff] [blame]

21495

</tr>

21496

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

21497

Zhijun He

2014-01-16 09:47:07 -0800

[diff] [blame]

21498

The resolutions are listed as <code>(width, height)</code> pairs. All camera devices will support

21499

sensor maximum resolution (defined by <a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a>).

21500

</td>

21501

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

21502

Zhijun He

2014-01-16 09:47:07 -0800

[diff] [blame]

21503

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

21504

<th class="th_details" colspan="6">HAL Implementation Details</th>

Zhijun He

2014-01-16 09:47:07 -0800

[diff] [blame]

21505

</tr>

21506

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

21507

Zhijun He

2014-01-16 09:47:07 -0800

[diff] [blame]

21508

The HAL must include sensor maximum resolution

21509

(defined by <a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a>),

21510

and should include half/quarter of sensor maximum resolution.

21511

</td>

21512

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

21513

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

21514

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

21515

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

21519

<td class="entry_name

Shuzhen Wang

2019-11-07 15:59:22 -0800

[diff] [blame]

21520

" rowspan="5">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

21521

android.scaler.availableMaxDigitalZoom

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

21522

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

21523

Igor Murashkin

f11a4df

2013-05-07 10:00:46 -0700

[diff] [blame]

21524

float

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

21525

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

21526

[public]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

21527

21528

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

21529

[legacy]

21530

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

21534

</td>

21535

21536

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

21537

The maximum ratio between both active area width

21538

and crop region width, and active area height and

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

21539

crop region height, for <a href="#controls_android.scaler.cropRegion">android.scaler.cropRegion</a>.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

21543

Zoom scale factor

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Igor Murashkin

2014-01-10 15:12:40 -0800

[diff] [blame]

21547

>=1

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

21548

</td>

21549

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

21554

Igor Murashkin

f11a4df

2013-05-07 10:00:46 -0700

[diff] [blame]

21555

21556

21557

</ul>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

21558

</td>

21559

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

21560

</tr>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

21561

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

21562

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

21563

</tr>

21564

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

21565

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

21566

This represents the maximum amount of zooming possible by

21567

the camera device, or equivalently, the minimum cropping

21568

window size.

21569

Crop regions that have a width or height that is smaller

21570

than this ratio allows will be rounded up to the minimum

21571

allowed size by the camera device.

Shuzhen Wang

2019-11-07 15:59:22 -0800

[diff] [blame]

21572

Starting from API level 30, when using <a href="#controls_android.control.zoomRatio">android.control.zoomRatio</a> to zoom in or out,

21573

the application must use <a href="#static_android.control.zoomRatioRange">android.control.zoomRatioRange</a> to query both the minimum and

21574

maximum zoom ratio.

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

21575

</td>

21576

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

21577

Shuzhen Wang

2019-11-07 15:59:22 -0800

[diff] [blame]

21578

21579

<th class="th_details" colspan="6">HAL Implementation Details</th>

</tr>

Shuzhen Wang

2021-06-30 16:09:35 -0700

[diff] [blame]

21583

If the HAL supports <a href="#controls_android.control.zoomRatio">android.control.zoomRatio</a>, this value must be equal to or less than

21584

the maximum supported zoomRatio specified in <a href="#static_android.control.zoomRatioRange">android.control.zoomRatioRange</a>.

Shuzhen Wang

2019-11-07 15:59:22 -0800

[diff] [blame]

21585

</td>

21586

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

21587

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

21588

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

21589

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

21593

<td class="entry_name

21594

entry_name_deprecated

21595

" rowspan="3">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

21596

android.scaler.availableProcessedMinDurations

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

21597

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

21598

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

21599

int64

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

x

n

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

[hidden]

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

21608

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

21609

[deprecated]

21610

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

21611

21612

21613

</td>

21614

21615

Igor Murashkin

2014-01-13 17:22:58 -0800

[diff] [blame]

21616

For each available processed output size (defined in

21617

<a href="#static_android.scaler.availableProcessedSizes">android.scaler.availableProcessedSizes</a>), this property lists the

21618

minimum supportable frame duration for that size.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

21622

Nanoseconds

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

21626

Deprecated. Do not use.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

21627

</td>

21628

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

21633

21634

Igor Murashkin

2012-12-05 14:49:11 -0800

[diff] [blame]

21635

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</ul>

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

21639

</tr>

21640

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

21641

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

21642

</tr>

21643

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

21644

Igor Murashkin

2014-01-13 17:22:58 -0800

[diff] [blame]

21645

This should correspond to the frame duration when only that processed

21646

stream is active, with all processing (typically in android.*.mode)

21647

set to FAST.

21648

When multiple streams are configured, the minimum frame duration will

21649

be >= max(individual stream min durations).

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

21650

</td>

21651

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

21652

21653

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

21654

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

21655

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

21659

<td class="entry_name

21660

entry_name_deprecated

21661

" rowspan="5">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

21662

android.scaler.availableProcessedSizes

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

21663

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

21664

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

21665

int32

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

x

n x 2

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

[hidden as size]

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

21674

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

21675

[deprecated]

21676

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

21677

21678

21679

</td>

21680

21681

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

21682

The resolutions available for use with

21683

processed output streams, such as YV12, NV12, and

21684

platform opaque YUV/RGB streams to the GPU or video

Zhijun He

2014-01-16 09:47:07 -0800

[diff] [blame]

21685

encoders.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

21692

Deprecated. Do not use.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

21693

</td>

21694

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

</ul>

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

21707

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

21708

</tr>

21709

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

21710

Zhijun He

2014-01-16 09:47:07 -0800

[diff] [blame]

21711

The resolutions are listed as <code>(width, height)</code> pairs.

21712

For a given use case, the actual maximum supported resolution

21713

may be lower than what is listed here, depending on the destination

21714

Surface for the image data. For example, for recording video,

21715

the video encoder chosen may have a maximum size limit (e.g. 1080p)

21716

smaller than what the camera (e.g. maximum resolution is 3264x2448)

21717

can provide.

21718

Please reference the documentation for the image data destination to

21719

check if it limits the maximum size for image data.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

21720

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

21721

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

21722

Zhijun He

2014-01-16 09:47:07 -0800

[diff] [blame]

21723

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

21724

<th class="th_details" colspan="6">HAL Implementation Details</th>

Zhijun He

2014-01-16 09:47:07 -0800

[diff] [blame]

21725

</tr>

21726

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

21727

Zhijun He

2014-01-16 09:47:07 -0800

[diff] [blame]

21728

For FULL capability devices (<code><a href="#static_android.info.supportedHardwareLevel">android.info.supportedHardwareLevel</a> == FULL</code>),

Eino-Ville Talvala

2014-02-10 12:39:35 -0800

[diff] [blame]

21729

the HAL must include all JPEG sizes listed in <a href="#static_android.scaler.availableJpegSizes">android.scaler.availableJpegSizes</a>

Zhijun He

2014-01-16 09:47:07 -0800

[diff] [blame]

21730

and each below resolution if it is smaller than or equal to the sensor

21731

maximum resolution (if they are not listed in JPEG sizes already):

<ul>

</ul>

For LIMITED capability devices (<code><a href="#static_android.info.supportedHardwareLevel">android.info.supportedHardwareLevel</a> == LIMITED</code>),

21739

the HAL only has to list up to the maximum video size supported by the devices.

21740

</td>

21741

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

21742

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

21743

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

21744

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

21748

<td class="entry_name

21749

entry_name_deprecated

21750

" rowspan="3">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

21751

android.scaler.availableRawMinDurations

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

21752

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

21753

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

21754

int64

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

x

n

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

21760

[system]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

21761

21762

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

21763

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

[deprecated]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

21768

</td>

21769

21770

Zhijun He

2014-01-21 18:28:30 -0800

[diff] [blame]

21771

For each available raw output size (defined in

Igor Murashkin

2014-01-13 17:22:58 -0800

[diff] [blame]

21772

<a href="#static_android.scaler.availableRawSizes">android.scaler.availableRawSizes</a>), this property lists the minimum

21773

supportable frame duration for that size.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

21777

Nanoseconds

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

21781

Deprecated. Do not use.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

21782

</td>

21783

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

21788

21789

Igor Murashkin

2012-12-05 14:49:11 -0800

[diff] [blame]

21790

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</ul>

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

21794

</tr>

21795

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

21796

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

21797

</tr>

21798

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

21799

Igor Murashkin

2014-01-13 17:22:58 -0800

[diff] [blame]

21800

Should correspond to the frame duration when only the raw stream is

21801

active.

21802

When multiple streams are configured, the minimum

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

21803

frame duration will be >= max(individual stream min

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

21804

durations)

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

21805

</td>

21806

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

21807

21808

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

21809

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

21810

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

21814

<td class="entry_name

21815

entry_name_deprecated

21816

" rowspan="1">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

21817

android.scaler.availableRawSizes

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

21818

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

21819

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

21820

int32

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

x

n x 2

Igor Murashkin

2013-07-17 16:29:34 -0700

[diff] [blame]

21826

[system as size]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

21827

21828

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

21829

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

[deprecated]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

21834

</td>

21835

21836

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

21837

The resolutions available for use with raw

21838

sensor output streams, listed as width,

21839

height

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

21846

Deprecated. Do not use.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

21847

</td>

21848

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

21856

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

21857

21858

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

21859

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

21860

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

21861

Igor Murashkin

2014-02-04 18:02:27 -0800

[diff] [blame]

21862

21863

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

21864

<td class="entry_name

21865

" rowspan="5">

Igor Murashkin

2014-02-04 18:02:27 -0800

[diff] [blame]

21866

android.scaler.availableInputOutputFormatsMap

21867

</td>

21868

21869

int32

Igor Murashkin

2014-02-04 18:02:27 -0800

[diff] [blame]

21870

Chien-Yu Chen

9e48beb

2015-03-18 18:33:17 -0700

[diff] [blame]

21871

[hidden as reprocessFormatsMap]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

21872

21873

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

21874

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

21875

Igor Murashkin

2014-02-04 18:02:27 -0800

[diff] [blame]

21876

21877

21878

</td>

21879

21880

21881

The mapping of image formats that are supported by this

21882

camera device for input streams, to their corresponding output formats.

</td>

</td>

Igor Murashkin

2014-02-04 18:02:27 -0800

[diff] [blame]

21889

</td>

21890

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2014-02-04 18:02:27 -0800

[diff] [blame]

21895

Zhijun He

2015-04-24 17:59:50 -0700

[diff] [blame]

21896

21897

<li><a href="#tag_REPROC">REPROC</a></li>

21898

</ul>

Igor Murashkin

2014-02-04 18:02:27 -0800

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

21903

<th class="th_details" colspan="6">Details</th>

Igor Murashkin

2014-02-04 18:02:27 -0800

[diff] [blame]

21904

</tr>

21905

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

21906

Igor Murashkin

2014-02-04 18:02:27 -0800

[diff] [blame]

21907

All camera devices with at least 1

Eino-Ville Talvala

2014-02-10 12:39:35 -0800

[diff] [blame]

21908

<a href="#static_android.request.maxNumInputStreams">android.request.maxNumInputStreams</a> will have at least one

Igor Murashkin

2014-02-04 18:02:27 -0800

[diff] [blame]

21909

available input format.

21910

The camera device will support the following map of formats,

Zhijun He

2015-01-15 18:17:24 -0800

[diff] [blame]

21911

if its dependent capability (<a href="#static_android.request.availableCapabilities">android.request.availableCapabilities</a>) is supported:

Igor Murashkin

2014-02-04 18:02:27 -0800

[diff] [blame]

<table>

<thead>

<tr>

<th align="left">Input Format</th>

21916

<th align="left">Output Format</th>

21917

<th align="left">Capability</th>

</tr>

</thead>

<tbody>

<tr>

Eino-Ville Talvala

2015-04-16 13:49:52 -0700

[diff] [blame]

21922

<td align="left"><a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#PRIVATE">ImageFormat#PRIVATE</a></td>

21923

<td align="left"><a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#JPEG">ImageFormat#JPEG</a></td>

Chien-Yu Chen

2015-05-12 15:13:00 -0700

[diff] [blame]

21924

<td align="left">PRIVATE_REPROCESSING</td>

Igor Murashkin

2014-02-04 18:02:27 -0800

[diff] [blame]

21925

</tr>

21926

<tr>

Eino-Ville Talvala

2015-04-16 13:49:52 -0700

[diff] [blame]

21927

<td align="left"><a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#PRIVATE">ImageFormat#PRIVATE</a></td>

21928

<td align="left"><a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#YUV_420_888">ImageFormat#YUV_420_888</a></td>

Chien-Yu Chen

2015-05-12 15:13:00 -0700

[diff] [blame]

21929

<td align="left">PRIVATE_REPROCESSING</td>

Igor Murashkin

2014-02-04 18:02:27 -0800

[diff] [blame]

21930

</tr>

21931

<tr>

Eino-Ville Talvala

2015-04-16 13:49:52 -0700

[diff] [blame]

21932

<td align="left"><a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#YUV_420_888">ImageFormat#YUV_420_888</a></td>

21933

<td align="left"><a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#JPEG">ImageFormat#JPEG</a></td>

Zhijun He

2015-01-15 18:17:24 -0800

[diff] [blame]

21934

<td align="left">YUV_REPROCESSING</td>

21935

</tr>

21936

<tr>

Eino-Ville Talvala

2015-04-16 13:49:52 -0700

[diff] [blame]

21937

<td align="left"><a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#YUV_420_888">ImageFormat#YUV_420_888</a></td>

21938

<td align="left"><a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#YUV_420_888">ImageFormat#YUV_420_888</a></td>

Zhijun He

2015-01-15 18:17:24 -0800

[diff] [blame]

21939

<td align="left">YUV_REPROCESSING</td>

Igor Murashkin

2014-02-04 18:02:27 -0800

[diff] [blame]

21940

</tr>

21941

</tbody>

21942

</table>

Eino-Ville Talvala

2015-04-16 13:49:52 -0700

[diff] [blame]

21943

PRIVATE refers to a device-internal format that is not directly application-visible. A

Chien-Yu Chen

2015-05-12 15:13:00 -0700

[diff] [blame]

21944

PRIVATE input surface can be acquired by <a href="https://developer.android.com/reference/android/media/ImageReader.html#newInstance">ImageReader#newInstance</a>

21945

with <a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#PRIVATE">ImageFormat#PRIVATE</a> as the format.

21946

For a PRIVATE_REPROCESSING-capable camera device, using the PRIVATE format as either input

Eino-Ville Talvala

2015-04-16 13:49:52 -0700

[diff] [blame]

21947

or output will never hurt maximum frame rate (i.e. <a href="https://developer.android.com/reference/android/hardware/camera2/params/StreamConfigurationMap.html#getOutputStallDuration">getOutputStallDuration(ImageFormat.PRIVATE, size)</a> is always 0),

Igor Murashkin

2014-02-04 18:02:27 -0800

[diff] [blame]

21948

Attempting to configure an input stream with output streams not

21949

listed as available in this map is not valid.

Shuzhen Wang

2018-09-27 15:50:01 -0700

[diff] [blame]

21950

Additionally, if the camera device is MONOCHROME with Y8 support, it will also support

21951

the following map of formats if its dependent capability

21952

(<a href="#static_android.request.availableCapabilities">android.request.availableCapabilities</a>) is supported:

<table>

<thead>

<tr>

<th align="left">Input Format</th>

21957

<th align="left">Output Format</th>

21958

<th align="left">Capability</th>

</tr>

</thead>

<tbody>

<tr>

<td align="left"><a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#PRIVATE">ImageFormat#PRIVATE</a></td>

21964

<td align="left"><a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#Y8">ImageFormat#Y8</a></td>

21965

<td align="left">PRIVATE_REPROCESSING</td>

21966

</tr>

21967

<tr>

21968

<td align="left"><a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#Y8">ImageFormat#Y8</a></td>

21969

<td align="left"><a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#JPEG">ImageFormat#JPEG</a></td>

21970

<td align="left">YUV_REPROCESSING</td>

21971

</tr>

21972

<tr>

21973

<td align="left"><a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#Y8">ImageFormat#Y8</a></td>

21974

<td align="left"><a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#Y8">ImageFormat#Y8</a></td>

21975

<td align="left">YUV_REPROCESSING</td>

21976

</tr>

21977

</tbody>

21978

</table>

Igor Murashkin

2014-02-04 18:02:27 -0800

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

21983

<th class="th_details" colspan="6">HAL Implementation Details</th>

Igor Murashkin

2014-02-04 18:02:27 -0800

[diff] [blame]

21984

</tr>

21985

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

21986

Jayant Chowdhary

2020-11-09 09:08:31 -0800

[diff] [blame]

21987

For the formats, see <code>system/core/libsystem/include/system/graphics-base.h</code> for a

21988

definition of the image format enumerations. The PRIVATE format refers to the

Chien-Yu Chen

9e48beb

2015-03-18 18:33:17 -0700

[diff] [blame]

21989

HAL_PIXEL_FORMAT_IMPLEMENTATION_DEFINED format. The HAL could determine

21990

the actual format by using the gralloc usage flags.

Zhijun He

2015-01-15 18:17:24 -0800

[diff] [blame]

21991

For ZSL use case in particular, the HAL could choose appropriate format (partially

21992

processed YUV or RAW based format) by checking the format and GRALLOC_USAGE_HW_CAMERA_ZSL.

21993

See camera3.h for more details.

Zhijun He

2014-04-24 11:17:25 -0700

[diff] [blame]

21994

This value is encoded as a variable-size array-of-arrays.

Igor Murashkin

2014-02-04 18:02:27 -0800

[diff] [blame]

21995

The inner array always contains <code>[format, length, ...]</code> where

21996

<code>...</code> has <code>length</code> elements. An inner array is followed by another

21997

inner array if the total metadata entry size hasn't yet been exceeded.

21998

A code sample to read/write this encoding (with a device that

Zhijun He

2015-01-15 18:17:24 -0800

[diff] [blame]

21999

supports reprocessing IMPLEMENTATION_DEFINED to YUV_420_888, and JPEG,

22000

and reprocessing YUV_420_888 to YUV_420_888 and JPEG):

Igor Murashkin

2014-02-04 18:02:27 -0800

[diff] [blame]

22001

<pre><code>// reading

22002

int32_t* contents = &entry.i32[0];

22003

for (size_t i = 0; i < entry.count; ) {

22004

int32_t format = contents[i++];

22005

int32_t length = contents[i++];

22006

int32_t output_formats[length];

22007

memcpy(&output_formats[0], &contents[i],

22008

length * sizeof(int32_t));

i += length;

}

Chien-Yu Chen

2015-05-12 15:13:00 -0700

[diff] [blame]

22012

// writing (static example, PRIVATE_REPROCESSING + YUV_REPROCESSING)

Igor Murashkin

2014-02-04 18:02:27 -0800

[diff] [blame]

22013

int32_t[] contents = {

Zhijun He

2015-01-15 18:17:24 -0800

[diff] [blame]

22014

IMPLEMENTATION_DEFINED, 2, YUV_420_888, BLOB,

22015

YUV_420_888, 2, YUV_420_888, BLOB,

Igor Murashkin

2014-02-04 18:02:27 -0800

[diff] [blame]

22016

};

22017

update_camera_metadata_entry(metadata, index, &contents[0],

22018

sizeof(contents)/sizeof(contents[0]), &updated_entry);

22019

</code></pre>

22020

If the HAL claims to support any of the capabilities listed in the

22021

above details, then it must also support all the input-output

22022

combinations listed for that capability. It can optionally support

22023

additional formats if it so chooses.

Igor Murashkin

2014-02-04 18:02:27 -0800

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

22027

Igor Murashkin

2014-02-04 18:02:27 -0800

[diff] [blame]

22028

22029

Igor Murashkin

2014-02-07 14:31:31 -0800

[diff] [blame]

22030

22031

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

22032

<td class="entry_name

22033

" rowspan="5">

Igor Murashkin

2014-02-07 14:31:31 -0800

[diff] [blame]

22034

android.scaler.availableStreamConfigurations

</td>

int32

x

n x 4

Yin-Chia Yeh

2016-04-02 16:30:30 -0700

[diff] [blame]

22043

[ndk_public as streamConfiguration]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

22044

22045

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

22046

[legacy]

22047

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

22048

Igor Murashkin

2014-02-07 14:31:31 -0800

[diff] [blame]

22049

22050

22051

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

22052

OUTPUT (v3.2)

Igor Murashkin

2014-02-07 14:31:31 -0800

[diff] [blame]

22053

</li>

22054

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

22055

INPUT (v3.2)

Igor Murashkin

2014-02-07 14:31:31 -0800

[diff] [blame]

</li>

</ul>

</td>

22060

22061

22062

The available stream configurations that this

22063

camera device supports

22064

(i.e. format, width, height, output/input stream).

</td>

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2014-02-07 14:31:31 -0800

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

22082

<th class="th_details" colspan="6">Details</th>

Igor Murashkin

2014-02-07 14:31:31 -0800

[diff] [blame]

22083

</tr>

22084

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

22085

Igor Murashkin

2014-02-07 14:31:31 -0800

[diff] [blame]

22086

The configurations are listed as <code>(format, width, height, input?)</code>

22087

tuples.

Igor Murashkin

2014-02-07 14:31:31 -0800

[diff] [blame]

22088

For a given use case, the actual maximum supported resolution

22089

may be lower than what is listed here, depending on the destination

22090

Surface for the image data. For example, for recording video,

22091

the video encoder chosen may have a maximum size limit (e.g. 1080p)

22092

smaller than what the camera (e.g. maximum resolution is 3264x2448)

22093

can provide.

22094

Please reference the documentation for the image data destination to

22095

check if it limits the maximum size for image data.

22096

Not all output formats may be supported in a configuration with

22097

an input stream of a particular format. For more details, see

22098

<a href="#static_android.scaler.availableInputOutputFormatsMap">android.scaler.availableInputOutputFormatsMap</a>.

Shuzhen Wang

2021-05-28 10:08:34 -0700

[diff] [blame]

22099

For applications targeting SDK version older than 31, the following table

22100

describes the minimum required output stream configurations based on the hardware level

22101

(<a href="#static_android.info.supportedHardwareLevel">android.info.supportedHardwareLevel</a>):

Igor Murashkin

2014-02-07 14:31:31 -0800

[diff] [blame]

<table>

<thead>

<tr>

<th align="center">Format</th>

22106

22107

<th align="center">Hardware Level</th>

22108

<th align="center">Notes</th>

</tr>

</thead>

<tbody>

<tr>

<td align="center"><a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a></td>

</tr>

<tr>

</tr>

<tr>

</tr>

<tr>

</tr>

<tr>

</tr>

<tr>

<td align="center">all output sizes available for JPEG</td>

</tr>

<tr>

<td align="center">all output sizes available for JPEG, up to the maximum video size</td>

22151

<td align="center">LIMITED</td>

</tr>

<tr>

<td align="center">IMPLEMENTATION_DEFINED</td>

</tr>

</tbody>

</table>

Shuzhen Wang

2021-05-28 10:08:34 -0700

[diff] [blame]

22162

For applications targeting SDK version 31 or newer, if the mobile device declares to be

Shuzhen Wang

2021-12-07 03:02:47 +0000

[diff] [blame]

22163

media performance class 12 or higher by setting

Shuzhen Wang

2022-06-13 09:42:11 -0700

[diff] [blame]

22164

<a href="https://developer.android.com/reference/android/os/Build.VERSION.html#MEDIA_PERFORMANCE_CLASS">VERSION#MEDIA_PERFORMANCE_CLASS</a> to be 31 or larger,

Shuzhen Wang

2021-05-28 10:08:34 -0700

[diff] [blame]

22165

the primary camera devices (first rear/front camera in the camera ID list) will not

22166

support JPEG sizes smaller than 1080p. If the application configures a JPEG stream

22167

smaller than 1080p, the camera device will round up the JPEG image size to at least

22168

1080p. The requirements for IMPLEMENTATION_DEFINED and YUV_420_888 stay the same.

22169

This new minimum required output stream configurations are illustrated by the table below:

Shuzhen Wang

2d329d4

2021-04-09 11:40:27 -0700

[diff] [blame]

<table>

<thead>

<tr>

<th align="center">Format</th>

22174

22175

<th align="center">Hardware Level</th>

22176

<th align="center">Notes</th>

</tr>

</thead>

<tbody>

<tr>

<td align="center"><a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a></td>

</tr>

<tr>

</tr>

<tr>

<td align="center"><a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a></td>

</tr>

<tr>

</tr>

<tr>

</tr>

<tr>

</tr>

<tr>

</tr>

<tr>

<td align="center">all output sizes available for FULL hardware level, up to the maximum video size</td>

22225

<td align="center">LIMITED</td>

</tr>

<tr>

<td align="center">IMPLEMENTATION_DEFINED</td>

</tr>

</tbody>

</table>

Shuzhen Wang

2021-05-28 10:08:34 -0700

[diff] [blame]

22236

For applications targeting SDK version 31 or newer, if the mobile device doesn't declare

Shuzhen Wang

2021-12-07 03:02:47 +0000

[diff] [blame]

22237

to be media performance class 12 or better by setting

Shuzhen Wang

2022-06-13 09:42:11 -0700

[diff] [blame]

22238

<a href="https://developer.android.com/reference/android/os/Build.VERSION.html#MEDIA_PERFORMANCE_CLASS">VERSION#MEDIA_PERFORMANCE_CLASS</a> to be 31 or larger,

Shuzhen Wang

2021-12-07 03:02:47 +0000

[diff] [blame]

22239

or if the camera device isn't a primary rear/front camera, the minimum required output

22240

stream configurations are the same as for applications targeting SDK version older than

22241

31.

Igor Murashkin

2014-02-07 14:31:31 -0800

[diff] [blame]

22242

Refer to <a href="#static_android.request.availableCapabilities">android.request.availableCapabilities</a> for additional

22243

mandatory stream configurations on a per-capability basis.

Yin-Chia Yeh

6023126

2019-01-23 15:25:41 -0800

[diff] [blame]

22244

Exception on 176x144 (QCIF) resolution: camera devices usually have a fixed capability for

22245

downscaling from larger resolution to smaller, and the QCIF resolution sometimes is not

22246

fully supported due to this limitation on devices with high-resolution image sensors.

22247

Therefore, trying to configure a QCIF resolution stream together with any other

22248

stream larger than 1920x1080 resolution (either width or height) might not be supported,

22249

and capture session creation will fail if it is not.

Igor Murashkin

2014-02-07 14:31:31 -0800

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

22254

<th class="th_details" colspan="6">HAL Implementation Details</th>

Igor Murashkin

2014-02-07 14:31:31 -0800

[diff] [blame]

22255

</tr>

22256

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

22257

Igor Murashkin

2014-02-07 14:31:31 -0800

[diff] [blame]

22258

It is recommended (but not mandatory) to also include half/quarter

22259

of sensor maximum resolution for JPEG formats (regardless of hardware

22260

level).

22261

(The following is a rewording of the above required table):

Zhijun He

5a1276a

2014-06-02 16:46:03 -0700

[diff] [blame]

22262

For JPEG format, the sizes may be restricted by below conditions:

22263

<ul>

22264

<li>The HAL may choose the aspect ratio of each Jpeg size to be one of well known ones

22265

(e.g. 4:3, 16:9, 3:2 etc.). If the sensor maximum resolution

22266

(defined by <a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a>) has an aspect ratio other than these,

22267

it does not have to be included in the supported JPEG sizes.</li>

22268

<li>Some hardware JPEG encoders may have pixel boundary alignment requirements, such as

22269

the dimensions being a multiple of 16.</li>

22270

</ul>

22271

Therefore, the maximum JPEG size may be smaller than sensor maximum resolution.

22272

However, the largest JPEG size must be as close as possible to the sensor maximum

22273

resolution given above constraints. It is required that after aspect ratio adjustments,

22274

additional size reduction due to other issues must be less than 3% in area. For example,

22275

if the sensor maximum resolution is 3280x2464, if the maximum JPEG size has aspect

22276

ratio 4:3, the JPEG encoder alignment requirement is 16, the maximum JPEG size will be

22277

3264x2448.

Igor Murashkin

2014-02-07 14:31:31 -0800

[diff] [blame]

22278

For FULL capability devices (<code><a href="#static_android.info.supportedHardwareLevel">android.info.supportedHardwareLevel</a> == FULL</code>),

22279

the HAL must include all YUV_420_888 sizes that have JPEG sizes listed

22280

here as output streams.

22281

It must also include each below resolution if it is smaller than or

Shuzhen Wang

2021-05-28 10:08:34 -0700

[diff] [blame]

22282

equal to the sensor maximum resolution (for both YUV_420_888 and JPEG

Igor Murashkin

2014-02-07 14:31:31 -0800

[diff] [blame]

22283

formats), as output streams:

<ul>

</ul>

Shuzhen Wang

2021-12-07 03:02:47 +0000

[diff] [blame]

22290

Note that for primary cameras (first rear/front facing camera in the camera ID list)

Shuzhen Wang

2022-06-13 09:42:11 -0700

[diff] [blame]

22291

on a device with <a href="https://developer.android.com/reference/android/os/Build.VERSION.html#MEDIA_PERFORMANCE_CLASS">VERSION#MEDIA_PERFORMANCE_CLASS</a> set to

Shuzhen Wang

2021-12-07 03:02:47 +0000

[diff] [blame]

22292

31 or larger, camera framework filters out JPEG sizes smaller than 1080p depending on

Shuzhen Wang

2021-05-28 10:08:34 -0700

[diff] [blame]

22293

applications' targetSdkLevel. The camera HAL must still support the smaller JPEG sizes

Shuzhen Wang

2021-12-07 03:02:47 +0000

[diff] [blame]

22294

to maintain backward compatibility.

Igor Murashkin

2014-02-07 14:31:31 -0800

[diff] [blame]

22295

For LIMITED capability devices

22296

(<code><a href="#static_android.info.supportedHardwareLevel">android.info.supportedHardwareLevel</a> == LIMITED</code>),

22297

the HAL only has to list up to the maximum video size

22298

supported by the device.

22299

Regardless of hardware level, every output resolution available for

22300

YUV_420_888 must also be available for IMPLEMENTATION_DEFINED.

Shuzhen Wang

2022-05-03 11:01:26 -0700

[diff] [blame]

22301

This supersedes the following fields, which are now deprecated:

Igor Murashkin

2014-02-07 14:31:31 -0800

[diff] [blame]

22302

<ul>

22303

<li>availableFormats</li>

22304

<li>available[Processed,Raw,Jpeg]Sizes</li>

</ul>

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

22309

Igor Murashkin

2014-02-07 14:31:31 -0800

[diff] [blame]

22310

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

22314

<td class="entry_name

22315

" rowspan="3">

Igor Murashkin

2014-02-07 14:31:31 -0800

[diff] [blame]

22316

android.scaler.availableMinFrameDurations

</td>

int64

x

4 x n

Yin-Chia Yeh

2016-04-02 16:30:30 -0700

[diff] [blame]

22325

[ndk_public as streamConfigurationDuration]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

22326

22327

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

22328

[legacy]

22329

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

22330

Igor Murashkin

2014-02-07 14:31:31 -0800

[diff] [blame]

22331

22332

22333

</td>

22334

22335

22336

This lists the minimum frame duration for each

22337

format/size combination.

</td>

(format, width, height, ns) x n

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2014-02-07 14:31:31 -0800

[diff] [blame]

22351

22352

Zhijun He

2014-05-21 17:51:05 -0700

[diff] [blame]

22353

Igor Murashkin

2014-02-07 14:31:31 -0800

[diff] [blame]

</ul>

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

22359

<th class="th_details" colspan="6">Details</th>

Igor Murashkin

2014-02-07 14:31:31 -0800

[diff] [blame]

22360

</tr>

22361

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

22362

Igor Murashkin

2014-02-07 14:31:31 -0800

[diff] [blame]

22363

This should correspond to the frame duration when only that

22364

stream is active, with all processing (typically in android.*.mode)

22365

set to either OFF or FAST.

22366

When multiple streams are used in a request, the minimum frame

22367

duration will be max(individual stream min durations).

Igor Murashkin

2014-02-07 14:31:31 -0800

[diff] [blame]

22368

See <a href="#controls_android.sensor.frameDuration">android.sensor.frameDuration</a> and

22369

<a href="#static_android.scaler.availableStallDurations">android.scaler.availableStallDurations</a> for more details about

22370

calculating the max frame rate.

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

22375

Igor Murashkin

2014-02-07 14:31:31 -0800

[diff] [blame]

22376

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

22380

<td class="entry_name

22381

" rowspan="5">

Igor Murashkin

2014-02-07 14:31:31 -0800

[diff] [blame]

22382

android.scaler.availableStallDurations

</td>

int64

x

4 x n

Yin-Chia Yeh

2016-04-02 16:30:30 -0700

[diff] [blame]

22391

[ndk_public as streamConfigurationDuration]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

22392

22393

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

22394

[legacy]

22395

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

22396

Igor Murashkin

2014-02-07 14:31:31 -0800

[diff] [blame]

22397

22398

22399

</td>

22400

22401

22402

This lists the maximum stall duration for each

Zhijun He

2015-04-24 17:59:50 -0700

[diff] [blame]

22403

output format/size combination.

Igor Murashkin

2014-02-07 14:31:31 -0800

[diff] [blame]

</td>

(format, width, height, ns) x n

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2014-02-07 14:31:31 -0800

[diff] [blame]

22417

22418

Zhijun He

2014-05-21 17:51:05 -0700

[diff] [blame]

22419

Igor Murashkin

2014-02-07 14:31:31 -0800

[diff] [blame]

</ul>

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

22425

<th class="th_details" colspan="6">Details</th>

Igor Murashkin

2014-02-07 14:31:31 -0800

[diff] [blame]

22426

</tr>

22427

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

22428

Igor Murashkin

2014-02-07 14:31:31 -0800

[diff] [blame]

22429

A stall duration is how much extra time would get added

22430

to the normal minimum frame duration for a repeating request

22431

that has streams with non-zero stall.

22432

For example, consider JPEG captures which have the following

22433

characteristics:

22434

<ul>

22435

<li>JPEG streams act like processed YUV streams in requests for which

22436

they are not included; in requests in which they are directly

22437

referenced, they act as JPEG streams. This is because supporting a

22438

JPEG stream requires the underlying YUV data to always be ready for

22439

use by a JPEG encoder, but the encoder will only be used (and impact

22440

frame duration) on requests that actually reference a JPEG stream.</li>

22441

<li>The JPEG processor can run concurrently to the rest of the camera

22442

pipeline, but cannot process more than 1 capture at a time.</li>

22443

</ul>

22444

In other words, using a repeating YUV request would result

22445

in a steady frame rate (let's say it's 30 FPS). If a single

22446

JPEG request is submitted periodically, the frame rate will stay

22447

at 30 FPS (as long as we wait for the previous JPEG to return each

22448

time). If we try to submit a repeating YUV + JPEG request, then

22449

the frame rate will drop from 30 FPS.

22450

In general, submitting a new request with a non-0 stall time

22451

stream will not cause a frame rate drop unless there are still

22452

outstanding buffers for that stream from previous requests.

22453

Submitting a repeating request with streams (call this <code>S</code>)

22454

is the same as setting the minimum frame duration from

22455

the normal minimum frame duration corresponding to <code>S</code>, added with

22456

the maximum stall duration for <code>S</code>.

22457

If interleaving requests with and without a stall duration,

22458

a request will stall by the maximum of the remaining times

22459

for each can-stall stream with outstanding buffers.

22460

This means that a stalling request will not have an exposure start

22461

until the stall has completed.

22462

This should correspond to the stall duration when only that stream is

22463

active, with all processing (typically in android.*.mode) set to FAST

22464

or OFF. Setting any of the processing modes to HIGH_QUALITY

22465

effectively results in an indeterminate stall duration for all

22466

streams in a request (the regular stall calculation rules are

22467

ignored).

22468

The following formats may always have a stall duration:

22469

<ul>

Eino-Ville Talvala

2015-04-16 13:49:52 -0700

[diff] [blame]

22470

<li><a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#JPEG">ImageFormat#JPEG</a></li>

22471

<li><a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#RAW_SENSOR">ImageFormat#RAW_SENSOR</a></li>

Igor Murashkin

2014-02-07 14:31:31 -0800

[diff] [blame]

22472

</ul>

22473

The following formats will never have a stall duration:

22474

<ul>

Eino-Ville Talvala

2015-04-16 13:49:52 -0700

[diff] [blame]

22475

<li><a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#YUV_420_888">ImageFormat#YUV_420_888</a></li>

22476

<li><a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#RAW10">ImageFormat#RAW10</a></li>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

22477

<li><a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#RAW12">ImageFormat#RAW12</a></li>

Shuzhen Wang

2018-09-27 15:50:01 -0700

[diff] [blame]

22478

<li><a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#Y8">ImageFormat#Y8</a></li>

Igor Murashkin

2014-02-07 14:31:31 -0800

[diff] [blame]

22479

</ul>

22480

All other formats may or may not have an allowed stall duration on

Eino-Ville Talvala

2014-02-10 12:39:35 -0800

[diff] [blame]

22481

a per-capability basis; refer to <a href="#static_android.request.availableCapabilities">android.request.availableCapabilities</a>

Igor Murashkin

2014-02-07 14:31:31 -0800

[diff] [blame]

22482

for more details.

22483

See <a href="#controls_android.sensor.frameDuration">android.sensor.frameDuration</a> for more information about

22484

calculating the max frame rate (absent stalls).

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

22489

<th class="th_details" colspan="6">HAL Implementation Details</th>

Igor Murashkin

2014-02-07 14:31:31 -0800

[diff] [blame]

22490

</tr>

22491

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

22492

Igor Murashkin

2014-02-07 14:31:31 -0800

[diff] [blame]

22493

If possible, it is recommended that all non-JPEG formats

Yin-Chia Yeh

f9801f4

2015-03-20 16:53:19 -0700

[diff] [blame]

22494

(such as RAW16) should not have a stall duration. RAW10, RAW12, RAW_OPAQUE

22495

and IMPLEMENTATION_DEFINED must not have stall durations.

Igor Murashkin

2014-02-07 14:31:31 -0800

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

22499

Igor Murashkin

2014-02-07 14:31:31 -0800

[diff] [blame]

22500

22501

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

22502

22503

22504

<td class="entry_name

22505

" rowspan="5">

22506

android.scaler.streamConfigurationMap

</td>

int32

Yin-Chia Yeh

2016-04-02 16:30:30 -0700

[diff] [blame]

22511

[java_public as streamConfigurationMap]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

[synthetic]

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

22515

[legacy]

22516

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

</td>

22521

22522

22523

The available stream configurations that this

22524

camera device supports; also includes the minimum frame durations

22525

and the stall durations for each format/size combination.

</td>

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

22543

<th class="th_details" colspan="6">Details</th>

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

22544

</tr>

22545

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

22546

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

22547

All camera devices will support sensor maximum resolution (defined by

22548

<a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a>) for the JPEG format.

22549

For a given use case, the actual maximum supported resolution

22550

may be lower than what is listed here, depending on the destination

22551

Surface for the image data. For example, for recording video,

22552

the video encoder chosen may have a maximum size limit (e.g. 1080p)

22553

smaller than what the camera (e.g. maximum resolution is 3264x2448)

22554

can provide.

22555

Please reference the documentation for the image data destination to

22556

check if it limits the maximum size for image data.

Shuzhen Wang

2022-06-13 09:42:11 -0700

[diff] [blame]

22557

For applications targeting SDK version older than 31, the following table

22558

describes the minimum required output stream configurations based on the

22559

hardware level (<a href="#static_android.info.supportedHardwareLevel">android.info.supportedHardwareLevel</a>):

22560

Format | Size | Hardware Level | Notes

22561

:-------------------------------------------------:|:--------------------------------------------:|:--------------:|:--------------:

22562

<a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#JPEG">ImageFormat#JPEG</a> | <a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a> (*1) | Any |

22563

<a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#JPEG">ImageFormat#JPEG</a> | 1920x1080 (1080p) | Any | if 1080p <= activeArraySize

22564

<a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#JPEG">ImageFormat#JPEG</a> | 1280x720 (720p) | Any | if 720p <= activeArraySize

22565

<a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#JPEG">ImageFormat#JPEG</a> | 640x480 (480p) | Any | if 480p <= activeArraySize

22566

<a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#JPEG">ImageFormat#JPEG</a> | 320x240 (240p) | Any | if 240p <= activeArraySize

22567

<a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#YUV_420_888">ImageFormat#YUV_420_888</a> | all output sizes available for JPEG | FULL |

22568

<a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#YUV_420_888">ImageFormat#YUV_420_888</a> | all output sizes available for JPEG, up to the maximum video size | LIMITED |

22569

<a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#PRIVATE">ImageFormat#PRIVATE</a> | same as YUV_420_888 | Any |

22570

For applications targeting SDK version 31 or newer, if the mobile device declares to be

22571

media performance class 12 or higher by setting

22572

<a href="https://developer.android.com/reference/android/os/Build.VERSION.html#MEDIA_PERFORMANCE_CLASS">VERSION#MEDIA_PERFORMANCE_CLASS</a> to be 31 or larger,

22573

the primary camera devices (first rear/front camera in the camera ID list) will not

22574

support JPEG sizes smaller than 1080p. If the application configures a JPEG stream

22575

smaller than 1080p, the camera device will round up the JPEG image size to at least

22576

1080p. The requirements for IMPLEMENTATION_DEFINED and YUV_420_888 stay the same.

22577

This new minimum required output stream configurations are illustrated by the table below:

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

<table>

<thead>

<tr>

<th align="center">Format</th>

22582

22583

<th align="center">Hardware Level</th>

22584

<th align="center">Notes</th>

</tr>

</thead>

<tbody>

<tr>

Eino-Ville Talvala

2015-04-16 13:49:52 -0700

[diff] [blame]

22589

<td align="center"><a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#JPEG">ImageFormat#JPEG</a></td>

Yin-Chia Yeh

fc57a58

2015-07-08 14:07:39 -0700

[diff] [blame]

22590

<td align="center"><a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a> (*1)</td>

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

</tr>

<tr>

Eino-Ville Talvala

2015-04-16 13:49:52 -0700

[diff] [blame]

22595

<td align="center"><a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#JPEG">ImageFormat#JPEG</a></td>

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

</tr>

<tr>

Eino-Ville Talvala

2015-04-16 13:49:52 -0700

[diff] [blame]

22601

<td align="center"><a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#YUV_420_888">ImageFormat#YUV_420_888</a></td>

Shuzhen Wang

2022-06-13 09:42:11 -0700

[diff] [blame]

22602

<td align="center"><a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a></td>

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

</tr>

<tr>

Eino-Ville Talvala

2015-04-16 13:49:52 -0700

[diff] [blame]

22607

<td align="center"><a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#YUV_420_888">ImageFormat#YUV_420_888</a></td>

Shuzhen Wang

2022-06-13 09:42:11 -0700

[diff] [blame]

</tr>

<tr>

<td align="center"><a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#YUV_420_888">ImageFormat#YUV_420_888</a></td>

</tr>

<tr>

<td align="center"><a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#YUV_420_888">ImageFormat#YUV_420_888</a></td>

</tr>

<tr>

<td align="center"><a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#YUV_420_888">ImageFormat#YUV_420_888</a></td>

</tr>

<tr>

<td align="center"><a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#YUV_420_888">ImageFormat#YUV_420_888</a></td>

22632

<td align="center">all output sizes available for FULL hardware level, up to the maximum video size</td>

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

22633

<td align="center">LIMITED</td>

22634

22635

</tr>

22636

<tr>

Eino-Ville Talvala

2015-04-16 13:49:52 -0700

[diff] [blame]

22637

<td align="center"><a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#PRIVATE">ImageFormat#PRIVATE</a></td>

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

</tr>

</tbody>

</table>

Shuzhen Wang

2022-06-13 09:42:11 -0700

[diff] [blame]

22644

For applications targeting SDK version 31 or newer, if the mobile device doesn't declare

22645

to be media performance class 12 or better by setting

22646

<a href="https://developer.android.com/reference/android/os/Build.VERSION.html#MEDIA_PERFORMANCE_CLASS">VERSION#MEDIA_PERFORMANCE_CLASS</a> to be 31 or larger,

22647

or if the camera device isn't a primary rear/front camera, the minimum required output

22648

stream configurations are the same as for applications targeting SDK version older than

22649

31.

Eino-Ville Talvala

2015-04-16 13:49:52 -0700

[diff] [blame]

22650

Refer to <a href="#static_android.request.availableCapabilities">android.request.availableCapabilities</a> and <a href="https://developer.android.com/reference/android/hardware/camera2/CameraDevice.html#createCaptureSession">CameraDevice#createCaptureSession</a> for additional mandatory

22651

stream configurations on a per-capability basis.

Yin-Chia Yeh

fc57a58

2015-07-08 14:07:39 -0700

[diff] [blame]

22652

*1: For JPEG format, the sizes may be restricted by below conditions:

22653

<ul>

22654

<li>The HAL may choose the aspect ratio of each Jpeg size to be one of well known ones

22655

(e.g. 4:3, 16:9, 3:2 etc.). If the sensor maximum resolution

22656

(defined by <a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a>) has an aspect ratio other than these,

22657

it does not have to be included in the supported JPEG sizes.</li>

22658

<li>Some hardware JPEG encoders may have pixel boundary alignment requirements, such as

22659

the dimensions being a multiple of 16.

22660

Therefore, the maximum JPEG size may be smaller than sensor maximum resolution.

22661

However, the largest JPEG size will be as close as possible to the sensor maximum

22662

resolution given above constraints. It is required that after aspect ratio adjustments,

22663

additional size reduction due to other issues must be less than 3% in area. For example,

22664

if the sensor maximum resolution is 3280x2464, if the maximum JPEG size has aspect

22665

ratio 4:3, and the JPEG encoder alignment requirement is 16, the maximum JPEG size will be

22666

3264x2448.</li>

22667

</ul>

Yin-Chia Yeh

6023126

2019-01-23 15:25:41 -0800

[diff] [blame]

22668

Exception on 176x144 (QCIF) resolution: camera devices usually have a fixed capability on

22669

downscaling from larger resolution to smaller ones, and the QCIF resolution can sometimes

22670

not be fully supported due to this limitation on devices with high-resolution image

22671

sensors. Therefore, trying to configure a QCIF resolution stream together with any other

22672

stream larger than 1920x1080 resolution (either width or height) might not be supported,

22673

and capture session creation will fail if it is not.

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

22678

<th class="th_details" colspan="6">HAL Implementation Details</th>

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

22679

</tr>

22680

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

22681

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

22682

Do not set this property directly

22683

(it is synthetic and will not be available at the HAL layer);

22684

set the <a href="#static_android.scaler.availableStreamConfigurations">android.scaler.availableStreamConfigurations</a> instead.

Igor Murashkin

2014-05-14 17:30:49 -0700

[diff] [blame]

22685

Not all output formats may be supported in a configuration with

22686

an input stream of a particular format. For more details, see

22687

<a href="#static_android.scaler.availableInputOutputFormatsMap">android.scaler.availableInputOutputFormatsMap</a>.

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

22688

It is recommended (but not mandatory) to also include half/quarter

22689

of sensor maximum resolution for JPEG formats (regardless of hardware

22690

level).

22691

(The following is a rewording of the above required table):

22692

The HAL must include sensor maximum resolution (defined by

22693

<a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a>).

22694

For FULL capability devices (<code><a href="#static_android.info.supportedHardwareLevel">android.info.supportedHardwareLevel</a> == FULL</code>),

22695

the HAL must include all YUV_420_888 sizes that have JPEG sizes listed

22696

here as output streams.

22697

It must also include each below resolution if it is smaller than or

22698

equal to the sensor maximum resolution (for both YUV_420_888 and JPEG

22699

formats), as output streams:

<ul>

</ul>

Shuzhen Wang

2022-06-13 09:42:11 -0700

[diff] [blame]

22706

Note that for Performance Class 12 or higher primary cameras (first rear/front facing

22707

camera in the camera ID list), camera framework filters out JPEG sizes smaller than

22708

1080p depending on applications' targetSdkLevel. The camera HAL must still support the

22709

smaller JPEG sizes to maintain backward comopatibility.

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

22710

For LIMITED capability devices

22711

(<code><a href="#static_android.info.supportedHardwareLevel">android.info.supportedHardwareLevel</a> == LIMITED</code>),

22712

the HAL only has to list up to the maximum video size

22713

supported by the device.

22714

Regardless of hardware level, every output resolution available for

22715

YUV_420_888 must also be available for IMPLEMENTATION_DEFINED.

Shuzhen Wang

2022-05-03 11:01:26 -0700

[diff] [blame]

22716

This supersedes the following fields, which are now deprecated:

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

22717

<ul>

22718

<li>availableFormats</li>

22719

<li>available[Processed,Raw,Jpeg]Sizes</li>

</ul>

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

22724

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

22725

22726

Zhijun He

2014-05-21 15:29:07 -0700

[diff] [blame]

22727

22728

22729

<td class="entry_name

Shuzhen Wang

2019-11-07 15:59:22 -0800

[diff] [blame]

22730

" rowspan="5">

Zhijun He

2014-05-21 15:29:07 -0700

[diff] [blame]

22731

android.scaler.croppingType

</td>

byte

[public]

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

22739

[legacy]

22740

Zhijun He

2014-05-21 15:29:07 -0700

[diff] [blame]

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

22745

CENTER_ONLY (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

22746

The camera device only supports centered crop regions.

Zhijun He

2014-05-21 15:29:07 -0700

[diff] [blame]

22747

</li>

22748

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

22749

FREEFORM (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

22750

The camera device supports arbitrarily chosen crop regions.

Zhijun He

2014-05-21 15:29:07 -0700

[diff] [blame]

</li>

</ul>

</td>

22755

22756

22757

The crop type that this camera device supports.

</td>

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Zhijun He

2014-05-21 15:29:07 -0700

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

22775

<th class="th_details" colspan="6">Details</th>

Zhijun He

2014-05-21 15:29:07 -0700

[diff] [blame]

22776

</tr>

22777

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

22778

Zhijun He

2014-05-21 15:29:07 -0700

[diff] [blame]

22779

When passing a non-centered crop region (<a href="#controls_android.scaler.cropRegion">android.scaler.cropRegion</a>) to a camera

22780

device that only supports CENTER_ONLY cropping, the camera device will move the

22781

crop region to the center of the sensor active array (<a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a>)

22782

and keep the crop region width and height unchanged. The camera device will return the

22783

final used crop region in metadata result <a href="#controls_android.scaler.cropRegion">android.scaler.cropRegion</a>.

22784

Camera devices that support FREEFORM cropping will support any crop region that

22785

is inside of the active array. The camera device will apply the same crop region and

22786

return the final used crop region in capture result metadata <a href="#controls_android.scaler.cropRegion">android.scaler.cropRegion</a>.

Shuzhen Wang

2019-11-07 15:59:22 -0800

[diff] [blame]

22787

Starting from API level 30,

22788

<ul>

22789

<li>If the camera device supports FREEFORM cropping, in order to do FREEFORM cropping, the

22790

application must set <a href="#controls_android.control.zoomRatio">android.control.zoomRatio</a> to 1.0, and use <a href="#controls_android.scaler.cropRegion">android.scaler.cropRegion</a>

22791

for zoom.</li>

22792

<li>To do CENTER_ONLY zoom, the application has below 2 options:<ol>

22793

<li>Set <a href="#controls_android.control.zoomRatio">android.control.zoomRatio</a> to 1.0; adjust zoom by <a href="#controls_android.scaler.cropRegion">android.scaler.cropRegion</a>.</li>

22794

<li>Adjust zoom by <a href="#controls_android.control.zoomRatio">android.control.zoomRatio</a>; use <a href="#controls_android.scaler.cropRegion">android.scaler.cropRegion</a> to crop

22795

the field of view vertically (letterboxing) or horizontally (pillarboxing), but not

windowboxing.</li>

</ol>

</li>

<li>Setting <a href="#controls_android.control.zoomRatio">android.control.zoomRatio</a> to values different than 1.0 and

Shuzhen Wang

0ca6316

2020-11-30 20:11:27 -0800

[diff] [blame]

22800

<a href="#controls_android.scaler.cropRegion">android.scaler.cropRegion</a> to be windowboxing at the same time are not supported. In this

22801

case, the camera framework will override the <a href="#controls_android.scaler.cropRegion">android.scaler.cropRegion</a> to be the active

22802

array.</li>

Shuzhen Wang

2019-11-07 15:59:22 -0800

[diff] [blame]

22803

</ul>

Eino-Ville Talvala

593b821

2015-06-30 16:33:57 -0700

[diff] [blame]

22804

LEGACY capability devices will only support CENTER_ONLY cropping.

Zhijun He

2014-05-21 15:29:07 -0700

[diff] [blame]

</td>

</tr>

Shuzhen Wang

2019-11-07 15:59:22 -0800

[diff] [blame]

22808

22809

<th class="th_details" colspan="6">HAL Implementation Details</th>

</tr>

If the HAL supports <a href="#controls_android.control.zoomRatio">android.control.zoomRatio</a>, this tag must be set to CENTER_ONLY.

22814

</td>

22815

</tr>

Zhijun He

2014-05-21 15:29:07 -0700

[diff] [blame]

22816

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

22817

Zhijun He

2014-05-21 15:29:07 -0700

[diff] [blame]

22818

22819

Emilian Peev

2018-09-18 14:01:55 +0100

[diff] [blame]

22820

22821

22822

<td class="entry_name

22823

" rowspan="5">

22824

android.scaler.availableRecommendedStreamConfigurations

</td>

int32

x

n x 5

[ndk_public as recommendedStreamConfiguration]

<li>

PREVIEW (v3.4)

0x0

Preview must only include non-stalling processed stream configurations with

Emilian Peev

2019-03-12 18:11:30 -0700

[diff] [blame]

22844

output formats like

22845

<a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#YUV_420_888">ImageFormat#YUV_420_888</a>,

22846

<a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#PRIVATE">ImageFormat#PRIVATE</a>, etc.

Emilian Peev

2018-09-18 14:01:55 +0100

[diff] [blame]

</li>

<li>

RECORD (v3.4)

0x1

Video record must include stream configurations that match the advertised

22852

supported media profiles <a href="https://developer.android.com/reference/android/media/CamcorderProfile.html">CamcorderProfile</a> with

22853

IMPLEMENTATION_DEFINED format.

22854

</li>

22855

<li>

22856

VIDEO_SNAPSHOT (v3.4)

22857

0x2

22858

Video snapshot must include stream configurations at least as big as

Emilian Peev

2019-03-12 18:11:30 -0700

[diff] [blame]

22859

the maximum RECORD resolutions and only with

22860

<a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#JPEG">JPEG output format</a>.

22861

Additionally the configurations shouldn't cause preview glitches and also be able to

22862

run at 30 fps.

Emilian Peev

2018-09-18 14:01:55 +0100

[diff] [blame]

</li>

<li>

SNAPSHOT (v3.4)

0x3

Recommended snapshot stream configurations must include at least one with

Emilian Peev

2019-03-12 18:11:30 -0700

[diff] [blame]

22868

size close to <a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a> and

22869

<a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#JPEG">JPEG output format</a>.

22870

Taking into account restrictions on aspect ratio, alignment etc. the area of the

22871

maximum suggested size shouldn’t be less than 97% of the sensor array size area.

Emilian Peev

2018-09-18 14:01:55 +0100

[diff] [blame]

</li>

<li>

ZSL (v3.4)

0x4

If supported, recommended input stream configurations must only be advertised with

22877

ZSL along with other processed and/or stalling output formats.

</li>

<li>

RAW (v3.4)

0x5

If supported, recommended raw stream configurations must only include RAW based

22883

output formats.

22884

</li>

22885

<li>

Emilian Peev

2019-03-12 18:11:30 -0700

[diff] [blame]

22886

LOW_LATENCY_SNAPSHOT (v3.4)

Emilian Peev

2018-09-18 14:01:55 +0100

[diff] [blame]

22887

0x6

Emilian Peev

2019-03-12 18:11:30 -0700

[diff] [blame]

22888

If supported, the recommended low latency stream configurations must have

22889

end-to-end latency that does not exceed 200 ms. under standard operating conditions

22890

(reasonable light levels, not loaded system) and using template

22891

TEMPLATE_STILL_CAPTURE. This is primarily for listing configurations for the

22892

<a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#JPEG">JPEG output format</a>

22893

however other supported output formats can be added as well.

</li>

<li>

PUBLIC_END (v3.4)

0x7

Emilian Peev

2018-09-18 14:01:55 +0100

[diff] [blame]

22898

</li>

22899

<li>

Emilian Peev

2021-11-12 18:07:39 -0800

[diff] [blame]

22900

10BIT_OUTPUT (v3.8)

22901

0x8

22902

If supported, the recommended 10-bit output stream configurations must include

22903

a subset of the advertised <a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#YCBCR_P010">ImageFormat#YCBCR_P010</a> and

22904

<a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#PRIVATE">ImageFormat#PRIVATE</a> outputs that are optimized for power

22905

and performance when registered along with a supported 10-bit dynamic range profile.

22906

see android.hardware.camera2.params.OutputConfiguration#setDynamicRangeProfile for

details.

</li>

<li>

PUBLIC_END_3_8 (v3.8)

22911

0x9

22912

</li>

22913

<li>

Emilian Peev

2018-09-18 14:01:55 +0100

[diff] [blame]

22914

VENDOR_START (v3.4)

22915

0x18

22916

Vendor defined use cases. These depend on the vendor implementation.

</li>

</ul>

</td>

22921

22922

22923

Recommended stream configurations for common client use cases.

</td>

</td>

</td>

3.4

</td>

</td>

</tr>

<th class="th_details" colspan="6">Details</th>

</tr>

Optional subset of the <a href="#static_android.scaler.availableStreamConfigurations">android.scaler.availableStreamConfigurations</a> that contains

22946

similar tuples listed as

22947

(i.e. width, height, format, output/input stream, usecase bit field).

22948

Camera devices will be able to suggest particular stream configurations which are

22949

power and performance efficient for specific use cases. For more information about

22950

retrieving the suggestions see

22951

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics.html#getRecommendedStreamConfigurationMap">CameraCharacteristics#getRecommendedStreamConfigurationMap</a>.

</td>

</tr>

<th class="th_details" colspan="6">HAL Implementation Details</th>

</tr>

There are some requirements that need to be considered regarding the usecases and the

22961

suggested configurations:

22962

<ul>

22963

<li>If <a href="#static_android.scaler.availableRecommendedStreamConfigurations">android.scaler.availableRecommendedStreamConfigurations</a> is set, then recommended

22964

stream configurations must be present for all mandatory usecases PREVIEW,

22965

SNAPSHOT, RECORD, VIDEO_SNAPSHOT. ZSL and RAW are

22966

required depending on device capabilities see <a href="#static_android.request.availableCapabilities">android.request.availableCapabilities</a>.</li>

22967

<li>Non-existing usecases and non-vendor usecases within the range

22968

(RAW : VENDOR_START] are prohibited as well as stream configurations not

22969

present in the exhaustive <a href="#static_android.scaler.availableStreamConfigurations">android.scaler.availableStreamConfigurations</a> list.</li>

22970

</ul>

22971

For example, in case the camera device supports only 4K and 1080p and both resolutions are

22972

recommended for the mandatory usecases except preview which can run efficiently only

22973

on 1080p. The array may look like this:

22974

[3840, 2160, HAL_PIXEL_FORMAT_IMPLEMENTATION_DEFINED,

22975

ANDROID_SCALER_AVAILABLE_STREAM_CONFIGURATIONS_OUTPUT,

22976

(1<< ANDROID_SCALER_AVAILABLE_RECOMMENDED_STREAM_CONFIGURATIONS_RECORD |

22977

1<< ANDROID_SCALER_AVAILABLE_RECOMMENDED_STREAM_CONFIGURATIONS_SNAPSHOT |

22978

1<< ANDROID_SCALER_AVAILABLE_RECOMMENDED_STREAM_CONFIGURATIONS_VIDEO_SNAPSHOT),

22979

1920, 1080, HAL_PIXEL_FORMAT_IMPLEMENTATION_DEFINED,

22980

ANDROID_SCALER_AVAILABLE_STREAM_CONFIGURATIONS_OUTPUT,

22981

(1<< ANDROID_SCALER_AVAILABLE_RECOMMENDED_STREAM_CONFIGURATIONS_PREVIEW |

22982

1<< ANDROID_SCALER_AVAILABLE_RECOMMENDED_STREAM_CONFIGURATIONS_RECORD |

22983

1<< ANDROID_SCALER_AVAILABLE_RECOMMENDED_STREAM_CONFIGURATIONS_SNAPSHOT |

22984

1<< ANDROID_SCALER_AVAILABLE_RECOMMENDED_STREAM_CONFIGURATIONS_VIDEO_SNAPSHOT)]

</td>

</tr>

<td class="entry_name

22994

" rowspan="5">

22995

android.scaler.availableRecommendedInputOutputFormatsMap

</td>

int32

[ndk_public as reprocessFormatsMap]

</td>

23008

23009

23010

Recommended mappings of image formats that are supported by this

23011

camera device for input streams, to their corresponding output formats.

</td>

</td>

</td>

3.4

</td>

<li><a href="#tag_REPROC">REPROC</a></li>

</ul>

</td>

</tr>

<th class="th_details" colspan="6">Details</th>

</tr>

This is a recommended subset of the complete list of mappings found in

23037

<a href="#static_android.scaler.availableInputOutputFormatsMap">android.scaler.availableInputOutputFormatsMap</a>. The same requirements apply here as well.

23038

The list however doesn't need to contain all available and supported mappings. Instead of

23039

this developers must list only recommended and efficient entries.

23040

If set, the information will be available in the ZERO_SHUTTER_LAG recommended stream

23041

configuration see

23042

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics.html#getRecommendedStreamConfigurationMap">CameraCharacteristics#getRecommendedStreamConfigurationMap</a>.

</td>

</tr>

<th class="th_details" colspan="6">HAL Implementation Details</th>

</tr>

For a code sample of the required data encoding please check

23052

<a href="#static_android.scaler.availableInputOutputFormatsMap">android.scaler.availableInputOutputFormatsMap</a>.

</td>

</tr>

23058

Emilian Peev

fdc5563

2018-11-14 17:50:18 +0000

[diff] [blame]

23059

23060

23061

<td class="entry_name

23062

" rowspan="5">

23063

android.scaler.mandatoryStreamCombinations

</td>

int32

x

n

[java_public as mandatoryStreamCombination]

[synthetic]

[limited]

</td>

23082

23083

23084

An array of mandatory stream combinations generated according to the camera device

23085

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics.html#INFO_SUPPORTED_HARDWARE_LEVEL">CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL</a>

23086

and <a href="https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics.html#REQUEST_AVAILABLE_CAPABILITIES">CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES</a>.

23087

This is an app-readable conversion of the mandatory stream combination

23088

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraDevice.html#createCaptureSession">tables</a>.

</td>

</td>

</td>

3.2

</td>

</td>

</tr>

<th class="th_details" colspan="6">Details</th>

</tr>

The array of

<a href="https://developer.android.com/reference/android/hardware/camera2/params/MandatoryStreamCombination.html">combinations</a> is

23112

generated according to the documented

23113

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraDevice.html#createCaptureSession">guideline</a> based on

23114

specific device level and capabilities.

23115

Clients can use the array as a quick reference to find an appropriate camera stream

23116

combination.

23117

As per documentation, the stream combinations with given PREVIEW, RECORD and

23118

MAXIMUM resolutions and anything smaller from the list given by

23119

<a href="https://developer.android.com/reference/android/hardware/camera2/params/StreamConfigurationMap.html#getOutputSizes">StreamConfigurationMap#getOutputSizes</a> are

23120

guaranteed to work.

Shuzhen Wang

2019-03-07 08:38:51 -0800

[diff] [blame]

23121

For a physical camera not independently exposed in

23122

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraManager.html#getCameraIdList">CameraManager#getCameraIdList</a>, the mandatory stream

23123

combinations for that physical camera Id are also generated, so that the application can

23124

configure them as physical streams via the logical camera.

23125

The mandatory stream combination array will be {@code null} in case the device is not

23126

backward compatible.

Emilian Peev

fdc5563

2018-11-14 17:50:18 +0000

[diff] [blame]

</td>

</tr>

<th class="th_details" colspan="6">HAL Implementation Details</th>

</tr>

Do not set this property directly

23136

(it is synthetic and will not be available at the HAL layer).

</td>

</tr>

23142

Eino-Ville Talvala

2020-01-06 13:06:22 -0800

[diff] [blame]

23143

Jayant Chowdhary

828a020

2020-03-13 13:57:38 -0700

[diff] [blame]

23144

23145

<td class="entry_name

23146

" rowspan="5">

23147

android.scaler.mandatoryConcurrentStreamCombinations

</td>

int32

x

n

[java_public as mandatoryStreamCombination]

[synthetic]

</td>

23165

23166

23167

An array of mandatory concurrent stream combinations.

23168

This is an app-readable conversion of the concurrent mandatory stream combination

23169

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraDevice.html#createCaptureSession">tables</a>.

</td>

</td>

</td>

3.2

</td>

</td>

</tr>

<th class="th_details" colspan="6">Details</th>

</tr>

The array of

<a href="https://developer.android.com/reference/android/hardware/camera2/params/MandatoryStreamCombination.html">combinations</a> is

23193

generated according to the documented

23194

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraDevice.html#createCaptureSession">guideline</a> for each

23195

device which has its Id present in the set returned by

23196

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraManager.html#getConcurrentCameraIds">CameraManager#getConcurrentCameraIds</a>.

23197

Clients can use the array as a quick reference to find an appropriate camera stream

23198

combination.

23199

The mandatory stream combination array will be {@code null} in case the device is not a

23200

part of at least one set of combinations returned by

23201

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraManager.html#getConcurrentCameraIds">CameraManager#getConcurrentCameraIds</a>.

</td>

</tr>

<th class="th_details" colspan="6">HAL Implementation Details</th>

</tr>

Do not set this property directly

23211

(it is synthetic and will not be available at the HAL layer).

</td>

</tr>

23217

23218

Eino-Ville Talvala

2020-01-06 13:06:22 -0800

[diff] [blame]

23219

23220

<td class="entry_name

23221

" rowspan="3">

23222

android.scaler.availableRotateAndCropModes

</td>

byte

x

n

[public as enumList]

<div class="entry_type_notes">list of enums</div>

23237

23238

23239

</td>

23240

23241

23242

List of rotate-and-crop modes for <a href="#controls_android.scaler.rotateAndCrop">android.scaler.rotateAndCrop</a> that are supported by this camera device.

</td>

</td>

Any value listed in <a href="#controls_android.scaler.rotateAndCrop">android.scaler.rotateAndCrop</a>

</td>

3.5

</td>

</td>

</tr>

<th class="th_details" colspan="6">Details</th>

</tr>

This entry lists the valid modes for <a href="#controls_android.scaler.rotateAndCrop">android.scaler.rotateAndCrop</a> for this camera device.

23266

Starting with API level 30, all devices will list at least <code>ROTATE_AND_CROP_NONE</code>.

23267

Devices with support for rotate-and-crop will additionally list at least

23268

<code>ROTATE_AND_CROP_AUTO</code> and <code>ROTATE_AND_CROP_90</code>.

</td>

</tr>

23275

Yin-Chia Yeh

8a349d8

2021-02-11 17:10:20 -0800

[diff] [blame]

23276

23277

23278

<td class="entry_name

23279

" rowspan="3">

23280

android.scaler.defaultSecureImageSize

</td>

int32

x

2

[public as size]

<div class="entry_type_notes">width/height for the default secure image data size</div>

23295

23296

23297

</td>

23298

23299

23300

Default YUV/PRIVATE size to use for requesting secure image buffers.

</td>

Pixels

</td>

</td>

3.6

</td>

</td>

</tr>

<th class="th_details" colspan="6">Details</th>

</tr>

This entry lists the default size supported in the secure camera mode. This entry is

23324

optional on devices support the SECURE_IMAGE_DATA capability. This entry will be null

23325

if the camera device does not list SECURE_IMAGE_DATA capability.

23326

When the key is present, only a PRIVATE/YUV output of the specified size is guaranteed

23327

to be supported by the camera HAL in the secure camera mode. Any other format or

23328

resolutions might not be supported. Use

23329

<a href="https://developer.android.com/reference/CameraDevice.html#isSessionConfigurationSupported">CameraDevice#isSessionConfigurationSupported</a>

23330

API to query if a secure session configuration is supported if the device supports this

23331

API.

23332

If this key returns null on a device with SECURE_IMAGE_DATA capability, the application

23333

can assume all output sizes listed in the

23334

<a href="https://developer.android.com/reference/android/hardware/camera2/params/StreamConfigurationMap.html">StreamConfigurationMap</a>

are supported.

</td>

</tr>

23342

Shuzhen Wang

2020-11-20 15:39:23 -0800

[diff] [blame]

23343

23344

23345

<td class="entry_name

Shuzhen Wang

e8aa556

2021-04-29 13:31:18 -0700

[diff] [blame]

23346

" rowspan="5">

Shuzhen Wang

2020-11-20 15:39:23 -0800

[diff] [blame]

23347

android.scaler.physicalCameraMultiResolutionStreamConfigurations

</td>

int32

x

n x 4

[ndk_public as streamConfiguration]

[limited]

<li>

OUTPUT (v3.6)

</li>

<li>

INPUT (v3.6)

</li>

</ul>

</td>

23373

23374

23375

The available multi-resolution stream configurations that this

23376

physical camera device supports

23377

(i.e. format, width, height, output/input stream).

</td>

</td>

</td>

3.6

</td>

</td>

</tr>

<th class="th_details" colspan="6">Details</th>

</tr>

This list contains a subset of the parent logical camera's multi-resolution stream

23400

configurations which belong to this physical camera, and it will advertise and will only

23401

advertise the maximum supported resolutions for a particular format.

23402

If this camera device isn't a physical camera device constituting a logical camera,

Jayant Chowdhary

2020-11-09 09:08:31 -0800

[diff] [blame]

23403

but a standalone <a href="https://developer.android.com/reference/android/hardware/camera2/CameraMetadata.html#REQUEST_AVAILABLE_CAPABILITIES_ULTRA_HIGH_RESOLUTION_SENSOR">CameraMetadata#REQUEST_AVAILABLE_CAPABILITIES_ULTRA_HIGH_RESOLUTION_SENSOR</a>

23404

camera, this field represents the multi-resolution input/output stream configurations of

23405

default mode and max resolution modes. The sizes will be the maximum resolution of a

23406

particular format for default mode and max resolution mode.

Shuzhen Wang

2020-11-20 15:39:23 -0800

[diff] [blame]

23407

This field will only be advertised if the device is a physical camera of a

23408

logical multi-camera device or an ultra high resolution sensor camera. For a logical

23409

multi-camera, the camera API will derive the logical camera’s multi-resolution stream

23410

configurations from all physical cameras. For an ultra high resolution sensor camera, this

23411

is used directly as the camera’s multi-resolution stream configurations.

</td>

</tr>

Shuzhen Wang

2021-04-29 13:31:18 -0700

[diff] [blame]

23415

23416

<th class="th_details" colspan="6">HAL Implementation Details</th>

</tr>

If this field contains input stream configurations, and the camera device is a physical

23421

camera (not a standalone ultra-high resolution camera), the

23422

<a href="#dynamic_android.logicalMultiCamera.activePhysicalId">android.logicalMultiCamera.activePhysicalId</a> tag must be set to the physical camera Id in

23423

the physical camera result metadata. This is to make sure during multi-resolution

23424

reprocessing, the camera HAL is notified of which physical camera the reprocessing

23425

request comes from.

23426

</td>

23427

</tr>

Shuzhen Wang

2020-11-20 15:39:23 -0800

[diff] [blame]

23428

23429

23430

<td class="entry_name

23435

" rowspan="5">

23436

android.scaler.multiResolutionStreamConfigurationMap

</td>

int32

[java_public as multiResolutionStreamConfigurationMap]

[synthetic]

</td>

23450

23451

23452

The multi-resolution stream configurations supported by this logical camera

23453

or ultra high resolution sensor camera device.

</td>

</td>

</td>

3.2

</td>

</td>

</tr>

<th class="th_details" colspan="6">Details</th>

</tr>

Multi-resolution streams can be used by a LOGICAL_MULTI_CAMERA or an

23476

ULTRA_HIGH_RESOLUTION_SENSOR camera where the images sent or received can vary in

23477

resolution per frame. This is useful in cases where the camera device's effective full

23478

resolution changes depending on factors such as the current zoom level, lighting

23479

condition, focus distance, or pixel mode.

23480

<ul>

23481

<li>For a logical multi-camera implementing optical zoom, at different zoom level, a

23482

different physical camera may be active, resulting in different full-resolution image

23483

sizes.</li>

23484

<li>For an ultra high resolution camera, depending on whether the camera operates in default

23485

mode, or maximum resolution mode, the output full-size images may be of either binned

23486

resolution or maximum resolution.</li>

23487

</ul>

23488

To use multi-resolution output streams, the supported formats can be queried by <a href="https://developer.android.com/reference/android/hardware/camera2/params/MultiResolutionStreamConfigurationMap.html#getOutputFormats">MultiResolutionStreamConfigurationMap#getOutputFormats</a>.

23489

A <a href="https://developer.android.com/reference/android/hardware/camera2/MultiResolutionImageReader.html">MultiResolutionImageReader</a> can then be created for a

23490

supported format with the MultiResolutionStreamInfo group queried by <a href="https://developer.android.com/reference/android/hardware/camera2/params/MultiResolutionStreamConfigurationMap.html#getOutputInfo">MultiResolutionStreamConfigurationMap#getOutputInfo</a>.

23491

If a camera device supports multi-resolution output streams for a particular format, for

23492

each of its mandatory stream combinations, the camera device will support using a

23493

MultiResolutionImageReader for the MAXIMUM stream of supported formats. Refer to

23494

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraDevice.html#createCaptureSession">CameraDevice#createCaptureSession</a> for additional details.

23495

To use multi-resolution input streams, the supported formats can be queried by <a href="https://developer.android.com/reference/android/hardware/camera2/params/MultiResolutionStreamConfigurationMap.html#getInputFormats">MultiResolutionStreamConfigurationMap#getInputFormats</a>.

23496

A reprocessable CameraCaptureSession can then be created using an <a href="https://developer.android.com/reference/android/hardware/camera2/params/InputConfiguration.html">InputConfiguration</a> constructed with

23497

the input MultiResolutionStreamInfo group, queried by <a href="https://developer.android.com/reference/android/hardware/camera2/params/MultiResolutionStreamConfigurationMap.html#getInputInfo">MultiResolutionStreamConfigurationMap#getInputInfo</a>.

23498

If a camera device supports multi-resolution {@code YUV} input and multi-resolution

23499

{@code YUV} output, or multi-resolution {@code PRIVATE} input and multi-resolution

23500

{@code PRIVATE} output, {@code JPEG} and {@code YUV} are guaranteed to be supported

23501

multi-resolution output stream formats. Refer to

23502

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraDevice.html#createCaptureSession">CameraDevice#createCaptureSession</a> for

23503

details about the additional mandatory stream combinations in this case.

</td>

</tr>

<th class="th_details" colspan="6">HAL Implementation Details</th>

</tr>

Do not set this property directly

23513

(it is synthetic and will not be available at the HAL layer).

</td>

</tr>

23519

Jayant Chowdhary

2020-11-09 09:08:31 -0800

[diff] [blame]

23520

23521

23522

<td class="entry_name

23523

" rowspan="5">

23524

android.scaler.availableStreamConfigurationsMaximumResolution

</td>

int32

x

n x 4

[ndk_public as streamConfiguration]

<li>

OUTPUT (v3.6)

</li>

<li>

INPUT (v3.6)

</li>

</ul>

</td>

23549

23550

23551

The available stream configurations that this

23552

camera device supports (i.e. format, width, height, output/input stream) for a

23553

CaptureRequest with <a href="#controls_android.sensor.pixelMode">android.sensor.pixelMode</a> set to

23554

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraMetadata.html#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION">CameraMetadata#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION</a>.

</td>

</td>

</td>

3.6

</td>

</td>

</tr>

<th class="th_details" colspan="6">Details</th>

</tr>

Analogous to <a href="#static_android.scaler.availableStreamConfigurations">android.scaler.availableStreamConfigurations</a>, for configurations

23577

which are applicable when <a href="#controls_android.sensor.pixelMode">android.sensor.pixelMode</a> is set to

23578

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraMetadata.html#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION">CameraMetadata#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION</a>.

23579

Not all output formats may be supported in a configuration with

23580

an input stream of a particular format. For more details, see

23581

<a href="#static_android.scaler.availableInputOutputFormatsMapMaximumResolution">android.scaler.availableInputOutputFormatsMapMaximumResolution</a>.

</td>

</tr>

<th class="th_details" colspan="6">HAL Implementation Details</th>

</tr>

Refer to hal_details for <a href="#static_android.scaler.availableStreamConfigurations">android.scaler.availableStreamConfigurations</a>.

</td>

</tr>

<td class="entry_name

23600

" rowspan="3">

23601

android.scaler.availableMinFrameDurationsMaximumResolution

</td>

int64

x

4 x n

[ndk_public as streamConfigurationDuration]

</td>

23618

23619

23620

This lists the minimum frame duration for each

23621

format/size combination when the camera device is sent a CaptureRequest with

23622

<a href="#controls_android.sensor.pixelMode">android.sensor.pixelMode</a> set to

23623

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraMetadata.html#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION">CameraMetadata#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION</a>.

</td>

(format, width, height, ns) x n

</td>

</td>

3.6

</td>

</td>

</tr>

<th class="th_details" colspan="6">Details</th>

</tr>

Analogous to <a href="#static_android.scaler.availableMinFrameDurations">android.scaler.availableMinFrameDurations</a>, for configurations

23647

which are applicable when <a href="#controls_android.sensor.pixelMode">android.sensor.pixelMode</a> is set to

23648

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraMetadata.html#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION">CameraMetadata#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION</a>.

23649

When multiple streams are used in a request (if supported, when <a href="#controls_android.sensor.pixelMode">android.sensor.pixelMode</a>

23650

is set to

23651

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraMetadata.html#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION">CameraMetadata#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION</a>), the

23652

minimum frame duration will be max(individual stream min durations).

23653

See <a href="#controls_android.sensor.frameDuration">android.sensor.frameDuration</a> and

23654

<a href="#static_android.scaler.availableStallDurationsMaximumResolution">android.scaler.availableStallDurationsMaximumResolution</a> for more details about

23655

calculating the max frame rate.

</td>

</tr>

<td class="entry_name

23666

" rowspan="5">

23667

android.scaler.availableStallDurationsMaximumResolution

</td>

int64

x

4 x n

[ndk_public as streamConfigurationDuration]

</td>

23684

23685

23686

This lists the maximum stall duration for each

23687

output format/size combination when CaptureRequests are submitted with

23688

<a href="#controls_android.sensor.pixelMode">android.sensor.pixelMode</a> set to

23689

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraMetadata.html#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION">CameraMetadata#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION</a>

</td>

(format, width, height, ns) x n

</td>

</td>

3.6

</td>

</td>

</tr>

<th class="th_details" colspan="6">Details</th>

</tr>

Analogous to <a href="#static_android.scaler.availableMinFrameDurations">android.scaler.availableMinFrameDurations</a>, for configurations

23713

which are applicable when <a href="#controls_android.sensor.pixelMode">android.sensor.pixelMode</a> is set to

23714

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraMetadata.html#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION">CameraMetadata#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION</a>.

</td>

</tr>

<th class="th_details" colspan="6">HAL Implementation Details</th>

</tr>

If possible, it is recommended that all non-JPEG formats

23724

(such as RAW16) should not have a stall duration. RAW10, RAW12, RAW_OPAQUE

23725

and IMPLEMENTATION_DEFINED must not have stall durations.

</td>

</tr>

<td class="entry_name

23735

" rowspan="5">

23736

android.scaler.streamConfigurationMapMaximumResolution

</td>

int32

[java_public as streamConfigurationMap]

[synthetic]

</td>

23750

23751

23752

The available stream configurations that this

23753

camera device supports when given a CaptureRequest with <a href="#controls_android.sensor.pixelMode">android.sensor.pixelMode</a>

23754

set to

23755

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraMetadata.html#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION">CameraMetadata#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION</a>;

23756

also includes the minimum frame durations

23757

and the stall durations for each format/size combination.

</td>

</td>

</td>

3.2

</td>

</td>

</tr>

<th class="th_details" colspan="6">Details</th>

</tr>

Analogous to <a href="#static_android.scaler.streamConfigurationMap">android.scaler.streamConfigurationMap</a> for CaptureRequests where

23780

<a href="#controls_android.sensor.pixelMode">android.sensor.pixelMode</a> is

23781

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraMetadata.html#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION">CameraMetadata#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION</a>.

</td>

</tr>

<th class="th_details" colspan="6">HAL Implementation Details</th>

</tr>

Do not set this property directly

23791

(it is synthetic and will not be available at the HAL layer);

23792

set the <a href="#static_android.scaler.availableStreamConfigurationsMaximumResolution">android.scaler.availableStreamConfigurationsMaximumResolution</a> instead.

23793

Not all output formats may be supported in a configuration with

23794

an input stream of a particular format. For more details, see

23795

<a href="#static_android.scaler.availableInputOutputFormatsMapMaximumResolution">android.scaler.availableInputOutputFormatsMapMaximumResolution</a>.

</td>

</tr>

<td class="entry_name

23805

" rowspan="5">

23806

android.scaler.availableInputOutputFormatsMapMaximumResolution

</td>

int32

[hidden as reprocessFormatsMap]

</td>

23819

23820

23821

The mapping of image formats that are supported by this

23822

camera device for input streams, to their corresponding output formats, when

23823

<a href="#controls_android.sensor.pixelMode">android.sensor.pixelMode</a> is set to

23824

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraMetadata.html#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION">CameraMetadata#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION</a>.

</td>

</td>

</td>

3.6

</td>

<li><a href="#tag_REPROC">REPROC</a></li>

</ul>

</td>

</tr>

<th class="th_details" colspan="6">Details</th>

</tr>

Analogous to <a href="#static_android.scaler.availableInputOutputFormatsMap">android.scaler.availableInputOutputFormatsMap</a> for CaptureRequests where

23850

<a href="#controls_android.sensor.pixelMode">android.sensor.pixelMode</a> is

23851

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraMetadata.html#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION">CameraMetadata#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION</a>.

</td>

</tr>

<th class="th_details" colspan="6">HAL Implementation Details</th>

</tr>

Refer to hal details for <a href="#static_android.scaler.availableInputOutputFormatsMapMaximumResolution">android.scaler.availableInputOutputFormatsMapMaximumResolution</a>.

</td>

</tr>

<td class="entry_name

23870

" rowspan="5">

23871

android.scaler.mandatoryMaximumResolutionStreamCombinations

</td>

int32

x

n

[java_public as mandatoryStreamCombination]

[synthetic]

</td>

23889

23890

23891

An array of mandatory stream combinations which are applicable when

23892

<a href="https://developer.android.com/reference/android/hardware/camera2/CaptureRequest.html">CaptureRequest</a> has <a href="#controls_android.sensor.pixelMode">android.sensor.pixelMode</a> set

23893

to <a href="https://developer.android.com/reference/android/hardware/camera2/CameraMetadata.html#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION">CameraMetadata#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION</a>.

23894

This is an app-readable conversion of the maximum resolution mandatory stream combination

23895

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraDevice.html#createCaptureSession">tables</a>.

</td>

</td>

</td>

3.2

</td>

</td>

</tr>

<th class="th_details" colspan="6">Details</th>

</tr>

The array of

<a href="https://developer.android.com/reference/android/hardware/camera2/params/MandatoryStreamCombination.html">combinations</a> is

23919

generated according to the documented

23920

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraDevice.html#createCaptureSession">guideline</a> for each

23921

device which has the

23922

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraMetadata.html#REQUEST_AVAILABLE_CAPABILITIES_ULTRA_HIGH_RESOLUTION_SENSOR">CameraMetadata#REQUEST_AVAILABLE_CAPABILITIES_ULTRA_HIGH_RESOLUTION_SENSOR</a>

23923

capability.

23924

Clients can use the array as a quick reference to find an appropriate camera stream

23925

combination.

23926

The mandatory stream combination array will be {@code null} in case the device is not an

23927

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraMetadata.html#REQUEST_AVAILABLE_CAPABILITIES_ULTRA_HIGH_RESOLUTION_SENSOR">CameraMetadata#REQUEST_AVAILABLE_CAPABILITIES_ULTRA_HIGH_RESOLUTION_SENSOR</a>

device.

</td>

</tr>

<th class="th_details" colspan="6">HAL Implementation Details</th>

</tr>

Do not set this property directly

23938

(it is synthetic and will not be available at the HAL layer).

</td>

</tr>

23944

Shuzhen Wang

2021-04-06 12:44:46 -0700

[diff] [blame]

23945

Emilian Peev

2021-11-12 18:07:39 -0800

[diff] [blame]

23946

23947

<td class="entry_name

23948

" rowspan="5">

23949

android.scaler.mandatoryTenBitOutputStreamCombinations

</td>

int32

x

n

[java_public as mandatoryStreamCombination]

[synthetic]

</td>

23967

23968

23969

An array of mandatory stream combinations which are applicable when device support the

23970

10-bit output capability

23971

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics.html#REQUEST_AVAILABLE_CAPABILITIES_DYNAMIC_RANGE_TEN_BIT">CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES_DYNAMIC_RANGE_TEN_BIT</a>

23972

This is an app-readable conversion of the maximum resolution mandatory stream combination

23973

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraDevice.html#createCaptureSession">tables</a>.

</td>

</td>

</td>

3.2

</td>

</td>

</tr>

<th class="th_details" colspan="6">Details</th>

</tr>

The array of

<a href="https://developer.android.com/reference/android/hardware/camera2/params/MandatoryStreamCombination.html">combinations</a> is

23997

generated according to the documented

23998

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraDevice.html#createCaptureSession">guideline</a> for each

23999

device which has the

24000

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics.html#REQUEST_AVAILABLE_CAPABILITIES_DYNAMIC_RANGE_TEN_BIT">CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES_DYNAMIC_RANGE_TEN_BIT</a>

24001

capability.

24002

Clients can use the array as a quick reference to find an appropriate camera stream

24003

combination.

24004

The mandatory stream combination array will be {@code null} in case the device is not an

24005

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics.html#REQUEST_AVAILABLE_CAPABILITIES_DYNAMIC_RANGE_TEN_BIT">CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES_DYNAMIC_RANGE_TEN_BIT</a>

device.

</td>

</tr>

<th class="th_details" colspan="6">HAL Implementation Details</th>

</tr>

Do not set this property directly

24016

(it is synthetic and will not be available at the HAL layer).

</td>

</tr>

24022

24023

Jayant Chowdhary

3621407

2022-02-09 20:58:54 +0000

[diff] [blame]

24024

24025

<td class="entry_name

24026

" rowspan="5">

24027

android.scaler.mandatoryPreviewStabilizationOutputStreamCombinations

</td>

int32

x

n

[java_public as mandatoryStreamCombination]

[synthetic]

</td>

24045

24046

24047

An array of mandatory stream combinations which are applicable when device lists

24048

{@code PREVIEW_STABILIZATION} in <a href="#static_android.control.availableVideoStabilizationModes">android.control.availableVideoStabilizationModes</a>.

24049

This is an app-readable conversion of the maximum resolution mandatory stream combination

24050

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraDevice.html#createCaptureSession">tables</a>.

</td>

</td>

</td>

3.2

</td>

</td>

</tr>

<th class="th_details" colspan="6">Details</th>

</tr>

The array of

<a href="https://developer.android.com/reference/android/hardware/camera2/params/MandatoryStreamCombination.html">combinations</a> is

24074

generated according to the documented

24075

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraDevice.html#createCaptureSession">guideline</a> for each

24076

device which supports {@code PREVIEW_STABILIZATION}

24077

Clients can use the array as a quick reference to find an appropriate camera stream

24078

combination.

24079

The mandatory stream combination array will be {@code null} in case the device does not

24080

list {@code PREVIEW_STABILIZATION} in <a href="#static_android.control.availableVideoStabilizationModes">android.control.availableVideoStabilizationModes</a>.

</td>

</tr>

<th class="th_details" colspan="6">HAL Implementation Details</th>

</tr>

Do not set this property directly

24090

(it is synthetic and will not be available at the HAL layer).

</td>

</tr>

24096

24097

Shuzhen Wang

2021-04-06 12:44:46 -0700

[diff] [blame]

24098

24099

<td class="entry_name

24100

" rowspan="5">

24101

android.scaler.multiResolutionStreamSupported

</td>

byte

[ndk_public as boolean]

[limited]

<li>

FALSE (v3.6)

</li>

<li>

TRUE (v3.6)

</li>

</ul>

</td>

24123

24124

24125

Whether the camera device supports multi-resolution input or output streams

</td>

</td>

</td>

3.6

</td>

</td>

</tr>

<th class="th_details" colspan="6">Details</th>

</tr>

A logical multi-camera or an ultra high resolution camera may support multi-resolution

24148

input or output streams. With multi-resolution output streams, the camera device is able

24149

to output different resolution images depending on the current active physical camera or

24150

pixel mode. With multi-resolution input streams, the camera device can reprocess images

24151

of different resolutions from different physical cameras or sensor pixel modes.

Shuzhen Wang

2022-05-03 11:01:26 -0700

[diff] [blame]

24152

When set to TRUE:

24153

<ul>

24154

<li>For a logical multi-camera, the camera framework derives

Shuzhen Wang

2021-04-06 12:44:46 -0700

[diff] [blame]

24155

<a href="#static_android.scaler.multiResolutionStreamConfigurationMap">android.scaler.multiResolutionStreamConfigurationMap</a> by combining the

24156

<a href="#static_android.scaler.physicalCameraMultiResolutionStreamConfigurations">android.scaler.physicalCameraMultiResolutionStreamConfigurations</a> from its physical

Shuzhen Wang

2022-05-03 11:01:26 -0700

[diff] [blame]

24157

cameras.</li>

24158

<li>For an ultra-high resolution sensor camera, the camera framework directly copies

Shuzhen Wang

2021-04-06 12:44:46 -0700

[diff] [blame]

24159

the value of <a href="#static_android.scaler.physicalCameraMultiResolutionStreamConfigurations">android.scaler.physicalCameraMultiResolutionStreamConfigurations</a> to

Shuzhen Wang

2022-05-03 11:01:26 -0700

[diff] [blame]

24160

<a href="#static_android.scaler.multiResolutionStreamConfigurationMap">android.scaler.multiResolutionStreamConfigurationMap</a>.</li>

24161

</ul>

Shuzhen Wang

2021-04-06 12:44:46 -0700

[diff] [blame]

</td>

</tr>

<th class="th_details" colspan="6">HAL Implementation Details</th>

</tr>

Shuzhen Wang

2022-05-03 11:01:26 -0700

[diff] [blame]

24170

For the HAL to claim support for multi-resolution streams:

24171

<ul>

24172

<li>The HAL must support the buffer management API by setting

24173

supportedBufferManagementVersion to HIDL_DEVICE_3_5.</li>

24174

<li>For a logical multi-camera, when combined from all its physical cameras, there must be

Shuzhen Wang

2021-04-06 12:44:46 -0700

[diff] [blame]

24175

at a minimum one input or output stream format with at least two different

Shuzhen Wang

2022-05-03 11:01:26 -0700

[diff] [blame]

24176

physicalCameraMultiResolutionStreamConfigurations entries for that format.</li>

24177

<li>For an ultra high resolution sensor camera, for each supported multi-resolution format,

Shuzhen Wang

2021-04-06 12:44:46 -0700

[diff] [blame]

24178

the physicalCameraMultiResolutionStreamConfigurations must contain both the largest stream

24179

configuration within the <a href="#static_android.scaler.streamConfigurationMap">android.scaler.streamConfigurationMap</a> and the largest stream

Shuzhen Wang

2022-05-03 11:01:26 -0700

[diff] [blame]

24180

configuration within the <a href="#static_android.scaler.streamConfigurationMapMaximumResolution">android.scaler.streamConfigurationMapMaximumResolution</a>.</li>

24181

<li>If the HAL advertises multi-resolution input stream support for a particular format

Shuzhen Wang

2021-04-06 12:44:46 -0700

[diff] [blame]

24182

(namely PRIVATE, or YUV), the logical multi-camera or ultra high resolution sensor camera

24183

must have the corresponding reprocessing capabilities (PRIVATE_REPROCESSING,

24184

or YUV_REPROCESSING respectively). The camera HAL must support reprocessing the

24185

multi-resolution input stream to the output formats specified in the camera's

Shuzhen Wang

2022-05-03 11:01:26 -0700

[diff] [blame]

24186

<a href="#static_android.scaler.availableInputOutputFormatsMap">android.scaler.availableInputOutputFormatsMap</a>.</li>

24187

</ul>

Shuzhen Wang

2021-04-06 12:44:46 -0700

[diff] [blame]

</td>

</tr>

24193

Shuzhen Wang

2021-12-14 20:08:28 -0800

[diff] [blame]

24194

24195

24196

<td class="entry_name

24197

" rowspan="5">

24198

android.scaler.availableStreamUseCases

24199

</td>

24200

Shuzhen Wang

d2a7807

2022-03-08 16:57:03 -0800

[diff] [blame]

24201

int64

Shuzhen Wang

2021-12-14 20:08:28 -0800

[diff] [blame]

x

n

[public]

<li>

DEFAULT (v3.8)

[optional]

0x0

Default stream use case.

24219

This use case is the same as when the application doesn't set any use case for

24220

the stream. The camera device uses the properties of the output target, such as

24221

format, dataSpace, or surface class type, to optimize the image processing pipeline.

</li>

<li>

PREVIEW (v3.8)

[optional]

0x1

Live stream shown to the user.

24228

Optimized for performance and usability as a viewfinder, but not necessarily for

24229

image quality. The output is not meant to be persisted as saved images or video.

Shuzhen Wang

2022-05-03 11:01:26 -0700

[diff] [blame]

24230

No stall if android.control.* are set to FAST. There may be stall if

24231

they are set to HIGH_QUALITY. This use case has the same behavior as the

24232

default SurfaceView and SurfaceTexture targets. Additionally, this use case can be

24233

used for in-app image analysis.

Shuzhen Wang

2021-12-14 20:08:28 -0800

[diff] [blame]

</li>

<li>

STILL_CAPTURE (v3.8)

[optional]

0x2

Still photo capture.

Optimized for high-quality high-resolution capture, and not expected to maintain

24241

preview-like frame rates.

24242

The stream may have stalls regardless of whether android.control.* is HIGH_QUALITY.

24243

This use case has the same behavior as the default JPEG and RAW related formats.

</li>

<li>

VIDEO_RECORD (v3.8)

[optional]

0x3

Recording video clips.

24250

Optimized for high-quality video capture, including high-quality image stabilization

24251

if supported by the device and enabled by the application. As a result, may produce

24252

output frames with a substantial lag from real time, to allow for highest-quality

24253

stabilization or other processing. As such, such an output is not suitable for drawing

24254

to screen directly, and is expected to be persisted to disk or similar for later

24255

playback or processing. Only streams that set the VIDEO_RECORD use case are guaranteed

24256

to have video stabilization applied when the video stabilization control is set

24257

to ON, as opposed to PREVIEW_STABILIZATION.

24258

This use case has the same behavior as the default MediaRecorder and MediaCodec

targets.

</li>

<li>

PREVIEW_VIDEO_STILL (v3.8)

24263

[optional]

24264

0x4

24265

One single stream used for combined purposes of preview, video, and still capture.

24266

For such multi-purpose streams, the camera device aims to make the best tradeoff

24267

between the individual use cases. For example, the STILL_CAPTURE use case by itself

24268

may have stalls for achieving best image quality. But if combined with PREVIEW and

24269

VIDEO_RECORD, the camera device needs to trade off the additional image processing

24270

for speed so that preview and video recording aren't slowed down.

24271

Similarly, VIDEO_RECORD may produce frames with a substantial lag, but

24272

PREVIEW_VIDEO_STILL must have minimal output delay. This means that to enable video

24273

stabilization with this use case, the device must support and the app must select the

24274

PREVIEW_STABILIZATION mode for video stabilization.

</li>

<li>

VIDEO_CALL (v3.8)

[optional]

0x5

Shuzhen Wang

2022-05-03 11:01:26 -0700

[diff] [blame]

24280

Long-running video call optimized for both power efficiency and video quality.

Shuzhen Wang

2021-12-14 20:08:28 -0800

[diff] [blame]

24281

The camera sensor may run in a lower-resolution mode to reduce power consumption

24282

at the cost of some image and digital zoom quality. Unlike VIDEO_RECORD, VIDEO_CALL

24283

outputs are expected to work in dark conditions, so are usually accompanied with

24284

variable frame rate settings to allow sufficient exposure time in low light.

</li>

<li>

VENDOR_START (v3.8)

[optional]

[hidden]

0x10000

Vendor defined use cases. These depend on the vendor implementation.

</li>

</ul>

</td>

24296

24297

24298

The stream use cases supported by this camera device.

</td>

</td>

</td>

3.8

</td>

</td>

</tr>

<th class="th_details" colspan="6">Details</th>

</tr>

The stream use case indicates the purpose of a particular camera stream from

24321

the end-user perspective. Some examples of camera use cases are: preview stream for

24322

live viewfinder shown to the user, still capture for generating high quality photo

24323

capture, video record for encoding the camera output for the purpose of future playback,

24324

and video call for live realtime video conferencing.

24325

With this flag, the camera device can optimize the image processing pipeline

Shuzhen Wang

2022-05-03 11:01:26 -0700

[diff] [blame]

24326

parameters, such as tuning, sensor mode, and ISP settings, independent of

Shuzhen Wang

2021-12-14 20:08:28 -0800

[diff] [blame]

24327

the properties of the immediate camera output surface. For example, if the output

24328

surface is a SurfaceTexture, the stream use case flag can be used to indicate whether

24329

the camera frames eventually go to display, video encoder,

24330

still image capture, or all of them combined.

24331

The application sets the use case of a camera stream by calling

24332

<a href="https://developer.android.com/reference/android/hardware/camera2/params/OutputConfiguration.html#setStreamUseCase">OutputConfiguration#setStreamUseCase</a>.

24333

A camera device with

24334

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics.html#REQUEST_AVAILABLE_CAPABILITIES_STREAM_USE_CASE">CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES_STREAM_USE_CASE</a>

24335

capability must support the following stream use cases:

<ul>

<li>DEFAULT</li>

<li>PREVIEW</li>

<li>STILL_CAPTURE</li>

24340

<li>VIDEO_RECORD</li>

24341

<li>PREVIEW_VIDEO_STILL</li>

24342

<li>VIDEO_CALL</li>

24343

</ul>

24344

The guaranteed stream combinations related to stream use case for a camera device with

24345

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics.html#REQUEST_AVAILABLE_CAPABILITIES_STREAM_USE_CASE">CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES_STREAM_USE_CASE</a>

24346

capability is documented in the camera device

24347

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraDevice.html#createCaptureSession">guideline</a>. The

Shuzhen Wang

2022-05-03 11:01:26 -0700

[diff] [blame]

24348

application is strongly recommended to use one of the guaranteed stream combinations.

Shuzhen Wang

2021-12-14 20:08:28 -0800

[diff] [blame]

24349

If the application creates a session with a stream combination not in the guaranteed

24350

list, or with mixed DEFAULT and non-DEFAULT use cases within the same session,

24351

the camera device may ignore some stream use cases due to hardware constraints

24352

and implementation details.

24353

For stream combinations not covered by the stream use case mandatory lists, such as

24354

reprocessable session, constrained high speed session, or RAW stream combinations, the

24355

application should leave stream use cases within the session as DEFAULT.

</td>

</tr>

<th class="th_details" colspan="6">HAL Implementation Details</th>

</tr>

The camera HAL must support DEFAULT stream use case to handle scenarios where the

24365

application doesn't explicitly set a stream's use case flag, in which case the camera

24366

framework sets it to DEFAULT.

</td>

</tr>

<td class="entry_name

24376

" rowspan="5">

24377

android.scaler.mandatoryUseCaseStreamCombinations

</td>

int32

x

n

[java_public as mandatoryStreamCombination]

[synthetic]

</td>

24395

24396

24397

An array of mandatory stream combinations with stream use cases.

24398

This is an app-readable conversion of the mandatory stream combination

24399

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraDevice.html#createCaptureSession">tables</a> with

24400

each stream's use case being set.

</td>

</td>

</td>

3.2

</td>

</td>

</tr>

<th class="th_details" colspan="6">Details</th>

</tr>

The array of

<a href="https://developer.android.com/reference/android/hardware/camera2/params/MandatoryStreamCombination.html">combinations</a> is

24424

generated according to the documented

24425

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraDevice.html#createCaptureSession">guideline</a> for a

24426

camera device with

24427

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics.html#REQUEST_AVAILABLE_CAPABILITIES_STREAM_USE_CASE">CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES_STREAM_USE_CASE</a>

24428

capability.

24429

The mandatory stream combination array will be {@code null} in case the device doesn't

24430

have <a href="https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics.html#REQUEST_AVAILABLE_CAPABILITIES_STREAM_USE_CASE">CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES_STREAM_USE_CASE</a>

capability.

</td>

</tr>

<th class="th_details" colspan="6">HAL Implementation Details</th>

</tr>

Do not set this property directly

24441

(it is synthetic and will not be available at the HAL layer).

</td>

</tr>

24447

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</tbody>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

24452

<tr><td colspan="7" class="kind">dynamic</td></tr>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

24453

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

24454

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

24455

<tr>

24456

<th class="th_name">Property Name</th>

24457

24458

<th class="th_description">Description</th>

24459

<th class="th_units">Units</th>

24460

<th class="th_range">Range</th>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

24461

<th class="th_hal_version">Initial HIDL HAL version</th>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</tr>

</thead>

<tbody>

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

24478

<td class="entry_name

Eino-Ville Talvala

2014-06-06 14:35:41 -0700

[diff] [blame]

24479

" rowspan="5">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

24480

android.scaler.cropRegion

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

24481

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

24482

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

24483

int32

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

x

Eino-Ville Talvala

2013-04-16 15:35:18 -0700

[diff] [blame]

24487

4

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

24488

Igor Murashkin

2013-07-17 16:29:34 -0700

[diff] [blame]

24489

[public as rectangle]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

24490

24491

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

24492

[legacy]

24493

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

24497

</td>

24498

24499

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

24500

The desired region of the sensor to read out for this capture.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

24504

Pixel coordinates relative to

Yin-Chia Yeh

2018-06-15 15:35:05 -0700

[diff] [blame]

24505

android.sensor.info.activeArraySize or

24506

android.sensor.info.preCorrectionActiveArraySize depending on distortion correction

24507

capability and mode

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

</ul>

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

24525

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

24526

</tr>

24527

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

24528

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

24529

This control can be used to implement digital zoom.

Yin-Chia Yeh

2018-06-15 15:35:05 -0700

[diff] [blame]

24530

For devices not supporting <a href="#controls_android.distortionCorrection.mode">android.distortionCorrection.mode</a> control, the coordinate

24531

system always follows that of <a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a>, with <code>(0, 0)</code> being

24532

the top-left pixel of the active array.

Eino-Ville Talvala

2020-01-06 16:08:56 -0800

[diff] [blame]

24533

For devices supporting <a href="#controls_android.distortionCorrection.mode">android.distortionCorrection.mode</a> control, the coordinate system

24534

depends on the mode being set. When the distortion correction mode is OFF, the

24535

coordinate system follows <a href="#static_android.sensor.info.preCorrectionActiveArraySize">android.sensor.info.preCorrectionActiveArraySize</a>, with <code>(0,

24536

0)</code> being the top-left pixel of the pre-correction active array. When the distortion

24537

correction mode is not OFF, the coordinate system follows

24538

<a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a>, with <code>(0, 0)</code> being the top-left pixel of the

24539

active array.

24540

Output streams use this rectangle to produce their output, cropping to a smaller region

24541

if necessary to maintain the stream's aspect ratio, then scaling the sensor input to

Eino-Ville Talvala

2014-06-06 14:35:41 -0700

[diff] [blame]

24542

match the output's configured resolution.

Eino-Ville Talvala

2020-01-06 16:08:56 -0800

[diff] [blame]

24543

The crop region is applied after the RAW to other color space (e.g. YUV)

24544

conversion. Since raw streams (e.g. RAW16) don't have the conversion stage, they are not

Eino-Ville Talvala

2014-06-06 14:35:41 -0700

[diff] [blame]

24545

croppable. The crop region will be ignored by raw streams.

Eino-Ville Talvala

2020-01-06 16:08:56 -0800

[diff] [blame]

24546

For non-raw streams, any additional per-stream cropping will be done to maximize the

24547

final pixel area of the stream.

24548

For example, if the crop region is set to a 4:3 aspect ratio, then 4:3 streams will use

24549

the exact crop region. 16:9 streams will further crop vertically (letterbox).

24550

Conversely, if the crop region is set to a 16:9, then 4:3 outputs will crop horizontally

24551

(pillarbox), and 16:9 streams will match exactly. These additional crops will be

24552

centered within the crop region.

24553

To illustrate, here are several scenarios of different crop regions and output streams,

24554

for a hypothetical camera device with an active array of size <code>(2000,1500)</code>. Note that

24555

several of these examples use non-centered crop regions for ease of illustration; such

24556

regions are only supported on devices with FREEFORM capability

24557

(<a href="#static_android.scaler.croppingType">android.scaler.croppingType</a> <code>== FREEFORM</code>), but this does not affect the way the crop

24558

rules work otherwise.

24559

<ul>

24560

<li>Camera Configuration:<ul>

24561

<li>Active array size: <code>2000x1500</code> (3 MP, 4:3 aspect ratio)</li>

24562

<li>Output stream #1: <code>640x480</code> (VGA, 4:3 aspect ratio)</li>

24563

<li>Output stream #2: <code>1280x720</code> (720p, 16:9 aspect ratio)</li>

24564

</ul>

24565

</li>

24566

<li>Case #1: 4:3 crop region with 2x digital zoom<ul>

24567

<li>Crop region: <code>Rect(500, 375, 1500, 1125) // (left, top, right, bottom)</code></li>

24568

24569

<li><code>640x480</code> stream source area: <code>(500, 375, 1500, 1125)</code> (equal to crop region)</li>

24570

<li><code>1280x720</code> stream source area: <code>(500, 469, 1500, 1031)</code> (letterboxed)</li>

24571

</ul>

24572

</li>

24573

<li>Case #2: 16:9 crop region with ~1.5x digital zoom.<ul>

24574

<li>Crop region: <code>Rect(500, 375, 1833, 1125)</code></li>

24575

24576

<li><code>640x480</code> stream source area: <code>(666, 375, 1666, 1125)</code> (pillarboxed)</li>

24577

<li><code>1280x720</code> stream source area: <code>(500, 375, 1833, 1125)</code> (equal to crop region)</li>

24578

</ul>

24579

</li>

24580

<li>Case #3: 1:1 crop region with ~2.6x digital zoom.<ul>

24581

<li>Crop region: <code>Rect(500, 375, 1250, 1125)</code></li>

24582

24583

<li><code>640x480</code> stream source area: <code>(500, 469, 1250, 1031)</code> (letterboxed)</li>

24584

<li><code>1280x720</code> stream source area: <code>(500, 543, 1250, 957)</code> (letterboxed)</li>

24585

</ul>

24586

</li>

24587

<li>Case #4: Replace <code>640x480</code> stream with <code>1024x1024</code> stream, with 4:3 crop region:<ul>

24588

<li>Crop region: <code>Rect(500, 375, 1500, 1125)</code></li>

24589

24590

<li><code>1024x1024</code> stream source area: <code>(625, 375, 1375, 1125)</code> (pillarboxed)</li>

24591

<li><code>1280x720</code> stream source area: <code>(500, 469, 1500, 1031)</code> (letterboxed)</li>

24592

<li>Note that in this case, neither of the two outputs is a subset of the other, with

24593

each containing image data the other doesn't have.</li>

24594

</ul>

24595

</li>

24596

</ul>

Eino-Ville Talvala

2018-08-01 15:26:26 -0700

[diff] [blame]

24597

If the coordinate system is <a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a>, the width and height

Yin-Chia Yeh

2018-06-15 15:35:05 -0700

[diff] [blame]

24598

of the crop region cannot be set to be smaller than

Eino-Ville Talvala

2014-06-06 14:35:41 -0700

[diff] [blame]

24599

<code>floor( activeArraySize.width / <a href="#static_android.scaler.availableMaxDigitalZoom">android.scaler.availableMaxDigitalZoom</a> )</code> and

24600

<code>floor( activeArraySize.height / <a href="#static_android.scaler.availableMaxDigitalZoom">android.scaler.availableMaxDigitalZoom</a> )</code>, respectively.

Yin-Chia Yeh

2018-06-15 15:35:05 -0700

[diff] [blame]

24601

If the coordinate system is <a href="#static_android.sensor.info.preCorrectionActiveArraySize">android.sensor.info.preCorrectionActiveArraySize</a>, the width

24602

and height of the crop region cannot be set to be smaller than

24603

<code>floor( preCorrectionActiveArraySize.width / <a href="#static_android.scaler.availableMaxDigitalZoom">android.scaler.availableMaxDigitalZoom</a> )</code>

24604

and

24605

<code>floor( preCorrectionActiveArraySize.height / <a href="#static_android.scaler.availableMaxDigitalZoom">android.scaler.availableMaxDigitalZoom</a> )</code>,

24606

respectively.

Eino-Ville Talvala

2020-01-06 16:08:56 -0800

[diff] [blame]

24607

The camera device may adjust the crop region to account for rounding and other hardware

24608

requirements; the final crop region used will be included in the output capture result.

Shuzhen Wang

2020-09-14 11:40:07 -0700

[diff] [blame]

24609

The camera sensor output aspect ratio depends on factors such as output stream

24610

combination and <a href="#controls_android.control.aeTargetFpsRange">android.control.aeTargetFpsRange</a>, and shouldn't be adjusted by using

24611

this control. And the camera device will treat different camera sensor output sizes

24612

(potentially with in-sensor crop) as the same crop of

24613

<a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a>. As a result, the application shouldn't assume the

24614

maximum crop region always maps to the same aspect ratio or field of view for the

24615

sensor output.

Shuzhen Wang

2019-11-07 15:59:22 -0800

[diff] [blame]

24616

Starting from API level 30, it's strongly recommended to use <a href="#controls_android.control.zoomRatio">android.control.zoomRatio</a>

24617

to take advantage of better support for zoom with logical multi-camera. The benefits

24618

include better precision with optical-digital zoom combination, and ability to do

24619

zoom-out from 1.0x. When using <a href="#controls_android.control.zoomRatio">android.control.zoomRatio</a> for zoom, the crop region in

Shuzhen Wang

2020-09-14 11:40:07 -0700

[diff] [blame]

24620

the capture request should be left as the default activeArray size. The

Shuzhen Wang

2019-11-07 15:59:22 -0800

[diff] [blame]

24621

coordinate system is post-zoom, meaning that the activeArraySize or

Eino-Ville Talvala

2020-01-06 16:08:56 -0800

[diff] [blame]

24622

preCorrectionActiveArraySize covers the camera device's field of view "after" zoom. See

24623

<a href="#controls_android.control.zoomRatio">android.control.zoomRatio</a> for details.

Jayant Chowdhary

2020-11-09 09:08:31 -0800

[diff] [blame]

24624

For camera devices with the

24625

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraMetadata.html#REQUEST_AVAILABLE_CAPABILITIES_ULTRA_HIGH_RESOLUTION_SENSOR">CameraMetadata#REQUEST_AVAILABLE_CAPABILITIES_ULTRA_HIGH_RESOLUTION_SENSOR</a>

24626

capability, <a href="#static_android.sensor.info.activeArraySizeMaximumResolution">android.sensor.info.activeArraySizeMaximumResolution</a> /

24627

<a href="#static_android.sensor.info.preCorrectionActiveArraySizeMaximumResolution">android.sensor.info.preCorrectionActiveArraySizeMaximumResolution</a> must be used as the

24628

coordinate system for requests where <a href="#controls_android.sensor.pixelMode">android.sensor.pixelMode</a> is set to

24629

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraMetadata.html#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION">CameraMetadata#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION</a>.

Eino-Ville Talvala

2014-06-06 14:35:41 -0700

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

24634

<th class="th_details" colspan="6">HAL Implementation Details</th>

Eino-Ville Talvala

2014-06-06 14:35:41 -0700

[diff] [blame]

24635

</tr>

24636

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

24637

Eino-Ville Talvala

2014-06-06 14:35:41 -0700

[diff] [blame]

24638

The output streams must maintain square pixels at all

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

24639

times, no matter what the relative aspect ratios of the

24640

crop region and the stream are. Negative values for

Igor Murashkin

2013-12-09 12:06:17 -0800

[diff] [blame]

24641

corner are allowed for raw output if full pixel array is

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

24642

larger than active pixel array. Width and height may be

24643

rounded to nearest larger supportable width, especially

24644

for raw output, where only a few fixed scales may be

Eino-Ville Talvala

2014-06-06 14:35:41 -0700

[diff] [blame]

24645

possible.

Shuzhen Wang

2019-11-07 15:59:22 -0800

[diff] [blame]

24646

If <a href="#controls_android.control.zoomRatio">android.control.zoomRatio</a> is supported by the HAL, the HAL must report the zoom

24647

ratio via <a href="#controls_android.control.zoomRatio">android.control.zoomRatio</a>, and change the coordinate system such that

24648

<a href="#static_android.sensor.info.preCorrectionActiveArraySize">android.sensor.info.preCorrectionActiveArraySize</a> or <a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a>(depending on whether <a href="#controls_android.distortionCorrection.mode">android.distortionCorrection.mode</a> is supported) is used to

24649

represent the camera field-of-view after zoom. see <a href="#controls_android.control.zoomRatio">android.control.zoomRatio</a> for

24650

details.

Eino-Ville Talvala

2014-06-06 14:35:41 -0700

[diff] [blame]

24651

HAL2.x uses only (x, y, width)

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

24652

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

24653

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

24654

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

24655

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

24656

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

24657

Eino-Ville Talvala

2020-01-06 13:06:22 -0800

[diff] [blame]

24658

24659

24660

<td class="entry_name

24661

" rowspan="5">

24662

android.scaler.rotateAndCrop

</td>

byte

[public]

<li>

NONE (v3.5)

No rotate and crop is applied. Processed outputs are in the sensor orientation.

</li>

<li>

90 (v3.5)

Processed images are rotated by 90 degrees clockwise, and then cropped

24681

to the original aspect ratio.

</li>

<li>

180 (v3.5)

Processed images are rotated by 180 degrees. Since the aspect ratio does not

24686

change, no cropping is performed.

</li>

<li>

270 (v3.5)

Processed images are rotated by 270 degrees clockwise, and then cropped

24691

to the original aspect ratio.

</li>

<li>

AUTO (v3.5)

The camera API automatically selects the best concrete value for

24696

rotate-and-crop based on the application's support for resizability and the current

24697

multi-window mode.

24698

If the application does not support resizing but the display mode for its main

24699

Activity is not in a typical orientation, the camera API will set <code>ROTATE_AND_CROP_90</code>

24700

or some other supported rotation value, depending on device configuration,

24701

to ensure preview and captured images are correctly shown to the user. Otherwise,

24702

<code>ROTATE_AND_CROP_NONE</code> will be selected.

24703

When a value other than NONE is selected, several metadata fields will also be parsed

24704

differently to ensure that coordinates are correctly handled for features like drawing

24705

face detection boxes or passing in tap-to-focus coordinates. The camera API will

24706

convert positions in the active array coordinate system to/from the cropped-and-rotated

24707

coordinate system to make the operation transparent for applications.

24708

No coordinate mapping will be done when the application selects a non-AUTO mode.

</li>

</ul>

</td>

24713

24714

24715

Whether a rotation-and-crop operation is applied to processed

24716

outputs from the camera.

</td>

</td>

<a href="#static_android.scaler.availableRotateAndCropModes">android.scaler.availableRotateAndCropModes</a>

</td>

3.5

</td>

</td>

</tr>

<th class="th_details" colspan="6">Details</th>

</tr>

This control is primarily intended to help camera applications with no support for

24740

multi-window modes to work correctly on devices where multi-window scenarios are

24741

unavoidable, such as foldables or other devices with variable display geometry or more

24742

free-form window placement (such as laptops, which often place portrait-orientation apps

24743

in landscape with pillarboxing).

24744

If supported, the default value is <code>ROTATE_AND_CROP_AUTO</code>, which allows the camera API

24745

to enable backwards-compatibility support for applications that do not support resizing

24746

/ multi-window modes, when the device is in fact in a multi-window mode (such as inset

24747

portrait on laptops, or on a foldable device in some fold states). In addition,

24748

<code>ROTATE_AND_CROP_NONE</code> and <code>ROTATE_AND_CROP_90</code> will always be available if this control

24749

is supported by the device. If not supported, devices API level 30 or higher will always

24750

list only <code>ROTATE_AND_CROP_NONE</code>.

24751

When <code>CROP_AUTO</code> is in use, and the camera API activates backward-compatibility mode,

24752

several metadata fields will also be parsed differently to ensure that coordinates are

24753

correctly handled for features like drawing face detection boxes or passing in

24754

tap-to-focus coordinates. The camera API will convert positions in the active array

24755

coordinate system to/from the cropped-and-rotated coordinate system to make the

24756

operation transparent for applications. The following controls are affected:

24757

<ul>

24758

<li><a href="#controls_android.control.aeRegions">android.control.aeRegions</a></li>

24759

<li><a href="#controls_android.control.afRegions">android.control.afRegions</a></li>

24760

<li><a href="#controls_android.control.awbRegions">android.control.awbRegions</a></li>

24761

<li><a href="#dynamic_android.statistics.faces">android.statistics.faces</a></li>

24762

</ul>

24763

Capture results will contain the actual value selected by the API;

24764

<code>ROTATE_AND_CROP_AUTO</code> will never be seen in a capture result.

24765

Applications can also select their preferred cropping mode, either to opt out of the

24766

backwards-compatibility treatment, or to use the cropping feature themselves as needed.

24767

In this case, no coordinate translation will be done automatically, and all controls

24768

will continue to use the normal active array coordinates.

24769

Cropping and rotating is done after the application of digital zoom (via either

24770

<a href="#controls_android.scaler.cropRegion">android.scaler.cropRegion</a> or <a href="#controls_android.control.zoomRatio">android.control.zoomRatio</a>), but before each individual

24771

output is further cropped and scaled. It only affects processed outputs such as

24772

YUV, PRIVATE, and JPEG. It has no effect on RAW outputs.

24773

When <code>CROP_90</code> or <code>CROP_270</code> are selected, there is a significant loss to the field of

24774

view. For example, with a 4:3 aspect ratio output of 1600x1200, <code>CROP_90</code> will still

24775

produce 1600x1200 output, but these buffers are cropped from a vertical 3:4 slice at the

24776

center of the 4:3 area, then rotated to be 4:3, and then upscaled to 1600x1200. Only

24777

56.25% of the original FOV is still visible. In general, for an aspect ratio of <code>w:h</code>,

24778

the crop and rotate operation leaves <code>(h/w)^2</code> of the field of view visible. For 16:9,

24779

this is ~31.6%.

24780

As a visual example, the figure below shows the effect of <code>ROTATE_AND_CROP_90</code> on the

24781

outputs for the following parameters:

24782

<ul>

24783

<li>Sensor active array: <code>2000x1500</code></li>

24784

<li>Crop region: top-left: <code>(500, 375)</code>, size: <code>(1000, 750)</code> (4:3 aspect ratio)</li>

24785

<li>Output streams: YUV <code>640x480</code> and YUV <code>1280x720</code></li>

24786

<li><code>ROTATE_AND_CROP_90</code></li>

24787

</ul>

24788

24789

With these settings, the regions of the active array covered by the output streams are:

24790

<ul>

24791

<li>640x480 stream crop: top-left: <code>(219, 375)</code>, size: <code>(562, 750)</code></li>

24792

<li>1280x720 stream crop: top-left: <code>(289, 375)</code>, size: <code>(422, 750)</code></li>

24793

</ul>

24794

Since the buffers are rotated, the buffers as seen by the application are:

24795

<ul>

24796

<li>640x480 stream: top-left: <code>(781, 375)</code> on active array, size: <code>(640, 480)</code>, downscaled 1.17x from sensor pixels</li>

24797

<li>1280x720 stream: top-left: <code>(711, 375)</code> on active array, size: <code>(1280, 720)</code>, upscaled 1.71x from sensor pixels</li>

</ul>

</td>

</tr>

<th class="th_details" colspan="6">HAL Implementation Details</th>

</tr>

ROTATE_AND_CROP_AUTO will never be sent to the HAL, though it must be set as the default

24808

value in all the capture request templates by the HAL. The camera service will

24809

translate AUTO to a specific rotation value based on the current application's

24810

multi-window state and its support of resizability.

24811

The HAL also does not need to consider coordinate transforms for ROTATE_AND_CROP - all

24812

capture request and result fields should be kept in the active array coordinate frame.

24813

Any translation required to implement ROTATE_AND_CROP_AUTO will be handled by the camera

service.

</td>

</tr>

24820

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</tbody>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

24827

<tr><td colspan="7" id="section_sensor" class="section">sensor</td></tr>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

24828

24829

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

24830

<tr><td colspan="7" class="kind">controls</td></tr>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

24831

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

24832

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

24833

<tr>

24834

<th class="th_name">Property Name</th>

24835

24836

<th class="th_description">Description</th>

24837

<th class="th_units">Units</th>

24838

<th class="th_range">Range</th>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

24839

<th class="th_hal_version">Initial HIDL HAL version</th>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</tr>

</thead>

<tbody>

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

24856

<td class="entry_name

24857

" rowspan="3">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

24858

android.sensor.exposureTime

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

24859

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

24860

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

24861

int64

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

24862

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

24863

[public]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

24864

24865

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

24866

[full]

24867

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

24871

</td>

24872

24873

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

24874

Duration each pixel is exposed to

24875

light.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

24879

Nanoseconds

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Eino-Ville Talvala

2014-01-02 16:11:44 -0800

[diff] [blame]

24883

<a href="#static_android.sensor.info.exposureTimeRange">android.sensor.info.exposureTimeRange</a>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

24884

</td>

24885

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

24890

24891

Igor Murashkin

2012-12-05 14:49:11 -0800

[diff] [blame]

24892

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</ul>

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

24896

</tr>

24897

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

24898

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

24899

</tr>

24900

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

24901

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

24902

If the sensor can't expose this exact duration, it will shorten the

24903

duration exposed to the nearest possible value (rather than expose longer).

24904

The final exposure time used will be available in the output capture result.

24905

This control is only effective if <a href="#controls_android.control.aeMode">android.control.aeMode</a> or <a href="#controls_android.control.mode">android.control.mode</a> is set to

24906

OFF; otherwise the auto-exposure algorithm will override this value.

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

24907

</td>

24908

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

24909

24910

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

24911

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

24912

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

24916

<td class="entry_name

24917

" rowspan="5">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

24918

android.sensor.frameDuration

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

24919

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

24920

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

24921

int64

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

24922

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

24923

[public]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

24924

24925

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

24926

[full]

24927

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

24931

</td>

24932

24933

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

24934

Duration from start of frame exposure to

Igor Murashkin

2014-01-13 17:22:58 -0800

[diff] [blame]

24935

start of next frame exposure.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

24939

Nanoseconds

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

24943

See <a href="#static_android.sensor.info.maxFrameDuration">android.sensor.info.maxFrameDuration</a>, <a href="https://developer.android.com/reference/android/hardware/camera2/params/StreamConfigurationMap.html">StreamConfigurationMap</a>.

24944

The duration is capped to <code>max(duration, exposureTime + overhead)</code>.

</td>

3.2

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

24949

</td>

24950

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

24951

24952

Igor Murashkin

2012-12-05 14:49:11 -0800

[diff] [blame]

24953

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</ul>

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

24957

</tr>

24958

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

24959

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

24960

</tr>

24961

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

24962

Igor Murashkin

2014-01-13 17:22:58 -0800

[diff] [blame]

24963

The maximum frame rate that can be supported by a camera subsystem is

24964

a function of many factors:

24965

<ul>

24966

<li>Requested resolutions of output image streams</li>

24967

<li>Availability of binning / skipping modes on the imager</li>

24968

<li>The bandwidth of the imager interface</li>

24969

<li>The bandwidth of the various ISP processing blocks</li>

24970

</ul>

24971

Since these factors can vary greatly between different ISPs and

24972

sensors, the camera abstraction tries to represent the bandwidth

24973

restrictions with as simple a model as possible.

24974

The model presented has the following characteristics:

24975

<ul>

24976

<li>The image sensor is always configured to output the smallest

24977

resolution possible given the application's requested output stream

24978

sizes. The smallest resolution is defined as being at least as large

24979

as the largest requested output stream size; the camera pipeline must

24980

never digitally upsample sensor data when the crop region covers the

24981

whole sensor. In general, this means that if only small output stream

24982

resolutions are configured, the sensor can provide a higher frame

24983

rate.</li>

24984

<li>Since any request may use any or all the currently configured

24985

output streams, the sensor and ISP must be configured to support

24986

scaling a single capture to all the streams at the same time. This

24987

means the camera pipeline must be ready to produce the largest

24988

requested output size without any delay. Therefore, the overall

24989

frame rate of a given configured stream set is governed only by the

24990

largest requested stream resolution.</li>

24991

<li>Using more than one output stream in a request does not affect the

24992

frame duration.</li>

Igor Murashkin

2014-02-07 14:31:31 -0800

[diff] [blame]

24993

<li>Certain format-streams may need to do additional background processing

24994

before data is consumed/produced by that stream. These processors

24995

can run concurrently to the rest of the camera pipeline, but

24996

cannot process more than 1 capture at a time.</li>

Igor Murashkin

2014-01-13 17:22:58 -0800

[diff] [blame]

24997

</ul>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

24998

The necessary information for the application, given the model above, is provided via

Eino-Ville Talvala

2015-04-16 13:49:52 -0700

[diff] [blame]

24999

<a href="https://developer.android.com/reference/android/hardware/camera2/params/StreamConfigurationMap.html#getOutputMinFrameDuration">StreamConfigurationMap#getOutputMinFrameDuration</a>.

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

25000

These are used to determine the maximum frame rate / minimum frame duration that is

25001

possible for a given stream configuration.

Igor Murashkin

2014-01-13 17:22:58 -0800

[diff] [blame]

25002

Specifically, the application can use the following rules to

Igor Murashkin

2014-02-07 14:31:31 -0800

[diff] [blame]

25003

determine the minimum frame duration it can request from the camera

Igor Murashkin

2014-01-13 17:22:58 -0800

[diff] [blame]

25004

device:

25005

<ol>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

25006

<li>Let the set of currently configured input/output streams be called <code>S</code>.</li>

25007

<li>Find the minimum frame durations for each stream in <code>S</code>, by looking it up in <a href="https://developer.android.com/reference/android/hardware/camera2/params/StreamConfigurationMap.html#getOutputMinFrameDuration">StreamConfigurationMap#getOutputMinFrameDuration</a>

25008

(with its respective size/format). Let this set of frame durations be called <code>F</code>.</li>

25009

<li>For any given request <code>R</code>, the minimum frame duration allowed for <code>R</code> is the maximum

25010

out of all values in <code>F</code>. Let the streams used in <code>R</code> be called <code>S_r</code>.</li>

Igor Murashkin

2014-01-13 17:22:58 -0800

[diff] [blame]

25011

</ol>

Eino-Ville Talvala

2015-04-16 13:49:52 -0700

[diff] [blame]

25012

If none of the streams in <code>S_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>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

25013

using its respective size/format), then the frame duration in <code>F</code> determines the steady

25014

state frame rate that the application will get if it uses <code>R</code> as a repeating request. Let

25015

this special kind of request be called <code>Rsimple</code>.

25016

A repeating request <code>Rsimple</code> can be occasionally interleaved by a single capture of a

25017

new request <code>Rstall</code> (which has at least one in-use stream with a non-0 stall time) and if

25018

<code>Rstall</code> has the same minimum frame duration this will not cause a frame rate loss if all

25019

buffers from the previous <code>Rstall</code> have already been delivered.

25020

For more details about stalling, see <a href="https://developer.android.com/reference/android/hardware/camera2/params/StreamConfigurationMap.html#getOutputStallDuration">StreamConfigurationMap#getOutputStallDuration</a>.

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

25021

This control is only effective if <a href="#controls_android.control.aeMode">android.control.aeMode</a> or <a href="#controls_android.control.mode">android.control.mode</a> is set to

25022

OFF; otherwise the auto-exposure algorithm will override this value.

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

25023

</td>

25024

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

25025

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

25026

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

25027

<th class="th_details" colspan="6">HAL Implementation Details</th>

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

25028

</tr>

25029

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

25030

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

25031

For more details about stalling, see

25032

<a href="#static_android.scaler.availableStallDurations">android.scaler.availableStallDurations</a>.

25033

</td>

25034

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

25035

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

25036

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

25037

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

25041

<td class="entry_name

Eino-Ville Talvala

2014-06-06 14:35:41 -0700

[diff] [blame]

25042

" rowspan="5">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

25043

android.sensor.sensitivity

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

25044

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

25045

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

25046

int32

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

25047

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

25048

[public]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

25049

25050

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

25051

[full]

25052

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

25056

</td>

25057

25058

Eino-Ville Talvala

2014-06-06 14:35:41 -0700

[diff] [blame]

25059

The amount of gain applied to sensor data

25060

before processing.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

25064

ISO arithmetic units

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Eino-Ville Talvala

2014-01-02 16:11:44 -0800

[diff] [blame]

25068

<a href="#static_android.sensor.info.sensitivityRange">android.sensor.info.sensitivityRange</a>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

25069

</td>

25070

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

25075

25076

Igor Murashkin

2012-12-05 14:49:11 -0800

[diff] [blame]

25077

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</ul>

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

25081

</tr>

25082

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

25083

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

25084

</tr>

25085

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

25086

Eino-Ville Talvala

2014-06-06 14:35:41 -0700

[diff] [blame]

25087

The sensitivity is the standard ISO sensitivity value,

25088

as defined in ISO 12232:2006.

25089

The sensitivity must be within <a href="#static_android.sensor.info.sensitivityRange">android.sensor.info.sensitivityRange</a>, and

25090

if if it less than <a href="#static_android.sensor.maxAnalogSensitivity">android.sensor.maxAnalogSensitivity</a>, the camera device

25091

is guaranteed to use only analog amplification for applying the gain.

25092

If the camera device cannot apply the exact sensitivity

25093

requested, it will reduce the gain to the nearest supported

25094

value. The final sensitivity used will be available in the

25095

output capture result.

Yin-Chia Yeh

2016-01-18 19:14:55 -0800

[diff] [blame]

25096

This control is only effective if <a href="#controls_android.control.aeMode">android.control.aeMode</a> or <a href="#controls_android.control.mode">android.control.mode</a> is set to

25097

OFF; otherwise the auto-exposure algorithm will override this value.

Shuzhen Wang

0496197

2019-07-08 15:03:24 -0700

[diff] [blame]

25098

Note that for devices supporting postRawSensitivityBoost, the total sensitivity applied

25099

to the final processed image is the combination of <a href="#controls_android.sensor.sensitivity">android.sensor.sensitivity</a> and

25100

<a href="#controls_android.control.postRawSensitivityBoost">android.control.postRawSensitivityBoost</a>. In case the application uses the sensor

25101

sensitivity from last capture result of an auto request for a manual request, in order

25102

to achieve the same brightness in the output image, the application should also

25103

set postRawSensitivityBoost.

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

25104

</td>

25105

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

25106

Eino-Ville Talvala

2014-06-06 14:35:41 -0700

[diff] [blame]

25107

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

25108

<th class="th_details" colspan="6">HAL Implementation Details</th>

Eino-Ville Talvala

2014-06-06 14:35:41 -0700

[diff] [blame]

25109

</tr>

25110

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

25111

Eino-Ville Talvala

2014-06-06 14:35:41 -0700

[diff] [blame]

25112

ISO 12232:2006 REI method is acceptable.

25113

</td>

25114

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

25115

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

25116

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

25117

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

25118

Igor Murashkin

2014-01-09 17:43:38 -0800

[diff] [blame]

25119

25120

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

25121

<td class="entry_name

25122

" rowspan="5">

Igor Murashkin

2014-01-09 17:43:38 -0800

[diff] [blame]

25123

android.sensor.testPatternData

</td>

int32

x

4

[public]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

25138

Igor Murashkin

2014-01-09 17:43:38 -0800

[diff] [blame]

25139

</td>

25140

25141

25142

A pixel <code>[R, G_even, G_odd, B]</code> that supplies the test pattern

25143

when <a href="#controls_android.sensor.testPatternMode">android.sensor.testPatternMode</a> is SOLID_COLOR.

</td>

</td>

Igor Murashkin

2014-01-09 17:43:38 -0800

[diff] [blame]

25150

</td>

25151

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2014-01-09 17:43:38 -0800

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

25161

<th class="th_details" colspan="6">Details</th>

Igor Murashkin

2014-01-09 17:43:38 -0800

[diff] [blame]

25162

</tr>

25163

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

25164

Igor Murashkin

2014-01-09 17:43:38 -0800

[diff] [blame]

25165

Each color channel is treated as an unsigned 32-bit integer.

25166

The camera device then uses the most significant X bits

25167

that correspond to how many bits are in its Bayer raw sensor

25168

output.

25169

For example, a sensor with RAW10 Bayer output would use the

25170

10 most significant bits from each color channel.

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

25175

<th class="th_details" colspan="6">HAL Implementation Details</th>

Igor Murashkin

2014-01-09 17:43:38 -0800

[diff] [blame]

25176

</tr>

25177

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

25178

Igor Murashkin

2014-01-09 17:43:38 -0800

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

25183

Igor Murashkin

2014-01-09 17:43:38 -0800

[diff] [blame]

25184

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

25188

<td class="entry_name

25189

" rowspan="5">

Igor Murashkin

2014-01-09 17:43:38 -0800

[diff] [blame]

25190

android.sensor.testPatternMode

</td>

int32

[public]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

25200

Igor Murashkin

2014-01-09 17:43:38 -0800

[diff] [blame]

25201

25202

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

25203

OFF (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

25204

No test pattern mode is used, and the camera

25205

device returns captures from the image sensor.

25206

This is the default if the key is not set.

Igor Murashkin

2014-01-09 17:43:38 -0800

[diff] [blame]

25207

</li>

25208

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

25209

SOLID_COLOR (v3.2)

Igor Murashkin

2014-01-09 17:43:38 -0800

[diff] [blame]

25210

Each pixel in <code>[R, G_even, G_odd, B]</code> is replaced by its

25211

respective color channel provided in

25212

<a href="#controls_android.sensor.testPatternData">android.sensor.testPatternData</a>.

25213

For example:

Eino-Ville Talvala

2021-05-27 14:43:59 -0700

[diff] [blame]

25214

<pre><code><a href="#controls_android.sensor.testPatternData">android.sensor.testPatternData</a> = [0, 0xFFFFFFFF, 0xFFFFFFFF, 0]

Igor Murashkin

2014-01-09 17:43:38 -0800

[diff] [blame]

25215

</code></pre>

25216

All green pixels are 100% green. All red/blue pixels are black.

Eino-Ville Talvala

2021-05-27 14:43:59 -0700

[diff] [blame]

25217

<pre><code><a href="#controls_android.sensor.testPatternData">android.sensor.testPatternData</a> = [0xFFFFFFFF, 0, 0xFFFFFFFF, 0]

Igor Murashkin

2014-01-09 17:43:38 -0800

[diff] [blame]

25218

</code></pre>

25219

All red pixels are 100% red. Only the odd green pixels

25220

are 100% green. All blue pixels are 100% black.

25221

</li>

25222

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

25223

COLOR_BARS (v3.2)

Igor Murashkin

2014-01-09 17:43:38 -0800

[diff] [blame]

25224

All pixel data is replaced with an 8-bar color pattern.

25225

The vertical bars (left-to-right) are as follows:

<ul>

<li>100% white</li>

<li>yellow</li>

<li>green</li>

<li>magenta</li>

<li>black</li>

</ul>

In general the image would look like the following:

25237

<pre><code>W Y C G M R B K

W Y C G M R B K

W Y C G M R B K

W Y C G M R B K

W Y C G M R B K

. . . . . . . .

. . . . . . . .

. . . . . . . .

(B = Blue, K = Black)

25247

</code></pre>

25248

Each bar should take up 1/8 of the sensor pixel array width.

25249

When this is not possible, the bar size should be rounded

25250

down to the nearest integer and the pattern can repeat

25251

on the right side.

25252

Each bar's height must always take up the full sensor

25253

pixel array height.

25254

Each pixel in this test pattern must be set to either

25255

0% intensity or 100% intensity.

25256

</li>

25257

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

25258

COLOR_BARS_FADE_TO_GRAY (v3.2)

Igor Murashkin

2014-01-09 17:43:38 -0800

[diff] [blame]

25259

The test pattern is similar to COLOR_BARS, except that

25260

each bar should start at its specified color at the top,

25261

and fade to gray at the bottom.

25262

Furthermore each bar is further subdivided into a left and

25263

right half. The left half should have a smooth gradient,

25264

and the right half should have a quantized gradient.

25265

In particular, the right half's should consist of blocks of the

25266

same color for 1/16th active sensor pixel array width.

25267

The least significant bits in the quantized gradient should

25268

be copied from the most significant bits of the smooth gradient.

25269

The height of each bar should always be a multiple of 128.

25270

When this is not the case, the pattern should repeat at the bottom

25271

of the image.

25272

</li>

25273

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

25274

PN9 (v3.2)

Igor Murashkin

2014-01-09 17:43:38 -0800

[diff] [blame]

25275

All pixel data is replaced by a pseudo-random sequence

25276

generated from a PN9 512-bit sequence (typically implemented

25277

in hardware with a linear feedback shift register).

25278

The generator should be reset at the beginning of each frame,

25279

and thus each subsequent raw frame with this test pattern should

25280

be exactly the same as the last.

25281

</li>

25282

<li>

Eino-Ville Talvala

2021-05-27 14:43:59 -0700

[diff] [blame]

25283

BLACK (v3.6)

25284

[test]

25285

All pixel data is replaced by 0% intensity (black) values.

25286

This test pattern is identical to SOLID_COLOR with a value of <code>[0, 0, 0, 0]</code> for

25287

<a href="#controls_android.sensor.testPatternData">android.sensor.testPatternData</a>. It is recommended that devices implement full

25288

SOLID_COLOR support instead, but BLACK can be used to provide minimal support for a

25289

test pattern suitable for privacy use cases.

25290

</li>

25291

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

25292

CUSTOM1 (v3.2)

Igor Murashkin

2014-01-09 17:43:38 -0800

[diff] [blame]

25293

256

25294

The first custom test pattern. All custom patterns that are

25295

available only on this camera device are at least this numeric

25296

value.

25297

All of the custom test patterns will be static

25298

(that is the raw image must not vary from frame to frame).

</li>

</ul>

</td>

25303

25304

25305

When enabled, the sensor sends a test pattern instead of

25306

doing a real exposure from the camera.

</td>

</td>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

25313

<a href="#static_android.sensor.availableTestPatternModes">android.sensor.availableTestPatternModes</a>

Igor Murashkin

2014-01-09 17:43:38 -0800

[diff] [blame]

25314

</td>

25315

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2014-01-09 17:43:38 -0800

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

25325

<th class="th_details" colspan="6">Details</th>

Igor Murashkin

2014-01-09 17:43:38 -0800

[diff] [blame]

25326

</tr>

25327

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

25328

Igor Murashkin

2014-01-09 17:43:38 -0800

[diff] [blame]

25329

When a test pattern is enabled, all manual sensor controls specified

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

25330

by android.sensor.* will be ignored. All other controls should

Igor Murashkin

2014-01-09 17:43:38 -0800

[diff] [blame]

25331

work as normal.

25332

For example, if manual flash is enabled, flash firing should still

25333

occur (and that the test pattern remain unmodified, since the flash

25334

would not actually affect it).

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

25335

Defaults to OFF.

Igor Murashkin

2014-01-09 17:43:38 -0800

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

25340

<th class="th_details" colspan="6">HAL Implementation Details</th>

Igor Murashkin

2014-01-09 17:43:38 -0800

[diff] [blame]

25341

</tr>

25342

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

25343

Igor Murashkin

2014-01-09 17:43:38 -0800

[diff] [blame]

25344

All test patterns are specified in the Bayer domain.

25345

The HAL may choose to substitute test patterns from the sensor

25346

with test patterns from on-device memory. In that case, it should be

25347

indistinguishable to the ISP whether the data came from the

25348

sensor interconnect bus (such as CSI2) or memory.

Shuzhen Wang

e2324d1

2021-10-28 17:27:29 -0700

[diff] [blame]

25349

For privacy use cases, if the camera device:

25350

<ul>

25351

<li>supports SOLID_COLOR or BLACK test patterns,</li>

25352

<li>is a logical multi-camera, and</li>

25353

<li>lists testPatternMode as a physical request key,</li>

25354

</ul>

25355

Each physical camera must support the same SOLID_COLOR and/or BLACK test patterns

25356

as the logical camera.

Igor Murashkin

2014-01-09 17:43:38 -0800

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

25360

Igor Murashkin

2014-01-09 17:43:38 -0800

[diff] [blame]

25361

25362

Jayant Chowdhary

2020-11-09 09:08:31 -0800

[diff] [blame]

25363

25364

25365

<td class="entry_name

25366

" rowspan="3">

25367

android.sensor.pixelMode

</td>

byte

[public]

<li>

DEFAULT (v3.6)

This is the default sensor pixel mode. This is the only sensor pixel mode

25382

supported unless a camera device advertises

25383

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraMetadata.html#REQUEST_AVAILABLE_CAPABILITIES_ULTRA_HIGH_RESOLUTION_SENSOR">CameraMetadata#REQUEST_AVAILABLE_CAPABILITIES_ULTRA_HIGH_RESOLUTION_SENSOR</a>.

25384

</li>

25385

<li>

25386

MAXIMUM_RESOLUTION (v3.6)

25387

This sensor pixel mode is offered by devices with capability

25388

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraMetadata.html#REQUEST_AVAILABLE_CAPABILITIES_ULTRA_HIGH_RESOLUTION_SENSOR">CameraMetadata#REQUEST_AVAILABLE_CAPABILITIES_ULTRA_HIGH_RESOLUTION_SENSOR</a>.

25389

In this mode, sensors typically do not bin pixels, as a result can offer larger

image sizes.

</li>

</ul>

</td>

25395

25396

25397

Switches sensor pixel mode between maximum resolution mode and default mode.

</td>

</td>

</td>

3.6

</td>

</td>

</tr>

<th class="th_details" colspan="6">Details</th>

</tr>

This key controls whether the camera sensor operates in

25420

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraMetadata.html#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION">CameraMetadata#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION</a>

25421

mode or not. By default, all camera devices operate in

25422

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraMetadata.html#SENSOR_PIXEL_MODE_DEFAULT">CameraMetadata#SENSOR_PIXEL_MODE_DEFAULT</a> mode.

25423

When operating in

25424

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraMetadata.html#SENSOR_PIXEL_MODE_DEFAULT">CameraMetadata#SENSOR_PIXEL_MODE_DEFAULT</a> mode, sensors

25425

with <a href="https://developer.android.com/reference/android/hardware/camera2/CameraMetadata.html#REQUEST_AVAILABLE_CAPABILITIES_ULTRA_HIGH_RESOLUTION_SENSOR">CameraMetadata#REQUEST_AVAILABLE_CAPABILITIES_ULTRA_HIGH_RESOLUTION_SENSOR</a>

25426

capability would typically perform pixel binning in order to improve low light

25427

performance, noise reduction etc. However, in

25428

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraMetadata.html#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION">CameraMetadata#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION</a>

25429

mode (supported only

25430

by <a href="https://developer.android.com/reference/android/hardware/camera2/CameraMetadata.html#REQUEST_AVAILABLE_CAPABILITIES_ULTRA_HIGH_RESOLUTION_SENSOR">CameraMetadata#REQUEST_AVAILABLE_CAPABILITIES_ULTRA_HIGH_RESOLUTION_SENSOR</a>

25431

sensors), sensors typically operate in unbinned mode allowing for a larger image size.

25432

The stream configurations supported in

25433

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraMetadata.html#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION">CameraMetadata#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION</a>

25434

mode are also different from those of

25435

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraMetadata.html#SENSOR_PIXEL_MODE_DEFAULT">CameraMetadata#SENSOR_PIXEL_MODE_DEFAULT</a> mode.

25436

They can be queried through

25437

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics.html#get">CameraCharacteristics#get</a> with

25438

<a href="https://developer.android.com/reference/CameraCharacteristics.html#SCALER_STREAM_CONFIGURATION_MAP_MAXIMUM_RESOLUTION)">CameraCharacteristics#SCALER_STREAM_CONFIGURATION_MAP_MAXIMUM_RESOLUTION)</a>.

25439

Unless reported by both

25440

<a href="https://developer.android.com/reference/android/hardware/camera2/params/StreamConfigurationMap.html">StreamConfigurationMap</a>s, the outputs from

25441

<code><a href="#static_android.scaler.streamConfigurationMapMaximumResolution">android.scaler.streamConfigurationMapMaximumResolution</a></code> and

25442

<code><a href="#static_android.scaler.streamConfigurationMap">android.scaler.streamConfigurationMap</a></code>

25443

must not be mixed in the same CaptureRequest. In other words, these outputs are

25444

exclusive to each other.

25445

This key does not need to be set for reprocess requests.

</td>

</tr>

25452

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</tbody>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

25457

<tr><td colspan="7" class="kind">static</td></tr>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

25458

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

25459

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

25460

<tr>

25461

<th class="th_name">Property Name</th>

25462

25463

<th class="th_description">Description</th>

25464

<th class="th_units">Units</th>

25465

<th class="th_range">Range</th>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

25466

<th class="th_hal_version">Initial HIDL HAL version</th>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</tr>

</thead>

<tbody>

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

25485

<td class="entry_name

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

25486

" rowspan="5">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

25487

android.sensor.info.activeArraySize

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

25488

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

25489

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

25490

int32

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

x

4

Igor Murashkin

2013-07-17 16:29:34 -0700

[diff] [blame]

25496

[public as rectangle]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

25497

25498

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

25499

[legacy]

25500

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

25501

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

25502

<div class="entry_type_notes">Four ints defining the active pixel rectangle</div>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

25503

25504

25505

</td>

25506

25507

Ruben Brunk

2015-06-11 18:23:41 -0700

[diff] [blame]

25508

The area of the image sensor which corresponds to active pixels after any geometric

25509

distortion correction has been applied.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

25513

Pixel coordinates on the image sensor

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

25523

25524

Eino-Ville Talvala

2014-07-15 10:43:01 -0700

[diff] [blame]

25525

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</ul>

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

25529

</tr>

Zhijun He

2014-01-21 18:28:30 -0800

[diff] [blame]

25530

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

25531

<th class="th_details" colspan="6">Details</th>

Zhijun He

2014-01-21 18:28:30 -0800

[diff] [blame]

25532

</tr>

25533

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

25534

Ruben Brunk

2015-06-11 18:23:41 -0700

[diff] [blame]

25535

This is the rectangle representing the size of the active region of the sensor (i.e.

25536

the region that actually receives light from the scene) after any geometric correction

25537

has been applied, and should be treated as the maximum size in pixels of any of the

25538

image output formats aside from the raw formats.

25539

This rectangle is defined relative to the full pixel array; (0,0) is the top-left of

25540

the full pixel array, and the size of the full pixel array is given by

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

25541

<a href="#static_android.sensor.info.pixelArraySize">android.sensor.info.pixelArraySize</a>.

Ruben Brunk

2015-06-11 18:23:41 -0700

[diff] [blame]

25542

The coordinate system for most other keys that list pixel coordinates, including

25543

<a href="#controls_android.scaler.cropRegion">android.scaler.cropRegion</a>, is defined relative to the active array rectangle given in

25544

this field, with <code>(0, 0)</code> being the top-left of this rectangle.

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

25545

The active array may be smaller than the full pixel array, since the full array may

Yin-Chia Yeh

2018-06-15 15:35:05 -0700

[diff] [blame]

25546

include black calibration pixels or other inactive regions.

25547

For devices that do not support <a href="#controls_android.distortionCorrection.mode">android.distortionCorrection.mode</a> control, the active

25548

array must be the same as <a href="#static_android.sensor.info.preCorrectionActiveArraySize">android.sensor.info.preCorrectionActiveArraySize</a>.

25549

For devices that support <a href="#controls_android.distortionCorrection.mode">android.distortionCorrection.mode</a> control, the active array must

25550

be enclosed by <a href="#static_android.sensor.info.preCorrectionActiveArraySize">android.sensor.info.preCorrectionActiveArraySize</a>. The difference between

25551

pre-correction active array and active array accounts for scaling or cropping caused

25552

by lens geometric distortion correction.

25553

In general, application should always refer to active array size for controls like

25554

metering regions or crop region. Two exceptions are when the application is dealing with

25555

RAW image buffers (RAW_SENSOR, RAW10, RAW12 etc), or when application explicitly set

25556

<a href="#controls_android.distortionCorrection.mode">android.distortionCorrection.mode</a> to OFF. In these cases, application should refer

25557

to <a href="#static_android.sensor.info.preCorrectionActiveArraySize">android.sensor.info.preCorrectionActiveArraySize</a>.

Ruben Brunk

2015-06-11 18:23:41 -0700

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

25562

<th class="th_details" colspan="6">HAL Implementation Details</th>

Ruben Brunk

2015-06-11 18:23:41 -0700

[diff] [blame]

25563

</tr>

25564

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

25565

Ruben Brunk

2015-06-11 18:23:41 -0700

[diff] [blame]

25566

This array contains <code>(xmin, ymin, width, height)</code>. The <code>(xmin, ymin)</code> must be

25567

>= <code>(0,0)</code>.

25568

The <code>(width, height)</code> must be <= <code><a href="#static_android.sensor.info.pixelArraySize">android.sensor.info.pixelArraySize</a></code>.

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

25572

Ruben Brunk

2015-06-11 18:23:41 -0700

[diff] [blame]

25573

25574

25575

Zhijun He

2013-07-17 09:42:58 -0700

[diff] [blame]

25576

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

25577

<td class="entry_name

Eino-Ville Talvala

2014-06-06 14:35:41 -0700

[diff] [blame]

25578

" rowspan="3">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

25579

android.sensor.info.sensitivityRange

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

25580

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

25581

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

25582

int32

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

x

Zhijun He

2013-07-17 09:42:58 -0700

[diff] [blame]

25586

2

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

25587

Ruben Brunk

2014-05-27 18:52:49 -0700

[diff] [blame]

25588

[public as rangeInt]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

25589

25590

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

25591

[full]

25592

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

25593

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

25594

<div class="entry_type_notes">Range of supported sensitivities</div>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

25595

25596

25597

</td>

25598

25599

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

25600

Range of sensitivities for <a href="#controls_android.sensor.sensitivity">android.sensor.sensitivity</a> supported by this

25601

camera device.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

Eino-Ville Talvala

2014-09-25 10:27:48 -0700

[diff] [blame]

25608

Min <= 100, Max >= 800

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

25609

</td>

25610

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

25615

25616

Igor Murashkin

2012-12-05 14:49:11 -0800

[diff] [blame]

25617

25618

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</ul>

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

25622

</tr>

Eino-Ville Talvala

2014-06-06 14:35:41 -0700

[diff] [blame]

25623

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

25624

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2014-06-06 14:35:41 -0700

[diff] [blame]

25625

</tr>

25626

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

25627

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

25628

The values are the standard ISO sensitivity values,

Eino-Ville Talvala

2014-06-06 14:35:41 -0700

[diff] [blame]

25629

as defined in ISO 12232:2006.

25630

</td>

25631

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

25632

25633

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

25634

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

25635

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

25639

<td class="entry_name

Shuzhen Wang

2018-10-15 12:00:13 -0700

[diff] [blame]

25640

" rowspan="3">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

25641

android.sensor.info.colorFilterArrangement

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

25642

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

25643

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

25644

byte

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

25645

Zhijun He

f769dd9

2014-04-08 17:22:07 -0700

[diff] [blame]

25646

[public]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

25647

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

25648

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

25649

[full]

25650

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

25651

25652

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

25653

25654

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

25655

RGGB (v3.2)

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

25656

</li>

25657

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

25658

GRBG (v3.2)

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

25659

</li>

25660

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

25661

GBRG (v3.2)

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

25662

</li>

25663

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

25664

BGGR (v3.2)

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

25665

</li>

25666

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

25667

RGB (v3.2)

Igor Murashkin

2014-01-15 17:05:22 -0800

[diff] [blame]

25668

Sensor is not Bayer; output has 3 16-bit

25669

values for each pixel, instead of just 1 16-bit value

25670

per pixel.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

25671

</li>

Shuzhen Wang

2018-10-15 12:00:13 -0700

[diff] [blame]

25672

<li>

Shuzhen Wang

b6ca2fe

2018-11-20 15:03:13 -0800

[diff] [blame]

25673

MONO (v3.4)

Shuzhen Wang

2018-10-15 12:00:13 -0700

[diff] [blame]

25674

Sensor doesn't have any Bayer color filter.

25675

Such sensor captures visible light in monochrome. The exact weighting and

25676

wavelengths captured is not specified, but generally only includes the visible

25677

frequencies. This value implies a MONOCHROME camera.

25678

</li>

25679

<li>

Shuzhen Wang

b6ca2fe

2018-11-20 15:03:13 -0800

[diff] [blame]

25680

NIR (v3.4)

Shuzhen Wang

2018-10-15 12:00:13 -0700

[diff] [blame]

25681

Sensor has a near infrared filter capturing light with wavelength between

25682

roughly 750nm and 1400nm, and the same filter covers the whole sensor array. This

25683

value implies a MONOCHROME camera.

25684

</li>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

25685

</ul>

25686

25687

</td>

25688

25689

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

25690

The arrangement of color filters on sensor;

Igor Murashkin

2013-12-09 12:06:17 -0800

[diff] [blame]

25691

represents the colors in the top-left 2x2 section of

Shuzhen Wang

2018-10-15 12:00:13 -0700

[diff] [blame]

25692

the sensor, in reading order, for a Bayer camera, or the

25693

light spectrum it captures for MONOCHROME camera.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

25706

25707

Eino-Ville Talvala

2014-07-15 10:43:01 -0700

[diff] [blame]

25708

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</ul>

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

25712

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

25713

Shuzhen Wang

2018-10-15 12:00:13 -0700

[diff] [blame]

25714

25715

<th class="th_details" colspan="6">HAL Implementation Details</th>

</tr>

Starting from Android Q, the colorFilterArrangement for a MONOCHROME camera must be

25720

single color patterns, such as MONO or NIR.

25721

</td>

25722

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

25723

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

25724

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

25725

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

25729

<td class="entry_name

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

25730

" rowspan="3">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

25731

android.sensor.info.exposureTimeRange

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

25732

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

25733

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

25734

int64

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

x

2

Ruben Brunk

2014-05-27 18:52:49 -0700

[diff] [blame]

25740

[public as rangeLong]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

25741

25742

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

25743

[full]

25744

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

25745

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

25746

<div class="entry_type_notes">nanoseconds</div>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

25747

25748

25749

</td>

25750

25751

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

25752

The range of image exposure times for <a href="#controls_android.sensor.exposureTime">android.sensor.exposureTime</a> supported

25753

by this camera device.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

25757

Nanoseconds

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

25761

The minimum exposure time will be less than 100 us. For FULL

25762

capability devices (<a href="#static_android.info.supportedHardwareLevel">android.info.supportedHardwareLevel</a> == FULL),

25763

the maximum exposure time will be greater than 100ms.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

25764

</td>

25765

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

25770

25771

Igor Murashkin

2012-12-05 14:49:11 -0800

[diff] [blame]

25772

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</ul>

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

25776

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

25777

Igor Murashkin

2014-01-27 16:00:26 -0800

[diff] [blame]

25778

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

25779

<th class="th_details" colspan="6">HAL Implementation Details</th>

Igor Murashkin

2014-01-27 16:00:26 -0800

[diff] [blame]

25780

</tr>

25781

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

25782

Zhijun He

7a8aea6

2014-03-18 13:37:23 -0700

[diff] [blame]

25783

For FULL capability devices (<a href="#static_android.info.supportedHardwareLevel">android.info.supportedHardwareLevel</a> == FULL),

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

25784

The maximum of the range SHOULD be at least 1 second (1e9), MUST be at least

25785

100ms.

Igor Murashkin

2014-01-27 16:00:26 -0800

[diff] [blame]

25786

</td>

25787

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

25788

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

25789

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

25790

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

25794

<td class="entry_name

25795

" rowspan="5">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

25796

android.sensor.info.maxFrameDuration

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

25797

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

25798

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

25799

int64

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

25800

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

25801

[public]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

25802

25803

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

25804

[full]

25805

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

25809

</td>

25810

25811

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

25812

The maximum possible frame duration (minimum frame rate) for

25813

<a href="#controls_android.sensor.frameDuration">android.sensor.frameDuration</a> that is supported this camera device.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

25817

Nanoseconds

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Zhijun He

2014-03-18 13:37:23 -0700

[diff] [blame]

25821

For FULL capability devices

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

25822

(<a href="#static_android.info.supportedHardwareLevel">android.info.supportedHardwareLevel</a> == FULL), at least 100ms.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

25823

</td>

25824

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

25829

25830

Igor Murashkin

2012-12-05 14:49:11 -0800

[diff] [blame]

25831

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</ul>

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

25835

</tr>

25836

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

25837

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

25838

</tr>

25839

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

25840

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

25841

Attempting to use frame durations beyond the maximum will result in the frame

25842

duration being clipped to the maximum. See that control for a full definition of frame

25843

durations.

Eino-Ville Talvala

2015-04-16 13:49:52 -0700

[diff] [blame]

25844

Refer to <a href="https://developer.android.com/reference/android/hardware/camera2/params/StreamConfigurationMap.html#getOutputMinFrameDuration">StreamConfigurationMap#getOutputMinFrameDuration</a>

25845

for the minimum frame duration values.

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

25846

</td>

25847

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

25848

Igor Murashkin

2014-01-27 16:00:26 -0800

[diff] [blame]

25849

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

25850

<th class="th_details" colspan="6">HAL Implementation Details</th>

Igor Murashkin

2014-01-27 16:00:26 -0800

[diff] [blame]

25851

</tr>

25852

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

25853

Zhijun He

7a8aea6

2014-03-18 13:37:23 -0700

[diff] [blame]

25854

For FULL capability devices (<a href="#static_android.info.supportedHardwareLevel">android.info.supportedHardwareLevel</a> == FULL),

25855

The maximum of the range SHOULD be at least

25856

1 second (1e9), MUST be at least 100ms (100e6).

Eino-Ville Talvala

2014-02-10 12:39:35 -0800

[diff] [blame]

25857

<a href="#static_android.sensor.info.maxFrameDuration">android.sensor.info.maxFrameDuration</a> must be greater or

25858

equal to the <a href="#static_android.sensor.info.exposureTimeRange">android.sensor.info.exposureTimeRange</a> max

25859

value (since exposure time overrides frame duration).

Igor Murashkin

2014-02-07 14:31:31 -0800

[diff] [blame]

25860

Available minimum frame durations for JPEG must be no greater

25861

than that of the YUV_420_888/IMPLEMENTATION_DEFINED

25862

minimum frame durations (for that respective size).

25863

Since JPEG processing is considered offline and can take longer than

25864

a single uncompressed capture, refer to

Eino-Ville Talvala

2014-02-10 12:39:35 -0800

[diff] [blame]

25865

<a href="#static_android.scaler.availableStallDurations">android.scaler.availableStallDurations</a>

Igor Murashkin

2014-02-07 14:31:31 -0800

[diff] [blame]

25866

for details about encoding this scenario.

Igor Murashkin

2014-01-27 16:00:26 -0800

[diff] [blame]

25867

</td>

25868

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

25869

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

25870

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

25871

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

25875

<td class="entry_name

Eino-Ville Talvala

2014-06-06 14:35:41 -0700

[diff] [blame]

25876

" rowspan="5">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

25877

android.sensor.info.physicalSize

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

25878

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

25879

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

25880

float

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

x

2

Yin-Chia Yeh

2014-05-27 09:48:07 -0700

[diff] [blame]

25886

[public as sizeF]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

25887

25888

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

25889

[legacy]

25890

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

25891

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

25892

<div class="entry_type_notes">width x height</div>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

25893

25894

25895

</td>

25896

25897

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

25898

The physical dimensions of the full pixel

Eino-Ville Talvala

2014-06-06 14:35:41 -0700

[diff] [blame]

25899

array.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

25903

Millimeters

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

25913

25914

Igor Murashkin

2012-12-05 14:49:11 -0800

[diff] [blame]

25915

25916

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</ul>

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

25920

</tr>

25921

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

25922

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

25923

</tr>

25924

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

25925

Eino-Ville Talvala

2014-06-06 14:35:41 -0700

[diff] [blame]

25926

This is the physical size of the sensor pixel

25927

array defined by <a href="#static_android.sensor.info.pixelArraySize">android.sensor.info.pixelArraySize</a>.

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

25928

</td>

25929

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

25930

Eino-Ville Talvala

2014-06-06 14:35:41 -0700

[diff] [blame]

25931

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

25932

<th class="th_details" colspan="6">HAL Implementation Details</th>

Eino-Ville Talvala

2014-06-06 14:35:41 -0700

[diff] [blame]

25933

</tr>

25934

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

25935

Eino-Ville Talvala

2014-06-06 14:35:41 -0700

[diff] [blame]

25936

Needed for FOV calculation for old API

25937

</td>

25938

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

25939

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

25940

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

25941

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

25945

<td class="entry_name

25946

" rowspan="3">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

25947

android.sensor.info.pixelArraySize

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

25948

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

25949

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

25950

int32

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

x

2

Ruben Brunk

2014-01-31 12:38:46 -0800

[diff] [blame]

25956

[public as size]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

25957

25958

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

25959

[legacy]

25960

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

25964

</td>

25965

25966

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

25967

Dimensions of the full pixel array, possibly

Zhijun He

2014-01-21 18:28:30 -0800

[diff] [blame]

25968

including black calibration pixels.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

25972

Pixels

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

25982

25983

Eino-Ville Talvala

2014-07-15 10:43:01 -0700

[diff] [blame]

25984

Igor Murashkin

2012-12-05 14:49:11 -0800

[diff] [blame]

25985

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</ul>

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

25989

</tr>

25990

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

25991

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

25992

</tr>

25993

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

25994

Ruben Brunk

2015-06-11 18:23:41 -0700

[diff] [blame]

25995

The pixel count of the full pixel array of the image sensor, which covers

25996

<a href="#static_android.sensor.info.physicalSize">android.sensor.info.physicalSize</a> area. This represents the full pixel dimensions of

25997

the raw buffers produced by this sensor.

25998

If a camera device supports raw sensor formats, either this or

25999

<a href="#static_android.sensor.info.preCorrectionActiveArraySize">android.sensor.info.preCorrectionActiveArraySize</a> is the maximum dimensions for the raw

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

26000

output formats listed in <a href="https://developer.android.com/reference/android/hardware/camera2/params/StreamConfigurationMap.html">StreamConfigurationMap</a>

26001

(this depends on whether or not the image sensor returns buffers containing pixels that

26002

are not part of the active array region for blacklevel calibration or other purposes).

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

26003

Some parts of the full pixel array may not receive light from the scene,

Ruben Brunk

2015-06-11 18:23:41 -0700

[diff] [blame]

26004

or be otherwise inactive. The <a href="#static_android.sensor.info.preCorrectionActiveArraySize">android.sensor.info.preCorrectionActiveArraySize</a> key

26005

defines the rectangle of active pixels that will be included in processed image

26006

formats.

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

26007

</td>

26008

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

26009

26010

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

26011

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

26012

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

26016

<td class="entry_name

26017

" rowspan="5">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

26018

android.sensor.info.whiteLevel

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

26019

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

26020

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

26021

int32

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

26022

Ruben Brunk

2014-02-10 19:16:56 -0800

[diff] [blame]

26023

[public]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

26024

26025

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

26029

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

26030

</td>

26031

26032

Ruben Brunk

2014-02-10 19:16:56 -0800

[diff] [blame]

26033

Maximum raw value output by sensor.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

Ruben Brunk

2014-03-18 14:37:04 -0700

[diff] [blame]

26040

> 255 (8-bit output)

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

26041

</td>

26042

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

26047

26048

Eino-Ville Talvala

2014-07-15 10:43:01 -0700

[diff] [blame]

26049

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</ul>

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

26053

</tr>

26054

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

26055

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

26056

</tr>

26057

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

26058

Ruben Brunk

2014-02-10 19:16:56 -0800

[diff] [blame]

26059

This specifies the fully-saturated encoding level for the raw

26060

sample values from the sensor. This is typically caused by the

26061

sensor becoming highly non-linear or clipping. The minimum for

26062

each channel is specified by the offset in the

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

26063

<a href="#static_android.sensor.blackLevelPattern">android.sensor.blackLevelPattern</a> key.

Ruben Brunk

2014-02-10 19:16:56 -0800

[diff] [blame]

26064

The white level is typically determined either by sensor bit depth

Ruben Brunk

2014-03-18 14:37:04 -0700

[diff] [blame]

26065

(8-14 bits is expected), or by the point where the sensor response

Ruben Brunk

2014-02-10 19:16:56 -0800

[diff] [blame]

26066

becomes too non-linear to be useful. The default value for this is

26067

maximum representable value for a 16-bit raw sample (2^16 - 1).

Zhijun He

2015-11-12 17:27:27 -0800

[diff] [blame]

26068

The white level values of captured images may vary for different

26069

capture settings (e.g., <a href="#controls_android.sensor.sensitivity">android.sensor.sensitivity</a>). This key

26070

represents a coarse approximation for such case. It is recommended

26071

to use <a href="#dynamic_android.sensor.dynamicWhiteLevel">android.sensor.dynamicWhiteLevel</a> for captures when supported

26072

by the camera device, which provides more accurate white level values.

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

26073

</td>

26074

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

26075

Ruben Brunk

2014-03-18 14:37:04 -0700

[diff] [blame]

26076

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

26077

<th class="th_details" colspan="6">HAL Implementation Details</th>

Ruben Brunk

2014-03-18 14:37:04 -0700

[diff] [blame]

26078

</tr>

26079

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

26080

Ruben Brunk

2014-03-18 14:37:04 -0700

[diff] [blame]

26081

The full bit depth of the sensor must be available in the raw data,

26082

so the value for linear sensors should not be significantly lower

26083

than maximum raw value supported, i.e. 2^(sensor bits per pixel).

26084

</td>

26085

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

26086

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

26087

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

26088

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

26089

Zhijun He

2014-06-12 10:43:32 -0700

[diff] [blame]

26090

Eino-Ville Talvala

2014-07-28 12:49:25 -0700

[diff] [blame]

26091

Zhijun He

2014-06-12 10:43:32 -0700

[diff] [blame]

26092

<td class="entry_name

Yin-Chia Yeh

2016-06-06 14:25:11 -0700

[diff] [blame]

26093

" rowspan="5">

Eino-Ville Talvala

2014-07-28 12:49:25 -0700

[diff] [blame]

26094

android.sensor.info.timestampSource

Zhijun He

2014-06-12 10:43:32 -0700

[diff] [blame]

</td>

byte

[public]

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

26102

[legacy]

26103

Zhijun He

2014-06-12 10:43:32 -0700

[diff] [blame]

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

26108

UNKNOWN (v3.2)

Eino-Ville Talvala

31f60ee

2020-01-09 15:10:12 -0800

[diff] [blame]

26109

Timestamps from <a href="#dynamic_android.sensor.timestamp">android.sensor.timestamp</a> are in nanoseconds and monotonic, but can

26110

not be compared to timestamps from other subsystems (e.g. accelerometer, gyro etc.),

26111

or other instances of the same or different camera devices in the same system with

Yin-Chia Yeh

fc30a53

2020-03-17 09:38:54 -0700

[diff] [blame]

26112

accuracy. However, the timestamps are roughly in the same timebase as

Eino-Ville Talvala

31f60ee

2020-01-09 15:10:12 -0800

[diff] [blame]

26113

<a href="https://developer.android.com/reference/android/os/SystemClock.html#uptimeMillis">SystemClock#uptimeMillis</a>. The accuracy is sufficient for tasks

26114

like A/V synchronization for video recording, at least, and the timestamps can be

26115

directly used together with timestamps from the audio subsystem for that task.

26116

Timestamps between streams and results for a single camera instance are comparable,

26117

and the timestamps for all buffers and the result metadata generated by a single

26118

capture are identical.

Zhijun He

2014-06-12 10:43:32 -0700

[diff] [blame]

26119

</li>

26120

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

26121

REALTIME (v3.2)

Zhijun He

2014-06-12 10:43:32 -0700

[diff] [blame]

26122

Timestamps from <a href="#dynamic_android.sensor.timestamp">android.sensor.timestamp</a> are in the same timebase as

Eino-Ville Talvala

2015-04-16 13:49:52 -0700

[diff] [blame]

26123

<a href="https://developer.android.com/reference/android/os/SystemClock.html#elapsedRealtimeNanos">SystemClock#elapsedRealtimeNanos</a>,

Eino-Ville Talvala

31f60ee

2020-01-09 15:10:12 -0800

[diff] [blame]

26124

and they can be compared to other timestamps using that base.

26125

When buffers from a REALTIME device are passed directly to a video encoder from the

26126

camera, automatic compensation is done to account for differing timebases of the

26127

audio and camera subsystems. If the application is receiving buffers and then later

26128

sending them to a video encoder or other application where they are compared with

26129

audio subsystem timestamps or similar, this compensation is not present. In those

26130

cases, applications need to adjust the timestamps themselves. Since <a href="https://developer.android.com/reference/android/os/SystemClock.html#elapsedRealtimeNanos">SystemClock#elapsedRealtimeNanos</a> and <a href="https://developer.android.com/reference/android/os/SystemClock.html#uptimeMillis">SystemClock#uptimeMillis</a> only diverge while the device is asleep, an

26131

offset between the two sources can be measured once per active session and applied

26132

to timestamps for sufficient accuracy for A/V sync.

Zhijun He

2014-06-12 10:43:32 -0700

[diff] [blame]

</li>

</ul>

</td>

26137

26138

Eino-Ville Talvala

2014-07-28 12:49:25 -0700

[diff] [blame]

26139

The time base source for sensor capture start timestamps.

Zhijun He

2014-06-12 10:43:32 -0700

[diff] [blame]

</td>

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Zhijun He

2014-06-12 10:43:32 -0700

[diff] [blame]

</ul>

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

26160

<th class="th_details" colspan="6">Details</th>

Zhijun He

2014-06-12 10:43:32 -0700

[diff] [blame]

26161

</tr>

26162

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

26163

Eino-Ville Talvala

2014-07-28 12:49:25 -0700

[diff] [blame]

26164

The timestamps provided for captures are always in nanoseconds and monotonic, but

26165

may not based on a time source that can be compared to other system time sources.

26166

This characteristic defines the source for the timestamps, and therefore whether they

26167

can be compared against other system time sources/timestamps.

Zhijun He

2014-06-12 10:43:32 -0700

[diff] [blame]

</td>

</tr>

Yin-Chia Yeh

2016-06-06 14:25:11 -0700

[diff] [blame]

26171

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

26172

<th class="th_details" colspan="6">HAL Implementation Details</th>

Yin-Chia Yeh

2016-06-06 14:25:11 -0700

[diff] [blame]

26173

</tr>

26174

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

26175

Yin-Chia Yeh

2016-06-06 14:25:11 -0700

[diff] [blame]

26176

For camera devices implement UNKNOWN, the camera framework expects that the timestamp

26177

source to be SYSTEM_TIME_MONOTONIC. For camera devices implement REALTIME, the camera

26178

framework expects that the timestamp source to be SYSTEM_TIME_BOOTTIME. See

26179

system/core/include/utils/Timers.h for the definition of SYSTEM_TIME_MONOTONIC and

26180

SYSTEM_TIME_BOOTTIME. Note that HAL must follow above expectation; otherwise video

26181

recording might suffer unexpected behavior.

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

26182

Also, camera devices which implement REALTIME must pass the ITS sensor fusion test which

Yin-Chia Yeh

2016-06-06 14:25:11 -0700

[diff] [blame]

26183

tests the alignment between camera timestamps and gyro sensor timestamps.

26184

</td>

26185

</tr>

Zhijun He

2014-06-12 10:43:32 -0700

[diff] [blame]

26186

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

26187

Zhijun He

2014-06-12 10:43:32 -0700

[diff] [blame]

26188

26189

Yin-Chia Yeh

2015-02-04 10:04:37 -0800

[diff] [blame]

26190

26191

26192

<td class="entry_name

26193

" rowspan="3">

26194

android.sensor.info.lensShadingApplied

</td>

byte

[public as boolean]

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

26207

FALSE (v3.2)

Yin-Chia Yeh

2015-02-04 10:04:37 -0800

[diff] [blame]

26208

</li>

26209

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

26210

TRUE (v3.2)

Yin-Chia Yeh

2015-02-04 10:04:37 -0800

[diff] [blame]

</li>

</ul>

</td>

26215

26216

26217

Whether the RAW images output from this camera device are subject to

26218

lens shading correction.

</td>

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Yin-Chia Yeh

2015-02-04 10:04:37 -0800

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

26236

<th class="th_details" colspan="6">Details</th>

Yin-Chia Yeh

2015-02-04 10:04:37 -0800

[diff] [blame]

26237

</tr>

26238

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

26239

Yin-Chia Yeh

2015-02-04 10:04:37 -0800

[diff] [blame]

26240

If TRUE, all images produced by the camera device in the RAW image formats will

26241

have lens shading correction already applied to it. If FALSE, the images will

26242

not be adjusted for lens shading correction.

26243

See <a href="#static_android.request.maxNumOutputRaw">android.request.maxNumOutputRaw</a> for a list of RAW image formats.

26244

This key will be <code>null</code> for all devices do not report this information.

26245

Devices with RAW capability will always report this information in this key.

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

26250

Yin-Chia Yeh

2015-02-04 10:04:37 -0800

[diff] [blame]

26251

26252

Ruben Brunk

2015-07-01 11:32:39 -0700

[diff] [blame]

26253

26254

26255

<td class="entry_name

26256

" rowspan="5">

26257

android.sensor.info.preCorrectionActiveArraySize

</td>

int32

x

4

[public as rectangle]

[legacy]

<div class="entry_type_notes">Four ints defining the active pixel rectangle</div>

26273

26274

26275

</td>

26276

26277

26278

The area of the image sensor which corresponds to active pixels prior to the

26279

application of any geometric distortion correction.

</td>

Pixel coordinates on the image sensor

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Ruben Brunk

2015-07-01 11:32:39 -0700

[diff] [blame]

</ul>

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

26301

<th class="th_details" colspan="6">Details</th>

Ruben Brunk

2015-07-01 11:32:39 -0700

[diff] [blame]

26302

</tr>

26303

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

26304

Ruben Brunk

2015-07-01 11:32:39 -0700

[diff] [blame]

26305

This is the rectangle representing the size of the active region of the sensor (i.e.

26306

the region that actually receives light from the scene) before any geometric correction

26307

has been applied, and should be treated as the active region rectangle for any of the

26308

raw formats. All metadata associated with raw processing (e.g. the lens shading

26309

correction map, and radial distortion fields) treats the top, left of this rectangle as

26310

the origin, (0,0).

26311

The size of this region determines the maximum field of view and the maximum number of

26312

pixels that an image from this sensor can contain, prior to the application of

26313

geometric distortion correction. The effective maximum pixel dimensions of a

26314

post-distortion-corrected image is given by the <a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a>

26315

field, and the effective maximum field of view for a post-distortion-corrected image

26316

can be calculated by applying the geometric distortion correction fields to this

26317

rectangle, and cropping to the rectangle given in <a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a>.

26318

E.g. to calculate position of a pixel, (x,y), in a processed YUV output image with the

26319

dimensions in <a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a> given the position of a pixel,

Jayant Chowdhary

3b8234c

2020-10-26 16:45:45 -0700

[diff] [blame]

26320

(x', y'), in the raw pixel array with dimensions given in

Ruben Brunk

2015-07-01 11:32:39 -0700

[diff] [blame]

26321

<a href="#static_android.sensor.info.pixelArraySize">android.sensor.info.pixelArraySize</a>:

26322

<ol>

26323

<li>Choose a pixel (x', y') within the active array region of the raw buffer given in

26324

<a href="#static_android.sensor.info.preCorrectionActiveArraySize">android.sensor.info.preCorrectionActiveArraySize</a>, otherwise this pixel is considered

26325

to be outside of the FOV, and will not be shown in the processed output image.</li>

26326

<li>Apply geometric distortion correction to get the post-distortion pixel coordinate,

26327

(x_i, y_i). When applying geometric correction metadata, note that metadata for raw

26328

buffers is defined relative to the top, left of the

26329

<a href="#static_android.sensor.info.preCorrectionActiveArraySize">android.sensor.info.preCorrectionActiveArraySize</a> rectangle.</li>

26330

<li>If the resulting corrected pixel coordinate is within the region given in

26331

<a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a>, then the position of this pixel in the

26332

processed output image buffer is <code>(x_i - activeArray.left, y_i - activeArray.top)</code>,

26333

when the top, left coordinate of that buffer is treated as (0, 0).</li>

26334

</ol>

26335

Thus, for pixel x',y' = (25, 25) on a sensor where <a href="#static_android.sensor.info.pixelArraySize">android.sensor.info.pixelArraySize</a>

26336

is (100,100), <a href="#static_android.sensor.info.preCorrectionActiveArraySize">android.sensor.info.preCorrectionActiveArraySize</a> is (10, 10, 100, 100),

26337

<a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a> is (20, 20, 80, 80), and the geometric distortion

26338

correction doesn't change the pixel coordinate, the resulting pixel selected in

26339

pixel coordinates would be x,y = (25, 25) relative to the top,left of the raw buffer

26340

with dimensions given in <a href="#static_android.sensor.info.pixelArraySize">android.sensor.info.pixelArraySize</a>, and would be (5, 5)

26341

relative to the top,left of post-processed YUV output buffer with dimensions given in

26342

<a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a>.

26343

The currently supported fields that correct for geometric distortion are:

26344

<ol>

Eino-Ville Talvala

2018-03-13 19:10:23 -0700

[diff] [blame]

26345

<li><a href="#static_android.lens.distortion">android.lens.distortion</a>.</li>

Ruben Brunk

2015-07-01 11:32:39 -0700

[diff] [blame]

26346

</ol>

Yin-Chia Yeh

2018-06-15 15:35:05 -0700

[diff] [blame]

26347

If the camera device doesn't support geometric distortion correction, or all of the

26348

geometric distortion fields are no-ops, this rectangle will be the same as the

26349

post-distortion-corrected rectangle given in <a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a>.

Ruben Brunk

2015-07-01 11:32:39 -0700

[diff] [blame]

26350

This rectangle is defined relative to the full pixel array; (0,0) is the top-left of

26351

the full pixel array, and the size of the full pixel array is given by

26352

<a href="#static_android.sensor.info.pixelArraySize">android.sensor.info.pixelArraySize</a>.

26353

The pre-correction active array may be smaller than the full pixel array, since the

26354

full array may include black calibration pixels or other inactive regions.

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

26359

<th class="th_details" colspan="6">HAL Implementation Details</th>

Ruben Brunk

2015-07-01 11:32:39 -0700

[diff] [blame]

26360

</tr>

26361

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

26362

Ruben Brunk

2015-07-01 11:32:39 -0700

[diff] [blame]

26363

This array contains <code>(xmin, ymin, width, height)</code>. The <code>(xmin, ymin)</code> must be

26364

>= <code>(0,0)</code>.

26365

The <code>(width, height)</code> must be <= <code><a href="#static_android.sensor.info.pixelArraySize">android.sensor.info.pixelArraySize</a></code>.

26366

If omitted by the HAL implementation, the camera framework will assume that this is

26367

the same as the post-correction active array region given in

26368

<a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a>.

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

26372

Ruben Brunk

2015-07-01 11:32:39 -0700

[diff] [blame]

26373

26374

Jayant Chowdhary

2020-11-09 09:08:31 -0800

[diff] [blame]

26375

26376

26377

<td class="entry_name

26378

" rowspan="5">

26379

android.sensor.info.activeArraySizeMaximumResolution

</td>

int32

x

4

[public as rectangle]

<div class="entry_type_notes">Four ints defining the active pixel rectangle</div>

26394

26395

26396

</td>

26397

26398

26399

The area of the image sensor which corresponds to active pixels after any geometric

26400

distortion correction has been applied, when the sensor runs in maximum resolution mode.

</td>

Pixel coordinates on the image sensor

</td>

</td>

3.6

</td>

</ul>

</td>

</tr>

<th class="th_details" colspan="6">Details</th>

</tr>

Analogous to <a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a>, when <a href="#controls_android.sensor.pixelMode">android.sensor.pixelMode</a>

26427

is set to

26428

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraMetadata.html#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION">CameraMetadata#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION</a>.

26429

Refer to <a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a> for details, with sensor array related keys

26430

replaced with their

26431

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraMetadata.html#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION">CameraMetadata#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION</a>

26432

counterparts.

26433

This key will only be present for devices which advertise the

26434

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraMetadata.html#REQUEST_AVAILABLE_CAPABILITIES_ULTRA_HIGH_RESOLUTION_SENSOR">CameraMetadata#REQUEST_AVAILABLE_CAPABILITIES_ULTRA_HIGH_RESOLUTION_SENSOR</a>

capability.

</td>

</tr>

<th class="th_details" colspan="6">HAL Implementation Details</th>

</tr>

This array contains <code>(xmin, ymin, width, height)</code>. The <code>(xmin, ymin)</code> must be

26445

>= <code>(0,0)</code>.

26446

The <code>(width, height)</code> must be <= <code><a href="#static_android.sensor.info.pixelArraySizeMaximumResolution">android.sensor.info.pixelArraySizeMaximumResolution</a></code>.

</td>

</tr>

<td class="entry_name

26456

" rowspan="3">

26457

android.sensor.info.pixelArraySizeMaximumResolution

</td>

int32

x

2

[public as size]

</td>

26474

26475

26476

Dimensions of the full pixel array, possibly

26477

including black calibration pixels, when the sensor runs in maximum resolution mode.

26478

Analogous to <a href="#static_android.sensor.info.pixelArraySize">android.sensor.info.pixelArraySize</a>, when <a href="#controls_android.sensor.pixelMode">android.sensor.pixelMode</a> is

26479

set to

26480

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraMetadata.html#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION">CameraMetadata#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION</a>.

</td>

Pixels

</td>

</td>

3.6

</td>

</ul>

</td>

</tr>

<th class="th_details" colspan="6">Details</th>

</tr>

The pixel count of the full pixel array of the image sensor, which covers

26507

<a href="#static_android.sensor.info.physicalSize">android.sensor.info.physicalSize</a> area. This represents the full pixel dimensions of

26508

the raw buffers produced by this sensor, when it runs in maximum resolution mode. That

26509

is, when <a href="#controls_android.sensor.pixelMode">android.sensor.pixelMode</a> is set to

26510

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraMetadata.html#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION">CameraMetadata#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION</a>.

26511

This key will only be present for devices which advertise the

26512

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraMetadata.html#REQUEST_AVAILABLE_CAPABILITIES_ULTRA_HIGH_RESOLUTION_SENSOR">CameraMetadata#REQUEST_AVAILABLE_CAPABILITIES_ULTRA_HIGH_RESOLUTION_SENSOR</a>

capability.

</td>

</tr>

<td class="entry_name

26524

" rowspan="5">

26525

android.sensor.info.preCorrectionActiveArraySizeMaximumResolution

</td>

int32

x

4

[public as rectangle]

<div class="entry_type_notes">Four ints defining the active pixel rectangle</div>

26540

26541

26542

</td>

26543

26544

26545

The area of the image sensor which corresponds to active pixels prior to the

26546

application of any geometric distortion correction, when the sensor runs in maximum

26547

resolution mode. This key must be used for crop / metering regions, only when

26548

<a href="#controls_android.sensor.pixelMode">android.sensor.pixelMode</a> is set to

26549

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraMetadata.html#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION">CameraMetadata#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION</a>.

</td>

Pixel coordinates on the image sensor

</td>

</td>

3.6

</td>

</ul>

</td>

</tr>

<th class="th_details" colspan="6">Details</th>

</tr>

Analogous to <a href="#static_android.sensor.info.preCorrectionActiveArraySize">android.sensor.info.preCorrectionActiveArraySize</a>,

26576

when <a href="#controls_android.sensor.pixelMode">android.sensor.pixelMode</a> is set to

26577

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraMetadata.html#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION">CameraMetadata#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION</a>.

26578

This key will only be present for devices which advertise the

26579

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraMetadata.html#REQUEST_AVAILABLE_CAPABILITIES_ULTRA_HIGH_RESOLUTION_SENSOR">CameraMetadata#REQUEST_AVAILABLE_CAPABILITIES_ULTRA_HIGH_RESOLUTION_SENSOR</a>

capability.

</td>

</tr>

<th class="th_details" colspan="6">HAL Implementation Details</th>

</tr>

This array contains <code>(xmin, ymin, width, height)</code>. The <code>(xmin, ymin)</code> must be

26590

>= <code>(0,0)</code>.

26591

The <code>(width, height)</code> must be <= <code><a href="#static_android.sensor.info.pixelArraySizeMaximumResolution">android.sensor.info.pixelArraySizeMaximumResolution</a></code>.

26592

If omitted by the HAL implementation, the camera framework will assume that this is

26593

the same as the post-correction active array region given in

26594

<a href="#static_android.sensor.info.activeArraySizeMaximumResolution">android.sensor.info.activeArraySizeMaximumResolution</a>.

</td>

</tr>

<td class="entry_name

26604

" rowspan="3">

26605

android.sensor.info.binningFactor

</td>

int32

x

2

[public as size]

</td>

26622

26623

26624

Dimensions of the group of pixels which are under the same color filter.

26625

This specifies the width and height (pair of integers) of the group of pixels which fall

26626

under the same color filter for ULTRA_HIGH_RESOLUTION sensors.

</td>

Pixels

</td>

</td>

3.6

</td>

</td>

</tr>

<th class="th_details" colspan="6">Details</th>

</tr>

Sensors can have pixels grouped together under the same color filter in order

26650

to improve various aspects of imaging such as noise reduction, low light

26651

performance etc. These groups can be of various sizes such as 2X2 (quad bayer),

26652

3X3 (nona-bayer). This key specifies the length and width of the pixels grouped under

26653

the same color filter.

26654

This key will not be present if REMOSAIC_REPROCESSING is not supported, since RAW images

26655

will have a regular bayer pattern.

26656

This key will not be present for sensors which don't have the

26657

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraMetadata.html#REQUEST_AVAILABLE_CAPABILITIES_ULTRA_HIGH_RESOLUTION_SENSOR">CameraMetadata#REQUEST_AVAILABLE_CAPABILITIES_ULTRA_HIGH_RESOLUTION_SENSOR</a>

capability.

</td>

</tr>

26665

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Ruben Brunk

2014-04-15 17:43:56 -0700

[diff] [blame]

26670

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

26671

<td class="entry_name

26672

" rowspan="5">

Ruben Brunk

2014-04-15 17:43:56 -0700

[diff] [blame]

26673

android.sensor.referenceIlluminant1

</td>

byte

[public]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

26683

Ruben Brunk

2014-04-15 17:43:56 -0700

[diff] [blame]

26684

26685

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

26686

DAYLIGHT (v3.2)

Ruben Brunk

2014-04-15 17:43:56 -0700

[diff] [blame]

26687

1

26688

</li>

26689

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

26690

FLUORESCENT (v3.2)

Ruben Brunk

2014-04-15 17:43:56 -0700

[diff] [blame]

26691

2

26692

</li>

26693

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

26694

TUNGSTEN (v3.2)

Ruben Brunk

2014-04-15 17:43:56 -0700

[diff] [blame]

3

Incandescent light

</li>

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

26699

FLASH (v3.2)

Ruben Brunk

2014-04-15 17:43:56 -0700

[diff] [blame]

26700

4

26701

</li>

26702

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

26703

FINE_WEATHER (v3.2)

Ruben Brunk

2014-04-15 17:43:56 -0700

[diff] [blame]

26704

9

26705

</li>

26706

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

26707

CLOUDY_WEATHER (v3.2)

Ruben Brunk

2014-04-15 17:43:56 -0700

[diff] [blame]

26708

10

26709

</li>

26710

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

26711

SHADE (v3.2)

Ruben Brunk

2014-04-15 17:43:56 -0700

[diff] [blame]

26712

11

26713

</li>

26714

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

26715

DAYLIGHT_FLUORESCENT (v3.2)

Ruben Brunk

2014-04-15 17:43:56 -0700

[diff] [blame]

12

D 5700 - 7100K

</li>

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

26720

DAY_WHITE_FLUORESCENT (v3.2)

Ruben Brunk

2014-04-15 17:43:56 -0700

[diff] [blame]

13

N 4600 - 5400K

</li>

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

26725

COOL_WHITE_FLUORESCENT (v3.2)

Ruben Brunk

2014-04-15 17:43:56 -0700

[diff] [blame]

14

W 3900 - 4500K

</li>

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

26730

WHITE_FLUORESCENT (v3.2)

Ruben Brunk

2014-04-15 17:43:56 -0700

[diff] [blame]

15

WW 3200 - 3700K

</li>

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

26735

STANDARD_A (v3.2)

Ruben Brunk

2014-04-15 17:43:56 -0700

[diff] [blame]

26736

17

26737

</li>

26738

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

26739

STANDARD_B (v3.2)

Ruben Brunk

2014-04-15 17:43:56 -0700

[diff] [blame]

26740

18

26741

</li>

26742

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

26743

STANDARD_C (v3.2)

Ruben Brunk

2014-04-15 17:43:56 -0700

[diff] [blame]

26744

19

26745

</li>

26746

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

26747

D55 (v3.2)

Ruben Brunk

2014-04-15 17:43:56 -0700

[diff] [blame]

26748

20

26749

</li>

26750

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

26751

D65 (v3.2)

Ruben Brunk

2014-04-15 17:43:56 -0700

[diff] [blame]

26752

21

26753

</li>

26754

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

26755

D75 (v3.2)

Ruben Brunk

2014-04-15 17:43:56 -0700

[diff] [blame]

26756

22

26757

</li>

26758

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

26759

D50 (v3.2)

Ruben Brunk

2014-04-15 17:43:56 -0700

[diff] [blame]

26760

23

26761

</li>

26762

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

26763

ISO_STUDIO_TUNGSTEN (v3.2)

Ruben Brunk

2014-04-15 17:43:56 -0700

[diff] [blame]

24

</li>

</ul>

</td>

26769

26770

26771

The standard reference illuminant used as the scene light source when

26772

calculating the <a href="#static_android.sensor.colorTransform1">android.sensor.colorTransform1</a>,

26773

<a href="#static_android.sensor.calibrationTransform1">android.sensor.calibrationTransform1</a>, and

26774

<a href="#static_android.sensor.forwardMatrix1">android.sensor.forwardMatrix1</a> matrices.

</td>

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Ruben Brunk

2014-04-15 17:43:56 -0700

[diff] [blame]

26787

26788

Eino-Ville Talvala

2014-07-15 10:43:01 -0700

[diff] [blame]

26789

Ruben Brunk

2014-04-15 17:43:56 -0700

[diff] [blame]

</ul>

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

26795

<th class="th_details" colspan="6">Details</th>

Ruben Brunk

2014-04-15 17:43:56 -0700

[diff] [blame]

26796

</tr>

26797

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

26798

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

26799

The values in this key correspond to the values defined for the

Ruben Brunk

2014-04-15 17:43:56 -0700

[diff] [blame]

26800

EXIF LightSource tag. These illuminants are standard light sources

26801

that are often used calibrating camera devices.

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

26802

If this key is present, then <a href="#static_android.sensor.colorTransform1">android.sensor.colorTransform1</a>,

Ruben Brunk

2014-04-15 17:43:56 -0700

[diff] [blame]

26803

<a href="#static_android.sensor.calibrationTransform1">android.sensor.calibrationTransform1</a>, and

26804

<a href="#static_android.sensor.forwardMatrix1">android.sensor.forwardMatrix1</a> will also be present.

26805

Some devices may choose to provide a second set of calibration

26806

information for improved quality, including

26807

<a href="#static_android.sensor.referenceIlluminant2">android.sensor.referenceIlluminant2</a> and its corresponding matrices.

Shuzhen Wang

2018-10-15 12:00:13 -0700

[diff] [blame]

26808

Starting from Android Q, this key will not be present for a MONOCHROME camera, even if

26809

the camera device has RAW capability.

Ruben Brunk

2014-04-15 17:43:56 -0700

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

26814

<th class="th_details" colspan="6">HAL Implementation Details</th>

Ruben Brunk

2014-04-15 17:43:56 -0700

[diff] [blame]

26815

</tr>

26816

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

26817

Ruben Brunk

2014-04-15 17:43:56 -0700

[diff] [blame]

26818

The first reference illuminant (<a href="#static_android.sensor.referenceIlluminant1">android.sensor.referenceIlluminant1</a>)

Eino-Ville Talvala

2014-07-15 10:43:01 -0700

[diff] [blame]

26819

and corresponding matrices must be present to support the RAW capability

26820

and DNG output.

Ruben Brunk

2014-04-15 17:43:56 -0700

[diff] [blame]

26821

When producing raw images with a color profile that has only been

26822

calibrated against a single light source, it is valid to omit

26823

<a href="#static_android.sensor.referenceIlluminant2">android.sensor.referenceIlluminant2</a> along with the

26824

<a href="#static_android.sensor.colorTransform2">android.sensor.colorTransform2</a>, <a href="#static_android.sensor.calibrationTransform2">android.sensor.calibrationTransform2</a>,

26825

and <a href="#static_android.sensor.forwardMatrix2">android.sensor.forwardMatrix2</a> matrices.

26826

If only <a href="#static_android.sensor.referenceIlluminant1">android.sensor.referenceIlluminant1</a> is included, it should be

26827

chosen so that it is representative of typical scene lighting. In

26828

general, D50 or DAYLIGHT will be chosen for this case.

26829

If both <a href="#static_android.sensor.referenceIlluminant1">android.sensor.referenceIlluminant1</a> and

26830

<a href="#static_android.sensor.referenceIlluminant2">android.sensor.referenceIlluminant2</a> are included, they should be

26831

chosen to represent the typical range of scene lighting conditions.

26832

In general, low color temperature illuminant such as Standard-A will

26833

be chosen for the first reference illuminant and a higher color

26834

temperature illuminant such as D65 will be chosen for the second

26835

reference illuminant.

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

26839

Ruben Brunk

2014-04-15 17:43:56 -0700

[diff] [blame]

26840

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

26844

<td class="entry_name

26845

" rowspan="3">

Ruben Brunk

2014-04-15 17:43:56 -0700

[diff] [blame]

26846

android.sensor.referenceIlluminant2

</td>

byte

[public]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

26857

Ruben Brunk

2014-04-15 17:43:56 -0700

[diff] [blame]

26858

</td>

26859

26860

26861

The standard reference illuminant used as the scene light source when

26862

calculating the <a href="#static_android.sensor.colorTransform2">android.sensor.colorTransform2</a>,

26863

<a href="#static_android.sensor.calibrationTransform2">android.sensor.calibrationTransform2</a>, and

26864

<a href="#static_android.sensor.forwardMatrix2">android.sensor.forwardMatrix2</a> matrices.

</td>

</td>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

26871

Any value listed in <a href="#static_android.sensor.referenceIlluminant1">android.sensor.referenceIlluminant1</a>

Ruben Brunk

2014-04-15 17:43:56 -0700

[diff] [blame]

26872

</td>

26873

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Ruben Brunk

2014-04-15 17:43:56 -0700

[diff] [blame]

26878

26879

Eino-Ville Talvala

2014-07-15 10:43:01 -0700

[diff] [blame]

26880

Ruben Brunk

2014-04-15 17:43:56 -0700

[diff] [blame]

</ul>

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

26886

<th class="th_details" colspan="6">Details</th>

Ruben Brunk

2014-04-15 17:43:56 -0700

[diff] [blame]

26887

</tr>

26888

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

26889

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

26890

See <a href="#static_android.sensor.referenceIlluminant1">android.sensor.referenceIlluminant1</a> for more details.

26891

If this key is present, then <a href="#static_android.sensor.colorTransform2">android.sensor.colorTransform2</a>,

Ruben Brunk

2014-04-15 17:43:56 -0700

[diff] [blame]

26892

<a href="#static_android.sensor.calibrationTransform2">android.sensor.calibrationTransform2</a>, and

26893

<a href="#static_android.sensor.forwardMatrix2">android.sensor.forwardMatrix2</a> will also be present.

Shuzhen Wang

2018-10-15 12:00:13 -0700

[diff] [blame]

26894

Starting from Android Q, this key will not be present for a MONOCHROME camera, even if

26895

the camera device has RAW capability.

Ruben Brunk

2014-04-15 17:43:56 -0700

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

26900

Ruben Brunk

2014-04-15 17:43:56 -0700

[diff] [blame]

26901

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

26905

<td class="entry_name

26906

" rowspan="3">

Ruben Brunk

2014-04-15 17:43:56 -0700

[diff] [blame]

26907

android.sensor.calibrationTransform1

</td>

rational

x

3 x 3

Eino-Ville Talvala

2014-05-27 10:50:30 -0700

[diff] [blame]

26916

[public as colorSpaceTransform]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

26920

Ruben Brunk

2014-04-15 17:43:56 -0700

[diff] [blame]

26921

<div class="entry_type_notes">3x3 matrix in row-major-order</div>

26922

26923

26924

</td>

26925

26926

26927

A per-device calibration transform matrix that maps from the

26928

reference sensor colorspace to the actual device sensor colorspace.

</td>

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Ruben Brunk

2014-04-15 17:43:56 -0700

[diff] [blame]

26941

26942

Eino-Ville Talvala

2014-07-15 10:43:01 -0700

[diff] [blame]

26943

Ruben Brunk

2014-04-15 17:43:56 -0700

[diff] [blame]

</ul>

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

26949

<th class="th_details" colspan="6">Details</th>

Ruben Brunk

2014-04-15 17:43:56 -0700

[diff] [blame]

26950

</tr>

26951

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

26952

Ruben Brunk

2014-04-15 17:43:56 -0700

[diff] [blame]

26953

This matrix is used to correct for per-device variations in the

26954

sensor colorspace, and is used for processing raw buffer data.

26955

The matrix is expressed as a 3x3 matrix in row-major-order, and

26956

contains a per-device calibration transform that maps colors

26957

from reference sensor color space (i.e. the "golden module"

26958

colorspace) into this camera device's native sensor color

26959

space under the first reference illuminant

26960

(<a href="#static_android.sensor.referenceIlluminant1">android.sensor.referenceIlluminant1</a>).

Shuzhen Wang

2018-10-15 12:00:13 -0700

[diff] [blame]

26961

Starting from Android Q, this key will not be present for a MONOCHROME camera, even if

26962

the camera device has RAW capability.

Ruben Brunk

2014-04-15 17:43:56 -0700

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

26967

Ruben Brunk

2014-04-15 17:43:56 -0700

[diff] [blame]

26968

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

26972

<td class="entry_name

26973

" rowspan="3">

Ruben Brunk

2014-04-15 17:43:56 -0700

[diff] [blame]

26974

android.sensor.calibrationTransform2

</td>

rational

x

3 x 3

Eino-Ville Talvala

2014-05-27 10:50:30 -0700

[diff] [blame]

26983

[public as colorSpaceTransform]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

26987

Ruben Brunk

2014-04-15 17:43:56 -0700

[diff] [blame]

26988

<div class="entry_type_notes">3x3 matrix in row-major-order</div>

26989

26990

26991

</td>

26992

26993

26994

A per-device calibration transform matrix that maps from the

26995

reference sensor colorspace to the actual device sensor colorspace

26996

(this is the colorspace of the raw buffer data).

</td>

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Ruben Brunk

2014-04-15 17:43:56 -0700

[diff] [blame]

27009

27010

Eino-Ville Talvala

2014-07-15 10:43:01 -0700

[diff] [blame]

27011

Ruben Brunk

2014-04-15 17:43:56 -0700

[diff] [blame]

</ul>

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

27017

<th class="th_details" colspan="6">Details</th>

Ruben Brunk

2014-04-15 17:43:56 -0700

[diff] [blame]

27018

</tr>

27019

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

27020

Ruben Brunk

2014-04-15 17:43:56 -0700

[diff] [blame]

27021

This matrix is used to correct for per-device variations in the

27022

sensor colorspace, and is used for processing raw buffer data.

27023

The matrix is expressed as a 3x3 matrix in row-major-order, and

27024

contains a per-device calibration transform that maps colors

27025

from reference sensor color space (i.e. the "golden module"

27026

colorspace) into this camera device's native sensor color

27027

space under the second reference illuminant

27028

(<a href="#static_android.sensor.referenceIlluminant2">android.sensor.referenceIlluminant2</a>).

27029

This matrix will only be present if the second reference

27030

illuminant is present.

Shuzhen Wang

2018-10-15 12:00:13 -0700

[diff] [blame]

27031

Starting from Android Q, this key will not be present for a MONOCHROME camera, even if

27032

the camera device has RAW capability.

Ruben Brunk

2014-04-15 17:43:56 -0700

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

27037

Ruben Brunk

2014-04-15 17:43:56 -0700

[diff] [blame]

27038

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

27042

<td class="entry_name

27043

" rowspan="3">

Ruben Brunk

2014-04-15 17:43:56 -0700

[diff] [blame]

27044

android.sensor.colorTransform1

</td>

rational

x

3 x 3

Eino-Ville Talvala

2014-05-27 10:50:30 -0700

[diff] [blame]

27053

[public as colorSpaceTransform]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

27057

Ruben Brunk

2014-04-15 17:43:56 -0700

[diff] [blame]

27058

<div class="entry_type_notes">3x3 matrix in row-major-order</div>

27059

27060

27061

</td>

27062

27063

27064

A matrix that transforms color values from CIE XYZ color space to

27065

reference sensor color space.

</td>

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Ruben Brunk

2014-04-15 17:43:56 -0700

[diff] [blame]

27078

27079

Eino-Ville Talvala

2014-07-15 10:43:01 -0700

[diff] [blame]

27080

Ruben Brunk

2014-04-15 17:43:56 -0700

[diff] [blame]

</ul>

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

27086

<th class="th_details" colspan="6">Details</th>

Ruben Brunk

2014-04-15 17:43:56 -0700

[diff] [blame]

27087

</tr>

27088

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

27089

Ruben Brunk

2014-04-15 17:43:56 -0700

[diff] [blame]

27090

This matrix is used to convert from the standard CIE XYZ color

27091

space to the reference sensor colorspace, and is used when processing

27092

raw buffer data.

27093

The matrix is expressed as a 3x3 matrix in row-major-order, and

27094

contains a color transform matrix that maps colors from the CIE

27095

XYZ color space to the reference sensor color space (i.e. the

27096

"golden module" colorspace) under the first reference illuminant

27097

(<a href="#static_android.sensor.referenceIlluminant1">android.sensor.referenceIlluminant1</a>).

27098

The white points chosen in both the reference sensor color space

27099

and the CIE XYZ colorspace when calculating this transform will

27100

match the standard white point for the first reference illuminant

27101

(i.e. no chromatic adaptation will be applied by this transform).

Shuzhen Wang

2018-10-15 12:00:13 -0700

[diff] [blame]

27102

Starting from Android Q, this key will not be present for a MONOCHROME camera, even if

27103

the camera device has RAW capability.

Ruben Brunk

2014-04-15 17:43:56 -0700

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

27108

Ruben Brunk

2014-04-15 17:43:56 -0700

[diff] [blame]

27109

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

27113

<td class="entry_name

27114

" rowspan="3">

Ruben Brunk

2014-04-15 17:43:56 -0700

[diff] [blame]

27115

android.sensor.colorTransform2

</td>

rational

x

3 x 3

Eino-Ville Talvala

2014-05-27 10:50:30 -0700

[diff] [blame]

27124

[public as colorSpaceTransform]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

27128

Ruben Brunk

2014-04-15 17:43:56 -0700

[diff] [blame]

27129

<div class="entry_type_notes">3x3 matrix in row-major-order</div>

27130

27131

27132

</td>

27133

27134

27135

A matrix that transforms color values from CIE XYZ color space to

27136

reference sensor color space.

</td>

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Ruben Brunk

2014-04-15 17:43:56 -0700

[diff] [blame]

27149

27150

Eino-Ville Talvala

2014-07-15 10:43:01 -0700

[diff] [blame]

27151

Ruben Brunk

2014-04-15 17:43:56 -0700

[diff] [blame]

</ul>

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

27157

<th class="th_details" colspan="6">Details</th>

Ruben Brunk

2014-04-15 17:43:56 -0700

[diff] [blame]

27158

</tr>

27159

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

27160

Ruben Brunk

2014-04-15 17:43:56 -0700

[diff] [blame]

27161

This matrix is used to convert from the standard CIE XYZ color

27162

space to the reference sensor colorspace, and is used when processing

27163

raw buffer data.

27164

The matrix is expressed as a 3x3 matrix in row-major-order, and

27165

contains a color transform matrix that maps colors from the CIE

27166

XYZ color space to the reference sensor color space (i.e. the

27167

"golden module" colorspace) under the second reference illuminant

27168

(<a href="#static_android.sensor.referenceIlluminant2">android.sensor.referenceIlluminant2</a>).

27169

The white points chosen in both the reference sensor color space

27170

and the CIE XYZ colorspace when calculating this transform will

27171

match the standard white point for the second reference illuminant

27172

(i.e. no chromatic adaptation will be applied by this transform).

27173

This matrix will only be present if the second reference

27174

illuminant is present.

Shuzhen Wang

2018-10-15 12:00:13 -0700

[diff] [blame]

27175

Starting from Android Q, this key will not be present for a MONOCHROME camera, even if

27176

the camera device has RAW capability.

Ruben Brunk

2014-04-15 17:43:56 -0700

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

27181

Ruben Brunk

2014-04-15 17:43:56 -0700

[diff] [blame]

27182

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

27186

<td class="entry_name

27187

" rowspan="3">

Ruben Brunk

2014-04-15 17:43:56 -0700

[diff] [blame]

27188

android.sensor.forwardMatrix1

</td>

rational

x

3 x 3

Eino-Ville Talvala

2014-05-27 10:50:30 -0700

[diff] [blame]

27197

[public as colorSpaceTransform]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

27201

Ruben Brunk

2014-04-15 17:43:56 -0700

[diff] [blame]

27202

<div class="entry_type_notes">3x3 matrix in row-major-order</div>

27203

27204

27205

</td>

27206

27207

27208

A matrix that transforms white balanced camera colors from the reference

27209

sensor colorspace to the CIE XYZ colorspace with a D50 whitepoint.

</td>

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Ruben Brunk

2014-04-15 17:43:56 -0700

[diff] [blame]

27222

27223

Eino-Ville Talvala

2014-07-15 10:43:01 -0700

[diff] [blame]

27224

Ruben Brunk

2014-04-15 17:43:56 -0700

[diff] [blame]

</ul>

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

27230

<th class="th_details" colspan="6">Details</th>

Ruben Brunk

2014-04-15 17:43:56 -0700

[diff] [blame]

27231

</tr>

27232

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

27233

Ruben Brunk

2014-04-15 17:43:56 -0700

[diff] [blame]

27234

This matrix is used to convert to the standard CIE XYZ colorspace, and

27235

is used when processing raw buffer data.

27236

This matrix is expressed as a 3x3 matrix in row-major-order, and contains

27237

a color transform matrix that maps white balanced colors from the

27238

reference sensor color space to the CIE XYZ color space with a D50 white

27239

point.

27240

Under the first reference illuminant (<a href="#static_android.sensor.referenceIlluminant1">android.sensor.referenceIlluminant1</a>)

27241

this matrix is chosen so that the standard white point for this reference

27242

illuminant in the reference sensor colorspace is mapped to D50 in the

27243

CIE XYZ colorspace.

Shuzhen Wang

2018-10-15 12:00:13 -0700

[diff] [blame]

27244

Starting from Android Q, this key will not be present for a MONOCHROME camera, even if

27245

the camera device has RAW capability.

Ruben Brunk

2014-04-15 17:43:56 -0700

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

27250

Ruben Brunk

2014-04-15 17:43:56 -0700

[diff] [blame]

27251

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

27255

<td class="entry_name

27256

" rowspan="3">

Ruben Brunk

2014-04-15 17:43:56 -0700

[diff] [blame]

27257

android.sensor.forwardMatrix2

</td>

rational

x

3 x 3

Eino-Ville Talvala

2014-05-27 10:50:30 -0700

[diff] [blame]

27266

[public as colorSpaceTransform]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

27270

Ruben Brunk

2014-04-15 17:43:56 -0700

[diff] [blame]

27271

<div class="entry_type_notes">3x3 matrix in row-major-order</div>

27272

27273

27274

</td>

27275

27276

27277

A matrix that transforms white balanced camera colors from the reference

27278

sensor colorspace to the CIE XYZ colorspace with a D50 whitepoint.

</td>

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Ruben Brunk

2014-04-15 17:43:56 -0700

[diff] [blame]

27291

27292

Eino-Ville Talvala

2014-07-15 10:43:01 -0700

[diff] [blame]

27293

Ruben Brunk

2014-04-15 17:43:56 -0700

[diff] [blame]

</ul>

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

27299

<th class="th_details" colspan="6">Details</th>

Ruben Brunk

2014-04-15 17:43:56 -0700

[diff] [blame]

27300

</tr>

27301

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

27302

Ruben Brunk

2014-04-15 17:43:56 -0700

[diff] [blame]

27303

This matrix is used to convert to the standard CIE XYZ colorspace, and

27304

is used when processing raw buffer data.

27305

This matrix is expressed as a 3x3 matrix in row-major-order, and contains

27306

a color transform matrix that maps white balanced colors from the

27307

reference sensor color space to the CIE XYZ color space with a D50 white

27308

point.

27309

Under the second reference illuminant (<a href="#static_android.sensor.referenceIlluminant2">android.sensor.referenceIlluminant2</a>)

27310

this matrix is chosen so that the standard white point for this reference

27311

illuminant in the reference sensor colorspace is mapped to D50 in the

27312

CIE XYZ colorspace.

27313

This matrix will only be present if the second reference

27314

illuminant is present.

Shuzhen Wang

2018-10-15 12:00:13 -0700

[diff] [blame]

27315

Starting from Android Q, this key will not be present for a MONOCHROME camera, even if

27316

the camera device has RAW capability.

Ruben Brunk

2014-04-15 17:43:56 -0700

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

27321

Ruben Brunk

2014-04-15 17:43:56 -0700

[diff] [blame]

27322

27323

27324

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

27325

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

27326

<td class="entry_name

27327

" rowspan="1">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

27328

android.sensor.baseGainFactor

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

27329

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

27330

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

27331

rational

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

27332

Zhijun He

2014-05-23 11:02:34 -0700

[diff] [blame]

27333

[system]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

27334

27335

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

27339

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

27340

</td>

27341

27342

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

27343

Gain factor from electrons to raw units when

27344

ISO=100

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

27357

27358

Zhijun He

2014-05-23 11:02:34 -0700

[diff] [blame]

27359

<li><a href="#tag_FUTURE">FUTURE</a></li>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</ul>

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

27363

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

27364

27365

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

27366

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

27367

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

27371

<td class="entry_name

Ruben Brunk

2014-06-05 13:20:47 -0700

[diff] [blame]

27372

" rowspan="5">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

27373

android.sensor.blackLevelPattern

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

27374

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

27375

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

27376

int32

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

x

4

Ruben Brunk

2014-06-05 13:20:47 -0700

[diff] [blame]

27382

[public as blackLevelPattern]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

27386

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

27387

<div class="entry_type_notes">2x2 raw count block</div>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

27388

27389

27390

</td>

27391

27392

Ruben Brunk

24bdaaf

2014-01-31 14:11:20 -0800

[diff] [blame]

27393

A fixed black level offset for each of the color filter arrangement

27394

(CFA) mosaic channels.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

Ruben Brunk

2014-01-31 14:11:20 -0800

[diff] [blame]

27401

>= 0 for each.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

27402

</td>

27403

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

27408

27409

Eino-Ville Talvala

2014-07-15 10:43:01 -0700

[diff] [blame]

27410

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</ul>

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

27414

</tr>

27415

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

27416

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

27417

</tr>

27418

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

27419

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

27420

This key specifies the zero light value for each of the CFA mosaic

Ruben Brunk

2014-02-10 19:16:56 -0800

[diff] [blame]

27421

channels in the camera sensor. The maximal value output by the

27422

sensor is represented by the value in <a href="#static_android.sensor.info.whiteLevel">android.sensor.info.whiteLevel</a>.

Ruben Brunk

2014-06-05 13:20:47 -0700

[diff] [blame]

27423

The values are given in the same order as channels listed for the CFA

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

27424

layout key (see <a href="#static_android.sensor.info.colorFilterArrangement">android.sensor.info.colorFilterArrangement</a>), i.e. the

Ruben Brunk

2014-06-05 13:20:47 -0700

[diff] [blame]

27425

nth value given corresponds to the black level offset for the nth

27426

color channel listed in the CFA.

Zhijun He

2015-11-12 17:27:27 -0800

[diff] [blame]

27427

The black level values of captured images may vary for different

27428

capture settings (e.g., <a href="#controls_android.sensor.sensitivity">android.sensor.sensitivity</a>). This key

27429

represents a coarse approximation for such case. It is recommended to

27430

use <a href="#dynamic_android.sensor.dynamicBlackLevel">android.sensor.dynamicBlackLevel</a> or use pixels from

27431

<a href="#static_android.sensor.opticalBlackRegions">android.sensor.opticalBlackRegions</a> directly for captures when

27432

supported by the camera device, which provides more accurate black

27433

level values. For raw capture in particular, it is recommended to use

27434

pixels from <a href="#static_android.sensor.opticalBlackRegions">android.sensor.opticalBlackRegions</a> to calculate black

27435

level values for each frame.

Shuzhen Wang

2018-10-15 12:00:13 -0700

[diff] [blame]

27436

For a MONOCHROME camera device, all of the 2x2 channels must have the same values.

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

27437

</td>

27438

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

27439

Ruben Brunk

2014-06-05 13:20:47 -0700

[diff] [blame]

27440

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

27441

<th class="th_details" colspan="6">HAL Implementation Details</th>

Ruben Brunk

2014-06-05 13:20:47 -0700

[diff] [blame]

27442

</tr>

27443

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

27444

Ruben Brunk

2014-06-05 13:20:47 -0700

[diff] [blame]

27445

The values are given in row-column scan order, with the first value

27446

corresponding to the element of the CFA in row=0, column=0.

27447

</td>

27448

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

27449

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

27450

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

27451

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

27452

27453

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

27454

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

27455

<td class="entry_name

27456

" rowspan="3">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

27457

android.sensor.maxAnalogSensitivity

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

27458

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

27459

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

27460

int32

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

27461

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

27462

[public]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

27463

27464

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

27465

[full]

27466

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

27470

</td>

27471

27472

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

27473

Maximum sensitivity that is implemented

Zhijun He

2014-01-21 18:28:30 -0800

[diff] [blame]

27474

purely through analog gain.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

27487

27488

Igor Murashkin

2012-12-05 14:49:11 -0800

[diff] [blame]

27489

Alex Ray

2013-10-01 17:52:33 -0700

[diff] [blame]

27490

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</ul>

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

27494

</tr>

27495

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

27496

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

27497

</tr>

27498

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

27499

Eino-Ville Talvala

2014-01-02 16:11:44 -0800

[diff] [blame]

27500

For <a href="#controls_android.sensor.sensitivity">android.sensor.sensitivity</a> values less than or

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

27501

equal to this, all applied gain must be analog. For

Zhijun He

2014-01-21 18:28:30 -0800

[diff] [blame]

27502

values above this, the gain applied can be a mix of analog and

27503

digital.

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

27504

</td>

27505

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

27506

27507

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

27508

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

27509

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

27510

27511

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

27512

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

27513

<td class="entry_name

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

27514

" rowspan="3">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

27515

android.sensor.orientation

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

27516

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

27517

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

27518

int32

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

27519

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

27520

[public]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

27521

27522

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

27523

[legacy]

27524

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

27528

</td>

27529

27530

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

27531

Clockwise angle through which the output image needs to be rotated to be

27532

upright on the device screen in its native orientation.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

27536

Degrees of clockwise rotation; always a multiple of

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

27537

90

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

27541

0, 90, 180, 270

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

27542

</td>

27543

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

27548

27549

Igor Murashkin

2012-12-05 14:49:11 -0800

[diff] [blame]

27550

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</ul>

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

27554

</tr>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

27555

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

27556

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

27557

</tr>

27558

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

27559

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

27560

Also defines the direction of rolling shutter readout, which is from top to bottom in

27561

the sensor's coordinate system.

Emilian Peev

2021-09-24 17:45:05 -0700

[diff] [blame]

27562

Starting with Android API level 32, camera clients that query the orientation via

27563

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics.html#get">CameraCharacteristics#get</a> on foldable devices which

27564

include logical cameras can receive a value that can dynamically change depending on the

27565

device/fold state.

27566

Clients are advised to not cache or store the orientation value of such logical sensors.

27567

In case repeated queries to CameraCharacteristics are not preferred, then clients can

27568

also access the entire mapping from device state to sensor orientation in

Emilian Peev

2021-10-12 13:11:27 -0700

[diff] [blame]

27569

<a href="https://developer.android.com/reference/android/hardware/camera2/params/DeviceStateSensorOrientationMap.html">DeviceStateSensorOrientationMap</a>.

Emilian Peev

2021-09-24 17:45:05 -0700

[diff] [blame]

27570

Do note that a dynamically changing sensor orientation value in camera characteristics

27571

will not be the best way to establish the orientation per frame. Clients that want to

27572

know the sensor orientation of a particular captured frame should query the

27573

<a href="#dynamic_android.logicalMultiCamera.activePhysicalId">android.logicalMultiCamera.activePhysicalId</a> from the corresponding capture result and

27574

check the respective physical camera orientation.

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

27575

</td>

27576

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

27577

27578

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

27579

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

27580

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

27581

27582

Ruben Brunk

2014-02-06 13:04:38 -0800

[diff] [blame]

27583

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

27584

<td class="entry_name

27585

" rowspan="3">

Ruben Brunk

2014-02-06 13:04:38 -0800

[diff] [blame]

27586

android.sensor.profileHueSatMapDimensions

</td>

int32

x

3

Zhijun He

2014-05-06 16:18:04 -0700

[diff] [blame]

27595

[system]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

27599

Ruben Brunk

2014-02-06 13:04:38 -0800

[diff] [blame]

27600

<div class="entry_type_notes">Number of samples for hue, saturation, and value</div>

27601

27602

27603

</td>

27604

27605

27606

The number of input samples for each dimension of

27607

<a href="#dynamic_android.sensor.profileHueSatMap">android.sensor.profileHueSatMap</a>.

</td>

</td>

Hue >= 1,

Saturation >= 2,

Value >= 1

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Ruben Brunk

2014-02-06 13:04:38 -0800

[diff] [blame]

27623

27624

Eino-Ville Talvala

2014-07-15 10:43:01 -0700

[diff] [blame]

27625

Ruben Brunk

2014-02-06 13:04:38 -0800

[diff] [blame]

</ul>

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

27631

<th class="th_details" colspan="6">Details</th>

Ruben Brunk

2014-02-06 13:04:38 -0800

[diff] [blame]

27632

</tr>

27633

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

27634

Ruben Brunk

2014-02-06 13:04:38 -0800

[diff] [blame]

27635

The number of input samples for the hue, saturation, and value

27636

dimension of <a href="#dynamic_android.sensor.profileHueSatMap">android.sensor.profileHueSatMap</a>. The order of the

27637

dimensions given is hue, saturation, value; where hue is the 0th

element.

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

27643

Ruben Brunk

2014-02-06 13:04:38 -0800

[diff] [blame]

27644

27645

27646

Igor Murashkin

2014-01-09 17:43:38 -0800

[diff] [blame]

27647

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

27648

<td class="entry_name

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

27649

" rowspan="5">

Igor Murashkin

2014-01-09 17:43:38 -0800

[diff] [blame]

27650

android.sensor.availableTestPatternModes

27651

</td>

27652

Zhijun He

29a973d

2014-03-27 23:54:16 -0700

[diff] [blame]

27653

int32

27654

x

Igor Murashkin

2014-01-09 17:43:38 -0800

[diff] [blame]

27655

Zhijun He

29a973d

2014-03-27 23:54:16 -0700

[diff] [blame]

n

Igor Murashkin

2014-01-09 17:43:38 -0800

[diff] [blame]

27659

[public]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

27663

Zhijun He

29a973d

2014-03-27 23:54:16 -0700

[diff] [blame]

27664

<div class="entry_type_notes">list of enums</div>

Igor Murashkin

2014-01-09 17:43:38 -0800

[diff] [blame]

27665

27666

27667

</td>

27668

27669

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

27670

List of sensor test pattern modes for <a href="#controls_android.sensor.testPatternMode">android.sensor.testPatternMode</a>

27671

supported by this camera device.

Igor Murashkin

2014-01-09 17:43:38 -0800

[diff] [blame]

</td>

</td>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

27678

Any value listed in <a href="#controls_android.sensor.testPatternMode">android.sensor.testPatternMode</a>

Igor Murashkin

2014-01-09 17:43:38 -0800

[diff] [blame]

27679

</td>

27680

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2014-01-09 17:43:38 -0800

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2014-06-06 14:35:41 -0700

[diff] [blame]

27689

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

27690

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2014-06-06 14:35:41 -0700

[diff] [blame]

27691

</tr>

27692

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

27693

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

27694

Defaults to OFF, and always includes OFF if defined.

Eino-Ville Talvala

2014-06-06 14:35:41 -0700

[diff] [blame]

27695

</td>

27696

</tr>

Igor Murashkin

2014-01-09 17:43:38 -0800

[diff] [blame]

27697

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

27698

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

27699

<th class="th_details" colspan="6">HAL Implementation Details</th>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

27700

</tr>

27701

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

27702

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

27703

All custom modes must be >= CUSTOM1.

27704

</td>

27705

</tr>

Igor Murashkin

2014-01-09 17:43:38 -0800

[diff] [blame]

27706

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

27707

Igor Murashkin

2014-01-09 17:43:38 -0800

[diff] [blame]

27708

27709

Zhijun He

2015-11-12 17:27:27 -0800

[diff] [blame]

27710

27711

27712

<td class="entry_name

27713

" rowspan="5">

27714

android.sensor.opticalBlackRegions

</td>

int32

x

4 x num_regions

[public as rectangle]

</td>

27731

27732

27733

List of disjoint rectangles indicating the sensor

27734

optically shielded black pixel regions.

</td>

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Zhijun He

2015-11-12 17:27:27 -0800

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

27752

<th class="th_details" colspan="6">Details</th>

Zhijun He

2015-11-12 17:27:27 -0800

[diff] [blame]

27753

</tr>

27754

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

27755

Zhijun He

2015-11-12 17:27:27 -0800

[diff] [blame]

27756

In most camera sensors, the active array is surrounded by some

27757

optically shielded pixel areas. By blocking light, these pixels

27758

provides a reliable black reference for black level compensation

27759

in active array region.

27760

This key provides a list of disjoint rectangles specifying the

27761

regions of optically shielded (with metal shield) black pixel

27762

regions if the camera device is capable of reading out these black

27763

pixels in the output raw images. In comparison to the fixed black

27764

level values reported by <a href="#static_android.sensor.blackLevelPattern">android.sensor.blackLevelPattern</a>, this key

27765

may provide a more accurate way for the application to calculate

27766

black level of each captured raw images.

27767

When this key is reported, the <a href="#dynamic_android.sensor.dynamicBlackLevel">android.sensor.dynamicBlackLevel</a> and

27768

<a href="#dynamic_android.sensor.dynamicWhiteLevel">android.sensor.dynamicWhiteLevel</a> will also be reported.

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

27773

<th class="th_details" colspan="6">HAL Implementation Details</th>

Zhijun He

2015-11-12 17:27:27 -0800

[diff] [blame]

27774

</tr>

27775

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

27776

Zhijun He

2015-11-12 17:27:27 -0800

[diff] [blame]

27777

This array contains (xmin, ymin, width, height). The (xmin, ymin)

27778

must be >= (0,0) and <=

27779

<a href="#static_android.sensor.info.pixelArraySize">android.sensor.info.pixelArraySize</a>. The (width, height) must be

27780

<= <a href="#static_android.sensor.info.pixelArraySize">android.sensor.info.pixelArraySize</a>. Each region must be

27781

outside the region reported by

27782

<a href="#static_android.sensor.info.preCorrectionActiveArraySize">android.sensor.info.preCorrectionActiveArraySize</a>.

27783

The HAL must report minimal number of disjoint regions for the

27784

optically shielded back pixel regions. For example, if a region can

27785

be covered by one rectangle, the HAL must not split this region into

multiple rectangles.

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

27790

Zhijun He

2015-11-12 17:27:27 -0800

[diff] [blame]

27791

27792

Yin-Chia Yeh

2015-12-06 21:42:35 -0800

[diff] [blame]

27793

27794

27795

<td class="entry_name

27796

" rowspan="5">

27797

android.sensor.opaqueRawSize

</td>

int32

x

n x 3

[system]

</td>

27814

27815

27816

Size in bytes for all the listed opaque RAW buffer sizes

</td>

</td>

Must be large enough to fit the opaque RAW of corresponding size produced by

the camera

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Yin-Chia Yeh

2015-12-06 21:42:35 -0800

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

27836

<th class="th_details" colspan="6">Details</th>

Yin-Chia Yeh

2015-12-06 21:42:35 -0800

[diff] [blame]

27837

</tr>

27838

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

27839

Yin-Chia Yeh

2015-12-06 21:42:35 -0800

[diff] [blame]

27840

This configurations are listed as <code>(width, height, size_in_bytes)</code> tuples.

27841

This is used for sizing the gralloc buffers for opaque RAW buffers.

27842

All RAW_OPAQUE output stream configuration listed in

27843

<a href="#static_android.scaler.availableStreamConfigurations">android.scaler.availableStreamConfigurations</a> will have a corresponding tuple in

this key.

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

27849

<th class="th_details" colspan="6">HAL Implementation Details</th>

Yin-Chia Yeh

2015-12-06 21:42:35 -0800

[diff] [blame]

27850

</tr>

27851

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

27852

27853

This key is added in legacy HAL3.4.

27854

For legacy HAL3.4 or above: devices advertising RAW_OPAQUE format output must list this

27855

key. For legacy HAL3.3 or earlier devices: if RAW_OPAQUE ouput is advertised, camera

27856

framework will derive this key by assuming each pixel takes two bytes and no padding bytes

Yin-Chia Yeh

2015-12-06 21:42:35 -0800

[diff] [blame]

between rows.

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

27861

Yin-Chia Yeh

2015-12-06 21:42:35 -0800

[diff] [blame]

27862

27863

Jayant Chowdhary

2020-11-09 09:08:31 -0800

[diff] [blame]

27864

27865

27866

<td class="entry_name

27867

" rowspan="5">

27868

android.sensor.opaqueRawSizeMaximumResolution

</td>

int32

x

n x 3

[system]

</td>

27885

27886

27887

Size in bytes for all the listed opaque RAW buffer sizes when

27888

<a href="#controls_android.sensor.pixelMode">android.sensor.pixelMode</a> is set to

27889

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraMetadata.html#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION">CameraMetadata#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION</a>.

</td>

</td>

Must be large enough to fit the opaque RAW of corresponding size produced by

the camera

</td>

3.6

</td>

</td>

</tr>

<th class="th_details" colspan="6">Details</th>

</tr>

Refer to <a href="#static_android.sensor.opaqueRawSize">android.sensor.opaqueRawSize</a> for details.

</td>

</tr>

<th class="th_details" colspan="6">HAL Implementation Details</th>

</tr>

Refer to <a href="#static_android.sensor.opaqueRawSize">android.sensor.opaqueRawSize</a> for details.

</td>

</tr>

27928

Shuzhen Wang

ccdf3a3

2022-04-20 10:15:57 -0700

[diff] [blame]

27929

27930

27931

<td class="entry_name

27932

" rowspan="5">

27933

android.sensor.readoutTimestamp

</td>

byte

[fwk_java_public]

[legacy]

<li>

NOT_SUPPORTED (v3.2)

This camera device doesn't support readout timestamp and onReadoutStarted

callback.

</li>

<li>

HARDWARE (v3.2)

This camera device supports the onReadoutStarted callback as well as outputting

27954

readout timestamp for streams with TIMESTAMP_BASE_READOUT_SENSOR timestamp base. The

27955

readout timestamp is generated by the camera hardware and it has the same accuracy

27956

and timing characteristics of the start-of-exposure time.

</li>

</ul>

</td>

27961

27962

27963

Whether or not the camera device supports readout timestamp and

27964

onReadoutStarted callback.

</td>

</td>

</td>

3.2

</td>

</td>

</tr>

<th class="th_details" colspan="6">Details</th>

</tr>

If this tag is HARDWARE, the camera device calls onReadoutStarted in addition to the

27987

onCaptureStarted callback for each capture. The timestamp passed into the callback

27988

is the start of camera image readout rather than the start of the exposure. In

27989

addition, the application can configure an

27990

<a href="https://developer.android.com/reference/android/hardware/camera2/params/OutputConfiguration.html">OutputConfiguration</a> with

27991

TIMESTAMP_BASE_READOUT_SENSOR timestamp base, in which case, the timestamp of the

27992

output surface matches the timestamp from the corresponding onReadoutStarted callback.

27993

The readout timestamp is beneficial for video recording, because the encoder favors

27994

uniform timestamps, and the readout timestamps better reflect the cadence camera sensors

27995

output data.

27996

If this tag is HARDWARE, the camera device produces the start-of-exposure and

27997

start-of-readout together. As a result, the onReadoutStarted is called right after

27998

onCaptureStarted. The difference in start-of-readout and start-of-exposure is the sensor

27999

exposure time, plus certain constant offset. The offset is usually due to camera sensor

28000

level crop, and it remains constant for a given camera sensor mode.

</td>

</tr>

<th class="th_details" colspan="6">HAL Implementation Details</th>

</tr>

This property is populated by the camera framework and must not be set at the HAL layer.

</td>

</tr>

28015

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</tbody>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

28020

<tr><td colspan="7" class="kind">dynamic</td></tr>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

28021

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

28022

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

28023

<tr>

28024

<th class="th_name">Property Name</th>

28025

28026

<th class="th_description">Description</th>

28027

<th class="th_units">Units</th>

28028

<th class="th_range">Range</th>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

28029

<th class="th_hal_version">Initial HIDL HAL version</th>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</tr>

</thead>

<tbody>

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

28046

<td class="entry_name

28047

" rowspan="3">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

28048

android.sensor.exposureTime

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

28049

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

28050

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

28051

int64

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

28052

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

28053

[public]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

28054

28055

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

28056

[full]

28057

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

28061

</td>

28062

28063

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

28064

Duration each pixel is exposed to

28065

light.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

28069

Nanoseconds

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Eino-Ville Talvala

2014-01-02 16:11:44 -0800

[diff] [blame]

28073

<a href="#static_android.sensor.info.exposureTimeRange">android.sensor.info.exposureTimeRange</a>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

28074

</td>

28075

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

28080

Igor Murashkin

2012-12-05 14:49:11 -0800

[diff] [blame]

28081

28082

28083

</ul>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

28084

</td>

28085

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

28086

</tr>

28087

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

28088

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

28089

</tr>

28090

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

28091

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

28092

If the sensor can't expose this exact duration, it will shorten the

28093

duration exposed to the nearest possible value (rather than expose longer).

28094

The final exposure time used will be available in the output capture result.

28095

This control is only effective if <a href="#controls_android.control.aeMode">android.control.aeMode</a> or <a href="#controls_android.control.mode">android.control.mode</a> is set to

28096

OFF; otherwise the auto-exposure algorithm will override this value.

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

28097

</td>

28098

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

28099

28100

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

28101

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

28102

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

28106

<td class="entry_name

28107

" rowspan="5">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

28108

android.sensor.frameDuration

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

28109

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

28110

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

28111

int64

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

28112

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

28113

[public]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

28114

28115

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

28116

[full]

28117

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

28121

</td>

28122

28123

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

28124

Duration from start of frame exposure to

Igor Murashkin

2014-01-13 17:22:58 -0800

[diff] [blame]

28125

start of next frame exposure.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

28129

Nanoseconds

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

28133

See <a href="#static_android.sensor.info.maxFrameDuration">android.sensor.info.maxFrameDuration</a>, <a href="https://developer.android.com/reference/android/hardware/camera2/params/StreamConfigurationMap.html">StreamConfigurationMap</a>.

28134

The duration is capped to <code>max(duration, exposureTime + overhead)</code>.

</td>

3.2

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

28139

</td>

28140

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

28141

Igor Murashkin

2012-12-05 14:49:11 -0800

[diff] [blame]

28142

28143

Igor Murashkin

2012-12-05 14:49:11 -0800

[diff] [blame]

28144

</ul>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

28145

</td>

28146

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

28147

</tr>

28148

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

28149

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

28150

</tr>

28151

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

28152

Igor Murashkin

2014-01-13 17:22:58 -0800

[diff] [blame]

28153

The maximum frame rate that can be supported by a camera subsystem is

28154

a function of many factors:

28155

<ul>

28156

<li>Requested resolutions of output image streams</li>

28157

<li>Availability of binning / skipping modes on the imager</li>

28158

<li>The bandwidth of the imager interface</li>

28159

<li>The bandwidth of the various ISP processing blocks</li>

28160

</ul>

28161

Since these factors can vary greatly between different ISPs and

28162

sensors, the camera abstraction tries to represent the bandwidth

28163

restrictions with as simple a model as possible.

28164

The model presented has the following characteristics:

28165

<ul>

28166

<li>The image sensor is always configured to output the smallest

28167

resolution possible given the application's requested output stream

28168

sizes. The smallest resolution is defined as being at least as large

28169

as the largest requested output stream size; the camera pipeline must

28170

never digitally upsample sensor data when the crop region covers the

28171

whole sensor. In general, this means that if only small output stream

28172

resolutions are configured, the sensor can provide a higher frame

28173

rate.</li>

28174

<li>Since any request may use any or all the currently configured

28175

output streams, the sensor and ISP must be configured to support

28176

scaling a single capture to all the streams at the same time. This

28177

means the camera pipeline must be ready to produce the largest

28178

requested output size without any delay. Therefore, the overall

28179

frame rate of a given configured stream set is governed only by the

28180

largest requested stream resolution.</li>

28181

<li>Using more than one output stream in a request does not affect the

28182

frame duration.</li>

Igor Murashkin

2014-02-07 14:31:31 -0800

[diff] [blame]

28183

<li>Certain format-streams may need to do additional background processing

28184

before data is consumed/produced by that stream. These processors

28185

can run concurrently to the rest of the camera pipeline, but

28186

cannot process more than 1 capture at a time.</li>

Igor Murashkin

2014-01-13 17:22:58 -0800

[diff] [blame]

28187

</ul>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

28188

The necessary information for the application, given the model above, is provided via

Eino-Ville Talvala

2015-04-16 13:49:52 -0700

[diff] [blame]

28189

<a href="https://developer.android.com/reference/android/hardware/camera2/params/StreamConfigurationMap.html#getOutputMinFrameDuration">StreamConfigurationMap#getOutputMinFrameDuration</a>.

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

28190

These are used to determine the maximum frame rate / minimum frame duration that is

28191

possible for a given stream configuration.

Igor Murashkin

2014-01-13 17:22:58 -0800

[diff] [blame]

28192

Specifically, the application can use the following rules to

Igor Murashkin

2014-02-07 14:31:31 -0800

[diff] [blame]

28193

determine the minimum frame duration it can request from the camera

Igor Murashkin

2014-01-13 17:22:58 -0800

[diff] [blame]

28194

device:

28195

<ol>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

28196

<li>Let the set of currently configured input/output streams be called <code>S</code>.</li>

28197

<li>Find the minimum frame durations for each stream in <code>S</code>, by looking it up in <a href="https://developer.android.com/reference/android/hardware/camera2/params/StreamConfigurationMap.html#getOutputMinFrameDuration">StreamConfigurationMap#getOutputMinFrameDuration</a>

28198

(with its respective size/format). Let this set of frame durations be called <code>F</code>.</li>

28199

<li>For any given request <code>R</code>, the minimum frame duration allowed for <code>R</code> is the maximum

28200

out of all values in <code>F</code>. Let the streams used in <code>R</code> be called <code>S_r</code>.</li>

Igor Murashkin

2014-01-13 17:22:58 -0800

[diff] [blame]

28201

</ol>

Eino-Ville Talvala

2015-04-16 13:49:52 -0700

[diff] [blame]

28202

If none of the streams in <code>S_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>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

28203

using its respective size/format), then the frame duration in <code>F</code> determines the steady

28204

state frame rate that the application will get if it uses <code>R</code> as a repeating request. Let

28205

this special kind of request be called <code>Rsimple</code>.

28206

A repeating request <code>Rsimple</code> can be occasionally interleaved by a single capture of a

28207

new request <code>Rstall</code> (which has at least one in-use stream with a non-0 stall time) and if

28208

<code>Rstall</code> has the same minimum frame duration this will not cause a frame rate loss if all

28209

buffers from the previous <code>Rstall</code> have already been delivered.

28210

For more details about stalling, see <a href="https://developer.android.com/reference/android/hardware/camera2/params/StreamConfigurationMap.html#getOutputStallDuration">StreamConfigurationMap#getOutputStallDuration</a>.

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

28211

This control is only effective if <a href="#controls_android.control.aeMode">android.control.aeMode</a> or <a href="#controls_android.control.mode">android.control.mode</a> is set to

28212

OFF; otherwise the auto-exposure algorithm will override this value.

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

28213

</td>

28214

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

28215

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

28216

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

28217

<th class="th_details" colspan="6">HAL Implementation Details</th>

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

28218

</tr>

28219

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

28220

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

28221

For more details about stalling, see

28222

<a href="#static_android.scaler.availableStallDurations">android.scaler.availableStallDurations</a>.

28223

</td>

28224

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

28225

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

28226

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

28227

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

28231

<td class="entry_name

Eino-Ville Talvala

2014-06-06 14:35:41 -0700

[diff] [blame]

28232

" rowspan="5">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

28233

android.sensor.sensitivity

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

28234

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

28235

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

28236

int32

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

28237

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

28238

[public]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

28239

28240

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

28241

[full]

28242

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

28246

</td>

28247

28248

Eino-Ville Talvala

2014-06-06 14:35:41 -0700

[diff] [blame]

28249

The amount of gain applied to sensor data

28250

before processing.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

28254

ISO arithmetic units

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Eino-Ville Talvala

2014-01-02 16:11:44 -0800

[diff] [blame]

28258

<a href="#static_android.sensor.info.sensitivityRange">android.sensor.info.sensitivityRange</a>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

28259

</td>

28260

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

28265

Igor Murashkin

2012-12-05 14:49:11 -0800

[diff] [blame]

28266

28267

28268

</ul>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

28269

</td>

28270

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

28271

</tr>

28272

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

28273

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

28274

</tr>

28275

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

28276

Eino-Ville Talvala

2014-06-06 14:35:41 -0700

[diff] [blame]

28277

The sensitivity is the standard ISO sensitivity value,

28278

as defined in ISO 12232:2006.

28279

The sensitivity must be within <a href="#static_android.sensor.info.sensitivityRange">android.sensor.info.sensitivityRange</a>, and

28280

if if it less than <a href="#static_android.sensor.maxAnalogSensitivity">android.sensor.maxAnalogSensitivity</a>, the camera device

28281

is guaranteed to use only analog amplification for applying the gain.

28282

If the camera device cannot apply the exact sensitivity

28283

requested, it will reduce the gain to the nearest supported

28284

value. The final sensitivity used will be available in the

28285

output capture result.

Yin-Chia Yeh

2016-01-18 19:14:55 -0800

[diff] [blame]

28286

This control is only effective if <a href="#controls_android.control.aeMode">android.control.aeMode</a> or <a href="#controls_android.control.mode">android.control.mode</a> is set to

28287

OFF; otherwise the auto-exposure algorithm will override this value.

Shuzhen Wang

0496197

2019-07-08 15:03:24 -0700

[diff] [blame]

28288

Note that for devices supporting postRawSensitivityBoost, the total sensitivity applied

28289

to the final processed image is the combination of <a href="#controls_android.sensor.sensitivity">android.sensor.sensitivity</a> and

28290

<a href="#controls_android.control.postRawSensitivityBoost">android.control.postRawSensitivityBoost</a>. In case the application uses the sensor

28291

sensitivity from last capture result of an auto request for a manual request, in order

28292

to achieve the same brightness in the output image, the application should also

28293

set postRawSensitivityBoost.

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

28294

</td>

28295

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

28296

Eino-Ville Talvala

2014-06-06 14:35:41 -0700

[diff] [blame]

28297

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

28298

<th class="th_details" colspan="6">HAL Implementation Details</th>

Eino-Ville Talvala

2014-06-06 14:35:41 -0700

[diff] [blame]

28299

</tr>

28300

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

28301

Eino-Ville Talvala

2014-06-06 14:35:41 -0700

[diff] [blame]

28302

ISO 12232:2006 REI method is acceptable.

28303

</td>

28304

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

28305

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

28306

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

28307

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

28311

<td class="entry_name

Eino-Ville Talvala

2014-06-06 14:35:41 -0700

[diff] [blame]

28312

" rowspan="5">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

28313

android.sensor.timestamp

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

28314

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

28315

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

28316

int64

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

28317

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

28318

[public]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

28319

28320

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

28321

[legacy]

28322

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

28326

</td>

28327

28328

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

28329

Time at start of exposure of first

Zhijun He

2014-06-11 10:44:53 -0700

[diff] [blame]

28330

row of the image sensor active array, in nanoseconds.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

28334

Nanoseconds

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Igor Murashkin

2014-01-10 15:12:40 -0800

[diff] [blame]

28338

> 0

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

28339

</td>

28340

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

28345

28346

Igor Murashkin

2012-12-05 14:49:11 -0800

[diff] [blame]

28347

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</ul>

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

28351

</tr>

28352

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

28353

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

28354

</tr>

28355

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

28356

Eino-Ville Talvala

2014-06-06 14:35:41 -0700

[diff] [blame]

28357

The timestamps are also included in all image

28358

buffers produced for the same capture, and will be identical

Zhijun He

2014-06-12 10:43:32 -0700

[diff] [blame]

28359

on all the outputs.

Eino-Ville Talvala

2014-07-28 12:49:25 -0700

[diff] [blame]

28360

When <a href="#static_android.sensor.info.timestampSource">android.sensor.info.timestampSource</a> <code>==</code> UNKNOWN,

Zhijun He

2014-06-12 10:43:32 -0700

[diff] [blame]

28361

the timestamps measure time since an unspecified starting point,

28362

and are monotonically increasing. They can be compared with the

28363

timestamps for other captures from the same camera device, but are

28364

not guaranteed to be comparable to any other time source.

Eino-Ville Talvala

2015-04-16 13:49:52 -0700

[diff] [blame]

28365

When <a href="#static_android.sensor.info.timestampSource">android.sensor.info.timestampSource</a> <code>==</code> REALTIME, the

28366

timestamps measure time in the same timebase as <a href="https://developer.android.com/reference/android/os/SystemClock.html#elapsedRealtimeNanos">SystemClock#elapsedRealtimeNanos</a>, and they can

28367

be compared to other timestamps from other subsystems that

28368

are using that base.

Chien-Yu Chen

c61e164

2015-05-29 11:36:53 -0700

[diff] [blame]

28369

For reprocessing, the timestamp will match the start of exposure of

28370

the input image, i.e. <a href="https://developer.android.com/reference/CaptureResult.html#SENSOR_TIMESTAMP">the

28371

timestamp</a> in the TotalCaptureResult that was used to create the

28372

reprocess capture request.

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

28373

</td>

28374

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

28375

Eino-Ville Talvala

2014-06-06 14:35:41 -0700

[diff] [blame]

28376

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

28377

<th class="th_details" colspan="6">HAL Implementation Details</th>

Eino-Ville Talvala

2014-06-06 14:35:41 -0700

[diff] [blame]

28378

</tr>

28379

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

28380

Zhijun He

2014-06-12 10:43:32 -0700

[diff] [blame]

28381

All timestamps must be in reference to the kernel's

Eino-Ville Talvala

2014-06-06 14:35:41 -0700

[diff] [blame]

28382

CLOCK_BOOTTIME monotonic clock, which properly accounts for

28383

time spent asleep. This allows for synchronization with

28384

sensors that continue to operate while the system is

28385

otherwise asleep.

Eino-Ville Talvala

2014-07-28 12:49:25 -0700

[diff] [blame]

28386

If <a href="#static_android.sensor.info.timestampSource">android.sensor.info.timestampSource</a> <code>==</code> REALTIME,

Zhijun He

2014-06-12 10:43:32 -0700

[diff] [blame]

28387

The timestamp must be synchronized with the timestamps from other

28388

sensor subsystems that are using the same timebase.

Chien-Yu Chen

c61e164

2015-05-29 11:36:53 -0700

[diff] [blame]

28389

For reprocessing, the input image's start of exposure can be looked up

28390

with <a href="#dynamic_android.sensor.timestamp">android.sensor.timestamp</a> from the metadata included in the

28391

capture request.

Eino-Ville Talvala

2014-06-06 14:35:41 -0700

[diff] [blame]

28392

</td>

28393

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

28394

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

28395

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

28396

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

28397

Igor Murashkin

2013-08-13 14:23:39 -0700

[diff] [blame]

28398

28399

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

28400

<td class="entry_name

28401

" rowspan="1">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

28402

android.sensor.temperature

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

28403

</td>

Igor Murashkin

2013-08-13 14:23:39 -0700

[diff] [blame]

float

Zhijun He

2014-05-23 11:02:34 -0700

[diff] [blame]

28407

[system]

Igor Murashkin

2013-08-13 14:23:39 -0700

[diff] [blame]

28408

28409

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

28413

Igor Murashkin

2013-08-13 14:23:39 -0700

[diff] [blame]

28414

</td>

28415

28416

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

28417

The temperature of the sensor, sampled at the time

28418

exposure began for this frame.

28419

The thermal diode being queried should be inside the sensor PCB, or

28420

somewhere close to it.

Igor Murashkin

2013-08-13 14:23:39 -0700

[diff] [blame]

</td>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

28424

Celsius

Igor Murashkin

2013-08-13 14:23:39 -0700

[diff] [blame]

</td>

Eino-Ville Talvala

2014-01-02 16:11:44 -0800

[diff] [blame]

28428

Optional. This value is missing if no temperature is available.

Igor Murashkin

2013-08-13 14:23:39 -0700

[diff] [blame]

28429

</td>

28430

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2013-08-13 14:23:39 -0700

[diff] [blame]

28435

Alex Ray

2013-10-01 17:52:33 -0700

[diff] [blame]

28436

Zhijun He

2014-05-23 11:02:34 -0700

[diff] [blame]

28437

<li><a href="#tag_FUTURE">FUTURE</a></li>

Alex Ray

2013-10-01 17:52:33 -0700

[diff] [blame]

28438

</ul>

Igor Murashkin

2013-08-13 14:23:39 -0700

[diff] [blame]

28439

</td>

28440

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

28441

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

28442

28443

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

28444

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

28445

Igor Murashkin

2013-08-13 14:23:39 -0700

[diff] [blame]

28446

Igor Murashkin

2014-01-09 17:43:38 -0800

[diff] [blame]

28447

Ruben Brunk

2014-02-06 18:37:48 -0800

[diff] [blame]

28448

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

28449

<td class="entry_name

28450

" rowspan="3">

Ruben Brunk

2014-02-06 18:37:48 -0800

[diff] [blame]

28451

android.sensor.neutralColorPoint

</td>

rational

x

3

[public]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

28466

Ruben Brunk

2014-02-06 18:37:48 -0800

[diff] [blame]

28467

</td>

28468

28469

Ruben Brunk

2014-04-15 17:43:56 -0700

[diff] [blame]

28470

The estimated camera neutral color in the native sensor colorspace at

28471

the time of capture.

Ruben Brunk

2014-02-06 18:37:48 -0800

[diff] [blame]

</td>

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Ruben Brunk

2014-02-06 18:37:48 -0800

[diff] [blame]

28484

28485

Eino-Ville Talvala

2014-07-15 10:43:01 -0700

[diff] [blame]

28486

Ruben Brunk

2014-02-06 18:37:48 -0800

[diff] [blame]

</ul>

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

28492

<th class="th_details" colspan="6">Details</th>

Ruben Brunk

2014-02-06 18:37:48 -0800

[diff] [blame]

28493

</tr>

28494

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

28495

Ruben Brunk

2014-04-15 17:43:56 -0700

[diff] [blame]

28496

This value gives the neutral color point encoded as an RGB value in the

28497

native sensor color space. The neutral color point indicates the

28498

currently estimated white point of the scene illumination. It can be

28499

used to interpolate between the provided color transforms when

28500

processing raw sensor data.

28501

The order of the values is R, G, B; where R is in the lowest index.

Shuzhen Wang

2018-10-15 12:00:13 -0700

[diff] [blame]

28502

Starting from Android Q, this key will not be present for a MONOCHROME camera, even if

28503

the camera device has RAW capability.

Ruben Brunk

2014-02-06 18:37:48 -0800

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

28508

Ruben Brunk

2014-02-06 18:37:48 -0800

[diff] [blame]

28509

28510

28511

Ruben Brunk

2014-07-23 15:13:16 -0700

[diff] [blame]

28512

28513

<td class="entry_name

28514

" rowspan="5">

28515

android.sensor.noiseProfile

</td>

double

x

2 x CFA Channels

[public as pairDoubleDouble]

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

28528

Ruben Brunk

2014-07-23 15:13:16 -0700

[diff] [blame]

28529

<div class="entry_type_notes">Pairs of noise model coefficients</div>

28530

28531

28532

</td>

28533

28534

28535

Noise model coefficients for each CFA mosaic channel.

</td>

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Ruben Brunk

2014-07-23 15:13:16 -0700

[diff] [blame]

</ul>

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

28556

<th class="th_details" colspan="6">Details</th>

Ruben Brunk

2014-07-23 15:13:16 -0700

[diff] [blame]

28557

</tr>

28558

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

28559

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

28560

This key contains two noise model coefficients for each CFA channel

Ruben Brunk

2014-07-23 15:13:16 -0700

[diff] [blame]

28561

corresponding to the sensor amplification (S) and sensor readout

28562

noise (O). These are given as pairs of coefficients for each channel

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

28563

in the same order as channels listed for the CFA layout key

Ruben Brunk

2014-07-23 15:13:16 -0700

[diff] [blame]

28564

(see <a href="#static_android.sensor.info.colorFilterArrangement">android.sensor.info.colorFilterArrangement</a>). This is

28565

represented as an array of Pair<Double, Double>, where

28566

the first member of the Pair at index n is the S coefficient and the

28567

second member is the O coefficient for the nth color channel in the CFA.

28568

These coefficients are used in a two parameter noise model to describe

28569

the amount of noise present in the image for each CFA channel. The

28570

noise model used here is:

28571

N(x) = sqrt(Sx + O)

28572

Where x represents the recorded signal of a CFA channel normalized to

Shuzhen Wang

2022-05-03 11:01:26 -0700

[diff] [blame]

28573

the range [0, 1], and S and O are the noise model coefficients for

Ruben Brunk

2014-07-23 15:13:16 -0700

[diff] [blame]

28574

that channel.

28575

A more detailed description of the noise model can be found in the

28576

Adobe DNG specification for the NoiseProfile tag.

Shuzhen Wang

2018-10-15 12:00:13 -0700

[diff] [blame]

28577

For a MONOCHROME camera, there is only one color channel. So the noise model coefficients

28578

will only contain one S and one O.

Ruben Brunk

2014-07-23 15:13:16 -0700

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

28583

<th class="th_details" colspan="6">HAL Implementation Details</th>

Ruben Brunk

2014-07-23 15:13:16 -0700

[diff] [blame]

28584

</tr>

28585

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

28586

Ruben Brunk

2014-07-23 15:13:16 -0700

[diff] [blame]

28587

For a CFA layout of RGGB, the list of coefficients would be given as

28588

an array of doubles S0,O0,S1,O1,..., where S0 and O0 are the coefficients

28589

for the red channel, S1 and O1 are the coefficients for the first green

channel, etc.

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

28594

Ruben Brunk

2014-07-23 15:13:16 -0700

[diff] [blame]

28595

28596

28597

Ruben Brunk

2014-02-06 13:04:38 -0800

[diff] [blame]

28598

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

28599

<td class="entry_name

28600

" rowspan="3">

Ruben Brunk

2014-02-06 13:04:38 -0800

[diff] [blame]

28601

android.sensor.profileHueSatMap

</td>

float

x

hue_samples x saturation_samples x value_samples x 3

28609

Zhijun He

d0f482a

2014-05-06 16:18:04 -0700

[diff] [blame]

28610

[system]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

28614

Ruben Brunk

2014-02-06 13:04:38 -0800

[diff] [blame]

28615

<div class="entry_type_notes">Mapping for hue, saturation, and value</div>

28616

28617

28618

</td>

28619

28620

28621

A mapping containing a hue shift, saturation scale, and value scale

for each pixel.

</td>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

28627

The hue shift is given in degrees; saturation and value scale factors are

28628

unitless and are between 0 and 1 inclusive

Ruben Brunk

2014-02-06 13:04:38 -0800

[diff] [blame]

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Ruben Brunk

2014-02-06 13:04:38 -0800

[diff] [blame]

28639

28640

Eino-Ville Talvala

2014-07-15 10:43:01 -0700

[diff] [blame]

28641

Ruben Brunk

2014-02-06 13:04:38 -0800

[diff] [blame]

</ul>

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

28647

<th class="th_details" colspan="6">Details</th>

Ruben Brunk

2014-02-06 13:04:38 -0800

[diff] [blame]

28648

</tr>

28649

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

28650

Ruben Brunk

2014-02-06 13:04:38 -0800

[diff] [blame]

28651

hue_samples, saturation_samples, and value_samples are given in

28652

<a href="#static_android.sensor.profileHueSatMapDimensions">android.sensor.profileHueSatMapDimensions</a>.

28653

Each entry of this map contains three floats corresponding to the

28654

hue shift, saturation scale, and value scale, respectively; where the

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

28655

hue shift has the lowest index. The map entries are stored in the key

Ruben Brunk

2014-02-06 13:04:38 -0800

[diff] [blame]

28656

in nested loop order, with the value divisions in the outer loop, the

28657

hue divisions in the middle loop, and the saturation divisions in the

28658

inner loop. All zero input saturation entries are required to have a

28659

value scale factor of 1.0.

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

28664

Ruben Brunk

2014-02-06 13:04:38 -0800

[diff] [blame]

28665

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

28669

<td class="entry_name

28670

" rowspan="3">

Ruben Brunk

2014-02-06 13:04:38 -0800

[diff] [blame]

28671

android.sensor.profileToneCurve

</td>

float

x

samples x 2

Zhijun He

2014-05-06 16:18:04 -0700

[diff] [blame]

28680

[system]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

28684

Ruben Brunk

2014-02-06 13:04:38 -0800

[diff] [blame]

28685

<div class="entry_type_notes">Samples defining a spline for a tone-mapping curve</div>

28686

28687

28688

</td>

28689

28690

28691

A list of x,y samples defining a tone-mapping curve for gamma adjustment.

</td>

</td>

Each sample has an input range of <code>[0, 1]</code> and an output range of

28699

<code>[0, 1]</code>. The first sample is required to be <code>(0, 0)</code>, and the last

28700

sample is required to be <code>(1, 1)</code>.

28701

</td>

28702

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Ruben Brunk

2014-02-06 13:04:38 -0800

[diff] [blame]

28707

28708

Eino-Ville Talvala

2014-07-15 10:43:01 -0700

[diff] [blame]

28709

Ruben Brunk

2014-02-06 13:04:38 -0800

[diff] [blame]

</ul>

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

28715

<th class="th_details" colspan="6">Details</th>

Ruben Brunk

2014-02-06 13:04:38 -0800

[diff] [blame]

28716

</tr>

28717

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

28718

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

28719

This key contains a default tone curve that can be applied while

Ruben Brunk

2014-02-06 13:04:38 -0800

[diff] [blame]

28720

processing the image as a starting point for user adjustments.

28721

The curve is specified as a list of value pairs in linear gamma.

28722

The curve is interpolated using a cubic spline.

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

28727

Ruben Brunk

2014-02-06 13:04:38 -0800

[diff] [blame]

28728

28729

28730

Ruben Brunk

2014-02-11 17:55:32 -0800

[diff] [blame]

28731

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

28732

<td class="entry_name

28733

" rowspan="5">

Ruben Brunk

2014-02-11 17:55:32 -0800

[diff] [blame]

28734

android.sensor.greenSplit

</td>

float

[public]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

28745

Ruben Brunk

2014-02-11 17:55:32 -0800

[diff] [blame]

28746

</td>

28747

28748

28749

The worst-case divergence between Bayer green channels.

</td>

</td>

>= 0

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Ruben Brunk

2014-02-11 17:55:32 -0800

[diff] [blame]

28763

28764

Eino-Ville Talvala

2014-07-15 10:43:01 -0700

[diff] [blame]

28765

Ruben Brunk

2014-02-11 17:55:32 -0800

[diff] [blame]

</ul>

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

28771

<th class="th_details" colspan="6">Details</th>

Ruben Brunk

2014-02-11 17:55:32 -0800

[diff] [blame]

28772

</tr>

28773

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

28774

Ruben Brunk

2014-02-11 17:55:32 -0800

[diff] [blame]

28775

This value is an estimate of the worst case split between the

28776

Bayer green channels in the red and blue rows in the sensor color

28777

filter array.

28778

The green split is calculated as follows:

28779

<ol>

Ruben Brunk

2014-03-18 14:37:04 -0700

[diff] [blame]

28780

<li>A 5x5 pixel (or larger) window W within the active sensor array is

28781

chosen. The term 'pixel' here is taken to mean a group of 4 Bayer

28782

mosaic channels (R, Gr, Gb, B). The location and size of the window

28783

chosen is implementation defined, and should be chosen to provide a

28784

green split estimate that is both representative of the entire image

28785

for this camera sensor, and can be calculated quickly.</li>

Ruben Brunk

2014-02-11 17:55:32 -0800

[diff] [blame]

28786

<li>The arithmetic mean of the green channels from the red

28787

rows (mean_Gr) within W is computed.</li>

28788

<li>The arithmetic mean of the green channels from the blue

28789

rows (mean_Gb) within W is computed.</li>

28790

<li>The maximum ratio R of the two means is computed as follows:

28791

28792

</ol>

28793

The ratio R is the green split divergence reported for this property,

28794

which represents how much the green channels differ in the mosaic

28795

pattern. This value is typically used to determine the treatment of

28796

the green mosaic channels when demosaicing.

28797

The green split value can be roughly interpreted as follows:

28798

<ul>

28799

28800

<li>1.20 <= R >= 1.03 will require some software

28801

correction to avoid demosaic errors (3-20% divergence).</li>

28802

<li>R > 1.20 will require strong software correction to produce

Shuzhen Wang

2022-05-03 11:01:26 -0700

[diff] [blame]

28803

a usable image (>20% divergence).</li>

Ruben Brunk

2014-02-11 17:55:32 -0800

[diff] [blame]

28804

</ul>

Shuzhen Wang

2018-10-15 12:00:13 -0700

[diff] [blame]

28805

Starting from Android Q, this key will not be present for a MONOCHROME camera, even if

28806

the camera device has RAW capability.

Ruben Brunk

2014-02-11 17:55:32 -0800

[diff] [blame]

</td>

</tr>

Ruben Brunk

2014-03-18 14:37:04 -0700

[diff] [blame]

28810

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

28811

<th class="th_details" colspan="6">HAL Implementation Details</th>

Ruben Brunk

2014-03-18 14:37:04 -0700

[diff] [blame]

28812

</tr>

28813

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

28814

Ruben Brunk

2014-03-18 14:37:04 -0700

[diff] [blame]

28815

The green split given may be a static value based on prior

28816

characterization of the camera sensor using the green split

28817

calculation method given here over a large, representative, sample

28818

set of images. Other methods of calculation that produce equivalent

28819

results, and can be interpreted in the same manner, may be used.

28820

</td>

28821

</tr>

Ruben Brunk

2014-02-11 17:55:32 -0800

[diff] [blame]

28822

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

28823

Ruben Brunk

2014-02-11 17:55:32 -0800

[diff] [blame]

28824

28825

28826

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

28827

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

28828

<td class="entry_name

28829

" rowspan="5">

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

28830

android.sensor.testPatternData

</td>

int32

x

4

[public]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

28845

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

28846

</td>

28847

28848

28849

A pixel <code>[R, G_even, G_odd, B]</code> that supplies the test pattern

28850

when <a href="#controls_android.sensor.testPatternMode">android.sensor.testPatternMode</a> is SOLID_COLOR.

</td>

</td>

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

28857

</td>

28858

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

28868

<th class="th_details" colspan="6">Details</th>

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

28869

</tr>

28870

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

28871

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

28872

Each color channel is treated as an unsigned 32-bit integer.

28873

The camera device then uses the most significant X bits

28874

that correspond to how many bits are in its Bayer raw sensor

28875

output.

28876

For example, a sensor with RAW10 Bayer output would use the

28877

10 most significant bits from each color channel.

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

28882

<th class="th_details" colspan="6">HAL Implementation Details</th>

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

28883

</tr>

28884

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

28885

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

28890

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

28891

28892

28893

Igor Murashkin

2014-01-09 17:43:38 -0800

[diff] [blame]

28894

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

28895

<td class="entry_name

28896

" rowspan="5">

Igor Murashkin

2014-01-09 17:43:38 -0800

[diff] [blame]

28897

android.sensor.testPatternMode

</td>

int32

[public]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

28907

Igor Murashkin

2014-01-09 17:43:38 -0800

[diff] [blame]

28908

28909

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

28910

OFF (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

28911

No test pattern mode is used, and the camera

28912

device returns captures from the image sensor.

28913

This is the default if the key is not set.

Igor Murashkin

2014-01-09 17:43:38 -0800

[diff] [blame]

28914

</li>

28915

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

28916

SOLID_COLOR (v3.2)

Igor Murashkin

2014-01-09 17:43:38 -0800

[diff] [blame]

28917

Each pixel in <code>[R, G_even, G_odd, B]</code> is replaced by its

28918

respective color channel provided in

28919

<a href="#controls_android.sensor.testPatternData">android.sensor.testPatternData</a>.

28920

For example:

Eino-Ville Talvala

2021-05-27 14:43:59 -0700

[diff] [blame]

28921

<pre><code><a href="#controls_android.sensor.testPatternData">android.sensor.testPatternData</a> = [0, 0xFFFFFFFF, 0xFFFFFFFF, 0]

Igor Murashkin

2014-01-09 17:43:38 -0800

[diff] [blame]

28922

</code></pre>

28923

All green pixels are 100% green. All red/blue pixels are black.

Eino-Ville Talvala

2021-05-27 14:43:59 -0700

[diff] [blame]

28924

<pre><code><a href="#controls_android.sensor.testPatternData">android.sensor.testPatternData</a> = [0xFFFFFFFF, 0, 0xFFFFFFFF, 0]

Igor Murashkin

2014-01-09 17:43:38 -0800

[diff] [blame]

28925

</code></pre>

28926

All red pixels are 100% red. Only the odd green pixels

28927

are 100% green. All blue pixels are 100% black.

28928

</li>

28929

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

28930

COLOR_BARS (v3.2)

Igor Murashkin

2014-01-09 17:43:38 -0800

[diff] [blame]

28931

All pixel data is replaced with an 8-bar color pattern.

28932

The vertical bars (left-to-right) are as follows:

<ul>

<li>100% white</li>

<li>yellow</li>

<li>green</li>

<li>magenta</li>

<li>black</li>

</ul>

In general the image would look like the following:

28944

<pre><code>W Y C G M R B K

W Y C G M R B K

W Y C G M R B K

W Y C G M R B K

W Y C G M R B K

. . . . . . . .

. . . . . . . .

. . . . . . . .

(B = Blue, K = Black)

28954

</code></pre>

28955

Each bar should take up 1/8 of the sensor pixel array width.

28956

When this is not possible, the bar size should be rounded

28957

down to the nearest integer and the pattern can repeat

28958

on the right side.

28959

Each bar's height must always take up the full sensor

28960

pixel array height.

28961

Each pixel in this test pattern must be set to either

28962

0% intensity or 100% intensity.

28963

</li>

28964

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

28965

COLOR_BARS_FADE_TO_GRAY (v3.2)

Igor Murashkin

2014-01-09 17:43:38 -0800

[diff] [blame]

28966

The test pattern is similar to COLOR_BARS, except that

28967

each bar should start at its specified color at the top,

28968

and fade to gray at the bottom.

28969

Furthermore each bar is further subdivided into a left and

28970

right half. The left half should have a smooth gradient,

28971

and the right half should have a quantized gradient.

28972

In particular, the right half's should consist of blocks of the

28973

same color for 1/16th active sensor pixel array width.

28974

The least significant bits in the quantized gradient should

28975

be copied from the most significant bits of the smooth gradient.

28976

The height of each bar should always be a multiple of 128.

28977

When this is not the case, the pattern should repeat at the bottom

28978

of the image.

28979

</li>

28980

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

28981

PN9 (v3.2)

Igor Murashkin

2014-01-09 17:43:38 -0800

[diff] [blame]

28982

All pixel data is replaced by a pseudo-random sequence

28983

generated from a PN9 512-bit sequence (typically implemented

28984

in hardware with a linear feedback shift register).

28985

The generator should be reset at the beginning of each frame,

28986

and thus each subsequent raw frame with this test pattern should

28987

be exactly the same as the last.

28988

</li>

28989

<li>

Eino-Ville Talvala

2021-05-27 14:43:59 -0700

[diff] [blame]

28990

BLACK (v3.6)

28991

[test]

28992

All pixel data is replaced by 0% intensity (black) values.

28993

This test pattern is identical to SOLID_COLOR with a value of <code>[0, 0, 0, 0]</code> for

28994

<a href="#controls_android.sensor.testPatternData">android.sensor.testPatternData</a>. It is recommended that devices implement full

28995

SOLID_COLOR support instead, but BLACK can be used to provide minimal support for a

28996

test pattern suitable for privacy use cases.

28997

</li>

28998

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

28999

CUSTOM1 (v3.2)

Igor Murashkin

2014-01-09 17:43:38 -0800

[diff] [blame]

29000

256

29001

The first custom test pattern. All custom patterns that are

29002

available only on this camera device are at least this numeric

29003

value.

29004

All of the custom test patterns will be static

29005

(that is the raw image must not vary from frame to frame).

</li>

</ul>

</td>

29010

29011

29012

When enabled, the sensor sends a test pattern instead of

29013

doing a real exposure from the camera.

</td>

</td>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

29020

<a href="#static_android.sensor.availableTestPatternModes">android.sensor.availableTestPatternModes</a>

Igor Murashkin

2014-01-09 17:43:38 -0800

[diff] [blame]

29021

</td>

29022

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2014-01-09 17:43:38 -0800

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

29032

<th class="th_details" colspan="6">Details</th>

Igor Murashkin

2014-01-09 17:43:38 -0800

[diff] [blame]

29033

</tr>

29034

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

29035

Igor Murashkin

2014-01-09 17:43:38 -0800

[diff] [blame]

29036

When a test pattern is enabled, all manual sensor controls specified

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

29037

by android.sensor.* will be ignored. All other controls should

Igor Murashkin

2014-01-09 17:43:38 -0800

[diff] [blame]

29038

work as normal.

29039

For example, if manual flash is enabled, flash firing should still

29040

occur (and that the test pattern remain unmodified, since the flash

29041

would not actually affect it).

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

29042

Defaults to OFF.

Igor Murashkin

2014-01-09 17:43:38 -0800

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

29047

<th class="th_details" colspan="6">HAL Implementation Details</th>

Igor Murashkin

2014-01-09 17:43:38 -0800

[diff] [blame]

29048

</tr>

29049

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

29050

Igor Murashkin

2014-01-09 17:43:38 -0800

[diff] [blame]

29051

All test patterns are specified in the Bayer domain.

29052

The HAL may choose to substitute test patterns from the sensor

29053

with test patterns from on-device memory. In that case, it should be

29054

indistinguishable to the ISP whether the data came from the

29055

sensor interconnect bus (such as CSI2) or memory.

Shuzhen Wang

e2324d1

2021-10-28 17:27:29 -0700

[diff] [blame]

29056

For privacy use cases, if the camera device:

29057

<ul>

29058

<li>supports SOLID_COLOR or BLACK test patterns,</li>

29059

<li>is a logical multi-camera, and</li>

29060

<li>lists testPatternMode as a physical request key,</li>

29061

</ul>

29062

Each physical camera must support the same SOLID_COLOR and/or BLACK test patterns

29063

as the logical camera.

Igor Murashkin

2014-01-09 17:43:38 -0800

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

29067

Igor Murashkin

2014-01-09 17:43:38 -0800

[diff] [blame]

29068

29069

Zhijun He

2014-06-11 10:44:53 -0700

[diff] [blame]

29070

29071

29072

<td class="entry_name

29073

" rowspan="5">

29074

android.sensor.rollingShutterSkew

</td>

int64

[public]

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

29082

[limited]

29083

Zhijun He

2014-06-11 10:44:53 -0700

[diff] [blame]

</td>

29088

29089

Eino-Ville Talvala

0bde386

2020-05-11 10:23:45 -0700

[diff] [blame]

29090

Duration between the start of exposure for the first row of the image sensor,

29091

and the start of exposure for one past the last row of the image sensor.

Zhijun He

2014-06-11 10:44:53 -0700

[diff] [blame]

</td>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

29095

Nanoseconds

Zhijun He

2014-06-11 10:44:53 -0700

[diff] [blame]

</td>

>= 0 and <

Eino-Ville Talvala

2015-04-16 13:49:52 -0700

[diff] [blame]

29100

<a href="https://developer.android.com/reference/android/hardware/camera2/params/StreamConfigurationMap.html#getOutputMinFrameDuration">StreamConfigurationMap#getOutputMinFrameDuration</a>.

Zhijun He

2014-06-11 10:44:53 -0700

[diff] [blame]

29101

</td>

29102

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Zhijun He

2014-06-11 10:44:53 -0700

[diff] [blame]

</ul>

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

29115

<th class="th_details" colspan="6">Details</th>

Zhijun He

2014-06-11 10:44:53 -0700

[diff] [blame]

29116

</tr>

29117

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

29118

Eino-Ville Talvala

0bde386

2020-05-11 10:23:45 -0700

[diff] [blame]

29119

This is the exposure time skew between the first and <code>(last+1)</code> row exposure start times. The

29120

first row and the last row are the first and last rows inside of the

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

29121

<a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a>.

Eino-Ville Talvala

0bde386

2020-05-11 10:23:45 -0700

[diff] [blame]

29122

For typical camera sensors that use rolling shutters, this is also equivalent to the frame

29123

readout time.

29124

If the image sensor is operating in a binned or cropped mode due to the current output

29125

target resolutions, it's possible this skew is reported to be larger than the exposure

29126

time, for example, since it is based on the full array even if a partial array is read

29127

out. Be sure to scale the number to cover the section of the sensor actually being used

29128

for the outputs you care about. So if your output covers N rows of the active array of

29129

height H, scale this value by N/H to get the total skew for that viewport.

29130

Note: Prior to Android 11, this field was described as measuring duration from

29131

first to last row of the image sensor, which is not equal to the frame readout time for a

29132

rolling shutter sensor. Implementations generally reported the latter value, so to resolve

29133

the inconsistency, the description has been updated to range from (first, last+1) row

29134

exposure start, instead.

Zhijun He

2014-06-11 10:44:53 -0700

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

29139

<th class="th_details" colspan="6">HAL Implementation Details</th>

Zhijun He

2014-06-11 10:44:53 -0700

[diff] [blame]

29140

</tr>

29141

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

29142

Zhijun He

2014-06-11 10:44:53 -0700

[diff] [blame]

29143

The HAL must report <code>0</code> if the sensor is using global shutter, where all pixels begin

29144

exposure at the same time.

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

29148

Zhijun He

2014-06-11 10:44:53 -0700

[diff] [blame]

29149

29150

Zhijun He

2015-11-12 17:27:27 -0800

[diff] [blame]

29151

29152

29153

<td class="entry_name

29154

" rowspan="5">

29155

android.sensor.dynamicBlackLevel

29156

</td>

29157

Zhijun He

88f2ffd

2015-11-24 14:24:52 -0800

[diff] [blame]

29158

float

Zhijun He

2015-11-12 17:27:27 -0800

[diff] [blame]

x

4

Zhijun He

2015-11-24 14:24:52 -0800

[diff] [blame]

29164

[public]

Zhijun He

2015-11-12 17:27:27 -0800

[diff] [blame]

<div class="entry_type_notes">2x2 raw count block</div>

29170

29171

29172

</td>

29173

29174

29175

A per-frame dynamic black level offset for each of the color filter

29176

arrangement (CFA) mosaic channels.

</td>

</td>

>= 0 for each.

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Zhijun He

2015-11-12 17:27:27 -0800

[diff] [blame]

</ul>

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

29198

<th class="th_details" colspan="6">Details</th>

Zhijun He

2015-11-12 17:27:27 -0800

[diff] [blame]

29199

</tr>

29200

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

29201

Zhijun He

2015-11-12 17:27:27 -0800

[diff] [blame]

29202

Camera sensor black levels may vary dramatically for different

29203

capture settings (e.g. <a href="#controls_android.sensor.sensitivity">android.sensor.sensitivity</a>). The fixed black

29204

level reported by <a href="#static_android.sensor.blackLevelPattern">android.sensor.blackLevelPattern</a> may be too

29205

inaccurate to represent the actual value on a per-frame basis. The

29206

camera device internal pipeline relies on reliable black level values

29207

to process the raw images appropriately. To get the best image

29208

quality, the camera device may choose to estimate the per frame black

29209

level values either based on optically shielded black regions

29210

(<a href="#static_android.sensor.opticalBlackRegions">android.sensor.opticalBlackRegions</a>) or its internal model.

29211

This key reports the camera device estimated per-frame zero light

29212

value for each of the CFA mosaic channels in the camera sensor. The

29213

<a href="#static_android.sensor.blackLevelPattern">android.sensor.blackLevelPattern</a> may only represent a coarse

29214

approximation of the actual black level values. This value is the

29215

black level used in camera device internal image processing pipeline

29216

and generally more accurate than the fixed black level values.

29217

However, since they are estimated values by the camera device, they

29218

may not be as accurate as the black level values calculated from the

29219

optical black pixels reported by <a href="#static_android.sensor.opticalBlackRegions">android.sensor.opticalBlackRegions</a>.

29220

The values are given in the same order as channels listed for the CFA

29221

layout key (see <a href="#static_android.sensor.info.colorFilterArrangement">android.sensor.info.colorFilterArrangement</a>), i.e. the

29222

nth value given corresponds to the black level offset for the nth

29223

color channel listed in the CFA.

Shuzhen Wang

2018-10-15 12:00:13 -0700

[diff] [blame]

29224

For a MONOCHROME camera, all of the 2x2 channels must have the same values.

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

29225

This key will be available if <a href="#static_android.sensor.opticalBlackRegions">android.sensor.opticalBlackRegions</a> is available or the

29226

camera device advertises this key via <a href="https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics.html#getAvailableCaptureResultKeys">CameraCharacteristics#getAvailableCaptureResultKeys</a>.

Zhijun He

2015-11-12 17:27:27 -0800

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

29231

<th class="th_details" colspan="6">HAL Implementation Details</th>

Zhijun He

2015-11-12 17:27:27 -0800

[diff] [blame]

29232

</tr>

29233

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

29234

Zhijun He

2015-11-12 17:27:27 -0800

[diff] [blame]

29235

The values are given in row-column scan order, with the first value

29236

corresponding to the element of the CFA in row=0, column=0.

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

29240

Zhijun He

2015-11-12 17:27:27 -0800

[diff] [blame]

29241

<td class="entry_name

29246

" rowspan="5">

29247

android.sensor.dynamicWhiteLevel

</td>

int32

[public]

</td>

29260

29261

29262

Maximum raw value output by sensor for this frame.

</td>

</td>

>= 0

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Zhijun He

2015-11-12 17:27:27 -0800

[diff] [blame]

</ul>

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

29284

<th class="th_details" colspan="6">Details</th>

Zhijun He

2015-11-12 17:27:27 -0800

[diff] [blame]

29285

</tr>

29286

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

29287

Eino-Ville Talvala

1f883d4

2016-04-04 10:47:43 -0700

[diff] [blame]

29288

Since the <a href="#static_android.sensor.blackLevelPattern">android.sensor.blackLevelPattern</a> may change for different

Zhijun He

2015-11-12 17:27:27 -0800

[diff] [blame]

29289

capture settings (e.g., <a href="#controls_android.sensor.sensitivity">android.sensor.sensitivity</a>), the white

29290

level will change accordingly. This key is similar to

29291

<a href="#static_android.sensor.info.whiteLevel">android.sensor.info.whiteLevel</a>, but specifies the camera device

29292

estimated white level for each frame.

29293

This key will be available if <a href="#static_android.sensor.opticalBlackRegions">android.sensor.opticalBlackRegions</a> is

29294

available or the camera device advertises this key via

29295

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics.html#getAvailableCaptureRequestKeys">CameraCharacteristics#getAvailableCaptureRequestKeys</a>.

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

29300

<th class="th_details" colspan="6">HAL Implementation Details</th>

Zhijun He

2015-11-12 17:27:27 -0800

[diff] [blame]

29301

</tr>

29302

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

29303

Zhijun He

2015-11-12 17:27:27 -0800

[diff] [blame]

29304

The full bit depth of the sensor must be available in the raw data,

29305

so the value for linear sensors should not be significantly lower

29306

than maximum raw value supported, i.e. 2^(sensor bits per pixel).

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

29310

Zhijun He

2015-11-12 17:27:27 -0800

[diff] [blame]

29311

29312

Jayant Chowdhary

2020-11-09 09:08:31 -0800

[diff] [blame]

29313

29314

29315

<td class="entry_name

29316

" rowspan="3">

29317

android.sensor.pixelMode

</td>

byte

[public]

<li>

DEFAULT (v3.6)

This is the default sensor pixel mode. This is the only sensor pixel mode

29332

supported unless a camera device advertises

29333

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraMetadata.html#REQUEST_AVAILABLE_CAPABILITIES_ULTRA_HIGH_RESOLUTION_SENSOR">CameraMetadata#REQUEST_AVAILABLE_CAPABILITIES_ULTRA_HIGH_RESOLUTION_SENSOR</a>.

29334

</li>

29335

<li>

29336

MAXIMUM_RESOLUTION (v3.6)

29337

This sensor pixel mode is offered by devices with capability

29338

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraMetadata.html#REQUEST_AVAILABLE_CAPABILITIES_ULTRA_HIGH_RESOLUTION_SENSOR">CameraMetadata#REQUEST_AVAILABLE_CAPABILITIES_ULTRA_HIGH_RESOLUTION_SENSOR</a>.

29339

In this mode, sensors typically do not bin pixels, as a result can offer larger

image sizes.

</li>

</ul>

</td>

29345

29346

29347

Switches sensor pixel mode between maximum resolution mode and default mode.

</td>

</td>

</td>

3.6

</td>

</td>

</tr>

<th class="th_details" colspan="6">Details</th>

</tr>

This key controls whether the camera sensor operates in

29370

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraMetadata.html#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION">CameraMetadata#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION</a>

29371

mode or not. By default, all camera devices operate in

29372

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraMetadata.html#SENSOR_PIXEL_MODE_DEFAULT">CameraMetadata#SENSOR_PIXEL_MODE_DEFAULT</a> mode.

29373

When operating in

29374

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraMetadata.html#SENSOR_PIXEL_MODE_DEFAULT">CameraMetadata#SENSOR_PIXEL_MODE_DEFAULT</a> mode, sensors

29375

with <a href="https://developer.android.com/reference/android/hardware/camera2/CameraMetadata.html#REQUEST_AVAILABLE_CAPABILITIES_ULTRA_HIGH_RESOLUTION_SENSOR">CameraMetadata#REQUEST_AVAILABLE_CAPABILITIES_ULTRA_HIGH_RESOLUTION_SENSOR</a>

29376

capability would typically perform pixel binning in order to improve low light

29377

performance, noise reduction etc. However, in

29378

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraMetadata.html#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION">CameraMetadata#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION</a>

29379

mode (supported only

29380

by <a href="https://developer.android.com/reference/android/hardware/camera2/CameraMetadata.html#REQUEST_AVAILABLE_CAPABILITIES_ULTRA_HIGH_RESOLUTION_SENSOR">CameraMetadata#REQUEST_AVAILABLE_CAPABILITIES_ULTRA_HIGH_RESOLUTION_SENSOR</a>

29381

sensors), sensors typically operate in unbinned mode allowing for a larger image size.

29382

The stream configurations supported in

29383

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraMetadata.html#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION">CameraMetadata#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION</a>

29384

mode are also different from those of

29385

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraMetadata.html#SENSOR_PIXEL_MODE_DEFAULT">CameraMetadata#SENSOR_PIXEL_MODE_DEFAULT</a> mode.

29386

They can be queried through

29387

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics.html#get">CameraCharacteristics#get</a> with

29388

<a href="https://developer.android.com/reference/CameraCharacteristics.html#SCALER_STREAM_CONFIGURATION_MAP_MAXIMUM_RESOLUTION)">CameraCharacteristics#SCALER_STREAM_CONFIGURATION_MAP_MAXIMUM_RESOLUTION)</a>.

29389

Unless reported by both

29390

<a href="https://developer.android.com/reference/android/hardware/camera2/params/StreamConfigurationMap.html">StreamConfigurationMap</a>s, the outputs from

29391

<code><a href="#static_android.scaler.streamConfigurationMapMaximumResolution">android.scaler.streamConfigurationMapMaximumResolution</a></code> and

29392

<code><a href="#static_android.scaler.streamConfigurationMap">android.scaler.streamConfigurationMap</a></code>

29393

must not be mixed in the same CaptureRequest. In other words, these outputs are

29394

exclusive to each other.

29395

This key does not need to be set for reprocess requests.

</td>

</tr>

<td class="entry_name

29406

" rowspan="3">

29407

android.sensor.rawBinningFactorUsed

</td>

byte

[public as boolean]

<li>

TRUE (v3.6)

The <code>RAW</code> targets in this capture have <a href="#static_android.sensor.info.binningFactor">android.sensor.info.binningFactor</a> as the

bayer pattern.

</li>

<li>

FALSE (v3.6)

The <code>RAW</code> targets have a regular bayer pattern in this capture.

</li>

</ul>

</td>

29431

29432

29433

Whether <code>RAW</code> images requested have their bayer pattern as described by

29434

<a href="#static_android.sensor.info.binningFactor">android.sensor.info.binningFactor</a>.

</td>

</td>

</td>

3.6

</td>

</td>

</tr>

<th class="th_details" colspan="6">Details</th>

</tr>

Shuzhen Wang

2022-05-03 11:01:26 -0700

[diff] [blame]

29456

This key will only be present in devices advertising the

Jayant Chowdhary

2020-11-09 09:08:31 -0800

[diff] [blame]

29457

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraMetadata.html#REQUEST_AVAILABLE_CAPABILITIES_ULTRA_HIGH_RESOLUTION_SENSOR">CameraMetadata#REQUEST_AVAILABLE_CAPABILITIES_ULTRA_HIGH_RESOLUTION_SENSOR</a>

29458

capability which also advertise <code>REMOSAIC_REPROCESSING</code> capability. On all other devices

29459

RAW targets will have a regular bayer pattern.

</td>

</tr>

29466

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</tbody>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

29473

<tr><td colspan="7" id="section_shading" class="section">shading</td></tr>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

29474

29475

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

29476

<tr><td colspan="7" class="kind">controls</td></tr>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

29477

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

29478

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

29479

<tr>

29480

<th class="th_name">Property Name</th>

29481

29482

<th class="th_description">Description</th>

29483

<th class="th_units">Units</th>

29484

<th class="th_range">Range</th>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

29485

<th class="th_hal_version">Initial HIDL HAL version</th>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</tr>

</thead>

<tbody>

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

29502

<td class="entry_name

29503

" rowspan="3">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

29504

android.shading.mode

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

29505

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

29506

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

29507

byte

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

29508

Zhijun He

6ba8696

2014-03-03 17:32:30 -0800

[diff] [blame]

29509

[public]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

29510

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

29511

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

29512

[full]

29513

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

29514

29515

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

29516

29517

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

29518

OFF (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

29519

No lens shading correction is applied.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

29520

</li>

29521

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

29522

FAST (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

29523

Apply lens shading corrections, without slowing

29524

frame rate relative to sensor raw output

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

29525

</li>

29526

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

29527

HIGH_QUALITY (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

29528

Apply high-quality lens shading correction, at the

Yin-Chia Yeh

2015-04-02 14:00:40 -0700

[diff] [blame]

29529

cost of possibly reduced frame rate.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</li>

</ul>

</td>

29534

29535

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

29536

Quality of lens shading correction applied

Zhijun He

2014-01-15 10:34:02 -0800

[diff] [blame]

29537

to the image data.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

Yin-Chia Yeh

2015-02-04 10:04:37 -0800

[diff] [blame]

29544

<a href="#static_android.shading.availableModes">android.shading.availableModes</a>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

29545

</td>

29546

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

29554

</tr>

Zhijun He

2014-01-15 10:34:02 -0800

[diff] [blame]

29555

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

29556

<th class="th_details" colspan="6">Details</th>

Zhijun He

2014-01-15 10:34:02 -0800

[diff] [blame]

29557

</tr>

29558

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

29559

Zhijun He

2014-01-15 10:34:02 -0800

[diff] [blame]

29560

When set to OFF mode, no lens shading correction will be applied by the

29561

camera device, and an identity lens shading map data will be provided

29562

if <code><a href="#controls_android.statistics.lensShadingMapMode">android.statistics.lensShadingMapMode</a> == ON</code>. For example, for lens

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

29563

shading map with size of <code>[ 4, 3 ]</code>,

29564

the output <a href="#dynamic_android.statistics.lensShadingCorrectionMap">android.statistics.lensShadingCorrectionMap</a> for this case will be an identity

29565

map shown below:

Zhijun He

2014-01-15 10:34:02 -0800

[diff] [blame]

29566

<pre><code>[ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0,

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

29567

1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0,

29568

1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0,

29569

1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0,

29570

1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0,

29571

1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ]

Zhijun He

2014-01-15 10:34:02 -0800

[diff] [blame]

29572

</code></pre>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

29573

When set to other modes, lens shading correction will be applied by the camera

29574

device. Applications can request lens shading map data by setting

29575

<a href="#controls_android.statistics.lensShadingMapMode">android.statistics.lensShadingMapMode</a> to ON, and then the camera device will provide lens

29576

shading map data in <a href="#dynamic_android.statistics.lensShadingCorrectionMap">android.statistics.lensShadingCorrectionMap</a>; the returned shading map

29577

data will be the one applied by the camera device for this capture request.

29578

The shading map data may depend on the auto-exposure (AE) and AWB statistics, therefore

29579

the reliability of the map data may be affected by the AE and AWB algorithms. When AE and

29580

AWB are in AUTO modes(<a href="#controls_android.control.aeMode">android.control.aeMode</a> <code>!=</code> OFF and <a href="#controls_android.control.awbMode">android.control.awbMode</a> <code>!=</code>

29581

OFF), to get best results, it is recommended that the applications wait for the AE and AWB

29582

to be converged before using the returned shading map data.

Zhijun He

2014-01-15 10:34:02 -0800

[diff] [blame]

29583

</td>

29584

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

29585

29586

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

29587

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

29588

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

29592

<td class="entry_name

29593

" rowspan="1">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

29594

android.shading.strength

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

29595

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

29596

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

29597

byte

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

29598

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

29599

[system]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

29600

29601

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

29605

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

29606

</td>

29607

29608

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

29609

Control the amount of shading correction

29610

applied to the images

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

29614

unitless: 1-10; 10 is full shading

29615

compensation

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

29625

29626

Zhijun He

2014-05-23 11:02:34 -0700

[diff] [blame]

29627

<li><a href="#tag_FUTURE">FUTURE</a></li>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</ul>

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

29631

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

29632

29633

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

29634

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

29635

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</tbody>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

29641

<tr><td colspan="7" class="kind">dynamic</td></tr>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

29642

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

29643

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

29644

<tr>

29645

<th class="th_name">Property Name</th>

29646

29647

<th class="th_description">Description</th>

29648

<th class="th_units">Units</th>

29649

<th class="th_range">Range</th>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

29650

<th class="th_hal_version">Initial HIDL HAL version</th>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</tr>

</thead>

<tbody>

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

29667

<td class="entry_name

29668

" rowspan="3">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

29669

android.shading.mode

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

29670

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

29671

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

29672

byte

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

29673

Zhijun He

6ba8696

2014-03-03 17:32:30 -0800

[diff] [blame]

29674

[public]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

29675

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

29676

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

29677

[full]

29678

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

29679

29680

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

29681

29682

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

29683

OFF (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

29684

No lens shading correction is applied.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

29685

</li>

29686

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

29687

FAST (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

29688

Apply lens shading corrections, without slowing

29689

frame rate relative to sensor raw output

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

29690

</li>

29691

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

29692

HIGH_QUALITY (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

29693

Apply high-quality lens shading correction, at the

Yin-Chia Yeh

2015-04-02 14:00:40 -0700

[diff] [blame]

29694

cost of possibly reduced frame rate.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</li>

</ul>

</td>

29699

29700

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

29701

Quality of lens shading correction applied

Zhijun He

2014-01-15 10:34:02 -0800

[diff] [blame]

29702

to the image data.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

Yin-Chia Yeh

2015-02-04 10:04:37 -0800

[diff] [blame]

29709

<a href="#static_android.shading.availableModes">android.shading.availableModes</a>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

29710

</td>

29711

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

29719

</tr>

Zhijun He

2014-01-15 10:34:02 -0800

[diff] [blame]

29720

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

29721

<th class="th_details" colspan="6">Details</th>

Zhijun He

2014-01-15 10:34:02 -0800

[diff] [blame]

29722

</tr>

29723

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

29724

Zhijun He

2014-01-15 10:34:02 -0800

[diff] [blame]

29725

When set to OFF mode, no lens shading correction will be applied by the

29726

camera device, and an identity lens shading map data will be provided

29727

if <code><a href="#controls_android.statistics.lensShadingMapMode">android.statistics.lensShadingMapMode</a> == ON</code>. For example, for lens

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

29728

shading map with size of <code>[ 4, 3 ]</code>,

29729

the output <a href="#dynamic_android.statistics.lensShadingCorrectionMap">android.statistics.lensShadingCorrectionMap</a> for this case will be an identity

29730

map shown below:

Zhijun He

2014-01-15 10:34:02 -0800

[diff] [blame]

29731

<pre><code>[ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0,

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

29732

1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0,

29733

1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0,

29734

1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0,

29735

1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0,

29736

1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ]

Zhijun He

2014-01-15 10:34:02 -0800

[diff] [blame]

29737

</code></pre>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

29738

When set to other modes, lens shading correction will be applied by the camera

29739

device. Applications can request lens shading map data by setting

29740

<a href="#controls_android.statistics.lensShadingMapMode">android.statistics.lensShadingMapMode</a> to ON, and then the camera device will provide lens

29741

shading map data in <a href="#dynamic_android.statistics.lensShadingCorrectionMap">android.statistics.lensShadingCorrectionMap</a>; the returned shading map

29742

data will be the one applied by the camera device for this capture request.

29743

The shading map data may depend on the auto-exposure (AE) and AWB statistics, therefore

29744

the reliability of the map data may be affected by the AE and AWB algorithms. When AE and

29745

AWB are in AUTO modes(<a href="#controls_android.control.aeMode">android.control.aeMode</a> <code>!=</code> OFF and <a href="#controls_android.control.awbMode">android.control.awbMode</a> <code>!=</code>

29746

OFF), to get best results, it is recommended that the applications wait for the AE and AWB

29747

to be converged before using the returned shading map data.

Zhijun He

2014-01-15 10:34:02 -0800

[diff] [blame]

29748

</td>

29749

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

29750

29751

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

29752

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

29753

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</tbody>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

29759

<tr><td colspan="7" class="kind">static</td></tr>

Yin-Chia Yeh

2015-02-04 10:04:37 -0800

[diff] [blame]

<tr>

<th class="th_name">Property Name</th>

29764

29765

<th class="th_description">Description</th>

29766

<th class="th_units">Units</th>

29767

<th class="th_range">Range</th>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

29768

<th class="th_hal_version">Initial HIDL HAL version</th>

Yin-Chia Yeh

2015-02-04 10:04:37 -0800

[diff] [blame]

</tr>

</thead>

<tbody>

<td class="entry_name

Yin-Chia Yeh

2015-04-02 14:00:40 -0700

[diff] [blame]

29786

" rowspan="5">

Yin-Chia Yeh

2015-02-04 10:04:37 -0800

[diff] [blame]

29787

android.shading.availableModes

</td>

byte

x

n

[public as enumList]

[legacy]

<div class="entry_type_notes">List of enums (android.shading.mode).</div>

29803

29804

29805

</td>

29806

29807

29808

List of lens shading modes for <a href="#controls_android.shading.mode">android.shading.mode</a> that are supported by this camera device.

</td>

</td>

Any value listed in <a href="#controls_android.shading.mode">android.shading.mode</a>

29816

</td>

29817

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Yin-Chia Yeh

2015-02-04 10:04:37 -0800

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

29827

<th class="th_details" colspan="6">Details</th>

Yin-Chia Yeh

2015-02-04 10:04:37 -0800

[diff] [blame]

29828

</tr>

29829

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

29830

Yin-Chia Yeh

2015-02-04 10:04:37 -0800

[diff] [blame]

29831

This list contains lens shading modes that can be set for the camera device.

29832

Camera devices that support the MANUAL_POST_PROCESSING capability will always

29833

list OFF and FAST mode. This includes all FULL level devices.

29834

LEGACY devices will always only support FAST mode.

</td>

</tr>

Yin-Chia Yeh

2015-04-02 14:00:40 -0700

[diff] [blame]

29838

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

29839

<th class="th_details" colspan="6">HAL Implementation Details</th>

Yin-Chia Yeh

2015-04-02 14:00:40 -0700

[diff] [blame]

29840

</tr>

29841

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

29842

Yin-Chia Yeh

2015-04-02 14:00:40 -0700

[diff] [blame]

29843

HAL must support both FAST and HIGH_QUALITY if lens shading correction control is

29844

available on the camera device, but the underlying implementation can be the same for

29845

both modes. That is, if the highest quality implementation on the camera device does not

29846

slow down capture rate, then FAST and HIGH_QUALITY will generate the same output.

29847

</td>

29848

</tr>

Yin-Chia Yeh

2015-02-04 10:04:37 -0800

[diff] [blame]

29849

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

29850

Yin-Chia Yeh

2015-02-04 10:04:37 -0800

[diff] [blame]

29851

</tbody>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

29857

29858

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

29859

<tr><td colspan="7" id="section_statistics" class="section">statistics</td></tr>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

29860

29861

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

29862

<tr><td colspan="7" class="kind">controls</td></tr>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

29863

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

29864

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

29865

<tr>

29866

<th class="th_name">Property Name</th>

29867

29868

<th class="th_description">Description</th>

29869

<th class="th_units">Units</th>

29870

<th class="th_range">Range</th>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

29871

<th class="th_hal_version">Initial HIDL HAL version</th>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</tr>

</thead>

<tbody>

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

29888

<td class="entry_name

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

29889

" rowspan="5">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

29890

android.statistics.faceDetectMode

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

29891

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

29892

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

29893

byte

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

29894

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

29895

[public]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

29896

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

29897

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

29898

[legacy]

29899

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

29900

29901

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

29902

29903

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

29904

OFF (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

29905

Do not include face detection statistics in capture

29906

results.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

29907

</li>

29908

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

29909

SIMPLE (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

29910

[optional]

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

29911

Return face rectangle and confidence values only.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

29912

</li>

29913

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

29914

FULL (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

29915

[optional]

29916

Return all face

29917

metadata.

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

29918

In this mode, face rectangles, scores, landmarks, and face IDs are all valid.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</li>

</ul>

</td>

29923

29924

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

29925

Operating mode for the face detector

Eino-Ville Talvala

2014-06-06 14:35:41 -0700

[diff] [blame]

29926

unit.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

Eino-Ville Talvala

2014-01-02 16:11:44 -0800

[diff] [blame]

29933

<a href="#static_android.statistics.info.availableFaceDetectModes">android.statistics.info.availableFaceDetectModes</a>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

29934

</td>

29935

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

29940

29941

Igor Murashkin

2012-12-05 14:49:11 -0800

[diff] [blame]

29942

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</ul>

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

29946

</tr>

29947

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

29948

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

29949

</tr>

29950

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

29951

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

29952

Whether face detection is enabled, and whether it

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

29953

should output just the basic fields or the full set of

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

29954

fields.

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

29955

</td>

29956

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

29957

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

29958

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

29959

<th class="th_details" colspan="6">HAL Implementation Details</th>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

29960

</tr>

29961

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

29962

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

29963

SIMPLE mode must fill in <a href="#dynamic_android.statistics.faceRectangles">android.statistics.faceRectangles</a> and

29964

<a href="#dynamic_android.statistics.faceScores">android.statistics.faceScores</a>.

29965

FULL mode must also fill in <a href="#dynamic_android.statistics.faceIds">android.statistics.faceIds</a>, and

29966

<a href="#dynamic_android.statistics.faceLandmarks">android.statistics.faceLandmarks</a>.

29967

</td>

29968

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

29969

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

29970

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

29971

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

29975

<td class="entry_name

29976

" rowspan="1">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

29977

android.statistics.histogramMode

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

29978

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

29979

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

29980

byte

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

29981

Igor Murashkin

2013-07-17 16:29:34 -0700

[diff] [blame]

29982

[system as boolean]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

29983

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

29987

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

29988

29989

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

29990

OFF (v3.2)

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

29991

</li>

29992

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

29993

ON (v3.2)

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</li>

</ul>

</td>

29998

29999

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

30000

Operating mode for histogram

30001

generation

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

30014

30015

Zhijun He

2014-05-23 11:02:34 -0700

[diff] [blame]

30016

<li><a href="#tag_FUTURE">FUTURE</a></li>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</ul>

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

30020

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

30021

30022

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

30023

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

30024

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

30028

<td class="entry_name

30029

" rowspan="1">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

30030

android.statistics.sharpnessMapMode

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

30031

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

30032

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

30033

byte

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

30034

Igor Murashkin

2013-07-17 16:29:34 -0700

[diff] [blame]

30035

[system as boolean]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

30036

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

30040

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

30041

30042

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

30043

OFF (v3.2)

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

30044

</li>

30045

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

30046

ON (v3.2)

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</li>

</ul>

</td>

30051

30052

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

30053

Operating mode for sharpness map

30054

generation

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

30067

30068

Zhijun He

2014-05-23 11:02:34 -0700

[diff] [blame]

30069

<li><a href="#tag_FUTURE">FUTURE</a></li>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</ul>

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

30073

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

30074

30075

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

30076

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

30077

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

30078

Zhijun He

2013-07-17 09:42:58 -0700

[diff] [blame]

30079

Ruben Brunk

2014-03-04 14:09:44 -0800

[diff] [blame]

30080

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

30081

<td class="entry_name

30082

" rowspan="3">

Ruben Brunk

2014-03-04 14:09:44 -0800

[diff] [blame]

30083

android.statistics.hotPixelMapMode

</td>

byte

[public as boolean]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

30093

Ruben Brunk

2014-03-04 14:09:44 -0800

[diff] [blame]

30094

30095

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

30096

OFF (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

30097

Hot pixel map production is disabled.

Ruben Brunk

2014-03-04 14:09:44 -0800

[diff] [blame]

30098

</li>

30099

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

30100

ON (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

30101

Hot pixel map production is enabled.

Ruben Brunk

2014-03-04 14:09:44 -0800

[diff] [blame]

</li>

</ul>

</td>

30106

30107

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

30108

Operating mode for hot pixel map generation.

Ruben Brunk

2014-03-04 14:09:44 -0800

[diff] [blame]

</td>

</td>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

30115

<a href="#static_android.statistics.info.availableHotPixelMapModes">android.statistics.info.availableHotPixelMapModes</a>

Ruben Brunk

2014-03-04 14:09:44 -0800

[diff] [blame]

30116

</td>

30117

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Ruben Brunk

2014-03-04 14:09:44 -0800

[diff] [blame]

Eino-Ville Talvala

2014-07-15 10:43:01 -0700

[diff] [blame]

30125

Ruben Brunk

2014-03-04 14:09:44 -0800

[diff] [blame]

</ul>

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

30131

<th class="th_details" colspan="6">Details</th>

Ruben Brunk

2014-03-04 14:09:44 -0800

[diff] [blame]

30132

</tr>

30133

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

30134

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

30135

If set to <code>true</code>, a hot pixel map is returned in <a href="#dynamic_android.statistics.hotPixelMap">android.statistics.hotPixelMap</a>.

30136

If set to <code>false</code>, no hot pixel map will be returned.

Ruben Brunk

2014-03-04 14:09:44 -0800

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

30141

Ruben Brunk

2014-03-04 14:09:44 -0800

[diff] [blame]

30142

30143

30144

Zhijun He

2013-07-17 09:42:58 -0700

[diff] [blame]

30145

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

30146

<td class="entry_name

30147

" rowspan="3">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

30148

android.statistics.lensShadingMapMode

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

30149

</td>

Zhijun He

2013-07-17 09:42:58 -0700

[diff] [blame]

byte

[public]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

30155

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

30156

[full]

30157

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

30158

30159

Zhijun He

2013-07-17 09:42:58 -0700

[diff] [blame]

30160

30161

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

30162

OFF (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

30163

Do not include a lens shading map in the capture result.

Zhijun He

2013-07-17 09:42:58 -0700

[diff] [blame]

30164

</li>

30165

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

30166

ON (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

30167

Include a lens shading map in the capture result.

Zhijun He

2013-07-17 09:42:58 -0700

[diff] [blame]

</li>

</ul>

</td>

30172

30173

Zhijun He

2014-02-24 09:49:37 -0800

[diff] [blame]

30174

Whether the camera device will output the lens

30175

shading map in output result metadata.

Zhijun He

2013-07-17 09:42:58 -0700

[diff] [blame]

</td>

</td>

Yin-Chia Yeh

2015-02-04 10:04:37 -0800

[diff] [blame]

30182

<a href="#static_android.statistics.info.availableLensShadingMapModes">android.statistics.info.availableLensShadingMapModes</a>

Zhijun He

2013-07-17 09:42:58 -0700

[diff] [blame]

30183

</td>

30184

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

30189

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

30190

30191

30192

</ul>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

30197

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

30198

</tr>

30199

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

30200

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

30201

When set to ON,

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

30202

<a href="#dynamic_android.statistics.lensShadingMap">android.statistics.lensShadingMap</a> will be provided in

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

30203

the output result metadata.

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

30204

ON is always supported on devices with the RAW capability.

Zhijun He

2013-07-17 09:42:58 -0700

[diff] [blame]

30205

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

30206

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

30207

30208

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

30209

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

30210

Zhijun He

2013-07-17 09:42:58 -0700

[diff] [blame]

30211

Chien-Yu Chen

2018-01-12 17:38:00 -0800

[diff] [blame]

30212

30213

30214

<td class="entry_name

Eino-Ville Talvala

2018-08-01 15:26:26 -0700

[diff] [blame]

30215

" rowspan="3">

Chien-Yu Chen

2018-01-12 17:38:00 -0800

[diff] [blame]

30216

android.statistics.oisDataMode

</td>

byte

[public]

<li>

OFF (v3.3)

Do not include OIS data in the capture result.

</li>

<li>

ON (v3.3)

Include OIS data in the capture result.

</li>

</ul>

</td>

30239

30240

Eino-Ville Talvala

2018-08-01 15:26:26 -0700

[diff] [blame]

30241

A control for selecting whether optical stabilization (OIS) position

30242

information is included in output result metadata.

Chien-Yu Chen

2018-01-12 17:38:00 -0800

[diff] [blame]

</td>

</td>

Eino-Ville Talvala

2018-03-13 19:10:23 -0700

[diff] [blame]

30249

<a href="#static_android.statistics.info.availableOisDataModes">android.statistics.info.availableOisDataModes</a>

Chien-Yu Chen

2018-01-12 17:38:00 -0800

[diff] [blame]

</td>

3.3

</td>

</td>

</tr>

Eino-Ville Talvala

2018-08-01 15:26:26 -0700

[diff] [blame]

30260

30261

<th class="th_details" colspan="6">Details</th>

</tr>

Since optical image stabilization generally involves motion much faster than the duration

Shuzhen Wang

1373ab5

2021-03-17 11:00:23 -0700

[diff] [blame]

30266

of individual image exposure, multiple OIS samples can be included for a single capture

Eino-Ville Talvala

2018-08-01 15:26:26 -0700

[diff] [blame]

30267

result. For example, if the OIS reporting operates at 200 Hz, a typical camera operating

30268

at 30fps may have 6-7 OIS samples per capture result. This information can be combined

30269

with the rolling shutter skew to account for lens motion during image exposure in

30270

post-processing algorithms.

30271

</td>

30272

</tr>

Chien-Yu Chen

2018-01-12 17:38:00 -0800

[diff] [blame]

30277

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</tbody>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

30282

<tr><td colspan="7" class="kind">static</td></tr>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

30283

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

30284

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

30285

<tr>

30286

<th class="th_name">Property Name</th>

30287

30288

<th class="th_description">Description</th>

30289

<th class="th_units">Units</th>

30290

<th class="th_range">Range</th>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

30291

<th class="th_hal_version">Initial HIDL HAL version</th>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</tr>

</thead>

<tbody>

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

30310

<td class="entry_name

30311

" rowspan="3">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

30312

android.statistics.info.availableFaceDetectModes

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

30313

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

30314

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

30315

byte

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

x

n

Eino-Ville Talvala

2014-05-27 10:50:30 -0700

[diff] [blame]

30321

[public as enumList]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

30322

30323

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

30324

[legacy]

30325

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

30326

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

30327

<div class="entry_type_notes">List of enums from android.statistics.faceDetectMode</div>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

30328

30329

30330

</td>

30331

30332

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

30333

List of face detection modes for <a href="#controls_android.statistics.faceDetectMode">android.statistics.faceDetectMode</a> that are

30334

supported by this camera device.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

30341

Any value listed in <a href="#controls_android.statistics.faceDetectMode">android.statistics.faceDetectMode</a>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

30342

</td>

30343

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

30353

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

30354

</tr>

30355

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

30356

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

30357

OFF is always supported.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

30358

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

30359

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

30360

30361

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

30362

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

30363

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

30367

<td class="entry_name

30368

" rowspan="1">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

30369

android.statistics.info.histogramBucketCount

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

30370

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

30371

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

30372

int32

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

30373

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

30374

[system]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

30375

30376

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

30380

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

30381

</td>

30382

30383

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

30384

Number of histogram buckets

30385

supported

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

Igor Murashkin

2014-01-10 15:12:40 -0800

[diff] [blame]

30392

>= 64

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

30393

</td>

30394

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

30399

Zhijun He

2014-05-23 11:02:34 -0700

[diff] [blame]

30400

30401

<li><a href="#tag_FUTURE">FUTURE</a></li>

30402

</ul>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

30403

</td>

30404

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

30405

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

30406

30407

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

30408

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

30409

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

30413

<td class="entry_name

30414

" rowspan="1">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

30415

android.statistics.info.maxFaceCount

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

30416

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

30417

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

30418

int32

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

30419

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

30420

[public]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

30421

30422

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

30423

[legacy]

30424

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

30428

</td>

30429

30430

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

30431

The maximum number of simultaneously detectable

30432

faces.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

30439

0 for cameras without available face detection; otherwise:

30440

<code>>=4</code> for LIMITED or FULL hwlevel devices or

30441

<code>>0</code> for LEGACY devices.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

30442

</td>

30443

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

30448

Zhijun He

2014-05-23 11:02:34 -0700

[diff] [blame]

30449

30450

30451

</ul>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

30452

</td>

30453

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

30454

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

30455

30456

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

30457

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

30458

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

30462

<td class="entry_name

30463

" rowspan="1">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

30464

android.statistics.info.maxHistogramCount

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

30465

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

30466

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

30467

int32

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

30468

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

30469

[system]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

30470

30471

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

30475

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

30476

</td>

30477

30478

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

30479

Maximum value possible for a histogram

30480

bucket

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

30493

Zhijun He

2014-05-23 11:02:34 -0700

[diff] [blame]

30494

30495

<li><a href="#tag_FUTURE">FUTURE</a></li>

30496

</ul>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

30497

</td>

30498

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

30499

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

30500

30501

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

30502

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

30503

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

30507

<td class="entry_name

30508

" rowspan="1">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

30509

android.statistics.info.maxSharpnessMapValue

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

30510

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

30511

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

30512

int32

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

30513

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

30514

[system]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

30515

30516

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

30520

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

30521

</td>

30522

30523

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

30524

Maximum value possible for a sharpness map

30525

region.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

30538

Zhijun He

2014-05-23 11:02:34 -0700

[diff] [blame]

30539

30540

<li><a href="#tag_FUTURE">FUTURE</a></li>

30541

</ul>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

30542

</td>

30543

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

30544

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

30545

30546

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

30547

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

30548

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

30552

<td class="entry_name

30553

" rowspan="1">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

30554

android.statistics.info.sharpnessMapSize

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

30555

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

30556

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

30557

int32

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

x

2

Igor Murashkin

2013-07-17 16:29:34 -0700

[diff] [blame]

30563

[system as size]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

30567

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

30568

<div class="entry_type_notes">width x height</div>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

30569

30570

30571

</td>

30572

30573

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

30574

Dimensions of the sharpness

30575

map

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

Eino-Ville Talvala

2014-01-02 16:11:44 -0800

[diff] [blame]

30582

Must be at least 32 x 32

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

30583

</td>

30584

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

30589

Zhijun He

2014-05-23 11:02:34 -0700

[diff] [blame]

30590

30591

<li><a href="#tag_FUTURE">FUTURE</a></li>

30592

</ul>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

30593

</td>

30594

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

30595

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

30596

30597

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

30598

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

30599

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

30600

Ruben Brunk

2014-03-04 14:09:44 -0800

[diff] [blame]

30601

30602

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

30603

<td class="entry_name

30604

" rowspan="3">

Ruben Brunk

2014-03-04 14:09:44 -0800

[diff] [blame]

30605

android.statistics.info.availableHotPixelMapModes

</td>

byte

x

n

[public as boolean]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

30618

Ruben Brunk

2014-03-04 14:09:44 -0800

[diff] [blame]

30619

<div class="entry_type_notes">list of enums</div>

30620

30621

30622

</td>

30623

30624

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

30625

List of hot pixel map output modes for <a href="#controls_android.statistics.hotPixelMapMode">android.statistics.hotPixelMapMode</a> that are

30626

supported by this camera device.

Ruben Brunk

2014-03-04 14:09:44 -0800

[diff] [blame]

</td>

</td>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

30633

Any value listed in <a href="#controls_android.statistics.hotPixelMapMode">android.statistics.hotPixelMapMode</a>

Ruben Brunk

2014-03-04 14:09:44 -0800

[diff] [blame]

30634

</td>

30635

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Ruben Brunk

2014-03-04 14:09:44 -0800

[diff] [blame]

Eino-Ville Talvala

2014-07-15 10:43:01 -0700

[diff] [blame]

30643

Ruben Brunk

2014-03-04 14:09:44 -0800

[diff] [blame]

</ul>

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

30649

<th class="th_details" colspan="6">Details</th>

Ruben Brunk

2014-03-04 14:09:44 -0800

[diff] [blame]

30650

</tr>

30651

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

30652

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

30653

If no hotpixel map output is available for this camera device, this will contain only

30654

<code>false</code>.

30655

ON is always supported on devices with the RAW capability.

Ruben Brunk

2014-03-04 14:09:44 -0800

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

30660

Ruben Brunk

2014-03-04 14:09:44 -0800

[diff] [blame]

30661

30662

Yin-Chia Yeh

2015-02-04 10:04:37 -0800

[diff] [blame]

30663

30664

30665

<td class="entry_name

30666

" rowspan="3">

30667

android.statistics.info.availableLensShadingMapModes

</td>

byte

x

n

Yin-Chia Yeh

2015-05-22 16:36:25 -0700

[diff] [blame]

30676

[public as enumList]

Yin-Chia Yeh

2015-02-04 10:04:37 -0800

[diff] [blame]

<div class="entry_type_notes">list of enums</div>

30682

30683

30684

</td>

30685

30686

30687

List of lens shading map output modes for <a href="#controls_android.statistics.lensShadingMapMode">android.statistics.lensShadingMapMode</a> that

30688

are supported by this camera device.

</td>

</td>

Any value listed in <a href="#controls_android.statistics.lensShadingMapMode">android.statistics.lensShadingMapMode</a>

30696

</td>

30697

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Yin-Chia Yeh

2015-02-04 10:04:37 -0800

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

30707

<th class="th_details" colspan="6">Details</th>

Yin-Chia Yeh

2015-02-04 10:04:37 -0800

[diff] [blame]

30708

</tr>

30709

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

30710

Yin-Chia Yeh

2015-02-04 10:04:37 -0800

[diff] [blame]

30711

If no lens shading map output is available for this camera device, this key will

30712

contain only OFF.

30713

ON is always supported on devices with the RAW capability.

30714

LEGACY mode devices will always only support OFF.

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

30719

Yin-Chia Yeh

2015-02-04 10:04:37 -0800

[diff] [blame]

30720

30721

Chien-Yu Chen

2018-01-12 17:38:00 -0800

[diff] [blame]

30722

30723

30724

<td class="entry_name

30725

" rowspan="3">

30726

android.statistics.info.availableOisDataModes

</td>

byte

x

n

[public as enumList]

<div class="entry_type_notes">list of enums</div>

30741

30742

30743

</td>

30744

30745

30746

List of OIS data output modes for <a href="#controls_android.statistics.oisDataMode">android.statistics.oisDataMode</a> that

30747

are supported by this camera device.

</td>

</td>

Any value listed in <a href="#controls_android.statistics.oisDataMode">android.statistics.oisDataMode</a>

</td>

3.3

</td>

</td>

</tr>

<th class="th_details" colspan="6">Details</th>

</tr>

If no OIS data output is available for this camera device, this key will

contain only OFF.

</td>

</tr>

30778

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</tbody>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

30786

<tr><td colspan="7" class="kind">dynamic</td></tr>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

30787

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

30788

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

30789

<tr>

30790

<th class="th_name">Property Name</th>

30791

30792

<th class="th_description">Description</th>

30793

<th class="th_units">Units</th>

30794

<th class="th_range">Range</th>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

30795

<th class="th_hal_version">Initial HIDL HAL version</th>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</tr>

</thead>

<tbody>

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

30812

<td class="entry_name

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

30813

" rowspan="5">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

30814

android.statistics.faceDetectMode

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

30815

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

30816

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

30817

byte

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

30818

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

30819

[public]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

30820

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

30821

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

30822

[legacy]

30823

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

30824

30825

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

30826

30827

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

30828

OFF (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

30829

Do not include face detection statistics in capture

30830

results.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

30831

</li>

30832

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

30833

SIMPLE (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

30834

[optional]

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

30835

Return face rectangle and confidence values only.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

30836

</li>

30837

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

30838

FULL (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

30839

[optional]

30840

Return all face

30841

metadata.

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

30842

In this mode, face rectangles, scores, landmarks, and face IDs are all valid.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</li>

</ul>

</td>

30847

30848

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

30849

Operating mode for the face detector

Eino-Ville Talvala

2014-06-06 14:35:41 -0700

[diff] [blame]

30850

unit.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

Eino-Ville Talvala

2014-01-02 16:11:44 -0800

[diff] [blame]

30857

<a href="#static_android.statistics.info.availableFaceDetectModes">android.statistics.info.availableFaceDetectModes</a>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

30858

</td>

30859

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

30864

Igor Murashkin

2012-12-05 14:49:11 -0800

[diff] [blame]

30865

30866

30867

</ul>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

30868

</td>

30869

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

30870

</tr>

30871

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

30872

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

30873

</tr>

30874

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

30875

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

30876

Whether face detection is enabled, and whether it

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

30877

should output just the basic fields or the full set of

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

30878

fields.

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

30879

</td>

30880

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

30881

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

30882

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

30883

<th class="th_details" colspan="6">HAL Implementation Details</th>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

30884

</tr>

30885

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

30886

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

30887

SIMPLE mode must fill in <a href="#dynamic_android.statistics.faceRectangles">android.statistics.faceRectangles</a> and

30888

<a href="#dynamic_android.statistics.faceScores">android.statistics.faceScores</a>.

30889

FULL mode must also fill in <a href="#dynamic_android.statistics.faceIds">android.statistics.faceIds</a>, and

30890

<a href="#dynamic_android.statistics.faceLandmarks">android.statistics.faceLandmarks</a>.

30891

</td>

30892

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

30893

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

30894

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

30895

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

30899

<td class="entry_name

30900

" rowspan="3">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

30901

android.statistics.faceIds

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

30902

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

30903

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

30904

int32

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

x

n

Yin-Chia Yeh

2016-04-02 16:30:30 -0700

[diff] [blame]

30910

[ndk_public]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

30911

30912

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

30913

[legacy]

30914

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

30918

</td>

30919

30920

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

30921

List of unique IDs for detected faces.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

30934

30935

Igor Murashkin

2012-12-05 14:49:11 -0800

[diff] [blame]

30936

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</ul>

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

30940

</tr>

30941

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

30942

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

30943

</tr>

30944

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

30945

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

30946

Each detected face is given a unique ID that is valid for as long as the face is visible

30947

to the camera device. A face that leaves the field of view and later returns may be

30948

assigned a new ID.

30949

Only available if <a href="#controls_android.statistics.faceDetectMode">android.statistics.faceDetectMode</a> == FULL

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

30950

</td>

30951

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

30952

30953

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

30954

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

30955

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

30959

<td class="entry_name

Yin-Chia Yeh

2018-06-15 15:35:05 -0700

[diff] [blame]

30960

" rowspan="5">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

30961

android.statistics.faceLandmarks

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

30962

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

30963

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

30964

int32

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

x

n x 6

Yin-Chia Yeh

2016-04-02 16:30:30 -0700

[diff] [blame]

30970

[ndk_public]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

30971

30972

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

30973

[legacy]

30974

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

30975

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

30976

<div class="entry_type_notes">(leftEyeX, leftEyeY, rightEyeX, rightEyeY, mouthX, mouthY)</div>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

30977

30978

30979

</td>

30980

30981

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

30982

List of landmarks for detected

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

30983

faces.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

30996

30997

Igor Murashkin

2012-12-05 14:49:11 -0800

[diff] [blame]

30998

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</ul>

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

31002

</tr>

31003

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

31004

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

31005

</tr>

31006

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

31007

Yin-Chia Yeh

2018-06-15 15:35:05 -0700

[diff] [blame]

31008

For devices not supporting <a href="#controls_android.distortionCorrection.mode">android.distortionCorrection.mode</a> control, the coordinate

31009

system always follows that of <a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a>, with <code>(0, 0)</code> being

31010

the top-left pixel of the active array.

31011

For devices supporting <a href="#controls_android.distortionCorrection.mode">android.distortionCorrection.mode</a> control, the coordinate

31012

system depends on the mode being set.

31013

When the distortion correction mode is OFF, the coordinate system follows

31014

<a href="#static_android.sensor.info.preCorrectionActiveArraySize">android.sensor.info.preCorrectionActiveArraySize</a>, with

31015

<code>(0, 0)</code> being the top-left pixel of the pre-correction active array.

31016

When the distortion correction mode is not OFF, the coordinate system follows

31017

<a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a>, with

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

31018

<code>(0, 0)</code> being the top-left pixel of the active array.

Shuzhen Wang

2019-11-07 15:59:22 -0800

[diff] [blame]

31019

Only available if <a href="#controls_android.statistics.faceDetectMode">android.statistics.faceDetectMode</a> == FULL.

31020

Starting from API level 30, the coordinate system of activeArraySize or

31021

preCorrectionActiveArraySize is used to represent post-zoomRatio field of view, not

31022

pre-zoomRatio field of view. This means that if the relative position of faces and

31023

the camera device doesn't change, when zooming in by increasing

31024

<a href="#controls_android.control.zoomRatio">android.control.zoomRatio</a>, the face landmarks move farther away from the center of the

31025

activeArray or preCorrectionActiveArray. If <a href="#controls_android.control.zoomRatio">android.control.zoomRatio</a> is set to 1.0

31026

(default), the face landmarks coordinates won't change as <a href="#controls_android.scaler.cropRegion">android.scaler.cropRegion</a>

31027

changes. See <a href="#controls_android.control.zoomRatio">android.control.zoomRatio</a> for details. Whether to use activeArraySize or

31028

preCorrectionActiveArraySize still depends on distortion correction mode.

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

31029

</td>

31030

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

31031

Yin-Chia Yeh

2018-06-15 15:35:05 -0700

[diff] [blame]

31032

31033

<th class="th_details" colspan="6">HAL Implementation Details</th>

</tr>

HAL must always report face landmarks in the coordinate system of pre-correction

31038

active array.

31039

</td>

31040

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

31041

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

31042

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

31043

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

31047

<td class="entry_name

Yin-Chia Yeh

2018-06-15 15:35:05 -0700

[diff] [blame]

31048

" rowspan="5">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

31049

android.statistics.faceRectangles

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

31050

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

31051

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

31052

int32

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

x

n x 4

Yin-Chia Yeh

2016-04-02 16:30:30 -0700

[diff] [blame]

31058

[ndk_public as rectangle]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

31059

31060

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

31061

[legacy]

31062

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

31063

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

31064

<div class="entry_type_notes">(xmin, ymin, xmax, ymax). (0,0) is top-left of active pixel area</div>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

31065

31066

31067

</td>

31068

31069

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

31070

List of the bounding rectangles for detected

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

31071

faces.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

31084

31085

Igor Murashkin

2012-12-05 14:49:11 -0800

[diff] [blame]

31086

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</ul>

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

31090

</tr>

31091

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

31092

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

31093

</tr>

31094

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

31095

Yin-Chia Yeh

2018-06-15 15:35:05 -0700

[diff] [blame]

31096

For devices not supporting <a href="#controls_android.distortionCorrection.mode">android.distortionCorrection.mode</a> control, the coordinate

31097

system always follows that of <a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a>, with <code>(0, 0)</code> being

31098

the top-left pixel of the active array.

31099

For devices supporting <a href="#controls_android.distortionCorrection.mode">android.distortionCorrection.mode</a> control, the coordinate

31100

system depends on the mode being set.

31101

When the distortion correction mode is OFF, the coordinate system follows

31102

<a href="#static_android.sensor.info.preCorrectionActiveArraySize">android.sensor.info.preCorrectionActiveArraySize</a>, with

31103

<code>(0, 0)</code> being the top-left pixel of the pre-correction active array.

31104

When the distortion correction mode is not OFF, the coordinate system follows

31105

<a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a>, with

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

31106

<code>(0, 0)</code> being the top-left pixel of the active array.

Shuzhen Wang

2019-11-07 15:59:22 -0800

[diff] [blame]

31107

Only available if <a href="#controls_android.statistics.faceDetectMode">android.statistics.faceDetectMode</a> != OFF.

31108

Starting from API level 30, the coordinate system of activeArraySize or

31109

preCorrectionActiveArraySize is used to represent post-zoomRatio field of view, not

31110

pre-zoomRatio field of view. This means that if the relative position of faces and

31111

the camera device doesn't change, when zooming in by increasing

31112

<a href="#controls_android.control.zoomRatio">android.control.zoomRatio</a>, the face rectangles grow larger and move farther away from

31113

the center of the activeArray or preCorrectionActiveArray. If <a href="#controls_android.control.zoomRatio">android.control.zoomRatio</a>

31114

is set to 1.0 (default), the face rectangles won't change as <a href="#controls_android.scaler.cropRegion">android.scaler.cropRegion</a>

31115

changes. See <a href="#controls_android.control.zoomRatio">android.control.zoomRatio</a> for details. Whether to use activeArraySize or

31116

preCorrectionActiveArraySize still depends on distortion correction mode.

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

31117

</td>

31118

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

31119

Yin-Chia Yeh

2018-06-15 15:35:05 -0700

[diff] [blame]

31120

31121

<th class="th_details" colspan="6">HAL Implementation Details</th>

</tr>

HAL must always report face rectangles in the coordinate system of pre-correction

31126

active array.

31127

</td>

31128

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

31129

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

31130

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

31131

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

31135

<td class="entry_name

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

31136

" rowspan="5">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

31137

android.statistics.faceScores

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

31138

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

31139

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

31140

byte

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

x

n

Yin-Chia Yeh

2016-04-02 16:30:30 -0700

[diff] [blame]

31146

[ndk_public]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

31147

31148

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

31149

[legacy]

31150

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

31154

</td>

31155

31156

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

31157

List of the face confidence scores for

31158

detected faces

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

Eino-Ville Talvala

2014-01-02 16:11:44 -0800

[diff] [blame]

31165

1-100

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

31166

</td>

31167

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

31172

31173

Igor Murashkin

2012-12-05 14:49:11 -0800

[diff] [blame]

31174

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</ul>

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

31178

</tr>

31179

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

31180

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

31181

</tr>

31182

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

31183

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

31184

Only available if <a href="#controls_android.statistics.faceDetectMode">android.statistics.faceDetectMode</a> != OFF.

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

31185

</td>

31186

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

31187

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

31188

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

31189

<th class="th_details" colspan="6">HAL Implementation Details</th>

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

31190

</tr>

31191

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

31192

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

31193

The value should be meaningful (for example, setting 100 at

31194

all times is illegal).

31195

</td>

31196

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

31197

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

31198

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

31199

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

31200

31201

Igor Murashkin

2014-05-14 17:30:49 -0700

[diff] [blame]

31202

31203

<td class="entry_name

31204

" rowspan="3">

31205

android.statistics.faces

</td>

int32

x

n

Yin-Chia Yeh

2016-04-02 16:30:30 -0700

[diff] [blame]

31214

[java_public as face]

Igor Murashkin

2014-05-14 17:30:49 -0700

[diff] [blame]

[synthetic]

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

31218

[legacy]

31219

Igor Murashkin

2014-05-14 17:30:49 -0700

[diff] [blame]

</td>

31224

31225

31226

List of the faces detected through camera face detection

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

31227

in this capture.

Igor Murashkin

2014-05-14 17:30:49 -0700

[diff] [blame]

</td>

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2014-05-14 17:30:49 -0700

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

31245

<th class="th_details" colspan="6">Details</th>

Igor Murashkin

2014-05-14 17:30:49 -0700

[diff] [blame]

31246

</tr>

31247

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

31248

Igor Murashkin

2014-05-14 17:30:49 -0700

[diff] [blame]

31249

Only available if <a href="#controls_android.statistics.faceDetectMode">android.statistics.faceDetectMode</a> <code>!=</code> OFF.

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

31254

Igor Murashkin

2014-05-14 17:30:49 -0700

[diff] [blame]

31255

31256

31257

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

31258

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

31259

<td class="entry_name

31260

" rowspan="3">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

31261

android.statistics.histogram

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

31262

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

31263

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

31264

int32

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

x

n x 3

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

31270

[system]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

31274

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

31275

<div class="entry_type_notes">count of pixels for each color channel that fall into each histogram bucket, scaled to be between 0 and maxHistogramCount</div>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

31276

31277

31278

</td>

31279

31280

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

31281

A 3-channel histogram based on the raw

31282

sensor data

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

31295

31296

Zhijun He

2014-05-23 11:02:34 -0700

[diff] [blame]

31297

<li><a href="#tag_FUTURE">FUTURE</a></li>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</ul>

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

31301

</tr>

31302

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

31303

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

31304

</tr>

31305

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

31306

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

31307

The k'th bucket (0-based) covers the input range

Eino-Ville Talvala

2014-01-02 16:11:44 -0800

[diff] [blame]

31308

(with w = <a href="#static_android.sensor.info.whiteLevel">android.sensor.info.whiteLevel</a>) of [ k * w/N,

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

31309

(k + 1) * w / N ). If only a monochrome sharpness map is

31310

supported, all channels should have the same data

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

31311

</td>

31312

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

31313

31314

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

31315

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

31316

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

31320

<td class="entry_name

31321

" rowspan="1">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

31322

android.statistics.histogramMode

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

31323

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

31324

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

31325

byte

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

31326

Igor Murashkin

2013-07-17 16:29:34 -0700

[diff] [blame]

31327

[system as boolean]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

31328

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

31332

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

31333

31334

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

31335

OFF (v3.2)

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

31336

</li>

31337

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

31338

ON (v3.2)

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</li>

</ul>

</td>

31343

31344

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

31345

Operating mode for histogram

31346

generation

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

31359

Igor Murashkin

2012-12-05 14:49:11 -0800

[diff] [blame]

31360

Zhijun He

2014-05-23 11:02:34 -0700

[diff] [blame]

31361

<li><a href="#tag_FUTURE">FUTURE</a></li>

Igor Murashkin

2012-12-05 14:49:11 -0800

[diff] [blame]

31362

</ul>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

31363

</td>

31364

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

31365

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

31366

31367

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

31368

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

31369

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

31373

<td class="entry_name

31374

" rowspan="3">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

31375

android.statistics.sharpnessMap

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

31376

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

31377

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

31378

int32

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

x

n x m x 3

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

31384

[system]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

31388

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

31389

<div class="entry_type_notes">estimated sharpness for each region of the input image. Normalized to be between 0 and maxSharpnessMapValue. Higher values mean sharper (better focused)</div>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

31390

31391

31392

</td>

31393

31394

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

31395

A 3-channel sharpness map, based on the raw

31396

sensor data

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

31409

31410

Zhijun He

2014-05-23 11:02:34 -0700

[diff] [blame]

31411

<li><a href="#tag_FUTURE">FUTURE</a></li>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</ul>

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

31415

</tr>

31416

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

31417

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

31418

</tr>

31419

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

31420

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

31421

If only a monochrome sharpness map is supported,

31422

all channels should have the same data

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

31423

</td>

31424

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

31425

31426

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

31427

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

31428

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

31432

<td class="entry_name

31433

" rowspan="1">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

31434

android.statistics.sharpnessMapMode

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

31435

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

31436

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

31437

byte

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

31438

Igor Murashkin

2013-07-17 16:29:34 -0700

[diff] [blame]

31439

[system as boolean]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

31440

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

31444

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

31445

31446

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

31447

OFF (v3.2)

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

31448

</li>

31449

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

31450

ON (v3.2)

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</li>

</ul>

</td>

31455

31456

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

31457

Operating mode for sharpness map

31458

generation

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

31471

Igor Murashkin

2012-12-05 14:49:11 -0800

[diff] [blame]

31472

Zhijun He

2014-05-23 11:02:34 -0700

[diff] [blame]

31473

<li><a href="#tag_FUTURE">FUTURE</a></li>

Igor Murashkin

2012-12-05 14:49:11 -0800

[diff] [blame]

31474

</ul>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

31475

</td>

31476

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

31477

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

31478

31479

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

31480

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

31481

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

31482

Zhijun He

2013-07-17 09:42:58 -0700

[diff] [blame]

31483

Ruben Brunk

2014-05-27 18:52:49 -0700

[diff] [blame]

31484

31485

<td class="entry_name

31486

" rowspan="3">

31487

android.statistics.lensShadingCorrectionMap

</td>

byte

Eino-Ville Talvala

2016-06-02 14:15:56 -0700

[diff] [blame]

31492

[java_public as lensShadingMap]

Ruben Brunk

2014-05-27 18:52:49 -0700

[diff] [blame]

31493

31494

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

31495

[full]

31496

Ruben Brunk

2014-05-27 18:52:49 -0700

[diff] [blame]

</td>

31501

31502

31503

The shading map is a low-resolution floating-point map

31504

that lists the coefficients used to correct for vignetting, for each

Bayer color channel.

</td>

</td>

Each gain factor is >= 1

31513

</td>

31514

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Ruben Brunk

2014-05-27 18:52:49 -0700

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

31524

<th class="th_details" colspan="6">Details</th>

Ruben Brunk

2014-05-27 18:52:49 -0700

[diff] [blame]

31525

</tr>

31526

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

31527

Eino-Ville Talvala

2016-06-02 14:15:56 -0700

[diff] [blame]

31528

The map provided here is the same map that is used by the camera device to

31529

correct both color shading and vignetting for output non-RAW images.

31530

When there is no lens shading correction applied to RAW

31531

output images (<a href="#static_android.sensor.info.lensShadingApplied">android.sensor.info.lensShadingApplied</a> <code>==</code>

31532

false), this map is the complete lens shading correction

31533

map; when there is some lens shading correction applied to

31534

the RAW output image (<a href="#static_android.sensor.info.lensShadingApplied">android.sensor.info.lensShadingApplied</a><code>==</code> true), this map reports the remaining lens shading

31535

correction map that needs to be applied to get shading

31536

corrected images that match the camera device's output for

31537

non-RAW formats.

31538

For a complete shading correction map, the least shaded

31539

section of the image will have a gain factor of 1; all

31540

other sections will have gains above 1.

Ruben Brunk

2014-05-27 18:52:49 -0700

[diff] [blame]

31541

When <a href="#controls_android.colorCorrection.mode">android.colorCorrection.mode</a> = TRANSFORM_MATRIX, the map

Eino-Ville Talvala

2016-06-02 14:15:56 -0700

[diff] [blame]

31542

will take into account the colorCorrection settings.

Ruben Brunk

2014-05-27 18:52:49 -0700

[diff] [blame]

31543

The shading map is for the entire active pixel array, and is not

31544

affected by the crop region specified in the request. Each shading map

31545

entry is the value of the shading compensation map over a specific

31546

pixel on the sensor. Specifically, with a (N x M) resolution shading

31547

map, and an active pixel array size (W x H), shading map entry

31548

(x,y) ϵ (0 ... N-1, 0 ... M-1) is the value of the shading map at

31549

pixel ( ((W-1)/(N-1)) * x, ((H-1)/(M-1)) * y) for the four color channels.

31550

The map is assumed to be bilinearly interpolated between the sample points.

31551

The channel order is [R, Geven, Godd, B], where Geven is the green

31552

channel for the even rows of a Bayer pattern, and Godd is the odd rows.

31553

The shading map is stored in a fully interleaved format.

Eino-Ville Talvala

2016-06-02 14:15:56 -0700

[diff] [blame]

31554

The shading map will generally have on the order of 30-40 rows and columns,

31555

and will be smaller than 64x64.

Ruben Brunk

2014-05-27 18:52:49 -0700

[diff] [blame]

31556

As an example, given a very small map defined as:

31557

<pre><code>width,height = [ 4, 3 ]

31558

values =

31559

[ 1.3, 1.2, 1.15, 1.2, 1.2, 1.2, 1.15, 1.2,

31560

1.1, 1.2, 1.2, 1.2, 1.3, 1.2, 1.3, 1.3,

31561

1.2, 1.2, 1.25, 1.1, 1.1, 1.1, 1.1, 1.0,

31562

1.0, 1.0, 1.0, 1.0, 1.2, 1.3, 1.25, 1.2,

31563

1.3, 1.2, 1.2, 1.3, 1.2, 1.15, 1.1, 1.2,

31564

1.2, 1.1, 1.0, 1.2, 1.3, 1.15, 1.2, 1.3 ]

31565

</code></pre>

31566

The low-resolution scaling map images for each channel are

31567

(displayed using nearest-neighbor interpolation):

As a visualization only, inverting the full-color map to recover an

31573

image of a gray wall (using bicubic interpolation for visual quality) as captured by the sensor gives:

31574

Shuzhen Wang

2018-10-15 12:00:13 -0700

[diff] [blame]

31575

For a MONOCHROME camera, all of the 2x2 channels must have the same values. An example

31576

shading map for such a camera is defined as:

31577

<pre><code><a href="#static_android.lens.info.shadingMapSize">android.lens.info.shadingMapSize</a> = [ 4, 3 ]

31578

<a href="#dynamic_android.statistics.lensShadingMap">android.statistics.lensShadingMap</a> =

31579

[ 1.3, 1.3, 1.3, 1.3, 1.2, 1.2, 1.2, 1.2,

31580

1.1, 1.1, 1.1, 1.1, 1.3, 1.3, 1.3, 1.3,

31581

1.2, 1.2, 1.2, 1.2, 1.1, 1.1, 1.1, 1.1,

31582

1.0, 1.0, 1.0, 1.0, 1.2, 1.2, 1.2, 1.2,

31583

1.3, 1.3, 1.3, 1.3, 1.2, 1.2, 1.2, 1.2,

31584

1.2, 1.2, 1.2, 1.2, 1.3, 1.3, 1.3, 1.3 ]

31585

</code></pre>

Ruben Brunk

2014-05-27 18:52:49 -0700

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

31590

Ruben Brunk

2014-05-27 18:52:49 -0700

[diff] [blame]

31591

31592

31593

Zhijun He

2013-07-17 09:42:58 -0700

[diff] [blame]

31594

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

31595

<td class="entry_name

Zhijun He

2014-05-20 18:22:18 -0700

[diff] [blame]

31596

" rowspan="5">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

31597

android.statistics.lensShadingMap

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

31598

</td>

Zhijun He

2013-07-17 09:42:58 -0700

[diff] [blame]

float

x

4 x n x m

Yin-Chia Yeh

2016-04-02 16:30:30 -0700

[diff] [blame]

31606

[ndk_public]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

31607

31608

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

31609

[full]

31610

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

31611

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

31612

<div class="entry_type_notes">2D array of float gain factors per channel to correct lens shading</div>

Zhijun He

2013-07-17 09:42:58 -0700

[diff] [blame]

31613

31614

31615

</td>

31616

31617

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

31618

The shading map is a low-resolution floating-point map

Zhijun He

5f92cff

2016-04-12 23:08:17 -0700

[diff] [blame]

31619

that lists the coefficients used to correct for vignetting and color shading,

31620

for each Bayer color channel of RAW image data.

Zhijun He

2013-07-17 09:42:58 -0700

[diff] [blame]

</td>

</td>

Eino-Ville Talvala

2014-01-02 16:11:44 -0800

[diff] [blame]

31627

Each gain factor is >= 1

Zhijun He

2013-07-17 09:42:58 -0700

[diff] [blame]

31628

</td>

31629

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

31639

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

31640

</tr>

31641

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

31642

Eino-Ville Talvala

2016-06-02 14:15:56 -0700

[diff] [blame]

31643

The map provided here is the same map that is used by the camera device to

31644

correct both color shading and vignetting for output non-RAW images.

31645

When there is no lens shading correction applied to RAW

31646

output images (<a href="#static_android.sensor.info.lensShadingApplied">android.sensor.info.lensShadingApplied</a> <code>==</code>

31647

false), this map is the complete lens shading correction

31648

map; when there is some lens shading correction applied to

31649

the RAW output image (<a href="#static_android.sensor.info.lensShadingApplied">android.sensor.info.lensShadingApplied</a><code>==</code> true), this map reports the remaining lens shading

31650

correction map that needs to be applied to get shading

31651

corrected images that match the camera device's output for

31652

non-RAW formats.

31653

For a complete shading correction map, the least shaded

31654

section of the image will have a gain factor of 1; all

31655

other sections will have gains above 1.

Eino-Ville Talvala

2014-01-02 16:11:44 -0800

[diff] [blame]

31656

When <a href="#controls_android.colorCorrection.mode">android.colorCorrection.mode</a> = TRANSFORM_MATRIX, the map

Eino-Ville Talvala

2016-06-02 14:15:56 -0700

[diff] [blame]

31657

will take into account the colorCorrection settings.

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

31658

The shading map is for the entire active pixel array, and is not

31659

affected by the crop region specified in the request. Each shading map

Igor Murashkin

1dd4ecb

2013-12-11 13:31:00 -0800

[diff] [blame]

31660

entry is the value of the shading compensation map over a specific

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

31661

pixel on the sensor. Specifically, with a (N x M) resolution shading

31662

map, and an active pixel array size (W x H), shading map entry

31663

(x,y) ϵ (0 ... N-1, 0 ... M-1) is the value of the shading map at

31664

pixel ( ((W-1)/(N-1)) * x, ((H-1)/(M-1)) * y) for the four color channels.

31665

The map is assumed to be bilinearly interpolated between the sample points.

Shuzhen Wang

2018-10-15 12:00:13 -0700

[diff] [blame]

31666

For a Bayer camera, the channel order is [R, Geven, Godd, B], where Geven is

31667

the green channel for the even rows of a Bayer pattern, and Godd is the odd rows.

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

31668

The shading map is stored in a fully interleaved format, and its size

Eino-Ville Talvala

2014-01-02 16:11:44 -0800

[diff] [blame]

31669

is provided in the camera static metadata by <a href="#static_android.lens.info.shadingMapSize">android.lens.info.shadingMapSize</a>.

Eino-Ville Talvala

2016-06-02 14:15:56 -0700

[diff] [blame]

31670

The shading map will generally have on the order of 30-40 rows and columns,

31671

and will be smaller than 64x64.

Shuzhen Wang

2018-10-15 12:00:13 -0700

[diff] [blame]

31672

As an example, given a very small map for a Bayer camera defined as:

Eino-Ville Talvala

2014-01-02 16:11:44 -0800

[diff] [blame]

31673

<pre><code><a href="#static_android.lens.info.shadingMapSize">android.lens.info.shadingMapSize</a> = [ 4, 3 ]

31674

<a href="#dynamic_android.statistics.lensShadingMap">android.statistics.lensShadingMap</a> =

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

31675

[ 1.3, 1.2, 1.15, 1.2, 1.2, 1.2, 1.15, 1.2,

31676

1.1, 1.2, 1.2, 1.2, 1.3, 1.2, 1.3, 1.3,

31677

1.2, 1.2, 1.25, 1.1, 1.1, 1.1, 1.1, 1.0,

31678

1.0, 1.0, 1.0, 1.0, 1.2, 1.3, 1.25, 1.2,

31679

1.3, 1.2, 1.2, 1.3, 1.2, 1.15, 1.1, 1.2,

31680

1.2, 1.1, 1.0, 1.2, 1.3, 1.15, 1.2, 1.3 ]

Igor Murashkin

1dd4ecb

2013-12-11 13:31:00 -0800

[diff] [blame]

31681

</code></pre>

31682

The low-resolution scaling map images for each channel are

31683

(displayed using nearest-neighbor interpolation):

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

31688

As a visualization only, inverting the full-color map to recover an

Yin-Chia Yeh

2015-02-04 10:04:37 -0800

[diff] [blame]

31689

image of a gray wall (using bicubic interpolation for visual quality)

31690

as captured by the sensor gives:

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

31691

Shuzhen Wang

2018-10-15 12:00:13 -0700

[diff] [blame]

31692

For a MONOCHROME camera, all of the 2x2 channels must have the same values. An example

31693

shading map for such a camera is defined as:

31694

<pre><code><a href="#static_android.lens.info.shadingMapSize">android.lens.info.shadingMapSize</a> = [ 4, 3 ]

31695

<a href="#dynamic_android.statistics.lensShadingMap">android.statistics.lensShadingMap</a> =

31696

[ 1.3, 1.3, 1.3, 1.3, 1.2, 1.2, 1.2, 1.2,

31697

1.1, 1.1, 1.1, 1.1, 1.3, 1.3, 1.3, 1.3,

31698

1.2, 1.2, 1.2, 1.2, 1.1, 1.1, 1.1, 1.1,

31699

1.0, 1.0, 1.0, 1.0, 1.2, 1.2, 1.2, 1.2,

31700

1.3, 1.3, 1.3, 1.3, 1.2, 1.2, 1.2, 1.2,

31701

1.2, 1.2, 1.2, 1.2, 1.3, 1.3, 1.3, 1.3 ]

31702

</code></pre>

Yin-Chia Yeh

2015-02-04 10:04:37 -0800

[diff] [blame]

31703

Note that the RAW image data might be subject to lens shading

31704

correction not reported on this map. Query

31705

<a href="#static_android.sensor.info.lensShadingApplied">android.sensor.info.lensShadingApplied</a> to see if RAW image data has subject

31706

to lens shading correction. If <a href="#static_android.sensor.info.lensShadingApplied">android.sensor.info.lensShadingApplied</a>

31707

is TRUE, the RAW image data is subject to partial or full lens shading

31708

correction. In the case full lens shading correction is applied to RAW

31709

images, the gain factor map reported in this key will contain all 1.0 gains.

31710

In other words, the map reported in this key is the remaining lens shading

31711

that needs to be applied on the RAW image to get images without lens shading

31712

artifacts. See <a href="#static_android.request.maxNumOutputRaw">android.request.maxNumOutputRaw</a> for a list of RAW image

31713

formats.

Zhijun He

2013-07-17 09:42:58 -0700

[diff] [blame]

31714

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

31715

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

31716

Zhijun He

2014-05-20 18:22:18 -0700

[diff] [blame]

31717

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

31718

<th class="th_details" colspan="6">HAL Implementation Details</th>

Zhijun He

2014-05-20 18:22:18 -0700

[diff] [blame]

31719

</tr>

31720

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

31721

Zhijun He

2014-05-20 18:22:18 -0700

[diff] [blame]

31722

The lens shading map calculation may depend on exposure and white balance statistics.

31723

When AE and AWB are in AUTO modes

31724

(<a href="#controls_android.control.aeMode">android.control.aeMode</a> <code>!=</code> OFF and <a href="#controls_android.control.awbMode">android.control.awbMode</a> <code>!=</code> OFF), the HAL

31725

may have all the information it need to generate most accurate lens shading map. When

31726

AE or AWB are in manual mode

31727

(<a href="#controls_android.control.aeMode">android.control.aeMode</a> <code>==</code> OFF or <a href="#controls_android.control.awbMode">android.control.awbMode</a> <code>==</code> OFF), the shading map

31728

may be adversely impacted by manual exposure or white balance parameters. To avoid

31729

generating unreliable shading map data, the HAL may choose to lock the shading map with

31730

the latest known good map generated when the AE and AWB are in AUTO modes.

31731

</td>

31732

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

31733

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

31734

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

31735

Zhijun He

2013-07-17 09:42:58 -0700

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

31739

<td class="entry_name

31740

entry_name_deprecated

31741

" rowspan="3">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

31742

android.statistics.predictedColorGains

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

31743

</td>

Zhijun He

2013-07-17 09:42:58 -0700

[diff] [blame]

float

x

4

Igor Murashkin

2014-01-13 16:59:47 -0800

[diff] [blame]

31751

[hidden]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

31752

31753

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

31754

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

31755

[deprecated]

31756

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

31757

<div class="entry_type_notes">A 1D array of floats for 4 color channel gains</div>

Zhijun He

2013-07-17 09:42:58 -0700

[diff] [blame]

31758

31759

31760

</td>

31761

31762

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

31763

The best-fit color channel gains calculated

Zhijun He

2014-02-24 09:49:37 -0800

[diff] [blame]

31764

by the camera device's statistics units for the current output frame.

Zhijun He

2013-07-17 09:42:58 -0700

[diff] [blame]

</td>

</td>

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

31771

Deprecated. Do not use.

Zhijun He

2013-07-17 09:42:58 -0700

[diff] [blame]

31772

</td>

31773

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

31783

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

31784

</tr>

31785

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

31786

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

31787

This may be different than the gains used for this frame,

Igor Murashkin

2013-12-09 12:06:17 -0800

[diff] [blame]

31788

since statistics processing on data from a new frame

31789

typically completes after the transform has already been

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

31790

applied to that frame.

31791

The 4 channel gains are defined in Bayer domain,

Eino-Ville Talvala

2014-01-02 16:11:44 -0800

[diff] [blame]

31792

see <a href="#controls_android.colorCorrection.gains">android.colorCorrection.gains</a> for details.

Eino-Ville Talvala

2014-06-06 14:35:41 -0700

[diff] [blame]

31793

This value should always be calculated by the auto-white balance (AWB) block,

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

31794

regardless of the android.control.* current values.

Zhijun He

2013-07-17 09:42:58 -0700

[diff] [blame]

31795

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

31796

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

31797

31798

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

31799

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

31800

Zhijun He

2013-07-17 09:42:58 -0700

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

31804

<td class="entry_name

31805

entry_name_deprecated

31806

" rowspan="3">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

31807

android.statistics.predictedColorTransform

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

31808

</td>

Zhijun He

2013-07-17 09:42:58 -0700

[diff] [blame]

rational

x

3 x 3

Igor Murashkin

2014-01-13 16:59:47 -0800

[diff] [blame]

31816

[hidden]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

31817

31818

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

31819

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

31820

[deprecated]

31821

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

31822

<div class="entry_type_notes">3x3 rational matrix in row-major order</div>

Zhijun He

2013-07-17 09:42:58 -0700

[diff] [blame]

31823

31824

31825

</td>

31826

31827

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

31828

The best-fit color transform matrix estimate

Zhijun He

2014-02-24 09:49:37 -0800

[diff] [blame]

31829

calculated by the camera device's statistics units for the current

31830

output frame.

Zhijun He

2013-07-17 09:42:58 -0700

[diff] [blame]

</td>

</td>

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

31837

Deprecated. Do not use.

Zhijun He

2013-07-17 09:42:58 -0700

[diff] [blame]

31838

</td>

31839

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

31849

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

31850

</tr>

31851

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

31852

Zhijun He

2014-02-24 09:49:37 -0800

[diff] [blame]

31853

The camera device will provide the estimate from its

Igor Murashkin

2013-12-09 12:06:17 -0800

[diff] [blame]

31854

statistics unit on the white balance transforms to use

Zhijun He

2014-02-24 09:49:37 -0800

[diff] [blame]

31855

for the next frame. These are the values the camera device believes

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

31856

are the best fit for the current output frame. This may

31857

be different than the transform used for this frame, since

Igor Murashkin

2013-12-09 12:06:17 -0800

[diff] [blame]

31858

statistics processing on data from a new frame typically

31859

completes after the transform has already been applied to

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

31860

that frame.

31861

These estimates must be provided for all frames, even if

31862

capture settings and color transforms are set by the application.

Eino-Ville Talvala

2014-06-06 14:35:41 -0700

[diff] [blame]

31863

This value should always be calculated by the auto-white balance (AWB) block,

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

31864

regardless of the android.control.* current values.

Zhijun He

2013-07-17 09:42:58 -0700

[diff] [blame]

31865

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

31866

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

31867

31868

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

31869

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

31870

Zhijun He

2013-07-17 09:42:58 -0700

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

31874

<td class="entry_name

31875

" rowspan="3">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

31876

android.statistics.sceneFlicker

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

31877

</td>

Zhijun He

2013-07-17 09:42:58 -0700

[diff] [blame]

byte

[public]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

31883

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

31884

[full]

31885

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

31886

31887

Zhijun He

2013-07-17 09:42:58 -0700

[diff] [blame]

31888

31889

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

31890

NONE (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

31891

The camera device does not detect any flickering illumination

31892

in the current scene.

Zhijun He

2013-07-17 09:42:58 -0700

[diff] [blame]

31893

</li>

31894

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

31895

50HZ (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

31896

The camera device detects illumination flickering at 50Hz

31897

in the current scene.

Zhijun He

2013-07-17 09:42:58 -0700

[diff] [blame]

31898

</li>

31899

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

31900

60HZ (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

31901

The camera device detects illumination flickering at 60Hz

31902

in the current scene.

Zhijun He

2013-07-17 09:42:58 -0700

[diff] [blame]

</li>

</ul>

</td>

31907

31908

Zhijun He

b8512c5

2014-02-03 11:46:58 -0800

[diff] [blame]

31909

The camera device estimated scene illumination lighting

31910

frequency.

Zhijun He

2013-07-17 09:42:58 -0700

[diff] [blame]

</td>

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Zhijun He

2013-07-17 09:42:58 -0700

[diff] [blame]

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

31926

</tr>

31927

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

31928

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

31929

</tr>

31930

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

31931

Zhijun He

b8512c5

2014-02-03 11:46:58 -0800

[diff] [blame]

31932

Many light sources, such as most fluorescent lights, flicker at a rate

31933

that depends on the local utility power standards. This flicker must be

31934

accounted for by auto-exposure routines to avoid artifacts in captured images.

31935

The camera device uses this entry to tell the application what the scene

31936

illuminant frequency is.

31937

When manual exposure control is enabled

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

31938

(<code><a href="#controls_android.control.aeMode">android.control.aeMode</a> == OFF</code> or <code><a href="#controls_android.control.mode">android.control.mode</a> ==

31939

OFF</code>), the <a href="#controls_android.control.aeAntibandingMode">android.control.aeAntibandingMode</a> doesn't perform

31940

antibanding, and the application can ensure it selects

31941

exposure times that do not cause banding issues by looking

31942

into this metadata field. See

31943

<a href="#controls_android.control.aeAntibandingMode">android.control.aeAntibandingMode</a> for more details.

31944

Reports NONE if there doesn't appear to be flickering illumination.

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

31945

</td>

31946

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

31947

31948

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

31949

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

31950

Zhijun He

2013-07-17 09:42:58 -0700

[diff] [blame]

31951

Ruben Brunk

2014-03-04 14:09:44 -0800

[diff] [blame]

31952

31953

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

31954

<td class="entry_name

31955

" rowspan="3">

Ruben Brunk

2014-03-04 14:09:44 -0800

[diff] [blame]

31956

android.statistics.hotPixelMapMode

</td>

byte

[public as boolean]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

31966

Ruben Brunk

2014-03-04 14:09:44 -0800

[diff] [blame]

31967

31968

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

31969

OFF (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

31970

Hot pixel map production is disabled.

Ruben Brunk

2014-03-04 14:09:44 -0800

[diff] [blame]

31971

</li>

31972

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

31973

ON (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

31974

Hot pixel map production is enabled.

Ruben Brunk

2014-03-04 14:09:44 -0800

[diff] [blame]

</li>

</ul>

</td>

31979

31980

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

31981

Operating mode for hot pixel map generation.

Ruben Brunk

2014-03-04 14:09:44 -0800

[diff] [blame]

</td>

</td>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

31988

<a href="#static_android.statistics.info.availableHotPixelMapModes">android.statistics.info.availableHotPixelMapModes</a>

Ruben Brunk

2014-03-04 14:09:44 -0800

[diff] [blame]

31989

</td>

31990

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Ruben Brunk

2014-03-04 14:09:44 -0800

[diff] [blame]

Eino-Ville Talvala

2014-07-15 10:43:01 -0700

[diff] [blame]

31998

Ruben Brunk

2014-03-04 14:09:44 -0800

[diff] [blame]

</ul>

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

32004

<th class="th_details" colspan="6">Details</th>

Ruben Brunk

2014-03-04 14:09:44 -0800

[diff] [blame]

32005

</tr>

32006

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

32007

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

32008

If set to <code>true</code>, a hot pixel map is returned in <a href="#dynamic_android.statistics.hotPixelMap">android.statistics.hotPixelMap</a>.

32009

If set to <code>false</code>, no hot pixel map will be returned.

Ruben Brunk

2014-03-04 14:09:44 -0800

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

32014

Ruben Brunk

2014-03-04 14:09:44 -0800

[diff] [blame]

32015

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

32019

<td class="entry_name

32020

" rowspan="5">

Ruben Brunk

2014-03-04 14:09:44 -0800

[diff] [blame]

32021

android.statistics.hotPixelMap

</td>

int32

x

2 x n

Yin-Chia Yeh

2014-05-27 09:48:07 -0700

[diff] [blame]

32030

[public as point]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

32034

Ruben Brunk

2014-03-04 14:09:44 -0800

[diff] [blame]

32035

<div class="entry_type_notes">list of coordinates based on android.sensor.pixelArraySize</div>

32036

32037

32038

</td>

32039

32040

32041

List of <code>(x, y)</code> coordinates of hot/defective pixels on the sensor.

</td>

</td>

n <= number of pixels on the sensor.

32049

The <code>(x, y)</code> coordinates must be bounded by

32050

<a href="#static_android.sensor.info.pixelArraySize">android.sensor.info.pixelArraySize</a>.

32051

</td>

32052

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Ruben Brunk

2014-03-04 14:09:44 -0800

[diff] [blame]

Eino-Ville Talvala

2014-07-15 10:43:01 -0700

[diff] [blame]

32060

Ruben Brunk

2014-03-04 14:09:44 -0800

[diff] [blame]

</ul>

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

32066

<th class="th_details" colspan="6">Details</th>

Ruben Brunk

2014-03-04 14:09:44 -0800

[diff] [blame]

32067

</tr>

32068

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

32069

Ruben Brunk

2014-03-04 14:09:44 -0800

[diff] [blame]

32070

A coordinate <code>(x, y)</code> must lie between <code>(0, 0)</code>, and

32071

<code>(width - 1, height - 1)</code> (inclusive), which are the top-left and

32072

bottom-right of the pixel array, respectively. The width and

32073

height dimensions are given in <a href="#static_android.sensor.info.pixelArraySize">android.sensor.info.pixelArraySize</a>.

32074

This may include hot pixels that lie outside of the active array

32075

bounds given by <a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a>.

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

32080

<th class="th_details" colspan="6">HAL Implementation Details</th>

Ruben Brunk

2014-03-04 14:09:44 -0800

[diff] [blame]

32081

</tr>

32082

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

32083

Ruben Brunk

2014-03-04 14:09:44 -0800

[diff] [blame]

32084

A hotpixel map contains the coordinates of pixels on the camera

32085

sensor that do report valid values (usually due to defects in

32086

the camera sensor). This includes pixels that are stuck at certain

Shuzhen Wang

2022-05-03 11:01:26 -0700

[diff] [blame]

32087

values, or have a response that does not accurately encode the

Ruben Brunk

2014-03-04 14:09:44 -0800

[diff] [blame]

32088

incoming light from the scene.

32089

To avoid performance issues, there should be significantly fewer hot

32090

pixels than actual pixels on the camera sensor.

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

32094

Ruben Brunk

2014-03-04 14:09:44 -0800

[diff] [blame]

32095

32096

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

32097

32098

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

32099

<td class="entry_name

32100

" rowspan="3">

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

32101

android.statistics.lensShadingMapMode

</td>

byte

[public]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

32108

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

32109

[full]

32110

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

32111

32112

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

32113

32114

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

32115

OFF (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

32116

Do not include a lens shading map in the capture result.

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

32117

</li>

32118

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

32119

ON (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

32120

Include a lens shading map in the capture result.

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

</li>

</ul>

</td>

32125

32126

32127

Whether the camera device will output the lens

32128

shading map in output result metadata.

</td>

</td>

Yin-Chia Yeh

2015-02-04 10:04:37 -0800

[diff] [blame]

32135

<a href="#static_android.statistics.info.availableLensShadingMapModes">android.statistics.info.availableLensShadingMapModes</a>

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

32136

</td>

32137

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

32142

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

32143

32144

32145

</ul>

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

32150

<th class="th_details" colspan="6">Details</th>

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

32151

</tr>

32152

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

32153

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

32154

When set to ON,

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

32155

<a href="#dynamic_android.statistics.lensShadingMap">android.statistics.lensShadingMap</a> will be provided in

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

32156

the output result metadata.

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

32157

ON is always supported on devices with the RAW capability.

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

32162

Zhijun He

2014-05-02 17:38:15 -0700

[diff] [blame]

32163

32164

Chien-Yu Chen

2018-01-12 17:38:00 -0800

[diff] [blame]

32165

32166

32167

<td class="entry_name

Eino-Ville Talvala

2018-08-01 15:26:26 -0700

[diff] [blame]

32168

" rowspan="3">

Chien-Yu Chen

2018-01-12 17:38:00 -0800

[diff] [blame]

32169

android.statistics.oisDataMode

</td>

byte

[public]

<li>

OFF (v3.3)

Do not include OIS data in the capture result.

</li>

<li>

ON (v3.3)

Include OIS data in the capture result.

</li>

</ul>

</td>

32192

32193

Eino-Ville Talvala

2018-08-01 15:26:26 -0700

[diff] [blame]

32194

A control for selecting whether optical stabilization (OIS) position

32195

information is included in output result metadata.

Chien-Yu Chen

2018-01-12 17:38:00 -0800

[diff] [blame]

</td>

</td>

Eino-Ville Talvala

2018-03-13 19:10:23 -0700

[diff] [blame]

32202

<a href="#static_android.statistics.info.availableOisDataModes">android.statistics.info.availableOisDataModes</a>

Chien-Yu Chen

2018-01-12 17:38:00 -0800

[diff] [blame]

</td>

3.3

</td>

</td>

</tr>

Eino-Ville Talvala

2018-08-01 15:26:26 -0700

[diff] [blame]

32213

32214

<th class="th_details" colspan="6">Details</th>

</tr>

Since optical image stabilization generally involves motion much faster than the duration

Shuzhen Wang

1373ab5

2021-03-17 11:00:23 -0700

[diff] [blame]

32219

of individual image exposure, multiple OIS samples can be included for a single capture

Eino-Ville Talvala

2018-08-01 15:26:26 -0700

[diff] [blame]

32220

result. For example, if the OIS reporting operates at 200 Hz, a typical camera operating

32221

at 30fps may have 6-7 OIS samples per capture result. This information can be combined

32222

with the rolling shutter skew to account for lens motion during image exposure in

32223

post-processing algorithms.

32224

</td>

32225

</tr>

Chien-Yu Chen

2018-01-12 17:38:00 -0800

[diff] [blame]

<td class="entry_name

32234

" rowspan="3">

32235

android.statistics.oisTimestamps

</td>

int64

x

n

Chien-Yu Chen

2018-02-15 12:34:30 -0800

[diff] [blame]

32244

[ndk_public]

Chien-Yu Chen

2018-01-12 17:38:00 -0800

[diff] [blame]

</td>

32252

32253

32254

An array of timestamps of OIS samples, in nanoseconds.

</td>

nanoseconds

</td>

</td>

3.3

</td>

</td>

</tr>

<th class="th_details" colspan="6">Details</th>

</tr>

The array contains the timestamps of OIS samples. The timestamps are in the same

32278

timebase as and comparable to <a href="#dynamic_android.sensor.timestamp">android.sensor.timestamp</a>.

</td>

</tr>

<td class="entry_name

32289

" rowspan="3">

32290

android.statistics.oisXShifts

</td>

float

x

n

Chien-Yu Chen

2018-02-15 12:34:30 -0800

[diff] [blame]

32299

[ndk_public]

Chien-Yu Chen

2018-01-12 17:38:00 -0800

[diff] [blame]

</td>

32307

32308

32309

An array of shifts of OIS samples, in x direction.

</td>

Pixels in active array.

</td>

</td>

3.3

</td>

</td>

</tr>

<th class="th_details" colspan="6">Details</th>

</tr>

The array contains the amount of shifts in x direction, in pixels, based on OIS samples.

Eino-Ville Talvala

2018-08-01 15:26:26 -0700

[diff] [blame]

32333

A positive value is a shift from left to right in the pre-correction active array

32334

coordinate system. For example, if the optical center is (1000, 500) in pre-correction

32335

active array coordinates, a shift of (3, 0) puts the new optical center at (1003, 500).

Chien-Yu Chen

2018-01-12 17:38:00 -0800

[diff] [blame]

32336

The number of shifts must match the number of timestamps in

32337

<a href="#dynamic_android.statistics.oisTimestamps">android.statistics.oisTimestamps</a>.

Eino-Ville Talvala

2018-08-01 15:26:26 -0700

[diff] [blame]

32338

The OIS samples are not affected by whether lens distortion correction is enabled (on

32339

supporting devices). They are always reported in pre-correction active array coordinates,

32340

since the scaling of OIS shifts would depend on the specific spot on the sensor the shift

32341

is needed.

Chien-Yu Chen

2018-01-12 17:38:00 -0800

[diff] [blame]

</td>

</tr>

<td class="entry_name

32352

" rowspan="3">

32353

android.statistics.oisYShifts

</td>

float

x

n

Chien-Yu Chen

2018-02-15 12:34:30 -0800

[diff] [blame]

32362

[ndk_public]

Chien-Yu Chen

2018-01-12 17:38:00 -0800

[diff] [blame]

</td>

32370

32371

32372

An array of shifts of OIS samples, in y direction.

</td>

Pixels in active array.

</td>

</td>

3.3

</td>

</td>

</tr>

<th class="th_details" colspan="6">Details</th>

</tr>

The array contains the amount of shifts in y direction, in pixels, based on OIS samples.

Eino-Ville Talvala

2018-08-01 15:26:26 -0700

[diff] [blame]

32396

A positive value is a shift from top to bottom in pre-correction active array coordinate

32397

system. For example, if the optical center is (1000, 500) in active array coordinates, a

32398

shift of (0, 5) puts the new optical center at (1000, 505).

Chien-Yu Chen

2018-01-12 17:38:00 -0800

[diff] [blame]

32399

The number of shifts must match the number of timestamps in

32400

<a href="#dynamic_android.statistics.oisTimestamps">android.statistics.oisTimestamps</a>.

Eino-Ville Talvala

2018-08-01 15:26:26 -0700

[diff] [blame]

32401

The OIS samples are not affected by whether lens distortion correction is enabled (on

32402

supporting devices). They are always reported in pre-correction active array coordinates,

32403

since the scaling of OIS shifts would depend on the specific spot on the sensor the shift

32404

is needed.

Chien-Yu Chen

2018-01-12 17:38:00 -0800

[diff] [blame]

</td>

</tr>

32411

Chien-Yu Chen

2018-02-15 12:34:30 -0800

[diff] [blame]

32412

32413

32414

<td class="entry_name

32415

" rowspan="3">

32416

android.statistics.oisSamples

</td>

float

x

n

[java_public as oisSample]

[synthetic]

</td>

32434

32435

Eino-Ville Talvala

2018-08-01 15:26:26 -0700

[diff] [blame]

32436

An array of optical stabilization (OIS) position samples.

Chien-Yu Chen

2018-02-15 12:34:30 -0800

[diff] [blame]

</td>

</td>

</td>

3.3

</td>

</td>

</tr>

<th class="th_details" colspan="6">Details</th>

</tr>

Each OIS sample contains the timestamp and the amount of shifts in x and y direction,

32459

in pixels, of the OIS sample.

Eino-Ville Talvala

2018-08-01 15:26:26 -0700

[diff] [blame]

32460

A positive value for a shift in x direction is a shift from left to right in the

32461

pre-correction active array coordinate system. For example, if the optical center is

32462

(1000, 500) in pre-correction active array coordinates, a shift of (3, 0) puts the new

32463

optical center at (1003, 500).

32464

A positive value for a shift in y direction is a shift from top to bottom in

32465

pre-correction active array coordinate system. For example, if the optical center is

32466

(1000, 500) in active array coordinates, a shift of (0, 5) puts the new optical center at

32467

(1000, 505).

32468

The OIS samples are not affected by whether lens distortion correction is enabled (on

32469

supporting devices). They are always reported in pre-correction active array coordinates,

32470

since the scaling of OIS shifts would depend on the specific spot on the sensor the shift

32471

is needed.

Chien-Yu Chen

2018-02-15 12:34:30 -0800

[diff] [blame]

</td>

</tr>

32478

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</tbody>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

32485

<tr><td colspan="7" id="section_tonemap" class="section">tonemap</td></tr>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

32486

32487

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

32488

<tr><td colspan="7" class="kind">controls</td></tr>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

32489

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

32490

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

32491

<tr>

32492

<th class="th_name">Property Name</th>

32493

32494

<th class="th_description">Description</th>

32495

<th class="th_units">Units</th>

32496

<th class="th_range">Range</th>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

32497

<th class="th_hal_version">Initial HIDL HAL version</th>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</tr>

</thead>

<tbody>

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

32514

<td class="entry_name

32515

" rowspan="3">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

32516

android.tonemap.curveBlue

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

32517

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

32518

Eino-Ville Talvala

2013-01-11 13:57:19 -0800

[diff] [blame]

32519

float

Zhijun He

2013-08-19 15:26:33 -0700

[diff] [blame]

32520

x

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

32521

Zhijun He

2013-08-19 15:26:33 -0700

[diff] [blame]

n x 2

Yin-Chia Yeh

2016-04-02 16:30:30 -0700

[diff] [blame]

32525

[ndk_public]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

32526

32527

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

32528

[full]

32529

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

32530

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

32531

<div class="entry_type_notes">1D array of float pairs (P_IN, P_OUT). The maximum number of pairs is specified by android.tonemap.maxCurvePoints.</div>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

32532

32533

32534

</td>

32535

32536

Igor Murashkin

2014-01-13 16:51:17 -0800

[diff] [blame]

32537

Tonemapping / contrast / gamma curve for the blue

32538

channel, to use when <a href="#controls_android.tonemap.mode">android.tonemap.mode</a> is

32539

CONTRAST_CURVE.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

32546

</td>

32547

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

32557

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

32558

</tr>

32559

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

32560

Igor Murashkin

2014-01-13 16:51:17 -0800

[diff] [blame]

32561

See <a href="#controls_android.tonemap.curveRed">android.tonemap.curveRed</a> for more details.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

32562

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

32563

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

32564

32565

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

32566

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

32567

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

32571

<td class="entry_name

32572

" rowspan="3">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

32573

android.tonemap.curveGreen

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

32574

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

32575

Eino-Ville Talvala

2013-01-11 13:57:19 -0800

[diff] [blame]

32576

float

Zhijun He

2013-08-19 15:26:33 -0700

[diff] [blame]

32577

x

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

32578

Zhijun He

2013-08-19 15:26:33 -0700

[diff] [blame]

n x 2

Yin-Chia Yeh

2016-04-02 16:30:30 -0700

[diff] [blame]

32582

[ndk_public]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

32583

32584

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

32585

[full]

32586

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

32587

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

32588

<div class="entry_type_notes">1D array of float pairs (P_IN, P_OUT). The maximum number of pairs is specified by android.tonemap.maxCurvePoints.</div>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

32589

32590

32591

</td>

32592

32593

Igor Murashkin

2014-01-13 16:51:17 -0800

[diff] [blame]

32594

Tonemapping / contrast / gamma curve for the green

32595

channel, to use when <a href="#controls_android.tonemap.mode">android.tonemap.mode</a> is

32596

CONTRAST_CURVE.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

32603

</td>

32604

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

32614

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

32615

</tr>

32616

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

32617

Igor Murashkin

2014-01-13 16:51:17 -0800

[diff] [blame]

32618

See <a href="#controls_android.tonemap.curveRed">android.tonemap.curveRed</a> for more details.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

32619

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

32620

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

32621

32622

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

32623

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

32624

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

32628

<td class="entry_name

32629

" rowspan="5">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

32630

android.tonemap.curveRed

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

32631

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

32632

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

32633

float

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

x

n x 2

Yin-Chia Yeh

2016-04-02 16:30:30 -0700

[diff] [blame]

32639

[ndk_public]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

32640

32641

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

32642

[full]

32643

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

32644

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

32645

<div class="entry_type_notes">1D array of float pairs (P_IN, P_OUT). The maximum number of pairs is specified by android.tonemap.maxCurvePoints.</div>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

32646

32647

32648

</td>

32649

32650

Igor Murashkin

2014-01-13 16:51:17 -0800

[diff] [blame]

32651

Tonemapping / contrast / gamma curve for the red

32652

channel, to use when <a href="#controls_android.tonemap.mode">android.tonemap.mode</a> is

32653

CONTRAST_CURVE.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

Igor Murashkin

2014-01-13 16:51:17 -0800

[diff] [blame]

32660

0-1 on both input and output coordinates, normalized

32661

as a floating-point value such that 0 == black and 1 == white.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

32662

</td>

32663

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

32668

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

32673

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

32674

</tr>

32675

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

32676

Igor Murashkin

2014-01-13 16:51:17 -0800

[diff] [blame]

32677

Each channel's curve is defined by an array of control points:

32678

<pre><code><a href="#controls_android.tonemap.curveRed">android.tonemap.curveRed</a> =

32679

[ P0in, P0out, P1in, P1out, P2in, P2out, P3in, P3out, ..., PNin, PNout ]

32680

2 <= N <= <a href="#static_android.tonemap.maxCurvePoints">android.tonemap.maxCurvePoints</a></code></pre>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

32681

These are sorted in order of increasing <code>Pin</code>; it is

32682

required that input values 0.0 and 1.0 are included in the list to

Igor Murashkin

2014-01-13 16:51:17 -0800

[diff] [blame]

32683

define a complete mapping. For input values between control points,

32684

the camera device must linearly interpolate between the control

32685

points.

32686

Each curve can have an independent number of points, and the number

32687

of points can be less than max (that is, the request doesn't have to

32688

always provide a curve with number of points equivalent to

32689

<a href="#static_android.tonemap.maxCurvePoints">android.tonemap.maxCurvePoints</a>).

Shuzhen Wang

2018-10-15 12:00:13 -0700

[diff] [blame]

32690

For devices with MONOCHROME capability, all three channels must have the same set of

32691

control points.

Igor Murashkin

2014-01-13 16:51:17 -0800

[diff] [blame]

32692

A few examples, and their corresponding graphical mappings; these

32693

only specify the red channel and the precision is limited to 4

32694

digits, for conciseness.

32695

Linear mapping:

32696

<pre><code><a href="#controls_android.tonemap.curveRed">android.tonemap.curveRed</a> = [ 0, 0, 1.0, 1.0 ]

</code></pre>

Invert mapping:

<pre><code><a href="#controls_android.tonemap.curveRed">android.tonemap.curveRed</a> = [ 0, 1.0, 1.0, 0 ]

32701

</code></pre>

32702

32703

Gamma 1/2.2 mapping, with 16 control points:

32704

<pre><code><a href="#controls_android.tonemap.curveRed">android.tonemap.curveRed</a> = [

32705

0.0000, 0.0000, 0.0667, 0.2920, 0.1333, 0.4002, 0.2000, 0.4812,

32706

0.2667, 0.5484, 0.3333, 0.6069, 0.4000, 0.6594, 0.4667, 0.7072,

32707

0.5333, 0.7515, 0.6000, 0.7928, 0.6667, 0.8317, 0.7333, 0.8685,

32708

0.8000, 0.9035, 0.8667, 0.9370, 0.9333, 0.9691, 1.0000, 1.0000 ]

32709

</code></pre>

32710

32711

Standard sRGB gamma mapping, per IEC 61966-2-1:1999, with 16 control points:

32712

<pre><code><a href="#controls_android.tonemap.curveRed">android.tonemap.curveRed</a> = [

32713

0.0000, 0.0000, 0.0667, 0.2864, 0.1333, 0.4007, 0.2000, 0.4845,

32714

0.2667, 0.5532, 0.3333, 0.6125, 0.4000, 0.6652, 0.4667, 0.7130,

32715

0.5333, 0.7569, 0.6000, 0.7977, 0.6667, 0.8360, 0.7333, 0.8721,

32716

0.8000, 0.9063, 0.8667, 0.9389, 0.9333, 0.9701, 1.0000, 1.0000 ]

32717

</code></pre>

32718

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

32719

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

32720

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

32721

Igor Murashkin

2014-01-13 16:51:17 -0800

[diff] [blame]

32722

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

32723

<th class="th_details" colspan="6">HAL Implementation Details</th>

Igor Murashkin

2014-01-13 16:51:17 -0800

[diff] [blame]

32724

</tr>

32725

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

32726

Igor Murashkin

2014-01-13 16:51:17 -0800

[diff] [blame]

32727

For good quality of mapping, at least 128 control points are

32728

preferred.

32729

A typical use case of this would be a gamma-1/2.2 curve, with as many

32730

control points used as are available.

32731

</td>

32732

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

32733

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

32734

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

32735

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

32736

32737

Yin-Chia Yeh

2014-05-27 09:48:07 -0700

[diff] [blame]

32738

32739

<td class="entry_name

32740

" rowspan="5">

32741

android.tonemap.curve

</td>

float

Yin-Chia Yeh

2016-04-02 16:30:30 -0700

[diff] [blame]

32746

[java_public as tonemapCurve]

Yin-Chia Yeh

2014-05-27 09:48:07 -0700

[diff] [blame]

[synthetic]

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

32750

[full]

32751

Yin-Chia Yeh

2014-05-27 09:48:07 -0700

[diff] [blame]

</td>

32756

32757

32758

Tonemapping / contrast / gamma curve to use when <a href="#controls_android.tonemap.mode">android.tonemap.mode</a>

is CONTRAST_CURVE.

</td>

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Yin-Chia Yeh

2014-05-27 09:48:07 -0700

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

32777

<th class="th_details" colspan="6">Details</th>

Yin-Chia Yeh

2014-05-27 09:48:07 -0700

[diff] [blame]

32778

</tr>

32779

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

32780

Yin-Chia Yeh

2014-05-27 09:48:07 -0700

[diff] [blame]

32781

The tonemapCurve consist of three curves for each of red, green, and blue

32782

channels respectively. The following example uses the red channel as an

32783

example. The same logic applies to green and blue channel.

32784

Each channel's curve is defined by an array of control points:

32785

<pre><code>curveRed =

32786

[ P0(in, out), P1(in, out), P2(in, out), P3(in, out), ..., PN(in, out) ]

32787

2 <= N <= <a href="#static_android.tonemap.maxCurvePoints">android.tonemap.maxCurvePoints</a></code></pre>

32788

These are sorted in order of increasing <code>Pin</code>; it is always

32789

guaranteed that input values 0.0 and 1.0 are included in the list to

32790

define a complete mapping. For input values between control points,

32791

the camera device must linearly interpolate between the control

32792

points.

32793

Each curve can have an independent number of points, and the number

32794

of points can be less than max (that is, the request doesn't have to

32795

always provide a curve with number of points equivalent to

32796

<a href="#static_android.tonemap.maxCurvePoints">android.tonemap.maxCurvePoints</a>).

Shuzhen Wang

2018-10-15 12:00:13 -0700

[diff] [blame]

32797

For devices with MONOCHROME capability, all three channels must have the same set of

32798

control points.

Yin-Chia Yeh

2014-05-27 09:48:07 -0700

[diff] [blame]

32799

A few examples, and their corresponding graphical mappings; these

32800

only specify the red channel and the precision is limited to 4

32801

digits, for conciseness.

32802

Linear mapping:

32803

<pre><code>curveRed = [ (0, 0), (1.0, 1.0) ]

</code></pre>

Invert mapping:

<pre><code>curveRed = [ (0, 1.0), (1.0, 0) ]

32808

</code></pre>

32809

32810

Gamma 1/2.2 mapping, with 16 control points:

32811

<pre><code>curveRed = [

32812

(0.0000, 0.0000), (0.0667, 0.2920), (0.1333, 0.4002), (0.2000, 0.4812),

32813

(0.2667, 0.5484), (0.3333, 0.6069), (0.4000, 0.6594), (0.4667, 0.7072),

32814

(0.5333, 0.7515), (0.6000, 0.7928), (0.6667, 0.8317), (0.7333, 0.8685),

32815

(0.8000, 0.9035), (0.8667, 0.9370), (0.9333, 0.9691), (1.0000, 1.0000) ]

32816

</code></pre>

32817

32818

Standard sRGB gamma mapping, per IEC 61966-2-1:1999, with 16 control points:

32819

<pre><code>curveRed = [

32820

(0.0000, 0.0000), (0.0667, 0.2864), (0.1333, 0.4007), (0.2000, 0.4845),

32821

(0.2667, 0.5532), (0.3333, 0.6125), (0.4000, 0.6652), (0.4667, 0.7130),

32822

(0.5333, 0.7569), (0.6000, 0.7977), (0.6667, 0.8360), (0.7333, 0.8721),

32823

(0.8000, 0.9063), (0.8667, 0.9389), (0.9333, 0.9701), (1.0000, 1.0000) ]

</code></pre>

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

32830

<th class="th_details" colspan="6">HAL Implementation Details</th>

Yin-Chia Yeh

2014-05-27 09:48:07 -0700

[diff] [blame]

32831

</tr>

32832

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

32833

Yin-Chia Yeh

2014-05-27 09:48:07 -0700

[diff] [blame]

32834

This entry is created by the framework from the curveRed, curveGreen and

curveBlue entries.

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

32839

Yin-Chia Yeh

2014-05-27 09:48:07 -0700

[diff] [blame]

32840

32841

32842

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

32843

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

32844

<td class="entry_name

32845

" rowspan="3">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

32846

android.tonemap.mode

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

32847

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

32848

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

32849

byte

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

32850

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

32851

[public]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

32852

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

32853

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

32854

[full]

32855

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

32856

32857

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

32858

32859

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

32860

CONTRAST_CURVE (v3.2)

Igor Murashkin

2014-01-15 17:05:22 -0800

[diff] [blame]

32861

Use the tone mapping curve specified in

Yin-Chia Yeh

2014-05-27 09:48:07 -0700

[diff] [blame]

32862

the <a href="#controls_android.tonemap.curve">android.tonemap.curve</a>* entries.

Igor Murashkin

2014-01-13 16:51:17 -0800

[diff] [blame]

32863

All color enhancement and tonemapping must be disabled, except

32864

for applying the tonemapping curve specified by

Yin-Chia Yeh

2014-05-27 09:48:07 -0700

[diff] [blame]

32865

<a href="#controls_android.tonemap.curve">android.tonemap.curve</a>.

Igor Murashkin

2014-01-13 16:51:17 -0800

[diff] [blame]

32866

Must not slow down frame rate relative to raw

32867

sensor output.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

32868

</li>

32869

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

32870

FAST (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

32871

Advanced gamma mapping and color enhancement may be applied, without

32872

reducing frame rate compared to raw sensor output.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

32873

</li>

32874

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

32875

HIGH_QUALITY (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

32876

High-quality gamma mapping and color enhancement will be applied, at

Yin-Chia Yeh

2015-04-02 14:00:40 -0700

[diff] [blame]

32877

the cost of possibly reduced frame rate compared to raw sensor output.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

32878

</li>

Yin-Chia Yeh

2015-02-05 13:19:21 -0800

[diff] [blame]

32879

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

32880

GAMMA_VALUE (v3.2)

Shuzhen Wang

2022-05-03 11:01:26 -0700

[diff] [blame]

32881

Use the gamma value specified in <a href="#controls_android.tonemap.gamma">android.tonemap.gamma</a> to perform

Yin-Chia Yeh

2015-02-05 13:19:21 -0800

[diff] [blame]

32882

tonemapping.

32883

All color enhancement and tonemapping must be disabled, except

Yin-Chia Yeh

2015-05-05 23:49:07 -0700

[diff] [blame]

32884

for applying the tonemapping curve specified by <a href="#controls_android.tonemap.gamma">android.tonemap.gamma</a>.

Yin-Chia Yeh

2015-02-05 13:19:21 -0800

[diff] [blame]

32885

Must not slow down frame rate relative to raw sensor output.

32886

</li>

32887

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

32888

PRESET_CURVE (v3.2)

Yin-Chia Yeh

2015-02-05 13:19:21 -0800

[diff] [blame]

32889

Use the preset tonemapping curve specified in

Shuzhen Wang

2022-05-03 11:01:26 -0700

[diff] [blame]

32890

<a href="#controls_android.tonemap.presetCurve">android.tonemap.presetCurve</a> to perform tonemapping.

Yin-Chia Yeh

2015-02-05 13:19:21 -0800

[diff] [blame]

32891

All color enhancement and tonemapping must be disabled, except

32892

for applying the tonemapping curve specified by

Yin-Chia Yeh

2015-05-05 23:49:07 -0700

[diff] [blame]

32893

<a href="#controls_android.tonemap.presetCurve">android.tonemap.presetCurve</a>.

Yin-Chia Yeh

2015-02-05 13:19:21 -0800

[diff] [blame]

32894

Must not slow down frame rate relative to raw sensor output.

32895

</li>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

32896

</ul>

32897

32898

</td>

32899

32900

Igor Murashkin

2014-01-13 16:51:17 -0800

[diff] [blame]

32901

High-level global contrast/gamma/tonemapping control.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

32908

<a href="#static_android.tonemap.availableToneMapModes">android.tonemap.availableToneMapModes</a>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

32909

</td>

32910

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

32918

</tr>

Igor Murashkin

2014-01-13 16:51:17 -0800

[diff] [blame]

32919

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

32920

<th class="th_details" colspan="6">Details</th>

Igor Murashkin

2014-01-13 16:51:17 -0800

[diff] [blame]

32921

</tr>

32922

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

32923

Igor Murashkin

2014-01-13 16:51:17 -0800

[diff] [blame]

32924

When switching to an application-defined contrast curve by setting

32925

<a href="#controls_android.tonemap.mode">android.tonemap.mode</a> to CONTRAST_CURVE, the curve is defined

32926

per-channel with a set of <code>(in, out)</code> points that specify the

32927

mapping from input high-bit-depth pixel value to the output

32928

low-bit-depth value. Since the actual pixel ranges of both input

32929

and output may change depending on the camera pipeline, the values

32930

are specified by normalized floating-point numbers.

32931

More-complex color mapping operations such as 3D color look-up

32932

tables, selective chroma enhancement, or other non-linear color

32933

transforms will be disabled when <a href="#controls_android.tonemap.mode">android.tonemap.mode</a> is

32934

CONTRAST_CURVE.

32935

When using either FAST or HIGH_QUALITY, the camera device will

Yin-Chia Yeh

2014-05-27 09:48:07 -0700

[diff] [blame]

32936

emit its own tonemap curve in <a href="#controls_android.tonemap.curve">android.tonemap.curve</a>.

Igor Murashkin

2014-01-13 16:51:17 -0800

[diff] [blame]

32937

These values are always available, and as close as possible to the

32938

actually used nonlinear/nonglobal transforms.

Zhijun He

2014-05-20 18:22:18 -0700

[diff] [blame]

32939

If a request is sent with CONTRAST_CURVE with the camera device's

Igor Murashkin

2014-01-13 16:51:17 -0800

[diff] [blame]

32940

provided curve in FAST or HIGH_QUALITY, the image's tonemap will be

32941

roughly the same.

32942

</td>

32943

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

32944

32945

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

32946

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

32947

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

32948

Yin-Chia Yeh

2015-02-05 13:19:21 -0800

[diff] [blame]

32949

32950

32951

<td class="entry_name

32952

" rowspan="3">

32953

android.tonemap.gamma

</td>

float

[public]

</td>

32966

32967

32968

Tonemapping curve to use when <a href="#controls_android.tonemap.mode">android.tonemap.mode</a> is

GAMMA_VALUE

</td>

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Yin-Chia Yeh

2015-02-05 13:19:21 -0800

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

32987

<th class="th_details" colspan="6">Details</th>

Yin-Chia Yeh

2015-02-05 13:19:21 -0800

[diff] [blame]

32988

</tr>

32989

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

32990

Shuzhen Wang

2022-05-03 11:01:26 -0700

[diff] [blame]

32991

The tonemap curve will be defined the following formula:

32992

<ul>

32993

<li>OUT = pow(IN, 1.0 / gamma)</li>

32994

</ul>

32995

where IN and OUT is the input pixel value scaled to range [0.0, 1.0],

Yin-Chia Yeh

2015-02-05 13:19:21 -0800

[diff] [blame]

32996

pow is the power function and gamma is the gamma value specified by this

32997

key.

32998

The same curve will be applied to all color channels. The camera device

32999

may clip the input gamma value to its supported range. The actual applied

33000

value will be returned in capture result.

33001

The valid range of gamma value varies on different devices, but values

33002

within [1.0, 5.0] are guaranteed not to be clipped.

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

33007

Yin-Chia Yeh

2015-02-05 13:19:21 -0800

[diff] [blame]

33008

<td class="entry_name

33013

" rowspan="3">

33014

android.tonemap.presetCurve

</td>

byte

[public]

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

33027

SRGB (v3.2)

Yin-Chia Yeh

2015-02-05 13:19:21 -0800

[diff] [blame]

33028

Tonemapping curve is defined by sRGB

33029

</li>

33030

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

33031

REC709 (v3.2)

Yin-Chia Yeh

2015-02-05 13:19:21 -0800

[diff] [blame]

33032

Tonemapping curve is defined by ITU-R BT.709

</li>

</ul>

</td>

33037

33038

33039

Tonemapping curve to use when <a href="#controls_android.tonemap.mode">android.tonemap.mode</a> is

PRESET_CURVE

</td>

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Yin-Chia Yeh

2015-02-05 13:19:21 -0800

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

33058

<th class="th_details" colspan="6">Details</th>

Yin-Chia Yeh

2015-02-05 13:19:21 -0800

[diff] [blame]

33059

</tr>

33060

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

33061

Yin-Chia Yeh

2015-02-05 13:19:21 -0800

[diff] [blame]

33062

The tonemap curve will be defined by specified standard.

33063

sRGB (approximated by 16 control points):

33064

33065

Rec. 709 (approximated by 16 control points):

33066

33067

Note that above figures show a 16 control points approximation of preset

33068

curves. Camera devices may apply a different approximation to the curve.

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

33073

Yin-Chia Yeh

2015-02-05 13:19:21 -0800

[diff] [blame]

33074

33075

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</tbody>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

33080

<tr><td colspan="7" class="kind">static</td></tr>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

33081

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

33082

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

33083

<tr>

33084

<th class="th_name">Property Name</th>

33085

33086

<th class="th_description">Description</th>

33087

<th class="th_units">Units</th>

33088

<th class="th_range">Range</th>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

33089

<th class="th_hal_version">Initial HIDL HAL version</th>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</tr>

</thead>

<tbody>

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

33106

<td class="entry_name

33107

" rowspan="5">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

33108

android.tonemap.maxCurvePoints

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

33109

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

33110

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

33111

int32

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

33112

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

33113

[public]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

33114

33115

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

33116

[full]

33117

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

33121

</td>

33122

33123

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

33124

Maximum number of supported points in the

Yin-Chia Yeh

2014-05-27 09:48:07 -0700

[diff] [blame]

33125

tonemap curve that can be used for <a href="#controls_android.tonemap.curve">android.tonemap.curve</a>.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

33132

</td>

33133

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

33141

</tr>

Igor Murashkin

2014-01-13 16:51:17 -0800

[diff] [blame]

33142

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

33143

<th class="th_details" colspan="6">Details</th>

Igor Murashkin

2014-01-13 16:51:17 -0800

[diff] [blame]

33144

</tr>

33145

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

33146

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

33147

If the actual number of points provided by the application (in <a href="#controls_android.tonemap.curve">android.tonemap.curve</a>*) is

33148

less than this maximum, the camera device will resample the curve to its internal

33149

representation, using linear interpolation.

Igor Murashkin

2014-01-13 16:51:17 -0800

[diff] [blame]

33150

The output curves in the result metadata may have a different number

33151

of points than the input curves, and will represent the actual

33152

hardware curves used as closely as possible when linearly interpolated.

33153

</td>

33154

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

33155

Igor Murashkin

2014-01-13 16:51:17 -0800

[diff] [blame]

33156

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

33157

<th class="th_details" colspan="6">HAL Implementation Details</th>

Igor Murashkin

2014-01-13 16:51:17 -0800

[diff] [blame]

33158

</tr>

33159

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

33160

Igor Murashkin

2014-01-13 16:51:17 -0800

[diff] [blame]

33161

This value must be at least 64. This should be at least 128.

33162

</td>

33163

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

33164

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

33165

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

33166

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

33167

Ruben Brunk

2014-03-04 15:01:25 -0800

[diff] [blame]

33168

33169

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

33170

<td class="entry_name

Yin-Chia Yeh

2015-04-02 14:00:40 -0700

[diff] [blame]

33171

" rowspan="5">

Ruben Brunk

2014-03-04 15:01:25 -0800

[diff] [blame]

33172

android.tonemap.availableToneMapModes

</td>

byte

x

n

Eino-Ville Talvala

2014-05-27 10:50:30 -0700

[diff] [blame]

33181

[public as enumList]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

33182

33183

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

33184

[full]

33185

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

33186

Ruben Brunk

2014-03-04 15:01:25 -0800

[diff] [blame]

33187

<div class="entry_type_notes">list of enums</div>

33188

33189

33190

</td>

33191

33192

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

33193

List of tonemapping modes for <a href="#controls_android.tonemap.mode">android.tonemap.mode</a> that are supported by this camera

33194

device.

Ruben Brunk

2014-03-04 15:01:25 -0800

[diff] [blame]

</td>

</td>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

33201

Any value listed in <a href="#controls_android.tonemap.mode">android.tonemap.mode</a>

Ruben Brunk

2014-03-04 15:01:25 -0800

[diff] [blame]

33202

</td>

33203

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Ruben Brunk

2014-03-04 15:01:25 -0800

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

33213

<th class="th_details" colspan="6">Details</th>

Ruben Brunk

2014-03-04 15:01:25 -0800

[diff] [blame]

33214

</tr>

33215

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

33216

Yin-Chia Yeh

2015-02-05 13:19:21 -0800

[diff] [blame]

33217

Camera devices that support the MANUAL_POST_PROCESSING capability will always contain

33218

at least one of below mode combinations:

33219

<ul>

Yin-Chia Yeh

2015-04-02 14:00:40 -0700

[diff] [blame]

33220

<li>CONTRAST_CURVE, FAST and HIGH_QUALITY</li>

33221

<li>GAMMA_VALUE, PRESET_CURVE, FAST and HIGH_QUALITY</li>

Yin-Chia Yeh

2015-02-05 13:19:21 -0800

[diff] [blame]

33222

</ul>

33223

This includes all FULL level devices.

Ruben Brunk

2014-03-04 15:01:25 -0800

[diff] [blame]

</td>

</tr>

Yin-Chia Yeh

2015-04-02 14:00:40 -0700

[diff] [blame]

33227

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

33228

<th class="th_details" colspan="6">HAL Implementation Details</th>

Yin-Chia Yeh

2015-04-02 14:00:40 -0700

[diff] [blame]

33229

</tr>

33230

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

33231

Yin-Chia Yeh

2015-04-02 14:00:40 -0700

[diff] [blame]

33232

HAL must support both FAST and HIGH_QUALITY if automatic tonemap control is available

33233

on the camera device, but the underlying implementation can be the same for both modes.

33234

That is, if the highest quality implementation on the camera device does not slow down

33235

capture rate, then FAST and HIGH_QUALITY will generate the same output.

33236

</td>

33237

</tr>

Ruben Brunk

2014-03-04 15:01:25 -0800

[diff] [blame]

33238

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

33239

Ruben Brunk

2014-03-04 15:01:25 -0800

[diff] [blame]

33240

33241

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</tbody>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

33246

<tr><td colspan="7" class="kind">dynamic</td></tr>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

33247

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

33248

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

33249

<tr>

33250

<th class="th_name">Property Name</th>

33251

33252

<th class="th_description">Description</th>

33253

<th class="th_units">Units</th>

33254

<th class="th_range">Range</th>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

33255

<th class="th_hal_version">Initial HIDL HAL version</th>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</tr>

</thead>

<tbody>

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

33272

<td class="entry_name

33273

" rowspan="3">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

33274

android.tonemap.curveBlue

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

33275

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

33276

Eino-Ville Talvala

2013-01-11 13:57:19 -0800

[diff] [blame]

33277

float

Zhijun He

2013-08-19 15:26:33 -0700

[diff] [blame]

33278

x

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

33279

Zhijun He

2013-08-19 15:26:33 -0700

[diff] [blame]

n x 2

Yin-Chia Yeh

2016-04-02 16:30:30 -0700

[diff] [blame]

33283

[ndk_public]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

33284

33285

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

33286

[full]

33287

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

33288

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

33289

<div class="entry_type_notes">1D array of float pairs (P_IN, P_OUT). The maximum number of pairs is specified by android.tonemap.maxCurvePoints.</div>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

33290

33291

33292

</td>

33293

33294

Igor Murashkin

2014-01-13 16:51:17 -0800

[diff] [blame]

33295

Tonemapping / contrast / gamma curve for the blue

33296

channel, to use when <a href="#controls_android.tonemap.mode">android.tonemap.mode</a> is

33297

CONTRAST_CURVE.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

33304

</td>

33305

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

33315

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

33316

</tr>

33317

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

33318

Igor Murashkin

2014-01-13 16:51:17 -0800

[diff] [blame]

33319

See <a href="#controls_android.tonemap.curveRed">android.tonemap.curveRed</a> for more details.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

33320

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

33321

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

33322

33323

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

33324

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

33325

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

33329

<td class="entry_name

33330

" rowspan="3">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

33331

android.tonemap.curveGreen

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

33332

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

33333

Eino-Ville Talvala

2013-01-11 13:57:19 -0800

[diff] [blame]

33334

float

Zhijun He

2013-08-19 15:26:33 -0700

[diff] [blame]

33335

x

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

33336

Zhijun He

2013-08-19 15:26:33 -0700

[diff] [blame]

n x 2

Yin-Chia Yeh

2016-04-02 16:30:30 -0700

[diff] [blame]

33340

[ndk_public]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

33341

33342

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

33343

[full]

33344

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

33345

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

33346

<div class="entry_type_notes">1D array of float pairs (P_IN, P_OUT). The maximum number of pairs is specified by android.tonemap.maxCurvePoints.</div>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

33347

33348

33349

</td>

33350

33351

Igor Murashkin

2014-01-13 16:51:17 -0800

[diff] [blame]

33352

Tonemapping / contrast / gamma curve for the green

33353

channel, to use when <a href="#controls_android.tonemap.mode">android.tonemap.mode</a> is

33354

CONTRAST_CURVE.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

33361

</td>

33362

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

33372

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

33373

</tr>

33374

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

33375

Igor Murashkin

2014-01-13 16:51:17 -0800

[diff] [blame]

33376

See <a href="#controls_android.tonemap.curveRed">android.tonemap.curveRed</a> for more details.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

33377

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

33378

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

33379

33380

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

33381

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

33382

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

33386

<td class="entry_name

33387

" rowspan="5">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

33388

android.tonemap.curveRed

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

33389

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

33390

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

33391

float

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

x

n x 2

Yin-Chia Yeh

2016-04-02 16:30:30 -0700

[diff] [blame]

33397

[ndk_public]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

33398

33399

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

33400

[full]

33401

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

33402

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

33403

<div class="entry_type_notes">1D array of float pairs (P_IN, P_OUT). The maximum number of pairs is specified by android.tonemap.maxCurvePoints.</div>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

33404

33405

33406

</td>

33407

33408

Igor Murashkin

2014-01-13 16:51:17 -0800

[diff] [blame]

33409

Tonemapping / contrast / gamma curve for the red

33410

channel, to use when <a href="#controls_android.tonemap.mode">android.tonemap.mode</a> is

33411

CONTRAST_CURVE.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

Igor Murashkin

2014-01-13 16:51:17 -0800

[diff] [blame]

33418

0-1 on both input and output coordinates, normalized

33419

as a floating-point value such that 0 == black and 1 == white.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

33420

</td>

33421

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

33426

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

33431

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

33432

</tr>

33433

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

33434

Igor Murashkin

2014-01-13 16:51:17 -0800

[diff] [blame]

33435

Each channel's curve is defined by an array of control points:

33436

<pre><code><a href="#controls_android.tonemap.curveRed">android.tonemap.curveRed</a> =

33437

[ P0in, P0out, P1in, P1out, P2in, P2out, P3in, P3out, ..., PNin, PNout ]

33438

2 <= N <= <a href="#static_android.tonemap.maxCurvePoints">android.tonemap.maxCurvePoints</a></code></pre>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

33439

These are sorted in order of increasing <code>Pin</code>; it is

33440

required that input values 0.0 and 1.0 are included in the list to

Igor Murashkin

2014-01-13 16:51:17 -0800

[diff] [blame]

33441

define a complete mapping. For input values between control points,

33442

the camera device must linearly interpolate between the control

33443

points.

33444

Each curve can have an independent number of points, and the number

33445

of points can be less than max (that is, the request doesn't have to

33446

always provide a curve with number of points equivalent to

33447

<a href="#static_android.tonemap.maxCurvePoints">android.tonemap.maxCurvePoints</a>).

Shuzhen Wang

2018-10-15 12:00:13 -0700

[diff] [blame]

33448

For devices with MONOCHROME capability, all three channels must have the same set of

33449

control points.

Igor Murashkin

2014-01-13 16:51:17 -0800

[diff] [blame]

33450

A few examples, and their corresponding graphical mappings; these

33451

only specify the red channel and the precision is limited to 4

33452

digits, for conciseness.

33453

Linear mapping:

33454

<pre><code><a href="#controls_android.tonemap.curveRed">android.tonemap.curveRed</a> = [ 0, 0, 1.0, 1.0 ]

</code></pre>

Invert mapping:

<pre><code><a href="#controls_android.tonemap.curveRed">android.tonemap.curveRed</a> = [ 0, 1.0, 1.0, 0 ]

33459

</code></pre>

33460

33461

Gamma 1/2.2 mapping, with 16 control points:

33462

<pre><code><a href="#controls_android.tonemap.curveRed">android.tonemap.curveRed</a> = [

33463

0.0000, 0.0000, 0.0667, 0.2920, 0.1333, 0.4002, 0.2000, 0.4812,

33464

0.2667, 0.5484, 0.3333, 0.6069, 0.4000, 0.6594, 0.4667, 0.7072,

33465

0.5333, 0.7515, 0.6000, 0.7928, 0.6667, 0.8317, 0.7333, 0.8685,

33466

0.8000, 0.9035, 0.8667, 0.9370, 0.9333, 0.9691, 1.0000, 1.0000 ]

33467

</code></pre>

33468

33469

Standard sRGB gamma mapping, per IEC 61966-2-1:1999, with 16 control points:

33470

<pre><code><a href="#controls_android.tonemap.curveRed">android.tonemap.curveRed</a> = [

33471

0.0000, 0.0000, 0.0667, 0.2864, 0.1333, 0.4007, 0.2000, 0.4845,

33472

0.2667, 0.5532, 0.3333, 0.6125, 0.4000, 0.6652, 0.4667, 0.7130,

33473

0.5333, 0.7569, 0.6000, 0.7977, 0.6667, 0.8360, 0.7333, 0.8721,

33474

0.8000, 0.9063, 0.8667, 0.9389, 0.9333, 0.9701, 1.0000, 1.0000 ]

33475

</code></pre>

33476

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

33477

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

33478

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

33479

Igor Murashkin

2014-01-13 16:51:17 -0800

[diff] [blame]

33480

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

33481

<th class="th_details" colspan="6">HAL Implementation Details</th>

Igor Murashkin

2014-01-13 16:51:17 -0800

[diff] [blame]

33482

</tr>

33483

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

33484

Igor Murashkin

2014-01-13 16:51:17 -0800

[diff] [blame]

33485

For good quality of mapping, at least 128 control points are

33486

preferred.

33487

A typical use case of this would be a gamma-1/2.2 curve, with as many

33488

control points used as are available.

33489

</td>

33490

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

33491

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

33492

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

33493

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

33494

33495

Yin-Chia Yeh

2014-05-27 09:48:07 -0700

[diff] [blame]

33496

33497

<td class="entry_name

33498

" rowspan="5">

33499

android.tonemap.curve

</td>

float

Yin-Chia Yeh

2016-04-02 16:30:30 -0700

[diff] [blame]

33504

[java_public as tonemapCurve]

Yin-Chia Yeh

2014-05-27 09:48:07 -0700

[diff] [blame]

[synthetic]

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

33508

[full]

33509

Yin-Chia Yeh

2014-05-27 09:48:07 -0700

[diff] [blame]

</td>

33514

33515

33516

Tonemapping / contrast / gamma curve to use when <a href="#controls_android.tonemap.mode">android.tonemap.mode</a>

is CONTRAST_CURVE.

</td>

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Yin-Chia Yeh

2014-05-27 09:48:07 -0700

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

33535

<th class="th_details" colspan="6">Details</th>

Yin-Chia Yeh

2014-05-27 09:48:07 -0700

[diff] [blame]

33536

</tr>

33537

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

33538

Yin-Chia Yeh

2014-05-27 09:48:07 -0700

[diff] [blame]

33539

The tonemapCurve consist of three curves for each of red, green, and blue

33540

channels respectively. The following example uses the red channel as an

33541

example. The same logic applies to green and blue channel.

33542

Each channel's curve is defined by an array of control points:

33543

<pre><code>curveRed =

33544

[ P0(in, out), P1(in, out), P2(in, out), P3(in, out), ..., PN(in, out) ]

33545

2 <= N <= <a href="#static_android.tonemap.maxCurvePoints">android.tonemap.maxCurvePoints</a></code></pre>

33546

These are sorted in order of increasing <code>Pin</code>; it is always

33547

guaranteed that input values 0.0 and 1.0 are included in the list to

33548

define a complete mapping. For input values between control points,

33549

the camera device must linearly interpolate between the control

33550

points.

33551

Each curve can have an independent number of points, and the number

33552

of points can be less than max (that is, the request doesn't have to

33553

always provide a curve with number of points equivalent to

33554

<a href="#static_android.tonemap.maxCurvePoints">android.tonemap.maxCurvePoints</a>).

Shuzhen Wang

2018-10-15 12:00:13 -0700

[diff] [blame]

33555

For devices with MONOCHROME capability, all three channels must have the same set of

33556

control points.

Yin-Chia Yeh

2014-05-27 09:48:07 -0700

[diff] [blame]

33557

A few examples, and their corresponding graphical mappings; these

33558

only specify the red channel and the precision is limited to 4

33559

digits, for conciseness.

33560

Linear mapping:

33561

<pre><code>curveRed = [ (0, 0), (1.0, 1.0) ]

</code></pre>

Invert mapping:

<pre><code>curveRed = [ (0, 1.0), (1.0, 0) ]

33566

</code></pre>

33567

33568

Gamma 1/2.2 mapping, with 16 control points:

33569

<pre><code>curveRed = [

33570

(0.0000, 0.0000), (0.0667, 0.2920), (0.1333, 0.4002), (0.2000, 0.4812),

33571

(0.2667, 0.5484), (0.3333, 0.6069), (0.4000, 0.6594), (0.4667, 0.7072),

33572

(0.5333, 0.7515), (0.6000, 0.7928), (0.6667, 0.8317), (0.7333, 0.8685),

33573

(0.8000, 0.9035), (0.8667, 0.9370), (0.9333, 0.9691), (1.0000, 1.0000) ]

33574

</code></pre>

33575

33576

Standard sRGB gamma mapping, per IEC 61966-2-1:1999, with 16 control points:

33577

<pre><code>curveRed = [

33578

(0.0000, 0.0000), (0.0667, 0.2864), (0.1333, 0.4007), (0.2000, 0.4845),

33579

(0.2667, 0.5532), (0.3333, 0.6125), (0.4000, 0.6652), (0.4667, 0.7130),

33580

(0.5333, 0.7569), (0.6000, 0.7977), (0.6667, 0.8360), (0.7333, 0.8721),

33581

(0.8000, 0.9063), (0.8667, 0.9389), (0.9333, 0.9701), (1.0000, 1.0000) ]

</code></pre>

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

33588

<th class="th_details" colspan="6">HAL Implementation Details</th>

Yin-Chia Yeh

2014-05-27 09:48:07 -0700

[diff] [blame]

33589

</tr>

33590

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

33591

Yin-Chia Yeh

2014-05-27 09:48:07 -0700

[diff] [blame]

33592

This entry is created by the framework from the curveRed, curveGreen and

curveBlue entries.

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

33597

Yin-Chia Yeh

2014-05-27 09:48:07 -0700

[diff] [blame]

33598

33599

33600

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

33601

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

33602

<td class="entry_name

33603

" rowspan="3">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

33604

android.tonemap.mode

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

33605

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

33606

Igor Murashkin

2012-12-04 16:07:21 -0800

[diff] [blame]

33607

byte

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

33608

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

33609

[public]

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

33610

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

33611

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

33612

[full]

33613

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

33614

33615

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

33616

33617

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

33618

CONTRAST_CURVE (v3.2)

Igor Murashkin

2014-01-15 17:05:22 -0800

[diff] [blame]

33619

Use the tone mapping curve specified in

Yin-Chia Yeh

2014-05-27 09:48:07 -0700

[diff] [blame]

33620

the <a href="#controls_android.tonemap.curve">android.tonemap.curve</a>* entries.

Igor Murashkin

2014-01-13 16:51:17 -0800

[diff] [blame]

33621

All color enhancement and tonemapping must be disabled, except

33622

for applying the tonemapping curve specified by

Yin-Chia Yeh

2014-05-27 09:48:07 -0700

[diff] [blame]

33623

<a href="#controls_android.tonemap.curve">android.tonemap.curve</a>.

Igor Murashkin

2014-01-13 16:51:17 -0800

[diff] [blame]

33624

Must not slow down frame rate relative to raw

33625

sensor output.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

33626

</li>

33627

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

33628

FAST (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

33629

Advanced gamma mapping and color enhancement may be applied, without

33630

reducing frame rate compared to raw sensor output.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

33631

</li>

33632

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

33633

HIGH_QUALITY (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

33634

High-quality gamma mapping and color enhancement will be applied, at

Yin-Chia Yeh

2015-04-02 14:00:40 -0700

[diff] [blame]

33635

the cost of possibly reduced frame rate compared to raw sensor output.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

33636

</li>

Yin-Chia Yeh

2015-02-05 13:19:21 -0800

[diff] [blame]

33637

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

33638

GAMMA_VALUE (v3.2)

Shuzhen Wang

2022-05-03 11:01:26 -0700

[diff] [blame]

33639

Use the gamma value specified in <a href="#controls_android.tonemap.gamma">android.tonemap.gamma</a> to perform

Yin-Chia Yeh

2015-02-05 13:19:21 -0800

[diff] [blame]

33640

tonemapping.

33641

All color enhancement and tonemapping must be disabled, except

Yin-Chia Yeh

2015-05-05 23:49:07 -0700

[diff] [blame]

33642

for applying the tonemapping curve specified by <a href="#controls_android.tonemap.gamma">android.tonemap.gamma</a>.

Yin-Chia Yeh

2015-02-05 13:19:21 -0800

[diff] [blame]

33643

Must not slow down frame rate relative to raw sensor output.

33644

</li>

33645

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

33646

PRESET_CURVE (v3.2)

Yin-Chia Yeh

2015-02-05 13:19:21 -0800

[diff] [blame]

33647

Use the preset tonemapping curve specified in

Shuzhen Wang

2022-05-03 11:01:26 -0700

[diff] [blame]

33648

<a href="#controls_android.tonemap.presetCurve">android.tonemap.presetCurve</a> to perform tonemapping.

Yin-Chia Yeh

2015-02-05 13:19:21 -0800

[diff] [blame]

33649

All color enhancement and tonemapping must be disabled, except

33650

for applying the tonemapping curve specified by

Yin-Chia Yeh

2015-05-05 23:49:07 -0700

[diff] [blame]

33651

<a href="#controls_android.tonemap.presetCurve">android.tonemap.presetCurve</a>.

Yin-Chia Yeh

2015-02-05 13:19:21 -0800

[diff] [blame]

33652

Must not slow down frame rate relative to raw sensor output.

33653

</li>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

33654

</ul>

33655

33656

</td>

33657

33658

Igor Murashkin

2014-01-13 16:51:17 -0800

[diff] [blame]

33659

High-level global contrast/gamma/tonemapping control.

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

</td>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

33666

<a href="#static_android.tonemap.availableToneMapModes">android.tonemap.availableToneMapModes</a>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

33667

</td>

33668

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

33676

</tr>

Igor Murashkin

2014-01-17 17:27:15 -0800

[diff] [blame]

33677

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

33678

<th class="th_details" colspan="6">Details</th>

Igor Murashkin

2014-01-17 17:27:15 -0800

[diff] [blame]

33679

</tr>

33680

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

33681

Igor Murashkin

2014-01-17 17:27:15 -0800

[diff] [blame]

33682

When switching to an application-defined contrast curve by setting

33683

<a href="#controls_android.tonemap.mode">android.tonemap.mode</a> to CONTRAST_CURVE, the curve is defined

33684

per-channel with a set of <code>(in, out)</code> points that specify the

33685

mapping from input high-bit-depth pixel value to the output

33686

low-bit-depth value. Since the actual pixel ranges of both input

33687

and output may change depending on the camera pipeline, the values

33688

are specified by normalized floating-point numbers.

33689

More-complex color mapping operations such as 3D color look-up

33690

tables, selective chroma enhancement, or other non-linear color

33691

transforms will be disabled when <a href="#controls_android.tonemap.mode">android.tonemap.mode</a> is

33692

CONTRAST_CURVE.

33693

When using either FAST or HIGH_QUALITY, the camera device will

Yin-Chia Yeh

2014-05-27 09:48:07 -0700

[diff] [blame]

33694

emit its own tonemap curve in <a href="#controls_android.tonemap.curve">android.tonemap.curve</a>.

Igor Murashkin

2014-01-17 17:27:15 -0800

[diff] [blame]

33695

These values are always available, and as close as possible to the

33696

actually used nonlinear/nonglobal transforms.

Zhijun He

2014-05-20 18:22:18 -0700

[diff] [blame]

33697

If a request is sent with CONTRAST_CURVE with the camera device's

Igor Murashkin

2014-01-17 17:27:15 -0800

[diff] [blame]

33698

provided curve in FAST or HIGH_QUALITY, the image's tonemap will be

33699

roughly the same.

33700

</td>

33701

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

33702

33703

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

33704

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

33705

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

33706

Yin-Chia Yeh

2015-02-05 13:19:21 -0800

[diff] [blame]

33707

33708

33709

<td class="entry_name

33710

" rowspan="3">

33711

android.tonemap.gamma

</td>

float

[public]

</td>

33724

33725

33726

Tonemapping curve to use when <a href="#controls_android.tonemap.mode">android.tonemap.mode</a> is

GAMMA_VALUE

</td>

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Yin-Chia Yeh

2015-02-05 13:19:21 -0800

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

33745

<th class="th_details" colspan="6">Details</th>

Yin-Chia Yeh

2015-02-05 13:19:21 -0800

[diff] [blame]

33746

</tr>

33747

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

33748

Shuzhen Wang

2022-05-03 11:01:26 -0700

[diff] [blame]

33749

The tonemap curve will be defined the following formula:

33750

<ul>

33751

<li>OUT = pow(IN, 1.0 / gamma)</li>

33752

</ul>

33753

where IN and OUT is the input pixel value scaled to range [0.0, 1.0],

Yin-Chia Yeh

2015-02-05 13:19:21 -0800

[diff] [blame]

33754

pow is the power function and gamma is the gamma value specified by this

33755

key.

33756

The same curve will be applied to all color channels. The camera device

33757

may clip the input gamma value to its supported range. The actual applied

33758

value will be returned in capture result.

33759

The valid range of gamma value varies on different devices, but values

33760

within [1.0, 5.0] are guaranteed not to be clipped.

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

33765

Yin-Chia Yeh

2015-02-05 13:19:21 -0800

[diff] [blame]

33766

<td class="entry_name

33771

" rowspan="3">

33772

android.tonemap.presetCurve

</td>

byte

[public]

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

33785

SRGB (v3.2)

Yin-Chia Yeh

2015-02-05 13:19:21 -0800

[diff] [blame]

33786

Tonemapping curve is defined by sRGB

33787

</li>

33788

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

33789

REC709 (v3.2)

Yin-Chia Yeh

2015-02-05 13:19:21 -0800

[diff] [blame]

33790

Tonemapping curve is defined by ITU-R BT.709

</li>

</ul>

</td>

33795

33796

33797

Tonemapping curve to use when <a href="#controls_android.tonemap.mode">android.tonemap.mode</a> is

PRESET_CURVE

</td>

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Yin-Chia Yeh

2015-02-05 13:19:21 -0800

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

33816

<th class="th_details" colspan="6">Details</th>

Yin-Chia Yeh

2015-02-05 13:19:21 -0800

[diff] [blame]

33817

</tr>

33818

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

33819

Yin-Chia Yeh

2015-02-05 13:19:21 -0800

[diff] [blame]

33820

The tonemap curve will be defined by specified standard.

33821

sRGB (approximated by 16 control points):

33822

33823

Rec. 709 (approximated by 16 control points):

33824

33825

Note that above figures show a 16 control points approximation of preset

33826

curves. Camera devices may apply a different approximation to the curve.

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

33831

Yin-Chia Yeh

2015-02-05 13:19:21 -0800

[diff] [blame]

33832

33833

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

</tbody>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

33840

Igor Murashkin

2013-04-23 14:31:02 -0700

[diff] [blame]

33841

33842

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

33843

<tr><td colspan="7" class="kind">controls</td></tr>

Igor Murashkin

2013-04-23 14:31:02 -0700

[diff] [blame]

33844

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

33845

Igor Murashkin

2013-04-23 14:31:02 -0700

[diff] [blame]

33846

<tr>

33847

<th class="th_name">Property Name</th>

33848

33849

<th class="th_description">Description</th>

33850

<th class="th_units">Units</th>

33851

<th class="th_range">Range</th>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

33852

<th class="th_hal_version">Initial HIDL HAL version</th>

Igor Murashkin

2013-04-23 14:31:02 -0700

[diff] [blame]

</tr>

</thead>

<tbody>

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

33869

<td class="entry_name

33870

" rowspan="1">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

33871

android.led.transmit

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

33872

</td>

Igor Murashkin

2013-04-23 14:31:02 -0700

[diff] [blame]

byte

Igor Murashkin

2013-07-17 16:29:34 -0700

[diff] [blame]

33876

[hidden as boolean]

Igor Murashkin

2013-04-23 14:31:02 -0700

[diff] [blame]

33877

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

33881

Igor Murashkin

2013-04-23 14:31:02 -0700

[diff] [blame]

33882

33883

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

33884

OFF (v3.2)

Igor Murashkin

2013-04-23 14:31:02 -0700

[diff] [blame]

33885

</li>

33886

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

33887

ON (v3.2)

Igor Murashkin

2013-04-23 14:31:02 -0700

[diff] [blame]

</li>

</ul>

</td>

33892

33893

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

33894

This LED is nominally used to indicate to the user

Igor Murashkin

2013-12-09 12:06:17 -0800

[diff] [blame]

33895

that the camera is powered on and may be streaming images back to the

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

33896

Application Processor. In certain rare circumstances, the OS may

Igor Murashkin

2013-12-09 12:06:17 -0800

[diff] [blame]

33897

disable this when video is processed locally and not transmitted to

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

33898

any untrusted applications.

33899

In particular, the LED must always be on when the data could be

33900

transmitted off the device. The LED should always be on whenever

33901

data is stored locally on the device.

Igor Murashkin

2013-12-09 12:06:17 -0800

[diff] [blame]

33902

The LED may be off if a trusted application is using the data that

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

33903

doesn't violate the above rules.

Igor Murashkin

2013-04-23 14:31:02 -0700

[diff] [blame]

</td>

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2013-04-23 14:31:02 -0700

[diff] [blame]

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

33919

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

33920

33921

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

33922

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

33923

Igor Murashkin

2013-04-23 14:31:02 -0700

[diff] [blame]

</tbody>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

33929

<tr><td colspan="7" class="kind">dynamic</td></tr>

Igor Murashkin

2013-04-23 14:31:02 -0700

[diff] [blame]

33930

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

33931

Igor Murashkin

2013-04-23 14:31:02 -0700

[diff] [blame]

33932

<tr>

33933

<th class="th_name">Property Name</th>

33934

33935

<th class="th_description">Description</th>

33936

<th class="th_units">Units</th>

33937

<th class="th_range">Range</th>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

33938

<th class="th_hal_version">Initial HIDL HAL version</th>

Igor Murashkin

2013-04-23 14:31:02 -0700

[diff] [blame]

</tr>

</thead>

<tbody>

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

33955

<td class="entry_name

33956

" rowspan="1">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

33957

android.led.transmit

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

33958

</td>

Igor Murashkin

2013-04-23 14:31:02 -0700

[diff] [blame]

byte

Igor Murashkin

2013-07-17 16:29:34 -0700

[diff] [blame]

33962

[hidden as boolean]

Igor Murashkin

2013-04-23 14:31:02 -0700

[diff] [blame]

33963

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

33967

Igor Murashkin

2013-04-23 14:31:02 -0700

[diff] [blame]

33968

33969

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

33970

OFF (v3.2)

Igor Murashkin

2013-04-23 14:31:02 -0700

[diff] [blame]

33971

</li>

33972

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

33973

ON (v3.2)

Igor Murashkin

2013-04-23 14:31:02 -0700

[diff] [blame]

</li>

</ul>

</td>

33978

33979

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

33980

This LED is nominally used to indicate to the user

Igor Murashkin

2013-12-09 12:06:17 -0800

[diff] [blame]

33981

that the camera is powered on and may be streaming images back to the

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

33982

Application Processor. In certain rare circumstances, the OS may

Igor Murashkin

2013-12-09 12:06:17 -0800

[diff] [blame]

33983

disable this when video is processed locally and not transmitted to

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

33984

any untrusted applications.

33985

In particular, the LED must always be on when the data could be

33986

transmitted off the device. The LED should always be on whenever

33987

data is stored locally on the device.

Igor Murashkin

2013-12-09 12:06:17 -0800

[diff] [blame]

33988

The LED may be off if a trusted application is using the data that

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

33989

doesn't violate the above rules.

Igor Murashkin

2013-04-23 14:31:02 -0700

[diff] [blame]

</td>

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2013-04-23 14:31:02 -0700

[diff] [blame]

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

34005

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

34006

34007

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

34008

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

34009

Igor Murashkin

2013-04-23 14:31:02 -0700

[diff] [blame]

</tbody>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

34015

<tr><td colspan="7" class="kind">static</td></tr>

Igor Murashkin

2013-04-23 14:31:02 -0700

[diff] [blame]

34016

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

34017

Igor Murashkin

2013-04-23 14:31:02 -0700

[diff] [blame]

34018

<tr>

34019

<th class="th_name">Property Name</th>

34020

34021

<th class="th_description">Description</th>

34022

<th class="th_units">Units</th>

34023

<th class="th_range">Range</th>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

34024

<th class="th_hal_version">Initial HIDL HAL version</th>

Igor Murashkin

2013-04-23 14:31:02 -0700

[diff] [blame]

</tr>

</thead>

<tbody>

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

34041

<td class="entry_name

34042

" rowspan="1">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

34043

android.led.availableLeds

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

34044

</td>

Igor Murashkin

2013-04-23 14:31:02 -0700

[diff] [blame]

byte

x

n

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

34052

[hidden]

Igor Murashkin

2013-04-23 14:31:02 -0700

[diff] [blame]

34053

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

34057

Igor Murashkin

2013-04-23 14:31:02 -0700

[diff] [blame]

34058

34059

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

34060

TRANSMIT (v3.2)

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

34061

<a href="#controls_android.led.transmit">android.led.transmit</a> control is used.

Igor Murashkin

2013-04-23 14:31:02 -0700

[diff] [blame]

</li>

</ul>

</td>

34066

34067

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

34068

A list of camera LEDs that are available on this system.

Igor Murashkin

2013-04-23 14:31:02 -0700

[diff] [blame]

</td>

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2013-04-23 14:31:02 -0700

[diff] [blame]

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

34084

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

34085

34086

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

34087

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

34088

Igor Murashkin

2013-04-23 14:31:02 -0700

[diff] [blame]

</tbody>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

34096

Igor Murashkin

2013-05-23 16:38:59 -0700

[diff] [blame]

34097

34098

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

34099

<tr><td colspan="7" class="kind">static</td></tr>

Igor Murashkin

2013-05-23 16:38:59 -0700

[diff] [blame]

34100

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

34101

Igor Murashkin

2013-05-23 16:38:59 -0700

[diff] [blame]

34102

<tr>

34103

<th class="th_name">Property Name</th>

34104

34105

<th class="th_description">Description</th>

34106

<th class="th_units">Units</th>

34107

<th class="th_range">Range</th>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

34108

<th class="th_hal_version">Initial HIDL HAL version</th>

Igor Murashkin

2013-05-23 16:38:59 -0700

[diff] [blame]

</tr>

</thead>

<tbody>

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

34125

<td class="entry_name

34126

" rowspan="5">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

34127

android.info.supportedHardwareLevel

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

34128

</td>

Igor Murashkin

2013-05-23 16:38:59 -0700

[diff] [blame]

byte

Eino-Ville Talvala

2013-07-16 16:18:44 -0700

[diff] [blame]

34132

[public]

Igor Murashkin

2013-05-23 16:38:59 -0700

[diff] [blame]

34133

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

34134

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

34135

[legacy]

34136

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

34137

34138

Igor Murashkin

2013-05-23 16:38:59 -0700

[diff] [blame]

34139

34140

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

34141

LIMITED (v3.2)

Eino-Ville Talvala

2016-01-21 12:23:56 -0800

[diff] [blame]

34142

This camera device does not have enough capabilities to qualify as a <code>FULL</code> device or

34143

better.

34144

Only the stream configurations listed in the <code>LEGACY</code> and <code>LIMITED</code> tables in the

34145

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraDevice.html#createCaptureSession">createCaptureSession</a> documentation are guaranteed to be supported.

34146

All <code>LIMITED</code> devices support the <code>BACKWARDS_COMPATIBLE</code> capability, indicating basic

34147

support for color image capture. The only exception is that the device may

34148

alternatively support only the <code>DEPTH_OUTPUT</code> capability, if it can only output depth

34149

measurements and not color images.

34150

<code>LIMITED</code> devices and above require the use of <a href="#controls_android.control.aePrecaptureTrigger">android.control.aePrecaptureTrigger</a>

34151

to lock exposure metering (and calculate flash power, for cameras with flash) before

34152

capturing a high-quality still image.

34153

A <code>LIMITED</code> device that only lists the <code>BACKWARDS_COMPATIBLE</code> capability is only

34154

required to support full-automatic operation and post-processing (<code>OFF</code> is not

34155

supported for <a href="#controls_android.control.aeMode">android.control.aeMode</a>, <a href="#controls_android.control.afMode">android.control.afMode</a>, or

34156

<a href="#controls_android.control.awbMode">android.control.awbMode</a>)

34157

Additional capabilities may optionally be supported by a <code>LIMITED</code>-level device, and

34158

can be checked for in <a href="#static_android.request.availableCapabilities">android.request.availableCapabilities</a>.

Igor Murashkin

2013-05-23 16:38:59 -0700

[diff] [blame]

34159

</li>

34160

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

34161

FULL (v3.2)

Eino-Ville Talvala

2016-01-21 12:23:56 -0800

[diff] [blame]

34162

This camera device is capable of supporting advanced imaging applications.

34163

The stream configurations listed in the <code>FULL</code>, <code>LEGACY</code> and <code>LIMITED</code> tables in the

34164

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraDevice.html#createCaptureSession">createCaptureSession</a> documentation are guaranteed to be supported.

34165

A <code>FULL</code> device will support below capabilities:

34166

<ul>

34167

<li><code>BURST_CAPTURE</code> capability (<a href="#static_android.request.availableCapabilities">android.request.availableCapabilities</a> contains

34168

<code>BURST_CAPTURE</code>)</li>

34169

<li>Per frame control (<a href="#static_android.sync.maxLatency">android.sync.maxLatency</a> <code>==</code> PER_FRAME_CONTROL)</li>

34170

<li>Manual sensor control (<a href="#static_android.request.availableCapabilities">android.request.availableCapabilities</a> contains <code>MANUAL_SENSOR</code>)</li>

34171

<li>Manual post-processing control (<a href="#static_android.request.availableCapabilities">android.request.availableCapabilities</a> contains

34172

<code>MANUAL_POST_PROCESSING</code>)</li>

34173

<li>The required exposure time range defined in <a href="#static_android.sensor.info.exposureTimeRange">android.sensor.info.exposureTimeRange</a></li>

34174

<li>The required maxFrameDuration defined in <a href="#static_android.sensor.info.maxFrameDuration">android.sensor.info.maxFrameDuration</a></li>

34175

</ul>

34176

Note:

34177

Pre-API level 23, FULL devices also supported arbitrary cropping region

34178

(<a href="#static_android.scaler.croppingType">android.scaler.croppingType</a> <code>== FREEFORM</code>); this requirement was relaxed in API level

34179

23, and <code>FULL</code> devices may only support <code>CENTERED</code> cropping.

Ruben Brunk

31b50c2

2014-07-02 00:13:46 +0000

[diff] [blame]

34180

</li>

34181

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

34182

LEGACY (v3.2)

Eino-Ville Talvala

2016-01-21 12:23:56 -0800

[diff] [blame]

34183

This camera device is running in backward compatibility mode.

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

34184

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> documentation are supported.

Eino-Ville Talvala

2016-01-21 12:23:56 -0800

[diff] [blame]

34185

A <code>LEGACY</code> device does not support per-frame control, manual sensor control, manual

34186

post-processing, arbitrary cropping regions, and has relaxed performance constraints.

34187

No additional capabilities beyond <code>BACKWARD_COMPATIBLE</code> will ever be listed by a

34188

<code>LEGACY</code> device in <a href="#static_android.request.availableCapabilities">android.request.availableCapabilities</a>.

34189

In addition, the <a href="#controls_android.control.aePrecaptureTrigger">android.control.aePrecaptureTrigger</a> is not functional on <code>LEGACY</code>

34190

devices. Instead, every request that includes a JPEG-format output target is treated

34191

as triggering a still capture, internally executing a precapture trigger. This may

34192

fire the flash for flash power metering during precapture, and then fire the flash

34193

for the final capture, if a flash is available on the device and the AE mode is set to

Eino-Ville Talvala

dde54ae

2019-04-10 17:28:26 -0700

[diff] [blame]

34194

enable the flash.

Shuzhen Wang

2022-06-13 09:42:11 -0700

[diff] [blame]

34195

Devices that initially shipped with Android version <a href="https://developer.android.com/reference/android/os/Build.VERSION_CODES.html#Q">Q</a> or newer will not include any LEGACY-level devices.

Eino-Ville Talvala

2016-01-21 12:23:56 -0800

[diff] [blame]

34196

</li>

34197

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

34198

3 (v3.2)

Eino-Ville Talvala

2016-01-21 12:23:56 -0800

[diff] [blame]

34199

This camera device is capable of YUV reprocessing and RAW data capture, in addition to

34200

FULL-level capabilities.

34201

The stream configurations listed in the <code>LEVEL_3</code>, <code>RAW</code>, <code>FULL</code>, <code>LEGACY</code> and

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

34202

<code>LIMITED</code> tables in the <a href="https://developer.android.com/reference/android/hardware/camera2/CameraDevice.html#createCaptureSession">createCaptureSession</a> documentation are guaranteed to be supported.

Eino-Ville Talvala

2016-01-21 12:23:56 -0800

[diff] [blame]

34203

The following additional capabilities are guaranteed to be supported:

34204

<ul>

34205

<li><code>YUV_REPROCESSING</code> capability (<a href="#static_android.request.availableCapabilities">android.request.availableCapabilities</a> contains

34206

<code>YUV_REPROCESSING</code>)</li>

34207

<li><code>RAW</code> capability (<a href="#static_android.request.availableCapabilities">android.request.availableCapabilities</a> contains

34208

34209

</ul>

Igor Murashkin

2013-05-23 16:38:59 -0700

[diff] [blame]

34210

</li>

Yin-Chia Yeh

eef3922

2018-01-19 11:32:19 -0800

[diff] [blame]

34211

<li>

34212

EXTERNAL (v3.3)

34213

This camera device is backed by an external camera connected to this Android device.

34214

The device has capability identical to a LIMITED level device, with the following

34215

exceptions:

34216

<ul>

34217

<li>The device may not report lens/sensor related information such as<ul>

34218

<li><a href="#controls_android.lens.focalLength">android.lens.focalLength</a></li>

34219

<li><a href="#static_android.lens.info.hyperfocalDistance">android.lens.info.hyperfocalDistance</a></li>

34220

<li><a href="#static_android.sensor.info.physicalSize">android.sensor.info.physicalSize</a></li>

34221

<li><a href="#static_android.sensor.info.whiteLevel">android.sensor.info.whiteLevel</a></li>

34222

<li><a href="#static_android.sensor.blackLevelPattern">android.sensor.blackLevelPattern</a></li>

34223

<li><a href="#static_android.sensor.info.colorFilterArrangement">android.sensor.info.colorFilterArrangement</a></li>

34224

<li><a href="#dynamic_android.sensor.rollingShutterSkew">android.sensor.rollingShutterSkew</a></li>

34225

</ul>

34226

</li>

34227

<li>The device will report 0 for <a href="#static_android.sensor.orientation">android.sensor.orientation</a></li>

34228

<li>The device has less guarantee on stable framerate, as the framerate partly depends

34229

on the external camera being used.</li>

34230

</ul>

34231

</li>

Igor Murashkin

2013-05-23 16:38:59 -0700

[diff] [blame]

34232

</ul>

34233

34234

</td>

34235

34236

Igor Murashkin

2014-02-06 15:35:37 -0800

[diff] [blame]

34237

Generally classifies the overall set of the camera device functionality.

Igor Murashkin

2013-05-23 16:38:59 -0700

[diff] [blame]

</td>

</td>

Igor Murashkin

2013-05-23 16:38:59 -0700

[diff] [blame]

34244

</td>

34245

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2013-05-23 16:38:59 -0700

[diff] [blame]

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

34253

</tr>

Igor Murashkin

2014-02-06 15:35:37 -0800

[diff] [blame]

34254

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

34255

<th class="th_details" colspan="6">Details</th>

Igor Murashkin

2014-02-06 15:35:37 -0800

[diff] [blame]

34256

</tr>

34257

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

34258

Eino-Ville Talvala

2016-01-21 12:23:56 -0800

[diff] [blame]

34259

The supported hardware level is a high-level description of the camera device's

34260

capabilities, summarizing several capabilities into one field. Each level adds additional

34261

features to the previous one, and is always a strict superset of the previous level.

34262

The ordering is <code>LEGACY < LIMITED < FULL < LEVEL_3</code>.

34263

Starting from <code>LEVEL_3</code>, the level enumerations are guaranteed to be in increasing

34264

numerical value as well. To check if a given device is at least at a given hardware level,

34265

the following code snippet can be used:

34266

<pre><code>// Returns true if the device supports the required hardware level, or better.

34267

boolean isHardwareLevelSupported(CameraCharacteristics c, int requiredLevel) {

Yin-Chia Yeh

2018-07-13 11:49:10 -0700

[diff] [blame]

34268

final int[] sortedHwLevels = {

34269

CameraCharacteristics.INFO_SUPPORTED_HARDWARE_LEVEL_LEGACY,

34270

CameraCharacteristics.INFO_SUPPORTED_HARDWARE_LEVEL_EXTERNAL,

34271

CameraCharacteristics.INFO_SUPPORTED_HARDWARE_LEVEL_LIMITED,

34272

CameraCharacteristics.INFO_SUPPORTED_HARDWARE_LEVEL_FULL,

34273

CameraCharacteristics.INFO_SUPPORTED_HARDWARE_LEVEL_3

34274

};

Eino-Ville Talvala

2016-01-21 12:23:56 -0800

[diff] [blame]

34275

int deviceLevel = c.get(CameraCharacteristics.INFO_SUPPORTED_HARDWARE_LEVEL);

Yin-Chia Yeh

2018-07-13 11:49:10 -0700

[diff] [blame]

34276

if (requiredLevel == deviceLevel) {

34277

return true;

Eino-Ville Talvala

2016-01-21 12:23:56 -0800

[diff] [blame]

34278

}

Yin-Chia Yeh

2018-07-13 11:49:10 -0700

[diff] [blame]

34279

34280

for (int sortedlevel : sortedHwLevels) {

34281

if (sortedlevel == requiredLevel) {

34282

return true;

34283

} else if (sortedlevel == deviceLevel) {

return false;

}

}

return false; // Should never reach here

Eino-Ville Talvala

2016-01-21 12:23:56 -0800

[diff] [blame]

34288

}

34289

</code></pre>

34290

At a high level, the levels are:

Igor Murashkin

2014-02-06 15:35:37 -0800

[diff] [blame]

34291

<ul>

Eino-Ville Talvala

2016-01-21 12:23:56 -0800

[diff] [blame]

34292

<li><code>LEGACY</code> devices operate in a backwards-compatibility mode for older

34293

Android devices, and have very limited capabilities.</li>

34294

<li><code>LIMITED</code> devices represent the

34295

baseline feature set, and may also include additional capabilities that are

34296

subsets of <code>FULL</code>.</li>

34297

<li><code>FULL</code> devices additionally support per-frame manual control of sensor, flash, lens and

34298

post-processing settings, and image capture at a high rate.</li>

34299

<li><code>LEVEL_3</code> devices additionally support YUV reprocessing and RAW image capture, along

34300

with additional output stream configurations.</li>

Yin-Chia Yeh

2018-07-13 11:49:10 -0700

[diff] [blame]

34301

<li><code>EXTERNAL</code> devices are similar to <code>LIMITED</code> devices with exceptions like some sensor or

Yin-Chia Yeh

6023126

2019-01-23 15:25:41 -0800

[diff] [blame]

34302

lens information not reported or less stable framerates.</li>

Igor Murashkin

2014-02-06 15:35:37 -0800

[diff] [blame]

34303

</ul>

Eino-Ville Talvala

2016-01-21 12:23:56 -0800

[diff] [blame]

34304

See the individual level enums for full descriptions of the supported capabilities. The

34305

<a href="#static_android.request.availableCapabilities">android.request.availableCapabilities</a> entry describes the device's capabilities at a

34306

finer-grain level, if needed. In addition, many controls have their available settings or

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

34307

ranges defined in individual entries from <a href="https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics.html">CameraCharacteristics</a>.

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

34308

Some features are not part of any particular hardware level or capability and must be

34309

queried separately. These include:

34310

<ul>

34311

<li>Calibrated timestamps (<a href="#static_android.sensor.info.timestampSource">android.sensor.info.timestampSource</a> <code>==</code> REALTIME)</li>

34312

<li>Precision lens control (<a href="#static_android.lens.info.focusDistanceCalibration">android.lens.info.focusDistanceCalibration</a> <code>==</code> CALIBRATED)</li>

34313

<li>Face detection (<a href="#static_android.statistics.info.availableFaceDetectModes">android.statistics.info.availableFaceDetectModes</a>)</li>

34314

<li>Optical or electrical image stabilization

34315

(<a href="#static_android.lens.info.availableOpticalStabilization">android.lens.info.availableOpticalStabilization</a>,

34316

<a href="#static_android.control.availableVideoStabilizationModes">android.control.availableVideoStabilizationModes</a>)</li>

34317

</ul>

Igor Murashkin

2014-02-06 15:35:37 -0800

[diff] [blame]

34318

</td>

34319

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

34320

Igor Murashkin

2014-02-06 15:35:37 -0800

[diff] [blame]

34321

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

34322

<th class="th_details" colspan="6">HAL Implementation Details</th>

Igor Murashkin

2014-02-06 15:35:37 -0800

[diff] [blame]

34323

</tr>

34324

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

34325

34326

A camera HALv3 device can implement one of three possible operational modes; LIMITED,

Eino-Ville Talvala

2016-01-21 12:23:56 -0800

[diff] [blame]

34327

FULL, and LEVEL_3.

34328

FULL support or better is expected from new higher-end devices. Limited

34329

mode has hardware requirements roughly in line with those for a camera HAL device v1

34330

implementation, and is expected from older or inexpensive devices. Each level is a strict

34331

superset of the previous level, and they share the same essential operational flow.

Igor Murashkin

2014-02-06 15:35:37 -0800

[diff] [blame]

34332

For full details refer to "S3. Operational Modes" in camera3.h

Eino-Ville Talvala

2016-01-21 12:23:56 -0800

[diff] [blame]

34333

Camera HAL3+ must not implement LEGACY mode. It is there for backwards compatibility in

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

34334

the <code>android.hardware.camera2</code> user-facing API only on legacy HALv1 devices, and is

34335

implemented by the camera framework code.

Shuzhen Wang

2022-05-03 11:01:26 -0700

[diff] [blame]

34336

EXTERNAL level devices have lower performance bar in CTS since the performance might depend

Yin-Chia Yeh

eef3922

2018-01-19 11:32:19 -0800

[diff] [blame]

34337

on the external camera being used and is not fully controlled by the device manufacturer.

34338

The ITS test suite is exempted for the same reason.

Igor Murashkin

2014-02-06 15:35:37 -0800

[diff] [blame]

34339

</td>

34340

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

34341

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

34342

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

34343

Igor Murashkin

2013-05-23 16:38:59 -0700

[diff] [blame]

34344

Chien-Yu Chen

218925a

2018-01-03 12:04:48 -0800

[diff] [blame]

34345

34346

34347

<td class="entry_name

" rowspan="5">

android.info.version

</td>

byte

[public as string]

</td>

34362

34363

34364

A short string for manufacturer version information about the camera device, such as

34365

ISP hardware, sensors, etc.

</td>

</td>

</td>

3.3

</td>

</td>

</tr>

<th class="th_details" colspan="6">Details</th>

</tr>

This can be used in <a href="https://developer.android.com/reference/android/media/ExifInterface.html#TAG_IMAGE_DESCRIPTION">TAG_IMAGE_DESCRIPTION</a>

34388

in jpeg EXIF. This key may be absent if no version information is available on the

device.

</td>

</tr>

<th class="th_details" colspan="6">HAL Implementation Details</th>

</tr>

The string must consist of only alphanumeric characters, punctuation, and

34399

whitespace, i.e. it must match regular expression "[\p{Alnum}\p{Punct}\p{Space}]*".

34400

It must not exceed 256 characters.

</td>

</tr>

34406

Yin-Chia Yeh

5fd3886

2018-09-17 11:52:08 -0700

[diff] [blame]

34407

34408

34409

<td class="entry_name

34410

" rowspan="3">

34411

android.info.supportedBufferManagementVersion

</td>

byte

[system]

<li>

HIDL_DEVICE_3_5 (v3.4)

34425

This camera device supports and opts in to the buffer management APIs provided by

34426

HIDL ICameraDevice version 3.5.

</li>

</ul>

</td>

34431

34432

34433

The version of buffer management API this camera device supports and opts into.

</td>

</td>

</td>

3.4

</td>

</td>

</tr>

<th class="th_details" colspan="6">Details</th>

</tr>

When this key is not present, camera framework will interact with this camera device

34456

without any buffer management HAL API. When this key is present and camera framework

34457

supports the buffer management API version, camera framework will interact with camera

34458

HAL using such version of buffer management API.

</td>

</tr>

34465

Emilian Peev

2021-09-24 17:45:05 -0700

[diff] [blame]

34466

Emilian Peev

2021-10-12 13:11:27 -0700

[diff] [blame]

34467

Emilian Peev

2021-09-24 17:45:05 -0700

[diff] [blame]

34468

<td class="entry_name

34469

" rowspan="3">

Emilian Peev

2021-10-12 13:11:27 -0700

[diff] [blame]

34470

android.info.deviceStateSensorOrientationMap

Emilian Peev

2021-09-24 17:45:05 -0700

[diff] [blame]

</td>

int64

Emilian Peev

2021-10-12 13:11:27 -0700

[diff] [blame]

34475

[java_public as deviceStateSensorOrientationMap]

Emilian Peev

2021-09-24 17:45:05 -0700

[diff] [blame]

[synthetic]

[limited]

</td>

34485

34486

34487

This lists the mapping between a device folding state and

34488

specific camera sensor orientation for logical cameras on a foldable device.

</td>

</td>

</td>

3.2

</td>

</td>

</tr>

<th class="th_details" colspan="6">Details</th>

</tr>

Logical cameras on foldable devices can support sensors with different orientation

34511

values. The orientation value may need to change depending on the specific folding

34512

state. Information about the mapping between the device folding state and the

34513

sensor orientation can be obtained in

Emilian Peev

2021-10-12 13:11:27 -0700

[diff] [blame]

34514

<a href="https://developer.android.com/reference/android/hardware/camera2/params/DeviceStateSensorOrientationMap.html">DeviceStateSensorOrientationMap</a>.

Emilian Peev

2021-09-24 17:45:05 -0700

[diff] [blame]

34515

Device state orientation maps are optional and maybe present on devices that support

34516

<a href="#controls_android.scaler.rotateAndCrop">android.scaler.rotateAndCrop</a>.

</td>

</tr>

<td class="entry_name

34527

" rowspan="3">

34528

android.info.deviceStateOrientations

</td>

int64

x

2 x n

[ndk_public]

[limited]

</td>

</td>

(device fold state, sensor orientation) x n

</td>

</td>

3.7

</td>

</td>

</tr>

<th class="th_details" colspan="6">Details</th>

</tr>

HAL must populate the array with

34571

(hardware::camera::provider::V2_5::DeviceState, sensorOrientation) pairs for each

34572

supported device state bitwise combination.

</td>

</tr>

34579

Igor Murashkin

2013-05-23 16:38:59 -0700

[diff] [blame]

</tbody>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

34586

<tr><td colspan="7" id="section_blackLevel" class="section">blackLevel</td></tr>

Zhijun He

2013-07-17 09:42:58 -0700

[diff] [blame]

34587

34588

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

34589

<tr><td colspan="7" class="kind">controls</td></tr>

Zhijun He

2013-07-17 09:42:58 -0700

[diff] [blame]

<tr>

<th class="th_name">Property Name</th>

34594

34595

<th class="th_description">Description</th>

34596

<th class="th_units">Units</th>

34597

<th class="th_range">Range</th>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

34598

<th class="th_hal_version">Initial HIDL HAL version</th>

Zhijun He

2013-07-17 09:42:58 -0700

[diff] [blame]

</tr>

</thead>

<tbody>

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

34615

<td class="entry_name

34616

" rowspan="5">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

34617

android.blackLevel.lock

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

34618

</td>

Zhijun He

2013-07-17 09:42:58 -0700

[diff] [blame]

byte

Igor Murashkin

2013-07-17 16:29:34 -0700

[diff] [blame]

34622

[public as boolean]

Zhijun He

2013-07-17 09:42:58 -0700

[diff] [blame]

34623

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

34624

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

34625

[full]

34626

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

34627

34628

Zhijun He

2013-07-17 09:42:58 -0700

[diff] [blame]

34629

34630

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

34631

OFF (v3.2)

Zhijun He

2013-07-17 09:42:58 -0700

[diff] [blame]

34632

</li>

34633

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

34634

ON (v3.2)

Zhijun He

2013-07-17 09:42:58 -0700

[diff] [blame]

</li>

</ul>

</td>

34639

34640

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

34641

Whether black-level compensation is locked

34642

to its current values, or is free to vary.

Zhijun He

2013-07-17 09:42:58 -0700

[diff] [blame]

</td>

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

</ul>

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

34663

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

34664

</tr>

34665

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

34666

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

34667

When set to <code>true</code> (ON), the values used for black-level

Eino-Ville Talvala

2013-12-26 13:16:54 -0800

[diff] [blame]

34668

compensation will not change until the lock is set to

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

34669

<code>false</code> (OFF).

Igor Murashkin

2013-12-09 12:06:17 -0800

[diff] [blame]

34670

Since changes to certain capture parameters (such as

34671

exposure time) may require resetting of black level

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

34672

compensation, the camera device must report whether setting

Eino-Ville Talvala

2013-12-26 13:16:54 -0800

[diff] [blame]

34673

the black level lock was successful in the output result

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

34674

metadata.

34675

For example, if a sequence of requests is as follows:

Igor Murashkin

2013-12-09 12:06:17 -0800

[diff] [blame]

34676

<ul>

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

34677

<li>Request 1: Exposure = 10ms, Black level lock = OFF</li>

34678

<li>Request 2: Exposure = 10ms, Black level lock = ON</li>

34679

<li>Request 3: Exposure = 10ms, Black level lock = ON</li>

34680

<li>Request 4: Exposure = 20ms, Black level lock = ON</li>

34681

<li>Request 5: Exposure = 20ms, Black level lock = ON</li>

34682

<li>Request 6: Exposure = 20ms, Black level lock = ON</li>

Igor Murashkin

2013-12-09 12:06:17 -0800

[diff] [blame]

34683

</ul>

Eino-Ville Talvala

2013-12-26 13:16:54 -0800

[diff] [blame]

34684

And the exposure change in Request 4 requires the camera

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

34685

device to reset the black level offsets, then the output

Eino-Ville Talvala

2013-12-26 13:16:54 -0800

[diff] [blame]

34686

result metadata is expected to be:

Igor Murashkin

2013-12-09 12:06:17 -0800

[diff] [blame]

34687

<ul>

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

34688

<li>Result 1: Exposure = 10ms, Black level lock = OFF</li>

34689

<li>Result 2: Exposure = 10ms, Black level lock = ON</li>

34690

<li>Result 3: Exposure = 10ms, Black level lock = ON</li>

34691

<li>Result 4: Exposure = 20ms, Black level lock = OFF</li>

34692

<li>Result 5: Exposure = 20ms, Black level lock = ON</li>

34693

<li>Result 6: Exposure = 20ms, Black level lock = ON</li>

Igor Murashkin

2013-12-09 12:06:17 -0800

[diff] [blame]

34694

</ul>

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

34695

This indicates to the application that on frame 4, black

34696

levels were reset due to exposure value changes, and pixel

34697

values may not be consistent across captures.

Eino-Ville Talvala

2013-12-26 13:16:54 -0800

[diff] [blame]

34698

The camera device will maintain the lock to the extent

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

34699

possible, only overriding the lock to OFF when changes to

Eino-Ville Talvala

2013-12-26 13:16:54 -0800

[diff] [blame]

34700

other request parameters require a black level recalculation

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

34701

or reset.

Zhijun He

2013-07-17 09:42:58 -0700

[diff] [blame]

34702

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

34703

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

34704

Eino-Ville Talvala

2013-12-26 13:16:54 -0800

[diff] [blame]

34705

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

34706

<th class="th_details" colspan="6">HAL Implementation Details</th>

Eino-Ville Talvala

2013-12-26 13:16:54 -0800

[diff] [blame]

34707

</tr>

34708

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

34709

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

34710

If for some reason black level locking is no longer possible

34711

(for example, the analog gain has changed, which forces

34712

black level offsets to be recalculated), then the HAL must

Eino-Ville Talvala

2013-12-26 13:16:54 -0800

[diff] [blame]

34713

override this request (and it must report 'OFF' when this

34714

does happen) until the next capture for which locking is

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

34715

possible again.

Eino-Ville Talvala

2013-12-26 13:16:54 -0800

[diff] [blame]

34716

</td>

34717

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

34718

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

34719

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

34720

Zhijun He

2013-07-17 09:42:58 -0700

[diff] [blame]

</tbody>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

34726

<tr><td colspan="7" class="kind">dynamic</td></tr>

Zhijun He

2013-07-17 09:42:58 -0700

[diff] [blame]

<tr>

<th class="th_name">Property Name</th>

34731

34732

<th class="th_description">Description</th>

34733

<th class="th_units">Units</th>

34734

<th class="th_range">Range</th>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

34735

<th class="th_hal_version">Initial HIDL HAL version</th>

Zhijun He

2013-07-17 09:42:58 -0700

[diff] [blame]

</tr>

</thead>

<tbody>

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

34752

<td class="entry_name

34753

" rowspan="5">

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

34754

android.blackLevel.lock

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

34755

</td>

Zhijun He

2013-07-17 09:42:58 -0700

[diff] [blame]

byte

Igor Murashkin

2013-07-17 16:29:34 -0700

[diff] [blame]

34759

[public as boolean]

Zhijun He

2013-07-17 09:42:58 -0700

[diff] [blame]

34760

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

34761

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

34762

[full]

34763

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

34764

34765

Zhijun He

2013-07-17 09:42:58 -0700

[diff] [blame]

34766

34767

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

34768

OFF (v3.2)

Zhijun He

2013-07-17 09:42:58 -0700

[diff] [blame]

34769

</li>

34770

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

34771

ON (v3.2)

Zhijun He

2013-07-17 09:42:58 -0700

[diff] [blame]

</li>

</ul>

</td>

34776

34777

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

34778

Whether black-level compensation is locked

34779

to its current values, or is free to vary.

Zhijun He

2013-07-17 09:42:58 -0700

[diff] [blame]

</td>

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Zhijun He

2013-07-17 09:42:58 -0700

[diff] [blame]

</ul>

</td>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

34798

</tr>

34799

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

34800

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

34801

</tr>

34802

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

34803

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

34804

Whether the black level offset was locked for this frame. Should be

Eino-Ville Talvala

2014-01-02 16:11:44 -0800

[diff] [blame]

34805

ON if <a href="#controls_android.blackLevel.lock">android.blackLevel.lock</a> was ON in the capture request, unless

Eino-Ville Talvala

2013-12-26 13:16:54 -0800

[diff] [blame]

34806

a change in other capture settings forced the camera device to

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

34807

perform a black level reset.

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

34808

</td>

34809

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

34810

Eino-Ville Talvala

2013-12-26 13:16:54 -0800

[diff] [blame]

34811

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

34812

<th class="th_details" colspan="6">HAL Implementation Details</th>

Eino-Ville Talvala

2013-12-26 13:16:54 -0800

[diff] [blame]

34813

</tr>

34814

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

34815

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

34816

If for some reason black level locking is no longer possible

34817

(for example, the analog gain has changed, which forces

34818

black level offsets to be recalculated), then the HAL must

Eino-Ville Talvala

2013-12-26 13:16:54 -0800

[diff] [blame]

34819

override this request (and it must report 'OFF' when this

34820

does happen) until the next capture for which locking is

Igor Murashkin

2013-12-27 15:30:25 -0800

[diff] [blame]

34821

possible again.

Eino-Ville Talvala

2013-12-26 13:16:54 -0800

[diff] [blame]

34822

</td>

34823

</tr>

Eino-Ville Talvala

2013-12-27 13:50:19 -0800

[diff] [blame]

34824

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

34825

Eino-Ville Talvala

2013-12-26 12:06:13 -0800

[diff] [blame]

34826

Zhijun He

2013-07-17 09:42:58 -0700

[diff] [blame]

</tbody>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

34834

Igor Murashkin

2014-01-16 17:51:36 -0800

[diff] [blame]

34835

34836

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

34837

<tr><td colspan="7" class="kind">dynamic</td></tr>

Igor Murashkin

2014-01-16 17:51:36 -0800

[diff] [blame]

<tr>

<th class="th_name">Property Name</th>

34842

34843

<th class="th_description">Description</th>

34844

<th class="th_units">Units</th>

34845

<th class="th_range">Range</th>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

34846

<th class="th_hal_version">Initial HIDL HAL version</th>

Igor Murashkin

2014-01-16 17:51:36 -0800

[diff] [blame]

</tr>

</thead>

<tbody>

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

34863

<td class="entry_name

34864

" rowspan="5">

Igor Murashkin

2014-01-16 17:51:36 -0800

[diff] [blame]

34865

android.sync.frameNumber

</td>

int64

Yin-Chia Yeh

2016-04-02 16:30:30 -0700

[diff] [blame]

34870

[ndk_public]

Igor Murashkin

2014-01-16 17:51:36 -0800

[diff] [blame]

34871

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

34872

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

34873

[legacy]

34874

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

34875

34876

Igor Murashkin

2014-01-16 17:51:36 -0800

[diff] [blame]

34877

34878

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

34879

CONVERGING (v3.2)

Igor Murashkin

2014-01-16 17:51:36 -0800

[diff] [blame]

34880

-1

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

34881

The current result is not yet fully synchronized to any request.

34882

Synchronization is in progress, and reading metadata from this

Igor Murashkin

2014-01-16 17:51:36 -0800

[diff] [blame]

34883

result may include a mix of data that have taken effect since the

34884

last synchronization time.

34885

In some future result, within <a href="#static_android.sync.maxLatency">android.sync.maxLatency</a> frames,

34886

this value will update to the actual frame number frame number

34887

the result is guaranteed to be synchronized to (as long as the

34888

request settings remain constant).

34889

</li>

34890

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

34891

UNKNOWN (v3.2)

Igor Murashkin

2014-01-16 17:51:36 -0800

[diff] [blame]

34892

-2

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

34893

The current result's synchronization status is unknown.

34894

The result may have already converged, or it may be in

34895

progress. Reading from this result may include some mix

34896

of settings from past requests.

Igor Murashkin

2014-01-16 17:51:36 -0800

[diff] [blame]

34897

After a settings change, the new settings will eventually all

34898

take effect for the output buffers and results. However, this

34899

value will not change when that happens. Altering settings

34900

rapidly may provide outcomes using mixes of settings from recent

34901

requests.

34902

This value is intended primarily for backwards compatibility with

34903

the older camera implementations (for android.hardware.Camera).

</li>

</ul>

</td>

34908

34909

34910

The frame number corresponding to the last request

34911

with which the output result (metadata + buffers) has been fully

synchronized.

</td>

</td>

Either a non-negative value corresponding to a

34920

<code>frame_number</code>, or one of the two enums (CONVERGING / UNKNOWN).

34921

</td>

34922

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2014-01-16 17:51:36 -0800

[diff] [blame]

34927

34928

Zhijun He

2014-05-21 17:51:05 -0700

[diff] [blame]

34929

Igor Murashkin

2014-01-16 17:51:36 -0800

[diff] [blame]

</ul>

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

34935

<th class="th_details" colspan="6">Details</th>

Igor Murashkin

2014-01-16 17:51:36 -0800

[diff] [blame]

34936

</tr>

34937

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

34938

Igor Murashkin

2014-01-16 17:51:36 -0800

[diff] [blame]

34939

When a request is submitted to the camera device, there is usually a

34940

delay of several frames before the controls get applied. A camera

34941

device may either choose to account for this delay by implementing a

34942

pipeline and carefully submit well-timed atomic control updates, or

34943

it may start streaming control changes that span over several frame

34944

boundaries.

34945

In the latter case, whenever a request's settings change relative to

34946

the previous submitted request, the full set of changes may take

34947

multiple frame durations to fully take effect. Some settings may

34948

take effect sooner (in less frame durations) than others.

34949

While a set of control changes are being propagated, this value

34950

will be CONVERGING.

34951

Once it is fully known that a set of control changes have been

34952

finished propagating, and the resulting updated control settings

34953

have been read back by the camera device, this value will be set

34954

to a non-negative frame number (corresponding to the request to

34955

which the results have synchronized to).

34956

Older camera device implementations may not have a way to detect

34957

when all camera controls have been applied, and will always set this

34958

value to UNKNOWN.

34959

FULL capability devices will always have this value set to the

34960

frame number of the request corresponding to this result.

34961

Further details:

34962

<ul>

34963

<li>Whenever a request differs from the last request, any future

34964

results not yet returned may have this value set to CONVERGING (this

34965

could include any in-progress captures not yet returned by the camera

34966

device, for more details see pipeline considerations below).</li>

34967

<li>Submitting a series of multiple requests that differ from the

34968

previous request (e.g. r1, r2, r3 s.t. r1 != r2 != r3)

34969

moves the new synchronization frame to the last non-repeating

34970

request (using the smallest frame number from the contiguous list of

34971

repeating requests).</li>

34972

<li>Submitting the same request repeatedly will not change this value

34973

to CONVERGING, if it was already a non-negative value.</li>

34974

<li>When this value changes to non-negative, that means that all of the

34975

metadata controls from the request have been applied, all of the

34976

metadata controls from the camera device have been read to the

34977

updated values (into the result), and all of the graphics buffers

34978

corresponding to this result are also synchronized to the request.</li>

34979

</ul>

34980

Pipeline considerations:

34981

Submitting a request with updated controls relative to the previously

34982

submitted requests may also invalidate the synchronization state

34983

of all the results corresponding to currently in-flight requests.

34984

In other words, results for this current request and up to

34985

<a href="#static_android.request.pipelineMaxDepth">android.request.pipelineMaxDepth</a> prior requests may have their

34986

<a href="#dynamic_android.sync.frameNumber">android.sync.frameNumber</a> change to CONVERGING.

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

34991

<th class="th_details" colspan="6">HAL Implementation Details</th>

Igor Murashkin

2014-01-16 17:51:36 -0800

[diff] [blame]

34992

</tr>

34993

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

34994

Eino-Ville Talvala

2014-02-10 12:39:35 -0800

[diff] [blame]

34995

Using UNKNOWN here is illegal unless <a href="#static_android.sync.maxLatency">android.sync.maxLatency</a>

Igor Murashkin

2014-01-16 17:51:36 -0800

[diff] [blame]

34996

is also UNKNOWN.

34997

FULL capability devices should simply set this value to the

34998

<code>frame_number</code> of the request this result corresponds to.

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

35002

Igor Murashkin

2014-01-16 17:51:36 -0800

[diff] [blame]

35003

</tbody>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

35009

<tr><td colspan="7" class="kind">static</td></tr>

Igor Murashkin

2014-01-16 17:51:36 -0800

[diff] [blame]

<tr>

<th class="th_name">Property Name</th>

35014

35015

<th class="th_description">Description</th>

35016

<th class="th_units">Units</th>

35017

<th class="th_range">Range</th>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

35018

<th class="th_hal_version">Initial HIDL HAL version</th>

Igor Murashkin

2014-01-16 17:51:36 -0800

[diff] [blame]

</tr>

</thead>

<tbody>

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

35035

<td class="entry_name

35036

" rowspan="5">

Igor Murashkin

2014-01-16 17:51:36 -0800

[diff] [blame]

35037

android.sync.maxLatency

</td>

int32

[public]

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

35044

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

35045

[legacy]

35046

Igor Murashkin

2014-05-13 14:51:49 -0700

[diff] [blame]

35047

35048

Igor Murashkin

2014-01-16 17:51:36 -0800

[diff] [blame]

35049

35050

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

35051

PER_FRAME_CONTROL (v3.2)

Igor Murashkin

2014-01-16 17:51:36 -0800

[diff] [blame]

35052

0

Eino-Ville Talvala

2014-06-09 14:23:02 -0700

[diff] [blame]

35053

Every frame has the requests immediately applied.

Igor Murashkin

2014-01-16 17:51:36 -0800

[diff] [blame]

35054

Changing controls over multiple requests one after another will

35055

produce results that have those controls applied atomically

35056

each frame.

35057

All FULL capability devices will have this as their maxLatency.

35058

</li>

35059

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

35060

UNKNOWN (v3.2)

Igor Murashkin

2014-01-16 17:51:36 -0800

[diff] [blame]

35061

-1

35062

Each new frame has some subset (potentially the entire set)

35063

of the past requests applied to the camera settings.

35064

By submitting a series of identical requests, the camera device

35065

will eventually have the camera settings applied, but it is

Igor Murashkin

2014-07-25 16:55:18 -0700

[diff] [blame]

35066

unknown when that exact point will be.

35067

All LEGACY capability devices will have this as their maxLatency.

Igor Murashkin

2014-01-16 17:51:36 -0800

[diff] [blame]

</li>

</ul>

</td>

35072

35073

35074

The maximum number of frames that can occur after a request

35075

(different than the previous) has been submitted, and before the

Chien-Yu Chen

2015-06-26 11:25:45 -0700

[diff] [blame]

35076

result's state becomes synchronized.

Igor Murashkin

2014-01-16 17:51:36 -0800

[diff] [blame]

</td>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

35080

Frame counts

Igor Murashkin

2014-01-16 17:51:36 -0800

[diff] [blame]

</td>

Eino-Ville Talvala

2014-10-02 18:27:34 -0700

[diff] [blame]

35084

A positive value, PER_FRAME_CONTROL, or UNKNOWN.

Igor Murashkin

2014-01-16 17:51:36 -0800

[diff] [blame]

35085

</td>

35086

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Igor Murashkin

2014-01-16 17:51:36 -0800

[diff] [blame]

35091

35092

Zhijun He

2014-05-21 17:51:05 -0700

[diff] [blame]

35093

Igor Murashkin

2014-01-16 17:51:36 -0800

[diff] [blame]

</ul>

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

35099

<th class="th_details" colspan="6">Details</th>

Igor Murashkin

2014-01-16 17:51:36 -0800

[diff] [blame]

35100

</tr>

35101

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

35102

Igor Murashkin

2014-01-16 17:51:36 -0800

[diff] [blame]

35103

This defines the maximum distance (in number of metadata results),

Chien-Yu Chen

2015-06-26 11:25:45 -0700

[diff] [blame]

35104

between the frame number of the request that has new controls to apply

35105

and the frame number of the result that has all the controls applied.

Igor Murashkin

2014-01-16 17:51:36 -0800

[diff] [blame]

35106

In other words this acts as an upper boundary for how many frames

35107

must occur before the camera device knows for a fact that the new

35108

submitted camera settings have been applied in outgoing frames.

Chien-Yu Chen

2015-06-26 11:25:45 -0700

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

35113

<th class="th_details" colspan="6">HAL Implementation Details</th>

Chien-Yu Chen

2015-06-26 11:25:45 -0700

[diff] [blame]

35114

</tr>

35115

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

35116

Chien-Yu Chen

2015-06-26 11:25:45 -0700

[diff] [blame]

35117

For example if maxLatency was 2,

Igor Murashkin

2014-01-16 17:51:36 -0800

[diff] [blame]

35118

<pre><code>initial request = X (repeating)

request1 = X

request2 = Y

request3 = Y

request4 = Y

where requestN has frameNumber N, and the first of the repeating

35125

initial request's has frameNumber F (and F < 1).

35126

35127

initial result = X' + { <a href="#dynamic_android.sync.frameNumber">android.sync.frameNumber</a> == F }

35128

result1 = X' + { <a href="#dynamic_android.sync.frameNumber">android.sync.frameNumber</a> == F }

35129

result2 = X' + { <a href="#dynamic_android.sync.frameNumber">android.sync.frameNumber</a> == CONVERGING }

35130

result3 = X' + { <a href="#dynamic_android.sync.frameNumber">android.sync.frameNumber</a> == CONVERGING }

35131

result4 = X' + { <a href="#dynamic_android.sync.frameNumber">android.sync.frameNumber</a> == 2 }

35132

35133

where resultN has frameNumber N.

35134

</code></pre>

35135

Since <code>result4</code> has a <code>frameNumber == 4</code> and

35136

<code><a href="#dynamic_android.sync.frameNumber">android.sync.frameNumber</a> == 2</code>, the distance is clearly

35137

<code>4 - 2 = 2</code>.

Chien-Yu Chen

2015-06-26 11:25:45 -0700

[diff] [blame]

35138

Use <code>frame_count</code> from camera3_request_t instead of

Eino-Ville Talvala

2015-04-16 13:49:52 -0700

[diff] [blame]

35139

<a href="#controls_android.request.frameCount">android.request.frameCount</a> or

Eino-Ville Talvala

2016-01-21 12:23:56 -0800

[diff] [blame]

35140

<code><a href="https://developer.android.com/reference/android/hardware/camera2/CaptureResult.html#getFrameNumber">CaptureResult#getFrameNumber</a></code>.

Igor Murashkin

2014-01-16 17:51:36 -0800

[diff] [blame]

35141

LIMITED devices are strongly encouraged to use a non-negative

35142

value. If UNKNOWN is used here then app developers do not have a way

35143

to know when sensor settings have been applied.

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

35147

Igor Murashkin

2014-01-16 17:51:36 -0800

[diff] [blame]

35148

</tbody>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

35156

<tr><td colspan="7" id="section_reprocess" class="section">reprocess</td></tr>

Zhijun He

2015-01-15 18:17:24 -0800

[diff] [blame]

35157

35158

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

35159

<tr><td colspan="7" class="kind">controls</td></tr>

Zhijun He

2015-01-15 18:17:24 -0800

[diff] [blame]

<tr>

<th class="th_name">Property Name</th>

35164

35165

<th class="th_description">Description</th>

35166

<th class="th_units">Units</th>

35167

<th class="th_range">Range</th>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

35168

<th class="th_hal_version">Initial HIDL HAL version</th>

Zhijun He

2015-01-15 18:17:24 -0800

[diff] [blame]

</tr>

</thead>

<tbody>

<td class="entry_name

35186

" rowspan="3">

35187

android.reprocess.effectiveExposureFactor

</td>

float

Yin-Chia Yeh

2016-04-02 16:30:30 -0700

[diff] [blame]

35192

[java_public]

Zhijun He

2015-01-15 18:17:24 -0800

[diff] [blame]

35193

35194

Zhijun He

2015-04-24 17:59:50 -0700

[diff] [blame]

35195

[limited]

Zhijun He

2015-01-15 18:17:24 -0800

[diff] [blame]

</td>

35201

35202

35203

The amount of exposure time increase factor applied to the original output

35204

frame by the application processing before sending for reprocessing.

</td>

Relative exposure time increase factor.

</td>

>= 1.0

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Zhijun He

2015-01-15 18:17:24 -0800

[diff] [blame]

35219

35220

Zhijun He

2015-04-24 17:59:50 -0700

[diff] [blame]

35221

<li><a href="#tag_REPROC">REPROC</a></li>

Zhijun He

2015-01-15 18:17:24 -0800

[diff] [blame]

</ul>

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

35227

<th class="th_details" colspan="6">Details</th>

Zhijun He

2015-01-15 18:17:24 -0800

[diff] [blame]

35228

</tr>

35229

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

35230

Zhijun He

2015-01-15 18:17:24 -0800

[diff] [blame]

35231

This is optional, and will be supported if the camera device supports YUV_REPROCESSING

35232

capability (<a href="#static_android.request.availableCapabilities">android.request.availableCapabilities</a> contains YUV_REPROCESSING).

35233

For some YUV reprocessing use cases, the application may choose to filter the original

35234

output frames to effectively reduce the noise to the same level as a frame that was

35235

captured with longer exposure time. To be more specific, assuming the original captured

35236

images were captured with a sensitivity of S and an exposure time of T, the model in

35237

the camera device is that the amount of noise in the image would be approximately what

35238

would be expected if the original capture parameters had been a sensitivity of

35239

S/effectiveExposureFactor and an exposure time of T*effectiveExposureFactor, rather

35240

than S and T respectively. If the captured images were processed by the application

35241

before being sent for reprocessing, then the application may have used image processing

35242

algorithms and/or multi-frame image fusion to reduce the noise in the

35243

application-processed images (input images). By using the effectiveExposureFactor

35244

control, the application can communicate to the camera device the actual noise level

35245

improvement in the application-processed image. With this information, the camera

35246

device can select appropriate noise reduction and edge enhancement parameters to avoid

35247

excessive noise reduction (<a href="#controls_android.noiseReduction.mode">android.noiseReduction.mode</a>) and insufficient edge

35248

enhancement (<a href="#controls_android.edge.mode">android.edge.mode</a>) being applied to the reprocessed frames.

35249

For example, for multi-frame image fusion use case, the application may fuse

35250

multiple output frames together to a final frame for reprocessing. When N image are

35251

fused into 1 image for reprocessing, the exposure time increase factor could be up to

35252

square root of N (based on a simple photon shot noise model). The camera device will

35253

adjust the reprocessing noise reduction and edge enhancement parameters accordingly to

35254

produce the best quality images.

35255

This is relative factor, 1.0 indicates the application hasn't processed the input

35256

buffer in a way that affects its effective exposure time.

35257

This control is only effective for YUV reprocessing capture request. For noise

35258

reduction reprocessing, it is only effective when <code><a href="#controls_android.noiseReduction.mode">android.noiseReduction.mode</a> != OFF</code>.

35259

Similarly, for edge enhancement reprocessing, it is only effective when

35260

<code><a href="#controls_android.edge.mode">android.edge.mode</a> != OFF</code>.

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

35265

Zhijun He

2015-01-15 18:17:24 -0800

[diff] [blame]

35266

</tbody>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

35272

<tr><td colspan="7" class="kind">dynamic</td></tr>

Zhijun He

2015-01-15 18:17:24 -0800

[diff] [blame]

<tr>

<th class="th_name">Property Name</th>

35277

35278

<th class="th_description">Description</th>

35279

<th class="th_units">Units</th>

35280

<th class="th_range">Range</th>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

35281

<th class="th_hal_version">Initial HIDL HAL version</th>

Zhijun He

2015-01-15 18:17:24 -0800

[diff] [blame]

</tr>

</thead>

<tbody>

<td class="entry_name

35299

" rowspan="3">

35300

android.reprocess.effectiveExposureFactor

</td>

float

Yin-Chia Yeh

2016-04-02 16:30:30 -0700

[diff] [blame]

35305

[java_public]

Zhijun He

2015-01-15 18:17:24 -0800

[diff] [blame]

35306

35307

Zhijun He

2015-04-24 17:59:50 -0700

[diff] [blame]

35308

[limited]

Zhijun He

2015-01-15 18:17:24 -0800

[diff] [blame]

</td>

35314

35315

35316

The amount of exposure time increase factor applied to the original output

35317

frame by the application processing before sending for reprocessing.

</td>

Relative exposure time increase factor.

</td>

>= 1.0

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Zhijun He

2015-01-15 18:17:24 -0800

[diff] [blame]

35332

35333

Zhijun He

2015-04-24 17:59:50 -0700

[diff] [blame]

35334

<li><a href="#tag_REPROC">REPROC</a></li>

Zhijun He

2015-01-15 18:17:24 -0800

[diff] [blame]

</ul>

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

35340

<th class="th_details" colspan="6">Details</th>

Zhijun He

2015-01-15 18:17:24 -0800

[diff] [blame]

35341

</tr>

35342

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

35343

Zhijun He

2015-01-15 18:17:24 -0800

[diff] [blame]

35344

This is optional, and will be supported if the camera device supports YUV_REPROCESSING

35345

capability (<a href="#static_android.request.availableCapabilities">android.request.availableCapabilities</a> contains YUV_REPROCESSING).

35346

For some YUV reprocessing use cases, the application may choose to filter the original

35347

output frames to effectively reduce the noise to the same level as a frame that was

35348

captured with longer exposure time. To be more specific, assuming the original captured

35349

images were captured with a sensitivity of S and an exposure time of T, the model in

35350

the camera device is that the amount of noise in the image would be approximately what

35351

would be expected if the original capture parameters had been a sensitivity of

35352

S/effectiveExposureFactor and an exposure time of T*effectiveExposureFactor, rather

35353

than S and T respectively. If the captured images were processed by the application

35354

before being sent for reprocessing, then the application may have used image processing

35355

algorithms and/or multi-frame image fusion to reduce the noise in the

35356

application-processed images (input images). By using the effectiveExposureFactor

35357

control, the application can communicate to the camera device the actual noise level

35358

improvement in the application-processed image. With this information, the camera

35359

device can select appropriate noise reduction and edge enhancement parameters to avoid

35360

excessive noise reduction (<a href="#controls_android.noiseReduction.mode">android.noiseReduction.mode</a>) and insufficient edge

35361

enhancement (<a href="#controls_android.edge.mode">android.edge.mode</a>) being applied to the reprocessed frames.

35362

For example, for multi-frame image fusion use case, the application may fuse

35363

multiple output frames together to a final frame for reprocessing. When N image are

35364

fused into 1 image for reprocessing, the exposure time increase factor could be up to

35365

square root of N (based on a simple photon shot noise model). The camera device will

35366

adjust the reprocessing noise reduction and edge enhancement parameters accordingly to

35367

produce the best quality images.

35368

This is relative factor, 1.0 indicates the application hasn't processed the input

35369

buffer in a way that affects its effective exposure time.

35370

This control is only effective for YUV reprocessing capture request. For noise

35371

reduction reprocessing, it is only effective when <code><a href="#controls_android.noiseReduction.mode">android.noiseReduction.mode</a> != OFF</code>.

35372

Similarly, for edge enhancement reprocessing, it is only effective when

35373

<code><a href="#controls_android.edge.mode">android.edge.mode</a> != OFF</code>.

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

35378

Zhijun He

2015-01-15 18:17:24 -0800

[diff] [blame]

35379

</tbody>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

35385

<tr><td colspan="7" class="kind">static</td></tr>

Zhijun He

2015-04-24 17:59:50 -0700

[diff] [blame]

<tr>

<th class="th_name">Property Name</th>

35390

35391

<th class="th_description">Description</th>

35392

<th class="th_units">Units</th>

35393

<th class="th_range">Range</th>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

35394

<th class="th_hal_version">Initial HIDL HAL version</th>

Zhijun He

2015-04-24 17:59:50 -0700

[diff] [blame]

</tr>

</thead>

<tbody>

<td class="entry_name

35412

" rowspan="3">

35413

android.reprocess.maxCaptureStall

</td>

int32

Yin-Chia Yeh

2016-04-02 16:30:30 -0700

[diff] [blame]

35418

[java_public]

Zhijun He

2015-04-24 17:59:50 -0700

[diff] [blame]

[limited]

</td>

35427

35428

35429

The maximal camera capture pipeline stall (in unit of frame count) introduced by a

35430

reprocess capture request.

</td>

Number of frames.

</td>

<= 4

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Zhijun He

2015-04-24 17:59:50 -0700

[diff] [blame]

35445

35446

35447

<li><a href="#tag_REPROC">REPROC</a></li>

</ul>

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

35453

<th class="th_details" colspan="6">Details</th>

Zhijun He

2015-04-24 17:59:50 -0700

[diff] [blame]

35454

</tr>

35455

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

35456

Zhijun He

2015-04-24 17:59:50 -0700

[diff] [blame]

35457

The key describes the maximal interference that one reprocess (input) request

35458

can introduce to the camera simultaneous streaming of regular (output) capture

35459

requests, including repeating requests.

35460

When a reprocessing capture request is submitted while a camera output repeating request

35461

(e.g. preview) is being served by the camera device, it may preempt the camera capture

35462

pipeline for at least one frame duration so that the camera device is unable to process

35463

the following capture request in time for the next sensor start of exposure boundary.

35464

When this happens, the application may observe a capture time gap (longer than one frame

35465

duration) between adjacent capture output frames, which usually exhibits as preview

35466

glitch if the repeating request output targets include a preview surface. This key gives

35467

the worst-case number of frame stall introduced by one reprocess request with any kind of

35468

formats/sizes combination.

35469

If this key reports 0, it means a reprocess request doesn't introduce any glitch to the

35470

ongoing camera repeating request outputs, as if this reprocess request is never issued.

Chien-Yu Chen

2015-05-12 15:13:00 -0700

[diff] [blame]

35471

This key is supported if the camera device supports PRIVATE or YUV reprocessing (

35472

i.e. <a href="#static_android.request.availableCapabilities">android.request.availableCapabilities</a> contains PRIVATE_REPROCESSING or

Zhijun He

2015-04-24 17:59:50 -0700

[diff] [blame]

YUV_REPROCESSING).

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

35478

Zhijun He

2015-04-24 17:59:50 -0700

[diff] [blame]

35479

</tbody>

Zhijun He

2015-01-15 18:17:24 -0800

[diff] [blame]

35485

35486

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

35487

<tr><td colspan="7" id="section_depth" class="section">depth</td></tr>

Eino-Ville Talvala

2015-02-23 15:51:58 -0800

[diff] [blame]

35488

35489

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

35490

<tr><td colspan="7" class="kind">static</td></tr>

Eino-Ville Talvala

2015-02-23 15:51:58 -0800

[diff] [blame]

<tr>

<th class="th_name">Property Name</th>

35495

35496

<th class="th_description">Description</th>

35497

<th class="th_units">Units</th>

35498

<th class="th_range">Range</th>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

35499

<th class="th_hal_version">Initial HIDL HAL version</th>

Eino-Ville Talvala

2015-02-23 15:51:58 -0800

[diff] [blame]

</tr>

</thead>

<tbody>

<td class="entry_name

35517

" rowspan="3">

35518

android.depth.maxDepthSamples

</td>

int32

[system]

[limited]

</td>

35532

35533

35534

Maximum number of points that a depth point cloud may contain.

</td>

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Eino-Ville Talvala

2015-02-23 15:51:58 -0800

[diff] [blame]

35547

35548

35549

<li><a href="#tag_DEPTH">DEPTH</a></li>

</ul>

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

35555

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2015-02-23 15:51:58 -0800

[diff] [blame]

35556

</tr>

35557

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

35558

Eino-Ville Talvala

2015-04-16 13:49:52 -0700

[diff] [blame]

35559

If a camera device supports outputting depth range data in the form of a depth point

35560

cloud (<a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#DEPTH_POINT_CLOUD">ImageFormat#DEPTH_POINT_CLOUD</a>), this is the maximum

35561

number of points an output buffer may contain.

Eino-Ville Talvala

2015-02-23 15:51:58 -0800

[diff] [blame]

35562

Any given buffer may contain between 0 and maxDepthSamples points, inclusive.

35563

If output in the depth point cloud format is not supported, this entry will

not be defined.

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

35569

Eino-Ville Talvala

2015-02-23 15:51:58 -0800

[diff] [blame]

35570

<td class="entry_name

35575

" rowspan="3">

35576

android.depth.availableDepthStreamConfigurations

</td>

int32

x

n x 4

Yin-Chia Yeh

2016-04-02 16:30:30 -0700

[diff] [blame]

35585

[ndk_public as streamConfiguration]

Eino-Ville Talvala

2015-02-23 15:51:58 -0800

[diff] [blame]

[limited]

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

35594

OUTPUT (v3.2)

Eino-Ville Talvala

2015-02-23 15:51:58 -0800

[diff] [blame]

35595

</li>

35596

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

35597

INPUT (v3.2)

Eino-Ville Talvala

2015-02-23 15:51:58 -0800

[diff] [blame]

</li>

</ul>

</td>

35602

35603

35604

The available depth dataspace stream

35605

configurations that this camera device supports

35606

(i.e. format, width, height, output/input stream).

</td>

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Eino-Ville Talvala

2015-02-23 15:51:58 -0800

[diff] [blame]

35619

35620

35621

<li><a href="#tag_DEPTH">DEPTH</a></li>

</ul>

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

35627

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2015-02-23 15:51:58 -0800

[diff] [blame]

35628

</tr>

35629

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

35630

Eino-Ville Talvala

2015-02-23 15:51:58 -0800

[diff] [blame]

35631

These are output stream configurations for use with

35632

dataSpace HAL_DATASPACE_DEPTH. The configurations are

35633

listed as <code>(format, width, height, input?)</code> tuples.

35634

Only devices that support depth output for at least

35635

the HAL_PIXEL_FORMAT_Y16 dense depth map may include

35636

this entry.

35637

A device that also supports the HAL_PIXEL_FORMAT_BLOB

35638

sparse depth point cloud must report a single entry for

35639

the format in this list as <code>(HAL_PIXEL_FORMAT_BLOB,

35640

<a href="#static_android.depth.maxDepthSamples">android.depth.maxDepthSamples</a>, 1, OUTPUT)</code> in addition to

35641

the entries for HAL_PIXEL_FORMAT_Y16.

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

35646

Eino-Ville Talvala

2015-02-23 15:51:58 -0800

[diff] [blame]

35647

<td class="entry_name

35652

" rowspan="3">

35653

android.depth.availableDepthMinFrameDurations

</td>

int64

x

4 x n

Yin-Chia Yeh

2016-04-02 16:30:30 -0700

[diff] [blame]

35662

[ndk_public as streamConfigurationDuration]

Eino-Ville Talvala

2015-02-23 15:51:58 -0800

[diff] [blame]

[limited]

</td>

35671

35672

35673

This lists the minimum frame duration for each

35674

format/size combination for depth output formats.

</td>

(format, width, height, ns) x n

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Eino-Ville Talvala

2015-02-23 15:51:58 -0800

[diff] [blame]

35688

35689

35690

<li><a href="#tag_DEPTH">DEPTH</a></li>

</ul>

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

35696

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2015-02-23 15:51:58 -0800

[diff] [blame]

35697

</tr>

35698

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

35699

Eino-Ville Talvala

2015-02-23 15:51:58 -0800

[diff] [blame]

35700

This should correspond to the frame duration when only that

35701

stream is active, with all processing (typically in android.*.mode)

35702

set to either OFF or FAST.

35703

When multiple streams are used in a request, the minimum frame

35704

duration will be max(individual stream min durations).

35705

The minimum frame duration of a stream (of a particular format, size)

35706

is the same regardless of whether the stream is input or output.

35707

See <a href="#controls_android.sensor.frameDuration">android.sensor.frameDuration</a> and

35708

<a href="#static_android.scaler.availableStallDurations">android.scaler.availableStallDurations</a> for more details about

35709

calculating the max frame rate.

Eino-Ville Talvala

2015-02-23 15:51:58 -0800

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

35714

Eino-Ville Talvala

2015-02-23 15:51:58 -0800

[diff] [blame]

35715

<td class="entry_name

35720

" rowspan="3">

35721

android.depth.availableDepthStallDurations

</td>

int64

x

4 x n

Yin-Chia Yeh

2016-04-02 16:30:30 -0700

[diff] [blame]

35730

[ndk_public as streamConfigurationDuration]

Eino-Ville Talvala

2015-02-23 15:51:58 -0800

[diff] [blame]

[limited]

</td>

35739

35740

35741

This lists the maximum stall duration for each

Zhijun He

2015-04-24 17:59:50 -0700

[diff] [blame]

35742

output format/size combination for depth streams.

Eino-Ville Talvala

2015-02-23 15:51:58 -0800

[diff] [blame]

</td>

(format, width, height, ns) x n

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Eino-Ville Talvala

2015-02-23 15:51:58 -0800

[diff] [blame]

35756

35757

35758

<li><a href="#tag_DEPTH">DEPTH</a></li>

</ul>

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

35764

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2015-02-23 15:51:58 -0800

[diff] [blame]

35765

</tr>

35766

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

35767

Eino-Ville Talvala

2015-02-23 15:51:58 -0800

[diff] [blame]

35768

A stall duration is how much extra time would get added

35769

to the normal minimum frame duration for a repeating request

35770

that has streams with non-zero stall.

35771

This functions similarly to

35772

<a href="#static_android.scaler.availableStallDurations">android.scaler.availableStallDurations</a> for depth

35773

streams.

35774

All depth output stream formats may have a nonzero stall

duration.

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

35780

Eino-Ville Talvala

2015-02-23 15:51:58 -0800

[diff] [blame]

35781

35782

Eino-Ville Talvala

2015-04-13 17:28:29 -0700

[diff] [blame]

35783

35784

35785

<td class="entry_name

35786

" rowspan="3">

35787

android.depth.depthIsExclusive

</td>

byte

[public as boolean]

[limited]

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

35801

FALSE (v3.2)

Eino-Ville Talvala

2015-04-13 17:28:29 -0700

[diff] [blame]

35802

</li>

35803

<li>

Eino-Ville Talvala

2017-12-07 13:06:05 -0800

[diff] [blame]

35804

TRUE (v3.2)

Eino-Ville Talvala

2015-04-13 17:28:29 -0700

[diff] [blame]

</li>

</ul>

</td>

35809

35810

35811

Indicates whether a capture request may target both a

35812

DEPTH16 / DEPTH_POINT_CLOUD output, and normal color outputs (such as

35813

YUV_420_888, JPEG, or RAW) simultaneously.

</td>

</td>

</td>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

3.2

</td>

Eino-Ville Talvala

2015-04-13 17:28:29 -0700

[diff] [blame]

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

35831

<th class="th_details" colspan="6">Details</th>

Eino-Ville Talvala

2015-04-13 17:28:29 -0700

[diff] [blame]

35832

</tr>

35833

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

35834

Eino-Ville Talvala

2015-04-13 17:28:29 -0700

[diff] [blame]

35835

If TRUE, including both depth and color outputs in a single

35836

capture request is not supported. An application must interleave color

35837

and depth requests. If FALSE, a single request can target both types

35838

of output.

35839

Typically, this restriction exists on camera devices that

35840

need to emit a specific pattern or wavelength of light to

35841

measure depth values, which causes the color image to be

35842

corrupted during depth measurement.

</td>

</tr>

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

35847

Eino-Ville Talvala

2015-04-13 17:28:29 -0700

[diff] [blame]

35848

35849

Emilian Peev

2018-09-18 14:01:55 +0100

[diff] [blame]

35850

35851

35852

<td class="entry_name

35853

" rowspan="5">

35854

android.depth.availableRecommendedDepthStreamConfigurations

</td>

int32

x

n x 5

[ndk_public as recommendedStreamConfiguration]

</td>

35871

35872

35873

Recommended depth stream configurations for common client use cases.

</td>

</td>

</td>

3.4

</td>

</td>

</tr>

<th class="th_details" colspan="6">Details</th>

</tr>

Optional subset of the <a href="#static_android.depth.availableDepthStreamConfigurations">android.depth.availableDepthStreamConfigurations</a> that

35896

contains similar tuples listed as

35897

(i.e. width, height, format, output/input stream, usecase bit field).

35898

Camera devices will be able to suggest particular depth stream configurations which are

35899

power and performance efficient for specific use cases. For more information about

35900

retrieving the suggestions see

35901

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics.html#getRecommendedStreamConfigurationMap">CameraCharacteristics#getRecommendedStreamConfigurationMap</a>.

</td>

</tr>

<th class="th_details" colspan="6">HAL Implementation Details</th>

</tr>

Recommended depth configurations are expected to be declared with SNAPSHOT and/or

35911

ZSL if supported by the device.

35912

For additional details on how to declare recommended stream configurations, check

35913

<a href="#static_android.scaler.availableRecommendedStreamConfigurations">android.scaler.availableRecommendedStreamConfigurations</a>.

35914

For additional requirements on depth streams please consider

35915

<a href="#static_android.depth.availableDepthStreamConfigurations">android.depth.availableDepthStreamConfigurations</a>.

</td>

</tr>

35921

Emilian Peev

65860e4

2019-01-04 17:49:37 +0000

[diff] [blame]

35922

35923

35924

<td class="entry_name

35925

" rowspan="5">

35926

android.depth.availableDynamicDepthStreamConfigurations

</td>

int32

x

n x 4

[ndk_public as streamConfiguration]

<li>

OUTPUT (v3.4)

</li>

<li>

INPUT (v3.4)

</li>

</ul>

</td>

35951

35952

35953

The available dynamic depth dataspace stream

35954

configurations that this camera device supports

35955

(i.e. format, width, height, output/input stream).

</td>

</td>

</td>

3.4

</td>

<li><a href="#tag_DEPTH">DEPTH</a></li>

</ul>

</td>

</tr>

<th class="th_details" colspan="6">Details</th>

</tr>

These are output stream configurations for use with

35981

dataSpace DYNAMIC_DEPTH. The configurations are

35982

listed as <code>(format, width, height, input?)</code> tuples.

35983

Only devices that support depth output for at least

35984

the HAL_PIXEL_FORMAT_Y16 dense depth map along with

35985

HAL_PIXEL_FORMAT_BLOB with the same size or size with

35986

the same aspect ratio can have dynamic depth dataspace

35987

stream configuration. <a href="#static_android.depth.depthIsExclusive">android.depth.depthIsExclusive</a> also

35988

needs to be set to FALSE.

</td>

</tr>

<th class="th_details" colspan="6">HAL Implementation Details</th>

</tr>

Do not set this property directly.

35998

It is populated by camera framework and must not be set

at the HAL layer.

</td>

</tr>

<td class="entry_name

36009

" rowspan="5">

36010

android.depth.availableDynamicDepthMinFrameDurations

</td>

int64

x

4 x n

[ndk_public as streamConfigurationDuration]

</td>

36027

36028

36029

This lists the minimum frame duration for each

36030

format/size combination for dynamic depth output streams.

</td>

(format, width, height, ns) x n

</td>

</td>

3.4

</td>

<li><a href="#tag_DEPTH">DEPTH</a></li>

</ul>

</td>

</tr>

<th class="th_details" colspan="6">Details</th>

</tr>

This should correspond to the frame duration when only that

36057

stream is active, with all processing (typically in android.*.mode)

36058

set to either OFF or FAST.

36059

When multiple streams are used in a request, the minimum frame

36060

duration will be max(individual stream min durations).

36061

The minimum frame duration of a stream (of a particular format, size)

36062

is the same regardless of whether the stream is input or output.

</td>

</tr>

<th class="th_details" colspan="6">HAL Implementation Details</th>

</tr>

Do not set this property directly.

36072

It is populated by camera framework and must not be set

at the HAL layer.

</td>

</tr>

<td class="entry_name

36083

" rowspan="5">

36084

android.depth.availableDynamicDepthStallDurations

</td>

int64

x

4 x n

[ndk_public as streamConfigurationDuration]

</td>

36101

36102

36103

This lists the maximum stall duration for each

36104

output format/size combination for dynamic depth streams.

</td>

(format, width, height, ns) x n

</td>

</td>

3.4

</td>

<li><a href="#tag_DEPTH">DEPTH</a></li>

</ul>

</td>

</tr>

<th class="th_details" colspan="6">Details</th>

</tr>

A stall duration is how much extra time would get added

36131

to the normal minimum frame duration for a repeating request

36132

that has streams with non-zero stall.

36133

All dynamic depth output streams may have a nonzero stall

duration.

</td>

</tr>

<th class="th_details" colspan="6">HAL Implementation Details</th>

</tr>

Do not set this property directly.

36144

It is populated by camera framework and must not be set

at the HAL layer.

</td>

</tr>

36151

Jayant Chowdhary

2020-11-09 09:08:31 -0800

[diff] [blame]

36152

36153

36154

<td class="entry_name

36155

" rowspan="3">

36156

android.depth.availableDepthStreamConfigurationsMaximumResolution

</td>

int32

x

n x 4

[ndk_public as streamConfiguration]

<li>

OUTPUT (v3.6)

</li>

<li>

INPUT (v3.6)

</li>

</ul>

</td>

36181

36182

36183

The available depth dataspace stream

36184

configurations that this camera device supports

36185

(i.e. format, width, height, output/input stream) when a CaptureRequest is submitted with

36186

<a href="#controls_android.sensor.pixelMode">android.sensor.pixelMode</a> set to

36187

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraMetadata.html#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION">CameraMetadata#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION</a>.

</td>

</td>

</td>

3.6

</td>

<li><a href="#tag_DEPTH">DEPTH</a></li>

</ul>

</td>

</tr>

<th class="th_details" colspan="6">Details</th>

</tr>

Analogous to <a href="#static_android.depth.availableDepthStreamConfigurations">android.depth.availableDepthStreamConfigurations</a>, for configurations which

36213

are applicable when <a href="#controls_android.sensor.pixelMode">android.sensor.pixelMode</a> is set to

36214

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraMetadata.html#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION">CameraMetadata#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION</a>.

</td>

</tr>

<td class="entry_name

36225

" rowspan="3">

36226

android.depth.availableDepthMinFrameDurationsMaximumResolution

</td>

int64

x

4 x n

[ndk_public as streamConfigurationDuration]

</td>

36243

36244

36245

This lists the minimum frame duration for each

36246

format/size combination for depth output formats when a CaptureRequest is submitted with

36247

<a href="#controls_android.sensor.pixelMode">android.sensor.pixelMode</a> set to

36248

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraMetadata.html#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION">CameraMetadata#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION</a>.

</td>

(format, width, height, ns) x n

</td>

</td>

3.6

</td>

<li><a href="#tag_DEPTH">DEPTH</a></li>

</ul>

</td>

</tr>

<th class="th_details" colspan="6">Details</th>

</tr>

Analogous to <a href="#static_android.depth.availableDepthMinFrameDurations">android.depth.availableDepthMinFrameDurations</a>, for configurations which

36275

are applicable when <a href="#controls_android.sensor.pixelMode">android.sensor.pixelMode</a> is set to

36276

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraMetadata.html#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION">CameraMetadata#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION</a>.

36277

See <a href="#controls_android.sensor.frameDuration">android.sensor.frameDuration</a> and

36278

<a href="#static_android.scaler.availableStallDurationsMaximumResolution">android.scaler.availableStallDurationsMaximumResolution</a> for more details about

36279

calculating the max frame rate.

</td>

</tr>

<td class="entry_name

36290

" rowspan="3">

36291

android.depth.availableDepthStallDurationsMaximumResolution

</td>

int64

x

4 x n

[ndk_public as streamConfigurationDuration]

</td>

36308

36309

36310

This lists the maximum stall duration for each

36311

output format/size combination for depth streams for CaptureRequests where

36312

<a href="#controls_android.sensor.pixelMode">android.sensor.pixelMode</a> is set to

36313

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraMetadata.html#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION">CameraMetadata#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION</a>.

</td>

(format, width, height, ns) x n

</td>

</td>

3.6

</td>

<li><a href="#tag_DEPTH">DEPTH</a></li>

</ul>

</td>

</tr>

<th class="th_details" colspan="6">Details</th>

</tr>

Analogous to <a href="#static_android.depth.availableDepthStallDurations">android.depth.availableDepthStallDurations</a>, for configurations which

36340

are applicable when <a href="#controls_android.sensor.pixelMode">android.sensor.pixelMode</a> is set to

36341

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraMetadata.html#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION">CameraMetadata#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION</a>.

</td>

</tr>

<td class="entry_name

36352

" rowspan="5">

36353

android.depth.availableDynamicDepthStreamConfigurationsMaximumResolution

</td>

int32

x

n x 4

[ndk_public as streamConfiguration]

<li>

OUTPUT (v3.6)

</li>

<li>

INPUT (v3.6)

</li>

</ul>

</td>

36378

36379

36380

The available dynamic depth dataspace stream

36381

configurations that this camera device supports (i.e. format, width, height,

36382

output/input stream) for CaptureRequests where <a href="#controls_android.sensor.pixelMode">android.sensor.pixelMode</a> is set to

36383

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraMetadata.html#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION">CameraMetadata#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION</a>.

</td>

</td>

</td>

3.6

</td>

<li><a href="#tag_DEPTH">DEPTH</a></li>

</ul>

</td>

</tr>

<th class="th_details" colspan="6">Details</th>

</tr>

Analogous to <a href="#static_android.depth.availableDynamicDepthStreamConfigurations">android.depth.availableDynamicDepthStreamConfigurations</a>, for configurations

36409

which are applicable when <a href="#controls_android.sensor.pixelMode">android.sensor.pixelMode</a> is set to

36410

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraMetadata.html#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION">CameraMetadata#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION</a>.

</td>

</tr>

<th class="th_details" colspan="6">HAL Implementation Details</th>

</tr>

Do not set this property directly.

36420

It is populated by camera framework and must not be set

at the HAL layer.

</td>

</tr>

<td class="entry_name

36431

" rowspan="5">

36432

android.depth.availableDynamicDepthMinFrameDurationsMaximumResolution

</td>

int64

x

4 x n

[ndk_public as streamConfigurationDuration]

</td>

36449

36450

36451

This lists the minimum frame duration for each

36452

format/size combination for dynamic depth output streams for CaptureRequests where

36453

<a href="#controls_android.sensor.pixelMode">android.sensor.pixelMode</a> is set to

36454

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraMetadata.html#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION">CameraMetadata#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION</a>.

</td>

(format, width, height, ns) x n

</td>

</td>

3.6

</td>

<li><a href="#tag_DEPTH">DEPTH</a></li>

</ul>

</td>

</tr>

<th class="th_details" colspan="6">Details</th>

</tr>

Analogous to <a href="#static_android.depth.availableDynamicDepthMinFrameDurations">android.depth.availableDynamicDepthMinFrameDurations</a>, for configurations

36481

which are applicable when <a href="#controls_android.sensor.pixelMode">android.sensor.pixelMode</a> is set to

36482

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraMetadata.html#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION">CameraMetadata#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION</a>.

</td>

</tr>

<th class="th_details" colspan="6">HAL Implementation Details</th>

</tr>

Do not set this property directly.

36492

It is populated by camera framework and must not be set

at the HAL layer.

</td>

</tr>

<td class="entry_name

36503

" rowspan="5">

36504

android.depth.availableDynamicDepthStallDurationsMaximumResolution

</td>

int64

x

4 x n

[ndk_public as streamConfigurationDuration]

</td>

36521

36522

36523

This lists the maximum stall duration for each

36524

output format/size combination for dynamic depth streams for CaptureRequests where

36525

<a href="#controls_android.sensor.pixelMode">android.sensor.pixelMode</a> is set to

36526

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraMetadata.html#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION">CameraMetadata#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION</a>.

</td>

(format, width, height, ns) x n

</td>

</td>

3.6

</td>

<li><a href="#tag_DEPTH">DEPTH</a></li>

</ul>

</td>

</tr>

<th class="th_details" colspan="6">Details</th>

</tr>

Analogous to <a href="#static_android.depth.availableDynamicDepthStallDurations">android.depth.availableDynamicDepthStallDurations</a>, for configurations

36553

which are applicable when <a href="#controls_android.sensor.pixelMode">android.sensor.pixelMode</a> is set to

36554

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraMetadata.html#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION">CameraMetadata#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION</a>.

</td>

</tr>

<th class="th_details" colspan="6">HAL Implementation Details</th>

</tr>

Do not set this property directly.

36564

It is populated by camera framework and must not be set

at the HAL layer.

</td>

</tr>

36571

Eino-Ville Talvala

2015-02-23 15:51:58 -0800

[diff] [blame]

</tbody>

Shuzhen Wang

2017-11-30 12:03:37 -0800

[diff] [blame]

36578

<tr><td colspan="7" id="section_logicalMultiCamera" class="section">logicalMultiCamera</td></tr>

36579

36580

36581

<tr><td colspan="7" class="kind">static</td></tr>

<tr>

<th class="th_name">Property Name</th>

36586

36587

<th class="th_description">Description</th>

36588

<th class="th_units">Units</th>

36589

<th class="th_range">Range</th>

36590

<th class="th_hal_version">Initial HIDL HAL version</th>

</tr>

</thead>

<tbody>

<td class="entry_name

36608

" rowspan="3">

36609

android.logicalMultiCamera.physicalIds

</td>

byte

x

n

Shuzhen Wang

2018-12-07 17:50:58 -0800

[diff] [blame]

36618

[ndk_public]

Shuzhen Wang

2017-11-30 12:03:37 -0800

[diff] [blame]

[limited]

</td>

36627

36628

36629

String containing the ids of the underlying physical cameras.

</td>

UTF-8 null-terminated string

</td>

</td>

3.3

</td>

<li><a href="#tag_LOGICALCAMERA">LOGICALCAMERA</a></li>

</ul>

</td>

</tr>

<th class="th_details" colspan="6">Details</th>

</tr>

Shuzhen Wang

2018-11-19 12:15:18 -0800

[diff] [blame]

36655

For a logical camera, this is concatenation of all underlying physical camera IDs.

36656

The null terminator for physical camera ID must be preserved so that the whole string

36657

can be tokenized using '\0' to generate list of physical camera IDs.

36658

For example, if the physical camera IDs of the logical camera are "2" and "3", the

Shuzhen Wang

2017-11-30 12:03:37 -0800

[diff] [blame]

36659

value of this tag will be ['2', '\0', '3', '\0'].

Shuzhen Wang

2018-11-19 12:15:18 -0800

[diff] [blame]

36660

The number of physical camera IDs must be no less than 2.

Shuzhen Wang

2017-11-30 12:03:37 -0800

[diff] [blame]

</td>

</tr>

<td class="entry_name

36671

" rowspan="3">

36672

android.logicalMultiCamera.sensorSyncType

</td>

byte

[public]

[limited]

<li>

APPROXIMATE (v3.3)

A software mechanism is used to synchronize between the physical cameras. As a result,

36688

the timestamp of an image from a physical stream is only an approximation of the

36689

image sensor start-of-exposure time.

</li>

<li>

CALIBRATED (v3.3)

The camera device supports frame timestamp synchronization at the hardware level,

36694

and the timestamp of a physical stream image accurately reflects its

36695

start-of-exposure time.

</li>

</ul>

</td>

36700

36701

36702

The accuracy of frame timestamp synchronization between physical cameras

</td>

</td>

</td>

3.3

</td>

<li><a href="#tag_LOGICALCAMERA">LOGICALCAMERA</a></li>

</ul>

</td>

</tr>

<th class="th_details" colspan="6">Details</th>

</tr>

The accuracy of the frame timestamp synchronization determines the physical cameras'

Eino-Ville Talvala

54960fa

2020-06-19 13:50:40 -0700

[diff] [blame]

36728

ability to start exposure at the same time. If the sensorSyncType is CALIBRATED, the

36729

physical camera sensors usually run in leader/follower mode where one sensor generates a

36730

timing signal for the other, so that their shutter time is synchronized. For APPROXIMATE

36731

sensorSyncType, the camera sensors usually run in leader/leader mode, where both sensors

36732

use their own timing generator, and there could be offset between their start of exposure.

Shuzhen Wang

2017-11-30 12:03:37 -0800

[diff] [blame]

36733

In both cases, all images generated for a particular capture request still carry the same

36734

timestamps, so that they can be used to look up the matching frame number and

36735

onCaptureStarted callback.

Shuzhen Wang

2019-03-07 08:38:51 -0800

[diff] [blame]

36736

This tag is only applicable if the logical camera device supports concurrent physical

36737

streams from different physical cameras.

Shuzhen Wang

2017-11-30 12:03:37 -0800

[diff] [blame]

</td>

</tr>

</tbody>

Shuzhen Wang

2018-11-19 12:15:18 -0800

[diff] [blame]

36749

<tr><td colspan="7" class="kind">dynamic</td></tr>

<tr>

<th class="th_name">Property Name</th>

36754

36755

<th class="th_description">Description</th>

36756

<th class="th_units">Units</th>

36757

<th class="th_range">Range</th>

36758

<th class="th_hal_version">Initial HIDL HAL version</th>

</tr>

</thead>

<tbody>

<td class="entry_name

36776

" rowspan="5">

36777

android.logicalMultiCamera.activePhysicalId

</td>

byte

[public as string]

</td>

36790

36791

36792

String containing the ID of the underlying active physical camera.

</td>

UTF-8 null-terminated string

</td>

</td>

3.4

</td>

<li><a href="#tag_LOGICALCAMERA">LOGICALCAMERA</a></li>

</ul>

</td>

</tr>

<th class="th_details" colspan="6">Details</th>

</tr>

The ID of the active physical camera that's backing the logical camera. All camera

36819

streams and metadata that are not physical camera specific will be originating from this

Shuzhen Wang

dcdd74b

2019-02-27 08:25:42 -0800

[diff] [blame]

36820

physical camera.

Shuzhen Wang

2018-11-19 12:15:18 -0800

[diff] [blame]

36821

For a logical camera made up of physical cameras where each camera's lenses have

36822

different characteristics, the camera device may choose to switch between the physical

36823

cameras when application changes FOCAL_LENGTH or SCALER_CROP_REGION.

36824

At the time of lens switch, this result metadata reflects the new active physical camera

36825

ID.

Shuzhen Wang

dcdd74b

2019-02-27 08:25:42 -0800

[diff] [blame]

36826

This key will be available if the camera device advertises this key via <a href="https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics.html#getAvailableCaptureResultKeys">CameraCharacteristics#getAvailableCaptureResultKeys</a>.

36827

When available, this must be one of valid physical IDs backing this logical multi-camera.

36828

If this key is not available for a logical multi-camera, the camera device implementation

36829

may still switch between different active physical cameras based on use case, but the

36830

current active physical camera information won't be available to the application.

Shuzhen Wang

2018-11-19 12:15:18 -0800

[diff] [blame]

</td>

</tr>

<th class="th_details" colspan="6">HAL Implementation Details</th>

</tr>

Staring from HIDL ICameraDevice version 3.5, the tag must be available in the capture

36840

result metadata to indicate current active physical camera ID.

</td>

</tr>

</tbody>

Shuzhen Wang

2017-11-30 12:03:37 -0800

[diff] [blame]

36851

36852

Eino-Ville Talvala

2018-03-13 19:46:57 -0700

[diff] [blame]

36853

<tr><td colspan="7" id="section_distortionCorrection" class="section">distortionCorrection</td></tr>

36854

36855

36856

<tr><td colspan="7" class="kind">controls</td></tr>

<tr>

<th class="th_name">Property Name</th>

36861

36862

<th class="th_description">Description</th>

36863

<th class="th_units">Units</th>

36864

<th class="th_range">Range</th>

36865

<th class="th_hal_version">Initial HIDL HAL version</th>

</tr>

</thead>

<tbody>

<td class="entry_name

36883

" rowspan="3">

36884

android.distortionCorrection.mode

</td>

byte

[public]

<li>

OFF (v3.3)

No distortion correction is applied.

</li>

<li>

FAST (v3.3)

Lens distortion correction is applied without reducing frame rate

36903

relative to sensor output. It may be the same as OFF if distortion correction would

36904

reduce frame rate relative to sensor.

</li>

<li>

HIGH_QUALITY (v3.3)

High-quality distortion correction is applied, at the cost of

36909

possibly reduced frame rate relative to sensor output.

</li>

</ul>

</td>

36914

36915

36916

Mode of operation for the lens distortion correction block.

</td>

</td>

<a href="#static_android.distortionCorrection.availableModes">android.distortionCorrection.availableModes</a>

</td>

3.3

</td>

</td>

</tr>

<th class="th_details" colspan="6">Details</th>

</tr>

The lens distortion correction block attempts to improve image quality by fixing

36940

radial, tangential, or other geometric aberrations in the camera device's optics. If

36941

available, the <a href="#static_android.lens.distortion">android.lens.distortion</a> field documents the lens's distortion parameters.

36942

OFF means no distortion correction is done.

36943

FAST/HIGH_QUALITY both mean camera device determined distortion correction will be

36944

applied. HIGH_QUALITY mode indicates that the camera device will use the highest-quality

36945

correction algorithms, even if it slows down capture rate. FAST means the camera device

36946

will not slow down capture rate when applying correction. FAST may be the same as OFF if

36947

any correction at all would slow down capture rate. Every output stream will have a

36948

similar amount of enhancement applied.

Shuzhen Wang

2018-09-27 15:50:01 -0700

[diff] [blame]

36949

The correction only applies to processed outputs such as YUV, Y8, JPEG, or DEPTH16; it is

36950

not applied to any RAW output.

Yin-Chia Yeh

2018-06-15 15:35:05 -0700

[diff] [blame]

36951

This control will be on by default on devices that support this control. Applications

36952

disabling distortion correction need to pay extra attention with the coordinate system of

36953

metering regions, crop region, and face rectangles. When distortion correction is OFF,

36954

metadata coordinates follow the coordinate system of

36955

<a href="#static_android.sensor.info.preCorrectionActiveArraySize">android.sensor.info.preCorrectionActiveArraySize</a>. When distortion is not OFF, metadata

Eino-Ville Talvala

2018-08-01 15:26:26 -0700

[diff] [blame]

36956

coordinates follow the coordinate system of <a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a>. The

36957

camera device will map these metadata fields to match the corrected image produced by the

36958

camera device, for both capture requests and results. However, this mapping is not very

36959

precise, since rectangles do not generally map to rectangles when corrected. Only linear

36960

scaling between the active array and precorrection active array coordinates is

36961

performed. Applications that require precise correction of metadata need to undo that

36962

linear scaling, and apply a more complete correction that takes into the account the app's

36963

own requirements.

36964

The full list of metadata that is affected in this way by distortion correction is:

36965

<ul>

36966

<li><a href="#controls_android.control.afRegions">android.control.afRegions</a></li>

36967

<li><a href="#controls_android.control.aeRegions">android.control.aeRegions</a></li>

36968

<li><a href="#controls_android.control.awbRegions">android.control.awbRegions</a></li>

36969

<li><a href="#controls_android.scaler.cropRegion">android.scaler.cropRegion</a></li>

36970

<li><a href="#dynamic_android.statistics.faces">android.statistics.faces</a></li>

36971

</ul>

Eino-Ville Talvala

2018-03-13 19:46:57 -0700

[diff] [blame]

</td>

</tr>

</tbody>

<tr><td colspan="7" class="kind">static</td></tr>

<tr>

<th class="th_name">Property Name</th>

36988

36989

<th class="th_description">Description</th>

36990

<th class="th_units">Units</th>

36991

<th class="th_range">Range</th>

36992

<th class="th_hal_version">Initial HIDL HAL version</th>

</tr>

</thead>

<tbody>

<td class="entry_name

37010

" rowspan="5">

37011

android.distortionCorrection.availableModes

</td>

byte

x

n

[public as enumList]

<div class="entry_type_notes">list of enums</div>

37026

37027

37028

</td>

37029

37030

37031

List of distortion correction modes for <a href="#controls_android.distortionCorrection.mode">android.distortionCorrection.mode</a> that are

37032

supported by this camera device.

</td>

</td>

Any value listed in <a href="#controls_android.distortionCorrection.mode">android.distortionCorrection.mode</a>

</td>

3.3

</td>

<li><a href="#tag_REPROC">REPROC</a></li>

</ul>

</td>

</tr>

<th class="th_details" colspan="6">Details</th>

</tr>

No device is required to support this API; such devices will always list only 'OFF'.

37060

All devices that support this API will list both FAST and HIGH_QUALITY.

</td>

</tr>

<th class="th_details" colspan="6">HAL Implementation Details</th>

</tr>

HAL must support both FAST and HIGH_QUALITY if distortion correction is available

37070

on the camera device, but the underlying implementation can be the same for both modes.

37071

That is, if the highest quality implementation on the camera device does not slow down

37072

capture rate, then FAST and HIGH_QUALITY will generate the same output.

</td>

</tr>

</tbody>

<tr><td colspan="7" class="kind">dynamic</td></tr>

<tr>

<th class="th_name">Property Name</th>

37088

37089

<th class="th_description">Description</th>

37090

<th class="th_units">Units</th>

37091

<th class="th_range">Range</th>

37092

<th class="th_hal_version">Initial HIDL HAL version</th>

</tr>

</thead>

<tbody>

<td class="entry_name

37110

" rowspan="3">

37111

android.distortionCorrection.mode

</td>

byte

[public]

<li>

OFF (v3.3)

No distortion correction is applied.

</li>

<li>

FAST (v3.3)

Lens distortion correction is applied without reducing frame rate

37130

relative to sensor output. It may be the same as OFF if distortion correction would

37131

reduce frame rate relative to sensor.

</li>

<li>

HIGH_QUALITY (v3.3)

High-quality distortion correction is applied, at the cost of

37136

possibly reduced frame rate relative to sensor output.

</li>

</ul>

</td>

37141

37142

37143

Mode of operation for the lens distortion correction block.

</td>

</td>

<a href="#static_android.distortionCorrection.availableModes">android.distortionCorrection.availableModes</a>

</td>

3.3

</td>

</td>

</tr>

<th class="th_details" colspan="6">Details</th>

</tr>

The lens distortion correction block attempts to improve image quality by fixing

37167

radial, tangential, or other geometric aberrations in the camera device's optics. If

37168

available, the <a href="#static_android.lens.distortion">android.lens.distortion</a> field documents the lens's distortion parameters.

37169

OFF means no distortion correction is done.

37170

FAST/HIGH_QUALITY both mean camera device determined distortion correction will be

37171

applied. HIGH_QUALITY mode indicates that the camera device will use the highest-quality

37172

correction algorithms, even if it slows down capture rate. FAST means the camera device

37173

will not slow down capture rate when applying correction. FAST may be the same as OFF if

37174

any correction at all would slow down capture rate. Every output stream will have a

37175

similar amount of enhancement applied.

Shuzhen Wang

2018-09-27 15:50:01 -0700

[diff] [blame]

37176

The correction only applies to processed outputs such as YUV, Y8, JPEG, or DEPTH16; it is

37177

not applied to any RAW output.

Yin-Chia Yeh

2018-06-15 15:35:05 -0700

[diff] [blame]

37178

This control will be on by default on devices that support this control. Applications

37179

disabling distortion correction need to pay extra attention with the coordinate system of

37180

metering regions, crop region, and face rectangles. When distortion correction is OFF,

37181

metadata coordinates follow the coordinate system of

37182

<a href="#static_android.sensor.info.preCorrectionActiveArraySize">android.sensor.info.preCorrectionActiveArraySize</a>. When distortion is not OFF, metadata

Eino-Ville Talvala

2018-08-01 15:26:26 -0700

[diff] [blame]

37183

coordinates follow the coordinate system of <a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a>. The

37184

camera device will map these metadata fields to match the corrected image produced by the

37185

camera device, for both capture requests and results. However, this mapping is not very

37186

precise, since rectangles do not generally map to rectangles when corrected. Only linear

37187

scaling between the active array and precorrection active array coordinates is

37188

performed. Applications that require precise correction of metadata need to undo that

37189

linear scaling, and apply a more complete correction that takes into the account the app's

37190

own requirements.

37191

The full list of metadata that is affected in this way by distortion correction is:

37192

<ul>

37193

<li><a href="#controls_android.control.afRegions">android.control.afRegions</a></li>

37194

<li><a href="#controls_android.control.aeRegions">android.control.aeRegions</a></li>

37195

<li><a href="#controls_android.control.awbRegions">android.control.awbRegions</a></li>

37196

<li><a href="#controls_android.scaler.cropRegion">android.scaler.cropRegion</a></li>

37197

<li><a href="#dynamic_android.statistics.faces">android.statistics.faces</a></li>

37198

</ul>

Eino-Ville Talvala

2018-03-13 19:46:57 -0700

[diff] [blame]

</td>

</tr>

</tbody>

Shuzhen Wang

2018-12-28 18:50:53 -0800

[diff] [blame]

<tr><td colspan="7" class="kind">static</td></tr>

<tr>

<th class="th_name">Property Name</th>

37220

37221

<th class="th_description">Description</th>

37222

<th class="th_units">Units</th>

37223

<th class="th_range">Range</th>

37224

<th class="th_hal_version">Initial HIDL HAL version</th>

</tr>

</thead>

<tbody>

<td class="entry_name

37244

" rowspan="3">

37245

android.heic.info.supported

</td>

byte

[system as boolean]

[limited]

<li>

FALSE (v3.4)

</li>

<li>

TRUE (v3.4)

</li>

</ul>

</td>

37267

37268

37269

Whether this camera device can support identical set of stream combinations

37270

involving HEIC image format, compared to the

37271

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraDevice.html#createCaptureSession">table of combinations</a>

37272

involving JPEG image format required for the device's hardware level and capabilities.

</td>

</td>

</td>

3.4

</td>

</ul>

</td>

</tr>

<th class="th_details" colspan="6">Details</th>

</tr>

All the static, control and dynamic metadata tags related to JPEG apply to HEIC formats

37298

as well. For example, the same <a href="#controls_android.jpeg.orientation">android.jpeg.orientation</a> and <a href="#controls_android.jpeg.quality">android.jpeg.quality</a> are

37299

used to control the orientation and quality of the HEIC image. Configuring JPEG and

37300

HEIC streams at the same time is not supported.

37301

If a camera device supports HEIC format (ISO/IEC 23008-12), not only does it

37302

support the existing mandatory stream

37303

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraDevice.html#createCaptureSession">combinations</a>

37304

required for the device's hardware level and capabilities, it also supports swapping

37305

each JPEG stream with HEIC stream in all guaranteed combinations.

37306

For every HEIC stream configured by the application, the camera framework sets up 2

37307

internal streams with camera HAL:

37308

<ul>

37309

<li>A YUV_420_888 or IMPLEMENTATION_DEFINED HAL stream as input to HEIC or HEVC encoder.</li>

37310

<li>A BLOB stream with JPEG_APPS_SEGMENTS dataspace to extract application markers

37311

including EXIF and thumbnail to be saved in HEIF container.</li>

37312

</ul>

37313

A camera device can output HEIC format to the application if and only if:

37314

<ul>

37315

<li>The system contains a HEIC or HEVC encoder with constant quality mode, and</li>

37316

<li>This tag is set to TRUE, meaning that camera HAL supports replacing JPEG streams in

37317

all mandatory stream combinations with a [YUV_420_888/IMPLEMENTATION_DEFINED stream +

37318

JPEG_APPS_SEGMENT BLOB stream] combo.</li>

37319

</ul>

37320

As an example, if the camera device's hardware level is LIMITED, and it supports HEIC,

37321

in addition to the required stream combinations, HAL must support below stream

37322

combinations as well:

37323

<ul>

37324

<li>IMPLEMENTATION_DEFINED/YUV_420_888 MAXIMUM + JPEG_SEGMENTS_BLOB,</li>

37325

<li>PRIV PREVIEW + IMPLEMENTATION_DEFINED/YUV_420_888 MAXIMUM + JPEG_SEGMENTS_BLOB,</li>

37326

<li>YUV PREVIEW + IMPLEMENTATION_DEFINED/YUV_420_888 MAXIMUM + JPEG_SEGMENTS_BLOB,</li>

37327

<li>PRIV PREVIEW + YUV PREVIEW + IMPLEMENTATION_DEFINED/YUV_420_888 MAXIMUM +

37328

JPEG_SEGMENTS_BLOB</li>

37329

</ul>

37330

The selection logic between YUV_420_888 and IMPLEMENTATION_DEFINED for HAL internal

37331

stream is as follows:

37332

<pre><code>if (HEIC encoder exists and supports the size) {

37333

use IMPLEMENTATION_DEFINED with GRALLOC_USAGE_HW_IMAGE_ENCODER usage flag;

37334

} else {

37335

// HVC encoder exists

37336

if (size is less than framework predefined tile size) {

37337

use IMPLEMENTATINO_DEFINED with GRALLOC_USAGE_HW_VIDEO_ENCODER usage flag;

} else {

use YUV_420_888;

}

}

</code></pre>

</td>

</tr>

<td class="entry_name

37353

" rowspan="3">

37354

android.heic.info.maxJpegAppSegmentsCount

</td>

byte

[system]

[limited]

</td>

37368

37369

37370

The maximum number of Jpeg APP segments supported by the camera HAL device.

</td>

</td>

</td>

3.4

</td>

</ul>

</td>

</tr>

<th class="th_details" colspan="6">Details</th>

</tr>

The camera framework will use this value to derive the size of the BLOB buffer with

37396

JPEG_APP_SEGMENTS dataspace, with each APP segment occupying at most 64K bytes. If the

37397

value of this tag is n, the size of the framework allocated buffer will be:

37398

<pre><code>n * (2 + 0xFFFF) + sizeof(struct CameraBlob)

37399

</code></pre>

37400

where 2 is number of bytes for APP marker, 0xFFFF is the maximum size per APP segment

37401

(including segment size).

37402

The value of this tag must be at least 1, and APP1 marker (0xFFE1) segment must be the

37403

first segment stored in the JPEG_APPS_SEGMENTS BLOB buffer. APP1 segment stores EXIF and

37404

thumbnail.

37405

Since media encoder embeds the orientation in the metadata of the output image, to be

37406

consistent between main image and thumbnail, camera HAL must not rotate the thumbnail

37407

image data based on <a href="#controls_android.jpeg.orientation">android.jpeg.orientation</a>. The framework will write the orientation

37408

into EXIF and HEIC container.

37409

APP1 segment is followed immediately by one or multiple APP2 segments, and APPn

37410

segments. After the HAL fills and returns the JPEG_APP_SEGMENTS buffer, the camera

37411

framework modifies the APP1 segment by filling in the EXIF tags that are related to

37412

main image bitstream and the tags that can be derived from capture result metadata,

37413

before saving them into the HEIC container.

37414

The value of this tag must not be more than 16.

</td>

</tr>

<td class="entry_name

37428

" rowspan="5">

37429

android.heic.availableHeicStreamConfigurations

</td>

int32

x

n x 4

[ndk_public as streamConfiguration]

[limited]

<li>

OUTPUT (v3.4)

</li>

<li>

INPUT (v3.4)

</li>

</ul>

</td>

37455

37456

37457

The available HEIC (ISO/IEC 23008-12) stream

37458

configurations that this camera device supports

37459

(i.e. format, width, height, output/input stream).

</td>

</td>

</td>

3.4

</td>

</ul>

</td>

</tr>

<th class="th_details" colspan="6">Details</th>

</tr>

The configurations are listed as <code>(format, width, height, input?)</code> tuples.

37485

If the camera device supports HEIC image format, it will support identical set of stream

37486

combinations involving HEIC image format, compared to the combinations involving JPEG

37487

image format as required by the device's hardware level and capabilities.

37488

All the static, control, and dynamic metadata tags related to JPEG apply to HEIC formats.

37489

Configuring JPEG and HEIC streams at the same time is not supported.

</td>

</tr>

<th class="th_details" colspan="6">HAL Implementation Details</th>

</tr>

These are output stream configurations for use with dataSpace HAL_DATASPACE_HEIF.

37499

Do not set this property directly. It is populated by camera framework and must not be

37500

set by the HAL layer.

</td>

</tr>

<td class="entry_name

37510

" rowspan="5">

37511

android.heic.availableHeicMinFrameDurations

</td>

int64

x

4 x n

[ndk_public as streamConfigurationDuration]

[limited]

</td>

37529

37530

37531

This lists the minimum frame duration for each

37532

format/size combination for HEIC output formats.

</td>

(format, width, height, ns) x n

</td>

</td>

3.4

</td>

</ul>

</td>

</tr>

<th class="th_details" colspan="6">Details</th>

</tr>

This should correspond to the frame duration when only that

37559

stream is active, with all processing (typically in android.*.mode)

37560

set to either OFF or FAST.

37561

When multiple streams are used in a request, the minimum frame

37562

duration will be max(individual stream min durations).

37563

See <a href="#controls_android.sensor.frameDuration">android.sensor.frameDuration</a> and

37564

<a href="#static_android.scaler.availableStallDurations">android.scaler.availableStallDurations</a> for more details about

37565

calculating the max frame rate.

</td>

</tr>

<th class="th_details" colspan="6">HAL Implementation Details</th>

</tr>

Do not set this property directly. It is populated by camera framework and must not be

37575

set by the HAL layer.

</td>

</tr>

<td class="entry_name

37585

" rowspan="5">

37586

android.heic.availableHeicStallDurations

</td>

int64

x

4 x n

[ndk_public as streamConfigurationDuration]

[limited]

</td>

37604

37605

37606

This lists the maximum stall duration for each

37607

output format/size combination for HEIC streams.

</td>

(format, width, height, ns) x n

</td>

</td>

3.4

</td>

</ul>

</td>

</tr>

<th class="th_details" colspan="6">Details</th>

</tr>

A stall duration is how much extra time would get added

37634

to the normal minimum frame duration for a repeating request

37635

that has streams with non-zero stall.

37636

This functions similarly to

37637

<a href="#static_android.scaler.availableStallDurations">android.scaler.availableStallDurations</a> for HEIC

37638

streams.

37639

All HEIC output stream formats may have a nonzero stall

duration.

</td>

</tr>

<th class="th_details" colspan="6">HAL Implementation Details</th>

</tr>

Do not set this property directly. It is populated by camera framework and must not be

37650

set by the HAL layer.

</td>

</tr>

37656

Jayant Chowdhary

2020-11-09 09:08:31 -0800

[diff] [blame]

37657

37658

37659

<td class="entry_name

37660

" rowspan="5">

37661

android.heic.availableHeicStreamConfigurationsMaximumResolution

</td>

int32

x

n x 4

[ndk_public as streamConfiguration]

<li>

OUTPUT (v3.6)

</li>

<li>

INPUT (v3.6)

</li>

</ul>

</td>

37686

37687

37688

The available HEIC (ISO/IEC 23008-12) stream

37689

configurations that this camera device supports

37690

(i.e. format, width, height, output/input stream).

</td>

</td>

</td>

3.6

</td>

</ul>

</td>

</tr>

<th class="th_details" colspan="6">Details</th>

</tr>

Refer to <a href="#static_android.heic.availableHeicStreamConfigurations">android.heic.availableHeicStreamConfigurations</a> for details.

</td>

</tr>

<th class="th_details" colspan="6">HAL Implementation Details</th>

</tr>

These are output stream configurations for use with dataSpace HAL_DATASPACE_HEIF.

37725

Do not set this property directly. It is populated by camera framework and must not be

37726

set by the HAL layer.

</td>

</tr>

<td class="entry_name

37736

" rowspan="5">

37737

android.heic.availableHeicMinFrameDurationsMaximumResolution

</td>

int64

x

4 x n

[ndk_public as streamConfigurationDuration]

</td>

37754

37755

37756

This lists the minimum frame duration for each

37757

format/size combination for HEIC output formats for CaptureRequests where

37758

<a href="#controls_android.sensor.pixelMode">android.sensor.pixelMode</a> is set to

37759

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraMetadata.html#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION">CameraMetadata#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION</a>.

</td>

(format, width, height, ns) x n

</td>

</td>

3.6

</td>

</ul>

</td>

</tr>

<th class="th_details" colspan="6">Details</th>

</tr>

Refer to <a href="#static_android.heic.availableHeicMinFrameDurations">android.heic.availableHeicMinFrameDurations</a> for details.

</td>

</tr>

<th class="th_details" colspan="6">HAL Implementation Details</th>

</tr>

Do not set this property directly. It is populated by camera framework and must not be

37795

set by the HAL layer.

</td>

</tr>

<td class="entry_name

37805

" rowspan="5">

37806

android.heic.availableHeicStallDurationsMaximumResolution

</td>

int64

x

4 x n

[ndk_public as streamConfigurationDuration]

</td>

37823

37824

37825

This lists the maximum stall duration for each

37826

output format/size combination for HEIC streams for CaptureRequests where

37827

<a href="#controls_android.sensor.pixelMode">android.sensor.pixelMode</a> is set to

37828

<a href="https://developer.android.com/reference/android/hardware/camera2/CameraMetadata.html#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION">CameraMetadata#SENSOR_PIXEL_MODE_MAXIMUM_RESOLUTION</a>.

</td>

(format, width, height, ns) x n

</td>

</td>

3.6

</td>

</ul>

</td>

</tr>

<th class="th_details" colspan="6">Details</th>

</tr>

Refer to <a href="#static_android.heic.availableHeicStallDurations">android.heic.availableHeicStallDurations</a> for details.

</td>

</tr>

<th class="th_details" colspan="6">HAL Implementation Details</th>

</tr>

Do not set this property directly. It is populated by camera framework and must not be

37864

set by the HAL layer.

</td>

</tr>

37870

Shuzhen Wang

2018-12-28 18:50:53 -0800

[diff] [blame]

</tbody>

Changyeon Jo

2022-01-19 13:51:47 -0800

[diff] [blame]

37877

<tr><td colspan="7" id="section_automotive" class="section">automotive</td></tr>

37878

37879

37880

<tr><td colspan="7" class="kind">static</td></tr>

<tr>

<th class="th_name">Property Name</th>

37885

37886

<th class="th_description">Description</th>

37887

<th class="th_units">Units</th>

37888

<th class="th_range">Range</th>

37889

<th class="th_hal_version">Initial HIDL HAL version</th>

</tr>

</thead>

<tbody>

<td class="entry_name

37909

" rowspan="3">

37910

android.automotive.lens.facing

</td>

byte

x

n

[public]

<li>

EXTERIOR_OTHER (v3.8)

37928

The camera device faces the outside of the vehicle body frame but not exactly

37929

one of the exterior sides defined by this enum. Applications should determine

37930

the exact facing direction from <a href="#static_android.lens.poseRotation">android.lens.poseRotation</a> and

37931

<a href="#static_android.lens.poseTranslation">android.lens.poseTranslation</a>.

37932

</li>

37933

<li>

37934

EXTERIOR_FRONT (v3.8)

37935

The camera device faces the front of the vehicle body frame.

</li>

<li>

EXTERIOR_REAR (v3.8)

The camera device faces the rear of the vehicle body frame.

</li>

<li>

EXTERIOR_LEFT (v3.8)

The camera device faces the left side of the vehicle body frame.

37944

</li>

37945

<li>

37946

EXTERIOR_RIGHT (v3.8)

37947

The camera device faces the right side of the vehicle body frame.

37948

</li>

37949

<li>

37950

INTERIOR_OTHER (v3.8)

37951

The camera device faces the inside of the vehicle body frame but not exactly

37952

one of seats described by this enum. Applications should determine the exact

37953

facing direction from <a href="#static_android.lens.poseRotation">android.lens.poseRotation</a> and <a href="#static_android.lens.poseTranslation">android.lens.poseTranslation</a>.

37954

</li>

37955

<li>

37956

INTERIOR_SEAT_ROW_1_LEFT (v3.8)

37957

The camera device faces the left side seat of the first row.

37958

</li>

37959

<li>

37960

INTERIOR_SEAT_ROW_1_CENTER (v3.8)

37961

The camera device faces the center seat of the first row.

37962

</li>

37963

<li>

37964

INTERIOR_SEAT_ROW_1_RIGHT (v3.8)

37965

The camera device faces the right seat of the first row.

37966

</li>

37967

<li>

37968

INTERIOR_SEAT_ROW_2_LEFT (v3.8)

37969

The camera device faces the left side seat of the second row.

37970

</li>

37971

<li>

37972

INTERIOR_SEAT_ROW_2_CENTER (v3.8)

37973

The camera device faces the center seat of the second row.

37974

</li>

37975

<li>

37976

INTERIOR_SEAT_ROW_2_RIGHT (v3.8)

37977

The camera device faces the right side seat of the second row.

37978

</li>

37979

<li>

37980

INTERIOR_SEAT_ROW_3_LEFT (v3.8)

37981

The camera device faces the left side seat of the third row.

37982

</li>

37983

<li>

37984

INTERIOR_SEAT_ROW_3_CENTER (v3.8)

37985

The camera device faces the center seat of the third row.

37986

</li>

37987

<li>

37988

INTERIOR_SEAT_ROW_3_RIGHT (v3.8)

37989

The camera device faces the right seat of the third row.

</li>

</ul>

</td>

37994

37995

37996

The direction of the camera faces relative to the vehicle body frame and the

passenger seats.

</td>

</td>

</td>

3.8

</td>

</td>

</tr>

<th class="th_details" colspan="6">Details</th>

</tr>

This enum defines the lens facing characteristic of the cameras on the automotive

38020

devices with locations <a href="#static_android.automotive.location">android.automotive.location</a> defines. If the system has

38021

FEATURE_AUTOMOTIVE, the camera will have this entry in its static metadata.

38022

When <a href="#static_android.automotive.location">android.automotive.location</a> is INTERIOR, this has one or more INTERIOR_*

38023

values or a single EXTERIOR_* value. When this has more than one INTERIOR_*,

38024

the first value must be the one for the seat closest to the optical axis. If this

38025

contains INTERIOR_OTHER, all other values will be ineffective.

38026

When <a href="#static_android.automotive.location">android.automotive.location</a> is EXTERIOR_* or EXTRA, this has a single

38027

EXTERIOR_* value.

38028

If a camera has INTERIOR_OTHER or EXTERIOR_OTHER, or more than one camera is at the

38029

same location and facing the same direction, their static metadata will list the

Shuzhen Wang

2022-05-03 11:01:26 -0700

[diff] [blame]

38030

following entries, so that applications can determine their lenses' exact facing

Changyeon Jo

2022-01-19 13:51:47 -0800

[diff] [blame]

38031

directions:

38032

<ul>

38033

<li><a href="#static_android.lens.poseReference">android.lens.poseReference</a></li>

38034

<li><a href="#static_android.lens.poseRotation">android.lens.poseRotation</a></li>

38035

<li><a href="#static_android.lens.poseTranslation">android.lens.poseTranslation</a></li>

</ul>

</td>

</tr>

<td class="entry_name

38050

" rowspan="3">

38051

android.automotive.location

</td>

byte

[public]

<li>

INTERIOR (v3.8)

The camera device exists inside of the vehicle cabin.

38066

</li>

38067

<li>

38068

EXTERIOR_OTHER (v3.8)

38069

The camera exists outside of the vehicle body frame but not exactly on one of the

38070

exterior locations this enum defines. The applications should determine the exact

38071

location from <a href="#static_android.lens.poseTranslation">android.lens.poseTranslation</a>.

38072

</li>

38073

<li>

38074

EXTERIOR_FRONT (v3.8)

38075

The camera device exists outside of the vehicle body frame and on its front side.

</li>

<li>

EXTERIOR_REAR (v3.8)

The camera device exists outside of the vehicle body frame and on its rear side.

</li>

<li>

EXTERIOR_LEFT (v3.8)

The camera device exists outside and on left side of the vehicle body frame.

38084

</li>

38085

<li>

38086

EXTERIOR_RIGHT (v3.8)

38087

The camera device exists outside and on right side of the vehicle body frame.

</li>

<li>

EXTRA_OTHER (v3.8)

The camera device exists on an extra vehicle, such as the trailer, but not exactly

38092

on one of front, rear, left, or right side. Applications should determine the exact

38093

location from <a href="#static_android.lens.poseTranslation">android.lens.poseTranslation</a>.

</li>

<li>

EXTRA_FRONT (v3.8)

The camera device exists outside of the extra vehicle's body frame and on its front

side.

</li>

<li>

EXTRA_REAR (v3.8)

The camera device exists outside of the extra vehicle's body frame and on its rear

side.

</li>

<li>

EXTRA_LEFT (v3.8)

The camera device exists outside and on left side of the extra vehicle body.

</li>

<li>

EXTRA_RIGHT (v3.8)

The camera device exists outside and on right side of the extra vehicle body.

</li>

</ul>

</td>

38116

38117

38118

Location of the cameras on the automotive devices.

</td>

</td>

</td>

3.8

</td>

</td>

</tr>

<th class="th_details" colspan="6">Details</th>

</tr>

This enum defines the locations of the cameras relative to the vehicle body frame on

38141

<a href="https://source.android.com/devices/sensors/sensor-types#auto_axes">the automotive sensor coordinate system</a>.

38142

If the system has FEATURE_AUTOMOTIVE, the camera will have this entry in its static

38143

metadata.

38144

<ul>

38145

<li>INTERIOR is the inside of the vehicle body frame (or the passenger cabin).</li>

38146

<li>EXTERIOR is the outside of the vehicle body frame.</li>

38147

<li>EXTRA is the extra vehicle such as a trailer.</li>

38148

</ul>

38149

Each side of the vehicle body frame on this coordinate system is defined as below:

38150

<ul>

38151

<li>FRONT is where the Y-axis increases toward.</li>

38152

<li>REAR is where the Y-axis decreases toward.</li>

38153

<li>LEFT is where the X-axis decreases toward.</li>

38154

<li>RIGHT is where the X-axis increases toward.</li>

38155

</ul>

38156

If the camera has either EXTERIOR_OTHER or EXTRA_OTHER, its static metadata will list

38157

the following entries, so that applications can determine the camera's exact location:

38158

<ul>

38159

<li><a href="#static_android.lens.poseReference">android.lens.poseReference</a></li>

38160

<li><a href="#static_android.lens.poseRotation">android.lens.poseRotation</a></li>

38161

<li><a href="#static_android.lens.poseTranslation">android.lens.poseTranslation</a></li>

</ul>

</td>

</tr>

</tbody>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

38176

</table>

<ul>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

38182

<li id="tag_BC">BC -

38183

Needed for backwards compatibility with old Java API

38184

38185

Eino-Ville Talvala

2013-12-30 12:03:45 -0800

[diff] [blame]

38186

<li><a href="#controls_android.control.aeAntibandingMode">android.control.aeAntibandingMode</a> (controls)</li>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

38187

<li><a href="#controls_android.control.aeExposureCompensation">android.control.aeExposureCompensation</a> (controls)</li>

38188

<li><a href="#controls_android.control.aeLock">android.control.aeLock</a> (controls)</li>

38189

<li><a href="#controls_android.control.aeMode">android.control.aeMode</a> (controls)</li>

38190

<li><a href="#controls_android.control.aeRegions">android.control.aeRegions</a> (controls)</li>

38191

<li><a href="#controls_android.control.aeTargetFpsRange">android.control.aeTargetFpsRange</a> (controls)</li>

Eino-Ville Talvala

2013-03-18 09:42:48 -0700

[diff] [blame]

38192

<li><a href="#controls_android.control.aePrecaptureTrigger">android.control.aePrecaptureTrigger</a> (controls)</li>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

38193

<li><a href="#controls_android.control.afMode">android.control.afMode</a> (controls)</li>

38194

<li><a href="#controls_android.control.afRegions">android.control.afRegions</a> (controls)</li>

Eino-Ville Talvala

2013-03-18 09:42:48 -0700

[diff] [blame]

38195

<li><a href="#controls_android.control.afTrigger">android.control.afTrigger</a> (controls)</li>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

38196

<li><a href="#controls_android.control.awbLock">android.control.awbLock</a> (controls)</li>

38197

<li><a href="#controls_android.control.awbMode">android.control.awbMode</a> (controls)</li>

38198

<li><a href="#controls_android.control.awbRegions">android.control.awbRegions</a> (controls)</li>

38199

<li><a href="#controls_android.control.captureIntent">android.control.captureIntent</a> (controls)</li>

38200

<li><a href="#controls_android.control.effectMode">android.control.effectMode</a> (controls)</li>

38201

<li><a href="#controls_android.control.mode">android.control.mode</a> (controls)</li>

38202

<li><a href="#controls_android.control.sceneMode">android.control.sceneMode</a> (controls)</li>

38203

<li><a href="#controls_android.control.videoStabilizationMode">android.control.videoStabilizationMode</a> (controls)</li>

Zhijun He

2014-05-21 17:51:05 -0700

[diff] [blame]

38204

<li><a href="#static_android.control.aeAvailableAntibandingModes">android.control.aeAvailableAntibandingModes</a> (static)</li>

Eino-Ville Talvala

2014-01-08 16:16:53 -0800

[diff] [blame]

38205

<li><a href="#static_android.control.aeAvailableModes">android.control.aeAvailableModes</a> (static)</li>

Zhijun He

2014-05-21 17:51:05 -0700

[diff] [blame]

38206

<li><a href="#static_android.control.aeAvailableTargetFpsRanges">android.control.aeAvailableTargetFpsRanges</a> (static)</li>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

38207

<li><a href="#static_android.control.aeCompensationRange">android.control.aeCompensationRange</a> (static)</li>

38208

<li><a href="#static_android.control.aeCompensationStep">android.control.aeCompensationStep</a> (static)</li>

38209

<li><a href="#static_android.control.afAvailableModes">android.control.afAvailableModes</a> (static)</li>

38210

<li><a href="#static_android.control.availableEffects">android.control.availableEffects</a> (static)</li>

38211

<li><a href="#static_android.control.availableSceneModes">android.control.availableSceneModes</a> (static)</li>

38212

<li><a href="#static_android.control.availableVideoStabilizationModes">android.control.availableVideoStabilizationModes</a> (static)</li>

38213

<li><a href="#static_android.control.awbAvailableModes">android.control.awbAvailableModes</a> (static)</li>

38214

<li><a href="#static_android.control.maxRegions">android.control.maxRegions</a> (static)</li>

38215

<li><a href="#static_android.control.sceneModeOverrides">android.control.sceneModeOverrides</a> (static)</li>

Yin-Chia Yeh

2015-02-20 15:34:14 -0800

[diff] [blame]

38216

<li><a href="#static_android.control.aeLockAvailable">android.control.aeLockAvailable</a> (static)</li>

38217

<li><a href="#static_android.control.awbLockAvailable">android.control.awbLockAvailable</a> (static)</li>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

38218

<li><a href="#controls_android.flash.mode">android.flash.mode</a> (controls)</li>

38219

<li><a href="#static_android.flash.info.available">android.flash.info.available</a> (static)</li>

38220

<li><a href="#controls_android.jpeg.gpsCoordinates">android.jpeg.gpsCoordinates</a> (controls)</li>

38221

<li><a href="#controls_android.jpeg.gpsProcessingMethod">android.jpeg.gpsProcessingMethod</a> (controls)</li>

38222

<li><a href="#controls_android.jpeg.gpsTimestamp">android.jpeg.gpsTimestamp</a> (controls)</li>

38223

<li><a href="#controls_android.jpeg.orientation">android.jpeg.orientation</a> (controls)</li>

38224

<li><a href="#controls_android.jpeg.quality">android.jpeg.quality</a> (controls)</li>

38225

<li><a href="#controls_android.jpeg.thumbnailQuality">android.jpeg.thumbnailQuality</a> (controls)</li>

38226

<li><a href="#controls_android.jpeg.thumbnailSize">android.jpeg.thumbnailSize</a> (controls)</li>

38227

<li><a href="#static_android.jpeg.availableThumbnailSizes">android.jpeg.availableThumbnailSizes</a> (static)</li>

38228

<li><a href="#controls_android.lens.focusDistance">android.lens.focusDistance</a> (controls)</li>

38229

<li><a href="#static_android.lens.info.availableFocalLengths">android.lens.info.availableFocalLengths</a> (static)</li>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

38230

<li><a href="#dynamic_android.lens.focusRange">android.lens.focusRange</a> (dynamic)</li>

38231

<li><a href="#static_android.request.maxNumOutputStreams">android.request.maxNumOutputStreams</a> (static)</li>

38232

<li><a href="#controls_android.scaler.cropRegion">android.scaler.cropRegion</a> (controls)</li>

38233

<li><a href="#static_android.scaler.availableFormats">android.scaler.availableFormats</a> (static)</li>

38234

<li><a href="#static_android.scaler.availableJpegMinDurations">android.scaler.availableJpegMinDurations</a> (static)</li>

38235

<li><a href="#static_android.scaler.availableJpegSizes">android.scaler.availableJpegSizes</a> (static)</li>

Igor Murashkin

f11a4df

2013-05-07 10:00:46 -0700

[diff] [blame]

38236

<li><a href="#static_android.scaler.availableMaxDigitalZoom">android.scaler.availableMaxDigitalZoom</a> (static)</li>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

38237

<li><a href="#static_android.scaler.availableProcessedMinDurations">android.scaler.availableProcessedMinDurations</a> (static)</li>

38238

<li><a href="#static_android.scaler.availableProcessedSizes">android.scaler.availableProcessedSizes</a> (static)</li>

38239

<li><a href="#static_android.scaler.availableRawMinDurations">android.scaler.availableRawMinDurations</a> (static)</li>

Zhijun He

2013-07-17 09:42:58 -0700

[diff] [blame]

38240

<li><a href="#static_android.sensor.info.sensitivityRange">android.sensor.info.sensitivityRange</a> (static)</li>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

38241

<li><a href="#static_android.sensor.info.physicalSize">android.sensor.info.physicalSize</a> (static)</li>

38242

<li><a href="#static_android.sensor.info.pixelArraySize">android.sensor.info.pixelArraySize</a> (static)</li>

38243

<li><a href="#static_android.sensor.orientation">android.sensor.orientation</a> (static)</li>

38244

<li><a href="#dynamic_android.sensor.timestamp">android.sensor.timestamp</a> (dynamic)</li>

38245

<li><a href="#controls_android.statistics.faceDetectMode">android.statistics.faceDetectMode</a> (controls)</li>

Zhijun He

2014-05-23 11:02:34 -0700

[diff] [blame]

38246

<li><a href="#static_android.statistics.info.maxFaceCount">android.statistics.info.maxFaceCount</a> (static)</li>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

38247

<li><a href="#dynamic_android.statistics.faceIds">android.statistics.faceIds</a> (dynamic)</li>

38248

<li><a href="#dynamic_android.statistics.faceLandmarks">android.statistics.faceLandmarks</a> (dynamic)</li>

38249

<li><a href="#dynamic_android.statistics.faceRectangles">android.statistics.faceRectangles</a> (dynamic)</li>

38250

<li><a href="#dynamic_android.statistics.faceScores">android.statistics.faceScores</a> (dynamic)</li>

38251

<li><a href="#dynamic_android.lens.focalLength">android.lens.focalLength</a> (dynamic)</li>

38252

<li><a href="#dynamic_android.lens.focusDistance">android.lens.focusDistance</a> (dynamic)</li>

38253

</ul>

38254

</li>

38255

<li id="tag_V1">V1 -

38256

New features for first camera 2 release (API1)

38257

38258

Zhijun He

2014-08-18 10:55:33 -0700

[diff] [blame]

38259

<li><a href="#static_android.colorCorrection.availableAberrationModes">android.colorCorrection.availableAberrationModes</a> (static)</li>

Zhijun He

2014-06-10 18:21:34 -0700

[diff] [blame]

38260

<li><a href="#static_android.control.availableHighSpeedVideoConfigurations">android.control.availableHighSpeedVideoConfigurations</a> (static)</li>

Jayant Chowdhary

2020-11-09 09:08:31 -0800

[diff] [blame]

38261

<li><a href="#static_android.control.availableHighSpeedVideoConfigurationsMaximumResolution">android.control.availableHighSpeedVideoConfigurationsMaximumResolution</a> (static)</li>

Ruben Brunk

2014-03-04 15:01:25 -0800

[diff] [blame]

38262

<li><a href="#controls_android.edge.mode">android.edge.mode</a> (controls)</li>

Ruben Brunk

2014-03-04 15:01:25 -0800

[diff] [blame]

38263

<li><a href="#static_android.edge.availableEdgeModes">android.edge.availableEdgeModes</a> (static)</li>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

38264

<li><a href="#controls_android.hotPixel.mode">android.hotPixel.mode</a> (controls)</li>

Ruben Brunk

2014-03-04 14:09:44 -0800

[diff] [blame]

38265

<li><a href="#static_android.hotPixel.availableHotPixelModes">android.hotPixel.availableHotPixelModes</a> (static)</li>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

38266

<li><a href="#controls_android.lens.aperture">android.lens.aperture</a> (controls)</li>

38267

<li><a href="#controls_android.lens.filterDensity">android.lens.filterDensity</a> (controls)</li>

38268

<li><a href="#controls_android.lens.focalLength">android.lens.focalLength</a> (controls)</li>

38269

<li><a href="#controls_android.lens.focusDistance">android.lens.focusDistance</a> (controls)</li>

38270

<li><a href="#controls_android.lens.opticalStabilizationMode">android.lens.opticalStabilizationMode</a> (controls)</li>

38271

<li><a href="#static_android.lens.info.availableApertures">android.lens.info.availableApertures</a> (static)</li>

38272

<li><a href="#static_android.lens.info.availableFilterDensities">android.lens.info.availableFilterDensities</a> (static)</li>

38273

<li><a href="#static_android.lens.info.availableFocalLengths">android.lens.info.availableFocalLengths</a> (static)</li>

38274

<li><a href="#static_android.lens.info.availableOpticalStabilization">android.lens.info.availableOpticalStabilization</a> (static)</li>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

38275

<li><a href="#static_android.lens.info.minimumFocusDistance">android.lens.info.minimumFocusDistance</a> (static)</li>

38276

<li><a href="#static_android.lens.info.shadingMapSize">android.lens.info.shadingMapSize</a> (static)</li>

Zhijun He

2014-02-06 01:40:35 -0800

[diff] [blame]

38277

<li><a href="#static_android.lens.info.focusDistanceCalibration">android.lens.info.focusDistanceCalibration</a> (static)</li>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

38278

<li><a href="#dynamic_android.lens.state">android.lens.state</a> (dynamic)</li>

38279

<li><a href="#controls_android.noiseReduction.mode">android.noiseReduction.mode</a> (controls)</li>

Ruben Brunk

2014-03-04 15:01:25 -0800

[diff] [blame]

38280

<li><a href="#static_android.noiseReduction.availableNoiseReductionModes">android.noiseReduction.availableNoiseReductionModes</a> (static)</li>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

38281

<li><a href="#controls_android.request.id">android.request.id</a> (controls)</li>

Zhijun He

2014-05-21 17:51:05 -0700

[diff] [blame]

38282

<li><a href="#static_android.scaler.availableMinFrameDurations">android.scaler.availableMinFrameDurations</a> (static)</li>

38283

<li><a href="#static_android.scaler.availableStallDurations">android.scaler.availableStallDurations</a> (static)</li>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

38284

<li><a href="#controls_android.sensor.exposureTime">android.sensor.exposureTime</a> (controls)</li>

38285

<li><a href="#controls_android.sensor.frameDuration">android.sensor.frameDuration</a> (controls)</li>

38286

<li><a href="#controls_android.sensor.sensitivity">android.sensor.sensitivity</a> (controls)</li>

Zhijun He

2013-07-17 09:42:58 -0700

[diff] [blame]

38287

<li><a href="#static_android.sensor.info.sensitivityRange">android.sensor.info.sensitivityRange</a> (static)</li>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

38288

<li><a href="#static_android.sensor.info.exposureTimeRange">android.sensor.info.exposureTimeRange</a> (static)</li>

38289

<li><a href="#static_android.sensor.info.maxFrameDuration">android.sensor.info.maxFrameDuration</a> (static)</li>

38290

<li><a href="#static_android.sensor.info.physicalSize">android.sensor.info.physicalSize</a> (static)</li>

Eino-Ville Talvala

2014-07-28 12:49:25 -0700

[diff] [blame]

38291

<li><a href="#static_android.sensor.info.timestampSource">android.sensor.info.timestampSource</a> (static)</li>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

38292

<li><a href="#static_android.sensor.maxAnalogSensitivity">android.sensor.maxAnalogSensitivity</a> (static)</li>

Zhijun He

2014-06-11 10:44:53 -0700

[diff] [blame]

38293

<li><a href="#dynamic_android.sensor.rollingShutterSkew">android.sensor.rollingShutterSkew</a> (dynamic)</li>

Ruben Brunk

2014-03-04 14:09:44 -0800

[diff] [blame]

38294

<li><a href="#controls_android.statistics.hotPixelMapMode">android.statistics.hotPixelMapMode</a> (controls)</li>

38295

<li><a href="#static_android.statistics.info.availableHotPixelMapModes">android.statistics.info.availableHotPixelMapModes</a> (static)</li>

Ruben Brunk

2014-03-04 14:09:44 -0800

[diff] [blame]

38296

<li><a href="#dynamic_android.statistics.hotPixelMap">android.statistics.hotPixelMap</a> (dynamic)</li>

Zhijun He

2014-05-21 17:51:05 -0700

[diff] [blame]

38297

<li><a href="#dynamic_android.sync.frameNumber">android.sync.frameNumber</a> (dynamic)</li>

38298

<li><a href="#static_android.sync.maxLatency">android.sync.maxLatency</a> (static)</li>

Eino-Ville Talvala

2018-03-13 19:46:57 -0700

[diff] [blame]

38299

<li><a href="#static_android.distortionCorrection.availableModes">android.distortionCorrection.availableModes</a> (static)</li>

Ruben Brunk

2014-03-04 15:01:25 -0800

[diff] [blame]

38300

<li><a href="#dynamic_android.edge.mode">android.edge.mode</a> (dynamic)</li>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

38301

<li><a href="#dynamic_android.hotPixel.mode">android.hotPixel.mode</a> (dynamic)</li>

38302

<li><a href="#dynamic_android.lens.aperture">android.lens.aperture</a> (dynamic)</li>

38303

<li><a href="#dynamic_android.lens.filterDensity">android.lens.filterDensity</a> (dynamic)</li>

38304

<li><a href="#dynamic_android.lens.opticalStabilizationMode">android.lens.opticalStabilizationMode</a> (dynamic)</li>

Ruben Brunk

2014-03-04 15:01:25 -0800

[diff] [blame]

38305

<li><a href="#dynamic_android.noiseReduction.mode">android.noiseReduction.mode</a> (dynamic)</li>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

38306

</ul>

38307

</li>

Eino-Ville Talvala

2014-07-15 10:43:01 -0700

[diff] [blame]

38308

<li id="tag_RAW">RAW -

38309

Needed for useful RAW image processing and DNG file support

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

38310

38311

Ruben Brunk

9d4a5e0

2014-02-18 11:27:07 -0800

[diff] [blame]

38312

<li><a href="#controls_android.hotPixel.mode">android.hotPixel.mode</a> (controls)</li>

Ruben Brunk

2014-03-04 14:09:44 -0800

[diff] [blame]

38313

<li><a href="#static_android.hotPixel.availableHotPixelModes">android.hotPixel.availableHotPixelModes</a> (static)</li>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

38314

<li><a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a> (static)</li>

38315

<li><a href="#static_android.sensor.info.colorFilterArrangement">android.sensor.info.colorFilterArrangement</a> (static)</li>

38316

<li><a href="#static_android.sensor.info.pixelArraySize">android.sensor.info.pixelArraySize</a> (static)</li>

38317

<li><a href="#static_android.sensor.info.whiteLevel">android.sensor.info.whiteLevel</a> (static)</li>

Ruben Brunk

2015-07-01 11:32:39 -0700

[diff] [blame]

38318

<li><a href="#static_android.sensor.info.preCorrectionActiveArraySize">android.sensor.info.preCorrectionActiveArraySize</a> (static)</li>

Jayant Chowdhary

2020-11-09 09:08:31 -0800

[diff] [blame]

38319

<li><a href="#static_android.sensor.info.activeArraySizeMaximumResolution">android.sensor.info.activeArraySizeMaximumResolution</a> (static)</li>

38320

<li><a href="#static_android.sensor.info.pixelArraySizeMaximumResolution">android.sensor.info.pixelArraySizeMaximumResolution</a> (static)</li>

38321

<li><a href="#static_android.sensor.info.preCorrectionActiveArraySizeMaximumResolution">android.sensor.info.preCorrectionActiveArraySizeMaximumResolution</a> (static)</li>

Ruben Brunk

2014-04-15 17:43:56 -0700

[diff] [blame]

38322

<li><a href="#static_android.sensor.referenceIlluminant1">android.sensor.referenceIlluminant1</a> (static)</li>

38323

<li><a href="#static_android.sensor.referenceIlluminant2">android.sensor.referenceIlluminant2</a> (static)</li>

38324

<li><a href="#static_android.sensor.calibrationTransform1">android.sensor.calibrationTransform1</a> (static)</li>

38325

<li><a href="#static_android.sensor.calibrationTransform2">android.sensor.calibrationTransform2</a> (static)</li>

38326

<li><a href="#static_android.sensor.colorTransform1">android.sensor.colorTransform1</a> (static)</li>

38327

<li><a href="#static_android.sensor.colorTransform2">android.sensor.colorTransform2</a> (static)</li>

38328

<li><a href="#static_android.sensor.forwardMatrix1">android.sensor.forwardMatrix1</a> (static)</li>

38329

<li><a href="#static_android.sensor.forwardMatrix2">android.sensor.forwardMatrix2</a> (static)</li>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

38330

<li><a href="#static_android.sensor.blackLevelPattern">android.sensor.blackLevelPattern</a> (static)</li>

Ruben Brunk

2014-02-06 13:04:38 -0800

[diff] [blame]

38331

<li><a href="#static_android.sensor.profileHueSatMapDimensions">android.sensor.profileHueSatMapDimensions</a> (static)</li>

Ruben Brunk

2014-02-06 18:37:48 -0800

[diff] [blame]

38332

<li><a href="#dynamic_android.sensor.neutralColorPoint">android.sensor.neutralColorPoint</a> (dynamic)</li>

Ruben Brunk

2014-07-23 15:13:16 -0700

[diff] [blame]

38333

<li><a href="#dynamic_android.sensor.noiseProfile">android.sensor.noiseProfile</a> (dynamic)</li>

Ruben Brunk

2014-02-06 13:04:38 -0800

[diff] [blame]

38334

<li><a href="#dynamic_android.sensor.profileHueSatMap">android.sensor.profileHueSatMap</a> (dynamic)</li>

38335

<li><a href="#dynamic_android.sensor.profileToneCurve">android.sensor.profileToneCurve</a> (dynamic)</li>

Ruben Brunk

2014-02-11 17:55:32 -0800

[diff] [blame]

38336

<li><a href="#dynamic_android.sensor.greenSplit">android.sensor.greenSplit</a> (dynamic)</li>

Zhijun He

2015-11-12 17:27:27 -0800

[diff] [blame]

38337

<li><a href="#dynamic_android.sensor.dynamicBlackLevel">android.sensor.dynamicBlackLevel</a> (dynamic)</li>

38338

<li><a href="#dynamic_android.sensor.dynamicWhiteLevel">android.sensor.dynamicWhiteLevel</a> (dynamic)</li>

Ruben Brunk

2014-03-04 14:09:44 -0800

[diff] [blame]

38339

<li><a href="#controls_android.statistics.hotPixelMapMode">android.statistics.hotPixelMapMode</a> (controls)</li>

38340

<li><a href="#static_android.statistics.info.availableHotPixelMapModes">android.statistics.info.availableHotPixelMapModes</a> (static)</li>

38341

<li><a href="#dynamic_android.statistics.hotPixelMap">android.statistics.hotPixelMap</a> (dynamic)</li>

Igor Murashkin

2014-10-02 15:27:09 -0700

[diff] [blame]

38342

<li><a href="#controls_android.statistics.lensShadingMapMode">android.statistics.lensShadingMapMode</a> (controls)</li>

Ruben Brunk

9d4a5e0

2014-02-18 11:27:07 -0800

[diff] [blame]

38343

<li><a href="#dynamic_android.hotPixel.mode">android.hotPixel.mode</a> (dynamic)</li>

Igor Murashkin

2012-11-29 15:23:03 -0800

[diff] [blame]

38344

</ul>

Eino-Ville Talvala

2014-07-15 10:43:01 -0700

[diff] [blame]

38345

</li>

Eino-Ville Talvala

2013-07-12 17:02:27 -0700

[diff] [blame]

38346

<li id="tag_HAL2">HAL2 -

Eino-Ville Talvala

2017-11-10 15:13:04 -0800

[diff] [blame]

38347

Entry is only used by camera device legacy HAL 2.x

Eino-Ville Talvala

2013-07-12 17:02:27 -0700

[diff] [blame]

38348

38349

38350

<li><a href="#controls_android.request.inputStreams">android.request.inputStreams</a> (controls)</li>

38351

<li><a href="#controls_android.request.outputStreams">android.request.outputStreams</a> (controls)</li>

38352

<li><a href="#controls_android.request.type">android.request.type</a> (controls)</li>

Zhijun He

2014-01-22 15:58:57 -0800

[diff] [blame]

38353

<li><a href="#static_android.request.maxNumReprocessStreams">android.request.maxNumReprocessStreams</a> (static)</li>

Zhijun He

2013-07-17 09:42:58 -0700

[diff] [blame]

38354

<li><a href="#controls_android.blackLevel.lock">android.blackLevel.lock</a> (controls)</li>

Eino-Ville Talvala

2013-07-12 17:02:27 -0700

[diff] [blame]

38355

</ul>

38356

</li>

Alex Ray

2013-10-01 17:52:33 -0700

[diff] [blame]

38357

<li id="tag_FULL">FULL -

38358

Entry is required for full hardware level devices, and optional for other hardware levels

38359

38360

Alex Ray

2013-10-01 17:52:33 -0700

[diff] [blame]

38361

<li><a href="#static_android.sensor.maxAnalogSensitivity">android.sensor.maxAnalogSensitivity</a> (static)</li>

Alex Ray

2013-10-01 17:52:33 -0700

[diff] [blame]

38362

</ul>

38363

</li>

Eino-Ville Talvala

2015-02-23 15:51:58 -0800

[diff] [blame]

38364

<li id="tag_DEPTH">DEPTH -

38365

Entry is required for the depth capability.

38366

38367

Eino-Ville Talvala

2015-02-09 15:47:27 -0800

[diff] [blame]

38368

<li><a href="#static_android.lens.poseRotation">android.lens.poseRotation</a> (static)</li>

38369

<li><a href="#static_android.lens.poseTranslation">android.lens.poseTranslation</a> (static)</li>

38370

<li><a href="#static_android.lens.intrinsicCalibration">android.lens.intrinsicCalibration</a> (static)</li>

38371

<li><a href="#static_android.lens.radialDistortion">android.lens.radialDistortion</a> (static)</li>

Eino-Ville Talvala

2018-03-13 19:10:23 -0700

[diff] [blame]

38372

<li><a href="#static_android.lens.distortion">android.lens.distortion</a> (static)</li>

Jayant Chowdhary

2020-11-09 09:08:31 -0800

[diff] [blame]

38373

<li><a href="#static_android.lens.distortionMaximumResolution">android.lens.distortionMaximumResolution</a> (static)</li>

38374

<li><a href="#static_android.lens.intrinsicCalibrationMaximumResolution">android.lens.intrinsicCalibrationMaximumResolution</a> (static)</li>

Eino-Ville Talvala

2015-02-23 15:51:58 -0800

[diff] [blame]

38375

<li><a href="#static_android.depth.maxDepthSamples">android.depth.maxDepthSamples</a> (static)</li>

38376

<li><a href="#static_android.depth.availableDepthStreamConfigurations">android.depth.availableDepthStreamConfigurations</a> (static)</li>

38377

<li><a href="#static_android.depth.availableDepthMinFrameDurations">android.depth.availableDepthMinFrameDurations</a> (static)</li>

38378

<li><a href="#static_android.depth.availableDepthStallDurations">android.depth.availableDepthStallDurations</a> (static)</li>

Emilian Peev

65860e4

2019-01-04 17:49:37 +0000

[diff] [blame]

38379

<li><a href="#static_android.depth.availableDynamicDepthStreamConfigurations">android.depth.availableDynamicDepthStreamConfigurations</a> (static)</li>

38380

<li><a href="#static_android.depth.availableDynamicDepthMinFrameDurations">android.depth.availableDynamicDepthMinFrameDurations</a> (static)</li>

38381

<li><a href="#static_android.depth.availableDynamicDepthStallDurations">android.depth.availableDynamicDepthStallDurations</a> (static)</li>

Jayant Chowdhary

2020-11-09 09:08:31 -0800

[diff] [blame]

38382

<li><a href="#static_android.depth.availableDepthStreamConfigurationsMaximumResolution">android.depth.availableDepthStreamConfigurationsMaximumResolution</a> (static)</li>

38383

<li><a href="#static_android.depth.availableDepthMinFrameDurationsMaximumResolution">android.depth.availableDepthMinFrameDurationsMaximumResolution</a> (static)</li>

38384

<li><a href="#static_android.depth.availableDepthStallDurationsMaximumResolution">android.depth.availableDepthStallDurationsMaximumResolution</a> (static)</li>

38385

<li><a href="#static_android.depth.availableDynamicDepthStreamConfigurationsMaximumResolution">android.depth.availableDynamicDepthStreamConfigurationsMaximumResolution</a> (static)</li>

38386

<li><a href="#static_android.depth.availableDynamicDepthMinFrameDurationsMaximumResolution">android.depth.availableDynamicDepthMinFrameDurationsMaximumResolution</a> (static)</li>

38387

<li><a href="#static_android.depth.availableDynamicDepthStallDurationsMaximumResolution">android.depth.availableDynamicDepthStallDurationsMaximumResolution</a> (static)</li>

Eino-Ville Talvala

2015-02-23 15:51:58 -0800

[diff] [blame]

38388

</ul>

38389

</li>

Zhijun He

2015-04-24 17:59:50 -0700

[diff] [blame]

38390

<li id="tag_REPROC">REPROC -

Chien-Yu Chen

2015-05-12 15:13:00 -0700

[diff] [blame]

38391

Entry is required for the YUV or PRIVATE reprocessing capability.

Zhijun He

2015-04-24 17:59:50 -0700

[diff] [blame]

38392

38393

38394

<li><a href="#controls_android.edge.mode">android.edge.mode</a> (controls)</li>

38395

<li><a href="#static_android.edge.availableEdgeModes">android.edge.availableEdgeModes</a> (static)</li>

38396

<li><a href="#controls_android.noiseReduction.mode">android.noiseReduction.mode</a> (controls)</li>

38397

<li><a href="#static_android.noiseReduction.availableNoiseReductionModes">android.noiseReduction.availableNoiseReductionModes</a> (static)</li>

38398

<li><a href="#static_android.request.maxNumInputStreams">android.request.maxNumInputStreams</a> (static)</li>

38399

<li><a href="#static_android.scaler.availableInputOutputFormatsMap">android.scaler.availableInputOutputFormatsMap</a> (static)</li>

Emilian Peev

2018-09-18 14:01:55 +0100

[diff] [blame]

38400

<li><a href="#static_android.scaler.availableRecommendedInputOutputFormatsMap">android.scaler.availableRecommendedInputOutputFormatsMap</a> (static)</li>

Jayant Chowdhary

2020-11-09 09:08:31 -0800

[diff] [blame]

38401

<li><a href="#static_android.scaler.availableInputOutputFormatsMapMaximumResolution">android.scaler.availableInputOutputFormatsMapMaximumResolution</a> (static)</li>

Zhijun He

2015-04-24 17:59:50 -0700

[diff] [blame]

38402

<li><a href="#controls_android.reprocess.effectiveExposureFactor">android.reprocess.effectiveExposureFactor</a> (controls)</li>

38403

<li><a href="#static_android.reprocess.maxCaptureStall">android.reprocess.maxCaptureStall</a> (static)</li>

Eino-Ville Talvala

2018-03-13 19:46:57 -0700

[diff] [blame]

38404

<li><a href="#static_android.distortionCorrection.availableModes">android.distortionCorrection.availableModes</a> (static)</li>

Zhijun He

2015-04-24 17:59:50 -0700

[diff] [blame]

38405

<li><a href="#dynamic_android.edge.mode">android.edge.mode</a> (dynamic)</li>

38406

<li><a href="#dynamic_android.noiseReduction.mode">android.noiseReduction.mode</a> (dynamic)</li>

38407

</ul>

38408

</li>

Shuzhen Wang

2017-11-30 12:03:37 -0800

[diff] [blame]

38409

<li id="tag_LOGICALCAMERA">LOGICALCAMERA -

38410

Entry is required for logical multi-camera capability.

38411

38412

38413

<li><a href="#static_android.logicalMultiCamera.physicalIds">android.logicalMultiCamera.physicalIds</a> (static)</li>

38414

<li><a href="#static_android.logicalMultiCamera.sensorSyncType">android.logicalMultiCamera.sensorSyncType</a> (static)</li>

Shuzhen Wang

2018-11-19 12:15:18 -0800

[diff] [blame]

38415

<li><a href="#dynamic_android.logicalMultiCamera.activePhysicalId">android.logicalMultiCamera.activePhysicalId</a> (dynamic)</li>

Shuzhen Wang

2017-11-30 12:03:37 -0800

[diff] [blame]

38416

</ul>

38417

</li>

Shuzhen Wang

2018-12-28 18:50:53 -0800

[diff] [blame]

38418

<li id="tag_HEIC">HEIC -

38419

Entry is required for devices with HEIC (High Efficiency Image Format) support.

38420

38421

38422

<li><a href="#static_android.heic.info.supported">android.heic.info.supported</a> (static)</li>

38423

<li><a href="#static_android.heic.info.maxJpegAppSegmentsCount">android.heic.info.maxJpegAppSegmentsCount</a> (static)</li>

38424

<li><a href="#static_android.heic.availableHeicStreamConfigurations">android.heic.availableHeicStreamConfigurations</a> (static)</li>

38425

<li><a href="#static_android.heic.availableHeicMinFrameDurations">android.heic.availableHeicMinFrameDurations</a> (static)</li>

38426

<li><a href="#static_android.heic.availableHeicStallDurations">android.heic.availableHeicStallDurations</a> (static)</li>

Jayant Chowdhary

2020-11-09 09:08:31 -0800

[diff] [blame]

38427

<li><a href="#static_android.heic.availableHeicStreamConfigurationsMaximumResolution">android.heic.availableHeicStreamConfigurationsMaximumResolution</a> (static)</li>

38428

<li><a href="#static_android.heic.availableHeicMinFrameDurationsMaximumResolution">android.heic.availableHeicMinFrameDurationsMaximumResolution</a> (static)</li>

38429

<li><a href="#static_android.heic.availableHeicStallDurationsMaximumResolution">android.heic.availableHeicStallDurationsMaximumResolution</a> (static)</li>

Shuzhen Wang

2018-12-28 18:50:53 -0800

[diff] [blame]

38430

</ul>

38431

</li>

Zhijun He

2014-05-23 11:02:34 -0700

[diff] [blame]

38432

<li id="tag_FUTURE">FUTURE -

38433

Entry is under-specified and is not required for now. This is for book-keeping purpose,

38434

do not implement or use it, it may be revised for future.

38435

38436

38437

<li><a href="#controls_android.demosaic.mode">android.demosaic.mode</a> (controls)</li>

38438

<li><a href="#controls_android.edge.strength">android.edge.strength</a> (controls)</li>

38439

<li><a href="#controls_android.flash.firingPower">android.flash.firingPower</a> (controls)</li>

38440

<li><a href="#controls_android.flash.firingTime">android.flash.firingTime</a> (controls)</li>

38441

<li><a href="#static_android.flash.info.chargeDuration">android.flash.info.chargeDuration</a> (static)</li>

38442

<li><a href="#static_android.flash.colorTemperature">android.flash.colorTemperature</a> (static)</li>

38443

<li><a href="#static_android.flash.maxEnergy">android.flash.maxEnergy</a> (static)</li>

38444

<li><a href="#dynamic_android.jpeg.size">android.jpeg.size</a> (dynamic)</li>

Zhijun He

2014-05-23 11:02:34 -0700

[diff] [blame]

38445

<li><a href="#controls_android.noiseReduction.strength">android.noiseReduction.strength</a> (controls)</li>

38446

<li><a href="#controls_android.request.metadataMode">android.request.metadataMode</a> (controls)</li>

38447

<li><a href="#static_android.sensor.baseGainFactor">android.sensor.baseGainFactor</a> (static)</li>

38448

<li><a href="#dynamic_android.sensor.temperature">android.sensor.temperature</a> (dynamic)</li>

38449

<li><a href="#controls_android.shading.strength">android.shading.strength</a> (controls)</li>

38450

<li><a href="#controls_android.statistics.histogramMode">android.statistics.histogramMode</a> (controls)</li>

38451

<li><a href="#controls_android.statistics.sharpnessMapMode">android.statistics.sharpnessMapMode</a> (controls)</li>

38452

<li><a href="#static_android.statistics.info.histogramBucketCount">android.statistics.info.histogramBucketCount</a> (static)</li>

38453

<li><a href="#static_android.statistics.info.maxHistogramCount">android.statistics.info.maxHistogramCount</a> (static)</li>

38454

<li><a href="#static_android.statistics.info.maxSharpnessMapValue">android.statistics.info.maxSharpnessMapValue</a> (static)</li>

38455

<li><a href="#static_android.statistics.info.sharpnessMapSize">android.statistics.info.sharpnessMapSize</a> (static)</li>

38456

<li><a href="#dynamic_android.statistics.histogram">android.statistics.histogram</a> (dynamic)</li>

38457

<li><a href="#dynamic_android.statistics.sharpnessMap">android.statistics.sharpnessMap</a> (dynamic)</li>

38458

</ul>

38459

</li>

Igor Murashkin