using System; using System.Collections.Generic; using System.IO; using System.Linq; using System.Threading; using System.Threading.Tasks; using MediaBrowser.Api.Playback; using MediaBrowser.Common.Configuration; using MediaBrowser.Controller.Configuration; using MediaBrowser.Controller.Library; using MediaBrowser.Controller.MediaEncoding; using MediaBrowser.Controller.Net; using MediaBrowser.Controller.Plugins; using MediaBrowser.Controller.Session; using MediaBrowser.Model.Configuration; using MediaBrowser.Model.Diagnostics; using MediaBrowser.Model.Dto; using MediaBrowser.Model.IO; using MediaBrowser.Model.Session; using MediaBrowser.Model.Threading; using Microsoft.Extensions.Logging; namespace MediaBrowser.Api { /// /// Class ServerEntryPoint /// public class ApiEntryPoint : IServerEntryPoint { /// /// The instance /// public static ApiEntryPoint Instance; /// /// Gets or sets the logger. /// /// The logger. internal ILogger Logger { get; private set; } internal IHttpResultFactory ResultFactory { get; private set; } /// /// The application paths /// private readonly IServerConfigurationManager _config; private readonly ISessionManager _sessionManager; private readonly IFileSystem _fileSystem; private readonly IMediaSourceManager _mediaSourceManager; public readonly ITimerFactory TimerFactory; public readonly IProcessFactory ProcessFactory; /// /// The active transcoding jobs /// private readonly List _activeTranscodingJobs = new List(); private readonly Dictionary _transcodingLocks = new Dictionary(); /// /// Initializes a new instance of the class. /// /// The logger. /// The session manager. /// The configuration. /// The file system. /// The media source manager. public ApiEntryPoint(ILogger logger, ISessionManager sessionManager, IServerConfigurationManager config, IFileSystem fileSystem, IMediaSourceManager mediaSourceManager, ITimerFactory timerFactory, IProcessFactory processFactory, IHttpResultFactory resultFactory) { Logger = logger; _sessionManager = sessionManager; _config = config; _fileSystem = fileSystem; _mediaSourceManager = mediaSourceManager; TimerFactory = timerFactory; ProcessFactory = processFactory; ResultFactory = resultFactory; Instance = this; _sessionManager.PlaybackProgress += _sessionManager_PlaybackProgress; _sessionManager.PlaybackStart += _sessionManager_PlaybackStart; } public static string[] Split(string value, char separator, bool removeEmpty) { if (string.IsNullOrWhiteSpace(value)) { return Array.Empty(); } if (removeEmpty) { return value.Split(new[] { separator }, StringSplitOptions.RemoveEmptyEntries); } return value.Split(separator); } public SemaphoreSlim GetTranscodingLock(string outputPath) { lock (_transcodingLocks) { if (!_transcodingLocks.TryGetValue(outputPath, out SemaphoreSlim result)) { result = new SemaphoreSlim(1, 1); _transcodingLocks[outputPath] = result; } return result; } } private void _sessionManager_PlaybackStart(object sender, PlaybackProgressEventArgs e) { if (!string.IsNullOrWhiteSpace(e.PlaySessionId)) { PingTranscodingJob(e.PlaySessionId, e.IsPaused); } } void _sessionManager_PlaybackProgress(object sender, PlaybackProgressEventArgs e) { if (!string.IsNullOrWhiteSpace(e.PlaySessionId)) { PingTranscodingJob(e.PlaySessionId, e.IsPaused); } } /// /// Runs this instance. /// public void Run() { try { DeleteEncodedMediaCache(); } catch (FileNotFoundException) { // Don't clutter the log } catch (IOException) { // Don't clutter the log } catch (Exception ex) { Logger.LogError(ex, "Error deleting encoded media cache"); } } public EncodingOptions GetEncodingOptions() { return ConfigurationManagerExtensions.GetConfiguration(_config, "encoding"); } /// /// Deletes the encoded media cache. /// private void DeleteEncodedMediaCache() { var path = _config.ApplicationPaths.TranscodingTempPath; foreach (var file in _fileSystem.GetFilePaths(path, true) .ToList()) { _fileSystem.DeleteFile(file); } } /// /// Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. /// public void Dispose() { Dispose(true); GC.SuppressFinalize(this); } /// /// Releases unmanaged and - optionally - managed resources. /// /// true to release both managed and unmanaged resources; false to release only unmanaged resources. protected virtual void Dispose(bool dispose) { var list = _activeTranscodingJobs.ToList(); var jobCount = list.Count; Parallel.ForEach(list, j => KillTranscodingJob(j, false, path => true)); // Try to allow for some time to kill the ffmpeg processes and delete the partial stream files if (jobCount > 0) { var task = Task.Delay(1000); Task.WaitAll(task); } } /// /// Called when [transcode beginning]. /// /// The path. /// The play session identifier. /// The live stream identifier. /// The transcoding job identifier. /// The type. /// The process. /// The device id. /// The state. /// The cancellation token source. /// TranscodingJob. public TranscodingJob OnTranscodeBeginning(string path, string playSessionId, string liveStreamId, string transcodingJobId, TranscodingJobType type, IProcess process, string deviceId, StreamState state, CancellationTokenSource cancellationTokenSource) { lock (_activeTranscodingJobs) { var job = new TranscodingJob(Logger, TimerFactory) { Type = type, Path = path, Process = process, ActiveRequestCount = 1, DeviceId = deviceId, CancellationTokenSource = cancellationTokenSource, Id = transcodingJobId, PlaySessionId = playSessionId, LiveStreamId = liveStreamId, MediaSource = state.MediaSource }; _activeTranscodingJobs.Add(job); ReportTranscodingProgress(job, state, null, null, null, null, null); return job; } } public void ReportTranscodingProgress(TranscodingJob job, StreamState state, TimeSpan? transcodingPosition, float? framerate, double? percentComplete, long? bytesTranscoded, int? bitRate) { var ticks = transcodingPosition.HasValue ? transcodingPosition.Value.Ticks : (long?)null; if (job != null) { job.Framerate = framerate; job.CompletionPercentage = percentComplete; job.TranscodingPositionTicks = ticks; job.BytesTranscoded = bytesTranscoded; job.BitRate = bitRate; } var deviceId = state.Request.DeviceId; if (!string.IsNullOrWhiteSpace(deviceId)) { var audioCodec = state.ActualOutputAudioCodec; var videoCodec = state.ActualOutputVideoCodec; _sessionManager.ReportTranscodingInfo(deviceId, new TranscodingInfo { Bitrate = bitRate ?? state.TotalOutputBitrate, AudioCodec = audioCodec, VideoCodec = videoCodec, Container = state.OutputContainer, Framerate = framerate, CompletionPercentage = percentComplete, Width = state.OutputWidth, Height = state.OutputHeight, AudioChannels = state.OutputAudioChannels, IsAudioDirect = string.Equals(state.OutputAudioCodec, "copy", StringComparison.OrdinalIgnoreCase), IsVideoDirect = string.Equals(state.OutputVideoCodec, "copy", StringComparison.OrdinalIgnoreCase), TranscodeReasons = state.TranscodeReasons }); } } /// /// /// The progressive /// /// Called when [transcode failed to start]. /// /// The path. /// The type. /// The state. public void OnTranscodeFailedToStart(string path, TranscodingJobType type, StreamState state) { lock (_activeTranscodingJobs) { var job = _activeTranscodingJobs.FirstOrDefault(j => j.Type == type && string.Equals(j.Path, path, StringComparison.OrdinalIgnoreCase)); if (job != null) { _activeTranscodingJobs.Remove(job); } } lock (_transcodingLocks) { _transcodingLocks.Remove(path); } if (!string.IsNullOrWhiteSpace(state.Request.DeviceId)) { _sessionManager.ClearTranscodingInfo(state.Request.DeviceId); } } /// /// Determines whether [has active transcoding job] [the specified path]. /// /// The path. /// The type. /// true if [has active transcoding job] [the specified path]; otherwise, false. public bool HasActiveTranscodingJob(string path, TranscodingJobType type) { return GetTranscodingJob(path, type) != null; } public TranscodingJob GetTranscodingJob(string path, TranscodingJobType type) { lock (_activeTranscodingJobs) { return _activeTranscodingJobs.FirstOrDefault(j => j.Type == type && string.Equals(j.Path, path, StringComparison.OrdinalIgnoreCase)); } } public TranscodingJob GetTranscodingJob(string playSessionId) { lock (_activeTranscodingJobs) { return _activeTranscodingJobs.FirstOrDefault(j => string.Equals(j.PlaySessionId, playSessionId, StringComparison.OrdinalIgnoreCase)); } } /// /// Called when [transcode begin request]. /// /// The path. /// The type. public TranscodingJob OnTranscodeBeginRequest(string path, TranscodingJobType type) { lock (_activeTranscodingJobs) { var job = _activeTranscodingJobs.FirstOrDefault(j => j.Type == type && string.Equals(j.Path, path, StringComparison.OrdinalIgnoreCase)); if (job == null) { return null; } OnTranscodeBeginRequest(job); return job; } } public void OnTranscodeBeginRequest(TranscodingJob job) { job.ActiveRequestCount++; if (string.IsNullOrWhiteSpace(job.PlaySessionId) || job.Type == TranscodingJobType.Progressive) { job.StopKillTimer(); } } public void OnTranscodeEndRequest(TranscodingJob job) { job.ActiveRequestCount--; //Logger.LogDebug("OnTranscodeEndRequest job.ActiveRequestCount={0}", job.ActiveRequestCount); if (job.ActiveRequestCount <= 0) { PingTimer(job, false); } } internal void PingTranscodingJob(string playSessionId, bool? isUserPaused) { if (string.IsNullOrEmpty(playSessionId)) { throw new ArgumentNullException(nameof(playSessionId)); } //Logger.LogDebug("PingTranscodingJob PlaySessionId={0} isUsedPaused: {1}", playSessionId, isUserPaused); List jobs; lock (_activeTranscodingJobs) { // This is really only needed for HLS. // Progressive streams can stop on their own reliably jobs = _activeTranscodingJobs.Where(j => string.Equals(playSessionId, j.PlaySessionId, StringComparison.OrdinalIgnoreCase)).ToList(); } foreach (var job in jobs) { if (isUserPaused.HasValue) { //Logger.LogDebug("Setting job.IsUserPaused to {0}. jobId: {1}", isUserPaused, job.Id); job.IsUserPaused = isUserPaused.Value; } PingTimer(job, true); } } private void PingTimer(TranscodingJob job, bool isProgressCheckIn) { if (job.HasExited) { job.StopKillTimer(); return; } var timerDuration = 10000; if (job.Type != TranscodingJobType.Progressive) { timerDuration = 60000; } job.PingTimeout = timerDuration; job.LastPingDate = DateTime.UtcNow; // Don't start the timer for playback checkins with progressive streaming if (job.Type != TranscodingJobType.Progressive || !isProgressCheckIn) { job.StartKillTimer(OnTranscodeKillTimerStopped); } else { job.ChangeKillTimerIfStarted(); } } /// /// Called when [transcode kill timer stopped]. /// /// The state. private void OnTranscodeKillTimerStopped(object state) { var job = (TranscodingJob)state; if (!job.HasExited && job.Type != TranscodingJobType.Progressive) { var timeSinceLastPing = (DateTime.UtcNow - job.LastPingDate).TotalMilliseconds; if (timeSinceLastPing < job.PingTimeout) { job.StartKillTimer(OnTranscodeKillTimerStopped, job.PingTimeout); return; } } Logger.LogInformation("Transcoding kill timer stopped for JobId {0} PlaySessionId {1}. Killing transcoding", job.Id, job.PlaySessionId); KillTranscodingJob(job, true, path => true); } /// /// Kills the single transcoding job. /// /// The device id. /// The play session identifier. /// The delete files. /// Task. internal void KillTranscodingJobs(string deviceId, string playSessionId, Func deleteFiles) { KillTranscodingJobs(j => { if (!string.IsNullOrWhiteSpace(playSessionId)) { return string.Equals(playSessionId, j.PlaySessionId, StringComparison.OrdinalIgnoreCase); } return string.Equals(deviceId, j.DeviceId, StringComparison.OrdinalIgnoreCase); }, deleteFiles); } /// /// Kills the transcoding jobs. /// /// The kill job. /// The delete files. /// Task. private void KillTranscodingJobs(Func killJob, Func deleteFiles) { var jobs = new List(); lock (_activeTranscodingJobs) { // This is really only needed for HLS. // Progressive streams can stop on their own reliably jobs.AddRange(_activeTranscodingJobs.Where(killJob)); } if (jobs.Count == 0) { return; } foreach (var job in jobs) { KillTranscodingJob(job, false, deleteFiles); } } /// /// Kills the transcoding job. /// /// The job. /// if set to true [close live stream]. /// The delete. private async void KillTranscodingJob(TranscodingJob job, bool closeLiveStream, Func delete) { job.DisposeKillTimer(); Logger.LogDebug("KillTranscodingJob - JobId {0} PlaySessionId {1}. Killing transcoding", job.Id, job.PlaySessionId); lock (_activeTranscodingJobs) { _activeTranscodingJobs.Remove(job); if (!job.CancellationTokenSource.IsCancellationRequested) { job.CancellationTokenSource.Cancel(); } } lock (_transcodingLocks) { _transcodingLocks.Remove(job.Path); } lock (job.ProcessLock) { if (job.TranscodingThrottler != null) { job.TranscodingThrottler.Stop(); } var process = job.Process; var hasExited = job.HasExited; if (!hasExited) { try { Logger.LogInformation("Stopping ffmpeg process with q command for {path}", job.Path); //process.Kill(); process.StandardInput.WriteLine("q"); // Need to wait because killing is asynchronous if (!process.WaitForExit(5000)) { Logger.LogInformation("Killing ffmpeg process for {path}", job.Path); process.Kill(); } } catch (Exception ex) { Logger.LogError(ex, "Error killing transcoding job for {path}", job.Path); } } } if (delete(job.Path)) { DeletePartialStreamFiles(job.Path, job.Type, 0, 1500); } if (closeLiveStream && !string.IsNullOrWhiteSpace(job.LiveStreamId)) { try { await _mediaSourceManager.CloseLiveStream(job.LiveStreamId).ConfigureAwait(false); } catch (Exception ex) { Logger.LogError(ex, "Error closing live stream for {path}", job.Path); } } } private async void DeletePartialStreamFiles(string path, TranscodingJobType jobType, int retryCount, int delayMs) { if (retryCount >= 10) { return; } Logger.LogInformation("Deleting partial stream file(s) {0}", path); await Task.Delay(delayMs).ConfigureAwait(false); try { if (jobType == TranscodingJobType.Progressive) { DeleteProgressivePartialStreamFiles(path); } else { DeleteHlsPartialStreamFiles(path); } } catch (FileNotFoundException) { } catch (IOException ex) { Logger.LogError(ex, "Error deleting partial stream file(s) {path}", path); DeletePartialStreamFiles(path, jobType, retryCount + 1, 500); } catch (Exception ex) { Logger.LogError(ex, "Error deleting partial stream file(s) {path}", path); } } /// /// Deletes the progressive partial stream files. /// /// The output file path. private void DeleteProgressivePartialStreamFiles(string outputFilePath) { _fileSystem.DeleteFile(outputFilePath); } /// /// Deletes the HLS partial stream files. /// /// The output file path. private void DeleteHlsPartialStreamFiles(string outputFilePath) { var directory = _fileSystem.GetDirectoryName(outputFilePath); var name = Path.GetFileNameWithoutExtension(outputFilePath); var filesToDelete = _fileSystem.GetFilePaths(directory) .Where(f => f.IndexOf(name, StringComparison.OrdinalIgnoreCase) != -1) .ToList(); Exception e = null; foreach (var file in filesToDelete) { try { //Logger.LogDebug("Deleting HLS file {0}", file); _fileSystem.DeleteFile(file); } catch (FileNotFoundException) { } catch (IOException ex) { e = ex; Logger.LogError(ex, "Error deleting HLS file {path}", file); } } if (e != null) { throw e; } } } /// /// Class TranscodingJob /// public class TranscodingJob { /// /// Gets or sets the play session identifier. /// /// The play session identifier. public string PlaySessionId { get; set; } /// /// Gets or sets the live stream identifier. /// /// The live stream identifier. public string LiveStreamId { get; set; } public bool IsLiveOutput { get; set; } /// /// Gets or sets the path. /// /// The path. public MediaSourceInfo MediaSource { get; set; } public string Path { get; set; } /// /// Gets or sets the type. /// /// The type. public TranscodingJobType Type { get; set; } /// /// Gets or sets the process. /// /// The process. public IProcess Process { get; set; } public ILogger Logger { get; private set; } /// /// Gets or sets the active request count. /// /// The active request count. public int ActiveRequestCount { get; set; } /// /// Gets or sets the kill timer. /// /// The kill timer. private ITimer KillTimer { get; set; } private readonly ITimerFactory _timerFactory; public string DeviceId { get; set; } public CancellationTokenSource CancellationTokenSource { get; set; } public object ProcessLock = new object(); public bool HasExited { get; set; } public bool IsUserPaused { get; set; } public string Id { get; set; } public float? Framerate { get; set; } public double? CompletionPercentage { get; set; } public long? BytesDownloaded { get; set; } public long? BytesTranscoded { get; set; } public int? BitRate { get; set; } public long? TranscodingPositionTicks { get; set; } public long? DownloadPositionTicks { get; set; } public TranscodingThrottler TranscodingThrottler { get; set; } private readonly object _timerLock = new object(); public DateTime LastPingDate { get; set; } public int PingTimeout { get; set; } public TranscodingJob(ILogger logger, ITimerFactory timerFactory) { Logger = logger; _timerFactory = timerFactory; } public void StopKillTimer() { lock (_timerLock) { if (KillTimer != null) { KillTimer.Change(Timeout.Infinite, Timeout.Infinite); } } } public void DisposeKillTimer() { lock (_timerLock) { if (KillTimer != null) { KillTimer.Dispose(); KillTimer = null; } } } public void StartKillTimer(Action callback) { StartKillTimer(callback, PingTimeout); } public void StartKillTimer(Action callback, int intervalMs) { if (HasExited) { return; } lock (_timerLock) { if (KillTimer == null) { //Logger.LogDebug("Starting kill timer at {0}ms. JobId {1} PlaySessionId {2}", intervalMs, Id, PlaySessionId); KillTimer = _timerFactory.Create(callback, this, intervalMs, Timeout.Infinite); } else { //Logger.LogDebug("Changing kill timer to {0}ms. JobId {1} PlaySessionId {2}", intervalMs, Id, PlaySessionId); KillTimer.Change(intervalMs, Timeout.Infinite); } } } public void ChangeKillTimerIfStarted() { if (HasExited) { return; } lock (_timerLock) { if (KillTimer != null) { var intervalMs = PingTimeout; //Logger.LogDebug("Changing kill timer to {0}ms. JobId {1} PlaySessionId {2}", intervalMs, Id, PlaySessionId); KillTimer.Change(intervalMs, Timeout.Infinite); } } } } }