libcamera  v0.0.0+100-debian/0_git20200629+e7aa92a-8-9-g77f5237c-dirty (2021-05-05T16:20:29+01:00)
Supporting cameras in Linux since 2019
request.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  * request.h - Capture request handling
6  */
7 #ifndef __LIBCAMERA_REQUEST_H__
8 #define __LIBCAMERA_REQUEST_H__
9 
10 #include <map>
11 #include <memory>
12 #include <stdint.h>
13 #include <string>
14 #include <unordered_set>
15 
16 #include <libcamera/class.h>
17 #include <libcamera/controls.h>
18 #include <libcamera/signal.h>
19 
20 namespace libcamera {
21 
22 class Camera;
23 class CameraControlValidator;
24 class FrameBuffer;
25 class Stream;
26 
27 class Request
28 {
29 public:
30  enum Status {
34  };
35 
36  enum ReuseFlag {
37  Default = 0,
38  ReuseBuffers = (1 << 0),
39  };
40 
41  using BufferMap = std::map<const Stream *, FrameBuffer *>;
42 
43  Request(Camera *camera, uint64_t cookie = 0);
44  ~Request();
45 
46  void reuse(ReuseFlag flags = Default);
47 
48  ControlList &controls() { return *controls_; }
49  ControlList &metadata() { return *metadata_; }
50  const BufferMap &buffers() const { return bufferMap_; }
51  int addBuffer(const Stream *stream, FrameBuffer *buffer);
52  FrameBuffer *findBuffer(const Stream *stream) const;
53 
54  uint32_t sequence() const { return sequence_; }
55  uint64_t cookie() const { return cookie_; }
56  Status status() const { return status_; }
57 
58  bool hasPendingBuffers() const { return !pending_.empty(); }
59 
60  std::string toString() const;
61 
62 private:
64 
65  friend class PipelineHandler;
66 
67  void complete();
68 
69  bool completeBuffer(FrameBuffer *buffer);
70 
71  Camera *camera_;
72  CameraControlValidator *validator_;
73  ControlList *controls_;
74  ControlList *metadata_;
75  BufferMap bufferMap_;
76  std::unordered_set<FrameBuffer *> pending_;
77 
78  uint32_t sequence_;
79  const uint64_t cookie_;
80  Status status_;
81  bool cancelled_;
82 };
83 
84 } /* namespace libcamera */
85 
86 #endif /* __LIBCAMERA_REQUEST_H__ */
int addBuffer(const Stream *stream, FrameBuffer *buffer)
Add a FrameBuffer with its associated Stream to the Request.
Definition: request.cpp:180
Definition: request.h:31
Utilities to help constructing class interfaces.
ControlList & controls()
Retrieve the request&#39;s ControlList.
Definition: request.h:48
Video stream for a camera.
Definition: stream.h:70
Top-level libcamera namespace.
Definition: bound_method.h:15
std::map< const Stream *, FrameBuffer * > BufferMap
A map of Stream to FrameBuffer pointers.
Definition: request.h:41
bool hasPendingBuffers() const
Check if a request has buffers yet to be completed.
Definition: request.h:58
Definition: request.h:32
Frame buffer data and its associated dynamic metadata.
Definition: buffer.h:37
A control validator for Camera instances.
Definition: camera_controls.h:16
FrameBuffer * findBuffer(const Stream *stream) const
Return the buffer associated with a stream.
Definition: request.cpp:215
Definition: request.h:38
const BufferMap & buffers() const
Retrieve the request&#39;s streams to buffers map.
Definition: request.h:50
ControlList & metadata()
Retrieve the request&#39;s metadata.
Definition: request.h:49
A frame capture request.
Definition: request.h:27
#define LIBCAMERA_DISABLE_COPY(klass)
Disable copy construction and assignment of the klass.
Signal & slot implementation.
Status
Definition: request.h:30
Create and manage cameras based on a set of media devices.
Definition: pipeline_handler.h:57
std::string toString() const
Generate a string representation of the Request internals.
Definition: request.cpp:331
Camera device.
Definition: camera.h:74
void reuse(ReuseFlag flags=Default)
Reset the request for reuse.
Definition: request.cpp:115
ReuseFlag
Definition: request.h:36
Associate a list of ControlId with their values for an object.
Definition: controls.h:346
Framework to manage controls related to an object.
Definition: request.h:37
Definition: request.h:33
uint32_t sequence() const
Retrieve the sequence number for the request.
Definition: request.h:54
Status status() const
Retrieve the request completion status.
Definition: request.h:56
uint64_t cookie() const
Retrieve the cookie set when the request was created.
Definition: request.h:55
Request(Camera *camera, uint64_t cookie=0)
Create a capture request for a camera.
Definition: request.cpp:75