com.google.android.exoplayer2.ext.vp9

Class LibvpxVideoRenderer

java.lang.Object

com.google.android.exoplayer2.BaseRenderer

com.google.android.exoplayer2.ext.vp9.LibvpxVideoRenderer

All Implemented Interfaces:

ExoPlayer.ExoPlayerComponent, Renderer, RendererCapabilities

public final class LibvpxVideoRenderer
extends BaseRenderer

Decodes and renders video using the native VP9 decoder.

Field Summary

Fields

Modifier and Type	Field and Description
static int	MSG_SET_OUTPUT_BUFFER_RENDERER The type of a message that can be passed to an instance of this class via ExoPlayer.sendMessages(com.google.android.exoplayer2.ExoPlayer.ExoPlayerMessage...) or ExoPlayer.blockingSendMessages(com.google.android.exoplayer2.ExoPlayer.ExoPlayerMessage...).

Fields inherited from interface com.google.android.exoplayer2.Renderer

STATE_DISABLED, STATE_ENABLED, STATE_STARTED

Fields inherited from interface com.google.android.exoplayer2.RendererCapabilities

ADAPTIVE_NOT_SEAMLESS, ADAPTIVE_NOT_SUPPORTED, ADAPTIVE_SEAMLESS, ADAPTIVE_SUPPORT_MASK, FORMAT_EXCEEDS_CAPABILITIES, FORMAT_HANDLED, FORMAT_SUPPORT_MASK, FORMAT_UNSUPPORTED_DRM, FORMAT_UNSUPPORTED_SUBTYPE, FORMAT_UNSUPPORTED_TYPE, TUNNELING_NOT_SUPPORTED, TUNNELING_SUPPORT_MASK, TUNNELING_SUPPORTED

Constructor Summary

Constructors

Constructor and Description
LibvpxVideoRenderer(boolean scaleToFit, long allowedJoiningTimeMs)
LibvpxVideoRenderer(boolean scaleToFit, long allowedJoiningTimeMs, Handler eventHandler, VideoRendererEventListener eventListener, int maxDroppedFramesToNotify)
LibvpxVideoRenderer(boolean scaleToFit, long allowedJoiningTimeMs, Handler eventHandler, VideoRendererEventListener eventListener, int maxDroppedFramesToNotify, DrmSessionManager<ExoMediaCrypto> drmSessionManager, boolean playClearSamplesWithoutKeys)

Method Summary

Modifier and Type	Method and Description
void	handleMessage(int messageType, Object message) Handles a message delivered to the component.
boolean	isEnded() Whether the renderer is ready for the ExoPlayer instance to transition to ExoPlayer.STATE_ENDED.
boolean	isReady() Whether the renderer is able to immediately render media from the current position.
protected void	onDisabled() Called when the renderer is disabled.
protected void	onEnabled(boolean joining) Called when the renderer is enabled.
protected void	onPositionReset(long positionUs, boolean joining) Called when the position is reset.
protected void	onStarted() Called when the renderer is started.
protected void	onStopped() Called when the renderer is stopped.
void	render(long positionUs, long elapsedRealtimeUs) Incrementally renders the SampleStream.
protected boolean	shouldDropOutputBuffer(long outputBufferTimeUs, long nextOutputBufferTimeUs, long positionUs, long joiningDeadlineMs) Returns whether the current frame should be dropped.
int	supportsFormat(Format format) Returns the extent to which the Renderer supports a given format.

Methods inherited from class com.google.android.exoplayer2.BaseRenderer

disable, enable, getCapabilities, getConfiguration, getIndex, getMediaClock, getState, getStream, getTrackType, hasReadStreamToEnd, isCurrentStreamFinal, isSourceReady, maybeThrowStreamError, onStreamChanged, readSource, replaceStream, resetPosition, setCurrentStreamFinal, setIndex, skipSource, start, stop, supportsMixedMimeTypeAdaptation

Methods inherited from class java.lang.Object

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

Field Detail

MSG_SET_OUTPUT_BUFFER_RENDERER

public static final int MSG_SET_OUTPUT_BUFFER_RENDERER

The type of a message that can be passed to an instance of this class via ExoPlayer.sendMessages(com.google.android.exoplayer2.ExoPlayer.ExoPlayerMessage...) or ExoPlayer.blockingSendMessages(com.google.android.exoplayer2.ExoPlayer.ExoPlayerMessage...). The message object should be the target VpxOutputBufferRenderer, or null.

See Also:

Constant Field Values

Constructor Detail

LibvpxVideoRenderer

public LibvpxVideoRenderer(boolean scaleToFit,
                           long allowedJoiningTimeMs)

Parameters:

scaleToFit - Whether video frames should be scaled to fit when rendering.

allowedJoiningTimeMs - The maximum duration in milliseconds for which this video renderer can attempt to seamlessly join an ongoing playback.

LibvpxVideoRenderer

public LibvpxVideoRenderer(boolean scaleToFit,
                           long allowedJoiningTimeMs,
                           Handler eventHandler,
                           VideoRendererEventListener eventListener,
                           int maxDroppedFramesToNotify)

Parameters:

scaleToFit - Whether video frames should be scaled to fit when rendering.

allowedJoiningTimeMs - The maximum duration in milliseconds for which this video renderer can attempt to seamlessly join an ongoing playback.

eventHandler - A handler to use when delivering events to eventListener. May be null if delivery of events is not required.

eventListener - A listener of events. May be null if delivery of events is not required.

maxDroppedFramesToNotify - The maximum number of frames that can be dropped between invocations of VideoRendererEventListener.onDroppedFrames(int, long).

LibvpxVideoRenderer

public LibvpxVideoRenderer(boolean scaleToFit,
                           long allowedJoiningTimeMs,
                           Handler eventHandler,
                           VideoRendererEventListener eventListener,
                           int maxDroppedFramesToNotify,
                           DrmSessionManager<ExoMediaCrypto> drmSessionManager,
                           boolean playClearSamplesWithoutKeys)

Parameters:

scaleToFit - Whether video frames should be scaled to fit when rendering.

allowedJoiningTimeMs - The maximum duration in milliseconds for which this video renderer can attempt to seamlessly join an ongoing playback.

eventHandler - A handler to use when delivering events to eventListener. May be null if delivery of events is not required.

eventListener - A listener of events. May be null if delivery of events is not required.

maxDroppedFramesToNotify - The maximum number of frames that can be dropped between invocations of VideoRendererEventListener.onDroppedFrames(int, long).

drmSessionManager - For use with encrypted media. May be null if support for encrypted media is not required.

playClearSamplesWithoutKeys - Encrypted media may contain clear (un-encrypted) regions. For example a media file may start with a short clear region so as to allow playback to begin in parallel with key acquisition. This parameter specifies whether the renderer is permitted to play clear regions of encrypted media files before drmSessionManager has obtained the keys necessary to decrypt encrypted regions of the media.

Method Detail

supportsFormat

public int supportsFormat(Format format)

Description copied from interface: RendererCapabilities

Returns the extent to which the Renderer supports a given format. The returned value is the bitwise OR of three properties:

• The level of support for the format itself. One of RendererCapabilities.FORMAT_HANDLED, RendererCapabilities.FORMAT_EXCEEDS_CAPABILITIES, RendererCapabilities.FORMAT_UNSUPPORTED_SUBTYPE and RendererCapabilities.FORMAT_UNSUPPORTED_TYPE.
• The level of support for adapting from the format to another format of the same mime type. One of RendererCapabilities.ADAPTIVE_SEAMLESS, RendererCapabilities.ADAPTIVE_NOT_SEAMLESS and RendererCapabilities.ADAPTIVE_NOT_SUPPORTED.
• The level of support for tunneling. One of RendererCapabilities.TUNNELING_SUPPORTED and RendererCapabilities.TUNNELING_NOT_SUPPORTED.

The individual properties can be retrieved by performing a bitwise AND with RendererCapabilities.FORMAT_SUPPORT_MASK, RendererCapabilities.ADAPTIVE_SUPPORT_MASK and RendererCapabilities.TUNNELING_SUPPORT_MASK respectively.

Parameters:

format - The format.

Returns:

The extent to which the renderer is capable of supporting the given format.

render

public void render(long positionUs,
                   long elapsedRealtimeUs)
            throws ExoPlaybackException

Description copied from interface: Renderer

Incrementally renders the SampleStream.

If the renderer is in the Renderer.STATE_ENABLED state then each call to this method will do work toward being ready to render the SampleStream when the renderer is started. It may also render the very start of the media, for example the first frame of a video stream. If the renderer is in the Renderer.STATE_STARTED state then calls to this method will render the SampleStream in sync with the specified media positions.

This method should return quickly, and should not block if the renderer is unable to make useful progress.

This method may be called when the renderer is in the following states: Renderer.STATE_ENABLED, Renderer.STATE_STARTED.

Parameters:

positionUs - The current media time in microseconds, measured at the start of the current iteration of the rendering loop.

elapsedRealtimeUs - SystemClock.elapsedRealtime() in microseconds, measured at the start of the current iteration of the rendering loop.

Throws:

ExoPlaybackException - If an error occurs.

shouldDropOutputBuffer

protected boolean shouldDropOutputBuffer(long outputBufferTimeUs,
                                         long nextOutputBufferTimeUs,
                                         long positionUs,
                                         long joiningDeadlineMs)

Returns whether the current frame should be dropped.

Parameters:

outputBufferTimeUs - The timestamp of the current output buffer.

nextOutputBufferTimeUs - The timestamp of the next output buffer or C.TIME_UNSET if the next output buffer is unavailable.

positionUs - The current playback position.

joiningDeadlineMs - The joining deadline.

Returns:

Returns whether to drop the current output buffer.

isEnded

public boolean isEnded()

Description copied from interface: Renderer

Whether the renderer is ready for the ExoPlayer instance to transition to ExoPlayer.STATE_ENDED. The player will make this transition as soon as true is returned by all of its Renderers.

This method may be called when the renderer is in the following states: Renderer.STATE_ENABLED, Renderer.STATE_STARTED.

Returns:

Whether the renderer is ready for the player to transition to the ended state.

isReady

public boolean isReady()

Description copied from interface: Renderer

Whether the renderer is able to immediately render media from the current position.

If the renderer is in the Renderer.STATE_STARTED state then returning true indicates that the renderer has everything that it needs to continue playback. Returning false indicates that the player should pause until the renderer is ready.

If the renderer is in the Renderer.STATE_ENABLED state then returning true indicates that the renderer is ready for playback to be started. Returning false indicates that it is not.

This method may be called when the renderer is in the following states: Renderer.STATE_ENABLED, Renderer.STATE_STARTED.

Returns:

Whether the renderer is ready to render media.

onEnabled

protected void onEnabled(boolean joining)
                  throws ExoPlaybackException

Description copied from class: BaseRenderer

Called when the renderer is enabled.

The default implementation is a no-op.

Overrides:

onEnabled in class BaseRenderer

Parameters:

joining - Whether this renderer is being enabled to join an ongoing playback.

Throws:

ExoPlaybackException - If an error occurs.

onPositionReset

protected void onPositionReset(long positionUs,
                               boolean joining)
                        throws ExoPlaybackException

Description copied from class: BaseRenderer

Called when the position is reset. This occurs when the renderer is enabled after BaseRenderer.onStreamChanged(Format[], long) has been called, and also when a position discontinuity is encountered.

After a position reset, the renderer's SampleStream is guaranteed to provide samples starting from a key frame.

The default implementation is a no-op.

Overrides:

onPositionReset in class BaseRenderer

Parameters:

positionUs - The new playback position in microseconds.

joining - Whether this renderer is being enabled to join an ongoing playback.

Throws:

ExoPlaybackException - If an error occurs.

onStarted

protected void onStarted()

Description copied from class: BaseRenderer

Called when the renderer is started.

The default implementation is a no-op.

Overrides:

onStarted in class BaseRenderer

onStopped

protected void onStopped()

Description copied from class: BaseRenderer

Called when the renderer is stopped.

The default implementation is a no-op.

Overrides:

onStopped in class BaseRenderer

onDisabled

protected void onDisabled()

Description copied from class: BaseRenderer

Called when the renderer is disabled.

The default implementation is a no-op.

Overrides:

onDisabled in class BaseRenderer

handleMessage

public void handleMessage(int messageType,
                          Object message)
                   throws ExoPlaybackException

Description copied from interface: ExoPlayer.ExoPlayerComponent

Handles a message delivered to the component. Called on the playback thread.

Specified by:

handleMessage in interface ExoPlayer.ExoPlayerComponent

Overrides:

handleMessage in class BaseRenderer

Parameters:

messageType - The message type.

message - The message.

Throws:

ExoPlaybackException - If an error occurred whilst handling the message.