openavb_intf_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 interface module public header
*/

#ifndef OPENAVB_INTF_PUB_H
#define OPENAVB_INTF_PUB_H 1

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

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

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

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

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

typedef bool (*openavb_intf_tx_cb_t)(media_q_t *pMediaQ);

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

typedef void (*openavb_intf_rx_translate_cb_t)(media_q_t *pMediaQ, U8 *pPubData, U32 length);

typedef bool (*openavb_intf_rx_cb_t)(media_q_t *pMediaQ);

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

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

typedef unsigned int (*openavb_intf_get_src_bitrate_t)(media_q_t *pMediaQ);

typedef struct {
    openavb_intf_cfg_cb_t           intf_cfg_cb;
    openavb_intf_gen_init_cb_t      intf_gen_init_cb;
    openavb_intf_avdecc_init_cb_t   intf_avdecc_init_cb;
    openavb_intf_tx_init_cb_t       intf_tx_init_cb;
    openavb_intf_tx_cb_t            intf_tx_cb;
    openavb_intf_rx_init_cb_t       intf_rx_init_cb;
    // openavb_intf_rx_translate_cb_t   intf_rx_translate_cb;   // Hidden since it is for direct mapping -> interface CBs
    openavb_intf_rx_cb_t            intf_rx_cb;
    openavb_intf_end_cb_t           intf_end_cb;
    openavb_intf_gen_end_cb_t       intf_gen_end_cb;
    void *                      intf_host_cb_list;
    openavb_intf_get_src_bitrate_t  intf_get_src_bitrate_cb;
} openavb_intf_cb_t;

typedef bool (*openavb_intf_initialize_fn_t)(media_q_t *pMediaQ, openavb_intf_cb_t *pIntfCB);

#endif  // OPENAVB_INTF_PUB_H