libcamera: include/libcamera/stream.h Source File

libcamera v0.7.0 Supporting cameras in Linux since 2019

Loading...
Searching...
No Matches
stream.h
Go to the documentation of this file.
1/* SPDX-License-Identifier: LGPL-2.1-or-later */
2/*
3 * Copyright (C) 2019, Google Inc.
4 *
5 * Video stream for a Camera
6 */
7
8#pragma once
9
10#include <map>
11#include <ostream>
12#include <string>
13#include <vector>
14
15#include <libcamera/color_space.h>
16#include <libcamera/framebuffer.h>
17#include <libcamera/geometry.h>
18#include <libcamera/pixel_format.h>
19
20namespace libcamera {
21
22class Camera;
23class Stream;
24
25 class StreamFormats
26{
27public:
28 StreamFormats();
29 StreamFormats(const std::map<PixelFormat, std::vector<SizeRange>> &formats);
30
31 std::vector<PixelFormat> pixelformats() const;
32 std::vector<Size> sizes(const PixelFormat &pixelformat) const;
33
34 SizeRange range(const PixelFormat &pixelformat) const;
35
36private:
37 std::map<PixelFormat, std::vector<SizeRange>> formats_;
38};
39
40 struct StreamConfiguration {
41 StreamConfiguration();
42 StreamConfiguration(const StreamFormats &formats);
43
44 PixelFormat pixelFormat;
45 Size size;
46 unsigned int stride;
47 unsigned int frameSize;
48
49 unsigned int bufferCount;
50
51 std::optional<ColorSpace> colorSpace;
52
53 Stream *stream() const { return stream_; }
54 void setStream(Stream *stream) { stream_ = stream; }
55 const StreamFormats &formats() const { return formats_; }
56
57 std::string toString() const;
58
59private:
60 Stream *stream_;
61 StreamFormats formats_;
62};
63
64std::ostream &operator<<(std::ostream &out, const StreamConfiguration &cfg);
65
66 enum class StreamRole {
67 Raw,
68 StillCapture,
69 VideoRecording,
70 Viewfinder,
71};
72
73std::ostream &operator<<(std::ostream &out, StreamRole role);
74
75 class Stream
76{
77public:
78 Stream();
79
80 const StreamConfiguration &configuration() const { return configuration_; }
81
82protected:
83 friend class Camera;
84
85 StreamConfiguration configuration_;
86};
87
88} /* namespace libcamera */
libcamera::Camera
Camera device.
Definition camera.h:115
libcamera::PixelFormat
libcamera image pixel format
Definition pixel_format.h:17
libcamera::SizeRange
Describe a range of sizes.
Definition geometry.h:205
libcamera::Size
Describe a two-dimensional size.
Definition geometry.h:51
libcamera::StreamFormats
Hold information about supported stream formats.
Definition stream.h:26
libcamera::StreamFormats::sizes
std::vector< Size > sizes(const PixelFormat &pixelformat) const
Retrieve the list of frame sizes supported for pixelformat.
Definition stream.cpp:131
libcamera::StreamFormats::range
SizeRange range(const PixelFormat &pixelformat) const
Retrieve the range of minimum and maximum sizes.
Definition stream.cpp:244
libcamera::StreamFormats::pixelformats
std::vector< PixelFormat > pixelformats() const
Retrieve the list of supported pixel formats.
Definition stream.cpp:107
libcamera::Stream
Video stream for a camera.
Definition stream.h:76
libcamera::Stream::configuration_
StreamConfiguration configuration_
The stream configuration.
Definition stream.h:85
libcamera::Stream::Stream
Stream()
Construct a stream with default parameters.
Definition stream.cpp:478
libcamera::Stream::configuration
const StreamConfiguration & configuration() const
Retrieve the active configuration of the stream.
Definition stream.h:80
color_space.h
Class and enums to represent color spaces.
framebuffer.h
Frame buffer handling.
geometry.h
Data structures related to geometric objects.
libcamera
Top-level libcamera namespace.
Definition backtrace.h:17
libcamera::StreamRole
StreamRole
Identify the role a stream is intended to play.
Definition stream.h:66
libcamera::StreamRole::Viewfinder
@ Viewfinder
Definition stream.h:70
libcamera::StreamRole::Raw
@ Raw
Definition stream.h:67
libcamera::StreamRole::StillCapture
@ StillCapture
Definition stream.h:68
libcamera::StreamRole::VideoRecording
@ VideoRecording
Definition stream.h:69
libcamera::operator<<
std::ostream & operator<<(std::ostream &out, const Point &p)
Insert a text representation of a Point into an output stream.
Definition geometry.cpp:91
pixel_format.h
libcamera pixel format
libcamera::StreamConfiguration
Configuration parameters for a stream.
Definition stream.h:40
libcamera::StreamConfiguration::setStream
void setStream(Stream *stream)
Associate a stream with a configuration.
Definition stream.h:54
libcamera::StreamConfiguration::colorSpace
std::optional< ColorSpace > colorSpace
The ColorSpace for this stream.
Definition stream.h:51
libcamera::StreamConfiguration::StreamConfiguration
StreamConfiguration()
Definition stream.cpp:282
libcamera::StreamConfiguration::formats
const StreamFormats & formats() const
Retrieve advisory stream format information.
Definition stream.h:55
libcamera::StreamConfiguration::stream
Stream * stream() const
Retrieve the stream associated with the configuration.
Definition stream.h:53
libcamera::StreamConfiguration::bufferCount
unsigned int bufferCount
Requested number of buffers to allocate for the stream.
Definition stream.h:49
libcamera::StreamConfiguration::frameSize
unsigned int frameSize
Frame size for the stream, in bytes.
Definition stream.h:47
libcamera::StreamConfiguration::stride
unsigned int stride
Image stride for the stream, in bytes.
Definition stream.h:46
libcamera::StreamConfiguration::pixelFormat
PixelFormat pixelFormat
Stream pixel format.
Definition stream.h:44
libcamera::StreamConfiguration::toString
std::string toString() const
Assemble and return a string describing the configuration.
Definition stream.cpp:393
libcamera::StreamConfiguration::size
Size size
Stream size in pixels.
Definition stream.h:45