mh5queue.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
 * Copyright © 2000 Koninklijke Philips Electronics N.V
 *
 * 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 _MH5QUEUE_H
#define _MH5QUEUE_H

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

#include "mh5action.h"
#include "mh5link.h"
#include "mh5group.h"

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

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

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

typedef enum
{
   EE_GROUP_ID_REF_ERROR = 2,
   EE_CONTENT_REF_ERROR = 3,
   EE_KEYPRESS_TEXT = 4,

   EE_VIDEO_PREF_CHANGED = 6,
   EE_ENGINE_RESUME = 7,
   #if defined(INCLUDE_FREESAT) || defined(INCLUDE_IPLAYER)
   EE_SUBTITLE_PREF_CHANGED = 8,
   #endif

   EE_NETWORK_BOOT_INFO = 9,
   EE_NON_DESTRUCTIVE_TUNE_OK = 10,

   EE_KEYPRESS_CANCEL = 16,

   EE_PVR_LIST_CHANGED = 20,

   EE_KEYPRESS_RED = 100,
   EE_KEYPRESS_GREEN = 101,
   EE_KEYPRESS_YELLOW = 102,
   EE_KEYPRESS_BLUE = 103,

   EE_KEYPRESS_INFO = 105,

   #ifdef INCLUDE_IC
   EE_IC_STATUS_CHANGED = 200,
   EE_IC_LOCAL_ERROR = 201,
   EE_IC_NETWORK_ERROR = 202,
   EE_IC_REMOTE_ERROR = 203,

   #ifdef INCLUDE_ICS
   EE_IC_STREAM_REF_ERROR = 204,
   EE_IC_STREAM_UNDERFLOW = 205,

   #ifdef INCLUDE_FREESAT
   EE_IP_STREAM_ACCESS_ERROR = 206,
   #endif

   #if defined(INCLUDE_FREESAT) || defined(INCLUDE_IPLAYER)
   EE_AUDIO_DESC_PREF_CHANGED = 207,
   #endif

   EE_IC_STREAM_UNDERFLOW_RESUME = 208,
   EE_IC_KEY_FILE_ERROR = 210,

   #endif /* INCLUDE_ICS */
   #endif /* INCLUDE_IC */

   EE_KEYPRESS_EPG = 300,

   EE_AUDIO_LANG_PREF_CHANGED = 301,
   EE_SUBTITLE_LANG_PREF_CHANGED = 302,
} E_ENGINE_EVENT;

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

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


#ifdef MH5PRINTOUT

void MHEG5queuePrint(char *out);
#endif


void MHEG5queueResetScene( MHEG5Root *grp );

void MHEG5queueResolveTargets( MHEG5ActionList actions );

void MHEG5queueUnresolveTargets( MHEG5ActionList actions );

void MHEG5actionListExecute( MHEG5Group *source, MHEG5ActionList actions );


void MHEG5PrependActionList( MHEG5ActionList actions );

void MHEG5AppendActionList( MHEG5ActionList actions );

void MHEG5sendEvent( MHEG5Root *source, MHEG5EventType event, int data );

void MHEG5sendAppEngineEvent( E_ENGINE_EVENT engine_event );

void MHEG5sendSync( MHEG5Root *source, MHEG5EventType event, int data );


void MHEG5stopEventsAndResetQueue(void);


void MHEG5queueEvents(void);


void MHEG5processQueue(void);


void MHEG5enableEventProcessing(MHEG5Bool enable);


void MHEG5eventProcessingReset(void);


void MHEG5requestDisplayUpdate(void);


int  MHEG5InitQueues(void);
void MHEG5ExitQueues(void);

#endif /*_MH5QUEUE_H*/