improve examples (#778)

Author: aler9

README.md

@@ -95,8 +95,8 @@ Features:
 * [server](examples/server/main.go)
 * [server-tls](examples/server-tls/main.go)
 * [server-auth](examples/server-auth/main.go)
-* [server-h264-to-disk](examples/server-h264-to-disk/main.go)
-* [server-h264-from-disk](examples/server-h264-from-disk/main.go)
+* [server-record-format-h264-to-disk](examples/server-record-format-h264-to-disk/main.go)
+* [server-play-format-h264-from-disk](examples/server-play-format-h264-from-disk/main.go)
 * [proxy](examples/proxy/main.go)
 
 ## API Documentation

examples/client-play-backchannel/main.go

@@ -13,9 +13,9 @@ import (
 )
 
 // This example shows how to
-// 1. generate a dummy G711 audio stream
-// 2. connect to a RTSP server, find a back channel that supports G711
-// 3. route the G711 stream to the channel
+// 1. generate a dummy G711 audio stream.
+// 2. connect to a RTSP server, find a back channel that supports G711.
+// 3. route the G711 stream to the channel.
 
 func multiplyAndDivide(v, m, d int64) int64 {
 	secs := v / d
@@ -72,7 +72,7 @@ func main() {
 	// find the back channel
 	medi, forma := findG711BackChannel(desc)
 	if medi == nil {
-		panic("media not found")
+		panic("back channel not found")
 	}
 
 	// setup a single media
@@ -137,7 +137,7 @@ func main() {
 		for _, pkt := range pkts {
 			pkt.Timestamp += uint32(int64(randomStart) + prevPTS)
 
-			err = c.WritePacketRTP(desc.Medias[0], pkt)
+			err = c.WritePacketRTP(medi, pkt)
 			if err != nil {
 				panic(err)
 			}

examples/client-play-format-av1-to-jpeg/main.go

@@ -19,10 +19,10 @@ import (
 )
 
 // This example shows how to
-// 1. connect to a RTSP server
-// 2. check if there's a AV1 stream
-// 3. decode the AV1 stream into RGBA frames
-// 4. convert RGBA frames to JPEG images and save them on disk
+// 1. connect to a RTSP server.
+// 2. check if there's a AV1 stream.
+// 3. decode the AV1 stream into RGBA frames.
+// 4. convert RGBA frames to JPEG images and save them on disk.
 
 // This example requires the FFmpeg libraries, that can be installed with this command:
 // apt install -y libavcodec-dev libswscale-dev gcc pkg-config

examples/client-play-format-av1/main.go

@@ -14,9 +14,9 @@ import (
 )
 
 // This example shows how to
-// 1. connect to a RTSP server
-// 2. check if there's a AV1 stream
-// 3. decode the AV1 stream into RGBA frames
+// 1. connect to a RTSP server.
+// 2. check if there's a AV1 stream.
+// 3. decode the AV1 stream into RGBA frames.
 
 // This example requires the FFmpeg libraries, that can be installed with this command:
 // apt install -y libavcodec-dev libswscale-dev gcc pkg-config

examples/client-play-format-g711/main.go

@@ -11,9 +11,9 @@ import (
 )
 
 // This example shows how to
-// 1. connect to a RTSP server
-// 2. check if there's a G711 stream
-// 3. decode the G711 stream into audio samples
+// 1. connect to a RTSP server.
+// 2. check if there's a G711 stream.
+// 3. decode the G711 stream into audio samples.
 
 func main() {
 	c := gortsplib.Client{}

examples/client-play-format-h264-mpeg4audio-to-disk/main.go

@@ -11,9 +11,9 @@ import (
 )
 
 // This example shows how to
-// 1. connect to a RTSP server
-// 2. check if there's a H264 stream and a MPEG-4 audio stream
-// 3. save the content of those formats in a file in MPEG-TS format
+// 1. connect to a RTSP server.
+// 2. check if there's a H264 stream and a MPEG-4 audio stream.
+// 3. save the content of those formats in a file in MPEG-TS format.
 
 func main() {
 	c := gortsplib.Client{}

examples/client-play-format-h264-mpeg4audio-to-disk/mpegts_muxer.go

@@ -50,7 +50,11 @@ func (e *mpegtsMuxer) initialize() error {
 		},
 	}
 
-	e.w = mpegts.NewWriter(e.b, []*mpegts.Track{e.h264Track, e.mpeg4AudioTrack})
+	e.w = &mpegts.Writer{W: e.b, Tracks: []*mpegts.Track{e.h264Track, e.mpeg4AudioTrack}}
+	err = e.w.Initialize()
+	if err != nil {
+		return err
+	}
 
 	return nil
 }

examples/client-play-format-h264-to-disk/main.go

@@ -11,9 +11,9 @@ import (
 )
 
 // This example shows how to
-// 1. connect to a RTSP server
-// 2. check if there's a H264 stream
-// 3. save the content of the format in a file in MPEG-TS format
+// 1. connect to a RTSP server.
+// 2. check if there's a H264 stream.
+// 3. save the content of the format in a file in MPEG-TS format.
 
 func main() {
 	c := gortsplib.Client{}

examples/client-play-format-h264-to-disk/mpegts_muxer.go

@@ -34,7 +34,11 @@ func (e *mpegtsMuxer) initialize() error {
 		Codec: &mpegts.CodecH264{},
 	}
 
-	e.w = mpegts.NewWriter(e.b, []*mpegts.Track{e.track})
+	e.w = &mpegts.Writer{W: e.b, Tracks: []*mpegts.Track{e.track}}
+	err = e.w.Initialize()
+	if err != nil {
+		return err
+	}
 
 	return nil
 }

examples/client-play-format-h264-to-jpeg/main.go

@@ -19,10 +19,10 @@ import (
 )
 
 // This example shows how to
-// 1. connect to a RTSP server
-// 2. check if there's a H264 stream
-// 3. decode the H264 stream into RGBA frames
-// 4. convert RGBA frames to JPEG images and save them on disk
+// 1. connect to a RTSP server.
+// 2. check if there's a H264 stream.
+// 3. decode the H264 stream into RGBA frames.
+// 4. convert RGBA frames to JPEG images and save them on disk.
 
 // This example requires the FFmpeg libraries, that can be installed with this command:
 // apt install -y libavcodec-dev libswscale-dev gcc pkg-config

examples/client-play-format-h264/main.go

@@ -14,9 +14,9 @@ import (
 )
 
 // This example shows how to
-// 1. connect to a RTSP server
-// 2. check if there's an H264 stream
-// 3. decode the H264 stream into RGBA frames
+// 1. connect to a RTSP server.
+// 2. check if there's an H264 stream.
+// 3. decode the H264 stream into RGBA frames.
 
 // This example requires the FFmpeg libraries, that can be installed with this command:
 // apt install -y libavcodec-dev libswscale-dev gcc pkg-config

examples/client-play-format-h265-to-disk/main.go

@@ -11,9 +11,9 @@ import (
 )
 
 // This example shows how to
-// 1. connect to a RTSP server
-// 2. check if there's a H265 stream
-// 3. save the content of the format in a file in MPEG-TS format
+// 1. connect to a RTSP server.
+// 2. check if there's a H265 stream.
+// 3. save the content of the format in a file in MPEG-TS format.
 
 func main() {
 	c := gortsplib.Client{}

examples/client-play-format-h265-to-disk/mpegts_muxer.go

@@ -35,7 +35,11 @@ func (e *mpegtsMuxer) initialize() error {
 		Codec: &mpegts.CodecH265{},
 	}
 
-	e.w = mpegts.NewWriter(e.b, []*mpegts.Track{e.track})
+	e.w = &mpegts.Writer{W: e.b, Tracks: []*mpegts.Track{e.track}}
+	err = e.w.Initialize()
+	if err != nil {
+		return err
+	}
 
 	return nil
 }

examples/client-play-format-h265-to-jpeg/main.go

@@ -19,10 +19,10 @@ import (
 )
 
 // This example shows how to
-// 1. connect to a RTSP server
-// 2. check if there's a H265 stream
-// 3. decode the H265 stream into RGBA frames
-// 4. convert RGBA frames to JPEG images and save them on disk
+// 1. connect to a RTSP server.
+// 2. check if there's a H265 stream.
+// 3. decode the H265 stream into RGBA frames.
+// 4. convert RGBA frames to JPEG images and save them on disk.
 
 // This example requires the FFmpeg libraries, that can be installed with this command:
 // apt install -y libavcodec-dev libswscale-dev gcc pkg-config

examples/client-play-format-h265/main.go

@@ -14,9 +14,9 @@ import (
 )
 
 // This example shows how to
-// 1. connect to a RTSP server
-// 2. check if there's a H265 stream
-// 3. decode the H265 stream into RGBA frames
+// 1. connect to a RTSP server.
+// 2. check if there's a H265 stream.
+// 3. decode the H265 stream into RGBA frames.
 
 // This example requires the FFmpeg libraries, that can be installed with this command:
 // apt install -y libavcodec-dev libswscale-dev gcc pkg-config

examples/client-play-format-lpcm/main.go

@@ -10,9 +10,9 @@ import (
 )
 
 // This example shows how to
-// 1. connect to a RTSP server
-// 2. check if there's a LPCM stream
-// 3. get LPCM samples of that format
+// 1. connect to a RTSP server.
+// 2. check if there's a LPCM stream.
+// 3. get LPCM samples of that format.
 
 func main() {
 	c := gortsplib.Client{}

examples/client-play-format-mjpeg/main.go

@@ -13,10 +13,10 @@ import (
 )
 
 // This example shows how to
-// 1. connect to a RTSP server
-// 2. check if there's a M-JPEG stream
-// 3. get JPEG images of that format
-// 4. decode JPEG images into RGBA frames
+// 1. connect to a RTSP server.
+// 2. check if there's a M-JPEG stream.
+// 3. get JPEG images of that format.
+// 4. decode JPEG images into RGBA frames.
 
 func main() {
 	c := gortsplib.Client{}

examples/client-play-format-mpeg4audio-to-disk/main.go

@@ -11,9 +11,9 @@ import (
 )
 
 // This example shows how to
-// 1. connect to a RTSP server
-// 2. check if there's a MPEG-4 audio stream
-// 3. save the content of the format in a file in MPEG-TS format
+// 1. connect to a RTSP server.
+// 2. check if there's a MPEG-4 audio stream.
+// 3. save the content of the format in a file in MPEG-TS format.
 
 func main() {
 	c := gortsplib.Client{}

examples/client-play-format-mpeg4audio-to-disk/mpegts_muxer.go

@@ -34,7 +34,11 @@ func (e *mpegtsMuxer) initialize() error {
 	}
 	e.b = bufio.NewWriter(e.f)
 
-	e.w = mpegts.NewWriter(e.b, []*mpegts.Track{e.track})
+	e.w = &mpegts.Writer{W: e.b, Tracks: []*mpegts.Track{e.track}}
+	err = e.w.Initialize()
+	if err != nil {
+		return err
+	}
 
 	return nil
 }

examples/client-play-format-mpeg4audio/main.go

@@ -10,9 +10,9 @@ import (
 )
 
 // This example shows how to
-// 1. connect to a RTSP server
-// 2. check if there's a MPEG-4 audio stream
-// 3. get access units of that format
+// 1. connect to a RTSP server.
+// 2. check if there's a MPEG-4 audio stream.
+// 3. get access units of that format.
 
 func main() {
 	c := gortsplib.Client{}

examples/client-play-format-opus-to-disk/main.go

@@ -11,9 +11,9 @@ import (
 )
 
 // This example shows how to
-// 1. connect to a RTSP server
-// 2. check if there's a Opus stream
-// 3. save the content of the format in a file in MPEG-TS format
+// 1. connect to a RTSP server.
+// 2. check if there's a Opus stream.
+// 3. save the content of the format in a file in MPEG-TS format.
 
 func main() {
 	c := gortsplib.Client{}

examples/client-play-format-opus-to-disk/mpegts_muxer.go

@@ -34,7 +34,11 @@ func (e *mpegtsMuxer) initialize() error {
 	}
 	e.b = bufio.NewWriter(e.f)
 
-	e.w = mpegts.NewWriter(e.b, []*mpegts.Track{e.track})
+	e.w = &mpegts.Writer{W: e.b, Tracks: []*mpegts.Track{e.track}}
+	err = e.w.Initialize()
+	if err != nil {
+		return err
+	}
 
 	return nil
 }

examples/client-play-format-opus/main.go

@@ -10,9 +10,9 @@ import (
 )
 
 // This example shows how to
-// 1. connect to a RTSP server
-// 2. check if there's an Opus stream
-// 3. get Opus packets of that format
+// 1. connect to a RTSP server.
+// 2. check if there's an Opus stream.
+// 3. get Opus packets of that format.
 
 func main() {
 	c := gortsplib.Client{}

examples/client-play-format-vp8/main.go

@@ -13,9 +13,9 @@ import (
 )
 
 // This example shows how to
-// 1. connect to a RTSP server
-// 2. check if there's a VP8 stream
-// 3. decode the VP8 stream into RGBA frames
+// 1. connect to a RTSP server.
+// 2. check if there's a VP8 stream.
+// 3. decode the VP8 stream into RGBA frames.
 
 // This example requires the FFmpeg libraries, that can be installed with this command:
 // apt install -y libavcodec-dev libswscale-dev gcc pkg-config

examples/client-play-format-vp9/main.go

@@ -13,9 +13,9 @@ import (
 )
 
 // This example shows how to
-// 1. connect to a RTSP server
-// 2. check if there's a VP9 stream
-// 3. decode the VP9 stream into RGBA frames
+// 1. connect to a RTSP server.
+// 2. check if there's a VP9 stream.
+// 3. decode the VP9 stream into RGBA frames.
 
 // This example requires the FFmpeg libraries, that can be installed with this command:
 // apt install -y libavcodec-dev libswscale-dev gcc pkg-config

examples/client-play-options/main.go

@@ -13,8 +13,8 @@ import (
 )
 
 // This example shows how to
-// 1. set additional client options
-// 2. connect to a RTSP server and read all medias on a path
+// 1. set additional client options.
+// 2. connect to a RTSP server and read all medias on a path.
 
 func main() {
 	// Client allows to set additional client options

examples/client-play-pause/main.go

@@ -13,10 +13,10 @@ import (
 )
 
 // This example shows how to
-// 1. connect to a RTSP server and read all medias on a path
-// 2. wait for 5 seconds
-// 3. pause for 5 seconds
-// 4. repeat
+// 1. connect to a RTSP server and read all medias on a path.
+// 2. wait for 5 seconds.
+// 3. pause for 5 seconds.
+// 4. repeat.
 
 func main() {
 	c := gortsplib.Client{}

examples/client-play-timestamp/main.go

@@ -11,9 +11,9 @@ import (
 )
 
 // This example shows how to
-// 1. connect to a RTSP server
-// 2. read all media streams on a path
-// 3. Get the PTS and NTP timestamp of incoming RTP packets
+// 1. connect to a RTSP server.
+// 2. read all media streams on a path.
+// 3. Get the PTS and NTP timestamp of incoming RTP packets.
 
 func main() {
 	c := gortsplib.Client{}

examples/client-play-to-record/main.go

@@ -11,8 +11,8 @@ import (
 )
 
 // This example shows how to
-// 1. connect to a RTSP server
-// 2. read all medias on a path
+// 1. connect to a RTSP server.
+// 2. read all medias on a path.
 // 3. re-publish all medias on another path.
 
 func main() {