source: svn/newcon3bcm2_21bu/nexus/app/bapp_av.h

/******************************************************************************
 *    (c)2008-2009 Broadcom Corporation
 *
 * This program is the proprietary software of Broadcom Corporation and/or its licensors,
 * and may only be used, duplicated, modified or distributed pursuant to the terms and
 * conditions of a separate, written license agreement executed between you and Broadcom
 * (an "Authorized License").  Except as set forth in an Authorized License, Broadcom grants
 * no license (express or implied), right to use, or waiver of any kind with respect to the
 * Software, and Broadcom expressly reserves all rights in and to the Software and all
 * intellectual property rights therein.  IF YOU HAVE NO AUTHORIZED LICENSE, THEN YOU
 * HAVE NO RIGHT TO USE THIS SOFTWARE IN ANY WAY, AND SHOULD IMMEDIATELY
 * NOTIFY BROADCOM AND DISCONTINUE ALL USE OF THE SOFTWARE.
 *
 * Except as expressly set forth in the Authorized License,
 *
 * 1.     This program, including its structure, sequence and organization, constitutes the valuable trade
 * secrets of Broadcom, and you shall use all reasonable efforts to protect the confidentiality thereof,
 * and to use this information only in connection with your use of Broadcom integrated circuit products.
 *
 * 2.     TO THE MAXIMUM EXTENT PERMITTED BY LAW, THE SOFTWARE IS PROVIDED "AS IS"
 * AND WITH ALL FAULTS AND BROADCOM MAKES NO PROMISES, REPRESENTATIONS OR
 * WARRANTIES, EITHER EXPRESS, IMPLIED, STATUTORY, OR OTHERWISE, WITH RESPECT TO
 * THE SOFTWARE.  BROADCOM SPECIFICALLY DISCLAIMS ANY AND ALL IMPLIED WARRANTIES
 * OF TITLE, MERCHANTABILITY, NONINFRINGEMENT, FITNESS FOR A PARTICULAR PURPOSE,
 * LACK OF VIRUSES, ACCURACY OR COMPLETENESS, QUIET ENJOYMENT, QUIET POSSESSION
 * OR CORRESPONDENCE TO DESCRIPTION. YOU ASSUME THE ENTIRE RISK ARISING OUT OF
 * USE OR PERFORMANCE OF THE SOFTWARE.
 *
 * 3.     TO THE MAXIMUM EXTENT PERMITTED BY LAW, IN NO EVENT SHALL BROADCOM OR ITS
 * LICENSORS BE LIABLE FOR (i) CONSEQUENTIAL, INCIDENTAL, SPECIAL, INDIRECT, OR
 * EXEMPLARY DAMAGES WHATSOEVER ARISING OUT OF OR IN ANY WAY RELATING TO YOUR
 * USE OF OR INABILITY TO USE THE SOFTWARE EVEN IF BROADCOM HAS BEEN ADVISED OF
 * THE POSSIBILITY OF SUCH DAMAGES; OR (ii) ANY AMOUNT IN EXCESS OF THE AMOUNT
 * ACTUALLY PAID FOR THE SOFTWARE ITSELF OR U.S. $1, WHICHEVER IS GREATER. THESE
 * LIMITATIONS SHALL APPLY NOTWITHSTANDING ANY FAILURE OF ESSENTIAL PURPOSE OF
 * ANY LIMITED REMEDY.
 *
 * $brcm_Workfile:  $
 * $brcm_Revision:  $
 * $brcm_Date:  $
 *
 * Module Description:
 *
 * Revision History:
 *
 * Created: 09/28/2009 by Jeff Fisher
 *
 * $brcm_Log:  $
 * 
 *
 *****************************************************************************/
#ifndef BAPP_AV_H__
#define BAPP_AV_H__

#include "bapp_nexus.h"
#include "bsettop_stream.h"

#define CURR_CH                 0
#define NEXT_CH                 1
#define PREV_CH                 2

/**
Summary:
        Stream format type
**/

typedef struct bapp_av_stream_type_t
{
        unsigned char format;
        unsigned int codec_id;
        unsigned int transport_id; /* not used */
        char format_name[32];
}bapp_av_stream_type_t;

/**
Summary:
        reference obtained bapp_av_open
**/

typedef struct bapp_av *bapp_av_t;


#ifdef __cplusplus
extern "C" {
#endif

/**
Summary:
        Return a bapp_av_t handle.
**/
bapp_result_t bapp_av_open(bapp_av_t *p_av, 
                                                         bapp_nexus_t *p_nexus);
/**
Summary:
        Release resources.
**/
bapp_result_t bapp_av_close(bapp_av_t p_av);

/**
Summary:
        Lock the frontend.
**/
bapp_result_t bapp_audio_start(bapp_av_t p_av,bstream_t p_stream);
/**
Summary:
        Unlock the frontend.
**/
bapp_result_t bapp_audio_stop(bapp_av_t p_av);

/**
Summary:
        Lock the frontend.
**/
bapp_result_t bapp_video_start(bapp_av_t p_av,bstream_t p_stream);
/**
Summary:
        Unlock the frontend.
**/
bapp_result_t bapp_video_stop(bapp_av_t p_av);

/**
Summary:
        Supported video format. Returns NULL if stream_type (from PMT) not supported.
**/
bapp_av_stream_type_t *bapp_av_supported_video(unsigned char stream_type);


/**
Summary:
        Supported audio format. Returns NULL if stream_type (from PMT) not supported.
**/
bapp_av_stream_type_t *bapp_av_supported_audio(unsigned char stream_type);
/**
Summary:
        Return decode status.
**/

bapp_result_t bapp_av_status(bapp_av_t p_av, 
                                                          NEXUS_VideoDecoderStatus *p_vStatus,
                                                          NEXUS_AudioDecoderStatus *p_aStatus);

#ifdef __cplusplus
}
#endif

#endif /* BAPP_AV_H__ */