.. 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 https://git.libcamera.org/libcamera/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}
Meson Build system: [required]
meson (>= 0.56) ninja-build pkg-config
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 the libcamera core: [required]
libyaml-dev python3-yaml python3-ply python3-jinja2
for IPA module signing: [recommended]
Either libgnutls28-dev or libssl-dev, openssl
Without IPA module signing, all IPA modules will be isolated in a
separate process. This adds an unnecessary extra overhead at runtime.
for improved debugging: [optional]
libdw-dev libunwind-dev
libdw and libunwind provide backtraces to help debugging assertion
failures. Their functions overlap, libdw provides the most detailed
information, and libunwind is not needed if both libdw and the glibc
backtrace() function are available.
for device hotplug enumeration: [optional]
libudev-dev
for documentation: [optional]
python3-sphinx doxygen graphviz texlive-latex-extra
for gstreamer: [optional]
libgstreamer1.0-dev libgstreamer-plugins-base1.0-dev
for cam: [optional]
libevent-dev is required to support cam, however the following
optional dependencies bring more functionality to the cam test
tool:
- libdrm-dev: Enables the KMS sink
- libjpeg-dev: Enables MJPEG on the SDL sink
- libsdl2-dev: Enables the SDL sink
for qcam: [optional]
qtbase5-dev libqt5core5a libqt5gui5 libqt5widgets5 qttools5-dev-tools libtiff-dev
for tracing with lttng: [optional]
liblttng-ust-dev python3-jinja2 lttng-tools
for android: [optional]
libexif-dev libjpeg-dev
for lc-compliance: [optional]
libevent-dev
Basic testing with cam utility
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The ``cam`` utility can be used for basic testing. You can list the cameras
detected on the system with ``cam -l``, and capture ten frames from the first
camera and save them to disk with ``cam -c 1 --capture=10 --file``. See
``cam -h`` for more information about the ``cam`` tool.
In case of problems, a detailed debug log can be obtained from libcamera by
setting the ``LIBCAMERA_LOG_LEVELS`` environment variable:
.. code::
:~$ LIBCAMERA_LOG_LEVELS=*:DEBUG cam -l
Using GStreamer plugin
~~~~~~~~~~~~~~~~~~~~~~
To use GStreamer plugin from source tree, set the following environment so that
GStreamer can find it. This isn't necessary when libcamera is installed.
export GST_PLUGIN_PATH=$(pwd)/build/src/gstreamer
The debugging tool ``gst-launch-1.0`` can be used to construct a pipeline and
test it. The following pipeline will stream from the camera named "Camera 1"
onto the OpenGL accelerated display element on your system.
.. code::
gst-launch-1.0 libcamerasrc camera-name="Camera 1" ! glimagesink
To show the first camera found you can omit the camera-name property, or you
can list the cameras and their capabilities using:
.. code::
gst-device-monitor-1.0 Video
This will also show the supported stream sizes which can be manually selected
if desired with a pipeline such as:
.. code::
gst-launch-1.0 libcamerasrc ! 'video/x-raw,width=1280,height=720' ! \
glimagesink
The libcamerasrc element has two log categories, named libcamera-provider (for
the video device provider) and libcamerasrc (for the operation of the camera).
All corresponding debug messages can be enabled by setting the ``GST_DEBUG``
environment variable to ``libcamera*:7``.
Presently, to prevent element negotiation failures it is required to specify
the colorimetry and framerate as part of your pipeline construction. For
instance, to capture and encode as a JPEG stream and receive on another device
the following example could be used as a starting point:
.. code::
gst-launch-1.0 libcamerasrc ! \
video/x-raw,colorimetry=bt709,format=NV12,width=1280,height=720,framerate=30/1 ! \
jpegenc ! multipartmux ! \
tcpserversink host=0.0.0.0 port=5000
Which can be received on another device over the network with:
.. code::
gst-launch-1.0 tcpclientsrc host=$DEVICE_IP port=5000 ! \
multipartdemux ! jpegdec ! autovideosink
.. section-end-getting-started
Troubleshooting
~~~~~~~~~~~~~~~
Several users have reported issues with meson installation, crux of the issue
is a potential version mismatch between the version that root uses, and the
version that the normal user uses. On calling `ninja -C build`, it can't find
the build.ninja module. This is a snippet of the error message.
::
ninja: Entering directory `build'
ninja: error: loading 'build.ninja': No such file or directory
This can be solved in two ways:
1) Don't install meson again if it is already installed system-wide.
2) If a version of meson which is different from the system-wide version is
already installed, uninstall that meson using pip3, and install again without
the --user argument.
a id='n115' href='#n115'>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
/* SPDX-License-Identifier: GPL-2.0-or-later */
/*
* Copyright (C) 2020, Google Inc.
*
* Unix socket IPC test
*/
#include <algorithm>
#include <fcntl.h>
#include <iostream>
#include <limits.h>
#include <stdlib.h>
#include <sys/stat.h>
#include <sys/types.h>
#include <sys/wait.h>
#include <unistd.h>
#include <libcamera/base/event_dispatcher.h>
#include <libcamera/base/thread.h>
#include <libcamera/base/timer.h>
#include <libcamera/base/utils.h>
#include "libcamera/internal/ipa_data_serializer.h"
#include "libcamera/internal/ipc_pipe.h"
#include "libcamera/internal/ipc_pipe_unixsocket.h"
#include "libcamera/internal/process.h"
#include "test.h"
using namespace std;
using namespace libcamera;
enum {
CmdExit = 0,
CmdGetSync = 1,
CmdSetAsync = 2,
};
const int32_t kInitialValue = 1337;
const int32_t kChangedValue = 9001;
class UnixSocketTestIPCSlave
{
public:
UnixSocketTestIPCSlave()
: value_(kInitialValue), exitCode_(EXIT_FAILURE), exit_(false)
{
dispatcher_ = Thread::current()->eventDispatcher();
ipc_.readyRead.connect(this, &UnixSocketTestIPCSlave::readyRead);
}
int run(UniqueFD fd)
{
if (ipc_.bind(std::move(fd))) {
cerr << "Failed to connect to IPC channel" << endl;
return EXIT_FAILURE;
}
while (!exit_)
dispatcher_->processEvents();
ipc_.close();
return exitCode_;
}
private:
void readyRead()
{
IPCUnixSocket::Payload message;
int ret;
ret = ipc_.receive(&message);
if (ret) {
cerr << "Receive message failed: " << ret << endl;
return;
}
IPCMessage ipcMessage(message);
uint32_t cmd = ipcMessage.header().cmd;
switch (cmd) {
case CmdExit: {
exit_ = true;
break;
}
case CmdGetSync: {
IPCMessage::Header header = { cmd, ipcMessage.header().cookie };
IPCMessage response(header);
vector<uint8_t> buf;
tie(buf, ignore) = IPADataSerializer<int32_t>::serialize(value_);
response.data().insert(response.data().end(), buf.begin(), buf.end());
ret = ipc_.send(response.payload());
if (ret < 0) {
cerr << "Reply failed" << endl;
stop(ret);
}
break;
}
case CmdSetAsync: {
value_ = IPADataSerializer<int32_t>::deserialize(ipcMessage.data());
break;
}
}
}
void stop(int code)
{
exitCode_ = code;
exit_ = true;
}
int32_t value_;
IPCUnixSocket ipc_;
EventDispatcher *dispatcher_;
int exitCode_;
bool exit_;
};
class UnixSocketTestIPC : public Test
{
protected:
int init()
{
return 0;
}
int setValue(int32_t val)
{
IPCMessage msg(CmdSetAsync);
tie(msg.data(), ignore) = IPADataSerializer<int32_t>::serialize(val);
int ret = ipc_->sendAsync(msg);
if (ret < 0) {
cerr << "Failed to call set value" << endl;
return ret;
}
return 0;
}
int getValue()
{
IPCMessage msg(CmdGetSync);
IPCMessage buf;
int ret = ipc_->sendSync(msg, &buf);
if (ret < 0) {
cerr << "Failed to call get value" << endl;
return ret;
}
return IPADataSerializer<int32_t>::deserialize(buf.data());
}
int exit()
{
IPCMessage msg(CmdExit);
int ret = ipc_->sendAsync(msg);
if (ret < 0) {
cerr << "Failed to call exit" << endl;
return ret;
}
return 0;
}
int run()
{
ipc_ = std::make_unique<IPCPipeUnixSocket>("", self().c_str());
if (!ipc_->isConnected()) {
cerr << "Failed to create IPCPipe" << endl;
return TestFail;
}
int ret = getValue();
if (ret != kInitialValue) {
cerr << "Wrong initial value, expected "
<< kInitialValue << ", got " << ret << endl;
return TestFail;
}
ret = setValue(kChangedValue);
if (ret < 0) {
cerr << "Failed to set value: " << strerror(-ret) << endl;
return TestFail;
}
ret = getValue();
if (ret != kChangedValue) {
cerr << "Wrong set value, expected " << kChangedValue
<< ", got " << ret << endl;
return TestFail;
}
ret = exit();
if (ret < 0) {
cerr << "Failed to exit: " << strerror(-ret) << endl;
return TestFail;
}
return TestPass;
}
private:
ProcessManager processManager_;
unique_ptr<IPCPipeUnixSocket> ipc_;
};
/*
* Can't use TEST_REGISTER() as single binary needs to act as both client and
* server
*/
int main(int argc, char **argv)
{
/* IPCPipeUnixSocket passes IPA module path in argv[1] */
if (argc == 3) {
UniqueFD ipcfd = UniqueFD(std::stoi(argv[2]));
UnixSocketTestIPCSlave slave;
return slave.run(std::move(ipcfd));
}
UnixSocketTestIPC test;
test.setArgs(argc, argv);
return test.execute();
}
|