mediamtx/internal/client/client.go

package client

import (
	"fmt"

	"github.com/aler9/gortsplib"
	"github.com/aler9/gortsplib/pkg/base"
	"github.com/aler9/gortsplib/pkg/headers"

	"github.com/aler9/rtsp-simple-server/internal/conf"
)

// ErrNoOnePublishing is a "no one is publishing" error.
type ErrNoOnePublishing struct {
	PathName string
}

// Error implements the error interface.
func (e ErrNoOnePublishing) Error() string {
	return fmt.Sprintf("no one is publishing to path '%s'", e.PathName)
}

// ErrAuthNotCritical is a non-critical authentication error.
type ErrAuthNotCritical struct {
	*base.Response
}

// Error implements the error interface.
func (ErrAuthNotCritical) Error() string {
	return "non-critical authentication error"
}

// ErrAuthCritical is a critical authentication error.
type ErrAuthCritical struct {
	*base.Response
}

// Error implements the error interface.
func (ErrAuthCritical) Error() string {
	return "critical authentication error"
}

// DescribeRes is a client describe response.
type DescribeRes struct {
	SDP      []byte
	Redirect string
	Err      error
}

// DescribeReq is a client describe request.
type DescribeReq struct {
	Client   Client
	PathName string
	Data     *base.Request
	Res      chan DescribeRes
}

// SetupPlayRes is a setup/play response.
type SetupPlayRes struct {
	Path   Path
	Tracks gortsplib.Tracks
	Err    error
}

// SetupPlayReq is a setup/play request.
type SetupPlayReq struct {
	Client   Client
	PathName string
	Data     interface{}
	Res      chan SetupPlayRes
}

// AnnounceRes is a client announce response.
type AnnounceRes struct {
	Path Path
	Err  error
}

// AnnounceReq is a client announce request.
type AnnounceReq struct {
	Client   Client
	PathName string
	Tracks   gortsplib.Tracks
	Data     interface{}
	Res      chan AnnounceRes
}

// RemoveReq is a remove request.
type RemoveReq struct {
	Client Client
	Res    chan struct{}
}

// TrackStartingPoint is the starting point of a track.
type TrackStartingPoint struct {
	Filled         bool // used by clientrtsp to avoid mutexes
	SequenceNumber uint16
	Timestamp      uint32
}

// PlayRes is a play response.
type PlayRes struct {
	TrackStartingPoints []*TrackStartingPoint
}

// PlayReq is a play request.
type PlayReq struct {
	Client Client
	Res    chan PlayRes
}

// RecordReq is a record request.
type RecordReq struct {
	Client Client
	Res    chan struct{}
}

// PauseReq is a pause request.
type PauseReq struct {
	Client Client
	Res    chan struct{}
}

// StartingPointReq is a starting point request.
type StartingPointReq struct {
	Client  Client
	TrackID int
	SP      *TrackStartingPoint
}

// Path is implemented by path.Path.
type Path interface {
	Name() string
	Conf() *conf.PathConf
	OnClientRemove(RemoveReq)
	OnClientPlay(PlayReq)
	OnClientRecord(RecordReq)
	OnClientPause(PauseReq)
	OnClientStartingPoint(StartingPointReq)
	OnFrame(int, gortsplib.StreamType, []byte)
}

// Client is implemented by all client*.
type Client interface {
	IsClient()
	IsSource()
	Close()
	Authenticate([]headers.AuthMethod,
		string, []interface{},
		string, string, interface{}) error
	OnIncomingFrame(int, gortsplib.StreamType, []byte)
}