libcamera  v0.4.0
Supporting cameras in Linux since 2019
control_serializer.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  * Control (de)serializer
6  */
7 
8 #pragma once
9 
10 #include <map>
11 #include <memory>
12 #include <vector>
13 
14 #include <libcamera/controls.h>
15 
16 namespace libcamera {
17 
18 class ByteStreamBuffer;
19 
21 {
22 public:
23  enum class Role {
24  Proxy,
25  Worker
26  };
27 
28  ControlSerializer(Role role);
29 
30  void reset();
31 
32  static size_t binarySize(const ControlInfoMap &infoMap);
33  static size_t binarySize(const ControlList &list);
34 
35  int serialize(const ControlInfoMap &infoMap, ByteStreamBuffer &buffer);
36  int serialize(const ControlList &list, ByteStreamBuffer &buffer);
37 
38  template<typename T>
39  T deserialize(ByteStreamBuffer &buffer);
40 
41  bool isCached(const ControlInfoMap &infoMap);
42 
43 private:
44  static size_t binarySize(const ControlValue &value);
45  static size_t binarySize(const ControlInfo &info);
46 
47  static void store(const ControlValue &value, ByteStreamBuffer &buffer);
48  static void store(const ControlInfo &info, ByteStreamBuffer &buffer);
49 
50  ControlValue loadControlValue(ByteStreamBuffer &buffer,
51  bool isArray = false, unsigned int count = 1);
52  ControlInfo loadControlInfo(ByteStreamBuffer &buffer);
53 
54  unsigned int serial_;
55  unsigned int serialSeed_;
56  std::vector<std::unique_ptr<ControlId>> controlIds_;
57  std::vector<std::unique_ptr<ControlIdMap>> controlIdMaps_;
58  std::map<unsigned int, ControlInfoMap> infoMaps_;
59  std::map<const ControlInfoMap *, unsigned int> infoMapHandles_;
60 };
61 
62 } /* namespace libcamera */
Describe the limits of valid values for a Control.
Definition: controls.h:329
int serialize(const ControlInfoMap &infoMap, ByteStreamBuffer &buffer)
Serialize a ControlInfoMap in a buffer.
Definition: control_serializer.cpp:224
bool isCached(const ControlInfoMap &infoMap)
Check if a ControlInfoMap is cached.
Definition: control_serializer.cpp:649
T deserialize(ByteStreamBuffer &buffer)
Deserialize an object from a binary buffer.
ControlSerializer(Role role)
Construct a new ControlSerializer.
Definition: control_serializer.cpp:106
Top-level libcamera namespace.
Definition: backtrace.h:17
Abstract type representing the value of a control.
Definition: controls.h:133
static size_t binarySize(const ControlInfoMap &infoMap)
Retrieve the size in bytes required to serialize a ControlInfoMap.
Definition: control_serializer.cpp:164
A map of ControlId to ControlInfo.
Definition: controls.h:366
Role
Define the role of the IPC component using the control serializer.
Definition: control_serializer.h:23
Serializer and deserializer for control-related classes.
Definition: control_serializer.h:20
Wrap a memory buffer and provide sequential data read and write.
Definition: byte_stream_buffer.h:19
void reset()
Reset the serializer.
Definition: control_serializer.cpp:135
Associate a list of ControlId with their values for an object.
Definition: controls.h:410
Framework to manage controls related to an object.