WHIP protocol change

.changeset/two-dogs-change.md

@@ -0,0 +1,8 @@
+---
+"github.com/livekit/protocol": minor
+"@livekit/protocol": minor
+---
+
+WHIP protocol change
+
+Deprecate the bypass_transcoding property in all ingress APIs and introduce the optional enable_transcoding property. This property will default to false for WHIP and to true for all other ingress types.

ingress/validation.go

@@ -67,6 +67,11 @@ func ValidateForSerialization(info *livekit.IngressInfo) error {
 		return err
 	}
 
+	err = ValidateEnableTranscoding(info)
+	if err != nil {
+		return err
+	}
+
 	err = ValidateVideoOptionsConsistency(info.Video)
 	if err != nil {
 		return err
@@ -103,6 +108,35 @@ func ValidateBypassTranscoding(info *livekit.IngressInfo) error {
 	return nil
 }
 
+func ValidateEnableTranscoding(info *livekit.IngressInfo) error {
+	var enableTranscoding bool
+	if info.InputType == livekit.IngressInput_WHIP_INPUT {
+		enableTranscoding = false
+		if info.EnableTranscoding != nil {
+			enableTranscoding = *info.EnableTranscoding
+		}
+	} else {
+		enableTranscoding = true
+		if info.EnableTranscoding != nil && *info.EnableTranscoding == false {
+			return NewInvalidTranscodingBypassError("bypassing transcoding impossible with selected input type")
+		}
+	}
+
+	if !enableTranscoding {
+		videoOptions := info.Video
+		if videoOptions != nil && videoOptions.EncodingOptions != nil {
+			return NewInvalidTranscodingBypassError("video encoding options must be empty if transcoding is disabled")
+		}
+
+		audioOptions := info.Audio
+		if audioOptions != nil && audioOptions.EncodingOptions != nil {
+			return NewInvalidTranscodingBypassError("audio encoding options must be empty if transcoding is disabled")
+		}
+	}
+
+	return nil
+}
+
 func ValidateVideoOptionsConsistency(options *livekit.IngressVideoOptions) error {
 	if options == nil {
 		return nil

ingress/validation_test.go

@@ -100,6 +100,49 @@ func TestValidateBypassTranscoding(t *testing.T) {
 
 }
 
+func TestValidateEnableTranscoding(t *testing.T) {
+	info := &livekit.IngressInfo{}
+	T := true
+	F := false
+
+	err := ValidateEnableTranscoding(info)
+	require.NoError(t, err)
+
+	info.InputType = livekit.IngressInput_WHIP_INPUT
+	err = ValidateEnableTranscoding(info)
+	require.NoError(t, err)
+
+	info.Audio = &livekit.IngressAudioOptions{}
+	info.Audio.EncodingOptions = &livekit.IngressAudioOptions_Options{}
+	err = ValidateEnableTranscoding(info)
+	require.Error(t, err)
+
+	info.Audio.EncodingOptions = nil
+
+	info.EnableTranscoding = &T
+	err = ValidateEnableTranscoding(info)
+	require.NoError(t, err)
+
+	info.EnableTranscoding = &F
+	err = ValidateEnableTranscoding(info)
+	require.NoError(t, err)
+
+	info.Video = &livekit.IngressVideoOptions{}
+	info.Video.EncodingOptions = &livekit.IngressVideoOptions_Preset{}
+	err = ValidateEnableTranscoding(info)
+	require.Error(t, err)
+
+	info.Video.EncodingOptions = nil
+
+	info.InputType = livekit.IngressInput_RTMP_INPUT
+	err = ValidateEnableTranscoding(info)
+	require.Error(t, err)
+
+	info.EnableTranscoding = &T
+	err = ValidateEnableTranscoding(info)
+	require.NoError(t, err)
+}
+
 func TestValidateVideoOptionsConsistency(t *testing.T) {
 	video := &livekit.IngressVideoOptions{}
 	err := ValidateVideoOptionsConsistency(video)
@@ -219,6 +262,7 @@ func TestValidateVideoOptionsConsistency(t *testing.T) {
 			Quality: livekit.VideoQuality_HIGH,
 		},
 	}
+
 	err = ValidateVideoOptionsConsistency(video)
 	require.NoError(t, err)
 }