baseline_profiles_1_00.c File Reference

This file contains the functions and other definitions that comprise the CDI AVM baseline profile. More...

#include <assert.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include "cdi_baseline_profile_01_00_api.h"
#include "cdi_logger_api.h"
#include "utilities_api.h"

Functions
static const CdiEnumStringKey *	KeyGetArray (CdiAvmBaselineEnumStringKeyTypes key_type)
	Update EnumStringKeyTypes in cdi_utility_api.h whenever an entry is added to this function's switch statement.
static bool	GetVideoUnitSize (const CdiAvmBaselineConfig *baseline_config_ptr, int *payload_unit_size_ptr)
static bool	CreateOptionalParamsString (const CdiAvmVideoConfig *video_config_ptr, char *optional_params_str, const size_t array_size)
static bool	MakeBaselineVideoConfiguration (const CdiAvmBaselineConfigCommon *baseline_ptr, CdiAvmConfig *config_ptr, int *payload_unit_size_ptr)
static bool	GetAudioUnitSize (const CdiAvmBaselineConfig *baseline_config_ptr, int *payload_unit_size_ptr)
static bool	MakeBaselineAudioConfiguration (const CdiAvmBaselineConfigCommon *baseline_ptr, CdiAvmConfig *config_ptr, int *payload_unit_size_ptr)
static bool	GetAncillaryDataUnitSize (const CdiAvmBaselineConfig *baseline_config_ptr, int *payload_unit_size_ptr)
static bool	MakeBaselineAncillaryDataConfiguration (const CdiAvmBaselineConfigCommon *baseline_ptr, CdiAvmConfig *config_ptr, int *payload_unit_size_ptr)
static bool	ParseBaselineVideoConfiguration (const CdiAvmConfig *config_ptr, CdiAvmBaselineConfigCommon *baseline_ptr)
static bool	ParseBaselineAudioConfiguration (const CdiAvmConfig *config_ptr, CdiAvmBaselineConfigCommon *baseline_ptr)
static bool	ParseBaselineAncillaryDataConfiguration (const CdiAvmConfig *config_ptr, CdiAvmBaselineConfigCommon *baseline_ptr)
static CdiReturnStatus	GetBaselineUnitSize (const CdiAvmBaselineConfigCommon *baseline_ptr, int *payload_unit_size_ptr)
	See CdiAvmGetBaselineUnitSize().
CdiReturnStatus	RegisterAvmBaselineProfiles_1_00 (void)
	Register baseline profile 01.00.

Variables
static const char *	profile_version_video_str = "01.00"
static const char *	profile_version_audio_str = "01.00"
static const char *	profile_version_ancillary_data_str = "01.00"
static const CdiEnumStringKey	video_sampling_key_array []
	Enum/string keys for CdiAvmVideoSampling.
static const CdiEnumStringKey	alpha_channel_key_array []
	Enum/string keys for CdiAvmVideoAlphaChannel.
static const CdiEnumStringKey	tcs_key_array []
	Enum/string keys for CdiAvmVideoTcs.
static const CdiEnumStringKey	range_key_array []
	Enum/string keys for CdiAvmVideoRange.
static const CdiEnumStringKey	video_bit_depth_key_array []
	Enum/string keys for CdiAvmVideoBitDepth.
static const CdiEnumStringKey	colorimetry_key_array []
	Enum/string keys for CdiAvmColorimetry.
static const CdiEnumStringKey	audio_channel_grouping_key_array []
	Enum/string keys for CdiAvmAudioChannelGrouping.
static const CdiEnumStringKey	audio_sample_rate_key_array []
	Enum/string keys for CdiAvmAudioSampleRate.

Detailed Description

This file contains the functions and other definitions that comprise the CDI AVM baseline profile.

Function Documentation

CreateOptionalParamsString()

static bool CreateOptionalParamsString ( const CdiAvmVideoConfig * video_config_ptr, char * optional_params_str, const size_t array_size )

static

Populates the optional_params_str with optional video configuration information.

Parameters

video_config_ptr	Pointer to the video configuration.
optional_params_str	Pointer to the optional params string.
array_size	The size of the optional params string.

Returns

true if the conversion was successful, false if it failed.

GetAncillaryDataUnitSize()

static bool GetAncillaryDataUnitSize ( const CdiAvmBaselineConfig * baseline_config_ptr, int * payload_unit_size_ptr )

static

Returns the number of bits that comprise the smallest number of bits that should be kept together for transmitting ancillary data.

Parameters

baseline_config_ptr	Pointer to the config structure with the specifics of the ancillary data format whose unit size is to be returned.
payload_unit_size_ptr	Pointer to where the unit size is to be written.

Returns

false if the configuration is not valid enough to determine the unit size, true otherwise.

GetAudioUnitSize()

static bool GetAudioUnitSize ( const CdiAvmBaselineConfig * baseline_config_ptr, int * payload_unit_size_ptr )

static

Returns the number of bits that evenly fit audio samples into bytes. It includes the samples for all of the channels in the stream.

Parameters

baseline_config_ptr	Pointer to the config structure with the specifics of the audio format whose unit size is to be returned.
payload_unit_size_ptr	Pointer to where the unit size is to be written.

Returns

false if the configuration is not valid enough to determine the unit size, true otherwise.

GetVideoUnitSize()

static bool GetVideoUnitSize ( const CdiAvmBaselineConfig * baseline_config_ptr, int * payload_unit_size_ptr )

static

Returns the number of bits that evenly fit video pixels into bytes. This is explained in ST 2110-20 and these values are in the tables, though they're expressed in units of bytes.

Parameters

baseline_config_ptr	Pointer to the config structure with the specifics of the video format whose unit size is to be returned.
payload_unit_size_ptr	Pointer to where the unit size is to be written.

Returns

false if the configuration is not valid enough to determine the unit size, true otherwise.

MakeBaselineAncillaryDataConfiguration()

static bool MakeBaselineAncillaryDataConfiguration ( const CdiAvmBaselineConfigCommon * baseline_ptr, CdiAvmConfig * config_ptr, int * payload_unit_size_ptr )

static

Populates the provided generic configuration structure with the information from an ancillary data baseline configuration structure.

Parameters

baseline_ptr	Pointer to the source configuration; its payload_type must be kCdiAvmAncillary.
config_ptr	Address of where the generic configuration is to be written.
payload_unit_size_ptr	Pointer to where the payload unit size is to be written.

Returns

true if the conversion was successful, false if it failed.

MakeBaselineAudioConfiguration()

static bool MakeBaselineAudioConfiguration ( const CdiAvmBaselineConfigCommon * baseline_ptr, CdiAvmConfig * config_ptr, int * payload_unit_size_ptr )

static

Populates the provided generic configuration structure with the information from an audio baseline configuration structure.

Parameters

baseline_ptr	Pointer to the source configuration; its payload_type must be kCdiAvmAudio.
config_ptr	Address of where the generic configuration is to be written.
payload_unit_size_ptr	Pointer to where the payload unit size is to be written.

Returns

true if the conversion was successful, false if it failed.

MakeBaselineVideoConfiguration()

static bool MakeBaselineVideoConfiguration ( const CdiAvmBaselineConfigCommon * baseline_ptr, CdiAvmConfig * config_ptr, int * payload_unit_size_ptr )

static

Populates the provided generic configuration structure with the information from a video baseline configuration structure.

Parameters

baseline_ptr	Pointer to the source configuration; its payload_type must be kCdiAvmVideo.
config_ptr	Address of where the generic configuration is to be written.
payload_unit_size_ptr	Pointer to where the payload unit size is to be written.

Returns

true if the conversion was successful, false if it failed.

ParseBaselineAncillaryDataConfiguration()

static bool ParseBaselineAncillaryDataConfiguration ( const CdiAvmConfig * config_ptr, CdiAvmBaselineConfigCommon * baseline_ptr )

static

Attempts to interpret a generic AVM configuration structure and convert it into a baseline configuration structure for ancillary data. Unknown parameters do not result in failure but do cause warnings to be logged in order to handle forward compatiblity as gracefully as possible.

Parameters

config_ptr	Pointer to the source generic configuration structure.
baseline_ptr	Address where the resulting video baseline configuration data will be written.

Returns

true if the conversion was successful, false if a failure was encountered.

ParseBaselineAudioConfiguration()

static bool ParseBaselineAudioConfiguration ( const CdiAvmConfig * config_ptr, CdiAvmBaselineConfigCommon * baseline_ptr )

static

Attempts to interpret a generic AVM configuration structure and convert it into a baseline configuration structure for audio. Unknown parameters do not result in failure but do cause warnings to be logged in order to handle forward compatiblity as gracefully as possible.

Parameters

config_ptr	Pointer to the source generic configuration structure.
baseline_ptr	Address where the resulting video baseline configuration data will be written.

Returns

true if the conversion was successful, false if a failure was encountered.

ParseBaselineVideoConfiguration()

static bool ParseBaselineVideoConfiguration ( const CdiAvmConfig * config_ptr, CdiAvmBaselineConfigCommon * baseline_ptr )

static

Attempts to interpret a generic AVM configuration structure and convert it into a baseline configuration structure for video. Unknown parameters do not result in failure but do cause warnings to be logged in order to handle forward compatiblity as gracefully as possible.

Parameters

config_ptr	Pointer to the source generic configuration structure.
baseline_ptr	Address where the resulting video baseline configuration data will be written.

Returns

true if the conversion was successful, false if a failure was encountered.

RegisterAvmBaselineProfiles_1_00()

CdiReturnStatus RegisterAvmBaselineProfiles_1_00

(

void

)

Register baseline profile 01.00.

Returns

kCdiStatusOk if ok. kCdiStatusArraySizeExceeded if array size has been exceeded, otherwise kCdiStatusFatal.

Variable Documentation

alpha_channel_key_array

const CdiEnumStringKey alpha_channel_key_array[]

static

Initial value:

= {
    { kCdiAvmAlphaUnused, "Unused" },
    { kCdiAvmAlphaUsed,   "Used" },
    { CDI_INVALID_ENUM_VALUE, NULL } 
}

Enum/string keys for CdiAvmVideoAlphaChannel.

audio_channel_grouping_key_array

const CdiEnumStringKey audio_channel_grouping_key_array[]

static

Initial value:

= {
    { kCdiAvmAudioM,    "M" },
    { kCdiAvmAudioDM,   "DM" },
    { kCdiAvmAudioST,   "ST" },
    { kCdiAvmAudioLtRt, "LtRt" },
    { kCdiAvmAudio51,   "51" },
    { kCdiAvmAudio71,   "71" },
    { kCdiAvmAudio222,  "222" },
    { kCdiAvmAudioSGRP, "SGRP" },
    { CDI_INVALID_ENUM_VALUE, NULL } 
}

Enum/string keys for CdiAvmAudioChannelGrouping.

audio_sample_rate_key_array

const CdiEnumStringKey audio_sample_rate_key_array[]

static

Initial value:

= {
    { kCdiAvmAudioSampleRate48kHz, "48kHz" },
    { kCdiAvmAudioSampleRate96kHz, "96kHz" },
    { CDI_INVALID_ENUM_VALUE, NULL } 
}

Enum/string keys for CdiAvmAudioSampleRate.

colorimetry_key_array

const CdiEnumStringKey colorimetry_key_array[]

static

Initial value:

= {
    { kCdiAvmVidColorimetryBT601,    "BT601" },
    { kCdiAvmVidColorimetryBT709,    "BT709" },
    { kCdiAvmVidColorimetryBT2020,   "BT2020" },
    { kCdiAvmVidColorimetryBT2100,   "BT2100" },
    { kCdiAvmVidColorimetryST2065_1, "ST2065-1" },
    { kCdiAvmVidColorimetryST2065_3, "ST2065-3" },
    { kCdiAvmVidColorimetryXYZ,      "XYZ" },
    { CDI_INVALID_ENUM_VALUE, NULL } 
}

Enum/string keys for CdiAvmColorimetry.

profile_version_ancillary_data_str

const char* profile_version_ancillary_data_str = "01.00"

static

The current version of the baseline ancillary data profile. This value is always sent with AVM configuration structures for ancillary data.

profile_version_audio_str

const char* profile_version_audio_str = "01.00"

static

The current version of the baseline audio profile. This value is always sent with AVM configuration structures for audio.

profile_version_video_str

const char* profile_version_video_str = "01.00"

static

The current version of the baseline video profile. This value is always sent with AVM configuration structures for video.

range_key_array

const CdiEnumStringKey range_key_array[]

static

Initial value:

= {
    { kCdiAvmVidRangeNarrow,      "Narrow" },
    { kCdiAvmVidRangeFullProtect, "FullProtect" },
    { kCdiAvmVidRangeFull,        "Full" },
    { CDI_INVALID_ENUM_VALUE, NULL } 
}

Enum/string keys for CdiAvmVideoRange.

tcs_key_array

const CdiEnumStringKey tcs_key_array[]

static

Initial value:

= {
    { kCdiAvmVidTcsSDR,          "SDR" },
    { kCdiAvmVidTcsPQ,           "PQ" },
    { kCdiAvmVidTcsHLG,          "HLG" },
    { kCdiAvmVidTcsLinear,       "Linear" },
    { kCdiAvmVidTcsBT2100LINPQ,  "BT2100LINPQ" },
    { kCdiAvmVidTcsBT2100LINHLG, "BT2100LINHLG" },
    { kCdiAvmVidTcsST2065_1,     "ST2065-1" },
    { kCdiAvmVidTcsST428_1,      "ST428-1" },
    { kCdiAvmVidTcsDensity,      "Density" },
    { CDI_INVALID_ENUM_VALUE, NULL } 
}

Enum/string keys for CdiAvmVideoTcs.

video_bit_depth_key_array

const CdiEnumStringKey video_bit_depth_key_array[]

static

Initial value:

= {
    { kCdiAvmVidBitDepth8,  "8bit" },
    { kCdiAvmVidBitDepth10, "10bit" },
    { kCdiAvmVidBitDepth12, "12bit" },
    { CDI_INVALID_ENUM_VALUE, NULL } 
}

Enum/string keys for CdiAvmVideoBitDepth.

video_sampling_key_array

const CdiEnumStringKey video_sampling_key_array[]

static

Initial value:

= {
    { kCdiAvmVidYCbCr444, "YCbCr444" },
    { kCdiAvmVidYCbCr422, "YCbCr422" },
    { kCdiAvmVidRGB,      "RGB" },
    { CDI_INVALID_ENUM_VALUE, NULL } 
}

Enum/string keys for CdiAvmVideoSampling.