added encoding options
This commit is contained in:
parent
4a4f90b613
commit
7584b9979d
|
|
@ -1,3 +1,286 @@
|
|||
{lib, ...}:
|
||||
with lib; {
|
||||
options.service.declarative-jellyfin.encoding = {
|
||||
EncodingThreadCount = mkOption {
|
||||
type = types.int;
|
||||
default = -1;
|
||||
description = ''
|
||||
Amount of threads used for encoding.
|
||||
|
||||
Set to -1 for automatic and 0 for max.
|
||||
'';
|
||||
};
|
||||
TranscodingTempPath = mkOption {
|
||||
type = types.str;
|
||||
default = "/var/cache/jellyfin/transcodes";
|
||||
description = "Path for temporary transcoded files when streaming";
|
||||
};
|
||||
EnableFallbackFont = mkEnableOption "Enable fallback font";
|
||||
EnableAudioVbr = mkEnableOption "Enable VBR Audio";
|
||||
DownMixAudioBoost = mkOption {
|
||||
type = types.float;
|
||||
default = 2;
|
||||
description = "Boost audio when downmixing. A value of one will preserve the original volume.";
|
||||
};
|
||||
DownMixStereoAlgorithm = mkOption {
|
||||
type = types.oneOf ["None" "Dave750" "NightmodeDialogue" "RFC7845" "AC-4"];
|
||||
default = "None";
|
||||
description = "Algorithm used to downmix multi-channel audio to stereo.";
|
||||
};
|
||||
MaxMuxingQueueSize = mkOption {
|
||||
type = types.int;
|
||||
default = 2048;
|
||||
description = ''
|
||||
Maximum number of packets that can be buffered while waiting for all streams to initialize.
|
||||
Try to increase it if you still meet "Too many packets buffered for output stream" error in FFmpeg logs.
|
||||
|
||||
The recommended value is `2048`.
|
||||
'';
|
||||
};
|
||||
EnableThrottling = mkEnableOption ''
|
||||
When a transcode or remux gets far enough ahead from the current playback position, pause the process so it will consume fewer resources.
|
||||
This is most useful when watching without seeking often. Turn this off if you experience playback issues.
|
||||
'';
|
||||
ThrottleDelaySeconds = mkOption {
|
||||
type = types.int;
|
||||
default = 180;
|
||||
description = ''
|
||||
Time in seconds after which the transcoder will be throttled.
|
||||
Must be large enough for the client to maintain a healthy buffer.
|
||||
Only works if throttling is enabled.
|
||||
'';
|
||||
};
|
||||
EnableSegmentDeletion = mkEnableOption ''
|
||||
Delete old segments after they have been downloaded by the client.
|
||||
This prevents having to store the entire transcoded file on disk.
|
||||
Turn this off if you experience playback issues.
|
||||
'';
|
||||
SegmentKeepSeconds = mkOption {
|
||||
type = types.int;
|
||||
default = 720;
|
||||
description = ''
|
||||
Time in seconds for which segments should be kept after they are downloaded by the client.
|
||||
Only works if segment deletion is enabled.
|
||||
'';
|
||||
};
|
||||
|
||||
HardwareAccelerationType = mkOption {
|
||||
type = types.oneOf ["none" "qsv" "amf" "nvenc" "vaapi" "rkmpp" "videotoolbox" "v4l2m2m"];
|
||||
description = ''
|
||||
Whether or not to use hardware acceleration for transcoding.
|
||||
|
||||
If you misconfigure this your streams **will not work**!.
|
||||
More info: https://jellyfin.org/docs/general/administration/hardware-acceleration/
|
||||
'';
|
||||
default = "None";
|
||||
};
|
||||
EncoderAppPathDisplay = mkOption {
|
||||
type = types.str;
|
||||
description = "The path to the FFmpeg application file or folder containing FFmpeg.";
|
||||
default = "${pkgs.jellyfin-ffmpeg}";
|
||||
};
|
||||
VaapiDevice = mkOption {
|
||||
type = types.str;
|
||||
description = ''
|
||||
This is the render node that is used for hardware acceleration.
|
||||
Only used if `HardwareAccelerationType` is set to `vaapi`.
|
||||
'';
|
||||
default = "/dev/dri/renderD128";
|
||||
};
|
||||
QsvDevice = mkOption {
|
||||
type = types.str;
|
||||
description = ''
|
||||
Specify the device for Intel QSV on a multi-GPU system.
|
||||
On Linux, this is the render node, e.g., /dev/dri/renderD128.
|
||||
Leave blank unless you know what you are doing.
|
||||
'';
|
||||
default = "";
|
||||
};
|
||||
|
||||
# Tonemapping
|
||||
EnableTonemapping = mkEnableOption ''
|
||||
Tone-mapping can transform the dynamic range of a video from HDR to SDR while maintaining image details and colors, which are very important information for representing the original scene.
|
||||
Currently works only with 10bit HDR10, HLG and DoVi videos. This requires the corresponding GPGPU runtime.
|
||||
'';
|
||||
TonemappingAlgorithm = mkOption {
|
||||
type = types.oneOf ["none" "bt2390" "clip" "linear" "gamma" "reinhard" "hable" "mobius"];
|
||||
description = ''
|
||||
Tone mapping can be fine-tuned.
|
||||
If you are not familiar with these options, just keep the default.
|
||||
'';
|
||||
default = "bt2390";
|
||||
};
|
||||
TonemappingMode = mkOption {
|
||||
type = types.oneOf ["auto" "max" "rgb" "lum" "itp"];
|
||||
description = ''
|
||||
Select the tone mapping mode.
|
||||
If you experience blown out highlights try switching to the RGB mode.
|
||||
'';
|
||||
default = "auto";
|
||||
};
|
||||
TonemappingRange = mkOption {
|
||||
type = types.oneOf ["auto" "tv" "pc"];
|
||||
description = ''
|
||||
Select the output color range. Auto is the same as the input range.
|
||||
'';
|
||||
default = "auto";
|
||||
};
|
||||
TonemappingDesat = mkOption {
|
||||
type = types.float;
|
||||
description = ''
|
||||
Apply desaturation for highlights that exceed this level of brightness.
|
||||
The higher the parameter, the more color information will be preserved.
|
||||
This setting helps prevent unnaturally blown-out colors for super-highlights, by (smoothly) turning into white instead.
|
||||
This makes images feel more natural, at the cost of reducing information about out-of-range colors.
|
||||
|
||||
The recommended and default values are 0 and 0.5.
|
||||
'';
|
||||
default = 0;
|
||||
};
|
||||
TonemappingPeak = mkOption {
|
||||
type = types.float;
|
||||
description = ''
|
||||
Override signal/nominal/reference peak with this value.
|
||||
Useful when the embedded peak information in display metadata is not reliable or when tone mapping from a lower range to a higher range.
|
||||
|
||||
The recommended and default values are 100 and 0.
|
||||
'';
|
||||
default = 100;
|
||||
};
|
||||
TonemapingParam = mkOption {
|
||||
type = types.float;
|
||||
description = ''
|
||||
Tune the tone mapping algorithm.
|
||||
The recommended and default values are 0.
|
||||
|
||||
Recommended to leave unchanged
|
||||
'';
|
||||
default = 0;
|
||||
};
|
||||
VppTonemappingBrightness = mkOption {
|
||||
type = types.float;
|
||||
description = ''
|
||||
Apply brightness gain in VPP tone mapping.
|
||||
|
||||
The recommended and default values are 16 and 0.
|
||||
'';
|
||||
default = 16;
|
||||
};
|
||||
VppTonemappingContrast = mkOption {
|
||||
type = types.float;
|
||||
description = ''
|
||||
Apply contrast gain in VPP tone mapping.
|
||||
|
||||
Both recommended and default values are 1.
|
||||
'';
|
||||
default = 0;
|
||||
};
|
||||
|
||||
H254Crf = mkOption {
|
||||
type = types.int;
|
||||
description = ''
|
||||
The 'Constant Rate Factor' (CRF) is the default quality setting for the x264 and x265 software encoders.
|
||||
You can set the values between 0 and 51, where lower values would result in better quality (at the expense of higher file sizes).
|
||||
Sane values are between 18 and 28.
|
||||
|
||||
Hardware encoders do not use these settings.
|
||||
'';
|
||||
default = 23;
|
||||
};
|
||||
H256Crf = mkOption {
|
||||
type = types.int;
|
||||
description = ''
|
||||
The 'Constant Rate Factor' (CRF) is the default quality setting for the x264 and x265 software encoders.
|
||||
You can set the values between 0 and 51, where lower values would result in better quality (at the expense of higher file sizes).
|
||||
Sane values are between 18 and 28.
|
||||
|
||||
Hardware encoders do not use these settings.
|
||||
'';
|
||||
default = 28;
|
||||
};
|
||||
|
||||
EncoderPreset = mkOption {
|
||||
type = types.oneOf [
|
||||
"auto"
|
||||
"veryslow"
|
||||
"slower"
|
||||
"slow"
|
||||
"medium"
|
||||
"fast"
|
||||
"faster"
|
||||
"veryfast"
|
||||
"superfast"
|
||||
"ultrafast"
|
||||
];
|
||||
default = "auto";
|
||||
description = ''
|
||||
Pick a faster value to improve performance, or a slower value to improve quality.
|
||||
'';
|
||||
};
|
||||
|
||||
DeinterlaceDoubleRate = mkEnableOption ''
|
||||
This setting uses the field rate when deinterlacing, often referred to as bob deinterlacing, which doubles the frame rate of the video to provide full motion like what you would see when viewing interlaced video on a TV.
|
||||
'';
|
||||
DeinterlaceMethod = mkOption {
|
||||
type = types.oneOf ["yadif" "bwdif"];
|
||||
default = "yadif";
|
||||
description = ''
|
||||
Select the deinterlacing method to use when software transcoding interlaced content.
|
||||
When hardware acceleration supporting hardware deinterlacing is enabled the hardware deinterlacer will be used instead of this setting.
|
||||
'';
|
||||
};
|
||||
|
||||
EnableDecodingColorDepth10Hevc = mkEnableOption "Enable hardware decoding for HEVC 10bit";
|
||||
EnableDecodingColorDepth10Vp9 = mkEnableOption "Enable hardware decoding for VP9 10bit";
|
||||
EnableDecodingColorDepth10HevcRext = mkEnableOption "Enable hardware decoding for HEVC RExt 8/10bit";
|
||||
EnableDecodingColorDepth12HevcRext = mkEnableOption "Enable hardware decoding for HEVC RExt 12bit";
|
||||
HardwareDecodingCodecs = mkOption {
|
||||
type = types.listOf (types.oneOf [
|
||||
"h264"
|
||||
"hevc"
|
||||
"mpeg2video"
|
||||
"vc1"
|
||||
"vp8"
|
||||
"vp9"
|
||||
"av1"
|
||||
]);
|
||||
default = [
|
||||
"h264"
|
||||
"hevc"
|
||||
"mpeg2video"
|
||||
"vc1"
|
||||
];
|
||||
description = ''
|
||||
List of codec types to enable hardware decoding for.
|
||||
Should only include codecs your hardware has support for.
|
||||
|
||||
Consult https://jellyfin.org/docs/general/administration/hardware-acceleration/ for more info.
|
||||
'';
|
||||
};
|
||||
EnableIntelLowPowerH264HwEncoder = mkEnableOption ''
|
||||
Low-Power Encoding can keep unnecessary CPU-GPU sync. On Linux they must be disabled if the i915 HuC firmware is not configured.
|
||||
|
||||
https://jellyfin.org/docs/general/administration/hardware-acceleration/intel/#configure-and-verify-lp-mode-on-linux
|
||||
'';
|
||||
EnableIntelLowPowerHevcHwEncoder = mkEnableOption ''
|
||||
Low-Power Encoding can keep unnecessary CPU-GPU sync. On Linux they must be disabled if the i915 HuC firmware is not configured.
|
||||
|
||||
https://jellyfin.org/docs/general/administration/hardware-acceleration/intel/#configure-and-verify-lp-mode-on-linux
|
||||
'';
|
||||
|
||||
EnableSubtitleExtraction = mkOption {
|
||||
type = types.bool;
|
||||
default = true;
|
||||
description = ''
|
||||
Embedded subtitles can be extracted from videos and delivered to clients in plain text, in order to help prevent video transcoding.
|
||||
On some systems this can take a long time and cause video playback to stall during the extraction process.
|
||||
Disable this to have embedded subtitles burned in with video transcoding when they are not natively supported by the client device.
|
||||
'';
|
||||
};
|
||||
AllowOnDemandMetadataBasedKeyframeExtractionForExtensions = mkOption {
|
||||
type = types.listOf str;
|
||||
description = "imma be real i have no idea what this option is. Just leave it as the default";
|
||||
default = ["mkv"];
|
||||
};
|
||||
};
|
||||
}
|
||||
|
|
|
|||
Loading…
Reference in a new issue