143 static constexpr uint8_t kQualityUndefined = 255;
144 static constexpr double kInvalidTimestamp = -1E-308;
152 double keyFrameTimestamp,
153 uint32_t keyFrameIndex);
162 uint32_t stride2 = 0,
163 string codecName = {},
164 uint8_t codecQuality = kQualityUndefined,
165 double keyFrameTimestamp = kInvalidTimestamp,
166 uint32_t keyFrameIndex = 0);
172 uint32_t height = 0);
187 uint8_t codecQuality = kQualityUndefined,
192 uint32_t stride2 = 0);
197 uint8_t codecQuality,
202 uint32_t stride2 = 0);
214 uint32_t stride2 = 0,
215 string codecName = {},
216 uint8_t codecQuality = kQualityUndefined,
217 double keyFrameTimestamp = kInvalidTimestamp,
218 uint32_t keyFrameIndex = 0);
277 uint32_t getRawStride2()
const {
322 return isQualityValid(codecQuality_) ? codecQuality_ : kQualityUndefined;
327 return quality <= 100;
332 return keyFrameTimestamp_;
338 return keyFrameIndex_;
348 return toString(pixelFormat);
364 uint32_t stride2_{0};
367 double keyFrameTimestamp_{kInvalidTimestamp};
368 uint32_t keyFrameIndex_{0};
369 uint8_t codecQuality_{kQualityUndefined};
384 uint8_t channelCount = 0,
385 uint8_t sampleFrameStride = 0,
386 uint32_t sampleFrameRate = 0,
387 uint32_t sampleFrameCount = 0,
388 uint8_t stereoPairCount = 0);
406 return !operator==(rhs);
426 return sampleFormat_;
450 return channelCount_;
454 return sampleFrameRate_;
458 return sampleFrameCount_;
462 sampleFrameCount_ = sampleCount;
465 uint8_t getStereoPairCount()
const {
466 return stereoPairCount_;
483 return toString(sampleFormat);
489 uint8_t sampleFrameStride_{};
490 uint8_t channelCount_{};
491 uint32_t sampleFrameRate_{};
492 uint32_t sampleFrameCount_{};
493 uint8_t stereoPairCount_{};
524 std::string codecName,
525 uint8_t codecQuality,
530 uint32_t stride2 = 0);
538 uint32_t stride2 = 0);
546 double keyFrameTimestamp,
547 uint32_t keyFrameIndex);
557 uint8_t numChannels = 0,
558 uint8_t sampleFrameStride = 0,
559 uint32_t sampleRate = 0,
560 uint32_t sampleCount = 0,
561 uint8_t stereoPairCount = 0);
569 : contentType_{other.contentType_}, size_{size} {
571 imageSpec_ = other.imageSpec_;
573 audioSpec_ = other.audioSpec_;
575 customContentBlockFormat_ = other.customContentBlockFormat_;
579 ~ContentBlock() =
default;
581 ContentBlock& operator=(
const ContentBlock& rhs) =
default;
582 ContentBlock& operator=(ContentBlock&& rhs)
noexcept =
default;
598 return customContentBlockFormat_;
604 return !operator==(rhs);
608 RecordFormat
operator+(
const ContentBlock&)
const;
611 const ImageContentBlockSpec&
image()
const;
613 const AudioContentBlockSpec&
audio()
const;
618 ImageContentBlockSpec imageSpec_;
619 AudioContentBlockSpec audioSpec_;
620 string customContentBlockFormat_;
645 uint32_t formatVersion,
648 recordType(recordType),
649 formatVersion(formatVersion),
650 blockIndex(blockIndex) {}
660 uint32_t getFormatVersion()
const {
661 return formatVersion;
664 size_t getBlockIndex()
const {
671 uint32_t formatVersion;
710 blocks_.emplace_back(block);
714 blocks_.emplace_back(std::move(block));
718 blocks_.emplace_back(first);
719 blocks_.emplace_back(second);
723 blocks_.emplace_back(std::move(first));
724 blocks_.emplace_back(std::move(second));
731 blocks_.emplace_back(type, size);
736 blocks_.emplace_back(block);
741 blocks_.emplace_back(std::move(block));
747 return !operator==(rhs);
756 void set(
const string& format);
791 size_t getBlockSize(
size_t blockIndex,
size_t remainingSize)
const;
797 static string getDataLayoutTagName(
Record::Type type, uint32_t version,
size_t blockIndex);
801 const string& tagName,
803 uint32_t& formatVersion);
808 map<string, string>& inOutRecordFormatRegister,
810 uint32_t formatVersion,
812 const vector<const DataLayout*>& layouts);
814 static void getRecordFormats(
815 const map<string, string>& recordFormatRegister,
818 static unique_ptr<DataLayout> getDataLayout(
819 const map<string, string>& recordFormatRegister,
823 vector<ContentBlock> blocks_;
Specification of an audio content block.
Definition RecordFormat.h:373
uint8_t getChannelCount() const
Get the number of audio channels in each sample frame (not in the content block).
Definition RecordFormat.h:449
void setSampleCount(uint32_t sampleCount)
Set the number of audio sample frames in the content block.
Definition RecordFormat.h:461
string asString() const
Definition RecordFormat.cpp:777
uint8_t getBitsPerSample() const
Get the number of bits per audio sample.
Definition RecordFormat.h:439
AudioContentBlockSpec(const AudioContentBlockSpec &)=default
Default copy constructor.
bool isLittleEndian() const
Tell if the audio sample format is little endian.
Definition RecordFormat.h:431
bool isSampleBlockFormatDefined() const
Definition RecordFormat.cpp:830
size_t getPcmBlockSize() const
Assuming PCM, get the number of bytes for this content block, or ContentBlock::kSizeUnknown.
Definition RecordFormat.cpp:806
uint32_t getSampleCount() const
Get the number of audio sample frames in the content block.
Definition RecordFormat.h:457
void clear()
Clear/reset object to default values.
Definition RecordFormat.cpp:717
uint8_t getBytesPerSample() const
Get the number of bytes per audio sample.
Definition RecordFormat.h:443
uint8_t getSampleFrameStride() const
Number of bytes used by a group of synchronous audio samples, including padding.
Definition RecordFormat.cpp:924
uint32_t getSampleRate() const
Get the audio frame sample rate.
Definition RecordFormat.h:453
bool isIEEEFloat() const
Tell if the audio sample format is an IEEE float.
Definition RecordFormat.h:435
AudioFormat getAudioFormat() const
Get audio format.
Definition RecordFormat.h:421
AudioSampleFormat getSampleFormat() const
Get audio sample format.
Definition RecordFormat.h:425
size_t getBlockSize() const
Get the number of bytes for this content block, or ContentBlock::kSizeUnknown.
Definition RecordFormat.cpp:802
string getSampleFormatAsString() const
Get audio sample format as a string.
Definition RecordFormat.cpp:826
bool isCompatibleWith(const AudioContentBlockSpec &rhs) const
Tell if two audio block have identical audio formats.
Definition RecordFormat.cpp:820
static string getSampleFormatAsString(AudioSampleFormat sampleFormat)
Get an audio sample format as a string.
Definition RecordFormat.h:482
Specification of a VRS record content block.
Definition RecordFormat.h:508
size_t getBlockSize() const
Get the content block size, if available or calculable.
Definition RecordFormat.cpp:1069
ContentBlock(const ContentBlock &)=default
Default copy constructor.
string asString() const
Conversion to string, to store on disk & reconstruct later using constructor.
Definition RecordFormat.cpp:1038
const ImageContentBlockSpec & image() const
Get the image content spec. Requires the content block to be of type ContentType::IMAGE.
Definition RecordFormat.cpp:1111
ContentBlock(ContentType type=ContentType::EMPTY, size_t size=kSizeUnknown)
Very generic block description.
Definition RecordFormat.cpp:990
ContentType getContentType() const
Get the ContentType of the block.
Definition RecordFormat.h:591
string getCustomContentBlockFormat() const
Definition RecordFormat.h:597
const AudioContentBlockSpec & audio() const
Get the audio content spec. Requires the content block to be of type ContentType::AUDIO.
Definition RecordFormat.cpp:1116
RecordFormat operator+(const ContentBlock &) const
Assembly operator, to construct a RecordFormat for ContentBlock parts.
Definition RecordFormat.cpp:1107
ContentBlock(std::string codecName, uint8_t codecQuality, PixelFormat pixelFormat=PixelFormat::UNDEFINED, uint32_t width=0, uint32_t height=0, uint32_t stride=0, uint32_t stride2=0)
Image formats with custom codec encoding.
static const size_t kSizeUnknown
Special value used to represent an unknown block size.
Definition RecordFormat.h:511
Helper to identify a particular content block within a file.
Definition RecordFormat.h:640
RecordFormat string parsing helper class.
Definition RecordFormat.cpp:37
Definition RecordFormat.h:623
Specification of an image content block.
Definition RecordFormat.h:141
ImageContentBlockSpec & operator=(const ImageContentBlockSpec &)=default
Default copy assignment.
void set(ContentParser &parser)
When constructing from a string.
Definition RecordFormat.cpp:380
void clear()
Clear/reset object to default values.
Definition RecordFormat.cpp:337
uint32_t getDefaultStride2() const
Get default stride for planes N > 0, when stride2 isn't specified (minimum stride2 value)
Definition RecordFormat.cpp:584
uint8_t getCodecQuality() const
Definition RecordFormat.h:321
string getPixelFormatAsString() const
Get pixel format presented as a readable string, from which it can be reconstructed.
Definition RecordFormat.cpp:639
uint32_t getKeyFrameIndex() const
Definition RecordFormat.h:337
string asString() const
Definition RecordFormat.cpp:425
size_t getBytesPerPixel() const
Definition RecordFormat.h:309
uint32_t getHeight() const
Get image height, or 0 if unknown/unspecified.
Definition RecordFormat.h:267
string getImageFormatAsString() const
Get Image format as string.
Definition RecordFormat.cpp:643
uint32_t getPlaneHeight(uint32_t planeIndex) const
Definition RecordFormat.cpp:601
uint32_t getStride() const
Get image stride (number of bytes between rows) for the first plane.
Definition RecordFormat.cpp:647
PixelFormat getPixelFormat() const
Get Pixel format.
Definition RecordFormat.h:257
static string getPixelFormatAsString(PixelFormat pixelFormat)
Get pixel format presented as a readable string, from which it can be reconstructed.
Definition RecordFormat.h:347
const string & getCodecName() const
Definition RecordFormat.h:315
uint32_t getPlaneStride(uint32_t planeIndex) const
Definition RecordFormat.cpp:574
bool sanityCheckStrides() const
Definition RecordFormat.cpp:561
size_t getRawImageSize() const
Definition RecordFormat.cpp:625
uint32_t getRawStride() const
Definition RecordFormat.h:274
size_t getBlockSize() const
Definition RecordFormat.cpp:621
ImageContentBlockSpec core() const
Return base of format (no codec quality nor key frame info)
Definition RecordFormat.cpp:348
double getKeyFrameTimestamp() const
Get timestamp of the key frame of the group of frames this video frame belongs to.
Definition RecordFormat.h:331
uint32_t getDefaultStride() const
Get default stride for plane 0 when stride isn't specified (minimum stride value)
Definition RecordFormat.cpp:652
static bool isQualityValid(uint8_t quality)
Validate that a quality value is valid.
Definition RecordFormat.h:326
uint8_t getChannelCountPerPixel() const
Definition RecordFormat.h:302
ImageFormat getImageFormat() const
Get image format.
Definition RecordFormat.h:249
uint32_t getPlaneCount() const
Get the number of planes for this pixel format.
Definition RecordFormat.h:286
uint32_t getWidth() const
Get image width, or 0 if unknown/unspecified.
Definition RecordFormat.h:263
Type
Definition Record.h:88
Definition Compressor.cpp:113
map< pair< Record::Type, uint32_t >, RecordFormat > RecordFormatMap
Map a pair of record type/format version to a record format, for a particular stream.
Definition RecordFormat.h:630
PixelFormat
Pixel format type, then the image format is ImageFormat::RAW.
Definition RecordFormat.h:63
@ GREY12
uses 16 bit little-endian values. 4 most significant bits are unused and set to 0.
@ UNDEFINED
Unknown/unrecognized.
@ GREY10
uses 16 bit little-endian values. 6 most significant bits are unused and set to 0.
@ RGB8
3 uint8_t values, red + green + blue.
@ DEPTH32F
1 32 bit float value, representing a depth.
@ YUV_420_NV21
Y plane + half width/half height chroma plane with weaved V and U values.
@ RAW10
https://developer.android.com/reference/android/graphics/ImageFormat#RAW10
@ RAW10_BAYER_RGGB
10 bit per pixel, RGGB bayer pattern.
@ YUV_I420_PLANAR
same as YUV_I420_SPLIT, but more conventional name.
@ YUV_I420_SPLIT
3 uint8_t values, 4:2:0. The 3 planes are stored separately.
@ RGBA32F
1 32 bit float value.
@ BAYER8_RGGB
8 bit per pixel, RGGB bayer pattern.
@ RAW10_BAYER_BGGR
10 bit per pixel, BGGR bayer pattern.
@ RGB10
uses 16 bit little-endian values. 6 most significant bits are unused and set to 0.
@ RGBA8
4 uint8_t values, red + blue + green + alpha.
@ YUY2
4 uint8_t values, 4:2:2, single plane.
@ YUV_420_NV12
Y plane + half width/half height chroma plane with weaved U and V values.
@ RGB12
uses 16 bit little-endian values. 4 most significant bits are unused and set to 0.
@ RGB32F
1 32 bit float value.
@ GREY10PACKED
10 bit per pixel, packed in successive little-endian bits, in 40 bits blocks.
@ SCALAR64F
1 64 bit float value, representing high precision image data.
@ BGR8
3 uint8_t values, blue + green + red.
@ GREY16
uses 16 bit little-endian values.
AudioSampleFormat
Audio sample format, when the audio type is AudioFormat::PCM.
Definition RecordFormat.h:109
@ U32_LE
LPCM, unsigned, 32 bit little endian.
@ F64_BE
LPCM, 64 bit float big endian.
@ U16_BE
LPCM, unsigned, 16 bit big endian.
@ U32_BE
LPCM, unsigned, 32 bit big endian.
@ F64_LE
LPCM, 64 bit float little endian.
@ S32_BE
LPCM, signed, 32 bit big endian.
@ U8
LPCM, unsigned, 8 bit.
@ S16_BE
LPCM, signed, 16 bit big endian.
@ F32_LE
LPCM, 32 bit float little endian.
@ S24_LE
LPCM, signed, 24 bit little endian.
@ S16_LE
LPCM, signed, 16 bit little endian.
@ U24_BE
LPCM, unsigned, 24 bit big endian.
@ S24_BE
LPCM, signed, 24 bit big endian.
@ MU_LAW
mu-law PCM, 8 bit.
@ U24_LE
LPCM, unsigned, 24 bit little endian.
@ U16_LE
LPCM, unsigned, 16 bit little endian.
@ F32_BE
LPCM, 32 bit float big endian.
@ S32_LE
LPCM, signed, 32 bit little endian.
ImageFormat
Definition RecordFormat.h:49
@ UNDEFINED
Unknown/unspecified.
@ CUSTOM_CODEC
Images encoded with a custom or experimental codec.
@ VIDEO
Video codec encoded images.
AudioFormat
Audio format type.
Definition RecordFormat.h:98
@ OPUS
Audio data compressed using Opus. https://opus-codec.org/.
RecordableTypeId
VRS stream type or class identifier enum.
Definition StreamId.h:49
ContentType
Type of a record's block.
Definition RecordFormat.h:35
@ DATA_LAYOUT
DataLayout block.
@ CUSTOM
Custom format, or unknown/unspecified data format.
@ EMPTY
No data (internal).