Replace Name with RTPCodec in codec builder

Allowing users to implement RTPCodec will give users freedom to have
a custom encoder with custom RTP payload.
This commit is contained in:
Lukas Herman
2020-10-06 22:26:35 -07:00
parent c9779e7f73
commit abdd96e6b2
8 changed files with 53 additions and 61 deletions

View File

@@ -161,8 +161,10 @@ type mockParams struct {
name string name string
} }
func (params *mockParams) Name() codec.Name { func (params *mockParams) RTPCodec() *codec.RTPCodec {
return codec.Name(params.name) rtpCodec := codec.NewRTPH264Codec(90000)
rtpCodec.Name = params.name
return rtpCodec
} }
func (params *mockParams) BuildVideoEncoder(r video.Reader, p prop.Media) (codec.ReadCloser, error) { func (params *mockParams) BuildVideoEncoder(r video.Reader, p prop.Media) (codec.ReadCloser, error) {

View File

@@ -6,18 +6,31 @@ import (
"github.com/pion/mediadevices/pkg/io/audio" "github.com/pion/mediadevices/pkg/io/audio"
"github.com/pion/mediadevices/pkg/io/video" "github.com/pion/mediadevices/pkg/io/video"
"github.com/pion/mediadevices/pkg/prop" "github.com/pion/mediadevices/pkg/prop"
"github.com/pion/webrtc/v2"
) )
// Name represents codec official name. It's possible to have more than 1 implementations // RTPCodec wraps webrtc.RTPCodec. RTPCodec might extend webrtc.RTPCodec in the future.
// for the same codec name, e.g. openh264 vs x264. type RTPCodec webrtc.RTPCodec
type Name string
const ( // NewRTPH264Codec is a helper to create an H264 codec
NameOpus Name = "opus" func NewRTPH264Codec(clockrate uint32) *RTPCodec {
NameH264 Name = "H264" return (*RTPCodec)(webrtc.NewRTPH264Codec(webrtc.DefaultPayloadTypeH264, clockrate))
NameVP8 Name = "VP8" }
NameVP9 Name = "VP9"
) // NewRTPVP8Codec is a helper to create an VP8 codec
func NewRTPVP8Codec(clockrate uint32) *RTPCodec {
return (*RTPCodec)(webrtc.NewRTPVP8Codec(webrtc.DefaultPayloadTypeVP8, clockrate))
}
// NewRTPVP9Codec is a helper to create an VP9 codec
func NewRTPVP9Codec(clockrate uint32) *RTPCodec {
return (*RTPCodec)(webrtc.NewRTPVP9Codec(webrtc.DefaultPayloadTypeVP9, clockrate))
}
// NewRTPOpusCodec is a helper to create an Opus codec
func NewRTPOpusCodec(clockrate uint32) *RTPCodec {
return (*RTPCodec)(webrtc.NewRTPOpusCodec(webrtc.DefaultPayloadTypeOpus, clockrate))
}
// AudioEncoderBuilder is the interface that wraps basic operations that are // AudioEncoderBuilder is the interface that wraps basic operations that are
// necessary to build the audio encoder. // necessary to build the audio encoder.
@@ -25,8 +38,8 @@ const (
// This interface is for codec implementors to provide codec specific params, // This interface is for codec implementors to provide codec specific params,
// but still giving generality for the users. // but still giving generality for the users.
type AudioEncoderBuilder interface { type AudioEncoderBuilder interface {
// Name represents the codec name // RTPCodec represents the codec metadata
Name() Name RTPCodec() *RTPCodec
// BuildAudioEncoder builds audio encoder by given media params and audio input // BuildAudioEncoder builds audio encoder by given media params and audio input
BuildAudioEncoder(r audio.Reader, p prop.Media) (ReadCloser, error) BuildAudioEncoder(r audio.Reader, p prop.Media) (ReadCloser, error)
} }
@@ -37,8 +50,8 @@ type AudioEncoderBuilder interface {
// This interface is for codec implementors to provide codec specific params, // This interface is for codec implementors to provide codec specific params,
// but still giving generality for the users. // but still giving generality for the users.
type VideoEncoderBuilder interface { type VideoEncoderBuilder interface {
// Name represents the codec name // RTPCodec represents the codec metadata
Name() Name RTPCodec() *RTPCodec
// BuildVideoEncoder builds video encoder by given media params and video input // BuildVideoEncoder builds video encoder by given media params and video input
BuildVideoEncoder(r video.Reader, p prop.Media) (ReadCloser, error) BuildVideoEncoder(r video.Reader, p prop.Media) (ReadCloser, error)
} }

View File

@@ -20,9 +20,9 @@ func NewParams() (Params, error) {
}, nil }, nil
} }
// Name represents the codec name // RTPCodec represents the codec metadata
func (p *Params) Name() codec.Name { func (p *Params) RTPCodec() *codec.RTPCodec {
return codec.NameH264 return codec.NewRTPH264Codec(90000)
} }
// BuildVideoEncoder builds openh264 encoder with given params // BuildVideoEncoder builds openh264 encoder with given params

View File

@@ -19,9 +19,9 @@ func NewParams() (Params, error) {
return Params{}, nil return Params{}, nil
} }
// Name represents the codec name // RTPCodec represents the codec metadata
func (p *Params) Name() codec.Name { func (p *Params) RTPCodec() *codec.RTPCodec {
return codec.NameOpus return codec.NewRTPOpusCodec(48000)
} }
// BuildAudioEncoder builds opus encoder with given params // BuildAudioEncoder builds opus encoder with given params

View File

@@ -43,9 +43,9 @@ func NewVP8Params() (ParamsVP8, error) {
}, nil }, nil
} }
// Name represents the codec name // RTPCodec represents the codec metadata
func (p *ParamsVP8) Name() codec.Name { func (p *ParamsVP8) RTPCodec() *codec.RTPCodec {
return codec.NameVP8 return codec.NewRTPVP8Codec(90000)
} }
// BuildVideoEncoder builds VP8 encoder with given params // BuildVideoEncoder builds VP8 encoder with given params
@@ -112,9 +112,9 @@ func NewVP9Params() (ParamsVP9, error) {
}, nil }, nil
} }
// Name represents the codec name // RTPCodec represents the codec metadata
func (p *ParamsVP9) Name() codec.Name { func (p *ParamsVP9) RTPCodec() *codec.RTPCodec {
return codec.NameVP9 return codec.NewRTPVP9Codec(90000)
} }
// BuildVideoEncoder builds VP9 encoder with given params // BuildVideoEncoder builds VP9 encoder with given params

View File

@@ -94,9 +94,9 @@ func NewVP8Params() (VP8Params, error) {
}, nil }, nil
} }
// Name represents the codec name // RTPCodec represents the codec metadata
func (p *VP8Params) Name() codec.Name { func (p *VP8Params) RTPCodec() *codec.RTPCodec {
return codec.NameVP8 return codec.NewRTPVP8Codec(90000)
} }
// BuildVideoEncoder builds VP8 encoder with given params // BuildVideoEncoder builds VP8 encoder with given params
@@ -121,9 +121,9 @@ func NewVP9Params() (VP9Params, error) {
}, nil }, nil
} }
// Name represents the codec name // RTPCodec represents the codec metadata
func (p *VP9Params) Name() codec.Name { func (p *VP9Params) RTPCodec() *codec.RTPCodec {
return codec.NameVP9 return codec.NewRTPVP9Codec(90000)
} }
// BuildVideoEncoder builds VP9 encoder with given params // BuildVideoEncoder builds VP9 encoder with given params

View File

@@ -39,9 +39,9 @@ func NewParams() (Params, error) {
}, nil }, nil
} }
// Name represents the codec name // RTPCodec represents the codec metadata
func (p *Params) Name() codec.Name { func (p *Params) RTPCodec() *codec.RTPCodec {
return codec.NameH264 return codec.NewRTPH264Codec(90000)
} }
// BuildVideoEncoder builds x264 encoder with given params // BuildVideoEncoder builds x264 encoder with given params

View File

@@ -12,15 +12,6 @@ import (
"github.com/pion/webrtc/v2/pkg/media" "github.com/pion/webrtc/v2/pkg/media"
) )
var (
webrtcCodecMapper = map[codec.Name]string{
codec.NameH264: webrtc.H264,
codec.NameVP8: webrtc.VP8,
codec.NameVP9: webrtc.VP9,
codec.NameOpus: webrtc.Opus,
}
)
// Tracker is an interface that represent MediaStreamTrack // Tracker is an interface that represent MediaStreamTrack
// Reference: https://w3c.github.io/mediacapture-main/#mediastreamtrack // Reference: https://w3c.github.io/mediacapture-main/#mediastreamtrack
type Tracker interface { type Tracker interface {
@@ -216,14 +207,7 @@ func newVideoEncoderBuilders(vr driver.VideoRecorder, constraints MediaTrackCons
encoderBuilders := make([]encoderBuilder, len(constraints.VideoEncoderBuilders)) encoderBuilders := make([]encoderBuilder, len(constraints.VideoEncoderBuilders))
for i, b := range constraints.VideoEncoderBuilders { for i, b := range constraints.VideoEncoderBuilders {
// If the codec name is not in the supported mapping, fallback to as is encoderBuilders[i].name = b.RTPCodec().Name
codecName := b.Name()
mappedName, ok := webrtcCodecMapper[codecName]
if ok {
encoderBuilders[i].name = mappedName
} else {
encoderBuilders[i].name = string(codecName)
}
encoderBuilders[i].build = func() (codec.ReadCloser, error) { encoderBuilders[i].build = func() (codec.ReadCloser, error) {
return b.BuildVideoEncoder(r, constraints.selectedMedia) return b.BuildVideoEncoder(r, constraints.selectedMedia)
} }
@@ -245,14 +229,7 @@ func newAudioEncoderBuilders(ar driver.AudioRecorder, constraints MediaTrackCons
encoderBuilders := make([]encoderBuilder, len(constraints.AudioEncoderBuilders)) encoderBuilders := make([]encoderBuilder, len(constraints.AudioEncoderBuilders))
for i, b := range constraints.AudioEncoderBuilders { for i, b := range constraints.AudioEncoderBuilders {
// If the codec name is not in the supported mapping, fallback to as is encoderBuilders[i].name = b.RTPCodec().Name
codecName := b.Name()
mappedName, ok := webrtcCodecMapper[codecName]
if ok {
encoderBuilders[i].name = mappedName
} else {
encoderBuilders[i].name = string(codecName)
}
encoderBuilders[i].build = func() (codec.ReadCloser, error) { encoderBuilders[i].build = func() (codec.ReadCloser, error) {
return b.BuildAudioEncoder(r, constraints.selectedMedia) return b.BuildAudioEncoder(r, constraints.selectedMedia)
} }