DataLayoutConventions.h

/*
 * Copyright (c) Meta Platforms, Inc. and affiliates.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 
#pragma once
 
#include <vrs/DataLayout.h>
#include <vrs/DataPieces.h>
#include <vrs/ForwardDefinitions.h>
#include <vrs/RecordFormat.h>
#include <vrs/VrsExport.h>
 
namespace vrs {
 
namespace datalayout_conventions {
 
constexpr const char* kImageWidth = "image_width";
constexpr const char* kImageHeight = "image_height";
constexpr const char* kImageStride = "image_stride";
constexpr const char* kImageStride2 = "image_stride_2";
constexpr const char* kImagePixelFormat = "image_pixel_format";
constexpr const char* kImageBytesPerPixel = "image_bytes_per_pixel";
 
constexpr const char* kImageCodecName = "image_codec_name";
constexpr const char* kImageCodecQuality = "image_codec_quality";
 
using ImageSpecType = uint32_t;
 
class VRS_API ImageSpec : public AutoDataLayout {
 public:
  DataPieceValue<ImageSpecType> width{kImageWidth};
  DataPieceValue<ImageSpecType> height{kImageHeight};
  DataPieceValue<ImageSpecType> stride{kImageStride};
  DataPieceValue<ImageSpecType> stride2{kImageStride2};
  DataPieceEnum<PixelFormat, ImageSpecType> pixelFormat{kImagePixelFormat};
 
  // For custom codec & video images
  DataPieceString codecName{kImageCodecName};
  DataPieceValue<ImageSpecType> codecQuality{kImageCodecQuality};
 
  // Deprecated fields
  DataPieceValue<ImageSpecType> bytesPerPixels{kImageBytesPerPixel};
  // for legacy data compatibility
  DataPieceValue<uint8_t> bytesPerPixels8{kImageBytesPerPixel};
 
  AutoDataLayoutEnd end;
 
  ContentBlock getImageContentBlock(
      const ImageContentBlockSpec& base,
      size_t blockSize = ContentBlock::kSizeUnknown);
};
 
constexpr const char* kImageKeyFrameTimeStamp = "image_key_frame_timestamp";
constexpr const char* kImageKeyFrameIndex = "image_key_frame_index";
 
class VRS_API VideoFrameSpec : public AutoDataLayout {
 public:
  DataPieceValue<double> keyFrameTimestamp{kImageKeyFrameTimeStamp};
  DataPieceValue<ImageSpecType> keyFrameIndex{kImageKeyFrameIndex};
 
  bool hasVideoSpec() const {
    return isMapped() && keyFrameTimestamp.isAvailable() && keyFrameIndex.isAvailable();
  }
 
  AutoDataLayoutEnd end;
};
 
constexpr const char* kAudioFormat = "audio_format";
constexpr const char* kAudioSampleFormat = "audio_sample_format";
constexpr const char* kAudioSampleFrameStride = "audio_sample_stride";
constexpr const char* kAudioChannelCount = "audio_channel_count";
constexpr const char* kAudioSampleRate = "audio_sample_rate";
constexpr const char* kAudioSampleCount = "audio_sample_count";
constexpr const char* kAudioStereoPairCount = "audio_stereo_pair_count";
 
class VRS_API AudioSpec : public AutoDataLayout {
 public:
  DataPieceEnum<AudioFormat, uint8_t> audioFormat{kAudioFormat}; 
  DataPieceEnum<AudioSampleFormat, uint8_t> sampleType{kAudioSampleFormat};
  DataPieceValue<uint8_t> sampleStride{kAudioSampleFrameStride};
  DataPieceValue<uint8_t> channelCount{kAudioChannelCount};
  DataPieceValue<uint32_t> sampleRate{kAudioSampleRate};
  DataPieceValue<uint32_t> sampleCount{kAudioSampleCount};
  DataPieceValue<uint8_t> stereoPairCount{kAudioStereoPairCount};
 
  AutoDataLayoutEnd end;
};
 
constexpr const char* kNextContentBlockSize = "next_content_block_size";
using ContentBlockSizeType = uint32_t;
 
class VRS_API NextContentBlockSpec : public AutoDataLayout {
 public:
  DataPieceValue<ContentBlockSizeType> nextContentBlockSize{kNextContentBlockSize};
  DataPieceValue<uint32_t> nextAudioContentBlockSampleCount{kAudioSampleCount};
 
  AutoDataLayoutEnd end;
};
 
} // namespace datalayout_conventions
 
// Previous name to help transition.
namespace DataLayoutConventions {
using namespace datalayout_conventions;
}
 
} // namespace vrs