libcamera  v0.2.0+85-1c5830a9
Supporting cameras in Linux since 2019
framebuffer.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  * framebuffer.h - Frame buffer handling
6  */
7 
8 #pragma once
9 
10 #include <assert.h>
11 #include <limits>
12 #include <memory>
13 #include <stdint.h>
14 #include <vector>
15 
16 #include <libcamera/base/class.h>
18 #include <libcamera/base/span.h>
19 
20 namespace libcamera {
21 
22 class Fence;
23 class Request;
24 
25 struct FrameMetadata {
26  enum Status {
30  };
31 
32  struct Plane {
33  unsigned int bytesused;
34  };
35 
37  unsigned int sequence;
38  uint64_t timestamp;
39 
40  Span<Plane> planes() { return planes_; }
41  Span<const Plane> planes() const { return planes_; }
42 
43 private:
44  friend class FrameBuffer;
45 
46  std::vector<Plane> planes_;
47 };
48 
49 class FrameBuffer : public Extensible
50 {
52 
53 public:
54  struct Plane {
55  static constexpr unsigned int kInvalidOffset = std::numeric_limits<unsigned int>::max();
57  unsigned int offset = kInvalidOffset;
58  unsigned int length;
59  };
60 
61  FrameBuffer(const std::vector<Plane> &planes, unsigned int cookie = 0);
62  FrameBuffer(std::unique_ptr<Private> d);
63  virtual ~FrameBuffer() {}
64 
65  const std::vector<Plane> &planes() const;
66  Request *request() const;
67  const FrameMetadata &metadata() const;
68 
69  uint64_t cookie() const;
70  void setCookie(uint64_t cookie);
71 
72  std::unique_ptr<Fence> releaseFence();
73 
74 private:
76 };
77 
78 } /* namespace libcamera */
RAII-style wrapper for file descriptors.
Definition: shared_fd.h:16
Span< const Plane > planes() const
Retrieve the array of per-plane metadata.
Definition: framebuffer.h:41
Utilities to help constructing class interfaces.
Status status
Status of the frame.
Definition: framebuffer.h:36
File descriptor wrapper.
Status
Define the frame completion status.
Definition: framebuffer.h:26
Top-level libcamera namespace.
Definition: backtrace.h:17
unsigned int length
The plane length in bytes.
Definition: framebuffer.h:58
Definition: framebuffer.h:28
Frame buffer data and its associated dynamic metadata.
Definition: framebuffer.h:49
Metadata related to a captured frame.
Definition: framebuffer.h:25
uint64_t timestamp
Time when the frame was captured.
Definition: framebuffer.h:38
#define LIBCAMERA_DECLARE_PRIVATE()
Declare private data for a public class.
A frame capture request.
Definition: request.h:30
Definition: framebuffer.h:27
Per-plane frame metadata.
Definition: framebuffer.h:32
Base class to manage private data through a d-pointer.
Definition: class.h:61
#define LIBCAMERA_DISABLE_COPY_AND_MOVE(klass)
Disable copy and move construction and assignment of the klass.
SharedFD fd
The dmabuf file descriptor.
Definition: framebuffer.h:56
Definition: framebuffer.h:29
A memory region to store a single plane of a frame.
Definition: framebuffer.h:54
Span< Plane > planes()
Retrieve the array of per-plane metadata.
Definition: framebuffer.h:40
unsigned int sequence
Frame sequence number.
Definition: framebuffer.h:37
unsigned int bytesused
Number of bytes occupied by the data in the plane, including line padding.
Definition: framebuffer.h:33