Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

WHIP protocol change #680

Merged
merged 21 commits into from
Apr 25, 2024
Merged

WHIP protocol change #680

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
d5f1a86
WiP
biglittlebigben Apr 15, 2024
8f81699
generated protobuf
github-actions[bot] Apr 15, 2024
b9b39d7
merge
biglittlebigben Apr 22, 2024
2a1a7f8
Validation
biglittlebigben Apr 22, 2024
be7839c
api_version
biglittlebigben Apr 22, 2024
ff09f94
EnableTranscoding
biglittlebigben Apr 23, 2024
afe3564
WiP
biglittlebigben Apr 23, 2024
ded242a
cleaup
biglittlebigben Apr 23, 2024
7612fed
generated protobuf
github-actions[bot] Apr 23, 2024
74b9830
test
biglittlebigben Apr 23, 2024
85a2a74
Create two-dogs-change.md
biglittlebigben Apr 23, 2024
46baf9a
Merge remote-tracking branch 'origin/benjamin/whip_passthrough' into …
biglittlebigben Apr 23, 2024
a0fc867
Only deprecate bypass_transcoding for now
biglittlebigben Apr 23, 2024
100b47e
generated protobuf
github-actions[bot] Apr 23, 2024
048cae4
Remove unused message
biglittlebigben Apr 24, 2024
3edec2d
Merge remote-tracking branch 'origin/benjamin/whip_passthrough' into …
biglittlebigben Apr 24, 2024
6c79d0b
generated protobuf
github-actions[bot] Apr 24, 2024
2f7d95e
Doc
biglittlebigben Apr 25, 2024
09b18e7
Merge remote-tracking branch 'origin/main' into benjamin/whip_passthr…
biglittlebigben Apr 25, 2024
1e01aca
Merge remote-tracking branch 'origin/benjamin/whip_passthrough' into …
biglittlebigben Apr 25, 2024
e291e98
generated protobuf
github-actions[bot] Apr 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Validation
  • Loading branch information
@biglittlebigben
biglittlebigben committed Apr 22, 2024
commit 2a1a7f891d2f9f28fa756c8296fe9340e1e1b331
52 changes: 48 additions & 4 deletions ingress/validation.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,16 +67,23 @@ func ValidateForSerialization(info *livekit.IngressInfo) error {
return err
}

err = ValidateVideoOptionsConsistency(info.Video)
err = ValidateVideoOptionsConsistency(info.InputType, info.Video)
if err != nil {
return err
}

err = ValidateAudioOptionsConsistency(info.Audio)
err = ValidateAudioOptionsConsistency(info.InputType, info.Audio)
if err != nil {
return err
}

if info.InputType == livekit.IngressInput_WHIP_INPUT {
err = ValidatePassthroughConsistency(info.Video, info.Audio)
if err != nil {
return err
}
}

return nil

}
Expand All @@ -103,7 +110,7 @@ func ValidateBypassTranscoding(info *livekit.IngressInfo) error {
return nil
}

func ValidateVideoOptionsConsistency(options *livekit.IngressVideoOptions) error {
func ValidateVideoOptionsConsistency(inputType livekit.IngressInput, options *livekit.IngressVideoOptions) error {
if options == nil {
return nil
}
Expand Down Expand Up @@ -131,6 +138,10 @@ func ValidateVideoOptionsConsistency(options *livekit.IngressVideoOptions) error
if err != nil {
return err
}
case *livekit.IngressVideoOptions_Passthrough:
if inputType != livekit.IngressInput_WHIP_INPUT {
return NewInvalidTranscodingBypassError("passthrough impossible with selected input type")
}
}

return nil
Expand Down Expand Up @@ -195,7 +206,7 @@ func ValidateVideoEncodingOptionsConsistency(options *livekit.IngressVideoEncodi
return nil
}

func ValidateAudioOptionsConsistency(options *livekit.IngressAudioOptions) error {
func ValidateAudioOptionsConsistency(inputType livekit.IngressInput, options *livekit.IngressAudioOptions) error {
if options == nil {
return nil
}
Expand Down Expand Up @@ -223,6 +234,10 @@ func ValidateAudioOptionsConsistency(options *livekit.IngressAudioOptions) error
if err != nil {
return err
}
case *livekit.IngressAudioOptions_Passthrough:
if inputType != livekit.IngressInput_WHIP_INPUT {
return NewInvalidTranscodingBypassError("passthrough impossible with selected input type")
}
}

return nil
Expand All @@ -247,3 +262,32 @@ func ValidateAudioEncodingOptionsConsistency(options *livekit.IngressAudioEncodi

return nil
}

func ValidatePassthroughConsistency(videoOptions *livekit.IngressVideoOptions, audioOptions *livekit.IngressAudioOptions) error {
audioPassthrough := true
videoPassthrough := true

if videoOptions != nil {
switch videoOptions.EncodingOptions.(type) {
case nil:
case *livekit.IngressVideoOptions_Passthrough:
default:
videoPassthrough = false
}
}

if audioOptions != nil {
switch audioOptions.EncodingOptions.(type) {
case nil:
case *livekit.IngressAudioOptions_Passthrough:
default:
audioPassthrough = false
}
}

if videoPassthrough != audioPassthrough {
return NewInvalidTranscodingBypassError("passthough can only be enabled for audio and video at the same time")
}

return nil
}
92 changes: 72 additions & 20 deletions ingress/validation_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,46 +102,46 @@ func TestValidateBypassTranscoding(t *testing.T) {

func TestValidateVideoOptionsConsistency(t *testing.T) {
video := &livekit.IngressVideoOptions{}
err := ValidateVideoOptionsConsistency(video)
err := ValidateVideoOptionsConsistency(livekit.IngressInput_RTMP_INPUT, video)
require.NoError(t, err)

video.Source = livekit.TrackSource_MICROPHONE
err = ValidateVideoOptionsConsistency(video)
err = ValidateVideoOptionsConsistency(livekit.IngressInput_RTMP_INPUT, video)
require.Error(t, err)

video.Source = livekit.TrackSource_CAMERA
video.EncodingOptions = &livekit.IngressVideoOptions_Preset{
Preset: livekit.IngressVideoEncodingPreset(42),
}
err = ValidateVideoOptionsConsistency(video)
err = ValidateVideoOptionsConsistency(livekit.IngressInput_RTMP_INPUT, video)
require.Error(t, err)

video.EncodingOptions = &livekit.IngressVideoOptions_Preset{
Preset: livekit.IngressVideoEncodingPreset_H264_1080P_30FPS_1_LAYER,
}
err = ValidateVideoOptionsConsistency(video)
err = ValidateVideoOptionsConsistency(livekit.IngressInput_RTMP_INPUT, video)
require.NoError(t, err)

video.EncodingOptions = &livekit.IngressVideoOptions_Options{
Options: &livekit.IngressVideoEncodingOptions{
VideoCodec: livekit.VideoCodec_H264_HIGH,
},
}
err = ValidateVideoOptionsConsistency(video)
err = ValidateVideoOptionsConsistency(livekit.IngressInput_RTMP_INPUT, video)
require.Error(t, err)

video.EncodingOptions = &livekit.IngressVideoOptions_Options{
Options: &livekit.IngressVideoEncodingOptions{
VideoCodec: livekit.VideoCodec_DEFAULT_VC,
},
}
err = ValidateVideoOptionsConsistency(video)
err = ValidateVideoOptionsConsistency(livekit.IngressInput_RTMP_INPUT, video)
require.NoError(t, err)

video.EncodingOptions.(*livekit.IngressVideoOptions_Options).Options.Layers = []*livekit.VideoLayer{
&livekit.VideoLayer{},
}
err = ValidateVideoOptionsConsistency(video)
err = ValidateVideoOptionsConsistency(livekit.IngressInput_RTMP_INPUT, video)
require.Error(t, err)

video.EncodingOptions.(*livekit.IngressVideoOptions_Options).Options.Layers = []*livekit.VideoLayer{
Expand All @@ -150,7 +150,7 @@ func TestValidateVideoOptionsConsistency(t *testing.T) {
Height: 480,
},
}
err = ValidateVideoOptionsConsistency(video)
err = ValidateVideoOptionsConsistency(livekit.IngressInput_RTMP_INPUT, video)
require.NoError(t, err)

video.EncodingOptions.(*livekit.IngressVideoOptions_Options).Options.Layers = []*livekit.VideoLayer{
Expand All @@ -159,7 +159,7 @@ func TestValidateVideoOptionsConsistency(t *testing.T) {
Height: 480,
},
}
err = ValidateVideoOptionsConsistency(video)
err = ValidateVideoOptionsConsistency(livekit.IngressInput_RTMP_INPUT, video)
require.Error(t, err)

video.EncodingOptions.(*livekit.IngressVideoOptions_Options).Options.Layers = []*livekit.VideoLayer{
Expand All @@ -174,7 +174,7 @@ func TestValidateVideoOptionsConsistency(t *testing.T) {
Quality: livekit.VideoQuality_LOW,
},
}
err = ValidateVideoOptionsConsistency(video)
err = ValidateVideoOptionsConsistency(livekit.IngressInput_RTMP_INPUT, video)
require.NoError(t, err)

video.EncodingOptions.(*livekit.IngressVideoOptions_Options).Options.Layers = []*livekit.VideoLayer{
Expand All @@ -189,7 +189,7 @@ func TestValidateVideoOptionsConsistency(t *testing.T) {
Quality: livekit.VideoQuality_HIGH,
},
}
err = ValidateVideoOptionsConsistency(video)
err = ValidateVideoOptionsConsistency(livekit.IngressInput_RTMP_INPUT, video)
require.Error(t, err)

video.EncodingOptions.(*livekit.IngressVideoOptions_Options).Options.Layers = []*livekit.VideoLayer{
Expand All @@ -204,7 +204,7 @@ func TestValidateVideoOptionsConsistency(t *testing.T) {
Quality: livekit.VideoQuality_LOW,
},
}
err = ValidateVideoOptionsConsistency(video)
err = ValidateVideoOptionsConsistency(livekit.IngressInput_RTMP_INPUT, video)
require.Error(t, err)

video.EncodingOptions.(*livekit.IngressVideoOptions_Options).Options.Layers = []*livekit.VideoLayer{
Expand All @@ -219,38 +219,45 @@ func TestValidateVideoOptionsConsistency(t *testing.T) {
Quality: livekit.VideoQuality_HIGH,
},
}
err = ValidateVideoOptionsConsistency(video)
err = ValidateVideoOptionsConsistency(livekit.IngressInput_RTMP_INPUT, video)
require.NoError(t, err)

video.EncodingOptions = &livekit.IngressVideoOptions_Passthrough{}
err = ValidateVideoOptionsConsistency(livekit.IngressInput_RTMP_INPUT, video)
require.Error(t, err)

err = ValidateVideoOptionsConsistency(livekit.IngressInput_WHIP_INPUT, video)
require.NoError(t, err)
}

func TestValidateAudioOptionsConsistency(t *testing.T) {
audio := &livekit.IngressAudioOptions{}
err := ValidateAudioOptionsConsistency(audio)
err := ValidateAudioOptionsConsistency(livekit.IngressInput_RTMP_INPUT, audio)
require.NoError(t, err)

audio.Source = livekit.TrackSource_CAMERA
err = ValidateAudioOptionsConsistency(audio)
err = ValidateAudioOptionsConsistency(livekit.IngressInput_RTMP_INPUT, audio)
require.Error(t, err)

audio.Source = livekit.TrackSource_SCREEN_SHARE_AUDIO
audio.EncodingOptions = &livekit.IngressAudioOptions_Preset{
Preset: livekit.IngressAudioEncodingPreset(42),
}
err = ValidateAudioOptionsConsistency(audio)
err = ValidateAudioOptionsConsistency(livekit.IngressInput_RTMP_INPUT, audio)
require.Error(t, err)

audio.EncodingOptions = &livekit.IngressAudioOptions_Preset{
Preset: livekit.IngressAudioEncodingPreset_OPUS_MONO_64KBS,
}
err = ValidateAudioOptionsConsistency(audio)
err = ValidateAudioOptionsConsistency(livekit.IngressInput_RTMP_INPUT, audio)
require.NoError(t, err)

audio.EncodingOptions = &livekit.IngressAudioOptions_Options{
Options: &livekit.IngressAudioEncodingOptions{
AudioCodec: livekit.AudioCodec_AAC,
},
}
err = ValidateAudioOptionsConsistency(audio)
err = ValidateAudioOptionsConsistency(livekit.IngressInput_RTMP_INPUT, audio)
require.Error(t, err)

audio.EncodingOptions = &livekit.IngressAudioOptions_Options{
Expand All @@ -259,10 +266,55 @@ func TestValidateAudioOptionsConsistency(t *testing.T) {
Channels: 3,
},
}
err = ValidateAudioOptionsConsistency(audio)
err = ValidateAudioOptionsConsistency(livekit.IngressInput_RTMP_INPUT, audio)
require.Error(t, err)

audio.EncodingOptions.(*livekit.IngressAudioOptions_Options).Options.Channels = 2
err = ValidateAudioOptionsConsistency(audio)
err = ValidateAudioOptionsConsistency(livekit.IngressInput_RTMP_INPUT, audio)
require.NoError(t, err)

audio.EncodingOptions = &livekit.IngressAudioOptions_Passthrough{}
err = ValidateAudioOptionsConsistency(livekit.IngressInput_RTMP_INPUT, audio)
require.Error(t, err)

err = ValidateAudioOptionsConsistency(livekit.IngressInput_WHIP_INPUT, audio)
require.NoError(t, err)
}

func TestValidatePassthroughConsistency(t *testing.T) {
var audio *livekit.IngressAudioOptions
var video *livekit.IngressVideoOptions

err := ValidatePassthroughConsistency(video, audio)
require.NoError(t, err)

audio = &livekit.IngressAudioOptions{}
video = &livekit.IngressVideoOptions{}

err = ValidatePassthroughConsistency(video, audio)
require.NoError(t, err)

audio.EncodingOptions = &livekit.IngressAudioOptions_Passthrough{}
err = ValidatePassthroughConsistency(video, audio)
require.NoError(t, err)

video.EncodingOptions = &livekit.IngressVideoOptions_Preset{}
err = ValidatePassthroughConsistency(video, audio)
require.Error(t, err)

audio.EncodingOptions = &livekit.IngressAudioOptions_Options{}
err = ValidatePassthroughConsistency(video, audio)
require.NoError(t, err)

video.EncodingOptions = &livekit.IngressVideoOptions_Passthrough{}
err = ValidatePassthroughConsistency(video, audio)
require.Error(t, err)

audio.EncodingOptions = &livekit.IngressAudioOptions_Passthrough{}
err = ValidatePassthroughConsistency(video, audio)
require.NoError(t, err)

video = nil
err = ValidatePassthroughConsistency(video, audio)
require.NoError(t, err)
}