First release

node_modules/@videojs/http-streaming/docs/images/sources/dash-playlist-loader-mpc-mg-sequence.plantuml

@@ -0,0 +1,119 @@
+@startuml
+
+header DashPlaylistLoader sequences
+title DashPlaylistLoader sequences: Master Manifest with Alternate Audio
+
+Participant "MasterPlaylistController" as MPC #red
+Participant "MasterDashPlaylistLoader" as MPL #blue
+Participant "mainSegmentLoader" as SL #blue
+Participant "AudioDashPlaylistLoader" as APL #green
+Participant "audioSegmentLoader" as ASL #green
+Participant "external server" as ext #brown
+Participant "mpdParser" as parser #orange
+Participant "mediaGroups" as MG #purple
+Participant Tech #lightblue
+
+== Initialization ==
+
+MPC -> MPL : construct MasterPlaylistLoader
+MPC -> MPL: load()
+
+== Requesting Master Manifest ==
+
+MPL -> MPL : start()
+
+MPL -> ext: xhr request for master manifest
+ext -> MPL : response with master manifest
+
+MPL -> parser: parse manifest
+parser -> MPL: object representing manifest
+
+note over MPL #lightblue: trigger 'loadedplaylist'
+
+== Requesting Video Manifest ==
+
+note over MPL #lightblue: handling loadedplaylist
+MPL -> MPL: media(x)
+
+alt if no sidx
+  note over MPL #lightgray: zero delay to fake network request
+else if sidx
+  break
+    MPL -> ext: request sidx
+  end
+end
+
+note over MPL #lightblue: trigger 'loadedmetadata' on master loader [T1]
+
+note over MPL #lightblue: handling 'loadedmetadata'
+
+opt vod and preload !== 'none'
+
+  MPL -> SL: playlist()
+  MPL -> SL: load()
+
+end
+
+== Initializing Media Groups, Choosing Active Tracks ==
+
+MPL -> MG: setupMediaGroups()
+MG -> MG: initialize()
+
+== Initializing Alternate Audio Loader ==
+
+MG -> APL: create child playlist loader for alt audio
+
+MG -> MG: activeGroup and audio variant selected
+MG -> MG: enable activeTrack, onTrackChanged()
+MG -> ASL: reset audio segment loader
+
+== Requesting Alternate Audio Manifest ==
+
+MG -> MG: startLoaders()
+
+MG -> APL: load()
+APL -> APL: start()
+APL -> APL: zero delay to fake network request
+
+break finish pending tasks
+  MG -> Tech: add audioTrack
+  MPL -> MPC: setupSourceBuffers_()
+  MPL -> MPC: setupFirstPlay()
+
+  loop mainSegmentLoader.monitorBufferTick_()
+    SL -> ext: requests media segments
+    ext -> SL: response with media segment bytes
+  end
+end
+
+APL -> APL: zero delay over
+APL -> APL: media(x)
+
+alt if no sidx
+  note over APL #lightgray: zero delay to fake network request
+else if sidx
+  break
+    MPL -> ext: request sidx
+  end
+end
+
+== Requesting Alternate Audio Segments ==
+
+note over APL #lightblue: trigger 'loadedplaylist'
+note over APL #lightblue: handling 'loadedplaylist'
+APL -> ASL: playlist()
+
+
+note over ASL #lightblue: trigger 'loadedmetadata' [T2]
+note over APL #lightblue: handling 'loadedmetadata'
+APL -> ASL: playlist()
+APL -> ASL: load()
+
+loop audioSegmentLoader.monitorBufferTick_()
+
+  ASL -> ext: requests media segments
+  ext -> ASL: response with media segment bytes
+
+end
+
+@enduml

node_modules/@videojs/http-streaming/docs/images/sources/dash-playlist-loader-states.nomnoml.txt

@@ -0,0 +1,21 @@
+#title: DASH Playlist Loader States
+#arrowSize: 0.5
+#bendSize: 1
+#direction: down
+#gutter: 10
+#edgeMargin: 1
+#edges: rounded
+#fillArrows: false
+#font: Arial
+#fontSize: 10
+#leading: 1
+#lineWidth: 2
+#padding: 20
+#spacing: 50
+#stroke: #33322E
+#zoom: 1
+
+#.label: align=center visual=none italic
+
+[HAVE_NOTHING] load()-> [HAVE_MASTER]
+[HAVE_MASTER] media()-> [HAVE_METADATA]

node_modules/@videojs/http-streaming/docs/images/sources/new-playlist-loader-master-video-alt-audio-sequence.plantuml

@@ -0,0 +1,246 @@
+@startuml
+
+header PlaylistLoader sequences
+title PlaylistLoader sequences: Master Manifest and Alternate Audio
+
+Participant "MasterPlaylistController" as MPC #red
+Participant "MasterPlaylistLoader" as MPL #blue
+Participant "mainSegmentLoader" as SL #blue
+Participant "AudioPlaylistLoader" as APL #green
+Participant "audioSegmentLoader" as ASL #green
+Participant "external server" as ext #brown
+Participant "m3u8Parser" as parser #orange
+Participant "mediaGroups" as MG #purple
+Participant Tech #lightblue
+
+== Initialization ==
+
+group MasterPlaylistController.constructor()
+
+  MPC -> MPL : setting up MasterPlaylistLoader
+  note left #lightyellow
+    sets up mediaupdatetimeout
+    handler for live playlist staleness
+  end note
+  note over MPL #lightgray: state = 'HAVE_NOTHING'
+
+  MPC -> MPL: load()
+
+end
+
+group MasterPlaylistLoader.load()
+
+  MPL -> MPL : start()
+  note left #lightyellow: not started yet
+
+== Requesting Master Manifest ==
+
+    group start()
+
+      note over MPL #lightgray: started = true
+
+      MPL -> ext: xhr request for master manifest
+      ext -> MPL : response with master manifest
+
+      MPL -> parser: parse master manifest
+      parser -> MPL: object representing manifest
+      MPL -> MPL: set loader's master playlist
+      note over MPL #lightgray: state = 'HAVE_MASTER'
+      note over MPL #lightblue: trigger 'loadedplaylist' on master loader
+
+== Requesting Video Manifest ==
+
+      group 'loadedplaylist' handler
+
+        note over MPL #lightblue: handling loadedplaylist
+        MPL -> MPL : media()
+        note left #lightgray: select initial (video) playlist
+        note over MPL #lightyellow: state = 'SWITCHING_MEDIA'
+
+        group media()
+
+          MPL -> ext : request child manifest
+          ext -> MPL: child manifest returned
+          MPL -> MPL: haveMetadata()
+          note over MPL #lightyellow: state = 'HAVE_METADATA'
+
+          group haveMetadata()
+
+            MPL -> parser: parse child manifest
+            parser -> MPL: object representing the child manifest
+            note over MPL #lightyellow
+              update master and media playlists
+            end note
+
+            opt live
+              MPL -> MPL: setup mediaupdatetimeout
+            end
+
+            note over MPL #lightblue
+              trigger 'loadedplaylist' on master loader.
+              This does not end up requesting segments
+              at this point.
+            end note
+
+            group MasterPlaylistLoader 'loadedplaylist' handler
+
+              MPL -> MPL : setup durationchange handler
+
+            end
+
+          end
+
+== Requesting Video Segments ==
+
+          note over MPL #lightblue: trigger 'loadedmetadata'
+
+          group 'loadedmetadata' handler
+
+            note over MPL #lightblue: handling 'loadedmetadata'
+
+            opt vod and preload !== 'none'
+
+              MPL -> SL: playlist()
+              note over SL #lightyellow: updates playlist
+
+              MPL -> SL: load()
+              note right #lightgray
+                This does nothing as mimeTypes
+                have not been set yet.
+              end note
+
+            end
+
+            MPL -> MG: setupMediaGroups()
+
+== Initializing Media Groups, Choosing Active Tracks ==
+
+            group MediaGroups.setupMediaGroups()
+
+              group initialize()
+
+                MG -> APL: create child playlist loader for alt audio
+                note over APL #lightyellow: state = 'HAVE_NOTHING'
+
+                note left #lightgray
+                  setup 'loadedmetadata' and 'loadedplaylist' listeners
+                  on child alt audio playlist loader
+                end note
+
+                MG -> Tech: add audioTracks
+
+              end
+
+              MG -> MG: activeGroup and audio variant selected
+              MG -> MG: enable activeTrack, onTrackChanged()
+              note left #lightgray
+                There is no activePlaylistLoader at this point,
+                but there is an audio playlistLoader
+              end note
+
+              group onTrackChanged()
+
+                MG -> SL: reset mainSegmentLoader
+                note left #lightgray: Clears buffer, aborts all inflight requests
+
+== Requesting Alternate Audio Manifest ==
+
+                MG -> MG: startLoaders()
+
+                group startLoaders()
+                  note over MG #lightyellow
+                    activePlaylistLoader = AudioPlaylistLoader
+                  end note
+
+                  MG -> APL: load()
+                end
+
+                group AudioPlaylistLoader.load()
+                  APL -> APL: start()
+
+                  group alt start()
+
+                    note over APL #lightyellow: started = true
+                    APL -> ext: request alt audio media manifest
+
+                    break MasterPlaylistLoader 'loadedmetadata' handler
+
+                      MPL -> MPC: setupSourceBuffers()
+                      note left #lightgray
+                        This will set mimeType.
+                        Segments can be loaded from now on.
+                      end note
+
+                      MPL -> MPC: setupFirstPlay()
+                      note left #lightgray
+                        Immediate exit since the player
+                        is paused
+                      end note
+
+                    end
+
+                    ext -> APL: responds with child manifest
+                    APL -> parser: parse child manifest
+                    parser -> APL: object representing child manifest returned
+                    note over APL #lightyellow: state = 'HAVE_MASTER'
+                    note left #lightgray: Infer a master playlist
+
+                    APL -> APL: haveMetadata()
+                    note over APL #lightyellow: state = 'HAVE_METADATA'
+
+                    group haveMetadata()
+
+                      APL -> parser: parsing the child manifest again
+                      parser -> APL: returning object representing child manifest
+                      note over APL #lightyellow
+                        update master and media references
+                      end note
+
+== Requesting Alternate Audio Segments ==
+
+                      note over APL #lightblue: trigger 'loadedplaylist'
+
+                      group 'loadedplaylist' handler
+
+                        note over APL #lightblue: handling 'loadedplaylist'
+                        APL -> ASL: playlist()
+                        note over ASL #lightyellow: set playlist
+
+                      end
+
+                    end
+
+                    note over APL #lightblue: trigger 'loadedmetadata'
+
+                    group 'loadedmetadata' handler
+
+                      note over APL #lightblue: handling 'loadedmetadata'
+
+                      APL -> ASL: playlist()
+                      APL -> ASL: load()
+
+                      loop audioSegmentLoader.load()
+
+                        ASL -> ext: requests media segments
+                        ext -> ASL: response with media segment bytes
+                      end
+
+                    end
+
+                  end
+
+                end
+
+            end
+
+          end
+
+        end
+
+      end
+
+    end
+
+end
+
+@enduml

node_modules/@videojs/http-streaming/docs/images/sources/playlist-loader-mpc-mg-sequence.plantuml

@@ -0,0 +1,114 @@
+@startuml
+
+header PlaylistLoader sequences
+title PlaylistLoader sequences: Master Manifest and Alternate Audio
+
+Participant "MasterPlaylistController" as MPC #red
+Participant "MasterPlaylistLoader" as MPL #blue
+Participant "mainSegmentLoader" as SL #blue
+Participant "AudioPlaylistLoader" as APL #green
+Participant "audioSegmentLoader" as ASL #green
+Participant "external server" as ext #brown
+Participant "m3u8Parser" as parser #orange
+Participant "mediaGroups" as MG #purple
+Participant Tech #lightblue
+
+== Initialization ==
+
+MPC -> MPL : construct MasterPlaylistLoader
+MPC -> MPL: load()
+
+MPL -> MPL : start()
+
+== Requesting Master Manifest ==
+
+MPL -> ext: xhr request for master manifest
+ext -> MPL : response with master manifest
+
+MPL -> parser: parse master manifest
+parser -> MPL: object representing manifest
+
+note over MPL #lightblue: trigger 'loadedplaylist'
+
+== Requesting Video Manifest ==
+
+note over MPL #lightblue: handling loadedplaylist
+MPL -> MPL : media()
+
+MPL -> ext : request child manifest
+ext -> MPL: child manifest returned
+
+MPL -> parser: parse child manifest
+parser -> MPL: object representing the child manifest
+
+note over MPL #lightblue: trigger 'loadedplaylist'
+note over MPL #lightblue: handleing 'loadedplaylist'
+
+MPL -> SL: playlist()
+MPL -> SL: load()
+
+== Requesting Video Segments ==
+
+note over MPL #lightblue: trigger 'loadedmetadata'
+note over MPL #lightblue: handling 'loadedmetadata'
+
+opt vod and preload !== 'none'
+
+  MPL -> SL: playlist()
+  MPL -> SL: load()
+
+end
+
+MPL -> MG: setupMediaGroups()
+
+== Initializing Media Groups, Choosing Active Tracks ==
+
+MG -> APL: create child playlist loader for alt audio
+
+MG -> MG: activeGroup and audio variant selected
+MG -> MG: enable activeTrack, onTrackChanged()
+MG -> SL: reset mainSegmentLoader
+
+== Requesting Alternate Audio Manifest ==
+
+MG -> MG: startLoaders()
+
+MG -> APL: load()
+APL -> APL: start()
+
+APL -> ext: request alt audio media manifest
+
+break finish pending tasks
+  MG -> Tech: add audioTracks
+  MPL -> MPC: setupSourceBuffers()
+  MPL -> MPC: setupFirstPlay()
+
+  loop on monitorBufferTick
+    SL -> ext: requests media segments
+    ext -> SL: response with media segment bytes
+  end
+end
+
+ext -> APL: responds with child manifest
+
+APL -> parser: parse child manifest
+parser -> APL: object representing child manifest returned
+
+== Requesting Alternate Audio Segments ==
+
+note over APL #lightblue: trigger 'loadedplaylist'
+note over APL #lightblue: handling 'loadedplaylist'
+APL -> ASL: playlist()
+
+note over APL #lightblue: trigger 'loadedmetadata'
+note over APL #lightblue: handling 'loadedmetadata'
+APL -> ASL: playlist()
+APL -> ASL: load()
+
+loop audioSegmentLoader.load()
+
+  ASL -> ext: requests media segments
+  ext -> ASL: response with media segment bytes
+end
+
+@enduml

node_modules/@videojs/http-streaming/docs/images/sources/playlist-loader-states.nomnoml.txt

@@ -0,0 +1,25 @@
+#title: Playlist Loader States
+#arrowSize: 0.5
+#bendSize: 1
+#direction: down
+#gutter: 10
+#edgeMargin: 1
+#edges: rounded
+#fillArrows: false
+#font: Arial
+#fontSize: 10
+#leading: 1
+#lineWidth: 2
+#padding: 20
+#spacing: 50
+#stroke: #33322E
+#zoom: 1
+
+#.label: align=center visual=none italic
+
+[HAVE_NOTHING] load()-> [HAVE_MASTER]
+[HAVE_MASTER] media()-> [SWITCHING_MEDIA]
+[SWITCHING_MEDIA] media()/ start()-> [HAVE_METADATA]
+
+[HAVE_METADATA] <--> [<label> mediaupdatetimeout]
+[<label> mediaupdatetimeout] <--> [HAVE_CURRENT_METADATA]