openavb_tl_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 : Talker Listener Public Interface
*/

#ifndef OPENAVB_TL_PUB_H
#define OPENAVB_TL_PUB_H 1

#include "openavb_types_pub.h"
#include "openavb_mediaq_pub.h"
#include "openavb_map_pub.h"
#include "openavb_intf_pub.h"
#include "openavb_avtp_time_pub.h"

typedef void *tl_handle_t;

typedef enum {
    TL_STAT_TX_CALLS,
    TL_STAT_TX_FRAMES,
    TL_STAT_TX_LATE,
    TL_STAT_TX_BYTES,
    TL_STAT_RX_CALLS,
    TL_STAT_RX_FRAMES,
    TL_STAT_RX_LOST,
    TL_STAT_RX_BYTES,
} tl_stat_t;

#define MAX_LIB_CFG_ITEMS 64


#define IFNAMSIZE 16

typedef struct {
    avb_role_t role;
    openavb_map_cb_t map_cb;
    openavb_intf_cb_t intf_cb;
    cfg_mac_t dest_addr;
    cfg_mac_t stream_addr;
    S32 stream_uid;
    U32 max_interval_frames;
    U32 max_frame_size;
    U32 max_transit_usec;
    U32 max_transmit_deficit_usec;
    U32 internal_latency;
    U32 max_stale;
    U32 batch_factor;
    U32 report_seconds;
    bool start_paused;
    U8 sr_class;
    U8 sr_rank;
    U32 raw_tx_buffers;
    U32 raw_rx_buffers;
    bool tx_blocking_in_intf;
    char ifname[IFNAMSIZE];
    bool rx_signal_mode;

    openavb_map_initialize_fn_t pMapInitFn;
    openavb_intf_initialize_fn_t pIntfInitFn;
} openavb_tl_cfg_t;

typedef struct openavb_tl_cfg_name_value_t {
    char *libCfgNames[MAX_LIB_CFG_ITEMS];
    char *libCfgValues[MAX_LIB_CFG_ITEMS];
    U32 nLibCfgItems;
} openavb_tl_cfg_name_value_t; 


bool openavbTLInitialize(U32 maxTL);

bool openavbTLCleanup(void);

bool openavbGetVersion(U8 *major, U8 *minor, U8 *revision);

tl_handle_t openavbTLOpen(void);

void openavbTLInitCfg(openavb_tl_cfg_t *pCfg);

bool openavbTLConfigure(tl_handle_t handle, openavb_tl_cfg_t *pCfg, openavb_tl_cfg_name_value_t *pNVCfg);

bool openavbTLRun(tl_handle_t handle);

bool openavbTLStop(tl_handle_t handle);

void openavbTLPauseStream(tl_handle_t handle, bool bPause);

bool openavbTLClose(tl_handle_t handle);

void* openavbTLGetIntfHostCBList(tl_handle_t handle);

void* openavbTLGetIntfHandle(tl_handle_t handle);

bool openavbTLIsRunning(tl_handle_t handle);

bool openavbTLIsConnected(tl_handle_t handle);

bool openavbTLIsStreaming(tl_handle_t handle);

avb_role_t openavbTLGetRole(tl_handle_t handle);

U64 openavbTLStat(tl_handle_t handle, tl_stat_t stat);

bool openavbTLReadIniFileOsal(tl_handle_t TLhandle, const char *fileName, openavb_tl_cfg_t *pCfg, openavb_tl_cfg_name_value_t *pNVCfg);


#endif  // OPENAVB_TL_PUB_H