No description
Find a file
Laurent Pinchart a8c40942b9 libcamera: controls: Improve the API towards applications
Rework the control-related classes to improve the API towards
applications. The goal is to enable writing code similar to

	Request *req = ...;
	ControlList &controls = req->controls();
	controls->set(controls::AwbEnable, false);
	controls->set(controls::ManualExposure, 1000);

	...

	int32_t exposure = controls->get(controls::ManualExposure);

with the get and set operations ensuring type safety for the control
values. This is achieved by creating the following classes:

- Control defines controls and is the main way to reference a control.
  It is a template class to allow methods using it to refer to the
  control type.

- ControlId is the base class of Control. It stores the control ID, name
  and type, and can be used in contexts where a control needs to be
  referenced regardless of its type (for instance in lists of controls).
  This class replaces ControlIdentifier.

- ControlValue is kept as-is.

The ControlList class now exposes two template get() and set() methods
that replace the operator[]. They ensure type safety by infering the
value type from the Control reference that they receive.

The main way to refer to a control is now through the Control class, and
optionally through its base ControlId class. The ControlId enumeration
is removed, replaced by a list of global Control instances. Numerical
control IDs are turned into macros, and are still exposed as they are
required to communicate with IPAs (especially to deserialise control
lists). They should however not be used by applications.

Auto-generation of header and source files is removed for now to keep
the change simple. It will be added back in the future in a more
elaborate form.

Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Reviewed-by: Niklas Söderlund <niklas.soderlund@ragnatech.se>
2019-10-04 19:33:08 +03:00
Documentation Documentation: Fix warnings when compiling with Doygen 1.8.16 2019-09-16 14:21:36 +03:00
include libcamera: controls: Improve the API towards applications 2019-10-04 19:33:08 +03:00
licenses licenses: add Apache-2.0 license 2019-08-12 10:34:13 +02:00
package/gentoo/media-libs/libcamera package: gentoo: Add libcamera ebuild 2019-05-02 16:36:16 +03:00
src libcamera: controls: Improve the API towards applications 2019-10-04 19:33:08 +03:00
test libcamera: controls: Improve the API towards applications 2019-10-04 19:33:08 +03:00
utils libcamera: skip auto version generation when building for Chromium OS 2019-07-11 12:22:40 +09:00
.clang-format clang-format: Don't indent namespaces 2019-09-23 09:50:08 +03:00
.gitignore git: Add .gitignore file 2018-12-14 13:23:07 +00:00
meson.build meson: Rename 'tests' option to 'test' 2019-08-22 19:35:54 +03:00
meson_options.txt meson: Rename 'tests' option to 'test' 2019-08-22 19:35:54 +03:00
README.rst readme: Provide build requirements 2019-08-16 08:51:28 +01:00

===========
 libcamera
===========

**A complex camera support library for Linux, Android, and ChromeOS**

Cameras are complex devices that need heavy hardware image processing
operations. Control of the processing is based on advanced algorithms that must
run on a programmable processor. This has traditionally been implemented in a
dedicated MCU in the camera, but in embedded devices algorithms have been moved
to the main CPU to save cost. Blurring the boundary between camera devices and
Linux often left the user with no other option than a vendor-specific
closed-source solution.

To address this problem the Linux media community has very recently started
collaboration with the industry to develop a camera stack that will be
open-source-friendly while still protecting vendor core IP. libcamera was born
out of that collaboration and will offer modern camera support to Linux-based
systems, including traditional Linux distributions, ChromeOS and Android.

Getting Started
---------------

To build and install:

::

  meson build
  cd build
  ninja
  ninja install

Dependencies
------------

The following Debian/Ubuntu packages are required for building libcamera.
Other distributions may have differing package names:

A C++ toolchain: [required]
	Either {g++, clang}

for libcamera: [required]
	meson ninja-build

for device hotplug enumeration: [optional]
	pkg-config libudev-dev

for qcam: [optional]
	qtbase5-dev libqt5core5a libqt5gui5 libqt5widgets5

for documentation: [optional]
	python3-sphinx doxygen