EmbProcessor.h

Go to the documentation of this file.

/*****************************************************************
|
|   EMB (Extended Marlin Broadcast) Processor
|
|   $Id: EmbProcessor.h 2017-10-03
|   Original author: Kiran Kumar G
|
|   This software is provided to you pursuant to your agreement 
|   with Intertrust Technologies Corporation ("Intertrust"). 
|   This software may be used only in accordance with the terms 
|   of the agreement.
|      
|   Copyright (c) 2017-2018 by Intertrust. All rights reserved. 
|
****************************************************************/
#ifndef _EMB_PROCESSOR_H_
#define _EMB_PROCESSOR_H_

/*----------------------------------------------------------------------
|   includes
+---------------------------------------------------------------------*/
#include "EmbTypes.h"
#include "EmbConfig.h"

/*----------------------------------------------------------------------
|   constants
+---------------------------------------------------------------------*/
#define EMB_GROUP_TABLES      13
#define EMB_COEFF_LENGTH      16
#define EMB_MASK_LENGTH       16
#define EMB_EMM_MIN_GROUP_ID  0
#define EMB_EMM_MAX_GROUP_ID  1247
#define EMB_CONTENT_ID_HASH_LENGTH  20
#define EMB_INVALID_PACKAGE_ID (EMB_UInt32)(-1)
#define EMB_INVALID_GROUP_ID (EMB_Int32)(-1)

/*----------------------------------------------------------------------
|   types
+---------------------------------------------------------------------*/
typedef struct {
    EMB_Size         data_size;

    const EMB_UInt8* data;
} EMB_ByteArray;

typedef struct {
    EMB_UInt8 mask[EMB_COEFF_LENGTH];
    EMB_UInt8 coeff[EMB_MASK_LENGTH];
} EMB_HardwareFilter;

typedef struct {
    EMB_UInt32         use_table_count;

    EMB_HardwareFilter filters[EMB_GROUP_TABLES];
} EMB_GroupFilters;

typedef struct {
    EMB_UInt32     content_id_count;

    EMB_ByteArray* content_ids;
} EMB_Processor_MediaInfo;

typedef enum {
    EMB_PROCESSOR_EVENT_TYPE_EPL_ADDED,
    EMB_PROCESSOR_EVENT_TYPE_EPL_CHANGED,
    EMB_PROCESSOR_EVENT_TYPE_EPL_REMOVED,

    EMB_PROCESSOR_EVENT_TYPE_GKO_ADDED,
    EMB_PROCESSOR_EVENT_TYPE_GKO_CHANGED,
    EMB_PROCESSOR_EVENT_TYPE_GKO_REMOVED,

    EMB_PROCESSOR_EVENT_TYPE_EPD_ADDED,
    EMB_PROCESSOR_EVENT_TYPE_EPD_CHANGED,
    EMB_PROCESSOR_EVENT_TYPE_EPD_REMOVED,

    EMB_PROCESSOR_EVENT_TYPE_OPM
} EMB_Processor_EventType;

typedef struct {
    EMB_Processor_EventType type;
} EMB_Processor_Event;

typedef struct {    
    /* Event base */    
    EMB_Processor_Event base;    

    /* data contains raw message */
    const EMB_UInt8*    data;    

    /* attains the length of decoded message */    
    EMB_Size            data_size;       

    /* the emm_id or transaction_id */
    EMB_UInt64          emm_id;    
} EMB_Processor_OpmNotificationEvent;

typedef struct {    
    /* Event base */    
    EMB_Processor_Event base;    

    /* The EPL item id which was inserted/modified/deleted in the store.
     * This item id can be passed to the EMB_Storage_GetItemByItemId API to get more details about it.
     */  
    const EMB_Int64    item_id;
} EMB_Processor_EplNotificationEvent;

typedef struct {    
    /* Event base */    
    EMB_Processor_Event base;    

    /* The GKO item id which was inserted/modified/deleted in the store.
     * This item id can be passed to the EMB_Storage_GetItemByItemId API to get more details about it.
     */      
    const EMB_Int64    item_id;
} EMB_Processor_GkoNotificationEvent;

typedef struct {    
    /* Event base */    
    EMB_Processor_Event base;    

    /* The package id which was inserted/modified/deleted in the store.
     * This item id can be passed to the EPD_Storage_GetPackageById API to get more details about it.
     */      
    EMB_UInt32   package_id;
} EMB_Processor_EpdNotificationEvent;

/*
 * Listener (callback) to provide feedback on the EMM being processed and let
 * further processing happen.
 *
 * For an EMM that modifies the set of group ids the device belongs to, further
 * processing may consist in acquiring the definition of the HW filters.
 *
 * For an EMM carrying an OPM (Operator Message), the listener should copy the
 * OPM for further processing.
 *
 * instance: is an opaque data type to pass closure-like data to the listener.
 * event: @ see EMB_Processor_Event
 */
typedef struct {
    void* instance;
    void (*handler)(void* instance, const EMB_Processor_Event* event);
} EMB_Processor_EventListener;

typedef struct SHI_Data SHI_Data;

typedef struct WSB_KeyManager WSB_KeyManager;

typedef struct EMB_Processor EMB_Processor;

/*----------------------------------------------------------------------
|   functions
+---------------------------------------------------------------------*/
#if defined(__cplusplus)
extern "C" {
#endif

EMB_EXPORT EMB_Result
EMB_Processor_Create(EMB_Processor_EventListener listener,
                     EMB_Processor**             processor);

EMB_EXPORT EMB_Result
EMB_Processor_GetDeviceFilter(EMB_Processor*      processor,
                              EMB_HardwareFilter* device_filter);

EMB_EXPORT EMB_Result
EMB_Processor_GetGroupFilters(EMB_Processor*    processor,
                              EMB_GroupFilters* group_filters);

EMB_EXPORT EMB_Result
EMB_Processor_ProcessPacket(EMB_Processor* processor, EMB_ByteArray* packet);

EMB_EXPORT EMB_Result
EMB_Processor_EnableContent(EMB_Processor*           processor,
                            EMB_Processor_MediaInfo* media_info,
                            WSB_KeyManager*          key_manager);

EMB_EXPORT EMB_Result
EMB_Processor_Destroy(EMB_Processor* processor);

#if defined(__cplusplus)
}
#endif /* __cplusplus */

#endif /* _EMB_PROCESSOR_H_ */