|
9 months ago | |
---|---|---|
.. | ||
src | 9 months ago | |
README.md | 9 months ago | |
build.gradle | 9 months ago | |
proguard-rules.txt | 9 months ago |
README.md
ExoPlayer Flac extension
The Flac extension provides FlacExtractor
and LibflacAudioRenderer
, which
use libFLAC (the Flac decoding library) to extract and decode FLAC audio.
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 build the extension's native components as follows:
- Set the following environment variables:
cd "<path to exoplayer checkout>"
EXOPLAYER_ROOT="$(pwd)"
FLAC_EXT_PATH="${EXOPLAYER_ROOT}/extensions/flac/src/main"
- Download the Android NDK and set its location in an environment variable. This build configuration has been tested on NDK r20.
NDK_PATH="<path to Android NDK>"
- Download and extract flac-1.3.2 as "${FLAC_EXT_PATH}/jni/flac" folder:
cd "${FLAC_EXT_PATH}/jni" && \
curl https://ftp.osuosl.org/pub/xiph/releases/flac/flac-1.3.2.tar.xz | tar xJ && \
mv flac-1.3.2 flac
- Build the JNI native libraries from the command line:
cd "${FLAC_EXT_PATH}"/jni && \
${NDK_PATH}/ndk-build APP_ABI=all -j4
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 the extractor and/or renderer.
Using FlacExtractor
FlacExtractor
is used via ExtractorMediaSource
. If you're using
DefaultExtractorsFactory
, FlacExtractor
will automatically be used to read
.flac
files. If you're not using DefaultExtractorsFactory
, return a
FlacExtractor
from your ExtractorsFactory.createExtractors
implementation.
Using LibflacAudioRenderer
- 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 useLibflacAudioRenderer
for playback ifMediaCodecAudioRenderer
doesn't support the input format. PassEXTENSION_RENDERER_MODE_PREFER
to giveLibflacAudioRenderer
priority overMediaCodecAudioRenderer
. - If you've subclassed
DefaultRenderersFactory
, add aLibflacAudioRenderer
to the output list inbuildAudioRenderers
. ExoPlayer will use the firstRenderer
in the list that supports the input media format. - If you've implemented your own
RenderersFactory
, return aLibflacAudioRenderer
instance fromcreateRenderers
. ExoPlayer will use the firstRenderer
in the returned array that supports the input media format. - If you're using
ExoPlayer.Builder
, pass aLibflacAudioRenderer
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,
so you need to make sure you are passing an LibflacAudioRenderer
to the
player, then 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.
Links
- Javadoc: Classes matching
com.google.android.exoplayer2.ext.flac.*
belong to this module.