owncast/core/transcoder/codecs.go

//nolint:goconst

package transcoder

import (
	"fmt"
	"os/exec"
	"strings"

	"github.com/owncast/owncast/models"
	log "github.com/sirupsen/logrus"
)

// Codec represents a supported codec on the system.
type Codec interface {
	Name() string
	DisplayName() string
	Key() string
	GlobalFlags() string
	PixelFormat() string
	Scaler() string
	ExtraArguments() string
	ExtraFilters() string
	VariantFlags(v *HLSVariant) string
	GetPresetForLevel(l int) string
	GetRepresentation() models.VideoCodec
}

var supportedCodecs = map[string]string{
	(&Libx264Codec{}).Name():      "libx264",
	(&OmxCodec{}).Name():          "omx",
	(&VaapiLegacyCodec{}).Name():  "vaapi (legacy)",
	(&VaapiCodec{}).Name():        "vaapi (ffmpeg 5+)",
	(&NvencCodec{}).Name():        "NVIDIA nvenc",
	(&VideoToolboxCodec{}).Name(): "videotoolbox",
}

type Libx264Codec struct{}

// Name returns the codec name.
func (c *Libx264Codec) Name() string {
	return "libx264"
}

// DisplayName returns the human readable name of the codec.
func (c *Libx264Codec) DisplayName() string {
	return "x264 (Default)"
}

// Name returns the codec key.
func (c *Libx264Codec) Key() string {
	return c.Name()
}

// GlobalFlags are the global flags used with this codec in the transcoder.
func (c *Libx264Codec) GlobalFlags() string {
	return ""
}

// PixelFormat is the pixel format required for this codec.
func (c *Libx264Codec) PixelFormat() string {
	return "yuv420p" //nolint:goconst
}

// Scaler is the scaler used for resizing the video in the transcoder.
func (c *Libx264Codec) Scaler() string {
	return ""
}

// ExtraArguments are the extra arguments used with this codec in the transcoder.
func (c *Libx264Codec) ExtraArguments() string {
	return strings.Join([]string{
		"-tune", "zerolatency", // Option used for good for fast encoding and low-latency streaming (always includes iframes in each segment)
	}, " ")
}

// ExtraFilters are the extra filters required for this codec in the transcoder.
func (c *Libx264Codec) ExtraFilters() string {
	return ""
}

// VariantFlags returns a string representing a single variant processed by this codec.
func (c *Libx264Codec) VariantFlags(v *HLSVariant) string {
	return strings.Join([]string{
		fmt.Sprintf("-x264-params:v:%d \"scenecut=0:open_gop=0\"", v.index), // How often the encoder checks the bitrate in order to meet average/max values
		fmt.Sprintf("-bufsize:v:%d %dk", v.index, v.getBufferSize()),
		fmt.Sprintf("-profile:v:%d %s", v.index, "high"), // Encoding profile
	}, " ")
}

// GetPresetForLevel returns the string preset for this codec given an integer level.
func (c *Libx264Codec) GetPresetForLevel(l int) string {
	presetMapping := map[int]string{
		0: "ultrafast",
		1: "superfast",
		2: "veryfast",
		3: "faster",
		4: "fast",
	}

	preset, ok := presetMapping[l]
	if !ok {
		defaultPreset := presetMapping[1]
		log.Errorf("Invalid level for x264 preset %d, defaulting to %s", l, defaultPreset)
		return defaultPreset
	}

	return preset
}

// GetRepresentation returns the simplified codec representation of this codec.
func (c *Libx264Codec) GetRepresentation() models.VideoCodec {
	return models.VideoCodec{
		Name:        c.Name(),
		DisplayName: c.DisplayName(),
		Key:         c.Key(),
	}
}

// OmxCodec represents an instance of the Omx codec.
type OmxCodec struct{}

// Name returns the codec name.
func (c *OmxCodec) Name() string {
	return "h264_omx"
}

// DisplayName returns the human readable name of the codec.
func (c *OmxCodec) DisplayName() string {
	return "OpenMAX (omx)"
}

// Name returns the codec key.
func (c *OmxCodec) Key() string {
	return c.Name()
}

// GlobalFlags are the global flags used with this codec in the transcoder.
func (c *OmxCodec) GlobalFlags() string {
	return ""
}

// PixelFormat is the pixel format required for this codec.
func (c *OmxCodec) PixelFormat() string {
	return "yuv420p"
}

// Scaler is the scaler used for resizing the video in the transcoder.
func (c *OmxCodec) Scaler() string {
	return ""
}

// ExtraArguments are the extra arguments used with this codec in the transcoder.
func (c *OmxCodec) ExtraArguments() string {
	return strings.Join([]string{
		"-tune", "zerolatency", // Option used for good for fast encoding and low-latency streaming (always includes iframes in each segment)
	}, " ")
}

// ExtraFilters are the extra filters required for this codec in the transcoder.
func (c *OmxCodec) ExtraFilters() string {
	return ""
}

// VariantFlags returns a string representing a single variant processed by this codec.
func (c *OmxCodec) VariantFlags(v *HLSVariant) string {
	return ""
}

// GetPresetForLevel returns the string preset for this codec given an integer level.
func (c *OmxCodec) GetPresetForLevel(l int) string {
	presetMapping := map[int]string{
		0: "ultrafast",
		1: "superfast",
		2: "veryfast",
		3: "faster",
		4: "fast",
	}

	preset, ok := presetMapping[l]
	if !ok {
		defaultPreset := presetMapping[1]
		log.Errorf("Invalid level for omx preset %d, defaulting to %s", l, defaultPreset)
		return defaultPreset
	}

	return preset
}

// GetRepresentation returns the simplified codec representation of this codec.
func (c *OmxCodec) GetRepresentation() models.VideoCodec {
	return models.VideoCodec{
		Name:        c.Name(),
		DisplayName: c.DisplayName(),
		Key:         c.Key(),
	}
}

// VaapiLegacyCodec represents an instance of the Vaapi codec.
type VaapiLegacyCodec struct{}

// Name returns the codec name.
func (c *VaapiLegacyCodec) Name() string {
	return "h264_vaapi" //nolint:goconst
}

// DisplayName returns the human readable name of the codec.
func (c *VaapiLegacyCodec) DisplayName() string {
	return "VA-API (Legacy)"
}

// Name returns the codec key.
func (c *VaapiLegacyCodec) Key() string {
	return "h264_vaapi_legacy"
}

// GlobalFlags are the global flags used with this codec in the transcoder.
func (c *VaapiLegacyCodec) GlobalFlags() string {
	flags := []string{
		"-hwaccel", "vaapi",
		"-hwaccel_output_format", "vaapi",
		"-vaapi_device", "/dev/dri/renderD128",
	}

	return strings.Join(flags, " ")
}

// PixelFormat is the pixel format required for this codec.
func (c *VaapiLegacyCodec) PixelFormat() string {
	return "vaapi_vld"
}

// Scaler is the scaler used for resizing the video in the transcoder.
func (c *VaapiLegacyCodec) Scaler() string {
	return "scale_vaapi"
}

// ExtraFilters are the extra filters required for this codec in the transcoder.
func (c *VaapiLegacyCodec) ExtraFilters() string {
	return ""
}

// ExtraArguments are the extra arguments used with this codec in the transcoder.
func (c *VaapiLegacyCodec) ExtraArguments() string {
	return ""
}

// VariantFlags returns a string representing a single variant processed by this codec.
func (c *VaapiLegacyCodec) VariantFlags(v *HLSVariant) string {
	return ""
}

// GetPresetForLevel returns the string preset for this codec given an integer level.
func (c *VaapiLegacyCodec) GetPresetForLevel(l int) string {
	presetMapping := map[int]string{
		0: "ultrafast",
		1: "superfast",
		2: "veryfast",
		3: "faster",
		4: "fast",
	}

	preset, ok := presetMapping[l]
	if !ok {
		defaultPreset := presetMapping[1]
		log.Errorf("Invalid level for vaapi preset %d, defaulting to %s", l, defaultPreset)
		return defaultPreset
	}

	return preset
}

// GetRepresentation returns the simplified codec representation of this codec.
func (c *VaapiLegacyCodec) GetRepresentation() models.VideoCodec {
	return models.VideoCodec{
		Name:        c.Name(),
		DisplayName: c.DisplayName(),
		Key:         c.Key(),
	}
}

// VaapiCodec represents the vaapi codec included in ffmpeg 5.0+.
type VaapiCodec struct{}

// Name returns the codec name.
func (c *VaapiCodec) Name() string {
	return "h264_vaapi"
}

// DisplayName returns the human readable name of the codec.
func (c *VaapiCodec) DisplayName() string {
	return "VA-API (ffmpeg 5+)"
}

// Name returns the codec key.
func (c *VaapiCodec) Key() string {
	return "h264_vaapi"
}

// GlobalFlags are the global flags used with this codec in the transcoder.
func (c *VaapiCodec) GlobalFlags() string {
	flags := []string{
		"-hwaccel", "vaapi",
		"-hwaccel_output_format", "vaapi",
		"-vaapi_device", "/dev/dri/renderD128",
	}

	return strings.Join(flags, " ")
}

// PixelFormat is the pixel format required for this codec.
func (c *VaapiCodec) PixelFormat() string {
	return "vaapi"
}

// Scaler is the scaler used for resizing the video in the transcoder.
func (c *VaapiCodec) Scaler() string {
	return "scale_vaapi"
}

// ExtraFilters are the extra filters required for this codec in the transcoder.
func (c *VaapiCodec) ExtraFilters() string {
	return ""
}

// ExtraArguments are the extra arguments used with this codec in the transcoder.
func (c *VaapiCodec) ExtraArguments() string {
	return ""
}

// VariantFlags returns a string representing a single variant processed by this codec.
func (c *VaapiCodec) VariantFlags(v *HLSVariant) string {
	return "-compression_level 0"
}

// GetPresetForLevel returns the string preset for this codec given an integer level.
func (c *VaapiCodec) GetPresetForLevel(l int) string {
	// This codec does not support presets. It uses a compression level instead.
	// See the VariantFlags method.
	return ""
}

// GetRepresentation returns the simplified codec representation of this codec.
func (c *VaapiCodec) GetRepresentation() models.VideoCodec {
	return models.VideoCodec{
		Name:        c.Name(),
		DisplayName: c.DisplayName(),
		Key:         c.Key(),
	}
}

// NvencCodec represents an instance of the Nvenc Codec.
type NvencCodec struct{}

// Name returns the codec name.
func (c *NvencCodec) Name() string {
	return "h264_nvenc"
}

// DisplayName returns the human readable name of the codec.
func (c *NvencCodec) DisplayName() string {
	return "nvidia nvenc"
}

// Name returns the codec key.
func (c *NvencCodec) Key() string {
	return c.Name()
}

// GlobalFlags are the global flags used with this codec in the transcoder.
func (c *NvencCodec) GlobalFlags() string {
	flags := []string{
		"-hwaccel", "cuda",
	}

	return strings.Join(flags, " ")
}

// PixelFormat is the pixel format required for this codec.
func (c *NvencCodec) PixelFormat() string {
	return "yuv420p"
}

// Scaler is the scaler used for resizing the video in the transcoder.
func (c *NvencCodec) Scaler() string {
	return ""
}

// ExtraArguments are the extra arguments used with this codec in the transcoder.
func (c *NvencCodec) ExtraArguments() string {
	return ""
}

// ExtraFilters are the extra filters required for this codec in the transcoder.
func (c *NvencCodec) ExtraFilters() string {
	return ""
}

// VariantFlags returns a string representing a single variant processed by this codec.
func (c *NvencCodec) VariantFlags(v *HLSVariant) string {
	tuning := "ll" // low latency
	return fmt.Sprintf("-tune:v:%d %s", v.index, tuning)
}

// GetPresetForLevel returns the string preset for this codec given an integer level.
func (c *NvencCodec) GetPresetForLevel(l int) string {
	presetMapping := map[int]string{
		0: "p1",
		1: "p2",
		2: "p3",
		3: "p4",
		4: "p5",
	}

	preset, ok := presetMapping[l]
	if !ok {
		defaultPreset := presetMapping[2]
		log.Errorf("Invalid level for nvenc preset %d, defaulting to %s", l, defaultPreset)
		return defaultPreset
	}

	return preset
}

// GetRepresentation returns the simplified codec representation of this codec.
func (c *NvencCodec) GetRepresentation() models.VideoCodec {
	return models.VideoCodec{
		Name:        c.Name(),
		DisplayName: c.DisplayName(),
		Key:         c.Key(),
	}
}

// QuicksyncCodec represents an instance of the Intel Quicksync Codec.
type QuicksyncCodec struct{}

// Name returns the codec name.
func (c *QuicksyncCodec) Name() string {
	return "h264_qsv"
}

// DisplayName returns the human readable name of the codec.
func (c *QuicksyncCodec) DisplayName() string {
	return "Intel QuickSync"
}

// Name returns the codec key.
func (c *QuicksyncCodec) Key() string {
	return c.Name()
}

// GlobalFlags are the global flags used with this codec in the transcoder.
func (c *QuicksyncCodec) GlobalFlags() string {
	return ""
}

// PixelFormat is the pixel format required for this codec.
func (c *QuicksyncCodec) PixelFormat() string {
	return "nv12"
}

// Scaler is the scaler used for resizing the video in the transcoder.
func (c *QuicksyncCodec) Scaler() string {
	return ""
}

// ExtraArguments are the extra arguments used with this codec in the transcoder.
func (c *QuicksyncCodec) ExtraArguments() string {
	return ""
}

// ExtraFilters are the extra filters required for this codec in the transcoder.
func (c *QuicksyncCodec) ExtraFilters() string {
	return ""
}

// VariantFlags returns a string representing a single variant processed by this codec.
func (c *QuicksyncCodec) VariantFlags(v *HLSVariant) string {
	return ""
}

// GetPresetForLevel returns the string preset for this codec given an integer level.
func (c *QuicksyncCodec) GetPresetForLevel(l int) string {
	presetMapping := map[int]string{
		0: "ultrafast",
		1: "superfast",
		2: "veryfast",
		3: "faster",
		4: "fast",
	}

	preset, ok := presetMapping[l]
	if !ok {
		defaultPreset := presetMapping[1]
		log.Errorf("Invalid level for quicksync preset %d, defaulting to %s", l, defaultPreset)
		return defaultPreset
	}

	return preset
}

// GetRepresentation returns the simplified codec representation of this codec.
func (c *QuicksyncCodec) GetRepresentation() models.VideoCodec {
	return models.VideoCodec{
		Name:        c.Name(),
		DisplayName: c.DisplayName(),
		Key:         c.Key(),
	}
}

// Video4Linux represents an instance of the V4L Codec.
type Video4Linux struct{}

// Name returns the codec name.
func (c *Video4Linux) Name() string {
	return "h264_v4l2m2m"
}

// DisplayName returns the human readable name of the codec.
func (c *Video4Linux) DisplayName() string {
	return "Video4Linux"
}

// Name returns the codec key.
func (c *Video4Linux) Key() string {
	return c.Name()
}

// GlobalFlags are the global flags used with this codec in the transcoder.
func (c *Video4Linux) GlobalFlags() string {
	return ""
}

// PixelFormat is the pixel format required for this codec.
func (c *Video4Linux) PixelFormat() string {
	return "nv21"
}

// Scaler is the scaler used for resizing the video in the transcoder.
func (c *Video4Linux) Scaler() string {
	return ""
}

// ExtraArguments are the extra arguments used with this codec in the transcoder.
func (c *Video4Linux) ExtraArguments() string {
	return ""
}

// ExtraFilters are the extra filters required for this codec in the transcoder.
func (c *Video4Linux) ExtraFilters() string {
	return ""
}

// VariantFlags returns a string representing a single variant processed by this codec.
func (c *Video4Linux) VariantFlags(v *HLSVariant) string {
	return ""
}

// GetPresetForLevel returns the string preset for this codec given an integer level.
func (c *Video4Linux) GetPresetForLevel(l int) string {
	presetMapping := map[int]string{
		0: "ultrafast",
		1: "superfast",
		2: "veryfast",
		3: "faster",
		4: "fast",
	}

	preset, ok := presetMapping[l]
	if !ok {
		defaultPreset := presetMapping[1]
		log.Errorf("Invalid level for v4l preset %d, defaulting to %s", l, defaultPreset)
		return defaultPreset
	}
	return preset
}

// GetRepresentation returns the simplified codec representation of this codec.
func (c *Video4Linux) GetRepresentation() models.VideoCodec {
	return models.VideoCodec{
		Name:        c.Name(),
		DisplayName: c.DisplayName(),
		Key:         c.Key(),
	}
}

// VideoToolboxCodec represents an instance of the VideoToolbox codec.
type VideoToolboxCodec struct{}

// Name returns the codec name.
func (c *VideoToolboxCodec) Name() string {
	return "h264_videotoolbox"
}

// DisplayName returns the human readable name of the codec.
func (c *VideoToolboxCodec) DisplayName() string {
	return "VideoToolbox"
}

// Name returns the codec key.
func (c *VideoToolboxCodec) Key() string {
	return c.Name()
}

// GlobalFlags are the global flags used with this codec in the transcoder.
func (c *VideoToolboxCodec) GlobalFlags() string {
	var flags []string

	return strings.Join(flags, " ")
}

// PixelFormat is the pixel format required for this codec.
func (c *VideoToolboxCodec) PixelFormat() string {
	return "nv12"
}

// Scaler is the scaler used for resizing the video in the transcoder.
func (c *VideoToolboxCodec) Scaler() string {
	return ""
}

// ExtraFilters are the extra filters required for this codec in the transcoder.
func (c *VideoToolboxCodec) ExtraFilters() string {
	return ""
}

// ExtraArguments are the extra arguments used with this codec in the transcoder.
func (c *VideoToolboxCodec) ExtraArguments() string {
	return ""
}

// VariantFlags returns a string representing a single variant processed by this codec.
func (c *VideoToolboxCodec) VariantFlags(v *HLSVariant) string {
	arguments := []string{
		"-realtime true",
		"-realtime true",
		"-realtime true",
	}

	if v.cpuUsageLevel >= len(arguments) {
		return ""
	}

	return arguments[v.cpuUsageLevel]
}

// GetPresetForLevel returns the string preset for this codec given an integer level.
func (c *VideoToolboxCodec) GetPresetForLevel(l int) string {
	presetMapping := map[int]string{
		0: "ultrafast",
		1: "superfast",
		2: "veryfast",
		3: "faster",
		4: "fast",
	}

	preset, ok := presetMapping[l]
	if !ok {
		defaultPreset := presetMapping[1]
		log.Errorf("Invalid level for videotoolbox preset %d, defaulting to %s", l, defaultPreset)
		return defaultPreset
	}

	return preset
}

// GetRepresentation returns the simplified codec representation of this codec.
func (c *VideoToolboxCodec) GetRepresentation() models.VideoCodec {
	return models.VideoCodec{
		Name:        c.Name(),
		DisplayName: c.DisplayName(),
		Key:         c.Key(),
	}
}

// GetCodecs will return the supported codecs available on the system.
func GetCodecs(ffmpegPath string) []models.VideoCodec {
	codecs := make([]models.VideoCodec, 0)

	cmd := exec.Command(ffmpegPath, "-encoders")
	out, err := cmd.CombinedOutput()
	if err != nil {
		return codecs
	}
	response := string(out)
	lines := strings.Split(response, "\n")
	for _, line := range lines {
		if strings.Contains(line, "H.264") {
			fields := strings.Fields(line)
			codecString := fields[1]
			supportedCodecsForName := getCodec(codecString)
			for _, codec := range supportedCodecsForName {
				if _, supported := supportedCodecs[codecString]; supported {
					codecs = append(codecs, codec.GetRepresentation())
				}
			}
		}
	}

	return codecs
}

func getCodec(name string) []Codec {
	switch name {
	case (&NvencCodec{}).Name():
		return []Codec{&NvencCodec{}}
	case (&VaapiLegacyCodec{}).Name():
		return []Codec{&VaapiLegacyCodec{}, &VaapiCodec{}}
	case (&VaapiCodec{}).Name():
		return []Codec{&VaapiLegacyCodec{}, &VaapiCodec{}}
	case (&QuicksyncCodec{}).Name():
		return []Codec{&QuicksyncCodec{}}
	case (&OmxCodec{}).Name():
		return []Codec{&OmxCodec{}}
	case (&Video4Linux{}).Name():
		return []Codec{&Video4Linux{}}
	case (&VideoToolboxCodec{}).Name():
		return []Codec{&VideoToolboxCodec{}}
	case (&Libx264Codec{}).Name():
		return []Codec{&Libx264Codec{}}
	default:
		return []Codec{}
	}
}

func getCodecForKey(key string) Codec {
	switch key {
	case (&NvencCodec{}).Key():
		return &NvencCodec{}
	case (&VaapiLegacyCodec{}).Key():
		return &VaapiLegacyCodec{}
	case (&VaapiCodec{}).Key():
		return &VaapiCodec{}
	case (&QuicksyncCodec{}).Key():
		return &QuicksyncCodec{}
	case (&OmxCodec{}).Key():
		return &OmxCodec{}
	case (&Video4Linux{}).Key():
		return &Video4Linux{}
	case (&VideoToolboxCodec{}).Key():
		return &VideoToolboxCodec{}
	default:
		return &Libx264Codec{}
	}
}