MHEG  17.9.0
 All Data Structures Files Functions Variables Typedefs Enumerations Macros Pages
mh5misc.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  * Copyright © 2000 Koninklijke Philips Electronics N.V
5  *
6  * This file is part of a DTVKit Software Component
7  * You are permitted to copy, modify or distribute this file subject to the terms
8  * of the DTVKit 1.0 Licence which can be found in licence.txt or at www.dtvkit.org
9  *
10  * THIS CODE AND INFORMATION ARE PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND,
11  * EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES
12  * OF MERCHANTABILITY AND/OR FITNESS FOR A PARTICULAR PURPOSE.
13  *
14  * If you or your organisation is not a member of DTVKit then you have access
15  * to this source code outside of the terms of the licence agreement
16  * and you are expected to delete this and any associated files immediately.
17  * Further information on DTVKit, membership and terms can be found at www.dtvkit.org
18  *******************************************************************************/
26 #ifndef _MH5MISC_H
27 #define _MH5MISC_H
28 
29 /*---includes for this file--------------------------------------------------*/
30 
31 #include "mh5base.h"
32 #include "dvblocator.h"
33 
34 /*---Constant and macro definitions for public use---------------------------*/
35 
36 /*---Enumerations for public use---------------------------------------------*/
37 
38 /*---Global type defs for public use-----------------------------------------*/
39 
40 /*---Global variable declarations for public use-----------------------------*/
41 
42 /*---Global Function prototypes for public use-------------------------------*/
43 
57 MHEG5Bool MHEG5parseUrl(U8BIT *buffer, U32BIT length,
58  S_DVB_LOCATOR *multiplexRef);
59 
60 
73 MHEG5Int MHEG5GetServiceIndex(MHEG5String *serviceReference);
74 
83 MHEG5String MHEG5GetBootInfo(MHEG5Bool *InfoResultVal);
84 
85 
93 MHEG5Int MHEG5GetDisplayAspectRatio(void);
94 
95 
108 MHEG5Bool MHEG5VideoToGraphics(MHEG5Int videoXval, MHEG5Int videoYval,
109  MHEG5Int *graphicsXVal, MHEG5Int *graphicsYVal);
110 
111 
131 MHEG5Bool MHEG5GetBasicSI(MHEG5Int serviceIndex, MHEG5Int *networkID,
132  MHEG5Int *origNetworkID, MHEG5Int *transportStreamID,
133  MHEG5Int *serviceID);
134 
135 
148 MHEG5Bool MHEG5RequestMPEGDecoder(MHEG5Bool request);
149 
161 void MHEG5SuppressMHEGGraphics(MHEG5Bool request);
162 
163 
170 
171 
177 MHEG5Bool MHEG5getICSupport(MHEG5Int val);
178 
179 #ifdef INCLUDE_IC
180 
188 void MHEG5getICStatus(MHEG5Int *icStatus);
189 
197 void MHEG5clearICStatus(void);
198 void MHEG5changedICStatus(void);
199 
205 void MHEG5isConnectionEnabled(MHEG5Bool *enabled);
206 
207 #ifdef INCLUDE_ICS
208 
213 MHEG5Bool MHEG5IsPinRequired(void);
214 
222 MHEG5Bool MHEG5promptForGuidance(MHEG5String *restriction, MHEG5Bool show);
223 
224 
225 #ifndef INCLUDE_FREESAT
226 
234 MHEG5Bool MHEG5GetPINSupport(MHEG5Int *support);
235 
236 #else /* INCLUDE_FREESAT */
237 
245 MHEG5Bool MHEG5GetFSIServiceReference(MHEG5Int serviceIndex, MHEG5Int *fsi, MHEG5String *fsiString);
246 
247 
255 MHEG5Bool MHEG5GetPINRequirement(MHEG5Int *status);
256 
257 
266 MHEG5Bool MHEG5ValidatePIN(MHEG5String *pin, MHEG5Int *status);
267 
268 
278 MHEG5Bool MHEG5ComputePrivateSignature(MHEG5String *data, MHEG5String *result);
279 
280 #endif /* INCLUDE_FREESAT */
281 
282 #endif /* INCLUDE_ICS */
283 
284 #endif /* INCLUDE_IC */
285 
286 #endif /*_MH5MISC_H*/
Basis MHEG5 data types.
MHEG5Int MHEG5GetServiceIndex(MHEG5String *serviceReference)
Ref:[1] - 3.10.6.1 and [1] - 3.10.6.3 Get the serviceIndex, a positive integer which is used to refer...
Definition: mh5misc.c:206
Definition: mh5base.h:82
void MHEG5SuppressMHEGGraphics(MHEG5Bool request)
Request that the external application toggles between showing MHEG graphics or subtitles This functio...
MHEG5Bool MHEG5parseUrl(U8BIT *buffer, U32BIT length, S_DVB_LOCATOR *multiplexRef)
Parse a DAVIC style multiplex reference or UK-DTT inherritance format URL. This can be one of the fol...
Definition: mh5misc.c:106
Definition: dvblocator.h:30
MHEG5Bool MHEG5VideoToGraphics(MHEG5Int videoXval, MHEG5Int videoYval, MHEG5Int *graphicsXVal, MHEG5Int *graphicsYVal)
Calculate the graphical co-ordinate from a given video coordinate (should take into account the curre...
MHEG5Bool MHEG5RequestMPEGDecoder(MHEG5Bool request)
Requests exclusive access to a MPEG decoder and video plane to display I-frames. The MPEG decoder sha...
void MHEG5restoreReceiverDefaults(void)
Restore receiver defaults as described in section 3.12.10 of the 1.06 profile.
Definition: mh5misc.c:397
MHEG5String MHEG5GetBootInfo(MHEG5Bool *InfoResultVal)
Tell whether a network_boot_info sub-descriptor has been found and received. If so, returns the value of the NB_info field of the network_boot_info sub-descriptor. This function is used by the GetBootInfo resident program. See UK1.06 profile section 3.10.7.3.
Definition: mh5misc.c:244
MHEG5Bool MHEG5getICSupport(MHEG5Int val)
Determines whether the system supports Interaction channel.
MHEG5Bool MHEG5GetBasicSI(MHEG5Int serviceIndex, MHEG5Int *networkID, MHEG5Int *origNetworkID, MHEG5Int *transportStreamID, MHEG5Int *serviceID)
Returns a series of integers representing basic Service Information (SI) about a service. The service is identified by means of a receiver specific "ServiceIndex". This integer can be determined by means of the SI_GetServiceIndex resident program (see 3.10.6.1, "SI_GetServiceIndex", on page 3-20). This function is used by the SI_TuneIndexInfo resident program. See UK1.06 profile section 3.10.6.3.
Definition: mh5misc.c:311
Definition of DVB locator and DVB component types.
MHEG5Int MHEG5GetDisplayAspectRatio(void)
Reads the format of the connected display (4:3 or 16:9) This function is used by the GetDisplayAspect...
Definition: mh5misc.c:280