VRS
A file format for sensor data.
Loading...
Searching...
No Matches
ForwardDefinitions.h
1/*
2 * Copyright (c) Meta Platforms, Inc. and affiliates.
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17#pragma once
18
19#include <cstdint>
20
21// Small set of forward declarations to reduce header inclusions
22
23namespace vrs {
24
25class StreamId;
26enum class RecordableTypeId : uint16_t;
27
28class RecordFileWriter;
29class RecordFileReader;
30class MultiRecordFileReader;
31class Recordable;
32struct StreamTags;
33class DataReference;
34enum class CompressionType : uint8_t;
35enum class CompressionPreset;
36enum class ThreadRole;
37namespace IndexRecord {
38struct RecordInfo;
39} // namespace IndexRecord
40
41class RecordFormat;
42class DataLayout;
43class ContentBlock;
44struct CurrentRecord;
45enum class ContentType : uint8_t;
46enum class ImageFormat : uint8_t;
47enum class PixelFormat : uint8_t;
48enum class AudioFormat : uint8_t;
49enum class AudioSampleFormat : uint8_t;
50
51struct FileSpec;
52class FileDelegator;
53class FileHandler;
55
56class DiskFileChunk;
57template <class FileChunk>
58class DiskFileT;
60
61} // namespace vrs
Specification of a VRS record content block.
Definition RecordFormat.h:474
The DataLayout class describes the data stored inside a DataLayoutContentBlock.
Definition DataLayout.h:191
Definition DiskFileChunk.hpp:29
FileHandler implementation for disk files, with chunked file support.
Definition DiskFile.h:34
Class to abstract the delegate file open operation for VRS file.
Definition FileDelegator.h:32
Class to abstract VRS file system operations, to enable support for alternate storage methods,...
Definition FileHandler.h:71
Description of the format of a VRS record as a succession of typed blocks of content.
Definition RecordFormat.h:644
The WriteFileHandler interface adds write operations to the FileHandler interface.
Definition WriteFileHandler.h:45
Definition AsyncDiskFileChunk.hpp:49
PixelFormat
Pixel format type, then the image format is ImageFormat::RAW.
Definition RecordFormat.h:60
CompressionPreset
VRS Compression setting.
Definition Compressor.h:38
AudioSampleFormat
Audio sample format, when the audio type is AudioFormat::PCM.
Definition RecordFormat.h:105
ImageFormat
Image format type.
Definition RecordFormat.h:47
CompressionType
Type of compression. Used in VRS record headers, so never modify the values.
Definition Record.h:35
ThreadRole
Thread types that are created with the RecordFileWriter interface.
Definition RecordFileWriter.h:59
AudioFormat
Audio format type.
Definition RecordFormat.h:94
RecordableTypeId
VRS stream type or class identifier enum.
Definition StreamId.h:49
ContentType
Type of a record's block.
Definition RecordFormat.h:35
Class describing which record is being read. Most fields are really self explanatory.
Definition StreamPlayer.h:27
Generalized file descriptor class, allowing the efficient representation of complex file objects,...
Definition FileSpec.h:37
Helper class to hold the details about a single VRS record in memory.
Definition IndexRecord.h:105