dvb_service.h

Go to the documentation of this file.

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

#include "techtype.h"
#include "dtvstring.h"
#include "dmxtype.h"
#include "dvblocator.h"
#include "mherrors.h"

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

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

typedef enum
{
   SRV_TYP_ALL,     /* All or any service type */
   SRV_TYP_TV_DATA, /* TV (including data) service type */
   SRV_TYP_RADIO    /* Radio service type */
} E_ServiceType;

typedef enum {
   SRV_NORMAL_TUNE,
   SRV_QUIET_TUNE,
   SRV_KEEP_APP_RUNING,
   SRV_QUIET_KEEP_APP
} E_TuningFlags;

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

/* Basic SI structure */
typedef struct
{
   /* Identifier of original broadcast network */
   U16BIT original_network_id;
   /* Identifier of transport stream */
   U16BIT transport_stream_id;
   /* Service identification information */
   U16BIT service_id;
   /* Identifier of broadcast network */
   U16BIT network_id;
} S_DvbLocation;

typedef void (*F_NotifyDvbTuning)(S32BIT serviceIndex, E_TuningFlags flags);

#if defined INCLUDE_SI_EXTENSION
typedef enum
{
   /* Subtitle stream is present */
   MHEG5_COMPONENT_SUBTITLES,

   /* Audio Description is available */
   MHEG5_COMPONENT_AUDIO_DESC,

   /* The service contains audio streams with more than one audio language */
   MHEG5_COMPONENT_ALT_LANG,

   /* Any audio stream is Dolby Digital or Dolby Digital Plus (AC-3/E-AC-3) */
   MHEG5_COMPONENT_DOLBY,

   /* Video component is either MPEG-2 high definition video, or H.264 */
   MHEG5_COMPONENT_HD
} E_ComponentKey;

typedef struct
{
   U32BIT serviceIndex;

   /* Service name, from the SDT service_descriptor */
   S_STRING serviceName;

   /* Service Provider name, from the SDT service_descriptor */
   S_STRING serviceProvider;

   /* Service type, from the SDT service_descriptor */
   U16BIT serviceType;

   /* Allocated LCN for service */
   U16BIT serviceLcn;
} S_ServiceDetails;

typedef struct
{
   U16BIT hours;
   U8BIT minutes;
   U8BIT seconds;
} S_Time;

typedef struct s_eventdetails
{
   void *dvb_user_data; /* Available for DVB stack - not used by MHEG5 */

   /* Event name, from the EIT short_event_descriptor */
   S_STRING eventName;

   /* Event description, from the EIT short_event_descriptor */
   S_STRING shortDescription;

   /* Event parental rating, from the EIT parental_rating_descriptor
      formatted as it is in parental_rating_descriptor*/
   U32BIT parentalRating;

   /* Event start date, in Modified Julian Date format - as per EIT field */
   U32BIT startDate;

   /* Event start time, from the EIT start_time field*/
   S_Time startTime;

   /* Event duration, from the EIT duration field,
      as formatted in the EIT*/
   S_Time duration;

   /* Event Category string, from the EIT content_descriptor (see Ref [2])
    * ONLY give bytes containing
    *    'content_nibble_level_1' and 'content_nibble_level_2'
    * 'user_data' byte(s) should be ignored.
    * Note that content_descriptor can have more than one iteration - depending
    * on descriptor length.
    */
   S_STRING category;

   /* Free-content flag, TRUE if content is free, FALSE if content is CA controlled
      from EIT free_CA_mode field*/
   BOOLEAN freeNotCA;
} S_EventDetails;

#endif /*SI Extension*/

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

DMXREF DVB_MhegGetDemuxPath(void);

E_MhegErr DVB_MhegGetTunedService(S32BIT *serviceIndex);

E_MhegErr DVB_MhegDvbLocatorToIndex(S_DvbLocator *pDvbLocator, S32BIT *pServiceIndex);

E_MhegErr DVB_MhegIndexToDvbLocator( S32BIT serviceIndex, S_DvbLocator *location );

E_MhegErr DVB_MhegIndexToDvbLocation( S32BIT serviceIndex, S_DvbLocation *pDvbLocation );

E_MhegErr DVB_MhegLcnToDvbLocator( U32BIT lcn, S_DvbLocator *pDvbLocator);

E_MhegErr DVB_MhegTuneIndex(S32BIT serviceIndex);

void DVB_MhegServiceAddPmtListen(S_DvbLocator dvbLocator);

void DVB_MhegServiceRemovePmtListen(S_DvbLocator dvbLocator);

void DVB_MhegRegisterDvbTuning( F_NotifyDvbTuning cb_func );

#ifdef INCLUDE_SI_EXTENSION

E_MhegErr DVB_MhegGetServiceDetails( S32BIT serviceIndex,
   S_ServiceDetails *details );

void DVB_MhegReleaseServiceDetails( S_ServiceDetails *details );

E_MhegErr DVB_MhegGetEventDetails( S32BIT serviceIndex, BOOLEAN porf,
   S_EventDetails *details );

void DVB_MhegReleaseEventDetails( S_EventDetails *details );

#ifdef INCLUDE_SA_PROFILE

E_MhegErr DVB_MhegGetNumberOfServices(S32BIT *number);

E_MhegErr DVB_MhegPrevServiceIndex(S32BIT *serviceIndex, E_ServiceType type);

E_MhegErr DVB_MhegNextServiceIndex(S32BIT *serviceIndex, E_ServiceType type);

E_MhegErr DVB_MhegGetServiceRunningStatus(S32BIT serviceIndex,
   U8BIT *runningStatus);

E_MhegErr DVB_MhegGetChannelNumber(S32BIT serviceIndex, S32BIT *channelNum);

E_MhegErr DVB_MhegGetEventId( S32BIT serviceIndex, BOOLEAN porf, S32BIT *eventId );

E_MhegErr DVB_MhegSetEventIterator(S32BIT serviceIndex, S32BIT startDate,
   S32BIT startTime, S32BIT *eventId);

E_MhegErr DVB_MhegIncrementEventIterator(S32BIT *eventId);

E_MhegErr DVB_MhegGetScheduledEventDetails(S32BIT serviceIndex,
   S32BIT eventId,
   BOOLEAN *result,
   S_EventDetails *details);

E_MhegErr DVB_MhegGetComponentInfo(S32BIT serviceIndex, S32BIT eventId,
   BOOLEAN *result, E_ComponentKey key,
   BOOLEAN *value);

E_MhegErr DVB_MhegGetComponentData(S32BIT serviceIndex, S32BIT eventId,
   BOOLEAN *result, U8BIT *strCont,
   U8BIT *contType, U8BIT *lang);

E_ServiceType DVB_MhegGetServiceMode(void);

#endif  /* INCLUDE_SA_PROFILE */

#endif  /* INCLUDE_SI_EXTENSION */

#ifdef INCLUDE_FREESAT

E_MhegErr DVB_MhegGetCurrentFSI(U16BIT *fsi);

E_MhegErr DVB_MhegGetFSILocator(U16BIT fsi, S_DVB_LOCATOR *pDvbLocator);

E_MhegErr DVB_MhegCurrentServiceIsInGroup(U16BIT groupIdentifier, BOOLEAN *inGroup);

E_MhegErr DVB_MhegGetFSIServiceReference(S32BIT serviceIndex, U16BIT *fsi);

#endif /*INCLUDE_FREESAT*/

#endif /* _DVB_SERVICE_H */