libcamera: include/libcamera/internal/framebuffer.h Source File

libcamera v0.0.4 Supporting cameras in Linux since 2019

Loading...
Searching...
No Matches
framebuffer.h
Go to the documentation of this file.
1/* SPDX-License-Identifier: LGPL-2.1-or-later */
2/*
3 * Copyright (C) 2020, Google Inc.
4 *
5 * framebuffer.h - Internal frame buffer handling
6 */
7
8#pragma once
9
10#include <memory>
11#include <utility>
12
13#include <libcamera/base/class.h>
14
15#include <libcamera/fence.h>
16#include <libcamera/framebuffer.h>
17
18namespace libcamera {
19
20 class FrameBuffer::Private : public Extensible::Private
21{
22 LIBCAMERA_DECLARE_PUBLIC(FrameBuffer)
23
24public:
25 Private(const std::vector<Plane> &planes, uint64_t cookie = 0);
26 virtual ~Private();
27
28 void setRequest(Request *request) { request_ = request; }
29 bool isContiguous() const { return isContiguous_; }
30
31 Fence *fence() const { return fence_.get(); }
32 void setFence(std::unique_ptr<Fence> fence) { fence_ = std::move(fence); }
33
34 void cancel() { metadata_.status = FrameMetadata::FrameCancelled; }
35
36 FrameMetadata &metadata() { return metadata_; }
37
38private:
39 std::vector<Plane> planes_;
40 FrameMetadata metadata_;
41 uint64_t cookie_;
42
43 std::unique_ptr<Fence> fence_;
44 Request *request_;
45 bool isContiguous_;
46};
47
48} /* namespace libcamera */
class.h
Utilities to help constructing class interfaces.
LIBCAMERA_DECLARE_PUBLIC
#define LIBCAMERA_DECLARE_PUBLIC(klass)
Declare public data for a private class.
libcamera::Extensible::Private
Base class for private data managed through a d-pointer.
Definition: class.h:65
libcamera::Extensible::Private::Private
Private()
Construct an instance of an Extensible class private data.
Definition: class.cpp:194
libcamera::Fence
Synchronization primitive to manage resources.
Definition: fence.h:16
libcamera::FrameBuffer::Private
Base class for FrameBuffer private data.
Definition: framebuffer.h:21
libcamera::FrameBuffer::Private::~Private
virtual ~Private()
FrameBuffer::Private destructor.
Definition: framebuffer.cpp:132
libcamera::FrameBuffer::Private::setRequest
void setRequest(Request *request)
Set the request this buffer belongs to.
Definition: framebuffer.h:28
libcamera::FrameBuffer::Private::fence
Fence * fence() const
Retrieve a const pointer to the Fence.
Definition: framebuffer.h:31
libcamera::FrameBuffer::Private::isContiguous
bool isContiguous() const
Check if the frame buffer stores planes contiguously in memory.
Definition: framebuffer.h:29
libcamera::FrameBuffer::Private::setFence
void setFence(std::unique_ptr< Fence > fence)
Move a fence in this buffer.
Definition: framebuffer.h:32
libcamera::FrameBuffer::Private::metadata
FrameMetadata & metadata()
Retrieve the dynamic metadata.
Definition: framebuffer.h:36
libcamera::FrameBuffer::Private::cancel
void cancel()
Marks the buffer as cancelled.
Definition: framebuffer.h:34
libcamera::FrameBuffer
Frame buffer data and its associated dynamic metadata.
Definition: framebuffer.h:50
libcamera::FrameBuffer::request
Request * request() const
Retrieve the request this buffer belongs to.
Definition: framebuffer.cpp:374
libcamera::FrameBuffer::planes
const std::vector< Plane > & planes() const
Retrieve the static plane descriptors.
Definition: framebuffer.cpp:356
libcamera::FrameBuffer::cookie
uint64_t cookie() const
Retrieve the cookie.
Definition: framebuffer.cpp:398
libcamera::Request
A frame capture request.
Definition: request.h:31
fence.h
Definition of the Fence class.
framebuffer.h
Frame buffer handling.
libcamera
Top-level libcamera namespace.
Definition: backtrace.h:17
libcamera::FrameMetadata
Metadata related to a captured frame.
Definition: framebuffer.h:25
libcamera::FrameMetadata::FrameCancelled
@ FrameCancelled
Definition: framebuffer.h:29
libcamera::FrameMetadata::status
Status status
Status of the frame.
Definition: framebuffer.h:36