hbbtv.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_H

#define _HBBTV_H

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

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

#define HBBTV_DBG_THBBAPI   1
#define HBBTV_DBG_TAIT      (1 << 2)
#define HBBTV_DBG_TKEYS     (1 << 3)
#define HBBTV_DBG_TAPP      (1 << 4)
#define HBBTV_DBG_TPVR      (1 << 5)
#define HBBTV_DBG_TAV       (1 << 6)
#define HBBTV_DBG_TOBJS     (1 << 7)
#define HBBTV_DBG_TSTRMEV   (1 << 8)
#define HBBTV_DBG_TVB       (1 << 9)
#define HBBTV_DBG_TCHN      (1 << 10)
#define HBBTV_DBG_TAVC      (1 << 11)
#define HBBTV_DBG_TSRCH     (1 << 12)
#define HBBTV_DBG_TDRM      (1 << 13)

#define HBBTV_CAP_DL 1

#define HBBTV_CAP_PVR 2

#define HBBTV_CAP_DRM 4


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

typedef enum
{
   HBBTV_CHANNEL_CHANGE_SUCCEEDED,
   HBBTV_CHANNEL_CHANGE_WRONG_TUNER,
   HBBTV_CHANNEL_CHANGE_NO_SIGNAL,
   HBBTV_CHANNEL_CHANGE_TUNER_IN_USE,
   HBBTV_CHANNEL_CHANGE_PARENTAL_LOCKED,
   HBBTV_CHANNEL_CHANGE_ENCRYPTED,
   HBBTV_CHANNEL_CHANGE_UNKNOWN_CHANNEL,
   HBBTV_CHANNEL_CHANGE_INTERRUPTED,
   HBBTV_CHANNEL_CHANGE_RECORDING_IN_PROGRESS,
   HBBTV_CHANNEL_CHANGE_INSUFFICIENT_RESOURCES,
   HBBTV_CHANNEL_CHANGE_CHANNEL_NOT_IN_TS,
   HBBTV_CHANNEL_CHANGE_UNKNOWN_ERROR
} E_HBBTV_CHANNEL_CHANGE_STATUS;

typedef enum
{
   HBBTV_MP_STOPPED = 0,
   HBBTV_MP_PLAYING,
   HBBTV_MP_PAUSED,
   HBBTV_MP_CONNECTING,
   HBBTV_MP_BUFFERING,
   HBBTV_MP_EOF,
   HBBTV_MP_ERROR
} E_HBBTV_MP_STATE;

typedef enum
{
   HBBTV_RECPLAYER_STOPPED,
   HBBTV_RECPLAYER_PLAYING,
   HBBTV_RECPLAYER_PAUSED,
   HBBTV_RECPLAYER_BUFFERING,
   HBBTV_RECPLAYER_EOF,
   HBBTV_RECPLAYER_ERROR
} E_HBBTV_RECPLAYER_STATE;

typedef enum
{
   HBBTV_RECORDING_NEWLY_SCHEDULED,
   HBBTV_RECORDING_ABOUT_TO_START,
   HBBTV_RECORDING_ACQUIRING_RESOURCES,
   HBBTV_RECORDING_STARTED,
   HBBTV_RECORDING_UPDATED,
   HBBTV_RECORDING_COMPLETED,
   HBBTV_RECORDING_PART_COMPLETED,
   HBBTV_RECORDING_FAILED_RESOURCE_LIMITATION,
   HBBTV_RECORDING_FAILED_INSUFFICIENT_STORAGE,
   HBBTV_RECORDING_FAILED_TUNER_CONFLICT,
   HBBTV_RECORDING_FAILED_NOT_ALLOWED,
   HBBTV_RECORDING_FAILED_UNKNOWN_ERROR,
   HBBTV_RECORDING_DELETED,
   HBBTV_RECORDING_TS_STARTING,           /* Timeshift related events */
   HBBTV_RECORDING_TS_STARTED,
   HBBTV_RECORDING_TS_STOPPED,
   HBBTV_RECORDING_TS_NOT_POSSIBLE,
   HBBTV_RECORDING_TS_NOT_ALLOWED,
   HBBTV_RECORDING_TS_FAILED
} E_HBBTV_RECORDING_EVENT;

typedef enum
{
   HBBTV_STRING_FORMAT_SI,
   HBBTV_STRING_FORMAT_HBBTV
} E_HBBTV_STRING_FORMAT;

typedef enum
{
   HBBTV_DRM_NO_LICENSE, 
   HBBTV_DRM_INVALID_LICENSE,
   HBBTV_DRM_VALID_LICENSE
} E_HBBTV_DRM_ERROR_STATE;

/*---Global type defs for public use-------------------------------------------*/
typedef struct
{
   U32BIT org_id;
   U16BIT app_id;
   U8BIT *name;
} S_HBBTV_BROADCAST_APP;

typedef void (*F_HBBTV_DRM_SEND)(U8BIT *message, U32BIT length, U32BIT id, void *user_data);

typedef void (*F_HBBTV_DSMCC_FILE_CALLBACK)(void* user_data, U32BIT err, U8BIT* data, U32BIT size);


/*---Global Function prototypes for public use---------------------------------*/
E_HBBTV_ERR HBBTV_Initialise(U32BIT task_priority, E_HBBTV_STRING_FORMAT string_format,
   U8BIT options);

void HBBTV_Finalise(void);

void HBBTV_Start(S_HBBTV_DVB_LOCATOR *p_dvb_locator);

void HBBTV_Stop(void);

E_HBBTV_ERR HBBTV_HbbTvSetUrl(const U8BIT *url);

E_HBBTV_ERR HBBTV_GetBroadcastAppList(S_HBBTV_BROADCAST_APP **apps, U32BIT *total);

void HBBTV_ReleaseAppList(S_HBBTV_BROADCAST_APP *apps);

E_HBBTV_ERR HBBTV_LaunchApplication(U32BIT org_id, U16BIT app_id);

E_HBBTV_ERR HBBTV_NotifyKeyPress(E_HBBTV_KEY key);

E_HBBTV_ERR HBBTV_ProcessAitSection(U16BIT service_id, U8BIT *data, U32BIT nbytes);

E_HBBTV_ERR HBBTV_NotifyServiceListChange(void);

E_HBBTV_ERR HBBTV_NotifyParentalRatingChange(BOOLEAN blocked);

E_HBBTV_ERR HBBTV_NotifyChannelChangeStatus(U16BIT onet_id, U16BIT trans_id, U16BIT serv_id,
   E_HBBTV_CHANNEL_CHANGE_STATUS status);

E_HBBTV_ERR HBBTV_NotifyProgrammeChanged(void);

E_HBBTV_ERR HBBTV_NotifyVideoAspectRatio(E_HBBTV_ASPECT_RATIO ratio);

void HBBTV_MPNotifyState(void *ihdl, E_HBBTV_MP_STATE state);

E_HBBTV_ERR HBBTV_NotifyRecordingEvent(U32BIT id, E_HBBTV_RECORDING_EVENT event);

E_HBBTV_ERR HBBTV_NotifyRecordingPlayerState(void *ihdl, E_HBBTV_RECPLAYER_STATE state);

E_HBBTV_ERR HBBTV_DRMRegister(U16BIT ca_system_id, F_HBBTV_DRM_SEND send_function, void *user_data);

void HBBTV_DRMUnregister(U16BIT ca_system_id);

E_HBBTV_ERR HBBTV_NotifyDRMMessageResult(U32BIT id, U8BIT *message, U32BIT length, U8BIT result_code);

E_HBBTV_ERR HBBTV_NotifyDRMSystemMessage(U8BIT *message, U32BIT length, U16BIT ca_system_id);

E_HBBTV_ERR HBBTV_NotifyDRMRightsError(E_HBBTV_DRM_ERROR_STATE error_state, U16BIT ca_system_id, 
   U8BIT *rights_issuer_url, U32BIT rights_issuer_length);

E_HBBTV_ERR HBBTV_NotifyLowMemory(void);

void HBBTV_DBGSetMask(U32BIT debug_mask);

E_HBBTV_ERR HBBTV_SetSystemInfo(S_HBBTV_SYSTEM_INFO *info);

void HBBTV_DsmccSetCallback(F_HBBTV_DSMCC_FILE_CALLBACK func);

void HBBTV_DsmccRequestFile(void *user_data, U8BIT* url);

#endif /* _HBBTV_H */