include/dvbevents.h

Go to the documentation of this file.

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

#include "mherrors.h"

/* Events generated in receiver and passed to MHEG5 engine */
typedef enum
{
   DVB_EVENT_TUNE_OFF,

   /* decoder has started playing an audio stream, 'data' set to 0               */
   DVB_EVENT_AUDIO_STARTED,

   /* decoder has stopped playing an audio stream, 'data' set to 0               */
   DVB_EVENT_AUDIO_STOPPED,

   /* decoder has started playing an audio clip, 'data' set to 0                 */
   DVB_EVENT_SAMPLE_STARTED,

   /* decoder has stopped playing an audio clip, 'data' set to 0                 */
   DVB_EVENT_SAMPLE_STOPPED,

   /* decoder has started playing an video stream, 'data' set to 0               */
   DVB_EVENT_VIDEO_STARTED,

   /* decoder has stopped playing an video stream, 'data' set to 0               */
   DVB_EVENT_VIDEO_STOPPED,

   /* Event raised when */
   DVB_EVENT_TUNE_TO_SERVICE,

   /* demux path for DSM-CC used by presentation engine (live path) has changed  *
    * 'data' set to path value                                                   */
   DVB_EVENT_DEMUX_PATH_CHANGE,

   /* When user video preference causes change to Decoder Format Conversation.   *
    * It is not generated when the broadcast video changes aspect ratio, or when *
    * a change affects only display format conversion.                           *
    * 'data' can be set to Decoder Format Conversion                             */
   DVB_EVENT_VIDEO_PREF_CHANGED,

   /* Network status has changed. 'data' set as defined by E_NETWORK_STATUS      */
   DVB_EVENT_NETWORK_STATUS_CHANGED,

   /* Tell engine that DVP is ready to received streaming data (MHEG5 ICS) */
   DVB_EVENT_STREAMING_READY,

   /* Response to engine request for parental control guidance */
   DVB_EVENT_GUIDANCE_RESPONSE,

   /* Audio description presentation viewer preference changed                   *
    * 'data' value 0 - normal audio, 'data' value 1 - Audio description          */
   DVB_EVENT_AUDIODESC_PREF_CHANGED,

   /* Subtitle presentation viewer preferences changed                           *
    * 'data' value 1 for receiver to display DVB subtitles, value 0 for no subt  */
   DVB_EVENT_SUBTITLE_PREF_CHANGED,

   /* Notifies the MHEG5 engine when the audio language preferences changes      */
   DVB_EVENT_AUDIO_LANG_PREF_CHANGED,

   /* Notifies the MHEG5 engine when the subtitle language preferences change    */
   DVB_EVENT_SUBTITLE_LANG_PREF_CHANGED,

   /* When the list of events to be recorded by the PVR changes.
    * Possible reasons for changes are:
    *           1. event recorded,
    *           2. event cancelled due to conflict.                              */
   DVB_EVENT_PVR_RECORD_LIST_CHANGED,

   /* When the list of events to be recorded by the PVR changes.
    * Possible reasons for changes are:
    *           1. event recorded,
    *           2. event cancelled due to conflict.                              */
   DVB_EVENT_PVR_BOOK_RESULT,

   /* Notifies the MHEG5 engine of the status of the Connected-TV launched 
    * application                                                                */
   DVB_EVENT_APPLICATION_LAUNCH_STATUS,

   /* Non-event - should not be generated                                        */
   DVB_EVENT_NONE,
} E_DvbEvent;

typedef void (*F_NotifyDvbEvent)( E_DvbEvent event, U32BIT data );

E_MhegErr DVB_MhegEventsStart(F_NotifyDvbEvent handler);

E_MhegErr DVB_MhegEventsStop();

#endif /* _DVBEVENTS_H */