/* SPDX-License-Identifier: LGPL-2.1-or-later */ /* * Copyright (C) 2021, Google Inc. * * ipa_context.cpp - IPU3 IPA Context */ #include "ipa_context.h" /** * \file ipa_context.h * \brief Context and state information shared between the algorithms */ namespace libcamera::ipa::ipu3 { /** * \struct IPASessionConfiguration * \brief Session configuration for the IPA module * * The session configuration contains all IPA configuration parameters that * remain constant during the capture session, from IPA module start to stop. * It is typically set during the configure() operation of the IPA module, but * may also be updated in the start() operation. */ /** * \struct IPAActiveState * \brief The active state of the IPA algorithms * * The IPA is fed with the statistics generated from the latest frame captured * by the hardware. The statistics are then processed by the IPA algorithms to * compute ISP parameters required for the next frame capture. The current state * of the algorithms is reflected through the IPAActiveState to store the values * most recently computed by the IPA algorithms. */ /** * \struct IPAFrameContext * \brief Context for a frame * * The frame context stores data specific to a single frame processed by the * IPA. Each frame processed by the IPA has a context associated with it, * accessible through the IPAContext structure. * * Fields in the frame context should reflect values and controls * associated with the specific frame as requested by the application, and * as configured by the hardware. Fields can be read by algorithms to * determine if they should update any specific action for this frame, and * finally to update the metadata control lists when the frame is fully * completed. */ /** * \struct IPAContext * \brief Global IPA context data shared between all algorithms * * \var IPAContext::configuration * \brief The IPA session configuration, immutable during the session * * \var IPAContext::frameContexts * \brief Ring buffer of the IPAFrameContext(s) * * \var IPAContext::activeState * \brief The current state of IPA algorithms */ /** * \var IPASessionConfiguration::grid * \brief Grid configuration of the IPA * * \var IPASessionConfiguration::grid.bdsGrid * \brief Bayer Down Scaler grid plane config used by the kernel * * \var IPASessionConfiguration::grid.bdsOutputSize * \brief BDS output size configured by the pipeline handler * * \var IPASessionConfiguration::grid.stride * \brief Number of cells on one line including the ImgU padding */ /** * \var IPASessionConfiguration::af * \brief AF grid configuration of the IPA * * \var IPASessionConfiguration::af.afGrid * \brief AF scene grid configuration. */ /** * \var IPAActiveState::af * \brief Context for the Automatic Focus algorithm * * \struct IPAActiveState::af * \var IPAActiveState::af.focus * \brief Current position of the lens * * \var IPAActiveState::af.maxVariance * \brief The maximum variance of the current image. * * \var IPAActiveState::af.stable * \brief It is set to true, if the best focus is found. */ /** * \var IPASessionConfiguration::agc * \brief AGC parameters configuration of the IPA * * \var IPASessionConfiguration::agc.minShutterSpeed * \brief Minimum shutter speed supported with the configured sensor * * \var IPASessionConfiguration::agc.maxShutterSpeed * \brief Maximum shutter speed supported with the configured sensor * * \var IPASessionConfiguration::agc.minAnalogueGain * \brief Minimum analogue gain supported with the configured sensor * * \var IPASessionConfiguration::agc.maxAnalogueGain * \brief Maximum analogue gain supported with the configured sensor */ /** * \var IPASessionConfiguration::sensor * \brief Sensor-specific configuration of the IPA * * \var IPASessionConfiguration::sensor.lineDuration * \brief Line duration in microseconds * * \var IPASessionConfiguration::sensor.defVBlank * \brief The default vblank value of the sensor */ /** * \var IPAActiveState::agc * \brief Context for the Automatic Gain Control algorithm * * The exposure and gain determined are expected to be applied to the sensor * at the earliest opportunity. * * \var IPAActiveState::agc.exposure * \brief Exposure time expressed as a number of lines * * \var IPAActiveState::agc.gain * \brief Analogue gain multiplier * * The gain should be adapted to the sensor specific gain code before applying. */ /** * \var IPAActiveState::awb * \brief Context for the Automatic White Balance algorithm * * \struct IPAActiveState::awb.gains * \brief White balance gains * * \var IPAActiveState::awb.gains.red * \brief White balance gain for R channel * * \var IPAActiveState::awb.gains.green * \brief White balance gain for G channel * * \var IPAActiveState::awb.gains.blue * \brief White balance gain for B channel * * \var IPAActiveState::awb.temperatureK * \brief Estimated color temperature */ /** * \var IPAActiveState::toneMapping * \brief Context for ToneMapping and Gamma control * * \var IPAActiveState::toneMapping.gamma * \brief Gamma value for the LUT * * \var IPAActiveState::toneMapping.gammaCorrection * \brief Per-pixel tone mapping implemented as a LUT * * The LUT structure is defined by the IPU3 kernel interface. See * struct ipu3_uapi_gamma_corr_lut for further details. */ /** * \brief Default constructor for IPAFrameContext */ IPAFrameContext::IPAFrameContext() = default; /** * \brief Construct a IPAFrameContext instance */ IPAFrameContext::IPAFrameContext(uint32_t id, const ControlList &reqControls) : frame(id), frameControls(reqControls) { sensor = {}; } /** * \var IPAFrameContext::frame * \brief The frame number * * \var IPAFrameContext::frameControls * \brief Controls sent in by the application while queuing the request * * \var IPAFrameContext::sensor * \brief Effective sensor values that were applied for the frame * * \var IPAFrameContext::sensor.exposure * \brief Exposure time expressed as a number of lines * * \var IPAFrameContext::sensor.gain * \brief Analogue gain multiplier */ } /* namespace libcamera::ipa::ipu3 */ id='n81' href='#n81'>81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 
/* SPDX-License-Identifier: LGPL-2.1-or-later */
/*
 * Copyright (C) 2019, Google Inc.
 *
 * Video stream for a Camera
 */

#include <libcamera/stream.h>

#include <algorithm>
#include <array>
#include <limits.h>
#include <ostream>
#include <string>
#include <vector>

#include <libcamera/base/log.h>
#include <libcamera/base/utils.h>

#include <libcamera/request.h>

/**
 * \file stream.h
 * \brief Video stream for a Camera
 *
 * A camera device can provide frames in different resolutions and formats
 * concurrently from a single image source. The Stream class represents
 * one of the multiple concurrent streams.
 *
 * All streams exposed by a camera device share the same image source and are
 * thus not fully independent. Parameters related to the image source, such as
 * the exposure time or flash control, are common to all streams. Other
 * parameters, such as format or resolution, may be specified per-stream,
 * depending on the capabilities of the camera device.
 *
 * Camera devices expose at least one stream, and may expose additional streams
 * based on the device capabilities. This can be used, for instance, to
 * implement concurrent viewfinder and video capture, or concurrent viewfinder,
 * video capture and still image capture.
 */

namespace libcamera {

LOG_DEFINE_CATEGORY(Stream)

/**
 * \class StreamFormats
 * \brief Hold information about supported stream formats
 *
 * The StreamFormats class holds information about the pixel formats and frame
 * sizes a stream supports. The class groups size information by the pixel
 * format which can produce it.
 *
 * There are two ways to examine the size information, as a range or as a list
 * of discrete sizes. When sizes are viewed as a range it describes the minimum
 * and maximum width and height values. The range description can include
 * horizontal and vertical steps.
 *
 * When sizes are viewed as a list of discrete sizes they describe the exact
 * dimensions which can be selected and used.
 *
 * Pipeline handlers can create StreamFormats describing each pixel format using
 * either a range or a list of discrete sizes. The StreamFormats class attempts
 * to translate between the two different ways to view them. The translations
 * are performed as:
 *
 *  - If the StreamFormat is constructed using a list of discrete image sizes
 *    and a range is requested, it gets created by taking the minimum and