source/graphics/inc/mg_osd.h

Go to the documentation of this file.

/*******************************************************************************
 * Copyright © 2014 The DTVKit Open Software Foundation Ltd (www.dtvkit.org)
 * Copyright © 2008 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
 *******************************************************************************/
#ifndef _MG_OSD_H
#define _MG_OSD_H

#include "mg_ctxt.h"
#include "osdtypes.h"

#define SRF_TYPE_TXT 0
#define SRF_TYPE_PNG 1
#define SRF_TYPE_JPG 2
#define SRF_TYPE_DLA 3

#ifndef MHEG_SCALE_ASPECT
#define MG_OSDMhegInit(x, y, s) MG_OSDMhegInit(x, y)
#else
typedef enum
{
   SCENE_ASPECT_16x9,
   SCENE_ASPECT_4x3,
   SCENE_ASPECT_UNSPECIFIED
} E_SCENE_ASPECT;
#endif

typedef struct s_surface
{
   U16BIT width;
   U16BIT height;
   void *col_buff;
   void *hw_handle;
   U32BIT buff_pitch;
   U8BIT opaque;
   U8BIT srf_type;
   #ifdef SRF_MEM_DGB
   struct s_surface *next;
   struct s_surface *prev;
   #endif
} S_SURFACE;


void MG_OSDMhegInit( U16BIT inWidth, U16BIT inHeight, E_SCENE_ASPECT sar );
void MG_OSDInit( U16BIT inWidth, U16BIT inHeight,
   U16BIT outWidth, U16BIT outHeight );

void MG_DisplayImage( S_SURFACE *data, S_REGION *overlap, S32BIT x, S32BIT y );

E_MhegErr MG_Initialise( U16BIT screenWidth, U16BIT screenHeight, U8BIT colourDepth );

void MG_Terminate(void);

BOOLEAN MG_IsHdSupported(void);

#ifdef SRF_MEM_DGB

void OSD_DbgAddSurf( S_SURFACE *srf );
void OSD_DbgRemSurf( S_SURFACE *srf );
void OSD_DbgListSrf(void);

#else

#define OSD_DbgAddSurf( s )
#define OSD_DbgRemSurf( s )
#define OSD_DbgListSurf()

#endif

#endif /*_MG_OSD_H*/