Releases: video-dev/hls.js
v1.5.1
Summary
HLS.js v1.5.1 includes bug fixes and improvements over the last release.
Changes Since The Last Release
- Fix regression where subtitle options with AUTOSELECT or FORCED are enabled at start (#6094) @robwalch
- Null CMCDController callback properties on destroy (#6098)
Demo Page
https://2400e6db.hls-js-dev.pages.dev/demo/
API and Breaking Changes
If you are upgrading from version v0.14.17 or lower, see the MIGRATING guide for API changes between v0.14.x and v1.0.0.
Feedback
Please provide feedback via Issues in GitHub. For more details on how to contribute to HLS.js, see our CONTRIBUTING guide.
v1.5.0
Summary
HLS.js v1.5.0 includes playback and API enhancements that support HLS assets containing multiple codec variants, HDR video variants, and multi-channel audio renditions. Support for MediaCapabilities and ManagedMediaSource has also been adopted.
Media segment codec parsing is available for direct playback of media playlists as well as proper setup of MediaSource buffers for AV1, HEVC, HEVC with DolbyVision, AVC, AC3, EC3, Apple Lossless (ALAC), AAC, FLAC and Opus.
MediaCapabilities decodeInfo
checks are performed after the initial start before switching to UHD, HDR, and Multi-channel audio options.
Note that auto-switching between codec families is not supported. HLS.js will attempt to start on the most efficient supported codec set available within the initial bandwidth estimate range (up to 500kbps). However, switching between variants with incompatible codecs requires manual intervention by the user or application. Constraining playback to compatible codecs maintains maximum compatibility and stable playback. changeType
is used when necessary but avoided for auto-switching because it is not always stable or smooth between all combinations or on all platforms.
ManagedMediaSource support adds the ability to run HLS.js on iOS 17.1 and up. HLS.js in Safari on iOS, iPadOS, and MacOS leverages ManagedMediaSource to start and stop streaming for power-efficient use of wireless connections.
Changes Since The Last Release
API Enhancements
- Named exports for all classes and enums are available in ESM output (#5930) @robwalch
- Rendition selection enhancements (#5704)
- HLS.js will no longer start on the first variant (
hls.firstLevel
) or any variant of a preferred codec if its BANDWIDTH exceedsabrEwmaDefaultEstimateMax
- Added
hls.firstAutoLevel
getter, used internally to get the starting level index
hls.levels
are sorted on height, frame rate, preferred codec, and video-range to infer order by quality. Height-first sorting allows cap-level-lontroller to set a max quality index at the maximum allowed resolution - Added getters for all audio tracks and all subtitle tracks:
hls.allAudioTracks
andhls.allSubtitleTracks
- HLS.js will no longer start on the first variant (
- API enhancements for audio and subtitle selection (#5978)
hls.setAudioOption()
andconfig.audioPreference
have been added to simplify audio selection based on user preferences and playback settingshls.setSubtitleOption()
andconfig.subtitlePreference
have been added to simplify subtitle selection based on user preferences and playback settings. Only subtitle media options (hls.allSubtitleTracks
) are subject to selection criteria. Captions are assigned a TextTrack or emitted through events when native rendering is disabled.
config.videoPreference.preferHDR
andpreferHDR
have been added to override the default SDR/HDR selection behavior- Base initial bandwidth estimate on first level bitrate (#5649)
- Added setter for
bandwidthEstimate
that resets estimator to a new starting value
- Added setter for
- Initial selection and level filtering based on preferred codecs and MediaCapabilities (#5704)
- Added
config.useMediaCapabilities
(defaults totrue
) - Set
config.useMediaCapabilities
tofalse
to disable the use ofMediaCapabilities.decodingInfo
- Added
isSupported()
has been expanded to test alternate baseline codecs (#6006)- Added
isMSESupported()
, a subroutine ofisSupported()
, checks for MediaSource API without isTypeSupported checks. - Added
getMediaSource()
, which returns the preferred MSE interface or undefined when unavailable - Added named exports for
isSupported
,isMSESupported
, andgetMediaSource
- Added
- Fire
STEERING_MANIFEST_LOADED
event when loading a Content Steering Manifest (#5417) @guillemcabrera - Added config flag for maximum front buffer
frontBufferFlushThreshold
(#5761) @iamboorrito - Implement event for
maxAutoLevel
change (#5763) @robwalch - Specify custom
shouldRetry
predicate inretryConfig
(#5658) @PavelFomin90 (completed in #5762) - Default estimate enhancements (#5649) @robwalch
- Added
config.abrEwmaDefaultEstimateMax
option, which limits how high the initial default value may be adjusted
Separate peak and average bitrates of Level objects
- Added
- Level properties
Level.bitrate
uses variant BANDWIDTH (required peak bitrate) before falling back to optional AVERAGE-BANDWIDTH.Level.averageBitrate
returns parsed AVERAGE-BANDWIDTH. Falls back to runtime average Level.realBitrate (which is only set whenconfig.abrMaxWithRealBitrate
is enabled) and finally Level.bitrate (BANDWIDTH).- Added
Level.frameRate
returns parsed FRAME-RATE number or 0. - Added
Level.codecs
returns parsed CODECS or empty string. - Added
Level.score
returns parsed SCORE number or 0.
- Added config option
preferManagedMediaSource
. Set it tofalse
to useMediaSource
rather thanManagedMediaSource
on platforms with both. - Extended
cmcd
config option withcmcd.includeKeys
. Takes an array of CMCD keys to include in client requests. (#5903) @littlespex
Codec Support
- HDR/SDR VIDEO-RANGE selection and priority (#6007) @robwalch
- Expand isSupported check to allow alternative codecs (#6006)
- Added codec string parsing for h264, h265, and mp4a (#4996) @uvjustin
- MP4 Sample Description ("stsd") CODEC Parsing (#5528)
- Added HEVC decoder configuration parser (890fae3) @fogarasyroland
- Added FLAC support (#4772) @jprjr
- Added support for AC-3 codec in MPEG-TS (#5167) @erankor
- Added AC3 file support and exclude AC3 parsing from hls.light builds (#5562) @robwalch
- Added support for AC-3 audio in DVB streams (#5636) @softworkz
- Prepare for Supporting Additional Video Codecs (#5634) @softworkz
iOS 17.1 Support
- ManagedMediaSource Support (#5542) @robwalch
- Check ManagedMediaSource removedRanges length on "bufferedchange" event (#5915)
Live Streaming Bug Fixes
- Fixed Low-Latency HLS directives skipping part
0
(#5714) @jhonalino - Fixed support of skip directive without block reload (#5791) @robwalch
- Fixed live frag finding after detaching and re-attaching past live window (#5742)
- Handle #EXT-X-ENDLIST appended to live playlist without new segment (#5778)
Captions, Subtitles, and Metadata Bug Fixes
- Clear CEA-608 captions on discontinuity (#5557)
- Fixed DateRange metadata cue duration with ID3 cues that overlap (#5546)
- Use input timescale when remuxing inband captions (#5675)
Bug Fixes (Misc)
- Fix regression in emergency switch down (#6082) @robwalch
- Fix codec parsing for AVC streams (#6077) by @Qizot
- Fix fetch loader abort in progressive mode (#6066) @robwalch
- Fix base-stream-controller onHandlerDestroying callback evocation (#6057)
- (Removes circular references left after destroying player)
- Fixed ID3 Decoding On Play Station 4 (#6042) @agajassi
- Fixed (latency-controller) only sync live stream (#5604) @FredZeng
- Use addEventListener for MediaKeySession events (#6030) @robwalch
- Fix handling of the DATERANGE END-ON-NEXT attribute (#6038)
- Fixed esds box parsing (#6019)
- Added polyfill for isSafeInteger (#6022)
- ID3 TextTrack Cue fixes for PlayStation4 (#6021)
- Fixed issues parsing sei_messages (#5998) @jcekstrom
- Fixed issues with long cea608 captions (#5953) @jcekstrom
- Fixed regression in dev with CEA608 parser setup (#5986) @robwalch
- Fixed detach/attach behavior dropping one of two SourceBuffers (#5974)
- Filter variants with any unsupported codecs (#5533)
- Fixed two AV1 parsing issues (#5774) @nyanmisaka
- Push AUD units to fix decode errors with some TS segments (#5696) @robwalch
- Fail MP3 probe if AC3 or EC3 detected (#5695)
- Prevent ADTS probe false positives when bytes following ID3 are a match for MPEG audio (#5783)
- Reset init segment when M2TS video configuration changes (#5794)
- Fixed capLevelToPlayerSize after hiding player and maintain stable selection when aspect ratio changes (#5614)
- Fixed handling of segments at the discontinuities that do not start with a keyframe (#5659)
- Fixed AC3 PES parsing (#5673) @softworkz
- Fixed issue #5632, where missing AUD units for keyframes causes them to be merged with their preceding frame (#5652) @Thulinma
- Fixed Safari decode errors with DTS not increasing when PTS decreases (#5710) @robwalch
- Fixed PlayReady DRM in Edge browser (#5699) @mikrohard
- Do not jump start gaps when paused (#5502) @robwalch
- Never back-track on first fragment to avoid loop loading (#5613)
- Use last discontinuity bounds when aligning playlists on PDT (#5681)
- Load last alt-audio segment even when is starts after the end of the main playlist (#5717)
- Do not exit from stall detection when playhead is at or past end of buffer (#5779)
- Error and switch on SourceBuffer append requests for non-existing tracks (#5485)
- Handle mixed sourcebuffer errors (#5623)
- Remove SourceBuffers on "updateend" when MediaSource is closed (#5731)
- Resume fragment loading after level switch follows level error (#5537)
- Prevent recursion in error event handlers that throw (#5549)
- Reset loading start on worker setup error (#5620)
Enhancements
- Use Content Steering Pathways to manage Redundant Streams (#5970)
- Remove the use of
self
fromenableLogger
(#5936) - Refactor CMCD controller and tests to use the common media library utilities (#5903) @littlespex
- Updated CMCD dependency @svta/common-media-library to v0.6.0 (#6024)
- Lazy init CEA608 parsers (#5689) @robwalch
- Improve buffer-controller logging (#5548)
- Do not modify fmp4 bytes when there is no offset (#5780)
- Ignore #EXT-X-INDEPENDENT-SEGMENTS (#6047)
Typescript Improvements
- Correcting usage of extended generic type `Loade...
v1.4.14
Summary
HLS.js v1.4.14 includes bug fixes and improvements over the last release.
Changes Since The Last Release
Demo Page
https://00e6b582.hls-js-dev.pages.dev/demo/
API and Breaking Changes
If you are upgrading from version v0.14.17 or lower, see the MIGRATING guide for API changes between v0.14.x and v1.0.0.
Feedback
Please provide feedback via Issues in GitHub. For more details on how to contribute to HLS.js, see our CONTRIBUTING guide.
v1.5.0-beta.3
Summary
HLS.js v1.5.0-beta.3 includes bug fixes and improvements over the last release.
Changes Since v1.5.0-beta.2
- Fixed ID3 Decoding On Play Station 4 (#6042) @agajassi
- Fixed (latency-controller) only sync live stream (#5604) @FredZeng
- Store deployments in json file, and generate md and txt file from that (#6044) @tjenkinson
- Use addEventListener for MediaKeySession events (#6030) @robwalch
- Fix handling of the DATERANGE END-ON-NEXT attribute (#6038)
- Ignore #EXT-X-INDEPENDENT-SEGMENTS (#6047)
Demo Page
https://04777092.hls-js-dev.pages.dev/demo/
API and Breaking Changes
If you are upgrading from version v0.14.17 or lower, see the MIGRATING guide for API changes between v0.14.x and v1.0.0.
Feedback
Please provide feedback via Issues in GitHub. For more details on how to contribute to HLS.js, see our CONTRIBUTING guide.
v1.5.0-beta.2
Summary
HLS.js v1.5.0-beta.2 includes bug fixes and improvements over the last release.
Changes Since v1.5.0-beta.1
- Fixed esds box parsing (#6019) @robwalch
- Added polyfill for isSafeInteger (#6022)
- ID3 TextTrack Cue fixes for PlayStation4 (#6021)
- Updated CMCD dependency @svta/common-media-library to v0.6.0 (#6024)
Known Issues
- EME "license-request" message missed on LG2019 after
mediaKeysSession.generateRequest
resolved (#6034)
Demo Page
https://898bc592.hls-js-dev.pages.dev/demo/
API and Breaking Changes
If you are upgrading from version v0.14.17 or lower, see the MIGRATING guide for API changes between v0.14.x and v1.0.0.
Feedback
Please provide feedback via Issues in GitHub. For more details on how to contribute to HLS.js, see our CONTRIBUTING guide.
v1.4.13
Summary
HLS.js v1.4.13 includes bug fixes and improvements over the last release.
Changes Since The Last Release
Demo Page
https://16f1932e.hls-js-dev.pages.dev/demo/
API and Breaking Changes
If you are upgrading from version v0.14.17 or lower, see the MIGRATING guide for API changes between v0.14.x and v1.0.0.
Feedback
Please provide feedback via Issues in GitHub. For more details on how to contribute to HLS.js, see our CONTRIBUTING guide.
v1.5.0-beta.1
Summary
HLS.js v1.5.0-beta.1 includes playback and API enhancements targeted at supporting HLS assets containing HDR video variants and multi-channel audio renditions.
Changes Since v1.5.0-alpha.1
v1.5.0-alpha.1...v1.5.0-beta.1
- API enhancements for audio and subtitle selection (#5978) @robwalch
- HDR/SDR VIDEO-RANGE selection and priority (#6007)
- Expand isSupported check to allow alternative codecs (#6006)
- Use named exports in ESM output (#5930)
- Fixed issues parsing sei_messages (#5998) @jcekstrom
- Fixed issues with long cea608 captions (#5953) @jcekstrom
- Fixed regression in dev with CEA608 parser setup (#5986) @robwalch
- Refactor CMCD controller and tests to use the common media library utilities (#5903) @littlespex
- Use Content Steering Pathways to manage Redundant Streams (#5970) @robwalch
- Fixed detach attach behavior dropping one of two SourceBuffers (#5974)
- Remove the use of
self
fromenableLogger
(#5936) - Check ManagedMediaSource removedRanges length on "bufferedchange" event (#5915)
- Upgrade to Rollup 4 (#5886) @tjenkinson
- Configure typescript, eslint, and prettier caches (#5990)
- Update
karma-rollup-preprocessor
to the version that works in watch mode (#5991)
Changes Since The Last Release (v1.4.12)
API Enhancements
- Named exports for all classes and enums are available in ESM output (#5930)
- Rendition selection enhancements (#5704)
- HLS.js will no longer start on the first variant (
hls.firstLevel
), or any variant of a preferred codec, if its BANDWIDTH exceedsabrEwmaDefaultEstimateMax
. - Added
hls.firstAutoLevel
getter, used internally to get the starting level index.
hls.levels
are sorted on height, frame rate, preferred codec, and video-range to infer order by quality. Height-first sorting allows cap-level-lontroller to set a max quality index at the maximum allowed resolution. - Added getters for all audio tracks and all subtitle tracks:
hls.allAudioTracks
andhls.allSubtitleTracks
- HLS.js will no longer start on the first variant (
- API enhancements for audio and subtitle selection (#5978)
hls.setAudioOption()
andconfig.audioPreference
have been added to simplify audio selection based on user preferences and playback settingshls.setSubtitleOption()
andconfig.subtitlePreference
have been added to simplify subtitle selection based on user preferences and playback settings. Only subtitle media options (hls.allSubtitleTracks
) are subject to selection criteria. Captions are either assigned a TextTrack or emitted through events when native rendering is disabled.
config.videoPreference.preferHDR
andpreferHDR
have been added to override the default SDR/HDR selection behavior- Base initial bandwidth estimate on first level bitrate #5649
- Added setter for
bandwidthEstimate
that resets estimator to new starting value
- Added setter for
- Initial selection and level filtering based on preferred codecs and MediaCapabilities #5704
- Added
config.useMediaCapabilities
(defaults totrue
) - Set
config.useMediaCapabilities
tofalse
to disable the use ofMediaCapabilities.decodingInfo
- Added
isSupported()
has been expanded to test alternate baseline codecs (#6006)- Added
isMSESupported()
, a subroutine ofisSupported()
, checks for MediaSource API without isTypeSupported checks. - Added
getMediaSource()
which returns the preferred MSE interface or undefined when unavailable - Added named exports for
isSupported
,isMSESupported
, andgetMediaSource
- Added
- Fire
STEERING_MANIFEST_LOADED
event when loading a Content Steering Manifest (#5417) @guillemcabrera - Added config flag for maximum front buffer
frontBufferFlushThreshold
(#5761) @iamboorrito - Implement event for
maxAutoLevel
change #5763 - Specify custom
shouldRetry
predicate inretryConfig
(#5658) @PavelFomin90 (completed in #5762) - Default estimate enhancements #5649
- Added
config.abrEwmaDefaultEstimateMax
option which limits how high default value can be adjusted to.
Separate peak and average bitrates of Level objects
- Added
- Level properties
Level.bitrate
uses variant BANDWIDTH (required peak bitrate) before falling back to optional AVERAGE-BANDWIDTH.Level.averageBitrate
returns parsed AVERAGE-BANDWIDTH. Falls back to runtime average Level.realBitrate (which is only set whenconfig.abrMaxWithRealBitrate
is enabled) and finally Level.bitrate (BANDWIDTH).- Added
Level.frameRate
returns parsed FRAME-RATE number or 0. - Added
Level.codecs
returns parsed CODECS or emptry string. - Added
Level.score
returns parsed SCORE number or 0.
Codec Support
- Added codec string parsing for h264, h265, and mp4a (#4996) @uvjustin
- MP4 Sample Description ("stsd") CODEC Parsing (#5528)
- Added hevc decoder configuration parser (890fae3) @fogarasyroland
- Added FLAC support (#4772) @jprjr
- Added support for AC-3 codec in MPEG-TS (#5167) @erankor
- Added AC3 file support and exclude AC3 parsing from hls.light builds (#5562) @robwalch
- Added support for AC-3 audio in DVB streams (#5636) @softworkz
- Prepare for Supporting Additional Video Codecs (#5634) @softworkz
iOS 17.1 Support
Live Streaming Bug Fixes
- Fixed Low-Latency HLS directives skipping part
0
@jhonalino in #5714 - Fixed support of skip directive without block reload (#5791) @robwalch
- Fixed live frag finding after detach and re-attach past live window (#5742)
- Handle #EXT-X-ENDLIST appended to live playlist without new segment (#5778)
Captions, Subtitles, and Metadata Bug Fixes
- Clear CEA-608 captions on discontinuity (#5557)
- Fixed DateRange metadata cue duration with ID3 cues that overlap (#5546)
- Use input timescale when remuxing inband captions (#5675)
Bug Fixes (Misc)
- Filter variants with any unsupported codecs (#5533) @robwalch
- Fixed two AV1 parsing issues (#5774) @nyanmisaka
- Push AUD units to fix decode errors with some TS segments (#5696) @robwalch
- Fail MP3 probe if AC3 or EC3 detected (#5695)
- Prevent ADTS probe false positives when bytes following ID3 are a match for MPEG audio (#5783)
- Reset init segment when M2TS video configuration changes (#5794)
- Fixed capLevelToPlayerSize after hiding player and maintain stable selection when aspect ratio changes (#5614)
- Fixed handling of segments at the discontinuities that do not start with a keyframe (#5659)
- Fixed AC3 PES parsing (#5673) @softworkz
- Fixed issue #5632, where missing AUD units for keyframes causes them to be merged with their preceding frame (#5652) @Thulinma
- Fixed Safari decode errors with DTS not increasing when PTS decreases (#5710) @robwalch
- Fixed PlayReady DRM in Edge browser (#5699) @mikrohard
- Do not jump start gaps when paused (#5502) @robwalch
- Never back-track on first fragment to avoid loop loading (#5613)
- Use last discontinuity bounds when aligning playlists on PDT (#5681)
- Load last alt-audio segment even when is starts after the end of the main playlist (#5717)
- Do not exit from stall detection when playhead is at or past end of buffer (#5779)
- Error and switch on SourceBuffer append requests for non-existing tracks (#5485)
- Handle mixed sourcebuffer errors (#5623)
- Remove SourceBuffers on "updateend" when MediaSource is closed (#5731)
- Resume fragment loading after level switch follows level error (#5537)
- Prevent recursion in error event handlers that throw (#5549)
- Reset loading start on worker setup error (#5620)
Minor Enhancements
- Lazy init CEA608 parsers (#5689) @robwalch
- Improve buffer-controller logging (#5548)
- Do not modify fmp4 bytes when there is no offset (#5780)
Typescript Improvements
- Correcting usage of extended generic type
LoaderContext
in typeLoader
(#5494) @lvnam96 - Make loader context nullable and cleanup loader cleanup (#5552) @robwalch
Demo Page Enhancements
- Added
playsInline
to video elements on demo pages (#5556) @tjenkinson
Documentation
Project and CI
- Upgrade to Rollup 4 (#5886) @tjenkinson
- Configure typescript, eslint and prettier caches (#5990)
- Update
karma-rollup-preprocessor
to version that works in watch mode (#5991) - Update question.yaml template description (#5591) @robwalch
- Added Visual Studio Exclusions to
.gitignore
(#5635) @softworkz
Demo Page
https://c2e375b8.hls-js-dev.pages.dev/demo/
Feedback
Please provide feedback via Issues in GitHub. For more details on how to contribute to HLS.js, see our CONTRIBUTING guide.
v1.5.0-alpha.1
Summary
HLS.js v1.5.0-alpha.1 includes bug fixes and improvements over the last release.
Changes Since v1.5.0-alpha.0
v1.5.0-alpha.0...v1.5.0-alpha.1
- Redundant Stream grouping enhancements and orphaned audio/subtitle option fixes (#5855) @robwalch
- Fixes #5302 reported by @syedThowfeeqAhmed
- Fix subtitle track selection when reusing media element with mismatched TextTracks (#5880) @robwalch
- Fixes #4571 reported by @SivanA-Kaltura
- Exit gracefully when switching to an audio group with no tracks (#5822) @robwalch
- Fixes #4602 reported by @connected-salmouaswas
- Skip large video start gaps using GAP flag (#5816) @robwalch
- Bugfix: Reset gap-controller
nudgeRetry
(#5879) @robwalch- Fixes #5904 reported by @konogousanda
- Fix audio codec alternate error fallback (#5848) @robwalch
- Fix for aligning live alt audio and subtitle playlists on msn without PDT (#5818) @robwalch
- Fixes #5802 reported by @wise-kim-vr
- Fix regression in M2TS probe introduced in #5503 (#5858) @robwalch
- MP4Demuxer probe fix for large "emsg" payloads (#5852) @robwalch (reported by @nicoweilelemental)
- Fix DATERANGE parser handling of
clientAttrs
property (#5891) @robwalch - Support #EXT-X-BYTERANGE before #EXT-X-MAP tag (#5850) @robwalch
- Adjust m2ts sample times to fix gaps in appended media (#5806) @robwalch (partial fix for #5631 reported by @tvinko)
- Adjust overlapping M2TS AVC timestamps of sample that overlap with previous segment (#5805) @robwalch
- Fixes #4470 reported by @Vladislavik and root-cause aspects of #5759 reported by @bes
- Switch on smaller fmp4 segments that align with buffered segment boundaries (#5804) @robwalch
- SourceBuffer controller cleanup (#5911) @robwalch
Documentation
- API docs: add more info around backBufferLength (#5841, #5842) @cmugla
- Add
preferManagedMediaSource
API.md doc entry for ManagedMediaSource usage (#5828) @robwalch
Project and CI
- Use
concurrency
instead ofcancel-workflow-action
(#5885) @tjenkinson - Fix http-server path in package.json (#5574) @cellinlab
Changes Since The Last Release (v1.4.12)
Codec Support
- Add codec string parsing for h264, h265, and mp4a (#4996) @uvjustin
- MP4 Sample Description ("stsd") CODEC Parsing by @robwalch in #5528
- Add hevc decoder configuration parser (890fae3) @fogarasyroland
- Add FLAC support by @jprjr in #4772
- Add support for AC-3 codec in MPEG-TS by @erankor in #5167
- Add AC3 file support and exclude AC3 parsing from hls.light builds by @robwalch in #5562
- Add support for AC-3 audio in DVB streams by @softworkz in #5636
- Prepare for Supporting Additional Video Codecs by @softworkz in #5634
Preferred Codec Selection
- Base initial bandwidth estimate on first level bitrate by @robwalch in #5649
- Initial selection and level filtering based on preferred codecs and MediaCapabilities by @robwalch in #5704
MSE on iPhone
API Enhancements
- Fire
STEERING_MANIFEST_LOADED
event when loading a Content Steering Manifest by @guillemcabrera in #5417 - Add config flag for maximum front buffer
frontBufferFlushThreshold
by @iamboorrito in #5761 - Implement event for
maxAutoLevel
change by @robwalch in #5763 - Specify custom
shouldRetry
predicate inretryConfig
by @PavelFomin90 in #5658 (completed in #5762) - Default estimate enhancements #5649
- Add
config.abrEwmaDefaultEstimateMax
option which limits how high default value can be adjusted to.
Separate peak and average bitrates of Level objects
- Add
- Rendition selection enhancements #5704
- HLS.js will no longer start on the first variant (
hls.firstLevel
), or any variant of a preferred codec, if its BANDWIDTH exceedsabrEwmaDefaultEstimateMax
. - Add
hls.firstAutoLevel
getter, used internally to get the starting level index.
hls.levels
are sorted on height, frame rate, preferred codec, and video-range to infer order by quality. Height-first sorting allows cap-level-lontroller to set a max quality index at the maximum allowed resolution. - Add getters for all audio tracks and all subtitle tracks:
hls.allAudioTracks
andhls.allSubtitleTracks
- HLS.js will no longer start on the first variant (
- Level properties
Level.bitrate
uses variant BANDWIDTH (required peak bitrate) before falling back to optional AVERAGE-BANDWIDTH.Level.averageBitrate
returns parsed AVERAGE-BANDWIDTH. Falls back to runtime average Level.realBitrate (which is only set whenconfig.abrMaxWithRealBitrate
is enabled) and finally Level.bitrate (BANDWIDTH).Added Level.frameRate
returns parsed FRAME-RATE number or 0.Added Level.codecs
returns parsed CODECS or emptry string.Added Level.score
returns parsed SCORE number or 0.
Live Streaming Bug Fixes
- Fix Low-Latency HLS directives skipping part
0
@jhonalino in #5714 - Fix support of skip directive without block reload by @robwalch in #5791
- Fix live frag finding after detach and re-attach past live window by @robwalch in #5742
- Handle #EXT-X-ENDLIST appended to live playlist without new segment by @robwalch in #5778
Captions, Subtitles, and Metadata Bug Fixes
- Clear CEA-608 captions on discontinuity by @robwalch in #5557
- Fix DateRange metadata cue duration with ID3 cues that overlap by @robwalch in #5546
- Use input timescale when remuxing inband captions by @robwalch in #5675
Bug Fixes (Misc)
- Filter variants with any unsupported codecs by @robwalch in #5533
- Fix two AV1 parsing issues by @nyanmisaka in #5774
- Push AUD units to fix decode errors with some TS segments by @robwalch in #5696
- Fail MP3 probe if AC3 or EC3 detected by @robwalch in #5695
- Prevent ADTS probe false positives when bytes following ID3 are a match for MPEG audio by @robwalch in #5783
- Reset init segment when M2TS video configuration changes by @robwalch in #5794
- Fix capLevelToPlayerSize after hiding player and maintain stable selection when aspect ratio changes by @robwalch in #5614
- Fix handling of segments at the discontinuities that do not start with a keyframe by @robwalch in #5659
- Fix AC3 PES parsing by @softworkz in #5673
- Fix issue #5632, where missing AUD units for keyframes causes them to be merged with their preceding frame by @Thulinma in #5652
- Fix Safari decode errors with DTS not increasing when PTS decreases by @robwalch in #5710
- Fix PlayReady DRM in Edge browser by @mikrohard in #5699
- Do not jump start gaps when paused by @robwalch in #5502
- Never back-track on first fragment to avoid loop loading by @robwalch in #5613
- Use last discontinuity bounds when aligning playlists on PDT by @robwalch in #5681
- Load last alt-audio segment even when is starts after the end of the main playlist by @robwalch in #5717
- Do not exit from stall detection when playhead is at or past end of buffer by @robwalch in #5779
- Error and switch on SourceBuffer append requests for non-existing tracks by @robwalch in #5485
- Handle mixed sourcebuffer errors by @robwalch in #5623
- Remove SourceBuffers on "updateend" when MediaSource is closed by @robwalch in #5731
- Resume fragment loading after level switch follows level error by @robwalch in #5537
- Prevent recursion in error event handlers that throw by @robwalch in #5549
- Reset loading start on worker setup error by @robwalch in #5620
Minor Enhancements
- Lazy init CEA608 parsers by @robwalch in #5689
- Improve buffer-controller logging by @robwalch in #5548
- Do not modify fmp4 bytes when there is no offset by @robwalch in #5780
Typescript Improvements
- Correcting usage of extended generic type
LoaderContext
in typeLoader
(#5487) by @lvnam96 in #5494 - Make loader context nullable and cleanup loader cleanup by @robwalch in #5552
Demo Page
- add
playsInline
to video elements on demo pages by @tjenkinson in #5556
Documentation
Project and CI
- Update question.yaml template description by @robwalch in #5591
- Add Visual Studio Exclusions to
.gitignore
by @softworkz in #5635
New Contributors
- @guillemcabrera made their first contribution in #5417
- @lvnam96 made their first contribution in #5494
- @PavelFomin90 made their first contribution in #5658
- @jhonalino made their first contribution in #5714
- @mogzol made their first contribution in #5765
- @nyanmisaka made their first contribution in #5774
Demo Page
https://eb50102f.hls-js-dev.pages.dev/
API and Breaking Changes
If you are upgrading from version v0.14.17 or lower, see the MIGRATING guide for API changes between v0.14.x and v1.0.0.
Feedback
Please provide feedback via Issues in GitHub. For more details on how to contribute to HLS.js, see our CONTRIBUTING guide.
v1.5.0-alpha.0
Summary
HLS.js v1.5.0-alpha.0 is an early preview of v1.5.0. It is not feature complete. Unresolved issues are tracked via the v1.5.0 milestone.
Changes Since The Last Release
Codec Support
- Add codec string parsing for h264, h265, and mp4a (#4996) @uvjustin
- MP4 Sample Description ("stsd") CODEC Parsing by @robwalch in #5528
- Add hevc decoder configuration parser (890fae3) @fogarasyroland
- Add FLAC support by @jprjr in #4772
- Add support for AC-3 codec in MPEG-TS by @erankor in #5167
- Add AC3 file support and exclude AC3 parsing from hls.light builds by @robwalch in #5562
- Add support for AC-3 audio in DVB streams by @softworkz in #5636
- Prepare for Supporting Additional Video Codecs by @softworkz in #5634
Preferred Codec Selection
- Base initial bandwidth estimate on first level bitrate by @robwalch in #5649
- Initial selection and level filtering based on preferred codecs and MediaCapabilities by @robwalch in #5704
MSE on iPhone
API Enhancements
- Fire
STEERING_MANIFEST_LOADED
event when loading a Content Steering Manifest by @guillemcabrera in #5417 - Add config flag for maximum front buffer
frontBufferFlushThreshold
by @iamboorrito in #5761 - Implement event for
maxAutoLevel
change by @robwalch in #5763 - Specify custom
shouldRetry
predicate inretryConfig
by @PavelFomin90 in #5658 (completed in #5762) - Default estimate enhancements #5649
- Add
config.abrEwmaDefaultEstimateMax
option which limits how high default value can be adjusted to.
Separate peak and average bitrates of Level objects
- Add
- Rendition selection enhancements #5704
- HLS.js will no longer start on the first variant (
hls.firstLevel
), or any variant of a preferred codec, if its BANDWIDTH exceedsabrEwmaDefaultEstimateMax
. - Add
hls.firstAutoLevel
getter, used internally to get the starting level index.
hls.levels
are sorted on height, frame rate, preferred codec, and video-range to infer order by quality. Height-first sorting allows cap-level-lontroller to set a max quality index at the maximum allowed resolution. - Add getters for all audio tracks and all subtitle tracks:
hls.allAudioTracks
andhls.allSubtitleTracks
- HLS.js will no longer start on the first variant (
- Level properties
Level.bitrate
uses variant BANDWIDTH (required peak bitrate) before falling back to optional AVERAGE-BANDWIDTH.Level.averageBitrate
returns parsed AVERAGE-BANDWIDTH. Falls back to runtime average Level.realBitrate (which is only set whenconfig.abrMaxWithRealBitrate
is enabled) and finally Level.bitrate (BANDWIDTH).Added Level.frameRate
returns parsed FRAME-RATE number or 0.Added Level.codecs
returns parsed CODECS or emptry string.Added Level.score
returns parsed SCORE number or 0.
Live Streaming Bug Fixes
- Fix Low-Latency HLS directives skipping part
0
@jhonalino in #5714 - Fix support of skip directive without block reload by @robwalch in #5791
- Fix live frag finding after detach and re-attach past live window by @robwalch in #5742
- Handle #EXT-X-ENDLIST appended to live playlist without new segment by @robwalch in #5778
Captions, Subtitles, and Metadata Bug Fixes
- Clear CEA-608 captions on discontinuity by @robwalch in #5557
- Fix DateRange metadata cue duration with ID3 cues that overlap by @robwalch in #5546
- Use input timescale when remuxing inband captions by @robwalch in #5675
Bug Fixes (Misc)
- Filter variants with any unsupported codecs by @robwalch in #5533
- Fix two AV1 parsing issues by @nyanmisaka in #5774
- Push AUD units to fix decode errors with some TS segments by @robwalch in #5696
- Fail MP3 probe if AC3 or EC3 detected by @robwalch in #5695
- Prevent ADTS probe false positives when bytes following ID3 are a match for MPEG audio by @robwalch in #5783
- Reset init segment when M2TS video configuration changes by @robwalch in #5794
- Fix capLevelToPlayerSize after hiding player and maintain stable selection when aspect ratio changes by @robwalch in #5614
- Fix handling of segments at the discontinuities that do not start with a keyframe by @robwalch in #5659
- Fix AC3 PES parsing by @softworkz in #5673
- Fix issue #5632, where missing AUD units for keyframes causes them to be merged with their preceding frame by @Thulinma in #5652
- Fix Safari decode errors with DTS not increasing when PTS decreases by @robwalch in #5710
- Fix PlayReady DRM in Edge browser by @mikrohard in #5699
- Do not jump start gaps when paused by @robwalch in #5502
- Never back-track on first fragment to avoid loop loading by @robwalch in #5613
- Use last discontinuity bounds when aligning playlists on PDT by @robwalch in #5681
- Load last alt-audio segment even when is starts after the end of the main playlist by @robwalch in #5717
- Do not exit from stall detection when playhead is at or past end of buffer by @robwalch in #5779
- Error and switch on SourceBuffer append requests for non-existing tracks by @robwalch in #5485
- Handle mixed sourcebuffer errors by @robwalch in #5623
- Remove SourceBuffers on "updateend" when MediaSource is closed by @robwalch in #5731
- Resume fragment loading after level switch follows level error by @robwalch in #5537
- Prevent recursion in error event handlers that throw by @robwalch in #5549
- Reset loading start on worker setup error by @robwalch in #5620
Minor Enhancements
- Lazy init CEA608 parsers by @robwalch in #5689
- Improve buffer-controller logging by @robwalch in #5548
- Do not modify fmp4 bytes when there is no offset by @robwalch in #5780
Typescript Improvements
- Correcting usage of extended generic type
LoaderContext
in typeLoader
(#5487) by @lvnam96 in #5494 - Make loader context nullable and cleanup loader cleanup by @robwalch in #5552
Demo Page
- add
playsInline
to video elements on demo pages by @tjenkinson in #5556
Documentation
Project and CI
- Update question.yaml template description by @robwalch in #5591
- Add Visual Studio Exclusions to
.gitignore
by @softworkz in #5635
New Contributors
- @guillemcabrera made their first contribution in #5417
- @lvnam96 made their first contribution in #5494
- @PavelFomin90 made their first contribution in #5658
- @jhonalino made their first contribution in #5714
- @mogzol made their first contribution in #5765
- @nyanmisaka made their first contribution in #5774
Demo Page
https://eb50102f.hls-js-dev.pages.dev/
API and Breaking Changes
If you are upgrading from version v0.14.17 or lower, see the MIGRATING guide for API changes between v0.14.x and v1.0.0.
Feedback
Please provide feedback via Issues in GitHub. For more details on how to contribute to HLS.js, see our CONTRIBUTING guide.
v1.4.12
Summary
HLS.js v1.4.12 includes bug fixes and improvements over the last release.
Changes Since The Last Release
- Fix support of skip directive without block reload (#5791)
Demo Page
https://6fd26b8d.hls-js-dev.pages.dev/
API and Breaking Changes
If you are upgrading from version v0.14.17 or lower, see the MIGRATING guide for API changes between v0.14.x and v1.0.0.
Feedback
Please provide feedback via Issues in GitHub. For more details on how to contribute to HLS.js, see our CONTRIBUTING guide.