dvb_ics.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_ICS_H
#define _DVB_ICS_H

#include "techtype.h"
#include "mherrors.h"

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

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

/* Video termination attribute */
typedef enum
{
   MHEG5_VIDEO_TERMINATION_FREEZE,
   MHEG5_VIDEO_TERMINATION_DISAPPEAR
} E_VideoTermination;

typedef enum
{
   MHEG5_ICS_PIN_SUPPORT_NONE,
   MHEG5_ICS_PIN_SUPPORT_DISABLED,
   MHEG5_ICS_PIN_SUPPORT_ENABLED
} E_ICSPinSupport;

typedef enum
{
   MHEG5_ICS_PIN_REQ_NEVER,
   MHEG5_ICS_PIN_REQ_GUIDANCE_ONLY,
   MHEG5_ICS_PIN_REQ_ALWAYS
} E_ICSPinReq;

typedef enum
{
   MHEG5_ICS_PIN_STATUS_NOT_REQUIRED,
   MHEG5_ICS_PIN_STATUS_OK,
   MHEG5_ICS_PIN_STATUS_INVALID
} E_ICSPinStatus;

/*Reference: ETSI ES 202 184 section 11.5.4.2 */
typedef enum
{
   ICS_AC_NONE,
   ICS_AC_AAC_ADTS,     /* ISO/IEC 13818-7 */
   ICS_AC_HE_AAC_LATM,  /* ISO/IEC 14496-3 */
   ICS_AC_EAC3,         /* TS 102 366 */
} E_ICSAudioCodec;

/*Reference: ETSI ES 202 184 section 11.5.4.1 */
typedef enum
{
   ICS_VC_NONE,
   ICS_VC_H264,
} E_ICSVideoCodec;

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

/* Encryption keys for IP streams */
typedef struct
{
   U8BIT odd[32];
   U8BIT even[32];
} S_ICSPidKeys;

typedef struct
{
   U16BIT composition;
   U16BIT ancillary;
} S_ICSSubtPage;

/*Information on all audio and subtitle streams - for each language*/
typedef struct
{
   U32BIT lang_code; /*language code*/
   U16BIT pid;       /*stream pid*/
   U8BIT a_type;     /*when non-zero is audio type */
   U8BIT s_type;     /*when non-zero is subtitle type */
   union {
      E_ICSAudioCodec codec;
      S_ICSSubtPage page;
   } u;
} S_ICSLangInfo;

typedef struct s_StreamPids
{
   U16BIT pcr_pid;
   U16BIT audio_pid;
   U16BIT video_pid;
   U16BIT subtitle_pid;
   U16BIT info_num;
   S_ICSLangInfo *info_ptr;
} S_StreamPids;

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

E_MhegErr DVB_MhegICStreamSetup(S_StreamPids pids, S_ICSPidKeys *audio_keys,
   S_ICSPidKeys *video_keys, E_VideoTermination video_termination,
   E_ICSAudioCodec audio_codec, E_ICSVideoCodec video_codec );

U32BIT DVB_MhegICStreamHandleData(U8BIT *data, U32BIT len, BOOLEAN last);

E_MhegErr DVB_MhegICStreamRelease(void);

E_MhegErr DVB_MhegICStreamPause(void);

E_MhegErr DVB_MhegICStreamResume(void);

E_MhegErr DVB_MhegICStreamAudioSetVolume(S32BIT volumeAdjust);

E_MhegErr DVB_MhegPromptForGuidance(U8BIT *restriction, BOOLEAN show);

E_MhegErr DVB_MhegGetPINSupport(E_ICSPinSupport *support);

#ifdef INCLUDE_FREESAT

E_MhegErr DVB_MhegIsConnectionAllowed(S32BIT service_index, BOOLEAN *pAllowed);

E_MhegErr DVB_MhegGetPINRequirement(E_ICSPinReq *status);

E_MhegErr DVB_MhegValidatePIN(U8BIT *pin, E_ICSPinStatus *status);

E_MhegErr DVB_MhegGetMACAddress(U8BIT address[6]);

E_MhegErr DVB_MhegGetPrivateKey(U8BIT *buffer, U16BIT bufsize,
   U16BIT *keylen, U32BIT *version);

#endif /* INCLUDE_FREESAT */

#endif /*_DVB_ICS_H*/