openavb_map_pub.h

Go to the documentation of this file.

/*************************************************************************************************************
Copyright (c) 2012-2015, Symphony Teleca Corporation, a Harman International Industries, Incorporated company
All rights reserved.
 
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
 
1. Redistributions of source code must retain the above copyright notice, this
   list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
   this list of conditions and the following disclaimer in the documentation
   and/or other materials provided with the distribution.
 
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS LISTED "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS LISTED BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
Attributions: The inih library portion of the source code is licensed from 
Brush Technology and Ben Hoyt - Copyright (c) 2009, Brush Technology and Copyright (c) 2009, Ben Hoyt. 
Complete license and copyright information can be found at 
https://github.com/benhoyt/inih/commit/74d2ca064fb293bc60a77b0bd068075b293cf175.
*************************************************************************************************************/

/*
* HEADER SUMMARY : Common mapper module public interface
*/

#ifndef OPENAVB_MAP_PUB_H
#define OPENAVB_MAP_PUB_H 1

#include "openavb_types_pub.h"
#include "openavb_mediaq_pub.h"

#define MAP_NULL_OPENAVB_FORMAT         0x00

#define MAP_PIPE_OPENAVB_FORMAT         0x01

#define MAP_CTRL_OPENAVB_FORMAT         0x00

typedef enum {
    TX_CB_RET_PACKET_NOT_READY = 0,     
    TX_CB_RET_PACKET_READY,             
    TX_CB_RET_MORE_PACKETS              
} tx_cb_ret_t;

typedef void (*openavb_map_cfg_cb_t)(media_q_t *pMediaQ, const char *name, const char *value);

typedef U8(*openavb_map_subtype_cb_t)();

typedef U8(*openavb_map_avtp_version_cb_t)();

typedef U16(*openavb_map_max_data_size_cb_t)(media_q_t *pMediaQ);

typedef U32(*openavb_map_transmit_interval_cb_t)(media_q_t *pMediaQ);

typedef void (*openavb_map_gen_init_cb_t)(media_q_t *pMediaQ);

typedef void (*openavb_map_avdecc_init_cb_t)(media_q_t *pMediaQ, U16 configIdx, U16 descriptorType, U16 descriptorIdx);

typedef void (*openavb_map_tx_init_cb_t)(media_q_t *pMediaQ);

typedef tx_cb_ret_t(*openavb_map_tx_cb_t)(media_q_t *pMediaQ, U8 *pData, U32 *datalen);

typedef void (*openavb_map_rx_init_cb_t)(media_q_t *pMediaQ);

typedef bool (*openavb_map_rx_cb_t)(media_q_t *pMediaQ, U8 *pData, U32 datalen);

typedef void (*openavb_map_end_cb_t)(media_q_t *pMediaQ);

typedef void (*openavb_map_gen_end_cb_t)(media_q_t *pMediaQ);

typedef void (*openavb_map_set_src_bitrate_cb_t)(media_q_t *pMediaQ, unsigned int bitrate);

typedef unsigned int (*openavb_map_get_max_interval_frames_cb_t)(media_q_t *pMediaQ, SRClassIdx_t sr_class);

typedef struct {
    openavb_map_cfg_cb_t                map_cfg_cb;
    openavb_map_subtype_cb_t            map_subtype_cb;
    openavb_map_avtp_version_cb_t       map_avtp_version_cb;
    openavb_map_max_data_size_cb_t      map_max_data_size_cb;
    openavb_map_transmit_interval_cb_t  map_transmit_interval_cb;
    openavb_map_gen_init_cb_t           map_gen_init_cb;
    openavb_map_avdecc_init_cb_t        map_avdecc_init_cb;
    openavb_map_tx_init_cb_t            map_tx_init_cb;
    openavb_map_tx_cb_t                 map_tx_cb;
    openavb_map_rx_init_cb_t            map_rx_init_cb;
    openavb_map_rx_cb_t                 map_rx_cb;
    openavb_map_end_cb_t                map_end_cb;
    openavb_map_gen_end_cb_t            map_gen_end_cb;
    openavb_map_set_src_bitrate_cb_t    map_set_src_bitrate_cb;
    openavb_map_get_max_interval_frames_cb_t map_get_max_interval_frames_cb;
} openavb_map_cb_t;

typedef bool (*openavb_map_initialize_fn_t)(media_q_t *pMediaQ, openavb_map_cb_t *pMapCB, U32 inMaxTransitUsec);

#endif  // OPENAVB_MAP_PUB_H