5.3 KiB
ExoPlayer AV1 extension
The AV1 extension provides Libgav1VideoRenderer
, which uses libgav1 native
library to decode AV1 videos.
License note
Please note that whilst the code in this repository is licensed under Apache 2.0, using this extension also requires building and including one or more external libraries as described below. These are licensed separately.
Build instructions (Linux, macOS)
To use this extension you need to clone the ExoPlayer repository and depend on its modules locally. Instructions for doing this can be found in ExoPlayer's top level README.
In addition, it's necessary to fetch cpu_features library and libgav1 with its dependencies as follows:
- Set the following environment variables:
cd "<path to exoplayer checkout>"
EXOPLAYER_ROOT="$(pwd)"
AV1_EXT_PATH="${EXOPLAYER_ROOT}/extensions/av1/src/main"
- Fetch cpu_features library:
cd "${AV1_EXT_PATH}/jni" && \
git clone https://github.com/google/cpu_features
- Fetch libgav1:
cd "${AV1_EXT_PATH}/jni" && \
git clone https://chromium.googlesource.com/codecs/libgav1 libgav1
- Fetch Abseil:
cd "${AV1_EXT_PATH}/jni/libgav1" && \
git clone https://github.com/abseil/abseil-cpp.git third_party/abseil-cpp
Having followed these steps, gradle will build the extension automatically when run on the command line or via Android Studio, using CMake and Ninja to configure and build libgav1 and the extension's JNI wrapper library.
Build instructions (Windows)
We do not provide support for building this extension on Windows, however it should be possible to follow the Linux instructions in Windows PowerShell.
Using the extension
Once you've followed the instructions above to check out, build and depend on
the extension, the next step is to tell ExoPlayer to use Libgav1VideoRenderer
.
How you do this depends on which player API you're using:
- If you're passing a
DefaultRenderersFactory
toSimpleExoPlayer.Builder
, you can enable using the extension by setting theextensionRendererMode
parameter of theDefaultRenderersFactory
constructor toEXTENSION_RENDERER_MODE_ON
. This will useLibgav1VideoRenderer
for playback ifMediaCodecVideoRenderer
doesn't support decoding the input AV1 stream. PassEXTENSION_RENDERER_MODE_PREFER
to giveLibgav1VideoRenderer
priority overMediaCodecVideoRenderer
. - If you've subclassed
DefaultRenderersFactory
, add aLibvgav1VideoRenderer
to the output list inbuildVideoRenderers
. ExoPlayer will use the firstRenderer
in the list that supports the input media format. - If you've implemented your own
RenderersFactory
, return aLibgav1VideoRenderer
instance fromcreateRenderers
. ExoPlayer will use the firstRenderer
in the returned array that supports the input media format. - If you're using
ExoPlayer.Builder
, pass aLibgav1VideoRenderer
in the array ofRenderer
s. ExoPlayer will use the firstRenderer
in the list that supports the input media format.
Note: These instructions assume you're using DefaultTrackSelector
. If you have
a custom track selector the choice of Renderer
is up to your implementation.
You need to make sure you are passing a Libgav1VideoRenderer
to the player and
then you need to implement your own logic to use the renderer for a given track.
Using the extension in the demo application
To try out playback using the extension in the demo application, see enabling extension decoders.
Rendering options
There are two possibilities for rendering the output Libgav1VideoRenderer
gets from the libgav1 decoder:
-
GL rendering using GL shader for color space conversion
- If you are using
SimpleExoPlayer
withPlayerView
, enable this option by settingsurface_type
ofPlayerView
to bevideo_decoder_gl_surface_view
. - Otherwise, enable this option by sending
Libgav1VideoRenderer
a message of typeC.MSG_SET_VIDEO_DECODER_OUTPUT_BUFFER_RENDERER
with an instance ofVideoDecoderOutputBufferRenderer
as its object.
- If you are using
-
Native rendering using
ANativeWindow
- If you are using
SimpleExoPlayer
withPlayerView
, this option is enabled by default. - Otherwise, enable this option by sending
Libgav1VideoRenderer
a message of typeC.MSG_SET_SURFACE
with an instance ofSurfaceView
as its object.
- If you are using
Note: Although the default option uses ANativeWindow
, based on our testing the
GL rendering mode has better performance, so should be preferred
Links
- Javadoc: Classes matching
com.google.android.exoplayer2.ext.av1.*
belong to this module.