capabilities.h

Go to the documentation of this file.

#ifndef MILLICAST_API_CAPABILITIES_H
#define MILLICAST_API_CAPABILITIES_H

 
#ifdef __cplusplus
 
#include <string>
 
#include "exports.h"
 
namespace millicast {

 
enum class VideoType {
  UNKNOWN,
  I420,
  I444,
  I210,
  IYUV,
  RGB24,
  ARGB,
  RGB565,
  YUY2,
  YV12,
  NV12,
  UYVY,
  MJPEG,
  BGRA,
  NATIVE
};

 
enum class PrimaryID : uint8_t {
  // The indices are equal to the values specified in T-REC H.273 Table 2.
  BT709 = 1,
  UNSPECIFIED = 2,
  BT470M = 4,
  BT470BG = 5,
  SMPTE170M = 6,  // Identical to BT601
  SMPTE240M = 7,
  FILM = 8,
  BT2020 = 9,
  SMPTEST428 = 10,
  SMPTEST431 = 11,
  SMPTEST432 = 12,
  JEDECP22 = 22,  // Identical to EBU3213-E
                  // When adding/removing entries here, please make sure to do
                  // the corresponding change to kPrimaryIds.
};

 
enum class TransferID : uint8_t {
  // The indices are equal to the values specified in T-REC H.273 Table 3.
  BT709 = 1,
  UNSPECIFIED = 2,
  GAMMA22 = 4,
  GAMMA28 = 5,
  SMPTE170M = 6,
  SMPTE240M = 7,
  LINEAR = 8,
  LOG = 9,
  LOG_SQRT = 10,
  IEC61966_2_4 = 11,
  BT1361_ECG = 12,
  IEC61966_2_1 = 13,
  BT2020_10 = 14,
  BT2020_12 = 15,
  SMPTEST2084 = 16,
  SMPTEST428 = 17,
  ARIB_STD_B67 = 18,
  // When adding/removing entries here, please make sure to do the
  // corresponding change to kTransferIds.
};

 
enum class MatrixID : uint8_t {
  // The indices are equal to the values specified in T-REC H.273 Table 4.
  RGB = 0,
  BT709 = 1,
  UNSPECIFIED = 2,
  FCC = 4,
  BT470BG = 5,
  SMPTE170M = 6,
  SMPTE240M = 7,
  YCOCG = 8,
  BT2020_NCL = 9,
  BT2020_CL = 10,
  SMPTE2085 = 11,
  CDNCLS = 12,
  CDCLS = 13,
  BT2100_ICTCP = 14,
  // When adding/removing entries here, please make sure to do the
  // corresponding change to kMatrixIds.
};

 
enum class RangeID {
  // The indices are equal to the values specified at
  // https://www.webmproject.org/docs/container/#colour for the element Range.
  INVALID = 0,
  // Limited Rec. 709 color range with RGB values ranging from 16 to 235.
  LIMITED = 1,
  // Full RGB color range with RGB valees from 0 to 255.
  FULL = 2,
  // Range is defined by MatrixCoefficients/TransferCharacteristics.
  DERIVED = 3,
  // When adding/removing entries here, please make sure to do the
  // corresponding change to kRangeIds.
};

 
MILLICAST_API std::string video_type_to_str(VideoType t);

 
class VideoCapabilities {
 public:
  int width{};  
  int height{}; 
  int fps{};    
  VideoType format{
      VideoType::UNKNOWN}; 
  PrimaryID primary{
      PrimaryID::UNSPECIFIED}; 
  TransferID transfer{TransferID::UNSPECIFIED}; 
  MatrixID matrix{MatrixID::UNSPECIFIED};       
  RangeID range{
      RangeID::INVALID}; 

  std::string video_standard;
 
  [[nodiscard]] MILLICAST_API std::string format_as_str()
      const; 
};
 
}  // namespace millicast
 
#endif /* MILLICAST_API_CAPABILITIES_H */
#endif // __cplusplus