MHEG5  18.9.0
MHEG5 Documentation
mh5control.h
Go to the documentation of this file.
1 /*******************************************************************************
2  * Copyright © 2014 The DTVKit Open Software Foundation Ltd (www.dtvkit.org)
3  * Copyright © 2004 Ocean Blue Software Ltd
4  *
5  * This file is part of a DTVKit Software Component
6  * You are permitted to copy, modify or distribute this file subject to the terms
7  * of the DTVKit 1.0 Licence which can be found in licence.txt or at www.dtvkit.org
8  *
9  * THIS CODE AND INFORMATION ARE PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND,
10  * EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES
11  * OF MERCHANTABILITY AND/OR FITNESS FOR A PARTICULAR PURPOSE.
12  *
13  * If you or your organisation is not a member of DTVKit then you have access
14  * to this source code outside of the terms of the licence agreement
15  * and you are expected to delete this and any associated files immediately.
16  * Further information on DTVKit, membership and terms can be found at www.dtvkit.org
17  *******************************************************************************/
25 #ifndef _MH5CONTROL_H
26 #define _MH5CONTROL_H
27 
28 /*---includes for this file--------------------------------------------------*/
29 
30 #include "dvb_misc.h"
31 #include "mh5base.h"
32 #include "mheg5_control.h"
33 #include "fs_types.h"
34 #include "glue_queue.h"
35 
36 /*---Constant and macro definitions for public use---------------------------*/
37 
38 #define ISO_639_LANG_CODE_UND (U32BIT)(('u'<<16)|('n'<<8)|'d')/*0x756E64*/
39 #define UND_LANGUAGE_CODE ISO_639_LANG_CODE_UND
40 
41 /*---Enumerations for public use---------------------------------------------*/
42 
43 /*---Global type defs for public use-----------------------------------------*/
44 
45 /*
46  * Values given to MHEG5_Stop for 'action'
47  */
48 typedef enum
49 {
53 } E_StopAction;
54 
55 /*---Global variable declarations for public use-----------------------------*/
56 
57 /*---Global Function prototypes for public use-------------------------------*/
58 
65 
70 void MHEG5_Terminate( void );
71 
79 void MHEG5engineStart( U8BIT *app_name, BOOLEAN isCi, BOOLEAN special );
80 
85 void MHEG5engineTerminate(void);
86 
91 
92 void MHEG5Pause(void);
93 void MHEG5Resume(void);
94 
96 
97 void MHEG5NotifyEngineStarted(void);
99 void MHEG5NotifyEngineQuit(void);
101 void MHEG5StartReboot(void *dummy);
102 E_MhegErr MHEG5ResetResolution(U16BIT screenWidth, U16BIT screenHeight);
103 void MHEG5RefreshDisplay(void);
104 void MHEG5RefreshDefaultAudio(void);
105 
106 #ifdef COMMON_INTERFACE
107 
108 void MHEG5CiAckData(U8BIT *pData);
109 U32BIT MHEG5GetCiModuleId(void);
110 void MHEG5notifyCiCamRemove(U32BIT slot_id);
111 
112 #endif /*COMMON_INTERFACE*/
113 
114 #ifndef CI_PLUS_ONLY
115 
119 
120 void MHEG5AutoPathComplete( E_FsStatus result );
121 
126 void MHEG5engineDsmTerminate(void);
127 
139 MHEG5Bool MHEG5TuneIndex(MHEG5Int serviceIndex);
140 
141 
155 void MHEG5TuneIndexInfo(MHEG5Int tuneInfo);
156 
157 U32BIT MHEG5tuneProcess( S_DvbLocator *pDvbLoc, S32BIT serviceIndex );
158 
159 void MHEG5RefreshStreams(U16BIT service_id);
160 
161 #ifdef INCLUDE_SA_PROFILE
162 void MHEG5StartEpgApp(void);
163 void MHEG5StartInfoApp(BOOLEAN doTimeout);
164 void MHEG5StartListApp(void);
165 #endif /*INCLUDE_SA_PROFILE*/
166 
167 #endif /* CI_PLUS_ONLY*/
168 
169 #endif /* _MH5CONTROL_H */
U32BIT MHEG5tuneProcess(S_DvbLocator *pDvbLoc, S32BIT serviceIndex)
Definition: mh5control.c:955
Basis MHEG5 data types.
void MHEG5engineStart(U8BIT *app_name, BOOLEAN isCi, BOOLEAN special)
Start the engine with the initial application.
Definition: mh5control.c:447
void MHEG5NotifyCarouselLoaded(S_DsmccEvent *param)
Definition: mh5control.c:1037
void MHEG5RefreshStreams(U16BIT service_id)
Definition: mh5control.c:1211
void MHEG5Pause(void)
Definition: mh5control.c:1183
MHEG5 queue.
void MHEG5NotifyCarouselBooted(S_DsmccEvent *param)
Definition: mh5control.c:564
E_MhegErr MHEG5ResetResolution(U16BIT screenWidth, U16BIT screenHeight)
Definition: mh5control.c:329
void MHEG5NotifyCarouselUnload(S_DsmccEvent *param)
Definition: mh5control.c:1061
void MHEG5NotifyEngineStarted(void)
Definition: mh5control.c:545
void MHEG5Resume(void)
Definition: mh5control.c:1191
E_MhegErr
Definition: mherrors.h:28
void MHEG5NotifyEngineQuit(void)
Definition: mh5control.c:679
uint8_t U8BIT
Definition: techtype.h:82
long MHEG5Int
Definition: mh5base.h:73
File System types.
void MHEG5_Terminate(void)
Terminate MHEG5 component.
Definition: mh5control.c:263
This file provides the control interface for MHEG5 engine. The use of this component MUST comply with...
void MHEG5TuneIndexInfo(MHEG5Int tuneInfo)
Sets the way the application expects the receiver is to perform all subsequence application initiated...
Definition: mh5control.c:882
void MHEG5RefreshDefaultAudio(void)
Definition: mh5control.c:1232
void MHEG5StartReboot(void *dummy)
Definition: mh5control.c:1164
short MHEG5Bool
Definition: mh5base.h:71
void MHEG5AutoPathComplete(E_FsStatus result)
Definition: mh5control.c:586
E_StopAction
Definition: mh5control.h:48
int32_t S32BIT
Definition: techtype.h:87
BOOLEAN MHEG5engineIsCiAppRunning(void)
Definition: mh5control.c:1158
E_MhegErr MHEG5Initialise(S_MhegConfig *cfg_params)
initialise MHEG5 component
Definition: mh5control.c:203
uint16_t U16BIT
Definition: techtype.h:84
U8BIT MHEG5HandleEngineStopAction(U8BIT action)
Definition: mh5control.c:1096
BOOLEAN MHEG5ProcessAutoBoot(void)
MHEG5Bool MHEG5TuneIndex(MHEG5Int serviceIndex)
Ref: [1] - 3.10.6.2 Tune to the specified service. If the tuner fails to tune to the service it shoul...
Definition: mh5control.c:852
void MHEG5engineTerminate(void)
Force the engine to terminate.
Definition: mh5control.c:712
void MHEG5RefreshDisplay(void)
Definition: mh5control.c:285
U8BIT BOOLEAN
Definition: techtype.h:99
void MHEG5engineDsmTerminate(void)
Force the engine to terminate any DSM-CC based MHEG application.
Definition: mh5control.c:831
References: [1] UK1 Profile - Digital Terrestrial Television - Requirements for interoperability (The...
void MHEG5NotifyEngineStartFailed(void)
Definition: mh5control.c:640
uint32_t U32BIT
Definition: techtype.h:86
E_FsStatus
Definition: fs_types.h:34