Working on SoftISP
Find a file
Laurent Pinchart 93e72b695e libcamera: Move internal headers to include/libcamera/internal/
The libcamera internal headers are located in src/libcamera/include/.
The directory is added to the compiler headers search path with a meson
include_directories() directive, and internal headers are included with
(e.g. for the internal semaphore.h header)

  #include "semaphore.h"

All was well, until libcxx decided to implement the C++20
synchronization library. The __threading_support header gained a

  #include <semaphore.h>

to include the pthread's semaphore support. As include_directories()
adds src/libcamera/include/ to the compiler search path with -I, the
internal semaphore.h is included instead of the pthread version.
Needless to say, the compiler isn't happy.

Three options have been considered to fix this issue:

- Use -iquote instead of -I. The -iquote option instructs gcc to only
  consider the header search path for headers included with the ""
  version. Meson unfortunately doesn't support this option.

- Rename the internal semaphore.h header. This was deemed to be the
  beginning of a long whack-a-mole game, where namespace clashes with
  system libraries would appear over time (possibly dependent on
  particular system configurations) and would need to be constantly
  fixed.

- Move the internal headers to another directory to create a unique
  namespace through path components. This causes lots of churn in all
  the existing source files through the all project.

The first option would be best, but isn't available to us due to missing
support in meson. Even if -iquote support was added, we would need to
fix the problem before a new version of meson containing the required
support would be released.

The third option is thus the only practical solution available. Bite the
bullet, and do it, moving headers to include/libcamera/internal/.

Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Acked-by: Jacopo Mondi <jacopo@jmondi.org>
2020-05-16 03:38:11 +03:00
Documentation libcamera: Move internal headers to include/libcamera/internal/ 2020-05-16 03:38:11 +03:00
include libcamera: Move internal headers to include/libcamera/internal/ 2020-05-16 03:38:11 +03:00
LICENSES licenses: License all meson files under CC0-1.0 2020-05-13 16:46:24 +03:00
package/gentoo/media-libs/libcamera licenses: Add SPDX headers to Gentoo ebuild 2020-04-15 19:51:56 +03:00
src libcamera: Move internal headers to include/libcamera/internal/ 2020-05-16 03:38:11 +03:00
test libcamera: Move internal headers to include/libcamera/internal/ 2020-05-16 03:38:11 +03:00
utils utils: raspberrypi: ctt: Fix pycodestyle E302 2020-05-13 17:00:25 +03:00
.clang-format licenses: Replace deprecated GPL-2.0 with GPL-2.0-only 2020-04-15 19:51:56 +03:00
.gitignore libcamera: Add Python cache and compiled files to .gitignore 2020-05-01 17:51:59 +03:00
meson.build licenses: License all meson files under CC0-1.0 2020-05-13 16:46:24 +03:00
meson_options.txt licenses: License all meson files under CC0-1.0 2020-05-13 16:46:24 +03:00
README.rst libcamera: Make IPA module signing mandatory for the meantime 2020-04-16 17:37:41 +03:00

.. SPDX-License-Identifier: CC-BY-SA-4.0

.. section-begin-libcamera

===========
 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.

.. section-end-libcamera
.. section-begin-getting-started

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

To fetch the sources, build and install:

::

  git clone git://linuxtv.org/libcamera.git
  cd libcamera
  meson build
  ninja -C build 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 (>= 0.47) ninja-build python3-yaml

        If your distribution doesn't provide a recent enough version of meson,
        you can install or upgrade it using pip3.

        .. code::

            pip3 install --user meson
            pip3 install --user --upgrade meson

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

for documentation: [optional]
	python3-sphinx doxygen

for gstreamer: [optional]
	libgstreamer1.0-dev libgstreamer-plugins-base1.0-dev

for IPA module signing: [required]
        libgnutls28-dev openssl

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

Using GStreamer plugin
~~~~~~~~~~~~~~~~~~~~~~

To use GStreamer plugin from source tree, set the following environment so that
GStreamer can find it.

  export GST_PLUGIN_PATH=$(pwd)/build/src/gstreamer

The debugging tool `gst-launch-1.0` can be used to construct and pipeline and test
it. The following pipeline will stream from the camera named "Camera 1" onto the
default video display element on your system.

.. code::

  gst-launch-1.0 libcamerasrc camera-name="Camera 1" ! videoconvert ! autovideosink

.. section-end-getting-started