diff options
Diffstat (limited to 'src/Jellyfin.MediaEncoding.Hls/Playlist/DynamicHlsPlaylistGenerator.cs')
| -rw-r--r-- | src/Jellyfin.MediaEncoding.Hls/Playlist/DynamicHlsPlaylistGenerator.cs | 347 |
1 files changed, 139 insertions, 208 deletions
diff --git a/src/Jellyfin.MediaEncoding.Hls/Playlist/DynamicHlsPlaylistGenerator.cs b/src/Jellyfin.MediaEncoding.Hls/Playlist/DynamicHlsPlaylistGenerator.cs index cbc62eb59..5cdacaf31 100644 --- a/src/Jellyfin.MediaEncoding.Hls/Playlist/DynamicHlsPlaylistGenerator.cs +++ b/src/Jellyfin.MediaEncoding.Hls/Playlist/DynamicHlsPlaylistGenerator.cs @@ -5,269 +5,200 @@ using System.Globalization; using System.IO; using System.Linq; using System.Text; -using System.Text.Json; -using Jellyfin.Extensions.Json; +using Jellyfin.MediaEncoding.Hls.Extractors; using Jellyfin.MediaEncoding.Keyframes; using MediaBrowser.Common.Configuration; -using MediaBrowser.Common.Extensions; using MediaBrowser.Controller.Configuration; using MediaBrowser.Controller.MediaEncoding; -using Microsoft.Extensions.Logging; -namespace Jellyfin.MediaEncoding.Hls.Playlist +namespace Jellyfin.MediaEncoding.Hls.Playlist; + +/// <inheritdoc /> +public class DynamicHlsPlaylistGenerator : IDynamicHlsPlaylistGenerator { - /// <inheritdoc /> - public class DynamicHlsPlaylistGenerator : IDynamicHlsPlaylistGenerator + private readonly IServerConfigurationManager _serverConfigurationManager; + private readonly IKeyframeExtractor[] _extractors; + + /// <summary> + /// Initializes a new instance of the <see cref="DynamicHlsPlaylistGenerator"/> class. + /// </summary> + /// <param name="serverConfigurationManager">An instance of the see <see cref="IServerConfigurationManager"/> interface.</param> + /// <param name="extractors">An instance of <see cref="IEnumerable{IKeyframeExtractor}"/>.</param> + public DynamicHlsPlaylistGenerator(IServerConfigurationManager serverConfigurationManager, IEnumerable<IKeyframeExtractor> extractors) { - private const string DefaultContainerExtension = ".ts"; - - private readonly JsonSerializerOptions _jsonOptions = JsonDefaults.Options; - private readonly IServerConfigurationManager _serverConfigurationManager; - private readonly IMediaEncoder _mediaEncoder; - private readonly IApplicationPaths _applicationPaths; - private readonly KeyframeExtractor _keyframeExtractor; - private readonly ILogger<DynamicHlsPlaylistGenerator> _logger; + _serverConfigurationManager = serverConfigurationManager; + _extractors = extractors.Where(e => e.IsMetadataBased).ToArray(); + } - /// <summary> - /// Initializes a new instance of the <see cref="DynamicHlsPlaylistGenerator"/> class. - /// </summary> - /// <param name="serverConfigurationManager">An instance of the see <see cref="IServerConfigurationManager"/> interface.</param> - /// <param name="mediaEncoder">An instance of the see <see cref="IMediaEncoder"/> interface.</param> - /// <param name="applicationPaths">An instance of the <see cref="IApplicationPaths"/> interface.</param> - /// <param name="loggerFactory">An instance of the see <see cref="ILoggerFactory"/> interface.</param> - public DynamicHlsPlaylistGenerator(IServerConfigurationManager serverConfigurationManager, IMediaEncoder mediaEncoder, IApplicationPaths applicationPaths, ILoggerFactory loggerFactory) + /// <inheritdoc /> + public string CreateMainPlaylist(CreateMainPlaylistRequest request) + { + IReadOnlyList<double> segments; + if (TryExtractKeyframes(request.FilePath, out var keyframeData)) { - _serverConfigurationManager = serverConfigurationManager; - _mediaEncoder = mediaEncoder; - _applicationPaths = applicationPaths; - _keyframeExtractor = new KeyframeExtractor(loggerFactory.CreateLogger<KeyframeExtractor>()); - _logger = loggerFactory.CreateLogger<DynamicHlsPlaylistGenerator>(); + segments = ComputeSegments(keyframeData, request.DesiredSegmentLengthMs); } - - private string KeyframeCachePath => Path.Combine(_applicationPaths.DataPath, "keyframes"); - - /// <inheritdoc /> - public string CreateMainPlaylist(CreateMainPlaylistRequest request) + else { - IReadOnlyList<double> segments; - if (TryExtractKeyframes(request.FilePath, out var keyframeData)) - { - segments = ComputeSegments(keyframeData, request.DesiredSegmentLengthMs); - } - else - { - segments = ComputeEqualLengthSegments(request.DesiredSegmentLengthMs, request.TotalRuntimeTicks); - } - - var segmentExtension = GetSegmentFileExtension(request.SegmentContainer); - - // http://ffmpeg.org/ffmpeg-all.html#toc-hls-2 - var isHlsInFmp4 = string.Equals(segmentExtension, "mp4", StringComparison.OrdinalIgnoreCase); - var hlsVersion = isHlsInFmp4 ? "7" : "3"; - - var builder = new StringBuilder(128); - - builder.AppendLine("#EXTM3U") - .AppendLine("#EXT-X-PLAYLIST-TYPE:VOD") - .Append("#EXT-X-VERSION:") - .Append(hlsVersion) - .AppendLine() - .Append("#EXT-X-TARGETDURATION:") - .Append(Math.Ceiling(segments.Count > 0 ? segments.Max() : request.DesiredSegmentLengthMs)) - .AppendLine() - .AppendLine("#EXT-X-MEDIA-SEQUENCE:0"); - - var index = 0; + segments = ComputeEqualLengthSegments(request.DesiredSegmentLengthMs, request.TotalRuntimeTicks); + } - if (isHlsInFmp4) - { - builder.Append("#EXT-X-MAP:URI=\"") - .Append(request.EndpointPrefix) - .Append("-1") - .Append(segmentExtension) - .Append(request.QueryString) - .Append('"') - .AppendLine(); - } + var segmentExtension = EncodingHelper.GetSegmentFileExtension(request.SegmentContainer); - long currentRuntimeInSeconds = 0; - foreach (var length in segments) - { - // Manually convert to ticks to avoid precision loss when converting double - var lengthTicks = Convert.ToInt64(length * TimeSpan.TicksPerSecond); - builder.Append("#EXTINF:") - .Append(length.ToString("0.000000", CultureInfo.InvariantCulture)) - .AppendLine(", nodesc") - .Append(request.EndpointPrefix) - .Append(index++) - .Append(segmentExtension) - .Append(request.QueryString) - .Append("&runtimeTicks=") - .Append(currentRuntimeInSeconds) - .Append("&actualSegmentLengthTicks=") - .Append(lengthTicks) - .AppendLine(); + // http://ffmpeg.org/ffmpeg-all.html#toc-hls-2 + var isHlsInFmp4 = string.Equals(segmentExtension, "mp4", StringComparison.OrdinalIgnoreCase); + var hlsVersion = isHlsInFmp4 ? "7" : "3"; - currentRuntimeInSeconds += lengthTicks; - } + var builder = new StringBuilder(128); - builder.AppendLine("#EXT-X-ENDLIST"); + builder.AppendLine("#EXTM3U") + .AppendLine("#EXT-X-PLAYLIST-TYPE:VOD") + .Append("#EXT-X-VERSION:") + .Append(hlsVersion) + .AppendLine() + .Append("#EXT-X-TARGETDURATION:") + .Append(Math.Ceiling(segments.Count > 0 ? segments.Max() : request.DesiredSegmentLengthMs)) + .AppendLine() + .AppendLine("#EXT-X-MEDIA-SEQUENCE:0"); - return builder.ToString(); - } + var index = 0; - private bool TryExtractKeyframes(string filePath, [NotNullWhen(true)] out KeyframeData? keyframeData) + if (isHlsInFmp4) { - keyframeData = null; - if (!IsExtractionAllowedForFile(filePath, _serverConfigurationManager.GetEncodingOptions().AllowAutomaticKeyframeExtractionForExtensions)) - { - return false; - } - - var succeeded = false; - var cachePath = GetCachePath(filePath); - if (TryReadFromCache(cachePath, out var cachedResult)) - { - keyframeData = cachedResult; - } - else - { - try - { - keyframeData = _keyframeExtractor.GetKeyframeData(filePath, _mediaEncoder.ProbePath, string.Empty); - } - catch (Exception ex) - { - _logger.LogError(ex, "Keyframe extraction failed for path {FilePath}", filePath); - return false; - } - - succeeded = keyframeData.KeyframeTicks.Count > 0; - if (succeeded) - { - CacheResult(cachePath, keyframeData); - } - } - - return succeeded; + builder.Append("#EXT-X-MAP:URI=\"") + .Append(request.EndpointPrefix) + .Append("-1") + .Append(segmentExtension) + .Append(request.QueryString) + .Append('"') + .AppendLine(); } - private void CacheResult(string cachePath, KeyframeData keyframeData) + long currentRuntimeInSeconds = 0; + foreach (var length in segments) { - var json = JsonSerializer.Serialize(keyframeData, _jsonOptions); - Directory.CreateDirectory(Path.GetDirectoryName(cachePath) ?? throw new ArgumentException($"Provided path ({cachePath}) is not valid.", nameof(cachePath))); - File.WriteAllText(cachePath, json); + // Manually convert to ticks to avoid precision loss when converting double + var lengthTicks = Convert.ToInt64(length * TimeSpan.TicksPerSecond); + builder.Append("#EXTINF:") + .Append(length.ToString("0.000000", CultureInfo.InvariantCulture)) + .AppendLine(", nodesc") + .Append(request.EndpointPrefix) + .Append(index++) + .Append(segmentExtension) + .Append(request.QueryString) + .Append("&runtimeTicks=") + .Append(currentRuntimeInSeconds) + .Append("&actualSegmentLengthTicks=") + .Append(lengthTicks) + .AppendLine(); + + currentRuntimeInSeconds += lengthTicks; } - private string GetCachePath(string filePath) - { - var lastWriteTimeUtc = File.GetLastWriteTimeUtc(filePath); - ReadOnlySpan<char> filename = (filePath + "_" + lastWriteTimeUtc.Ticks.ToString(CultureInfo.InvariantCulture)).GetMD5() + ".json"; - var prefix = filename.Slice(0, 1); + builder.AppendLine("#EXT-X-ENDLIST"); - return Path.Join(KeyframeCachePath, prefix, filename); - } + return builder.ToString(); + } - private bool TryReadFromCache(string cachePath, [NotNullWhen(true)] out KeyframeData? cachedResult) + private bool TryExtractKeyframes(string filePath, [NotNullWhen(true)] out KeyframeData? keyframeData) + { + keyframeData = null; + if (!IsExtractionAllowedForFile(filePath, _serverConfigurationManager.GetEncodingOptions().AllowOnDemandMetadataBasedKeyframeExtractionForExtensions)) { - if (File.Exists(cachePath)) - { - var bytes = File.ReadAllBytes(cachePath); - cachedResult = JsonSerializer.Deserialize<KeyframeData>(bytes, _jsonOptions); - return cachedResult != null; - } - - cachedResult = null; return false; } - internal static bool IsExtractionAllowedForFile(ReadOnlySpan<char> filePath, string[] allowedExtensions) + var len = _extractors.Length; + for (var i = 0; i < len; i++) { - var extension = Path.GetExtension(filePath); - if (extension.IsEmpty) + var extractor = _extractors[i]; + if (!extractor.TryExtractKeyframes(filePath, out var result)) { - return false; + continue; } - // Remove the leading dot - var extensionWithoutDot = extension[1..]; - for (var i = 0; i < allowedExtensions.Length; i++) - { - var allowedExtension = allowedExtensions[i]; - if (extensionWithoutDot.Equals(allowedExtension, StringComparison.OrdinalIgnoreCase)) - { - return true; - } - } + keyframeData = result; + return true; + } + return false; + } + + internal static bool IsExtractionAllowedForFile(ReadOnlySpan<char> filePath, string[] allowedExtensions) + { + var extension = Path.GetExtension(filePath); + if (extension.IsEmpty) + { return false; } - internal static IReadOnlyList<double> ComputeSegments(KeyframeData keyframeData, int desiredSegmentLengthMs) + // Remove the leading dot + var extensionWithoutDot = extension[1..]; + for (var i = 0; i < allowedExtensions.Length; i++) { - if (keyframeData.KeyframeTicks.Count > 0 && keyframeData.TotalDuration < keyframeData.KeyframeTicks[^1]) + var allowedExtension = allowedExtensions[i].AsSpan().TrimStart('.'); + if (extensionWithoutDot.Equals(allowedExtension, StringComparison.OrdinalIgnoreCase)) { - throw new ArgumentException("Invalid duration in keyframe data", nameof(keyframeData)); + return true; } + } - long lastKeyframe = 0; - var result = new List<double>(); - // Scale the segment length to ticks to match the keyframes - var desiredSegmentLengthTicks = TimeSpan.FromMilliseconds(desiredSegmentLengthMs).Ticks; - var desiredCutTime = desiredSegmentLengthTicks; - for (var j = 0; j < keyframeData.KeyframeTicks.Count; j++) - { - var keyframe = keyframeData.KeyframeTicks[j]; - if (keyframe >= desiredCutTime) - { - var currentSegmentLength = keyframe - lastKeyframe; - result.Add(TimeSpan.FromTicks(currentSegmentLength).TotalSeconds); - lastKeyframe = keyframe; - desiredCutTime += desiredSegmentLengthTicks; - } - } + return false; + } - result.Add(TimeSpan.FromTicks(keyframeData.TotalDuration - lastKeyframe).TotalSeconds); - return result; + internal static IReadOnlyList<double> ComputeSegments(KeyframeData keyframeData, int desiredSegmentLengthMs) + { + if (keyframeData.KeyframeTicks.Count > 0 && keyframeData.TotalDuration < keyframeData.KeyframeTicks[^1]) + { + throw new ArgumentException("Invalid duration in keyframe data", nameof(keyframeData)); } - internal static double[] ComputeEqualLengthSegments(int desiredSegmentLengthMs, long totalRuntimeTicks) + long lastKeyframe = 0; + var result = new List<double>(); + // Scale the segment length to ticks to match the keyframes + var desiredSegmentLengthTicks = TimeSpan.FromMilliseconds(desiredSegmentLengthMs).Ticks; + var desiredCutTime = desiredSegmentLengthTicks; + for (var j = 0; j < keyframeData.KeyframeTicks.Count; j++) { - if (desiredSegmentLengthMs == 0 || totalRuntimeTicks == 0) + var keyframe = keyframeData.KeyframeTicks[j]; + if (keyframe >= desiredCutTime) { - throw new InvalidOperationException($"Invalid segment length ({desiredSegmentLengthMs}) or runtime ticks ({totalRuntimeTicks})"); + var currentSegmentLength = keyframe - lastKeyframe; + result.Add(TimeSpan.FromTicks(currentSegmentLength).TotalSeconds); + lastKeyframe = keyframe; + desiredCutTime += desiredSegmentLengthTicks; } + } - var desiredSegmentLength = TimeSpan.FromMilliseconds(desiredSegmentLengthMs); + result.Add(TimeSpan.FromTicks(keyframeData.TotalDuration - lastKeyframe).TotalSeconds); + return result; + } - var segmentLengthTicks = desiredSegmentLength.Ticks; - var wholeSegments = totalRuntimeTicks / segmentLengthTicks; - var remainingTicks = totalRuntimeTicks % segmentLengthTicks; + internal static double[] ComputeEqualLengthSegments(int desiredSegmentLengthMs, long totalRuntimeTicks) + { + if (desiredSegmentLengthMs == 0 || totalRuntimeTicks == 0) + { + throw new InvalidOperationException($"Invalid segment length ({desiredSegmentLengthMs}) or runtime ticks ({totalRuntimeTicks})"); + } - var segmentsLen = wholeSegments + (remainingTicks == 0 ? 0 : 1); - var segments = new double[segmentsLen]; - for (int i = 0; i < wholeSegments; i++) - { - segments[i] = desiredSegmentLength.TotalSeconds; - } + var desiredSegmentLength = TimeSpan.FromMilliseconds(desiredSegmentLengthMs); - if (remainingTicks != 0) - { - segments[^1] = TimeSpan.FromTicks(remainingTicks).TotalSeconds; - } + var segmentLengthTicks = desiredSegmentLength.Ticks; + var wholeSegments = totalRuntimeTicks / segmentLengthTicks; + var remainingTicks = totalRuntimeTicks % segmentLengthTicks; - return segments; + var segmentsLen = wholeSegments + (remainingTicks == 0 ? 0 : 1); + var segments = new double[segmentsLen]; + for (int i = 0; i < wholeSegments; i++) + { + segments[i] = desiredSegmentLength.TotalSeconds; } - // TODO copied from DynamicHlsController - private static string GetSegmentFileExtension(string segmentContainer) + if (remainingTicks != 0) { - if (!string.IsNullOrWhiteSpace(segmentContainer)) - { - return "." + segmentContainer; - } - - return DefaultContainerExtension; + segments[^1] = TimeSpan.FromTicks(remainingTicks).TotalSeconds; } + + return segments; } } |