platform/inc/stbhwosd.h

Go to the documentation of this file.

/*******************************************************************************
 * Copyright © 2014 The DTVKit Open Software Foundation Ltd (www.dtvkit.org)
 * Copyright © 2004 Ocean Blue Software Ltd
 *
 * This file is part of a DTVKit Software Component
 * You are permitted to copy, modify or distribute this file subject to the terms
 * of the DTVKit 1.0 Licence which can be found in licence.txt or at www.dtvkit.org
 * 
 * THIS CODE AND INFORMATION ARE PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND,
 * EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND/OR FITNESS FOR A PARTICULAR PURPOSE.
 * 
 * If you or your organisation is not a member of DTVKit then you have access
 * to this source code outside of the terms of the licence agreement
 * and you are expected to delete this and any associated files immediately.
 * Further information on DTVKit, membership and terms can be found at www.dtvkit.org
 *******************************************************************************/
// pre-processor mechanism so multiple inclusions don't cause compilation error

#ifndef _STBHWOSD_H
#define _STBHWOSD_H

#include "osdtype.h"

//---Constant and macro definitions for public use-----------------------------

//---Enumerations for public use-----------------------------------------------
typedef enum e_blit_op
{
   STB_BLIT_COPY,
   STB_BLIT_A_BLEND
} E_BLIT_OP;

//---Global type defs for public use-------------------------------------------

//---Global Function prototypes for public use---------------------------------

void STB_OSDInitialise(U8BIT num_max_regions);

BOOLEAN STB_OSDEnable(BOOLEAN enable);

BOOLEAN STB_OSDDisableUIRegion(void);

BOOLEAN STB_OSDEnableUIRegion(void);

void STB_OSDSetTransparency(U8BIT trans);

U8BIT STB_OSDGetTransparency(void);

void STB_OSDSetPalette(U16BIT index, U16BIT num, U32BIT *trgb);

U32BIT* STB_OSDGetCurrentPalette(void);

void STB_OSDDrawBitmap(U16BIT x, U16BIT y, U16BIT width, U16BIT height, U8BIT bits, U8BIT *data);

void STB_OSDReadBitmap(U16BIT x, U16BIT y, U16BIT width, U16BIT height, U8BIT bits, U8BIT *data);

void STB_OSDDrawPixel(U16BIT x, U16BIT y, U32BIT colour);

void STB_OSDReadPixel(U16BIT x, U16BIT y, U32BIT *colour);

void STB_OSDDrawHLine(U16BIT x, U16BIT y, U16BIT width, U32BIT colour);

void STB_OSDDrawVLine(U16BIT x, U16BIT y, U16BIT height, U32BIT colour);

void STB_OSDDrawRectangle(U16BIT x, U16BIT y, U16BIT width, U16BIT height, U32BIT colour,
   U8BIT thick, BOOLEAN fill);

void STB_OSDClear(U32BIT colour);

void STB_OSDFill(U32BIT colour, E_BLIT_OP bflg);

void STB_OSDGetSize(U16BIT *width, U16BIT *height);

void STB_OSDUpdate(void);

void STB_OSDRegisterRefreshHandler(void (*func)(void));

void STB_OSDRegisterInUseCallback(U8BIT (*func)(void));

void STB_OSDRefreshDisplayCallback(void);

void STB_OSDResize(BOOLEAN scaling, U16BIT width, U16BIT height, U16BIT x_offset, U16BIT y_offset);


/* Subtitles and teletext OSD functions*/

void STB_OSDSetRegionDisplaySize(U16BIT width, U16BIT height);

void* STB_OSDCreateRegion(U16BIT width, U16BIT height, U8BIT depth);

void STB_OSDDestroyRegion(void *handle);

void STB_OSDSetYCrCbPalette(void *region_handle, U32BIT *tycrcb);

void STB_OSDMoveRegion(void *handle, U16BIT x, U16BIT y);

void STB_OSDHideRegion(void *handle);

void STB_OSDShowRegion(void *handle);

void STB_OSDDrawBitmapInRegion(void *handle, U16BIT x, U16BIT y, U16BIT w, U16BIT h, U8BIT *bitmap, BOOLEAN non_modifying_colour);

void STB_OSDRegionToRegionCopy(void *handle_new, void *handle_orig);

void STB_OSDFillRegion(void *handle, U8BIT colour);

void STB_OSDRegionFillRect(void *handle, U16BIT left, U16BIT top, U16BIT width, U16BIT height, U8BIT colour);

void STB_OSDUpdateRegions(void);

void STB_OSDSetRGBPalette(void *handle, U32BIT *trgb);


/* -------------------------- MHEG OSD functions ---------------------------------*/

void STB_OSDMhegSetPalette(U16BIT index, U16BIT number, const U32BIT *argb);

void* STB_OSDMhegSetResolution(U16BIT width, U16BIT height, U8BIT bits);

void* STB_OSDMhegCreateSurface( U16BIT width, U16BIT height,
   BOOLEAN init, U32BIT colour );

void* STB_OSDMhegLockBuffer( void *surface, U32BIT *pPitch );

void STB_OSDMhegUnlockBuffer( void *surface );

void STB_OSDMhegDestroySurface( void *surface );

void STB_OSDMhegBlitBitmap( void *surface, S_RECTANGLE *pRect, U32BIT pitch,
   U16BIT screen_x, U16BIT screen_y, E_BLIT_OP bflg );

void STB_OSDMhegFillRectangle( S_RECTANGLE *pRect, U32BIT colour, E_BLIT_OP bflg );

void STB_OSDMhegBlitStretch( S_RECTANGLE *pSrcRect, void *src_surf,
   S_RECTANGLE *pDstRect, void *dst_surf, U8BIT alpha_blend );

void STB_OSDMhegFillSurface( void *surface, S_RECTANGLE *pRect, U32BIT colour,
   E_BLIT_OP bflg );

void STB_OSDMhegUpdate(void);

void STB_OSDMhegClear(void);

#endif //  _STBHWOSD_H

//*****************************************************************************
// End of file
//*****************************************************************************