Add ITranscodeManager service

4 files changed, 359 insertions, 0 deletions

diff --git a/MediaBrowser.Controller/MediaEncoding/ITranscodeManager.cs b/MediaBrowser.Controller/MediaEncoding/ITranscodeManager.cs
new file mode 100644
index 000000000..c19a12ae7
--- /dev/null
+++ b/MediaBrowser.Controller/MediaEncoding/ITranscodeManager.cs
@@ -0,0 +1,104 @@
+using System;
+using System.Threading;
+using System.Threading.Tasks;
+using MediaBrowser.Controller.Streaming;
+
+namespace MediaBrowser.Controller.MediaEncoding;
+
+/// <summary>
+/// A service for managing media transcoding.
+/// </summary>
+public interface ITranscodeManager
+{
+    /// <summary>
+    /// Get transcoding job.
+    /// </summary>
+    /// <param name="playSessionId">Playback session id.</param>
+    /// <returns>The transcoding job.</returns>
+    public TranscodingJob? GetTranscodingJob(string playSessionId);
+
+    /// <summary>
+    /// Get transcoding job.
+    /// </summary>
+    /// <param name="path">Path to the transcoding file.</param>
+    /// <param name="type">The <see cref="TranscodingJobType"/>.</param>
+    /// <returns>The transcoding job.</returns>
+    public TranscodingJob? GetTranscodingJob(string path, TranscodingJobType type);
+
+    /// <summary>
+    /// Ping transcoding job.
+    /// </summary>
+    /// <param name="playSessionId">Play session id.</param>
+    /// <param name="isUserPaused">Is user paused.</param>
+    /// <exception cref="ArgumentNullException">Play session id is null.</exception>
+    public void PingTranscodingJob(string playSessionId, bool? isUserPaused);
+
+    /// <summary>
+    /// Kills the single transcoding job.
+    /// </summary>
+    /// <param name="deviceId">The device id.</param>
+    /// <param name="playSessionId">The play session identifier.</param>
+    /// <param name="deleteFiles">The delete files.</param>
+    /// <returns>Task.</returns>
+    public Task KillTranscodingJobs(string deviceId, string? playSessionId, Func<string, bool> deleteFiles);
+
+    /// <summary>
+    /// Report the transcoding progress to the session manager.
+    /// </summary>
+    /// <param name="job">The <see cref="TranscodingJob"/> of which the progress will be reported.</param>
+    /// <param name="state">The <see cref="StreamState"/> of the current transcoding job.</param>
+    /// <param name="transcodingPosition">The current transcoding position.</param>
+    /// <param name="framerate">The framerate of the transcoding job.</param>
+    /// <param name="percentComplete">The completion percentage of the transcode.</param>
+    /// <param name="bytesTranscoded">The number of bytes transcoded.</param>
+    /// <param name="bitRate">The bitrate of the transcoding job.</param>
+    public void ReportTranscodingProgress(
+        TranscodingJob job,
+        StreamState state,
+        TimeSpan? transcodingPosition,
+        float? framerate,
+        double? percentComplete,
+        long? bytesTranscoded,
+        int? bitRate);
+
+    /// <summary>
+    /// Starts FFMpeg.
+    /// </summary>
+    /// <param name="state">The state.</param>
+    /// <param name="outputPath">The output path.</param>
+    /// <param name="commandLineArguments">The command line arguments for FFmpeg.</param>
+    /// <param name="userId">The user id.</param>
+    /// <param name="transcodingJobType">The <see cref="TranscodingJobType"/>.</param>
+    /// <param name="cancellationTokenSource">The cancellation token source.</param>
+    /// <param name="workingDirectory">The working directory.</param>
+    /// <returns>Task.</returns>
+    public Task<TranscodingJob> StartFfMpeg(
+        StreamState state,
+        string outputPath,
+        string commandLineArguments,
+        Guid userId,
+        TranscodingJobType transcodingJobType,
+        CancellationTokenSource cancellationTokenSource,
+        string? workingDirectory = null);
+
+    /// <summary>
+    /// Called when [transcode begin request].
+    /// </summary>
+    /// <param name="path">The path.</param>
+    /// <param name="type">The type.</param>
+    /// <returns>The <see cref="TranscodingJob"/>.</returns>
+    public TranscodingJob? OnTranscodeBeginRequest(string path, TranscodingJobType type);
+
+    /// <summary>
+    /// Called when [transcode end].
+    /// </summary>
+    /// <param name="job">The transcode job.</param>
+    public void OnTranscodeEndRequest(TranscodingJob job);
+
+    /// <summary>
+    /// Gets the transcoding lock.
+    /// </summary>
+    /// <param name="outputPath">The output path of the transcoded file.</param>
+    /// <returns>A <see cref="SemaphoreSlim"/>.</returns>
+    public SemaphoreSlim GetTranscodingLock(string outputPath);
+}
diff --git a/MediaBrowser.Controller/Streaming/StreamState.cs b/MediaBrowser.Controller/Streaming/StreamState.cs
new file mode 100644
index 000000000..b5dbe29ec
--- /dev/null
+++ b/MediaBrowser.Controller/Streaming/StreamState.cs
@@ -0,0 +1,183 @@
+using System;
+using MediaBrowser.Controller.Library;
+using MediaBrowser.Controller.MediaEncoding;
+using MediaBrowser.Model.Dlna;
+
+namespace MediaBrowser.Controller.Streaming;
+
+/// <summary>
+/// The stream state dto.
+/// </summary>
+public class StreamState : EncodingJobInfo, IDisposable
+{
+    private readonly IMediaSourceManager _mediaSourceManager;
+    private readonly ITranscodeManager _transcodeManager;
+    private bool _disposed;
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="StreamState" /> class.
+    /// </summary>
+    /// <param name="mediaSourceManager">Instance of the <see cref="IMediaSourceManager" /> interface.</param>
+    /// <param name="transcodingType">The <see cref="TranscodingJobType" />.</param>
+    /// <param name="transcodeManager">The <see cref="ITranscodeManager" /> singleton.</param>
+    public StreamState(IMediaSourceManager mediaSourceManager, TranscodingJobType transcodingType, ITranscodeManager transcodeManager)
+        : base(transcodingType)
+    {
+        _mediaSourceManager = mediaSourceManager;
+        _transcodeManager = transcodeManager;
+    }
+
+    /// <summary>
+    /// Gets or sets the requested url.
+    /// </summary>
+    public string? RequestedUrl { get; set; }
+
+    /// <summary>
+    /// Gets or sets the request.
+    /// </summary>
+    public StreamingRequestDto Request
+    {
+        get => (StreamingRequestDto)BaseRequest;
+        set
+        {
+            BaseRequest = value;
+            IsVideoRequest = VideoRequest is not null;
+        }
+    }
+
+    /// <summary>
+    /// Gets the video request.
+    /// </summary>
+    public VideoRequestDto? VideoRequest => Request as VideoRequestDto;
+
+    /// <summary>
+    /// Gets or sets the direct stream provicer.
+    /// </summary>
+    /// <remarks>
+    /// Deprecated.
+    /// </remarks>
+    public IDirectStreamProvider? DirectStreamProvider { get; set; }
+
+    /// <summary>
+    /// Gets or sets the path to wait for.
+    /// </summary>
+    public string? WaitForPath { get; set; }
+
+    /// <summary>
+    /// Gets a value indicating whether the request outputs video.
+    /// </summary>
+    public bool IsOutputVideo => Request is VideoRequestDto;
+
+    /// <summary>
+    /// Gets the segment length.
+    /// </summary>
+    public int SegmentLength
+    {
+        get
+        {
+            if (Request.SegmentLength.HasValue)
+            {
+                return Request.SegmentLength.Value;
+            }
+
+            if (EncodingHelper.IsCopyCodec(OutputVideoCodec))
+            {
+                var userAgent = UserAgent ?? string.Empty;
+
+                if (userAgent.Contains("AppleTV", StringComparison.OrdinalIgnoreCase)
+                    || userAgent.Contains("cfnetwork", StringComparison.OrdinalIgnoreCase)
+                    || userAgent.Contains("ipad", StringComparison.OrdinalIgnoreCase)
+                    || userAgent.Contains("iphone", StringComparison.OrdinalIgnoreCase)
+                    || userAgent.Contains("ipod", StringComparison.OrdinalIgnoreCase))
+                {
+                    return 6;
+                }
+
+                if (IsSegmentedLiveStream)
+                {
+                    return 3;
+                }
+
+                return 6;
+            }
+
+            return 3;
+        }
+    }
+
+    /// <summary>
+    /// Gets the minimum number of segments.
+    /// </summary>
+    public int MinSegments
+    {
+        get
+        {
+            if (Request.MinSegments.HasValue)
+            {
+                return Request.MinSegments.Value;
+            }
+
+            return SegmentLength >= 10 ? 2 : 3;
+        }
+    }
+
+    /// <summary>
+    /// Gets or sets the user agent.
+    /// </summary>
+    public string? UserAgent { get; set; }
+
+    /// <summary>
+    /// Gets or sets a value indicating whether to estimate the content length.
+    /// </summary>
+    public bool EstimateContentLength { get; set; }
+
+    /// <summary>
+    /// Gets or sets the transcode seek info.
+    /// </summary>
+    public TranscodeSeekInfo TranscodeSeekInfo { get; set; }
+
+    /// <summary>
+    /// Gets or sets the transcoding job.
+    /// </summary>
+    public TranscodingJob? TranscodingJob { get; set; }
+
+    /// <inheritdoc />
+    public void Dispose()
+    {
+        Dispose(true);
+        GC.SuppressFinalize(this);
+    }
+
+    /// <inheritdoc />
+    public override void ReportTranscodingProgress(TimeSpan? transcodingPosition, float? framerate, double? percentComplete, long? bytesTranscoded, int? bitRate)
+    {
+        _transcodeManager.ReportTranscodingProgress(TranscodingJob!, this, transcodingPosition, framerate, percentComplete, bytesTranscoded, bitRate);
+    }
+
+    /// <summary>
+    /// Disposes the stream state.
+    /// </summary>
+    /// <param name="disposing">Whether the object is currently being disposed.</param>
+    protected virtual void Dispose(bool disposing)
+    {
+        if (_disposed)
+        {
+            return;
+        }
+
+        if (disposing)
+        {
+            // REVIEW: Is this the right place for this?
+            if (MediaSource.RequiresClosing
+                && string.IsNullOrWhiteSpace(Request.LiveStreamId)
+                && !string.IsNullOrWhiteSpace(MediaSource.LiveStreamId))
+            {
+                _mediaSourceManager.CloseLiveStream(MediaSource.LiveStreamId).GetAwaiter().GetResult();
+            }
+        }
+
+        TranscodingJob = null;
+
+        _disposed = true;
+    }
+}
diff --git a/MediaBrowser.Controller/Streaming/StreamingRequestDto.cs b/MediaBrowser.Controller/Streaming/StreamingRequestDto.cs
new file mode 100644
index 000000000..e47ef65f0
--- /dev/null
+++ b/MediaBrowser.Controller/Streaming/StreamingRequestDto.cs
@@ -0,0 +1,49 @@
+using MediaBrowser.Controller.MediaEncoding;
+
+namespace MediaBrowser.Controller.Streaming;
+
+/// <summary>
+/// The audio streaming request dto.
+/// </summary>
+public class StreamingRequestDto : BaseEncodingJobOptions
+{
+    /// <summary>
+    /// Gets or sets the params.
+    /// </summary>
+    public string? Params { get; set; }
+
+    /// <summary>
+    /// Gets or sets the play session id.
+    /// </summary>
+    public string? PlaySessionId { get; set; }
+
+    /// <summary>
+    /// Gets or sets the tag.
+    /// </summary>
+    public string? Tag { get; set; }
+
+    /// <summary>
+    /// Gets or sets the segment container.
+    /// </summary>
+    public string? SegmentContainer { get; set; }
+
+    /// <summary>
+    /// Gets or sets the segment length.
+    /// </summary>
+    public int? SegmentLength { get; set; }
+
+    /// <summary>
+    /// Gets or sets the min segments.
+    /// </summary>
+    public int? MinSegments { get; set; }
+
+    /// <summary>
+    /// Gets or sets the position of the requested segment in ticks.
+    /// </summary>
+    public long CurrentRuntimeTicks { get; set; }
+
+    /// <summary>
+    /// Gets or sets the actual segment length in ticks.
+    /// </summary>
+    public long ActualSegmentLengthTicks { get; set; }
+}
diff --git a/MediaBrowser.Controller/Streaming/VideoRequestDto.cs b/MediaBrowser.Controller/Streaming/VideoRequestDto.cs
new file mode 100644
index 000000000..44dc831fd
--- /dev/null
+++ b/MediaBrowser.Controller/Streaming/VideoRequestDto.cs
@@ -0,0 +1,23 @@
+namespace MediaBrowser.Controller.Streaming;
+
+/// <summary>
+/// The video request dto.
+/// </summary>
+public class VideoRequestDto : StreamingRequestDto
+{
+    /// <summary>
+    /// Gets a value indicating whether this instance has fixed resolution.
+    /// </summary>
+    /// <value><c>true</c> if this instance has fixed resolution; otherwise, <c>false</c>.</value>
+    public bool HasFixedResolution => Width.HasValue || Height.HasValue;
+
+    /// <summary>
+    /// Gets or sets a value indicating whether to enable subtitles in the manifest.
+    /// </summary>
+    public bool EnableSubtitlesInManifest { get; set; }
+
+    /// <summary>
+    /// Gets or sets a value indicating whether to enable trickplay images.
+    /// </summary>
+    public bool EnableTrickplay { get; set; }
+}