OpenCDMi Plugin

Version: 1.0

Status:

OCDM plugin for Thunder framework.

Introduction

Scope

This document describes purpose and functionality of the OCDM plugin. It includes detailed specification about its configuration, methods and properties as well as sent notifications.

Case Sensitivity

All identifiers of the interfaces described in this document are case-sensitive. Thus, unless stated otherwise, all keywords, entities, properties, relations and actions should be treated as such.

Acronyms, Abbreviations and Terms

The table below provides and overview of acronyms used in this document and their definitions.

Acronym	Description
API	Application Programming Interface
HTTP	Hypertext Transfer Protocol
JSON	JavaScript Object Notation; a data interchange format
JSON-RPC	A remote procedure call protocol encoded in JSON

The table below provides and overview of terms and abbreviations used in this document and their definitions.

Term	Description
callsign	The name given to an instance of a plugin. One plugin can be instantiated multiple times, but each instance the instance name, callsign, must be unique.

References

Ref ID	Description
HTTP	HTTP specification
JSON-RPC	JSON-RPC 2.0 specification
JSON	JSON specification
Thunder	Thunder API Reference

Configuration

The table below lists configuration options of the plugin.

Name	Type	M/O	Description
callsign	string	mandatory	Plugin instance name (default: OCDM)
classname	string	mandatory	Class name: OCDM
locator	string	mandatory	Library name: libThunderOCDM.so
startmode	string	mandatory	Determines in which state the plugin should be moved to at startup of the framework
configuration	object	optional	...
configuration?.location	string	optional	Location
configuration?.connector	string	optional	Connector
configuration?.sharepath	string	optional	Sharepath
configuration?.sharesize	string	optional	Sharesize
configuration?.systems	array	optional	List of key systems
configuration?.systems[#]	object	mandatory	System properties
configuration?.systems[#]?.name	string	optional	Name
configuration?.systems[#]?.designators	array	optional	...
configuration?.systems[#]?.designators[#]	object	mandatory	Designator
configuration?.systems[#]?.designators[#].name	string	mandatory	...

Interfaces

This plugin implements the following interfaces:

OCDM.json (version 1.0.0) (uncompliant-extended format)
IOpenCDM (IOCDM.h) (version 1.0.0) (compliant format)

This interface uses legacy lowercase naming convention. With the next major release the naming convention will change to camelCase.

Methods

The following methods are provided by the OCDM plugin:

Built-in methods:

Method	Description
versions	Retrieves a list of JSON-RPC interfaces offered by this service
exists	Checks if a JSON-RPC method or property exists
register	Registers for an asynchronous JSON-RPC notification
unregister	Unregisters from an asynchronous JSON-RPC notification

versions ^method

Retrieves a list of JSON-RPC interfaces offered by this service.

Parameters

This method takes no parameters.

Result

Name	Type	M/O	Description
result	array	mandatory	A list ofsinterfaces with their version numbers Array length must be at most 255 elements.
result[#]	object	mandatory	...
result[#].name	string	mandatory	Name of the interface
result[#].major	integer	mandatory	Major part of version number
result[#].minor	integer	mandatory	Minor part of version number
result[#].patch	integer	mandatory	Patch part of version version number

Example

Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "OCDM.1.versions"
}

Response

{
  "jsonrpc": "2.0",
  "id": 42,
  "result": [
    {
      "name": "JMyInterface",
      "major": 1,
      "minor": 0,
      "patch": 0
    }
  ]
}

exists ^method

Checks if a JSON-RPC method or property exists.

Description

This method will return True for the following methods/properties: drms, keysystems, sessions, systems, designators, versions, exists, register, unregister.

Parameters

Name	Type	M/O	Description
params	object	mandatory	...
params.method	string	mandatory	Name of the method or property to look up

Result

Name	Type	M/O	Description
result	boolean	mandatory	Denotes if the method exists or not

Example

Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "OCDM.1.exists",
  "params": {
    "method": "methodName"
  }
}

Response

{
  "jsonrpc": "2.0",
  "id": 42,
  "result": false
}

register ^method

Registers for an asynchronous JSON-RPC notification.

Description

This method supports the following event names: drmalreadyinitialized, drminitializationstatus.

Parameters

Name	Type	M/O	Description
params	object	mandatory	...
params.event	string	mandatory	Name of the notification to register for
params.id	string	mandatory	Client identifier

Result

Name	Type	M/O	Description
result	null	mandatory	Always null

Errors

Message	Description
`ERROR_FAILED_REGISTERED`	Failed to register for the notification (e.g. already registered)

Example

Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "OCDM.1.register",
  "params": {
    "event": "eventName",
    "id": "myapp"
  }
}

Response

{
  "jsonrpc": "2.0",
  "id": 42,
  "result": null
}

unregister ^method

Unregisters from an asynchronous JSON-RPC notification.

Description

This method supports the following event names: drmalreadyinitialized, drminitializationstatus.

Parameters

Name	Type	M/O	Description
params	object	mandatory	...
params.event	string	mandatory	Name of the notification to register for
params.id	string	mandatory	Client identifier

Result

Name	Type	M/O	Description
result	null	mandatory	Always null

Errors

Message	Description
`ERROR_FAILED_UNREGISTERED`	Failed to unregister from the notification (e.g. not yet registered)

Example

Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "OCDM.1.unregister",
  "params": {
    "event": "eventName",
    "id": "myapp"
  }
}

Response

{
  "jsonrpc": "2.0",
  "id": 42,
  "result": null
}

Properties

The following properties are provided by the OCDM plugin:

OCDM interface properties:

Property	R/W	Description
drms	read-only	Supported DRM systems
keysystems	read-only	DRM key systems
sessions	read-only	Active sessions enumerator

OpenCDM interface properties:

Property	R/W	Description
systems	read-only	Supported DRM systems
designators	read-only	Designators of a specified DRM system

drms ^property

Provides access to the supported DRM systems.

This property is read-only.

Value

Name	Type	M/O	Description
(property)	array	mandatory	Supported DRM systems
(property)[#]	object	mandatory	...
(property)[#].name	string	mandatory	Name of the DRM
(property)[#].keysystems	array	mandatory	Key system identifier list
(property)[#].keysystems[#]	string	mandatory	Identifier of a key system

Example

Get Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "OCDM.1.drms"
}

Get Response

{
  "jsonrpc": "2.0",
  "id": 42,
  "result": [
    {
      "name": "PlayReady",
      "keysystems": [
        "com.microsoft.playready"
      ]
    }
  ]
}

keysystems ^property

Provides access to the DRM key systems.

This property is read-only.

The drm system parameter shall be passed as the index to the property, i.e. keysystems@<drm-system>.

Index

Name	Type	M/O	Description
drm-system	string	mandatory	...

Value

Name	Type	M/O	Description
(property)	array	mandatory	DRM key systems
(property)[#]	string	mandatory	Identifier of a key system

Errors

Message	Description
`ERROR_BAD_REQUEST`	Invalid DRM name

Example

Get Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "OCDM.1.keysystems@PlayReady"
}

Get Response

{
  "jsonrpc": "2.0",
  "id": 42,
  "result": [
    "com.microsoft.playready"
  ]
}

sessions ^property

Provides access to the active sessions enumerator.

This property is read-only.

Value

Name	Type	M/O	Description
(property)	array	mandatory	Active sessions enumerator
(property)[#]	object	mandatory	...
(property)[#].drm	string	mandatory	Name of the DRM system

Example

Get Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "OCDM.1.sessions"
}

Get Response

{
  "jsonrpc": "2.0",
  "id": 42,
  "result": [
    {
      "drm": "PlayReady"
    }
  ]
}

systems ^property

Provides access to the supported DRM systems.

This property is read-only.

Value

Name	Type	M/O	Description
(property)	array	mandatory	Supported DRM systems
(property)[#]	string	mandatory	...

Example

Get Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "OCDM.1.systems"
}

Get Response

{
  "jsonrpc": "2.0",
  "id": 42,
  "result": [
    "..."
  ]
}

designators ^property

Provides access to the designators of a specified DRM system.

This property is read-only.

The keysystem parameter shall be passed as the index to the property, i.e. designators@<keysystem>.

Index

Name	Type	M/O	Description
keysystem	string	mandatory	...

Value

Name	Type	M/O	Description
(property)	array	mandatory	Designators of a specified DRM system
(property)[#]	string	mandatory	...

Errors

Message	Description
`ERROR_UNKNOWN_KEY`	Invalid DRM name

Example

Get Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "OCDM.1.designators@xyz"
}

Get Response

{
  "jsonrpc": "2.0",
  "id": 42,
  "result": [
    "..."
  ]
}

Notifications

Notifications are autonomous events triggered by the internals of the implementation and broadcasted via JSON-RPC to all registered observers. Refer to [Thunder] for information on how to register for a notification.

The following events are provided by the OCDM plugin:

OCDM interface events:

Notification	Description
drmalreadyinitialized	Signals that the specified DRM system could not be initialized because it is already initialized by another process
drminitializationstatus	Notifies about DRM initialization status

drmalreadyinitialized ^notification

Signals that the specified DRM system could not be initialized because it is already initialized by another process.

Description

When this event is received, the application owning given DRM system should release it immediately.

Notification Parameters

Name	Type	M/O	Description
params	object	mandatory	...
params.drm	string	mandatory	Name of the DRM system

Example

Registration

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "OCDM.1.register",
  "params": {
    "event": "drmalreadyinitialized",
    "id": "myid"
  }
}

Notification

{
  "jsonrpc": "2.0",
  "method": "myid.drmalreadyinitialized",
  "params": {
    "drm": "PlayReady"
  }
}

The client ID parameter is passed within the notification designator, i.e. <client-id>.drmalreadyinitialized.

drminitializationstatus ^notification

Notifies about DRM initialization status.

Description

Register to this event to be notified about DRM retrying status busy/failure/success

Notification Parameters

Name	Type	M/O	Description
params	object	mandatory	...
params.status	string	mandatory	BUSY - drm is used by another process, SUCCESS - recovered from BUSY state after retry, FAILED - not recovered after re-trying from BUSY (must be one of the following: BUSY, FAILED, SUCCESS)
params.drm	string	mandatory	Name of the DRM system

Example

Registration

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "OCDM.1.register",
  "params": {
    "event": "drminitializationstatus",
    "id": "myid"
  }
}

Notification

{
  "jsonrpc": "2.0",
  "method": "myid.drminitializationstatus",
  "params": {
    "status": "SUCCESS",
    "drm": "PlayReady"
  }
}

The client ID parameter is passed within the notification designator, i.e. <client-id>.drminitializationstatus.

OpenCDMi Plugin

Table of Contents

Introduction

Scope

Case Sensitivity

Acronyms, Abbreviations and Terms

References

Configuration

Interfaces

Methods

versions method

Parameters

Result

Example

Request

Response

exists method

Description

Parameters

Result

Example

Request

Response

register method

Description

Parameters

Result

Errors

Example

Request

Response

unregister method

Description

Parameters

Result

Errors

Example

Request

Response

Properties

drms property

Value

Example

Get Request

Get Response

keysystems property

Index

Value

Errors

Example

Get Request

Get Response

sessions property

Value

Example

Get Request

Get Response

systems property

Value

Example

Get Request

Get Response

designators property

Index

Value

Errors

Example

Get Request

Get Response

Notifications

drmalreadyinitialized notification

Description

Notification Parameters

Example

Registration

Notification

drminitializationstatus notification

Description

Notification Parameters

Example

versions ^method

exists ^method

register ^method

unregister ^method

drms ^property

keysystems ^property

sessions ^property

systems ^property

designators ^property

drmalreadyinitialized ^notification

drminitializationstatus ^notification