platform/inc/stbhwdmx.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
 *
 * 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
 *******************************************************************************/
// pre-processor mechanism so multiple inclusions don't cause compilation error

#ifndef _STBHWDMX_H

#define _STBHWDMX_H

//---Constant and macro definitions for public use-----------------------------
#define MAX_HW_SECT_FILT_LEN 8

#define STB_DMX_PID_FILTER_INVALID       0xffff
#define STB_DMX_SECT_FILTER_INVALID      0xffff

#define STB_TPID_CBUFF_PRIORITY          10

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

// definitions for the descrambler
typedef enum
{
   DESC_TRACK_AUDIO,
   DESC_TRACK_VIDEO,
   DESC_TRACK_TEXT,
   DESC_NUM_TRACKS
} E_STB_DMX_DESC_TRACK;

typedef enum
{
   KEY_PARITY_EVEN,
   KEY_PARITY_ODD
} E_STB_DMX_DESC_KEY_PARITY;

typedef enum
{
   DESC_TYPE_DVB,
   DESC_TYPE_AES,
   DESC_TYPE_AES_SCTE_52,
   DESC_TYPE_DES,
   DESC_TYPE_TDES
} E_STB_DMX_DESC_TYPE;

typedef enum
{
   KEY_USAGE_PES,
   KEY_USAGE_TRANSPORT,
   KEY_USAGE_ALL
} E_STB_DMX_KEY_USAGE;

typedef enum
{
   DMX_TUNER,
   DMX_1394,
   DMX_MEMORY
} E_STB_DMX_DEMUX_SOURCE;

typedef enum
{
   DMX_CAPS_LIVE = 0x0001,
   DMX_CAPS_PIP = 0x0002,
   DMX_CAPS_RECORDING = 0x0004,
   DMX_CAPS_PLAYBACK = 0x0008
} E_STB_DMX_CAPS;

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

typedef void (*FILTER_CALLBACK)( U8BIT path, U16BIT bytes, U16BIT pfilt_id );

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

void STB_DMXInitialise(U8BIT paths, BOOLEAN inc_pes_collection);

U16BIT STB_DMXGetCapabilities(U8BIT path);

U8BIT STB_DMXGetMaxSectionFilters(void);

void STB_DMXSetDemuxSource(U8BIT path, E_STB_DMX_DEMUX_SOURCE source, U8BIT param);

void STB_DMXGetDemuxSource(U8BIT path, E_STB_DMX_DEMUX_SOURCE *source, U8BIT *param);

void STB_DMXReadTextPES(U8BIT path, U8BIT **buffer, U32BIT *num_bytes);

void STB_DMXChangeDecodePIDs(U8BIT path, U16BIT pcr_pid, U16BIT video_pid, U16BIT audio_pid,
   U16BIT text_pid, U16BIT data_pid, U16BIT ad_pid);

void STB_DMXChangeTextPID(U8BIT path, U16BIT text_pid);

U16BIT STB_DMXGrabPIDFilter(U8BIT path, U16BIT pid, FILTER_CALLBACK func);

BOOLEAN STB_DMXCopyPIDFilterSect(U8BIT path, U8BIT *buffer, U16BIT size, U16BIT pfilt_id);

void STB_DMXSkipPIDFilterSect(U8BIT path, U16BIT pfilt_id);

U16BIT STB_DMXGrabSectFilter(U8BIT path, U16BIT pfilt_id);

void STB_DMXSetupSectFilter(U8BIT path, U16BIT sfilt_id, U8BIT *match_ptr, U8BIT *mask_ptr,
   U8BIT not_equal_byte_index, BOOLEAN crc);

void STB_DMXStartPIDFilter(U8BIT path, U16BIT pfilt_id);

void STB_DMXStopPIDFilter(U8BIT path, U16BIT pfilt_id);

void STB_DMXReleasePIDFilter(U8BIT path, U16BIT pfilt_id);

void STB_DMXReleaseSectFilter(U8BIT path, U16BIT sfilt_id);

BOOLEAN STB_DMXGetDescramblerKey(U8BIT path, E_STB_DMX_DESC_TRACK track);

BOOLEAN STB_DMXFreeDescramblerKey(U8BIT path, E_STB_DMX_DESC_TRACK track);

BOOLEAN STB_DMXSetDescramblerKeyData(U8BIT path, E_STB_DMX_DESC_TRACK track, E_STB_DMX_DESC_KEY_PARITY parity, U8BIT *data);

BOOLEAN STB_DMXGetKeyUsage(U8BIT path, E_STB_DMX_DESC_TRACK track, E_STB_DMX_KEY_USAGE *key_usage);

BOOLEAN STB_DMXSetKeyUsage(U8BIT path, E_STB_DMX_DESC_TRACK track, E_STB_DMX_KEY_USAGE key_usage);

BOOLEAN STB_DMXGetDescramblerType(U8BIT path, E_STB_DMX_DESC_TRACK track, E_STB_DMX_DESC_TYPE *type);

BOOLEAN STB_DMXSetDescramblerType(U8BIT path, E_STB_DMX_DESC_TRACK track, E_STB_DMX_DESC_TYPE type);

#endif //  _STBHWDMX_H