client: return ErrClientEOS when a playlist ends (#59)

client.go

@@ -7,6 +7,7 @@ package gohlslib
 
 import (
 	"context"
+	"errors"
 	"fmt"
 	"log"
 	"net/http"
@@ -22,6 +23,9 @@ const (
 	clientMaxDTSRTCDiff          = 10 * time.Second
 )
 
+// ErrClientEOS is returned by Wait() when the stream has ended.
+var ErrClientEOS = errors.New("end of stream")
+
 // ClientOnDownloadPrimaryPlaylistFunc is the prototype of Client.OnDownloadPrimaryPlaylist.
 type ClientOnDownloadPrimaryPlaylistFunc func(url string)
 

client_primary_downloader.go

@@ -113,6 +113,7 @@
 
 	// in
 	chStreamTracks chan clientStreamProcessor
+	chStreamEnded  chan struct{}
 
 	// out
 	startStreaming       chan struct{}
@@ -122,6 +123,7 @@
 func (d *clientPrimaryDownloader) initialize() {
 	d.streamProcByTrack = make(map[*Track]clientStreamProcessor)
 	d.chStreamTracks = make(chan clientStreamProcessor)
+	d.chStreamEnded = make(chan struct{})
 	d.startStreaming = make(chan struct{})
 	d.leadingTimeSyncReady = make(chan struct{})
 }
@@ -148,6 +150,7 @@
 			initialPlaylist:          plt,
 			rp:                       d.rp,
 			onStreamTracks:           d.onStreamTracks,
+			onStreamEnded:            d.onStreamEnded,
 			onSetLeadingTimeSync:     d.onSetLeadingTimeSync,
 			onGetLeadingTimeSync:     d.onGetLeadingTimeSync,
 			onData:                   d.onData,
@@ -176,6 +179,7 @@
 			initialPlaylist:          nil,
 			rp:                       d.rp,
 			onStreamTracks:           d.onStreamTracks,
+			onStreamEnded:            d.onStreamEnded,
 			onSetLeadingTimeSync:     d.onSetLeadingTimeSync,
 			onGetLeadingTimeSync:     d.onGetLeadingTimeSync,
 			onData:                   d.onData,
@@ -208,6 +212,7 @@
 					onSetLeadingTimeSync:     d.onSetLeadingTimeSync,
 					onGetLeadingTimeSync:     d.onGetLeadingTimeSync,
 					onData:                   d.onData,
+					onStreamEnded:            d.onStreamEnded,
 				}
 				d.rp.add(ds)
 				streamCount++
@@ -251,7 +256,15 @@
 
 	close(d.startStreaming)
 
-	return nil
+	for i := 0; i < streamCount; i++ {
+		select {
+		case <-d.chStreamEnded:
+		case <-ctx.Done():
+			return fmt.Errorf("terminated")
+		}
+	}
+
+	return ErrClientEOS
 }
 
 func (d *clientPrimaryDownloader) onStreamTracks(ctx context.Context, streamProc clientStreamProcessor) bool {
@@ -270,6 +283,13 @@
 	return true
 }
 
+func (d *clientPrimaryDownloader) onStreamEnded(ctx context.Context) {
+	select {
+	case d.chStreamEnded <- struct{}{}:
+	case <-ctx.Done():
+	}
+}
+
 func (d *clientPrimaryDownloader) onSetLeadingTimeSync(ts clientTimeSync) {
 	d.leadingTimeSync = ts
 	close(d.leadingTimeSyncReady)

client_stream_downloader.go

@@ -39,6 +39,7 @@ type clientStreamDownloader struct {
 	initialPlaylist          *playlist.Media
 	rp                       *clientRoutinePool
 	onStreamTracks           clientOnStreamTracksFunc
+	onStreamEnded            func(context.Context)
 	onSetLeadingTimeSync     func(clientTimeSync)
 	onGetLeadingTimeSync     func(context.Context) (clientTimeSync, bool)
 	onData                   map[*Track]interface{}
@@ -77,6 +78,7 @@ func (d *clientStreamDownloader) run(ctx context.Context) error {
 			segmentQueue:         segmentQueue,
 			rp:                   d.rp,
 			onStreamTracks:       d.onStreamTracks,
+			onStreamEnded:        d.onStreamEnded,
 			onSetLeadingTimeSync: d.onSetLeadingTimeSync,
 			onGetLeadingTimeSync: d.onGetLeadingTimeSync,
 			onData:               d.onData,
@@ -94,6 +96,7 @@ func (d *clientStreamDownloader) run(ctx context.Context) error {
 			segmentQueue:         segmentQueue,
 			rp:                   d.rp,
 			onStreamTracks:       d.onStreamTracks,
+			onStreamEnded:        d.onStreamEnded,
 			onSetLeadingTimeSync: d.onSetLeadingTimeSync,
 			onGetLeadingTimeSync: d.onGetLeadingTimeSync,
 			onData:               d.onData,
@@ -231,8 +234,9 @@ func (d *clientStreamDownloader) fillSegmentQueue(
 	})
 
 	if pl.Endlist && pl.Segments[len(pl.Segments)-1] == seg {
+		segmentQueue.push(nil)
 		<-ctx.Done()
-		return fmt.Errorf("stream has ended")
+		return fmt.Errorf("terminated")
 	}
 
 	return nil

client_stream_processor_fmp4.go

@@ -50,6 +50,7 @@ type clientStreamProcessorFMP4 struct {
 	segmentQueue         *clientSegmentQueue
 	rp                   *clientRoutinePool
 	onStreamTracks       clientOnStreamTracksFunc
+	onStreamEnded        func(context.Context)
 	onSetLeadingTimeSync func(clientTimeSync)
 	onGetLeadingTimeSync func(context.Context) (clientTimeSync, bool)
 	onData               map[*Track]interface{}
@@ -119,6 +120,12 @@ func (p *clientStreamProcessorFMP4) run(ctx context.Context) error {
 }
 
 func (p *clientStreamProcessorFMP4) processSegment(ctx context.Context, seg *segmentData) error {
+	if seg == nil {
+		p.onStreamEnded(ctx)
+		<-ctx.Done()
+		return fmt.Errorf("terminated")
+	}
+
 	var parts fmp4.Parts
 	err := parts.Unmarshal(seg.payload)
 	if err != nil {

client_stream_processor_mpegts.go

@@ -40,6 +40,7 @@ type clientStreamProcessorMPEGTS struct {
 	segmentQueue         *clientSegmentQueue
 	rp                   *clientRoutinePool
 	onStreamTracks       clientOnStreamTracksFunc
+	onStreamEnded        func(context.Context)
 	onSetLeadingTimeSync func(clientTimeSync)
 	onGetLeadingTimeSync func(context.Context) (clientTimeSync, bool)
 	onData               map[*Track]interface{}
@@ -85,6 +86,12 @@ func (p *clientStreamProcessorMPEGTS) run(ctx context.Context) error {
 }
 
 func (p *clientStreamProcessorMPEGTS) processSegment(ctx context.Context, seg *segmentData) error {
+	if seg == nil {
+		p.onStreamEnded(ctx)
+		<-ctx.Done()
+		return fmt.Errorf("terminated")
+	}
+
 	if p.switchableReader == nil {
 		err := p.initializeReader(ctx, seg.payload)
 		if err != nil {

client_test.go

@@ -403,8 +403,10 @@ func TestClient(t *testing.T) {
 				<-audioRecv
 				<-audioRecv
 
+				err = <-c.Wait()
+				require.Equal(t, ErrClientEOS, err)
+
 				c.Close()
-				<-c.Wait()
 			})
 		}
 	}