source: svn/trunk/newcon3bcm2_21bu/dta/src/settop_api/bsettop_display_priv.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:
 *
 * The application consists of two threads, application and system thread, with no   
 * overlapping functionality.  The main application thread handles 
 * initialization/destruction, user input, OSD and events from the system thread.  
 * The system thread handles media processing like video decode, psi processing, 
 * status monitoring, code downloads, etc.  The system thread also monitors events 
 * from the application thread and posts status events to the application thread.
 *
 * One advantage of this dual thread structure is that application thread is almost
 * always free to provide feedback on the OSD to user input.  The system thread 
 * manages most system resources without delaying or slowing user input and
 * corresponding OSD feedback. 
 *
 * To limit complexity neither application or system thread restricts or synchronizes
 * use of any system resource and the assumptions is that the threads cooperate as such.
 *
 * Revision History:
 *
 * Created: 09/28/2009 by Jeff Fisher
 *
 * $brcm_Log:  $
 * 
 *
 *****************************************************************************/
#ifndef BSETTOP_DISPLAY_PRIV_H__
#define BSETTOP_DISPLAY_PRIV_H__

#include "bsettop_types.h"
#include "bvdc.h"
#include "brdc.h"
#include "bxvd.h"
#include "bint.h"
#include "bvbilib.h"

/**
Summary:
        To support dual SD and HD display (composite SD and HDMI HD) output the BVN needs to be
        configured such that the single input source is connected to separate compositors. Therefore
        two compositors handles, display handles video and graphics window handles will be required.
        One compositor/display will be associated with SD composite output and the other will be 
        associated with the HDMI HD output but it is assumed that both the SD and HD outputs will share
        the same video input and same graphics surface as input to the two graphics feeders.
**/
typedef enum bsettop_display_id_t
{
#if HAS_HDMI
        eBDISPLAY_HDMI,                         /* display 0 pipeline */
#endif
        eBDISPLAY_COMPOSITE,            /* display 1 pipeline */
        eBDISPLAY_ID_MAX
}bsettop_display_id_t;

/**
Summary:
        same graphics surface used by both graphics feeders.
**/
typedef enum bsettop_surf_idx_t
{
        eBSURFACE_0,                            
        eBSURFACE_1,
#if HAS_HDMI
        eBSURFACE_2,            
#endif
        eBSURFACE_MAX
}bsettop_surf_idx_t;

/**
Summary:
        Collection of handles associated with a display pipeline.
**/
typedef struct bsettop_disp_t
{
        BVDC_Compositor_Handle hCmp;
        BVDC_Display_Handle    hDisplay;
        BVDC_Window_Handle     hVideoWindow;
        BVDC_Window_Handle     hGfxWindow;
        BVDC_Source_Handle     hGfxSource;
        BINT_CallbackHandle    hvsyncCbHandle;
}bsettop_disp_t;
/**
Summary:
        Collection of values, handles and pointers associated with a surface.
**/
struct bsettop_surf
{
        BSUR_Surface_Handle     hSurface;
        BSUR_Palette_Handle     hPalette;
        uint32_t                        num_palette_entries;
        uint32_t                        *p_palette;
        uint32_t                        pitch;
        uint8_t                         *p_pixels;
        uint32_t                        width;
        uint32_t                        height;
        uint32_t                        pixel_format;
};

/**
Summary:
        Central structure acting as agregator of all system resources.   No attempt is made
        to restrict mutual access to these resources as the general application structure 
        partitions responsibility to avoid such contention.
**/


struct bdisplay
{
    bool open;
    bdisplay_settings settings;
        BAVC_VdcDisplay_Info displayInfo;

        /* OSD Display */
    BVDC_Handle hVdc;
        BRDC_Handle hRdc;

        bsettop_disp_t         disp[eBDISPLAY_ID_MAX];
        BFMT_VideoFmt              hdmiFmt;
        BFMT_AspectRatio       auto_hdmi_480i_aspect_ratio;
        BFMT_AspectRatio       auto_hdmi_480p_aspect_ratio;

        BVDC_Source_Handle     hVideoSource; /* Mpeg feeder 0 */

        /* double buffered graphics surface used by both Gfx feeders */
        bsettop_surf_t                  offscreen;
        bsettop_surf_t                  overlay;
#ifdef CONFIG_GFX_ARGB32
        bsettop_surf_t                  osd;
#else
        bsettop_surf_t                  osd[eBDISPLAY_ID_MAX];
#endif
        BPXL_Format                             pxl_format;
        bsettop_surf_idx_t              surface_idx;

        /* vbi output */
        struct {
                BVBI_Handle             hVbi;
                BVBIlib_Handle          hVbilib;
                BVBIlib_List_Handle     hVbilist;
                BVBI_Encode_Handle      enc_core; /* must be NULL if not created */
                BVBIlib_Encode_Handle   enc; /* this is VBI encode handle destination for VBI data */
                BINT_CallbackHandle     tf_isr;
                BINT_CallbackHandle     bf_isr;
        } vbi;
        b_mutex_t                                       vdc_mutex;
};

#ifdef __cplusplus
extern "C" {
#endif
BERR_Code bdisplay_graphics_window_open(bdisplay_t display,  
                                                                                bsettop_display_id_t id);
BERR_Code bdisplay_graphics_window_close(bdisplay_t display,  
                                                                                 bsettop_display_id_t id);




#ifdef __cplusplus
}
#endif


#endif /* BSETTOP_DISPLAY_PRIV_H__ */