ShiLicense.h

Go to the documentation of this file.

/*****************************************************************
|
|   Sushi - License
|
|   $Id: ShiLicense.h 7930 2014-06-25 11:05:10Z jebaseelir $
|   Original author:  Gilles Boccon-Gibod
|
|   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) 2005-2014 by Intertrust. All rights reserved. 
|
****************************************************************/
#ifndef _SHI_LICENSE_H_
#define _SHI_LICENSE_H_

/*----------------------------------------------------------------------
|   includes
+---------------------------------------------------------------------*/
#include "ShiResults.h"
#include "ShiTypes.h"
#include "ShiList.h"
#include "ShiData.h"
#include "ShiAction.h"
#include "ShiAttributes.h"
#include "ShiLicenseInfo.h"
#include "ShiCrypto.h"

/*----------------------------------------------------------------------
|   constants
+---------------------------------------------------------------------*/
#define SHI_ERROR_LICENSE_IDS_ALREADY_SET    (SHI_ERROR_BASE_API_LICENSE - 0)
#define SHI_ERROR_LICENSE_ID_NOT_FOUND       (SHI_ERROR_BASE_API_LICENSE - 1)
#define SHI_ERROR_LICENSE_INVALID_DATA       (SHI_ERROR_BASE_API_LICENSE - 2)
#define SHI_ERROR_LICENSE_ACTION_PENDING     (SHI_ERROR_BASE_API_LICENSE - 3)
#define SHI_ERROR_LICENSE_MUST_PERFORM       (SHI_ERROR_BASE_API_LICENSE - 4)
#define SHI_ERROR_LICENSE_INCOMPLETE_DATA    (SHI_ERROR_BASE_API_LICENSE - 5)
#define SHI_ERROR_LICENSE_NO_SUCH_ACTION     (SHI_ERROR_BASE_API_LICENSE - 6)
#define SHI_ERROR_LICENSE_ACCEPT_FAILED      (SHI_ERROR_BASE_API_LICENSE - 7)
#define SHI_ERROR_LICENSE_CALLBACK_NOT_FOUND (SHI_ERROR_BASE_API_LICENSE - 8)
#define SHI_ERROR_LICENSE_CALLBACK_FAILED    (SHI_ERROR_BASE_API_LICENSE - 9)
#define SHI_ERROR_LICENSE_MUST_ACCEPT        (SHI_ERROR_BASE_API_LICENSE - 10)
#define SHI_ERROR_LICENSE_PARSE_FAILURE      (SHI_ERROR_BASE_API_LICENSE - 11)

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

typedef struct SHI_License SHI_License;

typedef enum {
    SHI_CONTENT_KEY_FORMAT_CLEARTEXT,    /* no parameters */
    SHI_CONTENT_KEY_FORMAT_SKB_STANDARD, /* SKB_EXPORT_TARGET_CROSS_ENGINE, no parameters */
    SHI_CONTENT_KEY_FORMAT_SKB_CUSTOM    /* SKB_EXPORT_TARGET_CUSTOM, parameters is a pointer to an SKB_ExportCustomParameters structure. */
} SHI_ContentKeyFormat;

SHI_PUBLIC_API
void*
SHI_License_GetInterface(SHI_License* self, SHI_InterfaceId iface_id);

SHI_PUBLIC_API
SHI_Result       
SHI_License_Destroy(SHI_License* self);

SHI_PUBLIC_API
SHI_Result 
SHI_License_Describe(SHI_License* self, SHI_LicenseInfo** description);

SHI_PUBLIC_API
SHI_Result 
SHI_License_ProcessLicenseData(SHI_License* self, 
                               const void*  data, 
                               SHI_Size     size);

SHI_PUBLIC_API
SHI_Result
SHI_License_SetContentIds(SHI_License*       self,
                          const char* const* ids,
                          SHI_Cardinal       id_count);

SHI_PUBLIC_API
SHI_Result
SHI_License_GetContentKey(SHI_License*         self,
                          const char*          content_id,
                          SHI_ContentKeyFormat format,
                          const void*          format_parameters,
                          SHI_Data**           data);

SHI_PUBLIC_API
SHI_Result 
SHI_License_CreateAction(SHI_License* self, 
                         const char*  name,
                         const void*  parameters,
                         SHI_Action** action);

SHI_PUBLIC_API
SHI_Result 
SHI_License_CreateActionEx(SHI_License*  self, 
                           const char*   name,
                           const void*   parameters,
                           SHI_Size      parameters_size,
                           SHI_Action**  action);

#if defined(__cplusplus)
}
#endif

#endif /* _SHI_LICENSE_H_ */