app.h

Go to the documentation of this file.

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

#include "techtype.h"

//---CONSTANT DEFINITIONS---------------------------------------------------------------------------
// application events
#define EV_SERVICE_NOT_RUNNING         0x0001
#define EV_SERVICE_AUDIO_PID_UPDATE    0x0002
#define EV_SERVICE_VIDEO_PID_UPDATE    0x0003
#define EV_SERVICE_SUBTITLE_UPDATE     0x0004
#define EV_SERVICE_SCRAMBLE_CHANGE     0x0005
#define EV_SERVICE_ANALOG_LOCKED       0x0006
#define EV_INDICATION_STATUS           0x0007
#define EV_SERVICE_ANALOG_STARTED      0x0008
#define EV_SERVICE_RUNNING             0x0009
#define EV_SERVICE_EIT_NOW_UPDATE      0x000a
#define EV_SERVICE_EIT_SCHED_UPDATE    0x000b
#define EV_SERVICE_ECM_PID_UPDATE      0x000c
#define EV_PVR_RECORDING_FAILED        0x000d
#define EV_SERVICE_VIDEO_CODEC_CHANGED 0x000e
#define EV_SERVICE_AUDIO_CODEC_CHANGED 0x000f
#define EV_SERVICE_CHANGED             0x0010
#define EV_SERVICE_STREAMS_CHANGED     0x0011
#define EV_SERVICE_SI_PID_UPDATE       0x0012
#define EV_TIME_CHANGED                0x0013
#define EV_CIPLUS_TUNE_COMPLETED       0x0014
#define EV_SERVICE_DELETED             0x0015
#define EV_TIMER_TRIGGERED             0x0016
#define EV_DECODE_PAUSED               0x0017
#define EV_DECODE_RESUMED              0x0018
#define EV_SWITCH_ALTERNATIVE_SERVICE  0x0019
#define EV_SERVICE_UPDATED             0x001a
#define EV_START_SERVICE_SEARCH        0x001b
#define EV_START_SSU_SEARCH            0x001c
#define EV_SERVICE_SI_SDT_UPDATE       0x0020
#define EV_SERVICE_SI_NIT_UPDATE       0x0021
#define EV_PVR_RECORDING_STARTED       0x0022
#define EV_PVR_RECORDING_STOPPED       0x0023

#define APP_EVENT_SERVICE_NOT_RUNNING           EVENT_CODE(EV_CLASS_APPLICATION, EV_SERVICE_NOT_RUNNING)
#define APP_EVENT_SERVICE_AUDIO_PID_UPDATE      EVENT_CODE(EV_CLASS_APPLICATION, EV_SERVICE_AUDIO_PID_UPDATE)
#define APP_EVENT_SERVICE_VIDEO_PID_UPDATE      EVENT_CODE(EV_CLASS_APPLICATION, EV_SERVICE_VIDEO_PID_UPDATE)
#define APP_EVENT_SERVICE_SUBTITLE_UPDATE       EVENT_CODE(EV_CLASS_APPLICATION, EV_SERVICE_SUBTITLE_UPDATE)
#define APP_EVENT_SERVICE_SCRAMBLE_CHANGE       EVENT_CODE(EV_CLASS_APPLICATION, EV_SERVICE_SCRAMBLE_CHANGE)
#define APP_EVENT_SERVICE_ANALOG_LOCKED         EVENT_CODE(EV_CLASS_APPLICATION, EV_SERVICE_ANALOG_LOCKED)
#define APP_EVENT_SERVICE_ANALOG_STARTED        EVENT_CODE(EV_CLASS_APPLICATION, EV_SERVICE_ANALOG_STARTED)
#define APP_EVENT_INDICATION_STATUS             EVENT_CODE(EV_CLASS_APPLICATION, EV_INDICATION_STATUS)
#define APP_EVENT_SERVICE_RUNNING               EVENT_CODE(EV_CLASS_APPLICATION, EV_SERVICE_RUNNING)
#define APP_EVENT_SERVICE_EIT_NOW_UPDATE        EVENT_CODE(EV_CLASS_APPLICATION, EV_SERVICE_EIT_NOW_UPDATE)
#define APP_EVENT_SERVICE_EIT_SCHED_UPDATE      EVENT_CODE(EV_CLASS_APPLICATION, EV_SERVICE_EIT_SCHED_UPDATE)
#define APP_EVENT_SERVICE_ECM_PID_UPDATE        EVENT_CODE(EV_CLASS_APPLICATION, EV_SERVICE_ECM_PID_UPDATE)
#define APP_EVENT_PVR_RECORDING_FAILED          EVENT_CODE(EV_CLASS_APPLICATION, EV_PVR_RECORDING_FAILED)
#define APP_EVENT_SERVICE_VIDEO_CODEC_CHANGED   EVENT_CODE(EV_CLASS_APPLICATION, EV_SERVICE_VIDEO_CODEC_CHANGED)
#define APP_EVENT_SERVICE_AUDIO_CODEC_CHANGED   EVENT_CODE(EV_CLASS_APPLICATION, EV_SERVICE_AUDIO_CODEC_CHANGED)
#define APP_EVENT_SERVICE_CHANGED               EVENT_CODE(EV_CLASS_APPLICATION, EV_SERVICE_CHANGED)
#define APP_EVENT_SERVICE_STREAMS_CHANGED       EVENT_CODE(EV_CLASS_APPLICATION, EV_SERVICE_STREAMS_CHANGED)
#define APP_EVENT_SERVICE_SI_PID_UPDATE         EVENT_CODE(EV_CLASS_APPLICATION, EV_SERVICE_SI_PID_UPDATE)
#define APP_EVENT_TIME_CHANGED                  EVENT_CODE(EV_CLASS_APPLICATION, EV_TIME_CHANGED)
#define APP_EVENT_CIPLUS_TUNE_COMPLETED         EVENT_CODE(EV_CLASS_APPLICATION, EV_CIPLUS_TUNE_COMPLETED)
#define APP_EVENT_SERVICE_DELETED               EVENT_CODE(EV_CLASS_APPLICATION, EV_SERVICE_DELETED)
#define APP_EVENT_TIMER_TRIGGERED               EVENT_CODE(EV_CLASS_APPLICATION, EV_TIMER_TRIGGERED)
#define APP_EVENT_DECODE_PAUSED                 EVENT_CODE(EV_CLASS_APPLICATION, EV_DECODE_PAUSED)
#define APP_EVENT_DECODE_RESUMED                EVENT_CODE(EV_CLASS_APPLICATION, EV_DECODE_RESUMED)
#define APP_EVENT_SWITCH_ALTERNATIVE_SERVICE    EVENT_CODE(EV_CLASS_APPLICATION, EV_SWITCH_ALTERNATIVE_SERVICE)
#define APP_EVENT_SERVICE_UPDATED               EVENT_CODE(EV_CLASS_APPLICATION, EV_SERVICE_UPDATED)
#define APP_EVENT_START_SERVICE_SEARCH          EVENT_CODE(EV_CLASS_APPLICATION, EV_START_SERVICE_SEARCH)
#define APP_EVENT_START_SSU_SEARCH              EVENT_CODE(EV_CLASS_APPLICATION, EV_START_SSU_SEARCH)
#define APP_EVENT_SERVICE_SI_SDT_UPDATE         EVENT_CODE(EV_CLASS_APPLICATION, EV_SERVICE_SI_SDT_UPDATE)
#define APP_EVENT_SERVICE_SI_NIT_UPDATE         EVENT_CODE(EV_CLASS_APPLICATION, EV_SERVICE_SI_NIT_UPDATE)
#define APP_EVENT_PVR_RECORDING_STARTED         EVENT_CODE(EV_CLASS_APPLICATION, EV_PVR_RECORDING_STARTED)
#define APP_EVENT_PVR_RECORDING_STOPPED         EVENT_CODE(EV_CLASS_APPLICATION, EV_PVR_RECORDING_STOPPED)

#define DISK_NAME_LEN               40    /* Max length for the name of a disk */

//---TYPEDEFS-STRUCTS-ENUMERATIONS------------------------------------------------------------------
typedef enum
{
   ACB_GET_SUBTITLE_PREF,
   ACB_GET_AD_PREF,
   ACB_GET_UI_LANG_PREF,
   ACB_GET_UI_BANNER_TRANSPARENCY,
   ACB_GET_UI_BANNER_TIMEOUT,
   ACB_GET_UI_SERVICE_MODE,
   ACB_NUM_INFO_TYPES
} E_ACB_INFO_TYPE;

typedef enum
{
   ACB_SERVICE_LIST_ALL,     /* All or any service type */
   ACB_SERVICE_LIST_TV_DATA, /* TV (including data) service type */
   ACB_SERVICE_LIST_RADIO    /* Radio service type */
} E_ACB_SERVICE_LIST_TYPE;

typedef struct
{
   BOOLEAN pref;
} S_ACB_SUBTITLE_PREF;

typedef struct
{
   BOOLEAN pref;
} S_ACB_AD_PREF;

typedef struct
{
   E_ACB_INFO_TYPE type;
   union
   {
      S_ACB_SUBTITLE_PREF subtitle;
      S_ACB_AD_PREF ad;
      U8BIT ui_lang_id;
      S32BIT banner_transparency;
      S32BIT banner_timeout;
      E_ACB_SERVICE_LIST_TYPE serv_type;
   } u;
} S_ACB_UI_INFO;

typedef enum
{
   DVB_INIT_NO_TELETEXT_OR_SUBTITLES,
   DVB_INIT_TELETEXT_ONLY,
   DVB_INIT_SUBTITLES_ONLY,
   DVB_INIT_TELETEXT_AND_SUBTITLES
} E_DVB_INIT_SUBS_TTXT;

/*!**************************************************************************
 * @brief   Callback function implemented in the UI. This function is called
 *          by the DVB module to query values defined in the UI (e.g. user
 *          preferences)
 * @param   S_ACB_UI_INFO (IN/OUT) pointer to the structure that contains
 *          the type of request and other fields to exchange information
 *          between the DVB and the UI. These fields can be input or output
 *          values depending on the query type.
 * @return  TRUE if the information is returned, FALSE otherwise
 ****************************************************************************/
typedef BOOLEAN (*ACB_INFO_CALLBACK)(S_ACB_UI_INFO *info);

typedef void (*DVB_EVENT_HANDLER)(U32BIT event, void *event_data, U32BIT data_size);

//---DEFINE THE GLOBAL VARIABLES--------------------------------------------------------------------

//---FUNCTION PROTOTYPES----------------------------------------------------------------------------

BOOLEAN APP_InitialiseDVB(DVB_EVENT_HANDLER event_handler, E_DVB_INIT_SUBS_TTXT subs_ttxt);

#if 0
void APP_TerminateDVB(void);
#endif

BOOLEAN APP_RegisterDVBEventHandler(DVB_EVENT_HANDLER event_handler);

BOOLEAN APP_UnregisterDVBEventHandler(DVB_EVENT_HANDLER event_handler);

// version string/Number retrieval
U8BIT* App_GetVersionString(void);
U32BIT App_GetVersionNumber(void);

void APP_RegisterUIInfoCallback(ACB_INFO_CALLBACK ui_info_callback);

void APP_SetClassifyRepeatEvents(BOOLEAN enable);

#endif //  _APP_H
//**************************************************************************************************
// End of File
//**************************************************************************************************