WsbDrmDbus.h

Go to the documentation of this file.

/*****************************************************************
|
|   Wasabi DRM D-Bus interface
|
|   $Id: WsbDrmDbus.h 11546 2015-02-03 07:31:48Z jebaseelir $
|   Original author:  Edin Hodzic ([email protected])
|
|   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 _WSB_DRM_DBUS_H_
#define _WSB_DRM_DBUS_H_

/*----------------------------------------------------------------------
|   includes
+---------------------------------------------------------------------*/
#include "Sushi.h"
#include "WsbTypes.h"
#include "WsbResults.h"

/*----------------------------------------------------------------------
|   macros
+---------------------------------------------------------------------*/
#define WSB_DRMDBUS_SERVICE                "com.intertrust.wasabi"
#define WSB_DRMDBUS_METHOD_PROCESS_MESSAGE "processMessage"
#define WSB_DRMDBUS_METHOD_IS_ACTION_VALID "isActionValid"

/*----------------------------------------------------------------------
|   types
+---------------------------------------------------------------------*/
/* Valid message types for Process message, currently only
 * ACTION_TOKEN is defined */
typedef enum {
    WSB_DRMDBUS_MT_UNKNOWN             = -1,
    WSB_DRMDBUS_MT_MARLIN_ACTION_TOKEN =  0
} WSB_DrmDbus_MessageType;

/* Valid action types, currently only PLAY is defined */
typedef enum {
    WSB_DRMDBUS_AT_UNKNOWN = -1,
    WSB_DRMDBUS_AT_PLAY    =  0
} WSB_DrmDbus_ActionType;

/* Result Code Macros */
typedef enum {
    /* The entire message was processed successfully. */
    WSB_DRMDBUS_SUCCESS = 0,

    /* The message was not processed because the DRM system is not in
     * a fully functional state. A software upgrade may resolve the
     * problem. */
    WSB_DRMDBUS_ERROR_INVALID_STATE = 1,

    /* Some or all of the message could not be processed because it was
     * deemed invalid by the DRM client. */
    WSB_DRMDBUS_ERROR_CLIENT = 2,

    /* Some or all of the message could not be processed because it
     * required access to a remote service which could not be
     * contacted. */
    WSB_DRMDBUS_ERROR_SERVER = 3,

    /* Some or all of the message could not be processed because a
       remote service denied the request. */
    WSB_DRMDBUS_ERROR_SERVER_DENIED = 4,

    /* Some or all of the message could not be processed because a
     * response from a remote service was deemed invalid or
     * unacceptable by the DRM client. */
    WSB_DRMDBUS_ERROR_COMMUNICATION = 5,

    /* 7 = Unsupported licence requirement: a licence for the content
     * exists but the device cannot meet all of its requirements.
     * Examples: unsupported output control; unsupported callbacks or
     * obligations.
     */
    WSB_DRMDBUS_ERROR_LICENSE_UNSUPPORTED = 7,

    /* 8 = Licence format error: a licence was located for the media
     * but it is invalid.  Examples: invalid signature on licence;
     * licence is incomplete; licence cannot be parsed.
     */
    WSB_DRMDBUS_ERROR_BAD_LICENSE_FORMAT = 8,

    /* 9 = Missing credentials: a licence was located for the media
     * but is dependent on other entities which are not present.
     * Example: Marlin Broadband licence dependent on a Link which
     * does not exist (IsNodeReachable failed).
     */
    WSB_DRMDBUS_ERROR_MISSING_CREDENTIALS = 9,

    /* 10 = Expired: a time constraint associated with a licence has
     * been violated.  Example: Marlin Broadband licence that is past
     * its expiry date and time.
     */
    WSB_DRMDBUS_ERROR_LICENSE_EXPIRED = 10,

    /* 11 = Play count exceeded: a play count constraint associated
     * with a licence has been violated.  Example: Marlin Broadband
     * licence permitted play count has reached zero.
     */
    WSB_DRMDBUS_ERROR_PLAYCOUNT_EXCEEDED = 11,

    /* 12 = Subscription expired: a time constraint associated with an
     * entity on which a licence depends has been violated.  Example:
     * a Marlin Broadband link on which a licence depends has expired.
     */
    WSB_DRMDBUS_ERROR_SUBSCRIPTION_EXPIRED = 12,

    /* 99 = Other content protection error: the requested operation
     * would fail due to a content protection problem other than those
     * described by specific response codes.
     */
    WSB_DRMDBUS_ERROR_CONTENT_PROTECTION_OTHER = 99
}  WSB_DrmDbusResult;

/* Token processing callback */
typedef struct {
    void*   instance;
    void  (*TokenProcessed)(void* instance, WSB_DrmDbusResult result);
} WSB_DrmDbus_TokenProcessed;

/* Action validation callback. ValidateActionResult can be set to NULL, 
   in which case a default validator gets invoked. */
typedef struct {
    void*        instance;
    WSB_Result (*ValidateActionResult)(void* instance, 
                                       SHI_ActionResult* action_result);
} WSB_DrmDbus_ActionResultValidator;

/* Opaque DRM D-Bus object */
typedef struct WSB_DrmDbus WSB_DrmDbus;

/*----------------------------------------------------------------------
|   functions
+---------------------------------------------------------------------*/

#ifdef __cplusplus
extern "C" {
#elif 0
}
#endif

/* Initialize the DrmDbus module */
WSB_EXPORT WSB_Result 
WSB_DrmDbus_Initialize(WSB_DrmDbus** drm, WSB_Size max_pending_requests);

/* Process an action token */
WSB_EXPORT WSB_Result 
WSB_DrmDbus_ProcessActionToken(WSB_DrmDbus*                     drm,
                               const char*                      token,
                               const WSB_DrmDbus_TokenProcessed callback);

/* Check whether an action is valid for a content ID */
WSB_EXPORT WSB_Result 
WSB_DrmDbus_IsActionValid(WSB_DrmDbus*                      drm,
                          const char*                       content_id,
                          WSB_DrmDbus_ActionType            action,
                          WSB_DrmDbus_ActionResultValidator validator,
                          int*                              retval);

/* Terminate the module execution */
WSB_EXPORT WSB_Result 
WSB_DrmDbus_Terminate(WSB_DrmDbus* drm);

/* Map a Wasabi error code to a Canvas D-Bus DRM error code */
WSB_EXPORT WSB_DrmDbusResult 
WSB_DrmDbus_ResultMap(WSB_Result code);

#ifdef __cplusplus
}
#endif

#endif // _WSB_DRM_DBUS_H_