test/serialization/ipa_data_serializer_test.cpp


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
2
	 *
	 * Internal:
	 *
	 * Data for the Android stream is produced by processing a libcamera
	 * stream created by the HAL for that purpose. The libcamera stream
	 * needs to be supplied with intermediate buffers where the library
	 * delivers frames to be processed and then provided to the framework.
	 * The libcamera stream configuration is not a direct translation of the
	 * Android stream characteristics, but it describes the format and size
	 * required for the processing procedure to produce frames in the
	 * Android required format.
	 *
	 * +-----+                +-----+
	 * |  A  |                |  L  |
	 * +-----+                +-----+
	 *    |                      |
	 *    V                      V
	 * +-----+                +------+
	 * |  B  |                |  FB  |
	 * +-----+                +------+
	 *   ^                       |
	 *   |-------Processing------|
	 *
	 *
	 * Mapped:
	 *
	 * Data for the Android stream is produced by processing a libcamera
	 * stream associated with another CameraStream. Mapped camera streams do
	 * not need any memory to be reserved for them as they process data
	 * produced by libcamera for a different stream whose format and size
	 * are compatible with the processing procedure requirements to produce
	 * frames in the Android required format.
	 *
	 * +-----+      +-----+          +-----+
	 * |  A  |      |  A' |          |  L  |
	 * +-----+      +-----+          +-----+
	 *    |            |                |
	 *    V            V                V
	 * +-----+      +-----+          +------+
	 * |  B  |      |  B' |<---------|  FB  |
	 * +-----+      +-----+          +------+
	 *   ^              |
	 *   |--Processing--|
	 *
	 *
	 * --------------------------------------------------------------------
	 * A  = Android stream
	 * L  = libcamera stream
	 * B  = memory buffer
	 * FB = libcamera FrameBuffer
	 * "Processing" = Frame processing procedure (Encoding, scaling etc)
	 */
	enum class Type {
		Direct,
		Internal,
		Mapped,
	};
	CameraStream(CameraDevice *const cameraDevice,
		     libcamera::CameraConfiguration *config, Type type,
		     camera3_stream_t *camera3Stream, unsigned int index);

	Type type() const { return type_; }
	const camera3_stream_t &camera3Stream() const { return *camera3Stream_; }
	const libcamera::StreamConfiguration &/* SPDX-License-Identifier: GPL-2.0-or-later */
/*
 * Copyright (C) 2020, Google Inc.
 *
 * Test serializing/deserializing with IPADataSerializer
 */

#include <algorithm>
#include <cxxabi.h>
#include <fcntl.h>
#include <iostream>
#include <limits>
#include <stdlib.h>
#include <sys/stat.h>
#include <sys/types.h>
#include <tuple>
#include <unistd.h>
#include <vector>

#include <libcamera/base/thread.h>
#include <libcamera/base/timer.h>

#include "libcamera/internal/ipa_data_serializer.h"

#include "serialization_test.h"
#include "test.h"

using namespace std;
using namespace libcamera;

static const ControlInfoMap Controls = ControlInfoMap({
		{ &controls::DebugMetadataEnable, ControlInfo(false, true) },
		{ &controls::ExposureTime, ControlInfo(0, 999999) },
		{ &controls::AnalogueGain, ControlInfo(1.0f, 32.0f) },
		{ &controls::ColourGains, ControlInfo(0.0f, 32.0f) },
		{ &controls::Brightness, ControlInfo(-1.0f, 1.0f) },
	}, controls::controls);

namespace libcamera {

static bool operator==(const ControlInfoMap &lhs, const ControlInfoMap &rhs)
{
	return SerializationTest::equals(lhs, rhs);
}

} /* namespace libcamera */

template<typename T>
int testPodSerdes(T in)
{
	std::vector<uint8_t> buf;
	std::vector<SharedFD> fds;

	std::tie(buf, fds) = IPADataSerializer<T>::serialize(in);
	T out = IPADataSerializer<T>::deserialize(buf, fds);
	if (in == out)
		return TestPass;

	char *name = abi::__cxa_demangle(typeid(T).name(), nullptr,
					 nullptr, nullptr);
	cerr << "Deserialized " << name << " doesn't match original" << endl;
	free(name);
	return TestFail;
}

template<typename T>
int testVectorSerdes(const std::vector<T> &in,
		     ControlSerializer *cs = nullptr)
{
	std::vector<uint8_t> buf;
	std::vector<SharedFD> fds;

	std::tie(buf, fds) = IPADataSerializer<std::vector<T>>::serialize(in, cs);
	std::vector<T> out = IPADataSerializer<std::vector<T>>::deserialize(buf, fds, cs);
	if (in == out)
		return TestPass;

	char *name = abi::__cxa_demangle(typeid(T).name(), nullptr,
					 nullptr, nullptr);
	cerr << "Deserialized std::vector<" << name
	     << "> doesn't match original" << endl;
	free(name);
	return TestFail;
}

template<typename K, typename V>
int testMapSerdes(const std::map<K, V> &in,
		  ControlSerializer *cs = nullptr)
{
	std::vector<uint8_t> buf;
	std::vector<SharedFD> fds;

	std::tie(buf, fds) = IPADataSerializer<std::map<K, V>>::serialize(in, cs);
	std::map<K, V> out = IPADataSerializer<std::map<K, V>>::deserialize(buf, fds, cs);
	if (in == out)
		return TestPass;

	char *nameK = abi::__cxa_demangle(typeid(K).name(), nullptr,
					  nullptr, nullptr);
	char *nameV = abi::__cxa_demangle(typeid(V).name(), nullptr,
					  nullptr, nullptr);
	cerr << "Deserialized std::map<" << nameK << ", " << nameV
	     << "> doesn't match original" << endl;
	free(nameK);
	free(nameV);
	return TestFail;
}

class IPADataSerializerTest : public CameraTest, public Test
{
public:
	IPADataSerializerTest()
		: CameraTest("platform/vimc.0 Sensor B")
	{
	}

protected:
	int init() override
	{
		return status_;
	}

	int run() override
	{
		int ret;

		ret = testControls();
		if (ret != TestPass)
			return ret;

		ret = testVector();
		if (ret != TestPass)
			return ret;

		ret = testMap();
		if (ret != TestPass)
			return ret;

		ret = testPod();
		if (ret != TestPass)
			return ret;

		return TestPass;
	}

private:
	ControlList generateControlList(const ControlInfoMap &infoMap)
	{
		/* Create a control list with three controls. */
		ControlList list(infoMap);

		list.set(controls::Brightness, 0.5f);
		list.set(controls::Contrast, 1.2f);
		list.set(controls::Saturation, 0.2f);

		return list;
	}

	int testControls()
	{
		ControlSerializer cs(ControlSerializer::Role::Proxy);

		const ControlInfoMap &infoMap = camera_->controls();
		ControlList list = generateControlList(infoMap);

		std::vector<uint8_t> infoMapBuf;
		std::tie(infoMapBuf, std::ignore) =
			IPADataSerializer<ControlInfoMap>::serialize(infoMap, &cs);

		std::vector<uint8_t> listBuf;
		std::tie(listBuf, std::ignore) =
			IPADataSerializer<ControlList>::serialize(list, &cs);

		const ControlInfoMap infoMapOut =
			IPADataSerializer<ControlInfoMap>::deserialize(infoMapBuf, &cs);

		ControlList listOut = IPADataSerializer<ControlList>::deserialize(listBuf, &cs);

		if (!SerializationTest::equals(infoMap, infoMapOut)) {
			cerr << "Deserialized map doesn't match original" << endl;
			return TestFail;
		}

		if (!SerializationTest::equals(list, listOut)) {
			cerr << "Deserialized list doesn't match original" << endl;
			return TestFail;
		}

		return TestPass;
	}

	int testVector()
	{
		ControlSerializer cs(ControlSerializer::Role::Proxy);

		/*
		 * We don't test SharedFD serdes because it dup()s, so we
		 * can't check for equality.
		 */
		std::vector<uint8_t>  vecUint8  = { 1, 2, 3, 4, 5, 6 };
		std::vector<uint16_t> vecUint16 = { 1, 2, 3, 4, 5, 6 };
		std::vector<uint32_t> vecUint32 = { 1, 2, 3, 4, 5, 6 };
		std::vector<uint64_t> vecUint64 = { 1, 2, 3, 4, 5, 6 };
		std::vector<int8_t>   vecInt8   = { 1, 2, 3, -4, 5, -6 };
		std::vector<int16_t>  vecInt16  = { 1, 2, 3, -4, 5, -6 };
		std::vector<int32_t>  vecInt32  = { 1, 2, 3, -4, 5, -6 };
		std::vector<int64_t>  vecInt64  = { 1, 2, 3, -4, 5, -6 };
		std::vector<float>    vecFloat  = { 1.1, 2.2, 3.3, -4.4, 5.5, -6.6 };
		std::vector<double>   vecDouble = { 1.1, 2.2, 3.3, -4.4, 5.5, -6.6 };
		std::vector<bool>     vecBool   = { true, true, false, false, true, false };
		std::vector<std::string>   vecString = { "foo", "bar", "baz" };
		std::vector<ControlInfoMap> vecControlInfoMap = {
			camera_->controls(),
			Controls,
		};

		std::vector<uint8_t> buf;
		std::vector<SharedFD> fds;

		if (testVectorSerdes(vecUint8) != TestPass)
			return TestFail;

		if (testVectorSerdes(vecUint16) != TestPass)
			return TestFail;

		if (testVectorSerdes(vecUint32) != TestPass)
			return TestFail;

		if (testVectorSerdes(vecUint64) != TestPass)
			return TestFail;

		if (testVectorSerdes(vecInt8) != TestPass)
			return TestFail;

		if (testVectorSerdes(vecInt16) != TestPass)
			return TestFail;

		if (testVectorSerdes(vecInt32) != TestPass)
			return TestFail;

		if (testVectorSerdes(vecInt64) != TestPass)
			return TestFail;

		if (testVectorSerdes(vecFloat) != TestPass)
			return TestFail;

		if (testVectorSerdes(vecDouble) != TestPass)
			return TestFail;

		if (testVectorSerdes(vecBool) != TestPass)
			return TestFail;

		if (testVectorSerdes(vecString) != TestPass)
			return TestFail;

		if (testVectorSerdes(vecControlInfoMap, &cs) != TestPass)
			return TestFail;

		return TestPass;
	}

	int testMap()
	{
		ControlSerializer cs(ControlSerializer::Role::Proxy);

		/*
		 * Realistically, only string and integral keys.
		 * Test simple, complex, and nested compound value.
		 */
		std::map<uint64_t, std::string> mapUintStr =
			{ { 101, "foo" }, { 102, "bar" }, { 103, "baz" } };
		std::map<int64_t, std::string> mapIntStr =
			{ { 101, "foo" }, { -102, "bar" }, { -103, "baz" } };
		std::map<std::string, std::string> mapStrStr =
			{ { "a", "foo" }, { "b", "bar" }, { "c", "baz" } };
		std::map<uint64_t, ControlInfoMap> mapUintCIM =
			{ { 201, camera_->controls() }, { 202, Controls } };
		std::map<int64_t, ControlInfoMap> mapIntCIM =
			{ { 201, camera_->controls() }, { -202, Controls } };
		std::map<std::string, ControlInfoMap> mapStrCIM =
			{ { "a", camera_->controls() }, { "b", Controls } };
		std::map<uint64_t, std::vector<uint8_t>> mapUintBVec =
			{ { 301, { 1, 2, 3 } }, { 302, { 4, 5, 6 } }, { 303, { 7, 8, 9 } } };
		std::map<int64_t, std::vector<uint8_t>> mapIntBVec =
			{ { 301, { 1, 2, 3 } }, { -302, { 4, 5, 6} }, { -303, { 7, 8, 9 } } };
		std::map<std::string, std::vector<uint8_t>> mapStrBVec =
			{ { "a", { 1, 2, 3 } }, { "b", { 4, 5, 6 } }, { "c", { 7, 8, 9 } } };

		std::vector<uint8_t> buf;
		std::vector<SharedFD> fds;

		if (testMapSerdes(mapUintStr) != TestPass)
			return TestFail;

		if (testMapSerdes(mapIntStr) != TestPass)
			return TestFail;

		if (testMapSerdes(mapStrStr) != TestPass)
			return TestFail;

		if (testMapSerdes(mapUintCIM, &cs) != TestPass)
			return TestFail;

		if (testMapSerdes(mapIntCIM,  &cs) != TestPass)
			return TestFail;

		if (testMapSerdes(mapStrCIM,  &cs) != TestPass)
			return TestFail;

		if (testMapSerdes(mapUintBVec) != TestPass)
			return TestFail;

		if (testMapSerdes(mapIntBVec) != TestPass)
			return TestFail;

		if (testMapSerdes(mapStrBVec) != TestPass)
			return TestFail;

		return TestPass;
	}

	int testPod()
	{
		uint32_t u32min = std::numeric_limits<uint32_t>::min();
		uint32_t u32max = std::numeric_limits<uint32_t>::max();
		uint32_t u32one = 1;
		int32_t  i32min = std::numeric_limits<int32_t>::min();
		int32_t  i32max = std::numeric_limits<int32_t>::max();
		int32_t  i32one = 1;

		uint64_t u64min = std::numeric_limits<uint64_t>::min();
		uint64_t u64max = std::numeric_limits<uint64_t>::max();
		uint64_t u64one = 1;
		int64_t  i64min = std::numeric_limits<int64_t>::min();
		int64_t  i64max = std::numeric_limits<int64_t>::max();
		int64_t  i64one = 1;

		float  flow = std::numeric_limits<float>::lowest();
		float  fmin = std::numeric_limits<float>::min();
		float  fmax = std::numeric_limits<float>::max();
		float  falmostOne = 1 + 1.0e-37;
		double dlow = std::numeric_limits<double>::lowest();
		double dmin = std::numeric_limits<double>::min();
		double dmax = std::numeric_limits<double>::max();
		double dalmostOne = 1 + 1.0e-307;

		bool t = true;
		bool f = false;

		std::stringstream ss;
		for (unsigned int i = 0; i < (1 << 11); i++)
			ss << "0123456789";

		std::string strLong = ss.str();
		std::string strEmpty = "";

		std::vector<uint8_t> buf;
		std::vector<SharedFD> fds;

		if (testPodSerdes(u32min) != TestPass)
			return TestFail;

		if (testPodSerdes(u32max) != TestPass)
			return TestFail;

		if (testPodSerdes(u32one) != TestPass)
			return TestFail;

		if (testPodSerdes(i32min) != TestPass)
			return TestFail;

		if (testPodSerdes(i32max) != TestPass)
			return TestFail;

		if (testPodSerdes(i32one) != TestPass)
			return TestFail;

		if (testPodSerdes(u64min) != TestPass)
			return TestFail;

		if (testPodSerdes(u64max) != TestPass)
			return TestFail;

		if (testPodSerdes(u64one) != TestPass)
			return TestFail;

		if (testPodSerdes(i64min) != TestPass)
			return TestFail;

		if (testPodSerdes(i64max) != TestPass)
			return TestFail;

		if (testPodSerdes(i64one) != TestPass)
			return TestFail;

		if (testPodSerdes(flow) != TestPass)
			return TestFail;

		if (testPodSerdes(fmin) != TestPass)
			return TestFail;

		if (testPodSerdes(fmax) != TestPass)
			return TestFail;

		if (testPodSerdes(falmostOne) != TestPass)
			return TestFail;

		if (testPodSerdes(dlow) != TestPass)
			return TestFail;

		if (testPodSerdes(dmin) != TestPass)
			return TestFail;

		if (testPodSerdes(dmax) != TestPass)
			return TestFail;

		if (testPodSerdes(dalmostOne) != TestPass)
			return TestFail;

		if (testPodSerdes(t) != TestPass)
			return TestFail;

		if (testPodSerdes(f) != TestPass)
			return TestFail;

		if (testPodSerdes(strLong) != TestPass)
			return TestFail;

		if (testPodSerdes(strEmpty) != TestPass)
			return TestFail;

		return TestPass;
	}
};

TEST_REGISTER(IPADataSerializerTest)