cdi_baseline_profile_api.h

Go to the documentation of this file.

// -------------------------------------------------------------------------------------------
// Copyright Amazon.com Inc. or its affiliates. All Rights Reserved.
// This file is part of the AWS CDI-SDK, licensed under the BSD 2-Clause "Simplified" License.
// License details at: https://github.com/aws/aws-cdi-sdk/blob/mainline/LICENSE
// -------------------------------------------------------------------------------------------
 
#ifndef CDI_BASELINE_PROFILE_API_H__
#define CDI_BASELINE_PROFILE_API_H__
 
#include <stdbool.h>
 
#include "cdi_avm_api.h"
 
//*********************************************************************************************************************
//***************************************** START OF DEFINITIONS AND TYPES ********************************************
//*********************************************************************************************************************
 
typedef struct {
    int major; 
    int minor; 
} CdiAvmBaselineProfileVersion;
 
typedef enum {
    kCdiAvmNotBaseline, 
    kCdiAvmVideo,       
    kCdiAvmAudio,       
    kCdiAvmAncillary,   
} CdiBaselineAvmPayloadType;
 
#define CDI_BASELINE_AVM_PAYLOAD_TYPE_ENUM_COUNT    (kCdiAvmAncillary)
 
typedef struct {
    CdiBaselineAvmPayloadType payload_type; 
    CdiAvmBaselineProfileVersion version;  
} CdiAvmBaselineConfigCommon;
 
typedef enum {
    kKeyAvmPayloadType,                 
 
    kKeyAvmVideoSamplingType,           
    kKeyAvmVideoAlphaChannelType,       
    kKeyAvmVideoBitDepthType,           
    kKeyAvmVideoColorimetryType,        
    kKeyAvmVideoTcsType,                
    kKeyAvmVideoRangeType,              
 
    // Keys used by audio profiles. See EnumStringKeyTypeToPayloadType().
    kKeyAvmAudioChannelGroupingType,    
    kKeyAvmAudioSampleRateType,         
} CdiAvmBaselineEnumStringKeyTypes;
 
typedef struct CdiAvmBaselineConfig CdiAvmBaselineConfig;
 
typedef bool (*CdiMakeBaselineConfigurationPtr)(const CdiAvmBaselineConfigCommon* baseline_config_ptr,
                                                CdiAvmConfig* config_ptr, int* payload_unit_size_ptr);
typedef bool (*CdiParseBaselineConfigurationPtr)(const CdiAvmConfig* config_ptr,
                                                 CdiAvmBaselineConfigCommon* baseline_config_ptr);
 
typedef CdiReturnStatus (*CdiAvmGetBaselineUnitSizePtr)(const CdiAvmBaselineConfigCommon* baseline_config_ptr,
                                                        int* payload_unit_size_ptr);
 
typedef const CdiEnumStringKey* (*CdiAvmKeyGetArrayPtr)(CdiAvmBaselineEnumStringKeyTypes key_type);
 
typedef struct {
    CdiMakeBaselineConfigurationPtr make_config_ptr; 
    CdiParseBaselineConfigurationPtr parse_config_ptr; 
    CdiAvmGetBaselineUnitSizePtr get_unit_size_ptr; 
    CdiAvmKeyGetArrayPtr key_get_array_ptr; 
    int structure_size; 
} CdiAvmVTableApi;
 
//*********************************************************************************************************************
//******************************************* START OF PUBLIC FUNCTIONS ***********************************************
//*********************************************************************************************************************
 
CDI_INTERFACE CdiReturnStatus CdiAvmRegisterBaselineProfile(CdiBaselineAvmPayloadType media_type,
                                                            const char* profile_version_str,
                                                            CdiAvmVTableApi* vtable_api_ptr);
 
CDI_INTERFACE CdiReturnStatus CdiAvmMakeBaselineConfiguration(const CdiAvmBaselineConfig* baseline_config_ptr,
                                                              CdiAvmConfig* config_ptr, int* payload_unit_size_ptr);
 
CDI_INTERFACE CdiReturnStatus CdiAvmMakeBaselineConfiguration2(const CdiAvmBaselineConfigCommon* baseline_config_ptr,
                                                               CdiAvmConfig* config_ptr, int* payload_unit_size_ptr);
 
CDI_INTERFACE CdiReturnStatus CdiAvmParseBaselineConfiguration(const CdiAvmConfig* config_ptr,
                                                               CdiAvmBaselineConfig* baseline_config_ptr);
 
CDI_INTERFACE CdiReturnStatus CdiAvmParseBaselineConfiguration2(const CdiAvmConfig* config_ptr,
                                                                CdiAvmBaselineConfigCommon* baseline_config_ptr);
 
CDI_INTERFACE CdiReturnStatus CdiAvmGetBaselineUnitSize(const CdiAvmBaselineConfig* baseline_config_ptr,
                                                        int* payload_unit_size_ptr);
 
CDI_INTERFACE CdiReturnStatus CdiAvmGetBaselineUnitSize2(const CdiAvmBaselineConfigCommon* baseline_config_ptr,
                                                         int* payload_unit_size_ptr);
 
CDI_INTERFACE const char* CdiAvmKeyEnumToString(CdiAvmBaselineEnumStringKeyTypes key_type, int enum_value,
                                                const CdiAvmBaselineProfileVersion* version_ptr);
 
CDI_INTERFACE int CdiAvmKeyStringToEnum(CdiAvmBaselineEnumStringKeyTypes key_type, const char* name_str,
                                        const CdiAvmBaselineProfileVersion* version_ptr);
 
CDI_INTERFACE const CdiEnumStringKey* CdiAvmKeyGetArray(CdiAvmBaselineEnumStringKeyTypes key_type,
                                                        const CdiAvmBaselineProfileVersion* version_ptr);
 
CDI_INTERFACE bool CdiAvmParseBaselineVersionString(const char* version_str,
                                                    CdiAvmBaselineProfileVersion* ret_version_ptr);
 
CDI_INTERFACE CdiReturnStatus CdiAvmValidateBaselineVersionString(CdiBaselineAvmPayloadType media_type,
    const char* version_str, CdiAvmBaselineProfileVersion* ret_version_ptr);
 
 
#endif // CDI_BASELINE_PROFILE_API_H__