cdi_avm_payloads_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_AVM_PAYLOADS_API_H__
#define CDI_AVM_PAYLOADS_API_H__
 
#include "cdi_core_api.h"
 
#include <stdbool.h>
#include <stdint.h>
 
//*********************************************************************************************************************
//***************************************** START OF DEFINITIONS AND TYPES ********************************************
//*********************************************************************************************************************
 
#define CDI_MAX_ANC_USER_DATA_WORDS (255)
 
typedef enum
{
    kCdiFieldKindUnspecified      = 0,
    kCdiFieldKindInvalid          = 1,
    kCdiFieldKindInterlacedFirst  = 2,
    kCdiFieldKindInterlacedSecond = 3
} CdiFieldKind;
 
typedef struct
{
    int packet_offset;
    int packet_size;
    bool is_color_difference_channel;
    unsigned line_number:11;
    unsigned horizontal_offset:12;
    bool is_valid_source_stream_number;
    unsigned source_stream_number:7;
    uint8_t did;
    uint8_t sdid;
    uint8_t data_count;
    uint8_t user_data[CDI_MAX_ANC_USER_DATA_WORDS];
 
}  CdiAvmAncillaryDataPacket;
 
typedef const CdiAvmAncillaryDataPacket* (CdiAvmPacketizeAncCallback)(void* context_ptr);
 
typedef void (CdiAvmUnpacketizeAncCallback)(void* context_ptr, CdiFieldKind field_kind,
    const CdiAvmAncillaryDataPacket* packet_ptr, bool has_parity_error, bool has_checksum_error);
 
//*********************************************************************************************************************
//******************************************* START OF PUBLIC FUNCTIONS ***********************************************
//*********************************************************************************************************************
 
CDI_INTERFACE int CdiAvmGetAncillaryDataPayloadSize(uint16_t num_anc_packets, uint8_t data_counts[]);
 
CDI_INTERFACE CdiReturnStatus CdiAvmPacketizeAncillaryData(CdiAvmPacketizeAncCallback* produce_next_packet_ptr,
    CdiFieldKind field_kind, void* context_ptr, char* buffer_ptr, int* size_in_bytes_ptr);
 
CDI_INTERFACE CdiReturnStatus CdiAvmUnpacketizeAncillaryData(const CdiSgList* sgl_ptr,
    CdiAvmUnpacketizeAncCallback* consume_next_packet_ptr, void* context_ptr);
 
#endif // CDI_AVM_PAYLOADS_API_H__