hbbtv_api.h

Go to the documentation of this file.

/*******************************************************************************
 * Copyright © 2017 The DTVKit Open Software Foundation Ltd (www.dtvkit.org)
 * Copyright © 2011 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_API_H
#define _HBBTV_API_H

#include "techtype.h"

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

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

typedef enum
{
   /* Following status values are consistent with error state table in OIPF spec Vol 5, section 7.13.1.2 */
   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_CANNOT_RESOLVE_URI,
   HBBTV_CHANNEL_CHANGE_INSUFFICIENT_BANDWIDTH,
   HBBTV_CHANNEL_CHANGE_CANNOT_BE_CHANGED,
   HBBTV_CHANNEL_CHANGE_INSUFFICIENT_RESOURCES,
   HBBTV_CHANNEL_CHANGE_CHANNEL_NOT_IN_TS,
   HBBTV_CHANNEL_CHANGE_UNKNOWN_ERROR = 100,
   HBBTV_CHANNEL_CHANGE_BAD_SIGNAL,
   /* Remaining status values relate to play state table in OIPF spec Vol 5, section 7.13.1.2 (values offset by 128) */
   HBBTV_CHANNEL_CHANGE_RECOVERING = 128,
   HBBTV_CHANNEL_CHANGE_STARTING   = 129,
   HBBTV_CHANNEL_CHANGE_SUCCEEDED  = 130,
   HBBTV_CHANNEL_CHANGE_STOPPED    = 131,
} E_HBBTV_CHANNEL_CHANGE_STATUS;

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_COMPONENT_TYPE_VIDEO    = 0x1,
   HBBTV_COMPONENT_TYPE_AUDIO    = 0x2,
   HBBTV_COMPONENT_TYPE_SUBTITLE = 0x4,
   HBBTV_COMPONENT_TYPE_OTHER    = 0x8
} E_HBBTV_COMPONENT_TYPE;

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

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

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

void HBBTV_NotifyServiceListChange(void);

void HBBTV_NotifyParentalRatingChange(BOOLEAN blocked);

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

void HBBTV_NotifyStreamsChange(U16BIT onet_id, U16BIT trans_id, U16BIT serv_id,
   E_HBBTV_COMPONENT_TYPE component_type);

void HBBTV_NotifyProgrammeChanged(void);

void HBBTV_NotifyRecordingEvent(U32BIT id, E_HBBTV_RECORDING_EVENT event);

void HBBTV_NotifyPlaySpeedChanged(S16BIT speed);

#endif