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;

/* IP streaming status */
typedef enum
{
   MHEG5_ICS_STATUS_READY,
   MHEG5_ICS_STATUS_PENDING
} E_ICSStatus;

typedef enum
{
   MHEG5_ICS_PIN_SUPPORT_NONE,
   MHEG5_ICS_PIN_SUPPORT_DISABLED,
   MHEG5_ICS_PIN_SUPPORT_ENABLED
} E_ICSPinSupport;

#ifdef INCLUDE_FREESAT
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;
#endif

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

/* A/V component selection for IP streaming */
typedef struct
{
   BOOLEAN audio_active;
   BOOLEAN video_active;
   S32BIT audio_component_tag;
   S32BIT video_component_tag;
   E_VideoTermination video_termination;
} S_ICSComponents;

/* Encryption keys for IP streams */
typedef struct
{
   U16BIT PID;
   U8BIT odd_key[16];
   U8BIT even_key[16];
   U8BIT iv[16];
} S_ICSPidInfo;

typedef struct
{
   S_ICSPidInfo *pid_info;
   U16BIT num_pids;
} S_ICSKeys;

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

E_MhegErr DVB_MhegStreamSetup(U8BIT *pmt, S_ICSKeys *keys, E_ICSStatus *status);

E_MhegErr DVB_MhegStreamSetComponents(S_ICSComponents *components);

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

E_MhegErr DVB_MhegStreamPause(void);

E_MhegErr DVB_MhegStreamResume(void);

E_MhegErr DVB_MhegStreamAudioSetVolume(S32BIT volumeAdjust);

E_MhegErr DVB_MhegStreamStop(void);

E_MhegErr DVB_MhegPromptForGuidance(U8BIT *restriction, BOOLEAN show);

E_MhegErr DVB_MhegGetPINSupport(E_ICSPinSupport *support);

#ifdef INCLUDE_FREESAT

E_MhegErr DVB_MhegIsConnectionAllowed(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*/