# SPDX-License-Identifier: BSD-2-Clause # # Copyright (C) 2019, Raspberry Pi (Trading) Limited # # ctt_tools.py - camera tuning tool miscellaneous import time import re import binascii import os import cv2 import numpy as np import imutils import sys import matplotlib.pyplot as plt from sklearn import cluster as cluster from sklearn.neighbors.nearest_centroid import NearestCentroid as get_centroids """ This file contains some useful tools, the details of which aren't important to understanding of the code. They ar collated here to attempt to improve code readability in the main files. """ """ obtain config values, unless it doesnt exist, in which case pick default Furthermore, it can check if the input is the correct type """ def get_config(dictt, key, default, ttype): try: val = dictt[key] if ttype == 'string': val = str(val) elif ttype == 'num': if 'int' not in str(type(val)): if 'float' not in str(type(val)): raise ValueError elif ttype == 'dict': if not isinstance(val, dict): raise ValueError elif ttype == 'list': if not isinstance(val, list): raise ValueError elif ttype == 'bool': ttype = int(bool(ttype)) else: val = dictt[key] except (KeyError, ValueError): val = default return val """ argument parser """ def parse_input(): arguments = sys.argv[1:] if len(arguments) % 2 != 0: raise ArgError('\n\nERROR! Enter value for each arguent passed.') params = arguments[0::2] vals = arguments[1::2] args_dict = dict(zip(params, vals)) json_output = get_config(args_dict, '-o', None, 'string') directory = get_config(args_dict, '-i', None, 'string') config = get_config(args_dict, '-c', None, 'string') log_path = get_config(args_dict, '-l', None, 'string') if directory is None: raise ArgError('\n\nERROR! No input directory given.') if json_output is None: raise ArgError('\n\nERROR! No output json given.') return json_output, directory, config, log_path """ custom arg and macbeth error class """ class ArgError(Exception): pass class MacbethError(Exception): pass """ correlation function to quantify match """ def correlate(im1, im2): f1 = im1.flatten() f2 = im2.flatten() cor = np.corrcoef(f1, f2) return cor[0][1] """ get list of files from directory """ def get_photos(directory='photos'): filename_list = [] for filename in os.listdir(directory): if 'jp' in filename or '.dng' in filename: filename_list.append(filename) return filename_list """ display image for debugging... read at your own risk... """ def represent(img, name='image'): # if type(img) == tuple or type(img) == list: # for i in range(len(img)): # name = 'image {}'.format(i) # cv2.imshow(name, img[i]) # else: # cv2.imshow(name, img) # cv2.waitKey(0) # cv2.destroyAllWindows() # return 0 """ code above displays using opencv, but this doesn't catch users pressing 'x' with their mouse to close the window.... therefore matplotlib is used.... (thanks a lot opencv) """ grid = plt.GridSpec(22, 1) plt.subplot(grid[:19, 0]) plt.imshow(img, cmap='gray') plt.axis('off') plt.subplot(grid[21, 0]) plt.title('press \'q\' to continue') plt.axis('off') plt.show() # f = plt.figure() # ax = f.add_subplot(211) # ax2 = f.add_subplot(122) # ax.imshow(img, cmap='gray') # ax.axis('off') # ax2.set_figheight(2) # ax2.title('press \'q\' to continue') # ax2.axis('off') # plt.show() """ reshape image to fixed width without distorting returns image and scale factor """ def reshape(img, width): factor = width/img.shape[0] return cv2.resize(img, None, fx=factor, fy=factor), factor d' value='7235248d38434f4c3e8a163ab03637ac115bdda8'/>
path: root/src/libcamera/control_serializer.cpp
blob: 0cf719bde79853ae5c5f20541946b6387769c4eb (plain) 
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
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648

/* SPDX-License-Identifier: LGPL-2.1-or-later */
/*
 * Copyright (C) 2019, Google Inc.
 *
 * control_serializer.cpp - Control (de)serializer
 */

#include "libcamera/internal/control_serializer.h"

#include <algorithm>
#include <memory>
#include <vector>

#include <libcamera/base/log.h>
#include <libcamera/base/span.h>

#include <libcamera/control_ids.h>
#include <libcamera/controls.h>
#include <libcamera/property_ids.h>

#include <libcamera/ipa/ipa_controls.h>

#include "libcamera/internal/byte_stream_buffer.h"

/**
 * \file control_serializer.h
 * \brief Serialization and deserialization helpers for controls
 */

namespace libcamera {

LOG_DEFINE_CATEGORY(Serializer)

/**
 * \class ControlSerializer
 * \brief Serializer and deserializer for control-related classes
 *
 * The control serializer is a helper to serialize and deserialize
 * ControlInfoMap and ControlValue instances for the purpose of communication
 * with IPA modules.
 *
 * Neither the ControlInfoMap nor the ControlList are self-contained data
 * container. ControlInfoMap references an external ControlId in each of its
 * entries, and ControlList references a ControlInfoMap for the purpose of
 * validation. Serializing and deserializing those objects thus requires a
 * context that maintains the associations between them. The control serializer
 * fulfils this task.
 *
 * ControlInfoMap instances can be serialized on their own, but require
 * ControlId instances to be provided at deserialization time. The serializer
 * recreates those ControlId instances and stores them in an internal cache,
 * from which the ControlInfoMap is populated.
 *
 * ControlList instances need to be associated with a ControlInfoMap when
 * deserialized. To make this possible, the control lists are serialized with a
 * handle to their ControlInfoMap, and the map is looked up from the handle at
 * deserialization time. To make this possible, the serializer assigns a
 * numerical handle to ControlInfoMap instances when they are serialized, and
 * stores the mapping between handle and ControlInfoMap both when serializing
 * (for the pipeline handler side) and deserializing (for the IPA side) them.
 * This mapping is used when serializing a ControlList to include the
 * corresponding ControlInfoMap handle in the binary data, and when
 * deserializing to retrieve the corresponding ControlInfoMap.
 *
 * As independent ControlSerializer instances are used on both sides of the IPC
 * boundary, and the two instances operate without a shared point of control,
 * there is a potential risk of collision of the numerical handles assigned to
 * each serialized ControlInfoMap. For this reason the control serializer is
 * initialized with a seed and the handle is incremented by 2, so that instances
 * initialized with a different seed operate on a separate numerical space,
 * avoiding any collision risk.
 *
 * In order to perform those tasks, the serializer keeps an internal state that
 * needs to be properly populated. This mechanism requires the ControlInfoMap
 * corresponding to a ControlList to have been serialized or deserialized
 * before the ControlList is serialized or deserialized. Failure to comply with
 * that constraint results in serialization or deserialization failure of the
 * ControlList.
 *
 * The serializer can be reset() to clear its internal state. This may be
 * performed when reconfiguring an IPA to avoid constant growth of the internal
 * state, especially if the contents of the ControlInfoMap instances change at
 * that time. A reset of the serializer invalidates all ControlList and
 * ControlInfoMap that have been previously deserialized. The caller shall thus
 * proceed with care to avoid stale references.
 */

/**
 * \enum ControlSerializer::Role
 * \brief Define the role of the IPC component using the control serializer
 *
 * The role of the component that creates the serializer is used to initialize
 * the handles numerical space.
 *
 * \var ControlSerializer::Role::Proxy
 * \brief The control serializer is used by the IPC Proxy classes
 *
 * \var ControlSerializer::Role::Worker
 * \brief The control serializer is used by the IPC ProxyWorker classes
 */

/**
 * \brief Construct a new ControlSerializer
 * \param[in] role The role of the IPC component using the serializer
 */
ControlSerializer::ControlSerializer(Role role)
{
	/*
	 * Initialize the handle numerical space using the role of the
	 * component that created the instance.
	 *
	 * Instances initialized for a different role will use a different
	 * numerical handle space, avoiding any collision risk when, in example,
	 * two instances of the ControlSerializer class are used at the IPC
	 * boundaries.
	 *
	 * Start counting handles from '1' as '0' is a special value used as
	 * place holder when serializing lists that do not have a ControlInfoMap
	 * associated (in example list of libcamera controls::controls).
	 *
	 * \todo This is a temporary hack and should probably be better
	 * engineered, but for the time being it avoids collisions on the handle
	 * value when using IPC.
	 */
	serialSeed_ = role == Role::Proxy ? 1 : 2;
	serial_ = serialSeed_;
}

/**
 * \brief Reset the serializer
 *
 * Reset the internal state of the serializer. This invalidates all the
 * ControlList and ControlInfoMap that have been previously deserialized.
 */
void ControlSerializer::reset()
{
	serial_ = serialSeed_;

	infoMapHandles_.clear();
	infoMaps_.clear();
	controlIds_.clear();
	controlIdMaps_.clear();
}

size_t ControlSerializer::binarySize(const ControlValue &value)
{
	return sizeof(ControlType) + value.data().size_bytes();
}

size_t ControlSerializer::binarySize(const ControlInfo &info)
{
	return binarySize(info.min()) + binarySize(info.max()) + binarySize(info.def());
}

/**
 * \brief Retrieve the size in bytes required to serialize a ControlInfoMap
 * \param[in] infoMap The control info map
 *
 * Compute and return the size in bytes required to store the serialized
 * ControlInfoMap.
 *
 * \return The size in bytes required to store the serialized ControlInfoMap
 */
size_t ControlSerializer::binarySize(const ControlInfoMap &infoMap)
{
	size_t size = sizeof(struct ipa_controls_header)
		    + infoMap.size() * sizeof(struct ipa_control_info_entry);

	for (const auto &ctrl : infoMap)
		size += binarySize(ctrl.second);

	return size;
}

/**
 * \brief Retrieve the size in bytes required to serialize a ControlList
 * \param[in] list The control list
 *
 * Compute and return the size in bytes required to store the serialized
 * ControlList.
 *
 * \return The size in bytes required to store the serialized ControlList
 */
size_t ControlSerializer::binarySize(const ControlList &list)
{
	size_t size = sizeof(struct ipa_controls_header)
		    + list.size() * sizeof(struct ipa_control_value_entry);

	for (const auto &ctrl : list)
		size += binarySize(ctrl.second);

	return size;
}

void ControlSerializer::store(const ControlValue &value,
			      ByteStreamBuffer &buffer)
{
	const ControlType type = value.type();
	buffer.write(&type);
	buffer.write(value.data());
}

void ControlSerializer::store(const ControlInfo &info, ByteStreamBuffer &buffer)
{
	store(info.min(), buffer);
	store(info.max(), buffer);
	store(info.def(), buffer);
}

/**
 * \brief Serialize a ControlInfoMap in a buffer
 * \param[in] infoMap The control info map to serialize