source/core/inc/tmcolor.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
 * Copyright © 2000 Koninklijke Philips Electronics N.V
 *
 * 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 _TMCOLOR_H
#define _TMCOLOR_H

/*---includes for this file--------------------------------------------------*/

#include "mh5base.h"
#include "osdtypes.h"

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

#define DEFAULTTEXTCOLOR        "\xff\xff\xff\x00", 4
#define TRANSPARENTCOLOR        "\xff\xff\xff\xff", 4
#define BLACKCOLOR              "\x00\x00\x00\x00", 4
#define DEFAULTSLIDERCOLOR      "\xff\xff\xff\x00", 4
#define DEFAULTBUTTONCOLOR      "\x50\x50\x50\x00", 4
#define DEFAULTHIGHLIGHTCOLOR   "\xff\xff\xff\x00", 4
#define DEFAULTDESKTOPCOLOUR    "\x00\x00\x00\x00", 4

/* Macros to convert from discrete red, green, blue and transparent values to
 * OSDColor values
 */
#define RGB(r, g, b)        (0xff000000 | ((r) << 16) | ((g) << 8) | (b))
#define RGBT(r, g, b, t)    ((((t) ^ 0xff) << 24) | ((r) << 16) | ((g) << 8) | (b))

/* Macros to extract red, green, blue, transparent and alpha values from an
 *  OSDColor value
 */

#define GetRValue(osdcolour)        (((osdcolour) >> 16) & 0xff)
#define GetGValue(osdcolour)        (((osdcolour) >> 8) & 0xff)
#define GetBValue(osdcolour)        ((osdcolour) & 0xff)
#define GetTValue(osdcolour)        (((osdcolour) >> 24) ^ 0xff)
#define GetAValue(osdcolour)        ((osdcolour) >> 24)

#define GetYValue(red, green, blue) ((U8BIT) (((77 * red + 150 * green + 29 * blue) / 256)))
#define GetCBValue(red, green, blue) ((U8BIT)((-44 * red - 87 * green + 131 * blue) / 256 + 128))
#define GetCRValue(red, green, blue) ((U8BIT)((131 * red - 110 * green - 21 * blue) / 256 + 128))
#define GetMixValue(transparency)     ((255 - transparency) / (255 / 63))

/* Desktop colour is displayed at the bottom of the MHEG-5 display stack */
#define DESKTOP_COLOUR      (RGBT(0, 0, 0, 0))

/* Fully transparent OSDColor type */
#define FULLY_TRANSPARENT   (RGBT(0, 0, 0, 255))

/*---Enumerations for public use---------------------------------------------*/

/*---Global type defs for public use-----------------------------------------*/
typedef enum
{
   MHEG_COLOUR_CYAN,
   MHEG_COLOUR_CYAN1,
   MHEG_COLOUR_CYAN2,
   MHEG_COLOUR_CYAN3,
   MHEG_COLOUR_CYAN4,
   MHEG_COLOUR_DARKCYAN,
   MHEG_COLOUR_YELLOW,
   MHEG_COLOUR_YELLOW1,
   MHEG_COLOUR_YELLOW2,
   MHEG_COLOUR_YELLOW3,
   MHEG_COLOUR_YELLOW4,
   MHEG_COLOUR_DARKYELLOW,
   MHEG_COLOUR_MAGENTA,
   MHEG_COLOUR_MAGENTA1,
   MHEG_COLOUR_MAGENTA2,
   MHEG_COLOUR_MAGENTA3,
   MHEG_COLOUR_MAGENTA4,
   MHEG_COLOUR_DARKMAGENTA,
   MHEG_COLOUR_RED,
   MHEG_COLOUR_RED1,
   MHEG_COLOUR_RED2,
   MHEG_COLOUR_RED3,
   MHEG_COLOUR_RED4,
   MHEG_COLOUR_DARKRED,
   MHEG_COLOUR_GREEN,
   MHEG_COLOUR_GREEN1,
   MHEG_COLOUR_GREEN2,
   MHEG_COLOUR_GREEN3,
   MHEG_COLOUR_GREEN4,
   MHEG_COLOUR_DARKGREEN,
   MHEG_COLOUR_BLUE,
   MHEG_COLOUR_BLUE1,
   MHEG_COLOUR_BLUE2,
   MHEG_COLOUR_BLUE3,
   MHEG_COLOUR_BLUE4,
   MHEG_COLOUR_DARKBLUE,
   MHEG_COLOUR_BLACK,
   MHEG_COLOUR_GRAY,
   MHEG_COLOUR_GREY,
   MHEG_COLOUR_WHITE,
   MHEG_COLOUR_TRANSPARENT
} E_MHEG_COLOURS;

typedef struct
{
   U8BIT transparancy;
   U8BIT red;
   U8BIT green;
   U8BIT blue;
} S_MHEG_OSD_COLOUR_MAP;

/*---Global variable declarations for public use-----------------------------*/

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

OSDColor OSDgetColour(const char *colour, int len);

MHEG5String OSDsetColour(OSDColor colour);


#endif /*_TMCOLOR_H*/