com.intertrust.wasabi.media

Class MediaSegmentDecrypter

java.lang.Object

com.intertrust.wasabi.media.MediaSegmentDecrypter

public class MediaSegmentDecrypter
extends java.lang.Object

Marlin Media Segment Decrypter API module.

Since:

1.12.2

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MediaSegmentDecrypter.HlsInitData The InitData specific to the HLS media format.
static class	MediaSegmentDecrypter.InitData A base InitData class.
static class	MediaSegmentDecrypter.Mp4CencInitData The InitData specific to the MP4/CENC media format.
static class	MediaSegmentDecrypter.Type Media type a decrypter object can be used with.

Constructor Summary

Constructors

Constructor and Description
MediaSegmentDecrypter(java.lang.String ms3_url, MediaSegmentDecrypter.Type type) Create a new instance of the Media Segment Decrypter object.

Method Summary

Methods

Modifier and Type	Method and Description
MediaSegmentDecrypter	cloneDecrypter() Create a new instance of Media Segment Decrypter from another Media Segment Decrypter object.
int	decrypt(byte[] input, byte[] output) A convenience method, assuming offset 0 and full array length for both input and output.
int	decrypt(byte[] input, int in_offset, int in_size, byte[] output, int out_offset, int out_size) Perform decryption of a media buffer.
void	destroy() Destroy a Media Segment Decrypter object earlier successfully created through MediaSegmentDecrypter().
void	init(MediaSegmentDecrypter.InitData init_data) Initialize decrypter for a new segment.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MediaSegmentDecrypter

public MediaSegmentDecrypter(java.lang.String ms3_url,
                     MediaSegmentDecrypter.Type type)
                      throws ErrorCodeException

Create a new instance of the Media Segment Decrypter object. The object must be destroyed through a call to destroy() once no longer needed.

Parameters:

ms3_url - the MS3 URL, must be ms3:// scheme, for Marlin MS3 license form, can be null if using BB license.

type - the media type.

Throws:

ErrorCodeException

Since:

1.12.2

Method Detail

cloneDecrypter

public MediaSegmentDecrypter cloneDecrypter()
                                     throws ErrorCodeException

Create a new instance of Media Segment Decrypter from another Media Segment Decrypter object. The new instance will have the same content keys as the original instance, but won't share any other state of the decrypter object. The new object needs to be initialized using init() before it can be used to decrypt. The original and the cloned object can be used on separate threads.

Returns:

newly created object

Throws:

ErrorCodeException

Since:

1.12.2

destroy

public void destroy()
             throws ErrorCodeException

Destroy a Media Segment Decrypter object earlier successfully created through MediaSegmentDecrypter().

Throws:

ErrorCodeException

Since:

1.12.2

init

public void init(MediaSegmentDecrypter.InitData init_data)
          throws ErrorCodeException

Initialize decrypter for a new segment. Must be called before a new segment can start decrypting, but not before any previous segment has been completely decrypted even if no init_data values have changed.

Parameters:

init_data - a media format specific initialization data. For HLS, this must be an HlsInitData object. For MP4/CENC, this must be an Mp4CencInitData object.

Throws:

ErrorCodeException

Since:

1.12.2

decrypt

public int decrypt(byte[] input,
          int in_offset,
          int in_size,
          byte[] output,
          int out_offset,
          int out_size)
            throws ErrorCodeException

Perform decryption of a media buffer. The decrypter buffers input data and may return less data than passed in. When decrypting an HLS segment, a final call must be made with null input buffer in order to flush the decrypter and receive any de-padded final bytes. When decrypting an MPEG/CENC segment, the input should contain the moof atom followed by the mdat atom with encrypted media. Only one fragment (moof/mdat) per input is supported. The returned output contains only decrypted media in the granularity of one or more samples (no moof atom and mdat atom header). It may return no data when there is not enough input to decrypt a sample. It may also throw exception when the output buffer size is less than current decrypted sample size. When all the samples of the current segment are decrypted and returned to the caller, additional call to this function will throw an exception.

Parameters:

input - the media data to be decrypted. For decrypting HLS segment, 'input' can be null to signal end of a segment, flush decrypter and receive any buffered decrypted data. For decrypting MP4/CENC segment, 'input' must not be NULL except when this function is used to obtain the estimated decrypted data size (see description of return value).

in_offset - data offset in the input buffer, in bytes.

in_size - size of the 'input' buffer in bytes.

output - the output buffer where the decrypted media data is returned. For decrypting HLS segment, 'output' must not be NULL. For decrypting MP4/CENC segment, 'output' must not be NULL except when this function is used to obtain the estimate decrypted data size.

out_offset - data offset in the output buffer, in bytes.

out_size - the number of bytes available from out_offset in the output buffer

Returns:

the amount of data written to the 'output' buffer, in bytes. For decrypting MP4/CENC segment, when the 'output' parameter is null, the estimated decrypted data size is returned.

Throws:

ErrorCodeException

Since:

1.12.2

decrypt

public int decrypt(byte[] input,
          byte[] output)
            throws ErrorCodeException

A convenience method, assuming offset 0 and full array length for both input and output. See @link{decrypt(byte[], int, int, byte[], int, int)}.

Parameters:

input - the media data to be decrypted. For decrypting HLS segment, 'input' can be null to signal end of a segment, flush decrypter and receive any buffered decrypted data. For decrypting MP4/CENC segment, 'input' must not be NULL except when this function is used to obtain the estimated decrypted data size (see description of return value).

output - the output buffer where the decrypted media data is returned. For decrypting HLS segment, 'output' must not be NULL. For decrypting MP4/CENC segment, 'output' must not be NULL except when this function is used to obtain the estimate decrypted data size.

Returns:

the amount of data written to the 'output' buffer, in bytes. For decrypting MP4/CENC segment, when the 'output' parameter is null, the estimated decrypted data size is returned.

Throws:

ErrorCodeException

Since:

1.12.2