Releases: androidx/media
Releases · androidx/media
1.5.0
This release includes the following changes since the 1.4.1 release:
- Common Library:
- Add
ForwardingSimpleBasePlayer
that allows forwarding to another player with small adjustments while ensuring full consistency and listener handling (#1183). - Replace
SimpleBasePlayer.State.playlist
bygetPlaylist()
method. - Add override for
SimpleBasePlayer.State.Builder.setPlaylist()
to directly specify aTimeline
and currentTracks
andMetadata
instead of building a playlist structure. - Increase
minSdk
to 21 (Android Lollipop). This is aligned with all other AndroidX libraries. - Add
androidx.media3:media3-common-ktx
artifact which provides Kotlin-specific functionality built on top of the Common library - Add
Player.listen
suspending extension function to spin a coroutine to listen toPlayer.Events
to themedia3-common-ktx
library. - Remove
@DoNotInline
annotations from manually out-of-lined inner classes designed to avoid runtime class verification failures. Recent versions of R8 now automatically out-of-line calls like these to avoid the runtime failures (so the manual out-of-lining is no longer required). All Gradle users of the library must already be a using a version of the Android Gradle Plugin that uses a version of R8 which does this, due tocompileSdk = 35
. Users of the library with non-Gradle build systems will need to ensure their R8-equivalent shrinking/obfuscating step does a similar automatic out-of-lining process in order to avoid runtime class verification failures. This change has already been done in other AndroidX libraries.
- Add
- ExoPlayer:
MediaCodecRenderer.onProcessedStreamChange()
can now be called for every media item. Previously it was not called for the first one. UseMediaCodecRenderer.experimentalEnableProcessedStreamChangedAtStart()
to enable this.- Add
PreloadMediaSource.PreloadControl.onPreloadError
to allowPreloadMediaSource.PreloadControl
implementations to take actions when error occurs. - Add
BasePreloadManager.Listener
to propagate preload events to apps. - Allow changing SNTP client timeout and retry alternative addresses on timeout (#1540).
- Remove
MediaCodecAdapter.Configuration.flags
as the field was always zero. - Allow the user to select the built-in speaker for playback on Wear OS API 35+ (where the device advertises support for this).
- Defer the blocking call to
Context.getSystemService(Context.AUDIO_SERVICE)
until audio focus handling is enabled. This ensures the blocking call isn't done if audio focus handling is not enabled (#1616). - Allow playback regardless of buffered duration when loading fails (#1571).
- Add
AnalyticsListener.onRendererReadyChanged()
to signal when individual renderers allow playback to be ready. - Fix
MediaCodec.CryptoException
sometimes being reported as an "unexpected runtime error" whenMediaCodec
is operated in asynchronous mode (default behaviour on API 31+). - Pass
bufferedDurationUs
instead ofbufferedPositionUs
withPreloadMediaSource.PreloadControl.onContinueLoadingRequested()
. Also changesDefaultPreloadManager.Status.STAGE_LOADED_TO_POSITION_MS
toDefaultPreloadManager.Status.STAGE_LOADED_FOR_DURATION_MS
, apps then need to pass a value representing a specific duration from the default start position for which the corresponding media source has to be preloaded with this IntDef, instead of a position. - Add
ForwardingRenderer
implementation that forwards all method calls to another renderer (1703). - Add playlist preloading for the next item in the playlist. Apps can enable preloading by calling
ExoPlayer.setPreloadConfiguration(PreloadConfiguration)
accordingly. By default preloading is disabled. When opted-in and to not interfere with playback,DefaultLoadControl
restricts preloading to start and continue only when the player is not loading for playback. Apps can change this behaviour by implementingLoadControl.shouldContinuePreloading()
accordingly (like when overriding this method inDefaultLoadControl
). The default implementation ofLoadControl
disables preloading in case an app is using a custom implementation ofLoadControl
. - Add method
MediaSourceEventListener.EventDispatcher.dispatchEvent()
to allow invoking events of subclass listeners (1736). - Add
DefaultPreloadManager.Builder
that builds theDefaultPreloadManager
andExoPlayer
instances with consistently shared configurations. - Remove
Renderer[]
parameter fromLoadControl.onTracksSelected()
asDefaultLoadControl
implementation can retrieve the stream types fromExoTrackSelection[]
. - Deprecated
DefaultLoadControl.calculateTargetBufferBytes(Renderer[], ExoTrackSelection[])
and marked method as final to prevent overrides. The newDefaultLoadControl.calculateTargetBufferBytes(ExoTrackSelection[])
should be used instead. - Report
MediaSourceEventListener
events from secondary sources inMergingMediaSource
. This will result in load start/error/cancelled/completed events being reported for sideloaded subtitles (those added withMediaItem.LocalConfiguration.subtitleConfigurations
), which may appear as duplicate load events emitted fromAnalyticsListener
. - Prevent subtitle & metadata errors from completely stopping playback. Instead the problematic track is disabled and playback of the remaining tracks continues (#1722).
- In new subtitle handling (during extraction), associated parse (e.g. invalid subtitle data) and load errors (e.g. HTTP 404) are emitted via
onLoadError
callbacks. - In legacy subtitle handling (during rendering), only associated load errors are emitted via
onLoadError
callbacks while parse errors are silently ignored (this is pre-existing behaviour).
- In new subtitle handling (during extraction), associated parse (e.g. invalid subtitle data) and load errors (e.g. HTTP 404) are emitted via
- Fix bug where playlist items or periods in multi-period DASH streams with durations that don't match the actual content could cause frame freezes at the end of the item (#1698).
- Add a setter to
SntpClient
to set the max elapsed time since the last update after which the client is re-initialized (#1794).
- Transformer:
- Add
SurfaceAssetLoader
, which supports queueing video data to Transformer via aSurface
. ImageAssetLoader
reports unsupported input viaAssetLoader.onError
instead of throwing anIllegalStateException
.- Make setting the image duration using
MediaItem.Builder.setImageDurationMs
mandatory for image export. - Add export support for gaps in sequences of audio EditedMediaItems.
- Add
- Track Selection:
DefaultTrackSelector
: Prefer object-based audio over channel-based audio when other factors are equal.
- Extractors:
- Allow
Mp4Extractor
andFragmentedMp4Extractor
to identify H264 samples that are not used as reference by subsequent samples. - Add option to enable index-based seeking in
AmrExtractor
. - Treat MP3 files with more than 128kB between valid frames as truncated (instead of invalid). This means files with non-MP3 data at the end, with no other metadata to indicate the length of the MP3 bytes, now stop playback at the end of the MP3 data instead of failing with
ParserException: Searched too many bytes.{contentIsMalformed=true, dataType=1}
(#1563). - Fix preroll sample handling for non-keyframe media start positions when processing edit lists in MP4 files (#1659).
- Improved frame rate calculation by using media duration from the
mdhd
box inMp4Extractor
andFragmentedMp4Extractor
(#1531). - Fix incorrect scaling of
media_time
in MP4 edit lists. Whilesegment_duration
was already correctly scaled using the movie timescale,media_time
is now properly scaled using the track timescale, as specified by the MP4 format standard (#1792). - Handle out-of-order frames in
endIndices
calculation for MP4 with edit list (#1797). - Fix media duration parsing in
mdhd
box of MP4 files to handle-1
values (#1819). - Add support for identifying
h263
box in MP4 files for H.263 video (#1821). - Add AC-4 Level-4 ISO base media file format support (#1265).
- Allow
- DataSource:
- Update
HttpEngineDataSource
to allow use starting at version S extension 7 instead of API level 34 (#1262). DataSourceContractTest
: Assert thatDataSource.getUri()
returns the resolved URI (as documented). Where this is different to the requested URI, tests can indicate this using the newDataSourceContractTest.TestResource.Builder.setResolvedUri()
method.DataSourceContractTest
: Assert thatDataSource.getUri()
andgetResponseHeaders()
return their 'open' value after a failed call toopen()
(due to a...
- Update
1.5.0-rc02
This release includes the following changes since the
1.5.0-rc01 release:
1.5.0-rc01
This release includes the following changes since the 1.5.0-beta01 release:
- ExoPlayer:
- Fix bug where playlist items or periods in multi-period DASH streams with durations that don't match the actual content could cause frame freezes at the end of the item (#1698).
- Add a setter to
SntpClient
to set the max elapsed time since the last update after which the client is re-initialized (#1794).
- Extractors:
- DataSource:
DataSourceContractTest
: Assert thatDataSource.getUri()
returns the resolved URI (as documented). Where this is different to the requested URI, tests can indicate this using the newDataSourceContractTest.TestResource.Builder.setResolvedUri()
method.DataSourceContractTest
: Assert thatDataSource.getUri()
andgetResponseHeaders()
return their 'open' value after a failed call toopen()
(due to a 'not found' resource) and before a subsequentclose()
call.- Overriding
DataSourceContractTest.getNotFoundResources()
allows test sub-classes to provide multiple 'not found' resources, and to provide any expected headers too. This allows to distinguish between HTTP 404 (with headers) and "server not found" (no headers).
- Overriding
- Text:
- RTSP Extension:
- Fix crashing when parsing of RTP packets with header extensions (#1225).
1.5.0-beta01
This release includes the following changes since the
1.5.0-alpha01 release:
- Common Library:
- Remove
@DoNotInline
annotations from manually out-of-lined inner classes designed to avoid runtime class verification failures. Recent versions of R8 now automatically out-of-line calls like these to avoid the runtime failures (so the manual out-of-lining is no longer required). All Gradle users of the library must already be a using a version of the Android Gradle Plugin that uses a version of R8 which does this, due tocompileSdk = 35
. Users of the library with non-Gradle build systems will need to ensure their R8-equivalent shrinking/obfuscating step does a similar automatic out-of-lining process in order to avoid runtime class verification failures. This change has already been done in other AndroidX libraries.
- Remove
- ExoPlayer:
- Fix
MediaCodec.CryptoException
sometimes being reported as an "unexpected runtime error" whenMediaCodec
is operated in asynchronous mode (default behaviour on API 31+). - Pass
bufferedDurationUs
instead ofbufferedPositionUs
withPreloadMediaSource.PreloadControl.onContinueLoadingRequested()
. Also changesDefaultPreloadManager.Status.STAGE_LOADED_TO_POSITION_MS
toDefaultPreloadManager.Status.STAGE_LOADED_FOR_DURATION_MS
, apps then need to pass a value representing a specific duration from the default start position for which the corresponding media source has to be preloaded with this IntDef, instead of a position. - Add
ForwardingRenderer
implementation that forwards all method calls to another renderer (1703). - Add playlist preloading for the next item in the playlist. Apps can enable preloading by calling
ExoPlayer.setPreloadConfiguration(PreloadConfiguration)
accordingly. By default preloading is disabled. When opted-in and to not interfere with playback,DefaultLoadControl
restricts preloading to start and continue only when the player is not loading for playback. Apps can change this behaviour by implementingLoadControl.shouldContinuePreloading()
accordingly (like when overriding this method inDefaultLoadControl
). The default implementation ofLoadControl
disables preloading in case an app is using a custom implementation ofLoadControl
. - Add method
MediaSourceEventListener.EventDispatcher.dispatchEvent()
to allow invoking events of subclass listeners (1736). - Add
DefaultPreloadManager.Builder
that builds theDefaultPreloadManager
andExoPlayer
instances with consistently shared configurations. - Remove
Renderer[]
parameter fromLoadControl.onTracksSelected()
asDefaultLoadControl
implementation can retrieve the stream types fromExoTrackSelection[]
. - Deprecated
DefaultLoadControl.calculateTargetBufferBytes(Renderer[], ExoTrackSelection[])
and marked method as final to prevent overrides. The newDefaultLoadControl.calculateTargetBufferBytes(ExoTrackSelection[])
should be used instead. - Report
MediaSourceEventListener
events from secondary sources inMergingMediaSource
. This will result in load start/error/cancelled/completed events being reported for sideloaded subtitles (those added withMediaItem.LocalConfiguration.subtitleConfigurations
), which may appear as duplicate load events emitted fromAnalyticsListener
. - Prevent subtitle & metadata errors from completely stopping playback. Instead the problematic track is disabled and playback of the remaining tracks continues (#1722).
- In new subtitle handling (during extraction), associated parse (e.g. invalid subtitle data) and load errors (e.g. HTTP 404) are emitted via
onLoadError
callbacks. - In legacy subtitle handling (during rendering), only associated load errors are emitted via
onLoadError
callbacks while parse errors are silently ignored (this is pre-existing behaviour).
- In new subtitle handling (during extraction), associated parse (e.g. invalid subtitle data) and load errors (e.g. HTTP 404) are emitted via
- Fix
- Transformer:
- Make setting the image duration using
MediaItem.Builder.setImageDurationMs
mandatory for image export. - Add export support for gaps in sequences of audio EditedMediaItems.
- Make setting the image duration using
- Track Selection:
DefaultTrackSelector
: Prefer object-based audio over channel-based audio when other factors are equal.
- Extractors:
- Fix preroll sample handling for non-keyframe media start positions when processing edit lists in MP4 files (#1659).
- Improved frame rate calculation by using media duration from the
mdhd
box inMp4Extractor
andFragmentedMp4Extractor
(#1531). - Fix incorrect scaling of
media_time
in MP4 edit lists. Whilesegment_duration
was already correctly scaled using the movie timescale,media_time
is now properly scaled using the track timescale, as specified by the MP4 format standard (#1792). - Handle out-of-order frames in
endIndices
calculation for MP4 with edit list (#1797).
- Audio:
- Fix pop sounds that may occur during seeks.
- Fix truncation error accumulation for Sonic's time-stretching/pitch-shifting algorithm.
- Fix bug in
SpeedChangingAudioProcessor
that causes dropped output frames.
- Video:
- Add workaround for a device issue on Galaxy Tab S7 FE that causes 60fps secure H264 streams to be marked as unsupported (#1619).
- Add workaround for codecs that get stuck after the last sample without returning an end-of-stream signal.
- Text:
- Ensure WebVTT in HLS with very large subtitle timestamps (which overflow a 64-bit
long
when represented as microseconds and multiplied by the90,000
MPEG timebase) are displayed (#1763).
- Ensure WebVTT in HLS with very large subtitle timestamps (which overflow a 64-bit
- Metadata:
- Assign the
C.TRACK_TYPE_METADATA
type to tracks containing icy or vnd.dvb.ait content.
- Assign the
- DRM:
- Fix
IllegalStateException
fromDefaultDrmSession.requiresSecureDecoder
after opening a DRM session failed. This issue was introduced in1.5.0-alpha01
.
- Fix
- IMA extension:
- Fix bug where server-side inserted DAI streams without a preroll can result in an
ArrayIndexOutOfBoundsException
when playing past the last midroll (#1741).
- Fix bug where server-side inserted DAI streams without a preroll can result in an
- Session:
- Fix bug that caused custom commands sent from a
MediaBrowser
being dispatched to theMediaSessionCompat.Callback
instead of theMediaBrowserServiceCompat
variant of the method when connected to a legacy service. This prevented theMediaBrowser
to receive the actual return value sent back by the legacy service (#1474). - Handle
IllegalArgumentException
thrown by devices of certain manufacturers when setting the broadcast receiver for media button intents (#1730). - Add command buttons for media items. This adds the Media3 API for what was known as
Custom browse actions
with the legacy library withMediaBrowserCompat
. Note that with Media3 command buttons for media items are available for both,MediaBrowser
andMediaController
. See Custom Browse actions of AAOS. - Fix bug where a Media3 controller was sometimes unable to let a session app start a foreground service after requesting
play()
. - Restrict
CommandButton.Builder.setIconUri
to only accept content Uris. - Pass connection hints of a Media3 browser to the initial
MediaBrowserCompat
when connecting to a legacyMediaBrowserCompat
. The service can receive the connection hints passed in as root hints with the first call toonGetRoot()
. - Fix bug where a
MediaBrowser
connected to a legacy browser service, didn't receive an error sent by the service after the browser has subscribed to aparentid
. - Improve interoperability behavior, so that a Media3 browser that is connected to a legacy
MediaBrowserService
doesn't request the children of aparentId
twice when subscribing to a parent.
- Fix bug that caused custom commands sent from a
- UI:
- Make the stretched/cropped video in
PlayerView
-in-Compose-AndroidView
workaround opt-in, due to issues with XML-based shared transitions. Apps usingPlayerView
insideAndroidView
need to callPlayerView.setEnableComposeSurfaceSyncWorkaround
in order to opt-in (#1237, #1594). - Add
setFullscreenButtonState
toPlayerView
to allow updates of fullscreen button's icon on demand, i.e. out-of-band and not reactively to a click interaction (#1590, #184). - Fix bug where the "None" choice in the text selection is not working if there are app-defined text track selection preferences.
- Make the stretched/cropped video in
- Smooth Streaming Extension:
- Fix a
Bad magic number for Bundle
error when playing SmoothStreaming streams with text tracks (#1779).
- Fix a
- RTSP Extension:
- Fix user info removal for URLs that contain encoded @ characters (#1138).
- Decoder Extensions (FFmpeg, VP9, AV1, etc.):
- Add 16 KB page support for decoder extensions on Android 15 ([#1685](https://github.com/a...
1.5.0-alpha01
This release includes the following changes since the
1.4.1 release:
- Common Library:
- Add
ForwardingSimpleBasePlayer
that allows forwarding to another player with small adjustments while ensuring full consistency and listener handling (#1183). - Replace
SimpleBasePlayer.State.playlist
bygetPlaylist()
method. - Add override for
SimpleBasePlayer.State.Builder.setPlaylist()
to directly specify aTimeline
and currentTracks
andMetadata
instead of building a playlist structure. - Increase
minSdk
to 21 (Android Lollipop). This is aligned with all other AndroidX libraries. - Add
androidx.media3:media3-common-ktx
artifact which provides Kotlin-specific functionality built on top of the Common library - Add
Player.listen
suspending extension function to spin a coroutine to listen toPlayer.Events
to themedia3-common-ktx
library.
- Add
- ExoPlayer:
MediaCodecRenderer.onProcessedStreamChange()
can now be called for every media item. Previously it was not called for the first one. UseMediaCodecRenderer.experimentalEnableProcessedStreamChangedAtStart()
to enable this.- Add
PreloadMediaSource.PreloadControl.onPreloadError
to allowPreloadMediaSource.PreloadControl
implementations to take actions when error occurs. - Add
BasePreloadManager.Listener
to propagate preload events to apps. - Allow changing SNTP client timeout and retry alternative addresses on timeout (#1540).
- Remove
MediaCodecAdapter.Configuration.flags
as the field was always zero. - Allow the user to select the built-in speaker for playback on Wear OS API 35+ (where the device advertises support for this).
- Defer the blocking call to
Context.getSystemService(Context.AUDIO_SERVICE)
until audio focus handling is enabled. This ensures the blocking call isn't done if audio focus handling is not enabled (#1616). - Allow playback regardless of buffered duration when loading fails (#1571).
- Add
AnalyticsListener.onRendererReadyChanged()
to signal when individual renderers allow playback to be ready.
- Transformer:
- Add
SurfaceAssetLoader
, which supports queueing video data to Transformer via aSurface
. ImageAssetLoader
reports unsupported input viaAssetLoader.onError
instead of throwing anIllegalStateException
.
- Add
- Extractors:
- Allow
Mp4Extractor
andFragmentedMp4Extractor
to identify H264 samples that are not used as reference by subsequent samples. - Add option to enable index-based seeking in
AmrExtractor
. - Treat MP3 files with more than 128kB between valid frames as truncated (instead of invalid). This means files with non-MP3 data at the end, with no other metadata to indicate the length of the MP3 bytes, now stop playback at the end of the MP3 data instead of failing with
ParserException: Searched too many bytes.{contentIsMalformed=true, dataType=1}
(#1563).
- Allow
- DataSource:
- Update
HttpEngineDataSource
to allow use starting at version S extension 7 instead of API level 34 (#1262).
- Update
- Audio:
- Automatically configure CTA-2075 loudness metadata on the codec if present in the media.
- Ensure smooth volume ramp down when seeking.
- Video:
MediaCodecVideoRenderer
avoids decoding samples that are neither rendered nor used as reference by other samples.- On API 35 and above,
MediaCodecAdapter
may now receive anull
Surface
inconfigure
and calls to a new methoddetachOutputSurface
to remove a previously setSurface
if the codec supports this (MediaCodecInfo.detachedSurfaceSupported
). - Use
MediaCodecAdapter
supplied pixel aspect ratio values if provided when processingonOutputFormatChanged
(#1371).
- Text:
- Add a custom
VoiceSpan
and populate it for WebVTT voice spans (#1632).
- Add a custom
- Image:
- Add
ExternallyLoadedImageDecoder
for simplified integration with external image loading libraries like Glide or Coil.
- Add
- DataSource:
- Add
FileDescriptorDataSource
, a newDataSource
that can be used to read from aFileDescriptor
(#3757).
- Add
- Effect:
- Add
DefaultVideoFrameProcessor
workaround for minorSurfaceTexture
scaling.SurfaceTexture
may include a small scaling that cuts off a 1-texel border around the edge of a cropped buffer. This is now handled such that output is closer to expected. - Speed up
DefaultVideoFrameProcessor.queueInputBitmap()
. As a result, exporting images to videos withTransformer
is faster.
- Add
- IMA extension:
- Fix bug where clearing the playlist may cause an
ArrayIndexOutOfBoundsException
inImaServerSideAdInsertionMediaSource
.
- Fix bug where clearing the playlist may cause an
- Session:
- Add
MediaButtonReceiver.shouldStartForegroundService(Intent)
to allow apps to suppress a play command coming in for playback resumption by overriding this method. By default, the service is always started and playback can't be suppressed without the system crashing the service with aForegroundServiceDidNotStartInTimeException
(#1528).
- Add
- DASH Extension:
- Add support for periods starting in the middle of a segment (#1440).
- Decoder Extensions (FFmpeg, VP9, AV1, etc.):
- Add the IAMF decoder module, which provides support for playback of MP4 files containing IAMF tracks using the libiamf native library to synthesize audio.
- Playback is enabled with a stereo layout as well as 5.1 with spatialization together with optional head tracking enabled, but binaural playback support is currently not available.
- Add the IAMF decoder module, which provides support for playback of MP4 files containing IAMF tracks using the libiamf native library to synthesize audio.
- Cast Extension:
- Stop clearning the timeline after the CastSession disconnects, which enables the sender app to resume playback locally after a disconnection.
- Populate CastPlayer's
DeviceInfo
when aContext
is provided. This enables linking theMediaSession
to aRoutingSession
, which is necessary for integrating Output Switcher (#1056).
- Test Utilities:
DataSourceContractTest
now includes tests to verify:- Input stream
read position
is updated. - Output buffer
offset
is applied correctly.
- Input stream
- Remove deprecated symbols:
- Remove deprecated
Player.hasPrevious
,Player.hasPreviousWindow()
. UsePlayer.hasPreviousMediaItem()
instead. - Remove deprecated
Player.previous()
method. UsePlayer.seekToPreviousMediaItem()
instead. - Remove deprecated
DrmSessionEventListener.onDrmSessionAcquired
method.
- Remove deprecated
1.4.1
This release includes the following changes since the 1.4.0 release:
- ExoPlayer:
- Extractors:
- MP3: Fix
Searched too many bytes
error by correctly ignoring trailing non-MP3 data based on the length field in anInfo
frame (#1480).
- MP3: Fix
- Text:
- TTML: Fix handling of percentage
tts:fontSize
values to ensure they are correctly inherited from parent nodes with percentagetts:fontSize
values. - Fix
IndexOutOfBoundsException
inLegacySubtitleUtil
due to incorrectly handling the case of the requested output start time being greater than or equal to the final event time in theSubtitle
(#1516).
- TTML: Fix handling of percentage
- DRM:
- Fix
android.media.MediaCodec$CryptoException: Operation not supported in this configuration: ERROR_DRM_CANNOT_HANDLE
error on API 31+ devices playing L1 Widevine content. This error is caused by an incomplete implementation of the frameworkMediaDrm.requiresSecureDecoder
method (#1603).
- Fix
- Effect:
- Add a
release()
method toGlObjectsProvider
.
- Add a
- Session:
- Transform a double-tap of
KEYCODE_HEADSETHOOK
into a 'seek to next' action, as documented (#1493). - Handle
KEYCODE_HEADSETHOOK
as a 'play' command inMediaButtonReceiver
when deciding whether to ignore it to avoid aForegroundServiceDidNotStartInTimeException
(#1581).
- Transform a double-tap of
- RTSP Extension:
- Skip invalid Media Descriptions in SDP parsing (#1087).
1.4.0
This release includes the following changes since the 1.3.1 release:
- Common Library:
- Forward presumed no-op seek calls to the protected
BasePlayer.seekTo()
andSimpleBasePlayer.handleSeek()
methods instead of ignoring them. If you are implementing these methods in a custom player, you may need to handle these additional calls withmediaItemIndex == C.INDEX_UNSET
. - Remove compile dependency on enhanced Java 8 desugaring (#1312).
- Ensure the duration passed to
MediaItem.Builder.setImageDurationMs()
is ignored for a non-imageMediaItem
(as documented). - Add
Format.customData
to store app-provided custom information aboutFormat
instances.
- Forward presumed no-op seek calls to the protected
- ExoPlayer:
- Add
BasePreloadManager
which coordinates the preloading for multiple sources based on the priorities defined by theirrankingData
. Customization is possible by extending this class. AddDefaultPreloadManager
which usesPreloadMediaSource
to preload media samples of the sources into memory, and uses an integerrankingData
that indicates the index of an item on the UI. - Add
PlayerId
to most methods ofLoadControl
to enableLoadControl
implementations to support multiple players. - Remove
Buffer.isDecodeOnly()
andC.BUFFER_FLAG_DECODE_ONLY
. There is no need to set this flag as renderers and decoders will decide to skip buffers based on timestamp. CustomRenderer
implementations should check if the buffer time is at leastBaseRenderer.getLastResetPositionUs()
to decide whether a sample should be shown. CustomSimpleDecoder
implementations can checkisAtLeastOutputStartTimeUs()
if needed or mark other buffers withDecoderOutputBuffer.shouldBeSkipped
to skip them. - Allow a null value to be returned by
TargetPreloadStatusControl.getTargetPreloadStatus(T)
to indicate not to preload aMediaSource
with the givenrankingData
. - Add
remove(MediaSource)
toBasePreloadManager
. - Add
reset()
toBasePreloadManager
to release all the holding sources while keep the preload manager instance. - Add
ExoPlayer.setPriority()
(andBuilder.setPriority()
) to define the priority value used inPriorityTaskManager
and for MediaCodec importance from API 35. - Fix issue with updating the last rebuffer time which resulted in incorrect
bs
(buffer starvation) key in CMCD (#1124). - Add
PreloadMediaSource.PreloadControl.onLoadedToTheEndOfSource(PreloadMediaSource)
to indicate that the source has loaded to the end. This allows theDefaultPreloadManager
and the customPreloadMediaSource.PreloadControl
implementations to preload the next source or take other actions. - Fix bug where silence skipping at the end of items can trigger a playback exception.
- Add
clear
toPreloadMediaSource
to discard the preloading period. - Add new error code
PlaybackException.ERROR_CODE_DECODING_RESOURCES_RECLAIMED
that is used when codec resources are reclaimed for higher priority tasks. - Let
AdsMediaSource
load preroll ads before initial content media preparation completes (#1358). - Fix bug where playback moved to
STATE_ENDED
when re-preparing a multi-period DASH live stream after the original period was already removed from the manifest. - Rename
onTimelineRefreshed()
toonSourcePrepared()
andonPrepared()
toonTracksSelected()
inPreloadMediaSource.PreloadControl
. Also rename the IntDefs inDefaultPreloadManager.Stage
accordingly. - Add experimental support for dynamic scheduling to better align work with CPU wake-cycles and delay waking up to when renderers can progress. You can enable this using
experimentalSetDynamicSchedulingEnabled()
when setting up your ExoPlayer instance. - Add
Renderer.getDurationToProgressUs()
. ARenderer
can implement this method to return to ExoPlayer the duration that playback must advance for the renderer to progress. IfExoPlayer
is set withexperimentalSetDynamicSchedulingEnabled()
thenExoPlayer
will call this method when calculating the time to schedule its work task. - Add
MediaCodecAdapter#OnBufferAvailableListener
to alert when input and output buffers are available for use byMediaCodecRenderer
.MediaCodecRenderer
will signalExoPlayer
when receiving these callbacks and ifExoPlayer
is set withexperimentalSetDynamicSchedulingEnabled()
, thenExoPlayer
will schedule its work loop as renderers can make progress. - Use data class for
LoadControl
methods instead of individual parameters. - Add
ExoPlayer.isReleased()
to check whetherExoplayer.release()
has been called. - Add
ExoPlayer.Builder.setMaxSeekToPreviousPositionMs()
to configure the maximum position for whichseekToPrevious()
seeks to the previous item (#1425). - Fix some audio focus inconsistencies, e.g. not reporting full or transient focus loss while the player is paused (#1436).
- Fix potential
IndexOutOfBoundsException
caused by extractors reporting additional tracks after the initial preparation step (#1476). Effects
inExoPlayer.setVideoEffect()
will receive the timestamps with the renderer offset removed (#1098).- Fix potential
IllegalArgumentException
when handling player error that happened while reading ahead into another playlist item (#1483).
- Add
- Transformer:
- Add
audioConversionProcess
andvideoConversionProcess
toExportResult
indicating how the respective track in the output file was made. - Relax trim optimization H.264 level checks.
- Add support for changing between SDR and HDR input media in a sequence.
- Add support for composition-level audio effects.
- Add support for transcoding Ultra HDR images into HDR videos.
- Fix issue where the
DefaultAudioMixer
does not output the correct amount of bytes after being reset and reused. - Work around a decoder bug where the number of audio channels was capped at stereo when handling PCM input.
- When selecting tracks in
ExoPlayerAssetLoader
, ignore audio channel count constraints as they only apply for playback. - Replace
androidx.media3.transformer.Muxer
interface withandroidx.media3.muxer.Muxer
and removeandroidx.media3.transformer.Muxer
. - Fix HEIC image loading from content URI schemes (#1373).
- Adjust audio track duration in
AudioGraphInput
to improve AV sync. - Remove
ExportResult.processedInputs
field. If you use this field for codec details, then useDefaultDecoderFactory.listener
instead. In case of a codec exception, codec details will be available in theExportException.codecInfo
.
- Add
- Extractors:
- MPEG-TS: Roll forward the change ensuring the last frame is rendered by passing the last access unit of a stream to the sample queue (#7909). Incorporating fixes to resolve the issues that emerged in I-frame only HLS streams(#1150) and H.262 HLS streams (#1126).
- MP3: Prefer the data size from an
Info
frame over the size reported by the underlying stream (e.g. file size, or HTTPContent-Length
header). This helps to exclude non-playable trailer data (e.g. album artwork) from constant bitrate seeking calculations, making seeks more accurate (#1376). - MP3: Use the frame count and other data in an
Info
frame (if present) to compute an average bitrate for constant bitrate seeking, rather than extrapolating from the bitrate of the frame after theInfo
frame, which may be artificially small, e.g.PCUT
frame (#1376). - Fix PCM audio format extraction in AVI containers.
- Audio:
- Fix DTS:X Profile 2 encoding attributes for passthrough playback (#1299).
- For offloaded playback, reset the tracking field for stream completion in
DefaultAudioSink
prior to callingAudioTrack.stop()
so thatAudioTrack.StreamEventCallback#onPresentationEnded
correctly identifies when all pending data has been played. - Fix bug in
SilenceSkippingAudioProcessor
where transitions between different audio formats (for example stereo to mono) can cause the processor to throw an exception (#1352). - Implement
MediaCodecAudioRenderer.getDurationToProgressUs()
so that ExoPlayer will dynamically schedule its main work loop to when the MediaCodecAudioRenderer can make progress.
- Video:
- Fix issue where
Listener.onRenderedFirstFrame()
arrives too early when switching surfaces mid-playback. - Fix decoder fallback logic for Dolby Vision to use a compatible AV1 decoder if needed (#1389).
- Fix codec exception that may be caused by enabling a video renderer mid-playback.
- Fix issue where
- Text:
- Fix issue where subtitles starting before a seek position are skipped. This issue was only introduced in Media3 1.4.0-alpha01.
- Change default subtitle parsing behavior so it happens during extraction instead of during rendering (see ExoPlayer's architecture diagram for the difference between extraction and rendering).
...
1.4.0-rc01
This release includes the following changes since the 1.4.0-beta01 release:
- Common Library:
- Add
Format.customData
to store app-provided custom information aboutFormat
instances.
- Add
- ExoPlayer:
- Fix some audio focus inconsistencies, e.g. not reporting full or transient focus loss while the player is paused (#1436).
- Fix potential
IndexOutOfBoundsException
caused by extractors reporting additional tracks after the initial preparation step (#1476). Effects
inExoPlayer.setVideoEffect()
will receive the timestamps with the renderer offset removed (#1098).- Fix potential
IllegalArgumentException
when handling player error that happened while reading ahead into another playlist item (#1483).
- Text:
- Fix an
IllegalArgumentException
fromLegacySubtitleUtil
when a WebVTT subtitle sample contains no cues, e.g. as part of a DASH stream (#1516).
- Fix an
- Session:
- Allow the session activity to be set per controller to override the global session activity. The session activity can be defined for a controller at connection time by creating a
ConnectionResult
withAcceptedResultBuilder.setSessionActivivty(PendingIntent)
. Once connected, the session activity can be updated withMediaSession.setSessionActivity(ControllerInfo, PendingIntent)
. - Improve error replication of calls to
MediaLibrarySession.Callback
. Error replication can now be configured by usingMediaLibrarySession.Builder.setLibraryErrorReplicationMode()
for choosing the error type or opt-ing out of error replication which is on by default.
- Allow the session activity to be set per controller to override the global session activity. The session activity can be defined for a controller at connection time by creating a
- UI:
- Work around a platform bug causing stretched/cropped video when using
SurfaceView
inside a ComposeAndroidView
on API 34 (#1237).
- Work around a platform bug causing stretched/cropped video when using
- Demo app:
- Use
HttpEngineDataSource
as theHttpDataSource
when supported by the device.
- Use
1.4.0-beta01
- ExoPlayer:
- Add
ExoPlayer.isReleased()
to check whetherExoplayer.release()
has been called. - Add
ExoPlayer.Builder.setMaxSeekToPreviousPositionMs
to configure the maximum position for whichseekToPrevious()
seeks to the previous item (#1425).
- Add
- Transformer:
- Remove
ExportResult.processedInputs
field. If you use this field for codec details, then useDefaultDecoderFactory.listener
instead. In case of a codec exception, codec details will be available in theExportException.codecInfo
.
- Remove
- Extractors:
- Fix PCM audio format extraction in AVI containers.
- Image:
- Allow
null
as parameter forExoPlayer.setImageOutput
to clear a previously setImageOutput
.
- Allow
- Effect:
- Remove unused
OverlaySettings.useHdr
since dynamic range of overlay - Add HDR support for
TextOverlay
. Luminance of the text overlay can be adjusted withOverlaySettings.setHdrLuminanceMultiplier
.
- Remove unused
- Session:
- Add
MediaSession.Callback.onPlayerInteractionFinished
to inform sessions when a series of player interactions from a specific controller finished. - Add
SessionError
and use it inSessionResult
andLibraryResult
instead of the error code to provide more information about the error and how to resolve the error if possible. - Publish the code for the media3 controller test app that can be used to test interactions with apps publishing a media session.
- Propagate extras passed to media3's
MediaSession[Builder].setSessionExtras()
to a media1 controller'sPlaybackStateCompat.getExtras()
. - Map fatal and non-fatal errors to and from the platform session. A
PlaybackException
is mapped to a fatal error state of thePlaybackStateCompat
. ASessionError
sent to the media notification controller withMediaSession.sendError(ControllerInfo, SessionError)
is mapped to a non-fatal error inPlaybackStateCompat
which means that error code and message are set but the state of the platform session remains different toSTATE_ERROR
.
- Add
- UI:
- HLS Extension:
- Fix a bug where non-primary playing playlists are not refreshed during live playback (#1240).
- Remove deprecated symbols:
- Remove
Bundleable
interface. This includes removing allBundleable.Creator<Foo> CREATOR
constant fields. Callers should use theBundle toBundle()
andstatic Foo fromBundle(Bundle)
methods on each type instead.
- Remove
1.4.0-alpha02
This release includes the following changes since the 1.4.0-alpha01 release:
- Common Library:
- Forward presumed no-op seek calls to the protected
BasePlayer.seekTo
andSimpleBasePlayer.handleSeek
methods instead of ignoring them. If you are implementing these methods in a custom player, you may need to handle these additional calls withmediaItemIndex == C.INDEX_UNSET
. - Remove compile dependency on enhanced Java 8 desugaring (#1312).
- Ensure the duration passed to
MediaItem.Builder.setImageDurationMs
is ignored for a non-imageMediaItem
(as documented).
- Forward presumed no-op seek calls to the protected
- ExoPlayer:
- Add
reset
toBasePreloadManager
to release all the holding sources while keep the preload manager instance. - Add
ExoPlayer.setPriority
(andBuilder.setPriority
) to define the priority value used inPriorityTaskManager
and for MediaCodec importance from API 35. - Fix issue with updating the last rebuffer time which resulted in incorrect
bs
(buffer starvation) key in CMCD (#1124). - Add
PreloadMediaSource.PreloadControl.onLoadedToTheEndOfSource(PreloadMediaSource)
to indicate that the source has loaded to the end. This allows theDefaultPreloadManager
and the customPreloadMediaSource.PreloadControl
implementations to preload the next source or take other actions. - Fix bug where silence skipping at the end of items can trigger a playback exception.
- Add
clear
toPreloadMediaSource
to discard the preloading period. - Add new error code
PlaybackException.ERROR_CODE_DECODING_RESOURCES_RECLAIMED
that is used when codec resources are reclaimed for higher priority tasks. - Let
AdsMediaSource
load preroll ads before initial content media preparation completes (#1358). - Fix bug where playback moved to
STATE_ENDED
when re-preparing a multi-period DASH live stream after the original period was already removed from the manifest. - Rename
onTimelineRefreshed
toonSourcePrepared
andonPrepared
toonTracksSelected
inPreloadMediaSource.PreloadControl
. Also rename the IntDefs inDefaultPreloadManager.Stage
accordingly. - Add experimental support for dynamic scheduling to better align work with CPU wake-cycles and delay waking up to when renderers can progress. You can enable this using
experimentalSetDynamicSchedulingEnabled
when setting up your ExoPlayer instance. - Add
Renderer.getDurationToProgressMs
. ARenderer
can implement this method to return to ExoPlayer the duration that playback must advance for the renderer to progress. IfExoPlayer
is set withexperimentalSetDynamicSchedulingEnabled
thenExoPlayer
will call this method when calculating the time to schedule its work task. - Add
MediaCodecAdapter#OnBufferAvailableListener
to alert when input and output buffers are available for use byMediaCodecRenderer
.MediaCodecRenderer
will signalExoPlayer
when receiving these callbacks and ifExoPlayer
is set withexperimentalSetDynamicSchedulingEnabled
, thenExoPlayer
will schedule its work loop as renderers can make progress. - Use data class for
LoadControl
methods instead of individual parameters.
- Add
- Transformer:
- Work around a decoder bug where the number of audio channels was capped at stereo when handling PCM input.
- When selecting tracks in
ExoPlayerAssetLoader
, ignore audio channel count constraints as they only apply for playback. - Replace
androidx.media3.transformer.Muxer
interface withandroidx.media3.muxer.Muxer
and removeandroidx.media3.transformer.Muxer
. - Fix HEIC image loading from content URI schemes (#1373).
- Adjust audio track duration in
AudioGraphInput
to improve AV sync.
- Extractors:
- MPEG-TS: Roll forward the change ensuring the last frame is rendered by passing the last access unit of a stream to the sample queue (#7909). Incorporating fixes to resolve the issues that emerged in I-frame only HLS streams(#1150) and H.262 HLS streams (#1126).
- MP3: Prefer the data size from an
Info
frame over the size reported by the underlying stream (e.g. file size, or HTTPContent-Length
header). This helps to exclude non-playable trailer data (e.g. album artwork) from constant bitrate seeking calculations, making seeks more accurate (#1376). - MP3: Use the frame count and other data in an
Info
frame (if present) to compute an average bitrate for constant bitrate seeking, rather than extrapolating from the bitrate of the frame after theInfo
frame, which may be artificially small, e.g.PCUT
frame (#1376).
- Audio:
- Fix DTS:X Profile 2 encoding attributes for passthrough playback (#1299).
- For offloaded playback, reset the tracking field for stream completion in
DefaultAudioSink
prior to callingAudioTrack.stop()
so thatAudioTrack.StreamEventCallback#onPresentationEnded
correctly identifies when all pending data has been played. - Fix bug in
SilenceSkippingAudioProcessor
where transitions between different audio formats (for example stereo to mono) can cause the processor to throw an exception (#1352). - Implement
MediaCodecAudioRenderer.getDurationToProgressUs
so that ExoPlayer will dynamically schedule its main work loop to when the MediaCodecAudioRenderer can make progress.
- Video:
- Fix decoder fallback logic for Dolby Vision to use a compatible AV1 decoder if needed (#1389).
- Text:
- Fix issue where subtitles starting before a seek position are skipped. This issue was only introduced in Media3 1.4.0-alpha01.
- Change default subtitle parsing behavior so it happens during extraction instead of during rendering (see ExoPlayer's architecture diagram for the difference between extraction and rendering).
- This change can be overridden by calling both
MediaSource.Factory.experimentalParseSubtitlesDuringExtraction(false)
andTextRenderer.experimentalSetLegacyDecodingEnabled(true)
. See the docs on customization for how to plumb these components into anExoPlayer
instance. These methods (and all support for legacy subtitle decoding) will be removed in a future release. - Apps with custom
SubtitleDecoder
implementations need to update them to implementSubtitleParser
instead (andSubtitleParser.Factory
instead ofSubtitleDecoderFactory
).
- This change can be overridden by calling both
- PGS: Fix run-length decoding to resolve
0
as a color index, instead of a literal color value (#1367). - CEA-708: Ignore
rowLock
value. The CEA-708-E S-2023 spec states thatrowLock
andcolumnLock
should both be assumed to be true, regardless of the values present in the stream (columnLock
support is not implemented, so it's effectively assumed to always be false).- This was originally included in the
1.3.0-alpha01
release notes, but the change was accidentally reverted before the1.3.0-rc01
release. This is now fixed, so the change is present again.
- This was originally included in the
- CEA-708: Avoid duplicate newlines being added by ExoPlayer's naive handling of the 'set pen location' command (#1315).
- Metadata:
- Fix mapping of MP4 to ID3 sort tags. Previously the 'album sort' (
soal
), 'artist sort' (soar
) and 'album artist sort' (soaa
) MP4 tags were wrongly mapped to theTSO2
,TSOA
andTSOP
ID3 tags (#1302). - Fix reading of MP4 (/iTunes) numeric
gnre
(genre) andtmpo
(tempo) tags when the value is more than one byte long. - Propagate ID3
TCON
frame toMediaMetadata.genre
(#1305).
- Fix mapping of MP4 to ID3 sort tags. Previously the 'album sort' (
- Image:
- Add support for non-square DASH thumbnail grids (#1300).
- Add support for AVIF for API 34+.
- DataSource:
- Allow
ByteArrayDataSource
to resolve a URI to a byte array duringopen()
, instead of being hard-coded at construction (#1405).
- Allow
- DRM:
- Allow setting a
LoadErrorHandlingPolicy
onDefaultDrmSessionManagerProvider
(#1271).
- Allow setting a
- Effect:
- Fix bug where
TimestampWrapper
crashes when used withExoPlayer#setVideoEffects
(#821). - Change default SDR color working space from linear colors to electrical BT 709 SDR video. Also provide third option to retain the original colorspace.
- Allow defining indeterminate z-order of EditedMediaItemSequences (#1055).
- Maintain a consistent luminance range across different pieces of HDR content (uses the HLG range).
- Add support for Ultra HDR (bitmap) overlays on HDR content.
- Allow
SeparableConvolution
effects to be used before API 26.
- Fix bug where
- IMA extension:
- Promote API that is required for apps to play DAI ad streams to stable.
- Add
replaceAdTagParameters(Map <String, String>)
...