2024-12-09
·
54 commits
to main
since this release
Media3: v1.5.0
November 27, 2024
androidx.media3:media3-*:1.5.0 is released. Version 1.5.0 contains these commits.
- Common Library:
- Add
ForwardingSimpleBasePlayerthat allows forwarding to another player with small adjustments while ensuring full consistency and listener handling (#1183). - Replace
SimpleBasePlayer.State.playlistbygetPlaylist()method. - Add override for
SimpleBasePlayer.State.Builder.setPlaylist()to directly specify aTimelineand currentTracksandMetadatainstead of building a playlist structure. - Increase
minSdkto 21 (Android Lollipop). This is aligned with all other AndroidX libraries. - Add
androidx.media3:media3-common-ktxartifact which provides Kotlin-specific functionality built on top of the Common library - Add
Player.listensuspending extension function to spin a coroutine to listen toPlayer.Eventsto themedia3-common-ktxlibrary. - Remove
@DoNotInlineannotations 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.onPreloadErrorto allowPreloadMediaSource.PreloadControlimplementations to take actions when error occurs. - Add
BasePreloadManager.Listenerto propagate preload events to apps. - Allow changing SNTP client timeout and retry alternative addresses on timeout (#1540).
- Remove
MediaCodecAdapter.Configuration.flagsas 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.CryptoExceptionsometimes being reported as an "unexpected runtime error" whenMediaCodecis operated in asynchronous mode (default behaviour on API 31+). - Pass
bufferedDurationUsinstead ofbufferedPositionUswithPreloadMediaSource.PreloadControl.onContinueLoadingRequested(). Also changesDefaultPreloadManager.Status.STAGE_LOADED_TO_POSITION_MStoDefaultPreloadManager.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
ForwardingRendererimplementation 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,DefaultLoadControlrestricts 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 ofLoadControldisables 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.Builderthat builds theDefaultPreloadManagerandExoPlayerinstances with consistently shared configurations. - Remove
Renderer[]parameter fromLoadControl.onTracksSelected()asDefaultLoadControlimplementation 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
MediaSourceEventListenerevents 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
onLoadErrorcallbacks. - In legacy subtitle handling (during rendering), only associated load errors are emitted via
onLoadErrorcallbacks 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
SntpClientto 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. ImageAssetLoaderreports unsupported input viaAssetLoader.onErrorinstead of throwing anIllegalStateException.- Make setting the image duration using
MediaItem.Builder.setImageDurationMsmandatory 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
Mp4ExtractorandFragmentedMp4Extractorto 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
mdhdbox inMp4ExtractorandFragmentedMp4Extractor(#1531). - Fix incorrect scaling of
media_timein MP4 edit lists. Whilesegment_durationwas already correctly scaled using the movie timescale,media_timeis now properly scaled using the track timescale, as specified by the MP4 format standard (#1792). - Handle out-of-order frames in
endIndicescalculation for MP4 with edit list (#1797). - Fix media duration parsing in
mdhdbox of MP4 files to handle-1values (#1819). - Add support for identifying
h263box in MP4 files for H.263 video (#1821). - Add AC-4 Level-4 ISO base media file format support (#1265).
- Allow
- DataSource:
- Update
HttpEngineDataSourceto 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 '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
- Update
- Audio:
- Automatically configure CTA-2075 loudness metadata on the codec if present in the media.
- Ensure smooth volume ramp down when seeking.
- Fix pop sounds that may occur during seeks.
- Fix truncation error accumulation for Sonic's time-stretching/pitch-shifting algorithm.
- Fix bug in
SpeedChangingAudioProcessorthat causes dropped output frames.
- Video:
MediaCodecVideoRendereravoids decoding samples that are neither rendered nor used as reference by other samples.- On API 35 and above,
MediaCodecAdaptermay now receive anullSurfaceinconfigureand calls to a new methoddetachOutputSurfaceto remove a previously setSurfaceif the codec supports this (MediaCodecInfo.detachedSurfaceSupported). - Use
MediaCodecAdaptersupplied pixel aspect ratio values if provided when processingonOutputFormatChanged(#1371). - 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:
- Add a custom
VoiceSpanand populate it for WebVTT voice spans (#1632). - Ensure WebVTT in HLS with very large subtitle timestamps (which overflow a 64-bit
longwhen represented as microseconds and multiplied by the90,000MPEG timebase) are displayed (#1763). - Support CEA-608 subtitles in Dolby Vision content (#1820).
- Fix playback hanging on DASH multi-period streams when CEA-608 subtitles are enabled (#1863).
- Add a custom
- Metadata:
- Assign the
C.TRACK_TYPE_METADATAtype to tracks containing icy or vnd.dvb.ait content.
- Assign the
- Image:
- Add
ExternallyLoadedImageDecoderfor simplified integration with external image loading libraries like Glide or Coil.
- Add
- DataSource:
- Add
FileDescriptorDataSource, a newDataSourcethat can be used to read from aFileDescriptor(#3757).
- Add
- Effect:
- Add
DefaultVideoFrameProcessorworkaround for minorSurfaceTexturescaling.SurfaceTexturemay 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 withTransformeris faster.
- Add
- IMA extension:
- Fix bug where clearing the playlist may cause an
ArrayIndexOutOfBoundsExceptioninImaServerSideAdInsertionMediaSource. - Fix bug where server-side inserted DAI streams without a preroll can result in an
ArrayIndexOutOfBoundsExceptionwhen playing past the last midroll (#1741).
- 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). - Fix bug that caused custom commands sent from a
MediaBrowserbeing dispatched to theMediaSessionCompat.Callbackinstead of theMediaBrowserServiceCompatvariant of the method when connected to a legacy service. This prevented theMediaBrowserto receive the actual return value sent back by the legacy service (#1474). - Handle
IllegalArgumentExceptionthrown 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 actionswith the legacy library withMediaBrowserCompat. Note that with Media3 command buttons for media items are available for both,MediaBrowserandMediaController. 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.setIconUrito only accept content Uris. - Pass connection hints of a Media3 browser to the initial
MediaBrowserCompatwhen 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
MediaBrowserconnected 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
MediaBrowserServicedoesn't request the children of aparentIdtwice when subscribing to a parent.
- Add
- UI:
- Make the stretched/cropped video in
PlayerView-in-Compose-AndroidViewworkaround opt-in, due to issues with XML-based shared transitions. Apps usingPlayerViewinsideAndroidViewneed to callPlayerView.setEnableComposeSurfaceSyncWorkaroundin order to opt-in (#1237, #1594). - Add
setFullscreenButtonStatetoPlayerViewto 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
- DASH Extension:
- Add support for periods starting in the middle of a segment (#1440).
- Smooth Streaming Extension:
- Fix a
Bad magic number for Bundleerror when playing SmoothStreaming streams with text tracks (#1779).
- Fix a
- RTSP Extension:
- 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 16 KB page support for decoder extensions on Android 15 (#1685).
- 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 cleaning the timeline after the CastSession disconnects, which enables the sender app to resume playback locally after a disconnection.
- Populate CastPlayer's
DeviceInfowhen aContextis provided. This enables linking theMediaSessionto aRoutingSession, which is necessary for integrating Output Switcher (#1056).
- Test Utilities:
DataSourceContractTestnow includes tests to verify:- Input stream
read positionis updated. - Output buffer
offsetis applied correctly.
- Input stream
- Demo app
- Resolve the memory leaks in demo short-form app (#1839).
- Remove deprecated symbols:
- Remove deprecated
Player.hasPrevious,Player.hasPreviousWindow(). UsePlayer.hasPreviousMediaItem()instead. - Remove deprecated
Player.previous()method. UsePlayer.seekToPreviousMediaItem()instead. - Remove deprecated
DrmSessionEventListener.onDrmSessionAcquiredmethod. - Remove deprecated
DefaultEncoderFactoryconstructors. UseDefaultEncoderFactory.Builderinstead.
- Remove deprecated