ait.h

Go to the documentation of this file.

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

/*---includes for this file--------------------------------------------------*/
#include "hbbtv_types.h"

/* compiler library header files */

/* third party header files */

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

#define AIT_USAGE_TELETEXT             0x01

#define AIT_MAX_NUM_PROTOCOLS          2
#define AIT_PROTOCOL_OBJECT_CAROUSEL   0x0001
#define AIT_PROTOCOL_HTTP              0x0003

#define AIT_NOT_VISIBLE_ALL            0x00
#define AIT_NOT_VISIBLE_USERS          0x01
#define AIT_VISIBLE_ALL                0x03

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

typedef enum
{
   APP_TYP_MHEG5 = 0x0008,
   APP_TYP_HBBTV = 0x0010,
   APP_TYP_XML = 0x8000,
} E_AIT_APP_TYPE;

typedef enum
{
   XML_TYP_UNKNOWN = 0x00,
   XML_TYP_OTHER = 0x01,
   XML_TYP_DVB_HTML = 0x10,
   XML_TYP_DVB_J = 0x11,
} E_AIT_XML_TYPE;

typedef enum
{
   APP_CTL_UNKNOWN = 0x00,
   APP_CTL_AUTOSTART = 0x01,
   APP_CTL_PRESENT = 0x02,
   APP_CTL_DESTROY = 0x03,
   APP_CTL_KILL = 0x04,
   APP_CTL_PREFETCH = 0x05,
   APP_CTL_REMOTE = 0x06,
   APP_CTL_DISABLED = 0x07,
   APP_CTL_PB_AUTO = 0x08
} E_AIT_APP_CONTROL;

/*---Global type defs for public use-------------------------------------------*/
typedef struct
{
   U32BIT lang_code;
   U32BIT zlen;
   U8BIT *zptr;
} S_LANG_STRING;

typedef struct
{
   U8BIT num_langs;
   S_LANG_STRING *names;
} S_APP_NAME_DESC;

typedef struct
{
   BOOLEAN remote_connection;
   U16BIT net_id;
   U16BIT stream_id;
   U16BIT service_id;
   U8BIT component_tag;
} S_OC_SELECTOR_BYTES;

typedef struct
{
   S_HBBTV_STRING base_url;
   U8BIT num_extension_urls;
   S_HBBTV_STRING *extension_urls;
} S_URL_SELECTOR_BYTES;

typedef struct
{
   U16BIT protocol_id;
   U8BIT transport_protocol_label;
   union
   {
      S_OC_SELECTOR_BYTES oc;
      S_URL_SELECTOR_BYTES url;
   } s;
} S_TRANSPORT_PROTOCOL_DESC;

typedef struct
{
   U16BIT app_profile;
   U8BIT version_major;
   U8BIT version_minor;
   U8BIT version_micro;
} S_APP_PROFILE;

typedef struct
{
   U8BIT visibility;
   U8BIT priority;
   U8BIT num_labels;
   U8BIT num_profiles;
   S_APP_PROFILE *app_profiles;
   U8BIT *transport_protocol_labels;
   BOOLEAN service_bound;
} S_APP_DESC;

typedef struct
{
   U32BIT org_id;
   U16BIT app_id;
   U8BIT control_code;
   U8BIT num_transports;
   S_TRANSPORT_PROTOCOL_DESC transport_array[AIT_MAX_NUM_PROTOCOLS];
   S_HBBTV_STRING location;
   S_APP_NAME_DESC app_name;
   S_APP_DESC app_desc;
   U8BIT xml_type;
   U8BIT xml_version;
   U8BIT usage_type;
   U8BIT num_boundaries;
   S_HBBTV_STRING *boundaries;
} S_AIT_APP_DESC;

typedef struct
{
   void *section_data;
   U16BIT app_type;
   U8BIT version;
   U8BIT num_apps;
   S_AIT_APP_DESC *app_array;
   BOOLEAN complete;
} S_AIT_TABLE;


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

/*!**************************************************************************
 * @brief   Parse the AIT table
 ****************************************************************************/
S_AIT_TABLE* AIT_ParseTable(U8BIT *data_ptr);
void AIT_ClearTable(S_AIT_TABLE *ait_table);

S_AIT_APP_DESC* AIT_AutoStartApp(S_AIT_TABLE *ait_table);
S_AIT_APP_DESC* AIT_TeletextApp(S_AIT_TABLE *ait_table);
S_AIT_APP_DESC* AIT_FindApp(S_AIT_TABLE *ait_table, U32BIT org_id, U16BIT app_id);

#endif /* AIT_PARSE_H */

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