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
|
/*
** Copyright (c) 2018-2020 Valve Corporation
** Copyright (c) 2018-2020 LunarG, Inc.
**
** Permission is hereby granted, free of charge, to any person obtaining a
** copy of this software and associated documentation files (the "Software"),
** to deal in the Software without restriction, including without limitation
** the rights to use, copy, modify, merge, publish, distribute, sublicense,
** and/or sell copies of the Software, and to permit persons to whom the
** Software is furnished to do so, subject to the following conditions:
**
** The above copyright notice and this permission notice shall be included in
** all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
** IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
** FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
** AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
** LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
** FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
** DEALINGS IN THE SOFTWARE.
*/
#ifndef GFXRECON_ENCODE_PARAMETER_ENCODER_H
#define GFXRECON_ENCODE_PARAMETER_ENCODER_H
#include "encode/vulkan_handle_wrapper_util.h"
#if defined(WIN32)
#include "encode/dx12_object_wrapper_util.h"
#endif
#include "format/format.h"
#include "util/defines.h"
#include "util/output_stream.h"
#include "util/platform.h"
#include "vulkan/vulkan.h"
#include <cstring>
#include <cwchar>
#include <memory>
#include <type_traits>
GFXRECON_BEGIN_NAMESPACE(gfxrecon)
GFXRECON_BEGIN_NAMESPACE(encode)
class ParameterEncoder
{
public:
ParameterEncoder(util::OutputStream* stream) : output_stream_(stream) {}
~ParameterEncoder() {}
// clang-format off
// Values
void EncodeInt8Value(int8_t value) { EncodeValue(value); }
void EncodeUInt8Value(uint8_t value) { EncodeValue(value); }
void EncodeInt16Value(int16_t value) { EncodeValue(value); }
void EncodeUInt16Value(uint16_t value) { EncodeValue(value); }
void EncodeInt32Value(int32_t value) { EncodeValue(value); }
void EncodeUInt32Value(uint32_t value) { EncodeValue(value); }
void EncodeInt64Value(int64_t value) { EncodeValue(value); }
void EncodeUInt64Value(uint64_t value) { EncodeValue(value); }
void EncodeFloatValue(float value) { EncodeValue(value); }
void EncodeVkBool32Value(VkBool32 value) { EncodeValue(value); }
void EncodeVkSampleMaskValue(VkSampleMask value) { EncodeValue(static_cast<format::SampleMaskEncodeType>(value)); }
void EncodeVkDeviceSizeValue(VkDeviceSize value) { EncodeValue(static_cast<format::DeviceSizeEncodeType>(value)); }
void EncodeVkDeviceAddressValue(VkDeviceAddress value) { EncodeValue(static_cast<format::DeviceSizeEncodeType>(value)); }
void EncodeSizeTValue(size_t value) { EncodeValue(static_cast<format::SizeTEncodeType>(value)); }
void EncodeHandleIdValue(format::HandleId value) { EncodeValue(static_cast<format::HandleEncodeType>(value)); }
// Encode the address values for pointers to non-Vulkan objects to be used as object IDs.
void EncodeAddress(const void* value) { EncodeValue(reinterpret_cast<format::AddressEncodeType>(value)); }
void EncodeVoidPtr(const void* value) { EncodeAddress(value); }
template<typename T>
void EncodeFunctionPtr(T value) { EncodeValue(reinterpret_cast<format::AddressEncodeType>(value)); }
template<typename T>
void EncodeHandleValue(T value) { EncodeHandleIdValue(GetWrappedId(value)); }
template<typename T>
void EncodeEnumValue(T value) { EncodeValue(static_cast<format::EnumEncodeType>(value)); }
template<typename T>
void EncodeFlagsValue(T value) { EncodeValue(static_cast<format::FlagsEncodeType>(value)); }
template<typename T>
void EncodeFlags64Value(T value) { EncodeValue(static_cast<format::Flags64EncodeType>(value)); }
// Pointers
void EncodeUInt8Ptr(const uint8_t* ptr, bool omit_data = false, bool omit_addr = false) { EncodePointer(ptr, omit_data, omit_addr); }
void EncodeInt32Ptr(const int32_t* ptr, bool omit_data = false, bool omit_addr = false) { EncodePointer(ptr, omit_data, omit_addr); }
void EncodeUInt32Ptr(const uint32_t* ptr, bool omit_data = false, bool omit_addr = false) { EncodePointer(ptr, omit_data, omit_addr); }
#if defined(WIN32)
// Oveload for WIN32 DWORD type. Pointers from the DWORD typedef of unsigned long are not compatible with uint32_t pointers.
void EncodeUInt32Ptr(const unsigned long* ptr, bool omit_data = false, bool omit_addr = false) { EncodePointer(ptr, omit_data, omit_addr); }
// Oveload for WIN32 SIZE_T type. Pointers from the SIZE_T typedef of unsigned long are not compatible with size_t pointers.
void EncodeSizeTPtr(const unsigned long* ptr, bool omit_data = false, bool omit_addr = false) { EncodePointer(ptr, omit_data, omit_addr); }
#endif
void EncodeInt64Ptr(const int64_t* ptr, bool omit_data = false, bool omit_addr = false) { EncodePointer(ptr, omit_data, omit_addr); }
void EncodeUInt64Ptr(const uint64_t* ptr, bool omit_data = false, bool omit_addr = false) { EncodePointer(ptr, omit_data, omit_addr); }
void EncodeFloatPtr(const float* ptr, bool omit_data = false, bool omit_addr = false) { EncodePointer(ptr, omit_data, omit_addr); }
void EncodeVkBool32Ptr(const VkBool32* ptr, bool omit_data = false, bool omit_addr = false) { EncodePointer(ptr, omit_data, omit_addr); }
void EncodeVkSampleMaskPtr(const VkSampleMask* ptr, bool omit_data = false, bool omit_addr = false) { EncodePointerConverted<format::SampleMaskEncodeType>(ptr, omit_data, omit_addr); }
void EncodeVkDeviceSizePtr(const VkDeviceSize* ptr, bool omit_data = false, bool omit_addr = false) { EncodePointerConverted<format::DeviceSizeEncodeType>(ptr, omit_data, omit_addr); }
void EncodeSizeTPtr(const size_t* ptr, bool omit_data = false, bool omit_addr = false) { EncodePointerConverted<format::SizeTEncodeType>(ptr, omit_data, omit_addr); }
void EncodeHandleIdPtr(const format::HandleId* ptr, bool omit_data = false, bool omit_addr = false) { EncodePointerConverted<format::HandleEncodeType>(ptr, omit_data, omit_addr); }
// Treat pointers to non-Vulkan objects as 64-bit object IDs.
template<typename T>
void EncodeVoidPtrPtr(const T* const* ptr, bool omit_data = false, bool omit_addr = false) { EncodePointerConverted<format::AddressEncodeType>(ptr, omit_data, omit_addr); }
template<typename T>
void EncodeHandlePtr(const T* ptr, bool omit_data = false, bool omit_addr = false) { EncodeWrappedHandlePointer(ptr, omit_data, omit_addr); }
template<typename T>
void EncodeEnumPtr(const T* ptr, bool omit_data = false, bool omit_addr = false) { EncodePointerConverted<format::EnumEncodeType>(ptr, omit_data, omit_addr); }
template<typename T>
void EncodeFlagsPtr(const T* ptr, bool omit_data = false, bool omit_addr = false) { EncodePointerConverted<format::FlagsEncodeType>(ptr, omit_data, omit_addr); }
template<typename T>
void EncodeFlags64Ptr(const T* ptr, bool omit_data = false, bool omit_addr = false) { EncodePointerConverted<format::Flags64EncodeType>(ptr, omit_data, omit_addr); }
// Arrays
void EncodeInt16Array(const int16_t* arr, size_t len, bool omit_data = false, bool omit_addr = false) { EncodeArray(arr, len, omit_data, omit_addr); }
void EncodeUInt16Array(const uint16_t* arr, size_t len, bool omit_data = false, bool omit_addr = false) { EncodeArray(arr, len, omit_data, omit_addr); }
void EncodeInt32Array(const int32_t* arr, size_t len, bool omit_data = false, bool omit_addr = false) { EncodeArray(arr, len, omit_data, omit_addr); }
void EncodeUInt32Array(const uint32_t* arr, size_t len, bool omit_data = false, bool omit_addr = false) { EncodeArray(arr, len, omit_data, omit_addr); }
void EncodeInt64Array(const int64_t* arr, size_t len, bool omit_data = false, bool omit_addr = false) { EncodeArray(arr, len, omit_data, omit_addr); }
void EncodeUInt64Array(const uint64_t* arr, size_t len, bool omit_data = false, bool omit_addr = false) { EncodeArray(arr, len, omit_data, omit_addr); }
void EncodeFloatArray(const float* arr, size_t len, bool omit_data = false, bool omit_addr = false) { EncodeArray(arr, len, omit_data, omit_addr); }
void EncodeVkBool32Array(const VkBool32* arr, size_t len, bool omit_data = false, bool omit_addr = false) { EncodeArray(arr, len, omit_data, omit_addr); }
void EncodeVkSampleMaskArray(const VkSampleMask* arr, size_t len, bool omit_data = false, bool omit_addr = false) { EncodeArrayConverted<format::SampleMaskEncodeType>(arr, len, omit_data, omit_addr); }
void EncodeVkDeviceSizeArray(const VkDeviceSize* arr, size_t len, bool omit_data = false, bool omit_addr = false) { EncodeArrayConverted<format::DeviceSizeEncodeType>(arr, len, omit_data, omit_addr); }
void EncodeVkDeviceAddressArray(const VkDeviceAddress* arr, size_t len, bool omit_data = false, bool omit_addr = false) { EncodeArrayConverted<format::DeviceAddressEncodeType>(arr, len, omit_data, omit_addr); }
void EncodeSizeTArray(const size_t* arr, size_t len, bool omit_data = false, bool omit_addr = false) { EncodeArrayConverted<format::SizeTEncodeType>(arr, len, omit_data, omit_addr); }
void EncodeHandleIdArray(const format::HandleId* arr, size_t len, bool omit_data = false, bool omit_addr = false) { EncodeArrayConverted<format::HandleEncodeType>(arr, len, omit_data, omit_addr); }
// Array of bytes.
void EncodeUInt8Array(const void* arr, size_t len, bool omit_data = false, bool omit_addr = false) { EncodeArray(reinterpret_cast<const uint8_t*>(arr), len, omit_data, omit_addr); }
void EncodeVoidArray(const void* arr, size_t len, bool omit_data = false, bool omit_addr = false) { EncodeArray(reinterpret_cast<const uint8_t*>(arr), len, omit_data, omit_addr); }
template<typename T>
void EncodeHandleArray(const T* arr, size_t len, bool omit_data = false, bool omit_addr = false) { EncodeWrappedHandleArray(arr, len, omit_data, omit_addr); }
template<typename T>
void EncodeEnumArray(const T* arr, size_t len, bool omit_data = false, bool omit_addr = false) { EncodeArrayConverted<format::EnumEncodeType>(arr, len, omit_data, omit_addr); }
template<typename T>
void EncodeFlagsArray(const T* arr, size_t len, bool omit_data = false, bool omit_addr = false) { EncodeArrayConverted<format::FlagsEncodeType>(arr, len, omit_data, omit_addr); }
template<typename T>
void EncodeFlags64Array(const T* arr, size_t len, bool omit_data = false, bool omit_addr = false) { EncodeArrayConverted<format::Flags64EncodeType>(arr, len, omit_data, omit_addr); }
void EncodeString(const char* str, bool omit_data = false, bool omit_addr = false) { EncodeBasicString<char, format::CharEncodeType, format::PointerAttributes::kIsString>(str, omit_data, omit_addr); }
void EncodeWString(const wchar_t* str, bool omit_data = false, bool omit_addr = false) { EncodeBasicString<wchar_t, format::WCharEncodeType, format::PointerAttributes::kIsWString>(str, omit_data, omit_addr); }
void EncodeStringArray(const char* const* str, size_t len, bool omit_data = false, bool omit_addr = false) { EncodeBasicStringArray<char, format::CharEncodeType, format::PointerAttributes::kIsString>(str, len, omit_data, omit_addr); }
void EncodeWStringArray(const wchar_t* const* str, size_t len, bool omit_data = false, bool omit_addr = false) { EncodeBasicStringArray<wchar_t, format::WCharEncodeType, format::PointerAttributes::kIsWString>(str, len, omit_data, omit_addr); }
// 2D Arrays
template<typename SizeT>
void EncodeUInt32Array2D(const uint32_t* const* arr, SizeT size_2d, bool omit_data = false, bool omit_addr = false) { EncodeArray2D(arr, size_2d, omit_data, omit_addr); }
template <size_t N, size_t M>
void EncodeFloat2DMatrix(const float (&arr)[N][M], size_t n, size_t m, bool omit_data = false, bool omit_addr = false) { assert((N == n) && (M == m)); EncodeArray(reinterpret_cast<const float*>(arr), n * m, omit_data, omit_addr); }
// clang-format on
void EncodeStructPtrPreamble(const void* ptr, bool omit_data = false, bool omit_addr = false)
{
uint32_t pointer_attrib = format::PointerAttributes::kIsStruct | format::PointerAttributes::kIsSingle |
GetPointerAttributeMask(ptr, omit_data, omit_addr);
output_stream_->Write(&pointer_attrib, sizeof(pointer_attrib));
if ((pointer_attrib & format::PointerAttributes::kHasAddress) == format::PointerAttributes::kHasAddress)
{
EncodeAddress(ptr);
}
}
void EncodeStructArrayPreamble(const void* arr, size_t len, bool omit_data = false, bool omit_addr = false)
{
uint32_t pointer_attrib = format::PointerAttributes::kIsStruct | format::PointerAttributes::kIsArray |
GetPointerAttributeMask(arr, omit_data, omit_addr);
output_stream_->Write(&pointer_attrib, sizeof(pointer_attrib));
if (arr != nullptr)
{
if ((pointer_attrib & format::PointerAttributes::kHasAddress) == format::PointerAttributes::kHasAddress)
{
EncodeAddress(arr);
}
// Always write the array size when the pointer is not null.
EncodeSizeTValue(len);
}
}
void EncodeStructArray2DPreamble(const void* arr, size_t len, bool omit_data = false, bool omit_addr = false)
{
uint32_t pointer_attrib = format::PointerAttributes::kIsStruct | format::PointerAttributes::kIsArray2D |
GetPointerAttributeMask(arr, omit_data, omit_addr);
output_stream_->Write(&pointer_attrib, sizeof(pointer_attrib));
if (arr != nullptr)
{
if ((pointer_attrib & format::PointerAttributes::kHasAddress) == format::PointerAttributes::kHasAddress)
{
EncodeAddress(arr);
}
// Always write the array size when the pointer is not null.
EncodeSizeTValue(len);
}
}
#if defined(WIN32)
template <typename T>
void EncodeObjectValue(const T* value)
{
EncodeHandleIdValue(GetDx12WrappedId<T>(value));
}
template <typename T>
void EncodeObjectPtr(const T* const* value, bool omit_data = false, bool omit_addr = false)
{
EncodeWrappedObjectPointer(value, omit_data, omit_addr);
}
void EncodeObjectPtr(const void* const* value, bool omit_data = false, bool omit_addr = false)
{
EncodeWrappedObjectPointer(reinterpret_cast<const IUnknown* const*>(value), omit_data, omit_addr);
}
template <typename T>
void EncodeWrappedObjectPointer(const T* const* ptr, bool omit_data = false, bool omit_addr = false)
{
uint32_t pointer_attrib =
format::PointerAttributes::kIsSingle | GetPointerAttributeMask(ptr, omit_data, omit_addr);
output_stream_->Write(&pointer_attrib, sizeof(pointer_attrib));
if (ptr != nullptr)
{
if ((pointer_attrib & format::PointerAttributes::kHasAddress) == format::PointerAttributes::kHasAddress)
{
EncodeAddress(ptr);
}
if ((pointer_attrib & format::PointerAttributes::kHasData) == format::PointerAttributes::kHasData)
{
EncodeObjectValue<T>(*ptr);
}
}
}
template <typename T>
void EncodeObjectArray(T* const* arr, size_t len, bool omit_data = false, bool omit_addr = false)
{
EncodeWrappedObjectArray<T>(arr, len, omit_data, omit_addr);
}
template <typename T>
void EncodeWrappedObjectArray(T* const* arr, size_t len, bool omit_data = false, bool omit_addr = false)
{
uint32_t pointer_attrib =
format::PointerAttributes::kIsArray | GetPointerAttributeMask(arr, omit_data, omit_addr);
output_stream_->Write(&pointer_attrib, sizeof(pointer_attrib));
if (arr != nullptr)
{
if ((pointer_attrib & format::PointerAttributes::kHasAddress) == format::PointerAttributes::kHasAddress)
{
EncodeAddress(arr);
}
// Always write the array size when the pointer is not null.
EncodeSizeTValue(len);
if ((pointer_attrib & format::PointerAttributes::kHasData) == format::PointerAttributes::kHasData)
{
for (size_t i = 0; i < len; ++i)
{
EncodeObjectValue<T>(arr[i]);
}
}
}
}
#endif
private:
uint32_t GetPointerAttributeMask(const void* ptr, bool omit_data, bool omit_addr)
{
uint32_t pointer_attrib = 0;
if (ptr == nullptr)
{
pointer_attrib |= format::PointerAttributes::kIsNull;
}
else
{
if (!omit_addr)
{
pointer_attrib |= format::PointerAttributes::kHasAddress;
}
if (!omit_data)
{
pointer_attrib |= format::PointerAttributes::kHasData;
}
}
return pointer_attrib;
}
template <typename DstT, typename SrcT>
typename std::enable_if<!std::is_pointer<SrcT>::value && !std::is_pointer<DstT>::value, DstT>::type
TypeCast(SrcT value)
{
return static_cast<DstT>(value);
}
template <typename DstT, typename SrcT>
typename std::enable_if<std::is_pointer<SrcT>::value || std::is_pointer<DstT>::value, DstT>::type
TypeCast(SrcT value)
{
return reinterpret_cast<DstT>(value);
}
template <typename T>
void EncodeValue(T value)
{
output_stream_->Write(&value, sizeof(T));
}
template <typename T>
void EncodePointer(const T* ptr, bool omit_data = false, bool omit_addr = false)
{
uint32_t pointer_attrib =
format::PointerAttributes::kIsSingle | GetPointerAttributeMask(ptr, omit_data, omit_addr);
output_stream_->Write(&pointer_attrib, sizeof(pointer_attrib));
if (ptr != nullptr)
{
if ((pointer_attrib & format::PointerAttributes::kHasAddress) == format::PointerAttributes::kHasAddress)
{
EncodeAddress(ptr);
}
if ((pointer_attrib & format::PointerAttributes::kHasData) == format::PointerAttributes::kHasData)
{
output_stream_->Write(ptr, sizeof(T));
}
}
}
template <typename DstT, typename SrcT>
void EncodePointerConverted(const SrcT* ptr, bool omit_data = false, bool omit_addr = false)
{
uint32_t pointer_attrib =
format::PointerAttributes::kIsSingle | GetPointerAttributeMask(ptr, omit_data, omit_addr);
output_stream_->Write(&pointer_attrib, sizeof(pointer_attrib));
if (ptr != nullptr)
{
if ((pointer_attrib & format::PointerAttributes::kHasAddress) == format::PointerAttributes::kHasAddress)
{
EncodeAddress(ptr);
}
if ((pointer_attrib & format::PointerAttributes::kHasData) == format::PointerAttributes::kHasData)
{
DstT converted = TypeCast<DstT>(*ptr);
output_stream_->Write(&converted, sizeof(DstT));
}
}
}
template <typename SrcT>
void EncodeWrappedHandlePointer(const SrcT* ptr, bool omit_data = false, bool omit_addr = false)
{
uint32_t pointer_attrib =
format::PointerAttributes::kIsSingle | GetPointerAttributeMask(ptr, omit_data, omit_addr);
output_stream_->Write(&pointer_attrib, sizeof(pointer_attrib));
if (ptr != nullptr)
{
if ((pointer_attrib & format::PointerAttributes::kHasAddress) == format::PointerAttributes::kHasAddress)
{
EncodeAddress(ptr);
}
if ((pointer_attrib & format::PointerAttributes::kHasData) == format::PointerAttributes::kHasData)
{
EncodeHandleValue(*ptr);
}
}
}
template <typename T>
void EncodeArray(const T* arr, size_t len, bool omit_data = false, bool omit_addr = false)
{
uint32_t pointer_attrib =
format::PointerAttributes::kIsArray | GetPointerAttributeMask(arr, omit_data, omit_addr);
output_stream_->Write(&pointer_attrib, sizeof(pointer_attrib));
if (arr != nullptr)
{
if ((pointer_attrib & format::PointerAttributes::kHasAddress) == format::PointerAttributes::kHasAddress)
{
EncodeAddress(arr);
}
// Always write the array size when the pointer is not null.
EncodeSizeTValue(len);
if ((pointer_attrib & format::PointerAttributes::kHasData) == format::PointerAttributes::kHasData)
{
output_stream_->Write(arr, len * sizeof(T));
}
}
}
// Perform a type conversion for array elements when the original type has a size that is not equal to the target
// type for conversion.
template <typename DstT, typename SrcT>
typename std::enable_if<sizeof(SrcT) != sizeof(DstT), void>::type
EncodeArrayConverted(const SrcT* arr, size_t len, bool omit_data = false, bool omit_addr = false)
{
uint32_t pointer_attrib =
format::PointerAttributes::kIsArray | GetPointerAttributeMask(arr, omit_data, omit_addr);
output_stream_->Write(&pointer_attrib, sizeof(pointer_attrib));
if (arr != nullptr)
{
if ((pointer_attrib & format::PointerAttributes::kHasAddress) == format::PointerAttributes::kHasAddress)
{
EncodeAddress(arr);
}
// Always write the array size when the pointer is not null.
EncodeSizeTValue(len);
if ((pointer_attrib & format::PointerAttributes::kHasData) == format::PointerAttributes::kHasData)
{
for (size_t i = 0; i < len; ++i)
{
DstT converted = TypeCast<DstT>(arr[i]);
output_stream_->Write(&converted, sizeof(DstT));
}
}
}
}
// Overload for the case where the original type and the conversion type have matching sizes, where we can skip the
// type conversion.
template <typename DstT, typename SrcT>
typename std::enable_if<sizeof(SrcT) == sizeof(DstT), void>::type
EncodeArrayConverted(const SrcT* arr, size_t len, bool omit_data = false, bool omit_addr = false)
{
EncodeArray(arr, len, omit_data, omit_addr);
}
template <typename SrcT>
void EncodeWrappedHandleArray(const SrcT* arr, size_t len, bool omit_data = false, bool omit_addr = false)
{
uint32_t pointer_attrib =
format::PointerAttributes::kIsArray | GetPointerAttributeMask(arr, omit_data, omit_addr);
output_stream_->Write(&pointer_attrib, sizeof(pointer_attrib));
if (arr != nullptr)
{
if ((pointer_attrib & format::PointerAttributes::kHasAddress) == format::PointerAttributes::kHasAddress)
{
EncodeAddress(arr);
}
// Always write the array size when the pointer is not null.
EncodeSizeTValue(len);
if ((pointer_attrib & format::PointerAttributes::kHasData) == format::PointerAttributes::kHasData)
{
for (size_t i = 0; i < len; ++i)
{
EncodeHandleValue(arr[i]);
}
}
}
}
template <typename T, typename SizeT>
typename std::enable_if<!std::is_integral<SizeT>::value>::type
EncodeArray2D(const T* const* arr, SizeT size_2d, bool omit_data = false, bool omit_addr = false)
{
// Outer pointer attributes
uint32_t pointer_attrib =
format::PointerAttributes::kIsArray2D | GetPointerAttributeMask(arr, omit_data, omit_addr);
output_stream_->Write(&pointer_attrib, sizeof(pointer_attrib));
if (arr != nullptr)
{
// Outer array address
if ((pointer_attrib & format::PointerAttributes::kHasAddress) == format::PointerAttributes::kHasAddress)
{
EncodeAddress(arr);
}
// Outer array size
EncodeSizeTValue(size_2d.size());
// Treat all inner array infomation as data
if ((pointer_attrib & format::PointerAttributes::kHasData) == format::PointerAttributes::kHasData)
{
for (size_t i = 0; i < size_2d.size(); ++i)
{
// Inner pointer attributes
uint32_t inner_pointer_attrib =
format::PointerAttributes::kIsArray | GetPointerAttributeMask(arr[i], omit_data, omit_addr);
output_stream_->Write(&inner_pointer_attrib, sizeof(inner_pointer_attrib));
// Inner array address
if ((inner_pointer_attrib & format::PointerAttributes::kHasAddress) ==
format::PointerAttributes::kHasAddress)
{
EncodeAddress(arr[i]);
}
// Inner array size
EncodeSizeTValue(size_2d[i]);
// Inner array data
if ((inner_pointer_attrib & format::PointerAttributes::kHasData) ==
format::PointerAttributes::kHasData)
{
output_stream_->Write(arr[i], size_2d[i] * sizeof(T));
}
}
}
}
}
template <typename CharT, typename EncodeT>
typename std::enable_if<sizeof(CharT) == sizeof(EncodeT), void>::type EncodeBasicStringConverted(const CharT* str,
size_t len)
{
output_stream_->Write(str, len * sizeof(CharT));
}
template <typename CharT, typename EncodeT>
typename std::enable_if<sizeof(CharT) != sizeof(EncodeT), void>::type EncodeBasicStringConverted(const CharT* str,
size_t len)
{
for (size_t i = 0; i < len; ++i)
{
EncodeT converted = TypeCast<EncodeT>(str[i]);
output_stream_->Write(&converted, sizeof(EncodeT));
}
}
template <typename CharT, typename EncodeT, format::PointerAttributes EncodeAttrib>
void EncodeBasicString(const CharT* str, bool omit_data, bool omit_addr)
{
uint32_t pointer_attrib =
EncodeAttrib | format::PointerAttributes::kIsSingle | GetPointerAttributeMask(str, omit_data, omit_addr);
output_stream_->Write(&pointer_attrib, sizeof(pointer_attrib));
if (str != nullptr)
{
if ((pointer_attrib & format::PointerAttributes::kHasAddress) == format::PointerAttributes::kHasAddress)
{
EncodeAddress(str);
}
// Always write the string length.
size_t len = util::platform::StringLength(str);
EncodeSizeTValue(len);
if ((pointer_attrib & format::PointerAttributes::kHasData) == format::PointerAttributes::kHasData)
{
EncodeBasicStringConverted<CharT, EncodeT>(str, len);
}
}
}
template <typename CharT, typename EncodeT, format::PointerAttributes EncodeAttrib>
void EncodeBasicStringArray(const CharT* const* str, size_t len, bool omit_data, bool omit_addr)
{
uint32_t pointer_attrib =
EncodeAttrib | format::PointerAttributes::kIsArray | GetPointerAttributeMask(str, omit_data, omit_addr);
output_stream_->Write(&pointer_attrib, sizeof(pointer_attrib));
if (str != nullptr)
{
if ((pointer_attrib & format::PointerAttributes::kHasAddress) == format::PointerAttributes::kHasAddress)
{
EncodeAddress(str);
}
// Always write the array size.
EncodeSizeTValue(len);
if ((pointer_attrib & format::PointerAttributes::kHasData) == format::PointerAttributes::kHasData)
{
for (size_t i = 0; i < len; ++i)
{
EncodeBasicString<CharT, EncodeT, EncodeAttrib>(str[i], omit_data, omit_addr);
}
}
}
}
private:
util::OutputStream* output_stream_;
};
GFXRECON_END_NAMESPACE(encode)
GFXRECON_END_NAMESPACE(gfxrecon)
#endif // GFXRECON_ENCODE_PARAMETER_ENCODER_H
|
