Damiano Galassi 4955ef8553
libhb: clean up qsv (#6958)
Removed all the unused parts from the previous implementation
and refactored many checks to avoid duplication.
2025-06-12 18:59:56 +02:00

656 lines
29 KiB
C#

// --------------------------------------------------------------------------------------------------------------------
// <copyright file="EncodeTaskFactory.cs" company="HandBrake Project (http://handbrake.fr)">
// This file is part of the HandBrake source code - It may be used under the terms of the GNU General Public License.
// </copyright>
// <summary>
// The encode factory.
// </summary>
// --------------------------------------------------------------------------------------------------------------------
namespace HandBrakeWPF.Services.Encode.Factories
{
using System;
using System.Collections.Generic;
using System.Globalization;
using System.Linq;
using System.Text.Json;
using HandBrake.App.Core.Utilities;
using HandBrake.Interop.Interop;
using HandBrake.Interop.Interop.HbLib;
using HandBrake.Interop.Interop.Interfaces.Model.Encoders;
using HandBrake.Interop.Interop.Json.Encode;
using HandBrake.Interop.Interop.Json.Shared;
using HandBrakeWPF.Model.Filters;
using HandBrakeWPF.Services.Interfaces;
using AudioEncoderRateType = Model.Models.AudioEncoderRateType;
using AudioTrack = Model.Models.AudioTrack;
using ChapterMarker = Model.Models.ChapterMarker;
using EncodeTask = Model.EncodeTask;
using FramerateMode = Model.Models.FramerateMode;
using OutputFormat = Model.Models.OutputFormat;
using PointToPointMode = Model.Models.PointToPointMode;
using Range = HandBrake.Interop.Interop.Json.Encode.Range;
using Subtitle = HandBrake.Interop.Interop.Json.Encode.Subtitles;
using SubtitleTrack = Model.Models.SubtitleTrack;
using VideoEncodeRateType = HandBrakeWPF.Model.Video.VideoEncodeRateType;
/// <summary>
/// This factory takes the internal EncodeJob object and turns it into a set of JSON models
/// that can be deserialized by libhb.
/// </summary>
internal class EncodeTaskFactory
{
private readonly IUserSettingService userSettingService;
private readonly bool isEncodePath;
public EncodeTaskFactory(IUserSettingService userSettingService, bool isEncodePath)
{
this.userSettingService = userSettingService;
this.isEncodePath = isEncodePath;
}
internal JsonEncodeObject Create(EncodeTask job)
{
JsonEncodeObject encode = new JsonEncodeObject
{
SequenceID = 0,
Audio = CreateAudio(job),
Destination = CreateDestination(job),
Filters = CreateFilters(job),
PAR = CreatePAR(job),
Metadata = CreateMetadata(job),
CoverArts = CreateCoverArts(job),
Source = CreateSource(job),
Subtitle = CreateSubtitle(job),
Video = CreateVideo(job)
};
return encode;
}
private List<CoverArt> CreateCoverArts(EncodeTask job)
{
if (job.CoverArts != null && job.PassthruMetadataEnabled)
{
List<CoverArt> coverArts = new List<CoverArt>();
foreach (var item in job.CoverArts)
{
coverArts.Add(item); // TODO: Support enable / disable of individual files
}
return coverArts;
}
return new List<CoverArt>(); // Empty Coverarts will not pass through to the destination.
}
private Source CreateSource(EncodeTask job)
{
Range range = new Range();
switch (job.PointToPointMode)
{
case PointToPointMode.Chapters:
range.Type = "chapter";
range.Start = job.StartPoint;
range.End = job.EndPoint;
break;
case PointToPointMode.Seconds:
range.Type = "time";
range.Start = job.StartPoint * 90000;
range.End = job.EndPoint * 90000;
break;
case PointToPointMode.Frames:
range.Type = "frame";
range.Start = job.StartPoint;
range.End = job.EndPoint;
break;
case PointToPointMode.Preview:
range.Type = "preview";
range.Start = job.PreviewEncodeStartAt;
range.SeekPoints = this.userSettingService.GetUserSetting<int>(UserSettingConstants.PreviewScanCount);
range.End = job.PreviewEncodeDuration * 90000;
break;
}
bool nvdec = this.userSettingService.GetUserSetting<bool>(UserSettingConstants.EnableNvDecSupport);
bool directx = this.userSettingService.GetUserSetting<bool>(UserSettingConstants.EnableDirectXDecoding);
int hwDecode = 0;
if (nvdec)
{
hwDecode = (int)NativeConstants.HB_DECODE_SUPPORT_NVDEC;
}
if (directx && HandBrakeHardwareEncoderHelper.IsDirectXAvailable)
{
hwDecode = (int)NativeConstants.HB_DECODE_SUPPORT_MF;
}
bool qsv = this.userSettingService.GetUserSetting<bool>(UserSettingConstants.EnableQuickSyncDecoding);
if (qsv)
{
hwDecode |= (int)NativeConstants.HB_DECODE_SUPPORT_QSV;
}
Source source = new Source
{
Title = job.Title,
Range = range,
Angle = job.Angle,
Path = job.Source,
HWDecode = hwDecode,
KeepDuplicateTitles = job.KeepDuplicateTitles
};
return source;
}
private Destination CreateDestination(EncodeTask job)
{
Destination destination = new Destination
{
File = job.Destination,
Options = new Options
{
IpodAtom = job.VideoEncoder.IsH264 ? job.IPod5GSupport : false,
Optimize = job.Optimize
},
ChapterMarkers = job.IncludeChapterMarkers,
AlignAVStart = job.AlignAVStart,
Mux = EnumHelper<OutputFormat>.GetShortName(job.OutputFormat),
ChapterList = new List<Chapter>()
};
if (job.IncludeChapterMarkers)
{
foreach (ChapterMarker item in job.ChapterNames)
{
Chapter chapter = new Chapter { Name = item.ChapterName };
destination.ChapterList.Add(chapter);
}
}
return destination;
}
private PAR CreatePAR(EncodeTask job)
{
return new PAR { Num = job.PixelAspectX, Den = job.PixelAspectY };
}
private Subtitle CreateSubtitle(EncodeTask job)
{
Subtitles subtitle = new Subtitles
{
Search =
new SubtitleSearch
{
Enable = false,
Default = false,
Burn = false,
Forced = false
},
SubtitleList = new List<HandBrake.Interop.Interop.Json.Encode.SubtitleTrack>()
};
foreach (SubtitleTrack item in job.SubtitleTracks)
{
if (!item.IsSrtSubtitle)
{
// Handle Foreign Audio Search
if (item.SourceTrack.TrackNumber == 0)
{
subtitle.Search.Enable = true;
subtitle.Search.Burn = item.Burned;
subtitle.Search.Default = item.Default;
subtitle.Search.Forced = item.Forced;
}
else
{
HandBrake.Interop.Interop.Json.Encode.SubtitleTrack track = new HandBrake.Interop.Interop.Json.Encode.SubtitleTrack
{
Burn = item.Burned,
Default = item.Default,
Forced = item.Forced,
ID = item.SourceTrack.TrackNumber,
Track = (item.SourceTrack.TrackNumber - 1),
Name = item.Name
};
subtitle.SubtitleList.Add(track);
}
}
else
{
HandBrake.Interop.Interop.Json.Encode.SubtitleTrack track = new HandBrake.Interop.Interop.Json.Encode.SubtitleTrack
{
Track = -1, // Indicates SRT
Default = item.Default,
Offset = item.SrtOffset,
Burn = item.Burned,
Name = item.Name,
Import =
new SubImport
{
Format = item.SrtPath.EndsWith("srt", StringComparison.InvariantCultureIgnoreCase) ? "SRT" : "SSA",
Filename = item.SrtPath,
Codeset = item.SrtCharCode,
Language = item.SrtLangCode
}
};
subtitle.SubtitleList.Add(track);
}
}
return subtitle;
}
private Video CreateVideo(EncodeTask job)
{
Video video = new Video();
if (job.VideoEncoder != null)
{
video.Encoder = job.VideoEncoder.ShortName;
}
video.Level = job.VideoLevel?.ShortName;
video.Preset = job.VideoPreset?.ShortName;
video.Profile = job.VideoProfile?.ShortName;
if (job.VideoTunes != null && job.VideoTunes.Count > 0)
{
foreach (var item in job.VideoTunes)
{
video.Tune += string.IsNullOrEmpty(video.Tune) ? item.ShortName : "," + item.ShortName;
}
}
if (job.VideoEncodeRateType == VideoEncodeRateType.ConstantQuality)
{
video.Quality = (decimal?)job.Quality;
}
if (job.VideoEncodeRateType == VideoEncodeRateType.AverageBitrate)
{
video.Bitrate = job.VideoBitrate;
}
video.MultiPass = job.MultiPass;
video.Turbo = job.TurboAnalysisPass;
video.Options = job.ExtraAdvancedArguments;
bool enableQuickSyncDecoding = userSettingService.GetUserSetting<bool>(UserSettingConstants.EnableQuickSyncDecoding);
bool useQSVDecodeForNonQSVEnc = userSettingService.GetUserSetting<bool>(UserSettingConstants.UseQSVDecodeForNonQSVEnc);
bool enableQsvLowPower = userSettingService.GetUserSetting<bool>(UserSettingConstants.EnableQuickSyncLowPower);
if (this.isEncodePath && (job.VideoEncoder?.IsQuickSync ?? false))
{
video.HardwareDecode = HandBrakeHardwareEncoderHelper.IsQsvAvailable && enableQuickSyncDecoding ?
NativeConstants.HB_DECODE_SUPPORT_QSV : 0 ;
}
// Allow use of the QSV decoder is configurable for non QSV encoders.
if (this.isEncodePath && job.VideoEncoder != null && !job.VideoEncoder.IsHardwareEncoder && useQSVDecodeForNonQSVEnc && enableQuickSyncDecoding)
{
video.HardwareDecode = HandBrakeHardwareEncoderHelper.IsQsvAvailable && useQSVDecodeForNonQSVEnc ?
NativeConstants.HB_DECODE_SUPPORT_QSV | NativeConstants.HB_DECODE_SUPPORT_FORCE_HW : 0;
}
if (this.isEncodePath && HandBrakeHardwareEncoderHelper.IsQsvAvailable && (HandBrakeHardwareEncoderHelper.QsvHardwareGeneration > 6) && (job.VideoEncoder?.IsQuickSync ?? false))
{
if (enableQsvLowPower && !video.Options.Contains("lowpower"))
{
video.Options = string.IsNullOrEmpty(video.Options) ? "lowpower=1" : string.Concat(video.Options, ":lowpower=1");
}
else if(!enableQsvLowPower && !video.Options.Contains("lowpower"))
{
video.Options = string.IsNullOrEmpty(video.Options) ? "lowpower=0" : string.Concat(video.Options, ":lowpower=0");
}
}
if (this.isEncodePath && HandBrakeHardwareEncoderHelper.IsNVDecAvailable && this.userSettingService.GetUserSetting<bool>(UserSettingConstants.EnableNvDecSupport) && job.VideoEncoder.IsNVEnc)
{
video.HardwareDecode = NativeConstants.HB_DECODE_SUPPORT_NVDEC;
}
if (HandBrakeHardwareEncoderHelper.IsDirectXAvailable && this.userSettingService.GetUserSetting<bool>(UserSettingConstants.EnableDirectXDecoding))
{
video.HardwareDecode = NativeConstants.HB_DECODE_SUPPORT_MF;
}
return video;
}
private Audio CreateAudio(EncodeTask job)
{
Audio audio = new Audio();
List<string> copyMaskList = new List<string>();
foreach (var item in job.AudioPassthruOptions)
{
copyMaskList.Add(item.ShortName);
}
audio.CopyMask = copyMaskList.ToArray();
audio.FallbackEncoder = job.AudioFallbackEncoder?.ShortName;
audio.AudioList = new List<HandBrake.Interop.Interop.Json.Encode.AudioTrack>();
foreach (AudioTrack item in job.AudioTracks)
{
if (item.IsPassthru && (item.ScannedTrack.Codec & item.Encoder.Id) == 0)
{
// We have an unsupported passthru. Rather than let libhb drop the track, switch it to the fallback.
item.Encoder = job.AudioFallbackEncoder;
}
HBMixdown mixdown = HandBrakeEncoderHelpers.GetMixdown(item.MixDown);
HBRate sampleRate = HandBrakeEncoderHelpers.AudioSampleRates.FirstOrDefault(s => s.Name == item.SampleRate.ToString(CultureInfo.InvariantCulture));
HandBrake.Interop.Interop.Json.Encode.AudioTrack audioTrack = new HandBrake.Interop.Interop.Json.Encode.AudioTrack
{
Track = (item.Track.HasValue ? item.Track.Value : 0) - 1,
DRC = item.DRC,
Encoder = item.Encoder?.ShortName,
Gain = item.Gain,
Mixdown = mixdown != null ? mixdown.Id : -1,
NormalizeMixLevel = false,
Samplerate = sampleRate != null ? sampleRate.Rate : 0,
Name = !string.IsNullOrEmpty(item.TrackName) ? item.TrackName : null,
};
if (!item.IsPassthru)
{
if (item.EncoderRateType == AudioEncoderRateType.Quality)
{
audioTrack.Quality = item.Quality;
}
if (item.EncoderRateType == AudioEncoderRateType.Bitrate)
{
audioTrack.Bitrate = item.Bitrate;
}
}
audio.AudioList.Add(audioTrack);
}
return audio;
}
private Filters CreateFilters(EncodeTask job)
{
Filters filter = new Filters
{
FilterList = new List<Filter>(),
};
// Note, order is important.
// Detelecine
if (job.Detelecine != Detelecine.Off)
{
string unparsedJson = HandBrakeFilterHelpers.GenerateFilterSettingJson((int)hb_filter_ids.HB_FILTER_DETELECINE, null, null, job.CustomDetelecine);
if (!string.IsNullOrEmpty(unparsedJson))
{
JsonDocument settings = JsonDocument.Parse(unparsedJson);
Filter filterItem = new Filter { ID = (int)hb_filter_ids.HB_FILTER_DETELECINE, Settings = settings };
filter.FilterList.Add(filterItem);
}
}
// Deinterlace
if (job.DeinterlaceFilter == DeinterlaceFilter.Yadif)
{
string unparsedJson = HandBrakeFilterHelpers.GenerateFilterSettingJson((int)hb_filter_ids.HB_FILTER_YADIF, job.DeinterlacePreset?.ShortName, null, job.CustomDeinterlaceSettings);
if (!string.IsNullOrEmpty(unparsedJson))
{
JsonDocument root = JsonDocument.Parse(unparsedJson);
Filter filterItem = new Filter { ID = (int)hb_filter_ids.HB_FILTER_YADIF, Settings = root };
filter.FilterList.Add(filterItem);
}
}
// Decomb
if (job.DeinterlaceFilter == DeinterlaceFilter.Decomb)
{
string unparsedJson = HandBrakeFilterHelpers.GenerateFilterSettingJson((int)hb_filter_ids.HB_FILTER_DECOMB, job.DeinterlacePreset?.ShortName, null, job.CustomDeinterlaceSettings);
if (!string.IsNullOrEmpty(unparsedJson))
{
JsonDocument settings = JsonDocument.Parse(unparsedJson);
Filter filterItem = new Filter { ID = (int)hb_filter_ids.HB_FILTER_DECOMB, Settings = settings };
filter.FilterList.Add(filterItem);
}
}
// Bwdif
if (job.DeinterlaceFilter == DeinterlaceFilter.Bwdif)
{
string unparsedJson = HandBrakeFilterHelpers.GenerateFilterSettingJson((int)hb_filter_ids.HB_FILTER_BWDIF, job.DeinterlacePreset?.ShortName, null, job.CustomDeinterlaceSettings);
if (!string.IsNullOrEmpty(unparsedJson))
{
JsonDocument settings = JsonDocument.Parse(unparsedJson);
Filter filterItem = new Filter { ID = (int)hb_filter_ids.HB_FILTER_BWDIF, Settings = settings };
filter.FilterList.Add(filterItem);
}
}
if (job.DeinterlaceFilter == DeinterlaceFilter.Decomb || job.DeinterlaceFilter == DeinterlaceFilter.Yadif || job.DeinterlaceFilter == DeinterlaceFilter.Bwdif)
{
if (job.CombDetect != CombDetect.Off)
{
string unparsedJson = HandBrakeFilterHelpers.GenerateFilterSettingJson((int)hb_filter_ids.HB_FILTER_COMB_DETECT, EnumHelper<CombDetect>.GetShortName(job.CombDetect), null, job.CustomCombDetect);
if (!string.IsNullOrEmpty(unparsedJson))
{
JsonDocument settings = JsonDocument.Parse(unparsedJson);
Filter filterItem = new Filter
{
ID = (int)hb_filter_ids.HB_FILTER_COMB_DETECT,
Settings = settings
};
filter.FilterList.Add(filterItem);
}
}
}
// Denoise
if (job.Denoise != Denoise.Off)
{
hb_filter_ids id = job.Denoise == Denoise.hqdn3d
? hb_filter_ids.HB_FILTER_HQDN3D
: hb_filter_ids.HB_FILTER_NLMEANS;
string unparsedJson = HandBrakeFilterHelpers.GenerateFilterSettingJson((int)id, job.DenoisePreset?.ShortName, job.DenoiseTune?.ShortName, job.CustomDenoise);
if (!string.IsNullOrEmpty(unparsedJson))
{
JsonDocument settings = JsonDocument.Parse(unparsedJson);
Filter filterItem = new Filter { ID = (int)id, Settings = settings };
filter.FilterList.Add(filterItem);
}
}
// Sharpen
if (job.Sharpen != Sharpen.Off)
{
hb_filter_ids id = job.Sharpen == Sharpen.LapSharp
? hb_filter_ids.HB_FILTER_LAPSHARP
: hb_filter_ids.HB_FILTER_UNSHARP;
string unparsedJson = HandBrakeFilterHelpers.GenerateFilterSettingJson((int)id, job.SharpenPreset.Key, job.SharpenTune.Key, job.SharpenCustom);
if (!string.IsNullOrEmpty(unparsedJson))
{
JsonDocument settings = JsonDocument.Parse(unparsedJson);
Filter filterItem = new Filter { ID = (int)id, Settings = settings };
filter.FilterList.Add(filterItem);
}
}
// Deblock
if (job.DeblockPreset != null && job.DeblockPreset.Key != "off")
{
string unparsedJson = HandBrakeFilterHelpers.GenerateFilterSettingJson((int)hb_filter_ids.HB_FILTER_DEBLOCK, job.DeblockPreset.Key, job.DeblockTune.Key, job.CustomDeblock);
if (!string.IsNullOrEmpty(unparsedJson))
{
JsonDocument settings = JsonDocument.Parse(unparsedJson);
Filter filterItem = new Filter { ID = (int)hb_filter_ids.HB_FILTER_DEBLOCK, Settings = settings };
filter.FilterList.Add(filterItem);
}
}
// CropScale Filter
string cropSettings = string.Format("width={0}:height={1}:crop-top={2}:crop-bottom={3}:crop-left={4}:crop-right={5}", job.Width, job.Height, job.Cropping.Top, job.Cropping.Bottom, job.Cropping.Left, job.Cropping.Right);
string unparsedCropSettingsJson = HandBrakeFilterHelpers.GenerateFilterSettingJson((int)hb_filter_ids.HB_FILTER_CROP_SCALE, null, null, cropSettings);
if (!string.IsNullOrEmpty(unparsedCropSettingsJson))
{
JsonDocument cropSettingsJson = JsonDocument.Parse(unparsedCropSettingsJson);
Filter cropScale = new Filter
{
ID = (int)hb_filter_ids.HB_FILTER_CROP_SCALE,
Settings = cropSettingsJson
};
filter.FilterList.Add(cropScale);
}
// Padding Filter
if (job.Padding.Mode != PaddingMode.None)
{
// Calculate the new Width / Height
int? width = job.Width;
int? height = job.Height;
width = width + job.Padding.W;
height = height + job.Padding.H;
// Setup the filter.
string padSettings = string.Format("width={0}:height={1}:color={2}:x={3}:y={4}", width, height, job.Padding.Color, job.Padding.X, job.Padding.Y);
string unparsedPadSettingsJson = HandBrakeFilterHelpers.GenerateFilterSettingJson((int)hb_filter_ids.HB_FILTER_PAD, null, null, padSettings);
if (!string.IsNullOrEmpty(unparsedPadSettingsJson))
{
JsonDocument PadSettingsJson = JsonDocument.Parse(unparsedPadSettingsJson);
Filter padding = new Filter
{
ID = (int)hb_filter_ids.HB_FILTER_PAD,
Settings = PadSettingsJson
};
filter.FilterList.Add(padding);
}
}
// Colourspace
if (job.Colourspace != null && job.Colourspace.Key != "off")
{
string unparsedJson = HandBrakeFilterHelpers.GenerateFilterSettingJson((int)hb_filter_ids.HB_FILTER_COLORSPACE, job.Colourspace.Key, null, job.CustomColourspace);
if (!string.IsNullOrEmpty(unparsedJson))
{
JsonDocument settings = JsonDocument.Parse(unparsedJson);
Filter filterItem = new Filter { ID = (int)hb_filter_ids.HB_FILTER_COLORSPACE, Settings = settings };
filter.FilterList.Add(filterItem);
}
}
if (job.ChromaSmooth != null && job.ChromaSmooth.Key != "off")
{
string unparsedJson = HandBrakeFilterHelpers.GenerateFilterSettingJson((int)hb_filter_ids.HB_FILTER_CHROMA_SMOOTH, job.ChromaSmooth.Key, job.ChromaSmoothTune?.Key, job.CustomChromaSmooth);
if (!string.IsNullOrEmpty(unparsedJson))
{
JsonDocument settings = JsonDocument.Parse(unparsedJson);
Filter filterItem = new Filter { ID = (int)hb_filter_ids.HB_FILTER_CHROMA_SMOOTH, Settings = settings };
filter.FilterList.Add(filterItem);
}
}
// Grayscale
if (job.Grayscale)
{
Filter filterItem = new Filter { ID = (int)hb_filter_ids.HB_FILTER_GRAYSCALE, Settings = null };
filter.FilterList.Add(filterItem);
}
// Rotate
if (job.Rotation != 0 || job.FlipVideo)
{
string rotateSettings = string.Format("angle={0}:hflip={1}", job.Rotation, job.FlipVideo ? "1" : "0");
string unparsedJson = HandBrakeFilterHelpers.GenerateFilterSettingJson((int)hb_filter_ids.HB_FILTER_ROTATE, null, null, rotateSettings);
if (!string.IsNullOrEmpty(unparsedJson))
{
JsonDocument settings = JsonDocument.Parse(unparsedJson);
Filter filterItem = new Filter { ID = (int)hb_filter_ids.HB_FILTER_ROTATE, Settings = settings };
filter.FilterList.Add(filterItem);
}
}
// Framerate shaping filter
int fm = job.FramerateMode == FramerateMode.CFR ? 1 : job.FramerateMode == FramerateMode.PFR ? 2 : 0;
int? num = null, den = null;
if (job.Framerate != null)
{
int vrate = HandBrakeUnitConversionHelpers.GetFramerateFromName(job.Framerate.Value.ToString(CultureInfo.InvariantCulture));
if (vrate > 0)
{
num = 27000000;
den = vrate;
}
}
string framerateString = num.HasValue ? string.Format("mode={0}:rate={1}/{2}", fm, num, den) : string.Format("mode={0}", fm); // filter_cfr, filter_vrate.num, filter_vrate.den
string unparsedFramerateJson = HandBrakeFilterHelpers.GenerateFilterSettingJson((int)hb_filter_ids.HB_FILTER_VFR, null, null, framerateString);
if (!string.IsNullOrEmpty(unparsedFramerateJson))
{
JsonDocument framerateSettings = JsonDocument.Parse(unparsedFramerateJson);
Filter framerateShaper = new Filter
{
ID = (int)hb_filter_ids.HB_FILTER_VFR,
Settings = framerateSettings
};
filter.FilterList.Add(framerateShaper);
}
return filter;
}
private Dictionary<string, string> CreateMetadata(EncodeTask job)
{
if (job.MetaData != null && job.PassthruMetadataEnabled)
{
Dictionary<string, string> metadata = new Dictionary<string, string>();
foreach (var item in job.MetaData)
{
if (item.Enabled)
{
metadata.Add(item.Annotation, item.Value);
}
}
return metadata;
}
return new Dictionary<string, string>(); // Empty Metadata will not pass through to the destination.
}
}
}