summaryrefslogtreecommitdiff
path: root/src/libcamera/stream.cpp
blob: de505d12c07a6f1cddfa0c0307deb45fd2552fba (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
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
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
/* SPDX-License-Identifier: LGPL-2.1-or-later */
/*
 * Copyright (C) 2019, Google Inc.
 *
 * stream.cpp - Video stream for a Camera
 */

#include <libcamera/stream.h>

#include <algorithm>
#include <array>
#include <climits>
#include <iomanip>
#include <sstream>

#include <libcamera/request.h>

#include "log.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
 *    maximum width/height in the list. The step information is not recreated
 *    and is set to 0 to indicate the range is generated.
 *
 *  - If the image sizes used to construct a StreamFormat are expressed as a
 *    range and a list of discrete sizes is requested, one which fits inside
 *    that range are selected from a list of common sizes. The step information
 *    is taken into consideration when generating the sizes.
 *
 * Applications examining sizes as a range with step values of 0 shall be
 * aware that the range are generated from a list of discrete sizes and there
 * could be a large number of possible Size combinations that may not be
 * supported by the Stream.
 *
 * All sizes retrieved from StreamFormats shall be treated as advisory and no
 * size shall be considered to be supported until it has been verified using
 * CameraConfiguration::validate().
 *
 * \todo Review the usage patterns of this class, and cache the computed
 * pixelformats(), sizes() and range() if this would improve performances.
 */

StreamFormats::StreamFormats()
{
}

/**
 * \brief Construct a StreamFormats object with a map of image formats
 * \param[in] formats A map of pixel formats to a sizes description
 */
StreamFormats::StreamFormats(const std::map<unsigned int, std::vector<SizeRange>> &formats)
	: formats_(formats)
{
}

/**
 * \brief Retrieve the list of supported pixel formats
 * \return The list of supported pixel formats
 */
std::vector<unsigned int> StreamFormats::pixelformats() const
{
	std::vector<unsigned int> formats;

	for (auto const &it : formats_)
		formats.push_back(it.first);

	return formats;
}

/**
 * \brief Retrieve the list of frame sizes supported for \a pixelformat
 * \param[in] pixelformat Pixel format to retrieve sizes for
 *
 * If the sizes described for \a pixelformat are discrete they are returned
 * directly.
 *
 * If the sizes are described as a range, a list of discrete sizes are computed
 * from a list of common resolutions that fit inside the described range. When
 * computing the discrete list step values are considered but there are no
 * guarantees that all sizes computed are supported.
 *
 * \return A list of frame sizes or an empty list on error
 */
std::vector<Size> StreamFormats::sizes(unsigned int pixelformat) const
{
	/*
	 * Sizes to try and extract from ranges.
	 * \todo Verify list of resolutions are good, current list compiled
	 * from v4l2 documentation and source code as well as lists of
	 * common frame sizes.
	 */
	static const std::array<Size, 53> rangeDiscreteSizes = {
		Size(160, 120),
		Size(240, 160),
		Size(320, 240),
		Size(400, 240),
		Size(480, 320),
		Size(640, 360),
		Size(640, 480),
		Size(720, 480),
		Size(720, 576),
		Size(768, 480),
		Size(800, 600),
		Size(854, 480),
		Size(960, 540),
		Size(960, 640),
		Size(1024, 576),
		Size(1024, 600),
		Size(1024, 768),
		Size(1152, 864),
		Size(1280, 1024),
		Size(1280, 1080),
		Size(1280, 720),
		Size(1280, 800),
		Size(1360, 768),
		Size(1366, 768),
		Size(1400, 1050),
		Size(1440, 900),
		Size(1536, 864),
		Size(1600, 1200),
		Size(1600, 900),
		Size(1680, 1050),
		Size(1920, 1080),
		Size(1920, 1200),
		Size(2048, 1080),
		Size(2048, 1152),
		Size(2048, 1536),
		Size(2160, 1080),
		Size(2560, 1080),
		Size(2560, 1440),
		Size(2560, 1600),
		Size(2560, 2048),
		Size(2960, 1440),
		Size(3200, 1800),
		Size(3200, 2048),
		Size(3200, 2400),
		Size(3440, 1440),
		Size(3840, 1080),
		Size(3840, 1600),
		Size(3840, 2160),
		Size(3840, 2400),
		Size(4096, 2160),
		Size(5120, 2160),
		Size(5120, 2880),
		Size(7680, 4320),
	};
	std::vector<Size> sizes;

	/* Make sure pixel format exists. */
	auto const &it = formats_.find(pixelformat);
	if (it == formats_.end())
		return {};

	/* Try creating a list of discrete sizes. */
	const std::vector<SizeRange> &ranges = it->second;
	bool discrete = true;
	for (const SizeRange &range : ranges) {
		if (range.min != range.max) {
			discrete = false;
			break;
		}
		sizes.emplace_back(range.min);
	}

	/* If discrete not possible generate from range. */
	if (!discrete) {
		if (ranges.size() != 1) {
			LOG(Stream, Error) << "Range format is ambiguous";
			return {};
		}

		const SizeRange &limit = ranges.front();
		sizes.clear();

		for (const Size &size : rangeDiscreteSizes)
			if (limit.contains(size))
				sizes.push_back(size);
	}

	std::sort(sizes.begin(), sizes.end());

	return sizes;
}

/**
 * \brief Retrieve the range of minimum and maximum sizes
 * \param[in] pixelformat Pixel format to retrieve range for
 *
 * If the size described for \a pixelformat is a range, that range is returned
 * directly. If the sizes described are a list of discrete sizes, a range is
 * created from the minimum and maximum sizes in the list. The step values of
 * the range are set to 0 to indicate that the range is generated and that not
 * all image sizes contained in the range might be supported.
 *
 * \return A range of valid image sizes or an empty range on error
 */
SizeRange StreamFormats::range(unsigned int pixelformat) const
{
	auto const it = formats_.find(pixelformat);
	if (it == formats_.end())
		return {};

	const std::vector<SizeRange> &ranges = it->second;
	if (ranges.size() == 1)
		return ranges[0];

	LOG(Stream, Debug) << "Building range from discrete sizes";
	SizeRange range(UINT_MAX, UINT_MAX, 0, 0);
	for (const SizeRange &limit : ranges) {
		if (limit.min < range.min)
			range.min = limit.min;

		if (limit.max > range.max)
			range.max = limit.max;
	}

	range.hStep = 0;
	range.vStep = 0;

	return range;
}

/**
 * \enum MemoryType
 * \brief Define the memory type used by a Stream
 * \var MemoryType::InternalMemory
 * The Stream uses memory allocated internally by the library and exported to
 * applications.
 * \var MemoryType::ExternalMemory
 * The Stream uses memory allocated externally by application and imported in
 * the library.
 */

/**
 * \struct StreamConfiguration
 * \brief Configuration parameters for a stream
 *
 * The StreamConfiguration structure models all information which can be
 * configured for a single video stream.
 */

/**
 * \todo This method is deprecated and should be removed once all pipeline
 * handlers provied StreamFormats.
 */
StreamConfiguration::StreamConfiguration()
	: memoryType(InternalMemory), stream_(nullptr)
{
}

/**
 * \brief Construct a configuration with stream formats
 */
StreamConfiguration::StreamConfiguration(const StreamFormats &formats)
	: memoryType(InternalMemory), stream_(nullptr), formats_(formats)
{
}

/**
 * \var StreamConfiguration::size
 * \brief Stream size in pixels
 */

/**
 * \var StreamConfiguration::pixelFormat
 * \brief Stream pixel format
 *
 * This is a little endian four character code representation of the pixel
 * format described in V4L2 using the V4L2_PIX_FMT_* definitions.
 */

/**
 * \var StreamConfiguration::memoryType
 * \brief The memory type the stream shall use
 */

/**
 * \var StreamConfiguration::bufferCount
 * \brief Requested number of buffers to allocate for the stream
 */

/**
 * \fn StreamConfiguration::stream()
 * \brief Retrieve the stream associated with the configuration
 *
 * When a camera is configured with Camera::configure() Stream instances are
 * associated with each stream configuration entry. This method retrieves the
 * associated Stream, which remains valid until the next call to
 * Camera::configure() or Camera::release().
 *
 * \return The stream associated with the configuration
 */

/**
 * \fn StreamConfiguration::setStream()
 * \brief Associate a stream with a configuration
 *
 * This method is meant for the PipelineHandler::configure() method and shall
 * not be called by applications.
 *
 * \param[in] stream The stream
 */

/**
 * \fn StreamConfiguration::formats()
 * \brief Retrieve advisory stream format information
 *
 * This method retrieves information about the pixel formats and sizes supported
 * by the stream configuration. The sizes are advisory and not all of them are
 * guaranteed to be supported by the stream. Users shall always inspect the size
 * in the stream configuration after calling CameraConfiguration::validate().
 *
 * \return Stream formats information
 */

/**
 * \brief Assemble and return a string describing the configuration
 *
 * \return A string describing the StreamConfiguration
 */
std::string StreamConfiguration::toString() const
{
	std::stringstream ss;

	ss.fill(0);
	ss << size.toString() << "-0x" << std::hex << std::setw(8)
	   << pixelFormat;

	return ss.str();
}

/**
 * \enum StreamRole
 * \brief Identify the role a stream is intended to play
 *
 * The StreamRole describes how an application intends to use a stream. Roles
 * are specified by applications and passed to cameras, that then select the
 * most appropriate streams and their default configurations.
 *
 * \var StillCapture
 * The stream is intended to capture high-resolution, high-quality still images
 * with low frame rate. The captured frames may be exposed with flash.
 * \var VideoRecording
 * The stream is intended to capture video for the purpose of recording or
 * streaming. The video stream may produce a high frame rate and may be
 * enhanced with video stabilization.
 * \var Viewfinder
 * The stream is intended to capture video for the purpose of display on the
 * local screen. Trade-offs between quality and usage of system resources are
 * acceptable.
 */

/**
 * \typedef StreamRoles
 * \brief A vector of StreamRole
 */

/**
 * \class Stream
 * \brief Video stream for a camera
 *
 * The Stream class models all static information which are associated with a
 * single video stream. Streams are exposed by the Camera object they belong to.
 *
 * Cameras may supply more than one stream from the same video source. In such
 * cases an application can inspect all available streams and select the ones
 * that best fit its use case.
 *
 * \todo Add capabilities to the stream API. Without this the Stream class only
 * serves to reveal how many streams of unknown capabilities a camera supports.
 * This in itself is productive as it allows applications to configure and
 * capture from one or more streams even if they won't be able to select the
 * optimal stream for the task.
 */

/**
 * \brief Construct a stream with default parameters
 */
Stream::Stream()
{
}

/**
 * \brief Create a Buffer instance referencing the memory buffer \a index
 * \param[in] index The desired buffer index
 *
 * This method creates a Buffer instance that references a BufferMemory from
 * the stream's buffers pool by its \a index. The index shall be lower than the
 * number of buffers in the pool.
 *
 * This method is only valid for streams that use the InternalMemory type. It
 * will return a null pointer when called on streams using the ExternalMemory
 * type.
 *
 * \return A newly created Buffer on success or nullptr otherwise
 */
std::unique_ptr<Buffer> Stream::createBuffer(unsigned int index)
{
	if (memoryType_ != InternalMemory) {
		LOG(Stream, Error) << "Invalid stream memory type";
		return nullptr;
	}

	if (index >= bufferPool_.count()) {
		LOG(Stream, Error) << "Invalid buffer index " << index;
		return nullptr;
	}

	Buffer *buffer = new Buffer();
	buffer->index_ = index;
	buffer->stream_ = this;

	return std::unique_ptr<Buffer>(buffer);
}

/**
 * \brief Create a Buffer instance that represents a memory area identified by
 * dmabuf file descriptors
 * \param[in] fds The dmabuf file descriptors for each plane
 *
 * This method creates a Buffer instance that references buffer memory
 * allocated outside of libcamera through dmabuf file descriptors. The \a
 * dmabuf array shall contain a file descriptor for each plane in the buffer,
 * and unused entries shall be set to -1.
 *
 * The buffer is created without a valid index, as it does not yet map to any of
 * the stream's BufferMemory instances. An index will be assigned at the time
 * the buffer is queued to the camera in a request. Applications may thus
 * create any number of Buffer instances, providing that no more than the
 * number of buffers allocated for the stream are queued at any given time.
 *
 * This method is only valid for streams that use the ExternalMemory type. It
 * will return a null pointer when called on streams using the InternalMemory
 * type.
 *
 * \sa Stream::mapBuffer()
 *
 * \return A newly created Buffer on success or nullptr otherwise
 */
std::unique_ptr<Buffer> Stream::createBuffer(const std::array<int, 3> &fds)
{
	if (memoryType_ != ExternalMemory) {
		LOG(Stream, Error) << "Invalid stream memory type";
		return nullptr;
	}

	Buffer *buffer = new Buffer();
	buffer->dmabuf_ = fds;
	buffer->stream_ = this;

	return std::unique_ptr<Buffer>(buffer);
}

/**
 * \fn Stream::bufferPool()
 * \brief Retrieve the buffer pool for the stream
 *
 * The buffer pool handles the memory buffers used to store frames for the
 * stream. It is initially created empty and shall be populated with
 * buffers before being used.
 *
 * \return A reference to the buffer pool
 */

/**
 * \fn Stream::buffers()
 * \brief Retrieve the memory buffers in the Stream's buffer pool
 * \return The list of stream's memory buffers
 */

/**
 * \fn Stream::configuration()
 * \brief Retrieve the active configuration of the stream
 * \return The active configuration of the stream
 */

/**
 * \fn Stream::memoryType()
 * \brief Retrieve the stream memory type
 * \return The memory type used by the stream
 */

/**
 * \brief Map a Buffer to a buffer memory index
 * \param[in] buffer The buffer to map to a buffer memory index
 *
 * Streams configured to use externally allocated memory need to maintain a
 * best-effort association between the memory area the \a buffer represents
 * and the associated buffer memory in the Stream's pool.
 *
 * The buffer memory to use, once the \a buffer reaches the video device,
 * is selected using the index assigned to the \a buffer and to minimize
 * relocations in the V4L2 back-end, this operation provides a best-effort
 * caching mechanism that associates to the dmabuf file descriptors contained
 * in the \a buffer the index of the buffer memory that was lastly queued with
 * those file descriptors set.
 *
 * If the Stream uses internally allocated memory, the index of the memory
 * buffer to use will match the one request at Stream::createBuffer(unsigned int)
 * time, and no mapping is thus required.
 *
 * \return The buffer memory index for the buffer on success, or a negative
 * error code otherwise
 * \retval -ENOMEM No buffer memory was available to map the buffer
 */
int Stream::mapBuffer(const Buffer *buffer)
{
	ASSERT(memoryType_ == ExternalMemory);

	if (bufferCache_.empty())
		return -ENOMEM;

	const std::array<int, 3> &dmabufs = buffer->dmabufs();

	/*
	 * Try to find a previously mapped buffer in the cache. If we miss, use
	 * the oldest entry in the cache.
	 */
	auto map = std::find_if(bufferCache_.begin(), bufferCache_.end(),
				[&](std::pair<std::array<int, 3>, unsigned int> &entry) {
					return entry.first == dmabufs;
				});
	if (map == bufferCache_.end())
		map = bufferCache_.begin();

	/*
	 * Update the dmabuf file descriptors of the entry. We can't assume that
	 * identical file descriptor numbers refer to the same dmabuf object as
	 * it may have been closed and its file descriptor reused. We thus need
	 * to update the plane's internally cached mmap()ed memory.
	 */
	unsigned int index = map->second;
	BufferMemory *mem = &bufferPool_.buffers()[index];
	mem->planes().clear();

	for (unsigned int i = 0; i < dmabufs.size(); ++i) {
		if (dmabufs[i] == -1)
			break;

		mem->planes().emplace_back();
		mem->planes().back().setDmabuf(dmabufs[i], 0);
	}

	/* Remove the buffer from the cache and return its index. */
	bufferCache_.erase(map);
	return index;
}

/**
 * \brief Unmap a Buffer from its buffer memory
 * \param[in] buffer The buffer to unmap
 *
 * This method releases the buffer memory entry that was mapped by mapBuffer(),
 * making it available for new mappings.
 */
void Stream::unmapBuffer(const Buffer *buffer)
{
	ASSERT(memoryType_ == ExternalMemory);

	bufferCache_.emplace_back(buffer->dmabufs(), buffer->index());
}

/**
 * \brief Create buffers for the stream
 * \param[in] count The number of buffers to create
 * \param[in] memory The stream memory type
 *
 * Create \a count empty buffers in the Stream's buffer pool.
 */
void Stream::createBuffers(MemoryType memory, unsigned int count)
{
	destroyBuffers();
	if (count == 0)
		return;

	memoryType_ = memory;
	bufferPool_.createBuffers(count);

	/* Streams with internal memory usage do not need buffer mapping. */
	if (memoryType_ == InternalMemory)
		return;

	/*
	 * Prepare for buffer mapping by adding all buffer memory entries to the
	 * cache.
	 */
	bufferCache_.clear();
	for (unsigned int i = 0; i < bufferPool_.count(); ++i)
		bufferCache_.emplace_back(std::array<int, 3>{ -1, -1, -1 }, i);
}

/**
 * \brief Destroy buffers in the stream
 *
 * If no buffers have been created or if buffers have already been destroyed no
 * operation is performed.
 */
void Stream::destroyBuffers()
{
	bufferPool_.destroyBuffers();
}

/**
 * \var Stream::bufferPool_
 * \brief The pool of buffers associated with the stream
 *
 * The stream buffer pool is populated by the Camera class after a successful
 * stream configuration.
 */

/**
 * \var Stream::configuration_
 * \brief The stream configuration
 *
 * The configuration for the stream is set by any successful call to
 * Camera::configure() that includes the stream, and remains valid until the
 * next call to Camera::configure() regardless of if it includes the stream.
 */

/**
 * \var Stream::memoryType_
 * \brief The stream memory type
 */

} /* namespace libcamera */