Ts2Marlin.h

Go to the documentation of this file.

/*****************************************************************
|
|   MPEG2 Transport Stream - Marlin
|
|   $Id: Ts2Marlin.h 354 2018-06-28 00:42:39Z pgirish $
|   Original author:  Julien Boeuf
|
|   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) 2010-2014 by Intertrust. All rights reserved. 
|
****************************************************************/

#ifndef _TS2_MARLIN_H_
#define _TS2_MARLIN_H_

/*----------------------------------------------------------------------
|   includes
+---------------------------------------------------------------------*/
#include "Ts2Descriptors.h"
#include "Ts2Tables.h"
#include "Ts2Iec62455.h"
#include "Ts2Protection.h"

/*----------------------------------------------------------------------
|   constants
+---------------------------------------------------------------------*/
#define TS2_MARLIN_CA_SYSTEM_ID    0x4AF4
#define TS2_MARLIN_MAC_SEED        "MRL-BBTS-AUTH-KEY-10"
#define TS2_MARLIN_RIGHTS_TABLE_ID 0x82

#define TS2_MARLIN_SILENT_METHOD_ON_DEMAND  0x00
#define TS2_MARLIN_SILENT_METHOD_IN_ADVANCE 0x01

/* The Key Derivation Function IDs from the Key Derivation Function descriptor */
#define TS2_KEY_DERIVATION_FUNCTION_NONE           0
#define TS2_KEY_DERIVATION_FUNCTION_TRUNCATED_SHA1 1

/*----------------------------------------------------------------------
|   types
+---------------------------------------------------------------------*/
typedef struct {
    ATX_String rights_issuer_url;
    ATX_String silent_rights_url;
    ATX_String preview_rights_url;
} TS2_MarlinRightsInfo;

typedef struct {
    TS2_Table            base;
    TS2_MarlinRightsInfo info;
} TS2_MarlinRightsTable;

#ifdef __cplusplus
extern "C" {
#endif

/*----------------------------------------------------------------------
|   Marlin CADescriptor related methods
+---------------------------------------------------------------------*/
TS2_CADescriptor*
TS2_GetMarlinCADescriptorFromPMT(const TS2_PMT* pmt);
                                     
TS2_CADescriptor*
TS2_GetMarlinCADescriptorFromCAT(const TS2_CAT* cat);
    
/*----------------------------------------------------------------------
|   TS2_MarlinCADescriptor_Create
+---------------------------------------------------------------------*/
ATX_Result
TS2_MarlinCADescriptor_Create(ATX_UInt16                  pid,
                              const char*                 base_cid, /* can be NULL */ 
                              ATX_Boolean                 single_key_layer,
                              TS2_TrafficProtectionSystem protection,
                              TS2_CADescriptor**          desc);

ATX_Result
TS2_MarlinCADescriptor_GetBaseContentIdAndProtection(const TS2_CADescriptor*      marlin_desc,
                                                     ATX_String*                  base_cid,
                                                     TS2_TrafficProtectionSystem* protection,
                                                     ATX_UInt32*                  kdf_type);
    
/*----------------------------------------------------------------------
|   Marlin ContentId related methods
+---------------------------------------------------------------------*/
ATX_Result 
TS2_GetMarlinContentIdFromKSM(const char*    cid_base,
                              const TS2_KSM* ksm,
                              ATX_String*    cid);
    
ATX_Result
TS2_GetMarlinContentIdAndProtectionFromKSM(const char*                  cid_base,
                                           const TS2_KSM*               ksm,
                                           ATX_String*                  cid,
                                           TS2_TrafficProtectionSystem* protection);                                           

ATX_Result
TS2_ParseContentId(const char*  content_id,
                   ATX_String*  cid_base,
                   ATX_Byte*    cid_extension, /* TS2_KSM_CID_EXTENSION_SIZE   */
                   ATX_Boolean* is_service);   /* ATX_FALSE means is_programme */

/*----------------------------------------------------------------------
|   MarlinRightsTable methods 
+---------------------------------------------------------------------*/
TS2_EXPORT ATX_Result
TS2_MarlinRightsTable_Construct(TS2_MarlinRightsTable* self);

ATX_Boolean
TS2_MarlinRightsTable_IsEmpty(TS2_MarlinRightsTable* self);

/*----------------------------------------------------------------------
|   other methods 
+---------------------------------------------------------------------*/
ATX_Result
TS2_VerifyMarlinKSM(const ATX_Byte* drm_key,
                    const TS2_KSM*  ksm);

#ifdef __cplusplus
}
#endif

#endif /* _TS2_MARLIN_H_ */