mh5control.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 _MH5CONTROL_H
#define _MH5CONTROL_H

/*---includes for this file--------------------------------------------------*/

#include "dvb_misc.h"
#include "mh5base.h"
#include "mheg5_control.h"
#include "fs_types.h"
#include "glue_queue.h"

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

#define ISO_639_LANG_CODE_UND (U32BIT)(('u'<<16)|('n'<<8)|'d')/*0x756E64*/
#define UND_LANGUAGE_CODE ISO_639_LANG_CODE_UND

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

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

/*
 * Values given to MHEG5_Stop for 'action'
 */
typedef enum
{
   STOP_ACTION_CLEAR_DSMCC,
   STOP_ACTION_MHEG_TUNE,
   STOP_ACTION_CI_PLUS_NDT,
} E_StopAction;

/*---Global variable declarations for public use-----------------------------*/

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

E_MhegErr MHEG5Initialise( S_MhegConfig *cfg_params );

void MHEG5_Terminate( void );

void MHEG5engineStart( U8BIT *app_name, BOOLEAN isCi, BOOLEAN special );

void MHEG5engineTerminate(void);

BOOLEAN MHEG5engineIsCiAppRunning(void);

void MHEG5Pause(void);
void MHEG5Resume(void);

U8BIT MHEG5HandleEngineStopAction( U8BIT action );

void MHEG5NotifyEngineStarted(void);
void MHEG5NotifyEngineStartFailed(void);
void MHEG5NotifyEngineQuit(void);
BOOLEAN MHEG5ProcessAutoBoot(void);
void MHEG5StartReboot(void *dummy);
E_MhegErr MHEG5ResetResolution(U16BIT screenWidth, U16BIT screenHeight);
void MHEG5RefreshDisplay(void);
void MHEG5RefreshDefaultAudio(void);

#ifdef COMMON_INTERFACE

void MHEG5CiAckData(U8BIT *pData);
U32BIT MHEG5GetCiModuleId(void);
void MHEG5notifyCiCamRemove(U32BIT slot_id);

#endif /*COMMON_INTERFACE*/

#ifndef CI_PLUS_ONLY

void MHEG5NotifyCarouselBooted(S_DsmccEvent *param);
void MHEG5NotifyCarouselLoaded(S_DsmccEvent *param);
void MHEG5NotifyCarouselUnload(S_DsmccEvent *param);

void MHEG5AutoPathComplete( E_FsStatus result );

void MHEG5engineDsmTerminate(void);

MHEG5Bool MHEG5TuneIndex(MHEG5Int serviceIndex);


void MHEG5TuneIndexInfo(MHEG5Int tuneInfo);

void MHEG5RefreshStreams(U16BIT service_id);

#ifdef INCLUDE_SA_PROFILE
void MHEG5StartEpgApp(void);
void MHEG5StartInfoApp(BOOLEAN doTimeout);
void MHEG5StartListApp(void);
#endif /*INCLUDE_SA_PROFILE*/

#endif /* CI_PLUS_ONLY*/

U32BIT MHEG5tuneProcess( S_DvbLocator *pDvbLoc, S32BIT serviceIndex );

#endif /* _MH5CONTROL_H */