hbbtv_sif_service.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_SIF_SERVICE_H

#define _HBBTV_SIF_SERVICE_H


#include "techtype.h"
#include "hbbtv_types.h"
#include "hbbtv_sif_types.h"


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

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

typedef enum
{
   /* These come from 8bit service type field in Service Descriptor Table,
    * and should be used for field 'service_type' */
   SDT_TYPE_TV = 0x01,
   SDT_TYPE_RADIO = 0x02,
   SDT_TYPE_AVC_RADIO = 0x0a,
   SDT_TYPE_DATA = 0x0c,
   SDT_TYPE_MPEG2_HD = 0x11,
   SDT_TYPE_AVC_SD_TV = 0x16,
   SDT_TYPE_HD_TV = 0x19,
} E_HBBTV_SDT_SERVICE_TYPE;


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

typedef struct
{
   U16BIT hours;
   U8BIT minutes;
   U8BIT seconds;
} S_HBBTV_TIME;

typedef struct
{
   void *dvb_user_data; /* Available for DVB stack - not used by the HbbTV engine */

   /* Event name, from the EIT short_event_descriptor */
   S_HBBTV_STRING event_name;

   /* Event description, from the EIT short_event_descriptor */
   S_HBBTV_STRING short_description;

   /* Event parental rating, from the EIT parental_rating_descriptor
      formatted as it is in parental_rating_descriptor*/
   U32BIT parental_rating;

   /* Event start date, in Modified Julian Date format - as per EIT field */
   U32BIT start_date;

   /* Event start time, from the EIT start_time field*/
   S_HBBTV_TIME start_time;

   /* Event duration, from the EIT duration field,
      as formatted in the EIT*/
   S_HBBTV_TIME duration;

   BOOLEAN use_crid;

   /* Event identifier */
   U16BIT event_id;

   /* Full programme CRID */
   S_HBBTV_STRING crid;

   /* Event description, from the EIT extended_event_descriptor */
   S_HBBTV_STRING long_description;

   U8BIT audio_type;

   BOOLEAN is_multilingual;

   U8BIT num_audio_languages;

   S_HBBTV_STRING *audio_language_array;

   BOOLEAN is_hd;

   U8BIT num_genres;

   S_HBBTV_STRING *genre_array;

   BOOLEAN has_recording;

   U32BIT recording_id;

   U32BIT timer_id;

} S_HBBTV_EVENT_DETAILS;

typedef struct
{
   U32BIT service_index;

   /* Service name, from the SDT service_descriptor */
   S_HBBTV_STRING service_name;

   /* Service type, from the SDT service_descriptor or BAT service_list_descriptor */
   U16BIT service_type;

   /* Allocated LCN for service */
   U16BIT service_lcn;

   S32BIT nid;

   BOOLEAN hidden;
} S_HBBTV_SERVICE_DETAILS;


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

U8BIT HBBTV_GetDemuxPath(void);

E_HBBTV_ERR HBBTV_GetEventDetails(S32BIT service_index, BOOLEAN porf,
   S_HBBTV_EVENT_DETAILS *details);

void HBBTV_ReleaseEventDetails(S_HBBTV_EVENT_DETAILS *details);

E_HBBTV_ERR HBBTV_GetLCNLocator(U32BIT lcn, S_HBBTV_DVB_LOCATOR *p_dvb_locator);

E_HBBTV_ERR HBBTV_GetNetworkID(U32BIT lcn, U16BIT *nid);

E_HBBTV_ERR HBBTV_GetMajorChannel(U32BIT lcn, U16BIT *major_channel);

E_HBBTV_ERR HBBTV_ObtainComponentList(S_HBBTV_DVB_LOCATOR *locator, E_HBBTV_COMPONENT_TYPE type,
   U32BIT *num_ptr, S_HBBTV_COMPONENT_DETAILS **list_ptr);

void HBBTV_ReleaseComponentList(U32BIT num, S_HBBTV_COMPONENT_DETAILS *list_ptr);

E_HBBTV_ERR HBBTV_ObtainEventList(U32BIT service_index,
   U32BIT *num_ptr, S_HBBTV_EVENT_DETAILS **list_ptr);

void HBBTV_ReleaseEventList(U32BIT num, S_HBBTV_EVENT_DETAILS *list_ptr);

E_HBBTV_ERR HBBTV_ObtainServiceList(U32BIT *num_ptr, S_HBBTV_SERVICE_DETAILS **list_ptr);

void HBBTV_ReleaseServiceList(U32BIT num, S_HBBTV_SERVICE_DETAILS *list_ptr);

E_HBBTV_ERR HBBTV_GetServiceDetails(U16BIT service_lcn, S_HBBTV_SERVICE_DETAILS *details);

void HBBTV_ReleaseServiceDetails(S_HBBTV_SERVICE_DETAILS *details);

U8BIT* HBBTV_GetEventSIDescriptorData(S_HBBTV_DVB_LOCATOR *dvb_locator, U16BIT event_id,
   U8BIT desc_tag_id, S32BIT ext_desc_tag_id, U16BIT *desc_len);

void HBBTV_ReleaseEventSIDescriptorData(U8BIT *desc_data, U16BIT desc_len);

BOOLEAN HBBTV_GetServiceLocked(U16BIT service_lcn);

#endif /* _HBBTV_SIF_SERVICE_H */