replace New* with Initialize (#723)

Author: aler9

client.go

@@ -854,7 +854,8 @@ func (c *Client) trySwitchingProtocol2(medi *description.Media, baseURL *base.UR
 }
 
 func (c *Client) startTransportRoutines() {
-	c.timeDecoder = rtptime.NewGlobalDecoder2()
+	c.timeDecoder = &rtptime.GlobalDecoder2{}
+	c.timeDecoder.Initialize()
 
 	for _, cm := range c.setuppedMedias {
 		cm.start()
@@ -1025,7 +1026,7 @@ func (c *Client) do(req *base.Request, skipResponse bool) (*base.Response, error
 	// get session from response
 	if v, ok := res.Header["Session"]; ok {
 		var sx headers.Session
-		err := sx.Unmarshal(v)
+		err = sx.Unmarshal(v)
 		if err != nil {
 			return nil, liberrors.ErrClientSessionHeaderInvalid{Err: err}
 		}
@@ -1041,7 +1042,12 @@ func (c *Client) do(req *base.Request, skipResponse bool) (*base.Response, error
 		pass, _ := req.URL.User.Password()
 		user := req.URL.User.Username()
 
-		sender, err := auth.NewSender(res.Header["WWW-Authenticate"], user, pass)
+		sender := &auth.Sender{
+			WWWAuth: res.Header["WWW-Authenticate"],
+			User:    user,
+			Pass:    pass,
+		}
+		err = sender.Initialize()
 		if err != nil {
 			return nil, liberrors.ErrClientAuthSetup{Err: err}
 		}

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

@@ -12,7 +12,7 @@ import (
 
 // This example shows how to
 // 1. connect to a RTSP server
-// 2. check if there's a H264 stream and an MPEG-4 audio format
+// 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() {

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

@@ -15,7 +15,7 @@ import (
 
 // This example shows how to
 // 1. connect to a RTSP server
-// 2. check if there's an H264 format
+// 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:

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

@@ -15,7 +15,7 @@ import (
 
 // This example shows how to
 // 1. connect to a RTSP server
-// 2. check if there's an H265 format
+// 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:

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

@@ -11,7 +11,7 @@ import (
 
 // This example shows how to
 // 1. connect to a RTSP server
-// 2. check if there's an LPCM format
+// 2. check if there's a LPCM stream
 // 3. get LPCM samples of that format
 
 func main() {

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

@@ -12,7 +12,7 @@ import (
 
 // This example shows how to
 // 1. connect to a RTSP server
-// 2. check if there's an MPEG-4 audio format
+// 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() {

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

@@ -11,7 +11,7 @@ import (
 
 // This example shows how to
 // 1. connect to a RTSP server
-// 2. check if there's an MPEG-4 audio format
+// 2. check if there's a MPEG-4 audio stream
 // 3. get access units of that format
 
 func main() {

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

@@ -11,7 +11,7 @@ import (
 
 // This example shows how to
 // 1. connect to a RTSP server
-// 2. check if there's an Opus format
+// 2. check if there's an Opus stream
 // 3. get Opus packets of that format
 
 func main() {

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

@@ -14,7 +14,7 @@ import (
 
 // This example shows how to
 // 1. connect to a RTSP server
-// 2. check if there's an VP8 format
+// 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:

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

@@ -14,7 +14,7 @@ import (
 
 // This example shows how to
 // 1. connect to a RTSP server
-// 2. check if there's an VP9 format
+// 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:

examples/proxy/server.go

@@ -98,7 +98,11 @@ func (s *server) OnPlay(ctx *gortsplib.ServerHandlerOnPlayCtx) (*base.Response,
 func (s *server) setStreamReady(desc *description.Session) *gortsplib.ServerStream {
 	s.mutex.Lock()
 	defer s.mutex.Unlock()
-	s.stream = gortsplib.NewServerStream(s.s, desc)
+	s.stream = &gortsplib.ServerStream{
+		Server: s.s,
+		Desc:   desc,
+	}
+	s.stream.Initialize()
 	return s.stream
 }
 

examples/server-auth/main.go

@@ -117,7 +117,11 @@ func (sh *serverHandler) OnAnnounce(ctx *gortsplib.ServerHandlerOnAnnounceCtx) (
 	}
 
 	// create the stream and save the publisher
-	sh.stream = gortsplib.NewServerStream(sh.s, ctx.Description)
+	sh.stream = &gortsplib.ServerStream{
+		Server: sh.s,
+		Desc:   ctx.Description,
+	}
+	sh.stream.Initialize()
 	sh.publisher = ctx.Session
 
 	return &base.Response{

examples/server-tls/main.go

@@ -89,7 +89,11 @@ func (sh *serverHandler) OnAnnounce(ctx *gortsplib.ServerHandlerOnAnnounceCtx) (
 	}
 
 	// create the stream and save the publisher
-	sh.stream = gortsplib.NewServerStream(sh.s, ctx.Description)
+	sh.stream = &gortsplib.ServerStream{
+		Server: sh.s,
+		Desc:   ctx.Description,
+	}
+	sh.stream.Initialize()
 	sh.publisher = ctx.Session
 
 	return &base.Response{

examples/server/main.go

@@ -88,7 +88,11 @@ func (sh *serverHandler) OnAnnounce(ctx *gortsplib.ServerHandlerOnAnnounceCtx) (
 	}
 
 	// create the stream and save the publisher
-	sh.stream = gortsplib.NewServerStream(sh.s, ctx.Description)
+	sh.stream = &gortsplib.ServerStream{
+		Server: sh.s,
+		Desc:   ctx.Description,
+	}
+	sh.stream.Initialize()
 	sh.publisher = ctx.Session
 
 	return &base.Response{

internal/highleveltests/server_test.go

@@ -328,7 +328,11 @@ func TestServerRecordRead(t *testing.T) {
 							}, fmt.Errorf("someone is already publishing")
 						}
 
-						stream = gortsplib.NewServerStream(s, ctx.Description)
+						stream = &gortsplib.ServerStream{
+							Server: s,
+							Desc:   ctx.Description,
+						}
+						stream.Initialize()
 						publisher = ctx.Session
 
 						return &base.Response{

pkg/auth/sender.go

@@ -7,42 +7,51 @@ import (
 	"github.com/bluenviron/gortsplib/v4/pkg/headers"
 )
 
-// Sender allows to send credentials.
-type Sender struct {
-	user       string
-	pass       string
-	authHeader *headers.Authenticate
+// NewSender allocates a Sender.
+//
+// Deprecated: replaced by Sender.Initialize().
+func NewSender(wwwAuth base.HeaderValue, user string, pass string) (*Sender, error) {
+	s := &Sender{
+		WWWAuth: wwwAuth,
+		User:    user,
+		Pass:    pass,
+	}
+	err := s.Initialize()
+	return s, err
 }
 
-// NewSender allocates a Sender.
+// Sender allows to send credentials.
 // It requires a WWW-Authenticate header (provided by the server)
 // and a set of credentials.
-func NewSender(wwwAuth base.HeaderValue, user string, pass string) (*Sender, error) {
-	var bestAuthHeader *headers.Authenticate
+type Sender struct {
+	WWWAuth base.HeaderValue
+	User    string
+	Pass    string
+
+	authHeader *headers.Authenticate
+}
 
-	for _, v := range wwwAuth {
+// Initialize initializes a Sender.
+func (se *Sender) Initialize() error {
+	for _, v := range se.WWWAuth {
 		var auth headers.Authenticate
 		err := auth.Unmarshal(base.HeaderValue{v})
 		if err != nil {
 			continue // ignore unrecognized headers
 		}
 
-		if bestAuthHeader == nil ||
+		if se.authHeader == nil ||
 			(auth.Algorithm != nil && *auth.Algorithm == headers.AuthAlgorithmSHA256) ||
-			(bestAuthHeader.Method == headers.AuthMethodBasic) {
-			bestAuthHeader = &auth
+			(se.authHeader.Method == headers.AuthMethodBasic) {
+			se.authHeader = &auth
 		}
 	}
 
-	if bestAuthHeader == nil {
-		return nil, fmt.Errorf("no authentication methods available")
+	if se.authHeader == nil {
+		return fmt.Errorf("no authentication methods available")
 	}
 
-	return &Sender{
-		user:       user,
-		pass:       pass,
-		authHeader: bestAuthHeader,
-	}, nil
+	return nil
 }
 
 // AddAuthorization adds the Authorization header to a Request.
@@ -53,21 +62,21 @@ func (se *Sender) AddAuthorization(req *base.Request) {
 		Method: se.authHeader.Method,
 	}
 
-	h.Username = se.user
+	h.Username = se.User
 
 	if se.authHeader.Method == headers.AuthMethodBasic {
-		h.BasicPass = se.pass
+		h.BasicPass = se.Pass
 	} else { // digest
 		h.Realm = se.authHeader.Realm
 		h.Nonce = se.authHeader.Nonce
 		h.URI = urStr
 		h.Algorithm = se.authHeader.Algorithm
 
 		if se.authHeader.Algorithm == nil || *se.authHeader.Algorithm == headers.AuthAlgorithmMD5 {
-			h.Response = md5Hex(md5Hex(se.user+":"+se.authHeader.Realm+":"+se.pass) + ":" +
+			h.Response = md5Hex(md5Hex(se.User+":"+se.authHeader.Realm+":"+se.Pass) + ":" +
 				se.authHeader.Nonce + ":" + md5Hex(string(req.Method)+":"+urStr))
 		} else { // sha256
-			h.Response = sha256Hex(sha256Hex(se.user+":"+se.authHeader.Realm+":"+se.pass) + ":" +
+			h.Response = sha256Hex(sha256Hex(se.User+":"+se.authHeader.Realm+":"+se.Pass) + ":" +
 				se.authHeader.Nonce + ":" + sha256Hex(string(req.Method)+":"+urStr))
 		}
 	}

pkg/rtptime/global_decoder2.go

@@ -32,6 +32,15 @@ type GlobalDecoder2Track interface {
 	PTSEqualsDTS(*rtp.Packet) bool
 }
 
+// NewGlobalDecoder2 allocates a GlobalDecoder.
+//
+// Deprecated: replaced by GlobalDecoder2.Initialize().
+func NewGlobalDecoder2() *GlobalDecoder2 {
+	d := &GlobalDecoder2{}
+	d.Initialize()
+	return d
+}
+
 // GlobalDecoder2 is a RTP timestamp decoder.
 type GlobalDecoder2 struct {
 	mutex             sync.Mutex
@@ -42,11 +51,9 @@ type GlobalDecoder2 struct {
 	tracks            map[GlobalDecoder2Track]*globalDecoder2TrackData
 }
 
-// NewGlobalDecoder2 allocates a GlobalDecoder.
-func NewGlobalDecoder2() *GlobalDecoder2 {
-	return &GlobalDecoder2{
-		tracks: make(map[GlobalDecoder2Track]*globalDecoder2TrackData),
-	}
+// Initialize initializes a GlobalDecoder2.
+func (d *GlobalDecoder2) Initialize() {
+	d.tracks = make(map[GlobalDecoder2Track]*globalDecoder2TrackData)
 }
 
 // Decode decodes a timestamp.

server_conn.go

@@ -348,7 +348,7 @@ func (sc *ServerConn) handleRequestInner(req *base.Request) (*base.Response, err
 				}
 
 				if stream != nil {
-					byts, _ := serverSideDescription(stream.desc).Marshal(multicast)
+					byts, _ := serverSideDescription(stream.Desc).Marshal(multicast)
 					res.Body = byts
 				}
 			}