source/decoder/inc/decoder.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 _DECODER_H
#define _DECODER_H

#include "techtype.h"

#define HAS_TRANSPARENCY  0x00
#define COMPLETELY_OPAQUE 0x01

#define PIX_BYTES_PLT    1
#define PIX_BYTES_RGB    3
#define PIX_BYTES_ARGB   4

#define SD_METRIC_RESOLUTION        2835
#define HD_720_METRIC_RESOLUTION    3543
#define HD_1080_METRIC_RESOLUTION   5315

/* Structure: 'S_IMAGE'
 * Only
 * 'width' and 'height' are in pixels of the bitmap.
 * 'y_resolution' is in pixels per meter (on y axis). It is expected that bitmap resolution
 * could be - 0 or 2835, 3543, 5315. These correspond to bitmaps adapted to screen resolutions:
 * 720x576 (in case of 0 or 2835),  1280x720 (in case of 3543) and 1920x1080 (in case of 5315)
 *
 * 'pix_bytes' is the number of bytes per pixel - 1, 3 or 4.
 *    For value of 1 (palette data), the buffer should use the palette given by MHEG5_Open
 *    For value of 3 (RGB colour data), 'opaque' should always be set to COMPLETELY_OPAQUE.
 *    For value of 4 (ARGB colour data), 'opaque' could be set to COMPLETELY_OPAQUE, if all data is so.
 *
 * Values for 'opaque' indicate whether entire buffer has opaque colours
 * This can helps later with speed of pixel blending
 */
typedef struct s_image
{
   U16BIT width;
   U16BIT height;
   U16BIT y_resolution;
   U8BIT pix_bytes;
   U8BIT opaque;
   U8BIT *col_buff;
} S_IMAGE;


/*-------------------------------------------------------------------------------*
 *       Functions optionally provided by Receiver Platform                      *
 *        - when not using PNG/JPG libraries from Ocean Blue                     *
 *-------------------------------------------------------------------------------*/

S_IMAGE* DEC_DecodePng( U8BIT *data, U32BIT size );


void DEC_FreePng( S_IMAGE *image );


S_IMAGE* DEC_DecodeJpg( U8BIT *data, U32BIT size );


void DEC_FreeJpg( S_IMAGE *image );


void* DEC_OSDCreateBmpSurf( U32BIT s_width, U32BIT s_height,
   U32BIT i_width, U32BIT i_height,
   S_IMAGE *image, U32BIT *pitch );

#endif /* _DECODER_H  */