cdi_utility_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_UTILITY_API_H__
#define CDI_UTILITY_API_H__
 
#include <stdbool.h>
#include <stdint.h>
 
//*********************************************************************************************************************
//***************************************** START OF DEFINITIONS AND TYPES ********************************************
//*********************************************************************************************************************
 
#if defined(_WIN32) && defined(__cplusplus)
#define CDI_INTERFACE extern "C" __declspec (dllexport)
#elif defined(_WIN32)
#define CDI_INTERFACE __declspec (dllexport)
#elif defined(__cplusplus)
#define CDI_INTERFACE extern "C"
#else
#define CDI_INTERFACE
#endif
 
#define CDI_INVALID_ENUM_VALUE  (-1)
 
typedef struct CdiPtpTimestamp CdiPtpTimestamp;
 
typedef struct {
    int enum_value;       
    const char* name_str; 
} CdiEnumStringKey;
 
typedef enum {
    kKeyAdapterType,                    
    kKeyBufferType,                     
    kKeyConnectionProtocolType,         
    kKeyLogMethod,                      
    kKeyLogComponent,                   
    kKeyLogLevel,                       
    kKeyConnectionStatus,               
    kKeyTestUnit,                       
} CdiEnumStringKeyType;
 
typedef enum {
    kProtocolTypeRaw, 
    kProtocolTypeAvm, 
} CdiConnectionProtocolType;
 
//*********************************************************************************************************************
//******************************************* START OF PUBLIC FUNCTIONS ***********************************************
//*********************************************************************************************************************
 
CDI_INTERFACE const CdiEnumStringKey* CdiUtilityKeyGetArray(CdiEnumStringKeyType key_type);
 
CDI_INTERFACE const char* CdiUtilityEnumValueToString(const CdiEnumStringKey* key_array, int enum_value);
 
CDI_INTERFACE int CdiUtilityStringToEnumValue(const CdiEnumStringKey* key_array, const char* name_str);
 
CDI_INTERFACE const char* CdiUtilityKeyEnumToString(CdiEnumStringKeyType key_type, int enum_value);
 
CDI_INTERFACE int CdiUtilityKeyStringToEnum(CdiEnumStringKeyType key_type, const char* name_str);
 
CDI_INTERFACE uint32_t CdiUtilityPtpToRtp(const CdiPtpTimestamp* ptp_timestamp_ptr, uint32_t sample_rate);
 
CDI_INTERFACE uint64_t CdiUtilityPtpTimestampToMicroseconds(const CdiPtpTimestamp* timestamp_ptr);
 
static inline const char* CdiUtilityBoolToString(bool b)
{
    return b ? "true" : "false";
}
 
#endif // CDI_UTILITY_API_H__