source: svn/branches/kctv/newcon3bcm2_21bu/magnum/commonutils/sur/7552/bsur_private.h

/***************************************************************************
 *     Copyright (c) 2003-2010, Broadcom Corporation
 *     All Rights Reserved
 *     Confidential Property of Broadcom Corporation
 *
 *  THIS SOFTWARE MAY ONLY BE USED SUBJECT TO AN EXECUTED SOFTWARE LICENSE
 *  AGREEMENT  BETWEEN THE USER AND BROADCOM.  YOU HAVE NO RIGHT TO USE OR
 *  EXPLOIT THIS MATERIAL EXCEPT SUBJECT TO THE TERMS OF SUCH AN AGREEMENT.
 *
 * $brcm_Workfile: bsur_private.h $
 * $brcm_Revision: Hydra_Software_Devel/16 $
 * $brcm_Date: 2/5/10 3:30p $
 *
 * Module Description:
 *
 * Revision History:
 *
 * $brcm_Log: /magnum/commonutils/sur/7038/bsur_private.h $
 * 
 * Hydra_Software_Devel/16   2/5/10 3:30p erickson
 * SW3548-2765: added BDBG_OBJECT_ASSERT protection for surface and
 * palette handles
 *
 * Hydra_Software_Devel/15   10/3/08 10:45a yuxiaz
 * PR47303: More TestFeature1 support in BSUR.
 *
 * Hydra_Software_Devel/14   10/1/08 5:53p nissen
 * PR 47303: Added functions to get default surface settings and
 * TestFeature1 settings. Added settings structure parameter to surface
 * create function.
 *
 * Hydra_Software_Devel/13   4/4/08 11:26a nissen
 * PR 40122: Added support for 10-bit 422 40-bit packed formats.
 *
 * Hydra_Software_Devel/12   11/8/06 10:55a nissen
 * PR 25683: Added support for a surface ID.
 *
 * Hydra_Software_Devel/11   8/25/06 11:04a nissen
 * PR 18990: Added support for 10-bit YCbCr 422 alignment.
 *
 * Hydra_Software_Devel/10   3/15/06 11:49a nissen
 * PR 15840: Added support for creating YCbCr 420 surfaces.
 *
 * Hydra_Software_Devel/9   11/10/05 5:03p syang
 * PR 12244: move alpha-only pixel constant color setting from BSUR to
 * BVDC
 *
 * Hydra_Software_Devel/8   2/2/05 10:08a nissen
 * PR 13979: Added user allocated palette memory alignment check.
 *
 * Hydra_Software_Devel/7   8/11/04 6:28p syang
 * PR 12244: added alpha only pixel format support for gfx feeder (new B0
 * feature)
 *
 * Hydra_Software_Devel/6   11/20/03 6:55p nissen
 * Changed palette pointer to handle.
 *
 * Hydra_Software_Devel/5   8/20/03 4:39p nissen
 * Removed, added, and modified structures and macros.
 *
 * Hydra_Software_Devel/4   8/6/03 2:24p nissen
 * Changed all references to "unsigned int" to "uint32_t".
 *
 * Hydra_Software_Devel/3   6/5/03 11:42a nissen
 * Fixed macro to get alignment mask.
 *
 * Hydra_Software_Devel/2   4/25/03 3:52p nissen
 * Added align mask macro.
 *
 * Hydra_Software_Devel/1   4/25/03 12:14p nissen
 * Surface module
 *
 ***************************************************************************/

#ifndef BSUR_PRIVATE_H__
#define BSUR_PRIVATE_H__

#ifdef __cplusplus
extern "C" {
#endif

BDBG_OBJECT_ID_DECLARE(BSUR_Palette);
BDBG_OBJECT_ID_DECLARE(BSUR_Surface);

/***************************************************************************
Description:
        This is the private palette structure.
****************************************************************************/
typedef struct BSUR_P_Palette_Handle
{
        BDBG_OBJECT(BSUR_Palette)
        BMEM_Handle hMem;                /* handle to BMEM module */
        void *pvAddress;                 /* palette address */
        uint32_t ulNumEntries;           /* number of palette entries */
        uint32_t ulConstraintMask;       /* constraint mask */
        BPXL_Format eFormat;             /* format of palette */
        bool bDriverOwned;               /* memory allocated by driver */
}
BSUR_P_Palette_Handle;

/***************************************************************************
Description:
        This is the private surface structure.
****************************************************************************/
typedef struct BSUR_P_Surface_Handle
{
        BDBG_OBJECT(BSUR_Surface)
        BSUR_Surface_Settings stSettings; /* extended settings */
        BMEM_Handle hMem;                 /* handle to BMEM module */
        void *pvAddress;                  /* surface address */
        uint32_t ulWidth;                 /* surface width */
        uint32_t ulHeight;                /* surface height */
        uint32_t ulPitch;                 /* surface pitch */
        uint32_t ulConstraintMask;        /* constraint mask */
        uint32_t ulID;                    /* surface ID */
        BPXL_Format eFormat;              /* format of palette */
        BSUR_Palette_Handle hPalette;     /* pointer to attached palette */
        bool bDriverOwned;                /* memory allocated by driver */
}
BSUR_P_Surface_Handle;

/***************************************************************************
Description:
        Gets format's alignment mask.

Input:
        format - Pixel format.
****************************************************************************/
#define BSUR_P_ALIGN_MASK( format ) \
        ((BPXL_BITS_PER_PIXEL(format) > 8) ? \
        (((BPXL_BITS_PER_PIXEL(format) / 8) & 1) ? 0 : \
        ((BPXL_BITS_PER_PIXEL(format) / 8) - 1)) : 0)

/***************************************************************************
Description:
        Determines if value is unaligned to size of pixel in given format.

Input:
        format - Pixel format.
        value  - Value to check.
****************************************************************************/
#define BSUR_P_PIXEL_UNALIGNED( format, value ) \
        (((uint32_t) (value)) & BSUR_P_ALIGN_MASK( format ))

/***************************************************************************
Description:
        Determines if palette address is unaligned.

Input:
        value  - Value to check.
****************************************************************************/
#define BSUR_P_PALETTE_ALIGNMENT   5
#define BSUR_P_PALETTE_UNALIGNED( value ) \
        (((uint32_t) (value)) & ((1 << BSUR_P_PALETTE_ALIGNMENT) - 1))

/***************************************************************************
Description:
        Determines if value is a power of 2.

Input:
        value  - Value to check.
        valid  - Returned bool (true if power of 2).
****************************************************************************/
#define BSUR_P_POWER_OF_2( value, valid ) \
{ \
        uint32_t ulSize = (uint32_t) (value); \
        uint32_t ulCount = 0; \
        while( ulSize > 1 ) \
        { \
                ulSize /= 2; \
                ulCount++; \
        } \
        while( ulCount ) \
        { \
                ulSize *= 2; \
                ulCount--; \
        } \
        (valid) = (ulSize == (value)) ? true : false; \
}

/***************************************************************************
Description:
        Determines if YCbCr420 format is unaligned. (eg. BPXL_eY8, BPXL_eCb8_Cr8)

Input:
        value  - Value to check.
****************************************************************************/
#define BSUR_P_YCbCr420_ALIGNMENT   6
#define BSUR_P_YCbCr420_UNALIGNED( value ) \
        (((uint32_t) (value)) & ((1 << BSUR_P_YCbCr420_ALIGNMENT) - 1))

/***************************************************************************
Description:
        Determines if YCbCr422 10-bit format is unaligned.
        (eg. BPXL_eX2_Y010_Cb10_Y110_X2_Cr10_Y010_Cb10_X2_Y110_Cr10_Y010_X2_Cb10_Y110_Cr10)

Input:
        value  - Value to check.
****************************************************************************/
#define BSUR_P_YCbCr422_10BIT_ALIGNMENT   4
#define BSUR_P_YCbCr422_10BIT_UNALIGNED( value ) \
        (((uint32_t) (value)) & ((1 << BSUR_P_YCbCr422_10BIT_ALIGNMENT) - 1))

/***************************************************************************
Description:
        Determines if YCbCr422 10-bit packed format is unaligned.
        (eg. BPXL_eCr10_Y110_Cb10_Y010)

Input:
        value  - Value to check.
****************************************************************************/
#define BSUR_P_YCbCr422_10BIT_PACKED_ALIGNMENT   5
#define BSUR_P_YCbCr422_10BIT_PACKED_UNALIGNED( value ) \
        (((uint32_t) (value)) & ((1 << BSUR_P_YCbCr422_10BIT_PACKED_ALIGNMENT) - 1))

/***************************************************************************
Description:
        Determines if DCX TestFeature1 format is unaligned.

Input:
        value  - Value to check.
****************************************************************************/
#define BSUR_P_DCX_TESTFEATURE1_ALIGNMENT   6
#define BSUR_P_DCX_TESTFEATURE1_UNALIGNED( value ) \
        (((uint32_t) (value)) & ((1 << BSUR_P_DCX_TESTFEATURE1_ALIGNMENT) - 1))

#define BSUR_P_DCX_TESTFEATURE1_BITSPERPIXEL_MINIMUM   14
#define BSUR_P_DCX_TESTFEATURE1_BITSPERPIXEL_MAXIMUM   64
#define BSUR_P_DCX_TESTFEATURE1_BITSPERPIXEL_DEFAULT   BSUR_P_DCX_TESTFEATURE1_BITSPERPIXEL_MINIMUM

#ifdef __cplusplus
}
#endif

#endif /* #ifndef BSUR_PRIVATE_H__ */

/* end of file */