hbbtv_types.h

Go to the documentation of this file.

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

#define _HBBTV_TYPES_H

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

/*---Enumerations for public use-----------------------------------------------*/
typedef enum
{
   // Requested operation completed successfully
   HBBTV_OK = 0,

   // Function call had no effect
   HBBTV_IGNORED_REQUEST,

   // When specified object (e.g. file) was not found
   HBBTV_ERR_OBJECT_NOT_FOUND,

   // One or more of the parameters passed was invalid
   HBBTV_ERR_BAD_PARAMETER,

   // Memory allocation failure or mutex/semaphore failure
   HBBTV_ERR_ALLOCATING_MEMORY,

   // The HbbTV module has not been opened
   HBBTV_ERR_COMP_NOT_OPEN,

   // The HbbTV module has already been opened
   HBBTV_ERR_COMP_ALREADY_OPEN,

   // The HbbTV module has not been started
   HBBTV_ERR_COMP_NOT_STARTED,

   // The HbbTV module has already been started
   HBBTV_ERR_COMP_ALREADY_STARTED,

   // The internal Queue is full
   HBBTV_ERR_QUEUE_FULL,

   // An error internal to the HbbTV module has occurred.
   HBBTV_ERR_INTERNAL,

   // An error due to failure to create system resource (e.g task, queue, semaphore or mutex)
   HBBTV_ERR_SYSTEM_RESOURCE,

   // An error that does not fit any other error code occurred
   HBBTV_ERR_OTHER,
} E_HBBTV_ERR;

typedef enum
{
   HBBTV_VIDEO_ASPECT_RATIO_16x9,
   HBBTV_VIDEO_ASPECT_RATIO_4x3
} E_HBBTV_ASPECT_RATIO;

typedef enum
{
   HBBTV_VK_INVALID = 0,
   HBBTV_VK_RED = 403,
   HBBTV_VK_GREEN = 404,
   HBBTV_VK_YELLOW = 405,
   HBBTV_VK_BLUE = 406,
   HBBTV_VK_UP = 38,
   HBBTV_VK_DOWN = 40,
   HBBTV_VK_LEFT = 37,
   HBBTV_VK_RIGHT = 39,
   HBBTV_VK_ENTER = 13,
   HBBTV_VK_BACK = 461,
   HBBTV_VK_0 = 48,
   HBBTV_VK_1 = 49,
   HBBTV_VK_2 = 50,
   HBBTV_VK_3 = 51,
   HBBTV_VK_4 = 52,
   HBBTV_VK_5 = 53,
   HBBTV_VK_6 = 54,
   HBBTV_VK_7 = 55,
   HBBTV_VK_8 = 56,
   HBBTV_VK_9 = 57,
   HBBTV_VK_STOP = 413,
   HBBTV_VK_PLAY = 415,
   HBBTV_VK_PAUSE = 19,
   HBBTV_VK_FAST_FWD = 417,
   HBBTV_VK_REWIND = 412,
   HBBTV_VK_INFO = 457,
   HBBTV_VK_TELETEXT = 459,

   /*
    * The following keys are not mandatory for HbbTV 1.2.1
    */
   HBBTV_VK_RECORD = 416,
   HBBTV_VK_PAGE_UP = 33,
   HBBTV_VK_PAGE_DOWN = 34,
   HBBTV_VK_A = 65,
   HBBTV_VK_B = 66,
   HBBTV_VK_C = 67,
   HBBTV_VK_D = 68,
   HBBTV_VK_E = 69,
   HBBTV_VK_F = 70,
   HBBTV_VK_G = 71,
   HBBTV_VK_H = 72,
   HBBTV_VK_I = 73,
   HBBTV_VK_J = 74,
   HBBTV_VK_K = 75,
   HBBTV_VK_L = 76,
   HBBTV_VK_M = 77,
   HBBTV_VK_N = 78,
   HBBTV_VK_O = 79,
   HBBTV_VK_P = 80,
   HBBTV_VK_Q = 81,
   HBBTV_VK_R = 82,
   HBBTV_VK_S = 83,
   HBBTV_VK_T = 84,
   HBBTV_VK_U = 85,
   HBBTV_VK_V = 86,
   HBBTV_VK_W = 87,
   HBBTV_VK_X = 88,
   HBBTV_VK_Y = 89,
   HBBTV_VK_Z = 90,
   HBBTV_VK_PREV = 424,
   HBBTV_VK_NEXT = 425,
   HBBTV_VK_GUIDE = 458,
   HBBTV_VK_SUBTITLE = 460,
   HBBTV_VK_MENU = 462
} E_HBBTV_KEY;

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

typedef struct
{
   U16BIT original_network_id;
   U16BIT transport_stream_id;
   U16BIT service_id;
} S_HBBTV_DVB_LOCATOR;


typedef struct
{
   U32BIT zlen;
   U8BIT *zptr;
} S_HBBTV_STRING;

typedef struct
{
   S32BIT left;
   S32BIT top;
   U32BIT width;
   U32BIT height;
} S_HBBTV_RECT;

typedef struct
{
   S16BIT left;
   S16BIT top;
   S16BIT right;
   S16BIT bottom;
} S_HBBTV_REGION;

typedef struct
{
   S_HBBTV_STRING device_id;

   S_HBBTV_STRING vendor_name;

   S_HBBTV_STRING model_name;

   S_HBBTV_STRING family_name;

   S_HBBTV_STRING sw_version;

   S_HBBTV_STRING hw_version;

   BOOLEAN pvr_enabled;

   BOOLEAN speech_desc_available;

   BOOLEAN voice_control_available;
} S_HBBTV_SYSTEM_INFO;

typedef E_HBBTV_ERR (*F_HBBTV_OBTAIN_ALL_GENRES)(S_HBBTV_STRING **genre_list, U32BIT *num);

typedef E_HBBTV_ERR (*F_HBBTV_OBTAIN_SERVICE_GENRES)(U16BIT freesat_id, S_HBBTV_STRING **genre_list, U32BIT *num);

typedef void (*F_HBBTV_FREE_GENRE_LIST)(S_HBBTV_STRING *genre_list, U32BIT num);

typedef struct
{
   F_HBBTV_OBTAIN_ALL_GENRES obtain_all_genres;
   F_HBBTV_OBTAIN_SERVICE_GENRES obtain_service_genres;
   F_HBBTV_FREE_GENRE_LIST free_genre_list;
} S_HBBTV_FREESAT_CALLBACKS;


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

#endif /* _HBBTV_TYPES_H */