Migrate subtitle upload to Jellyfin.Api

Jellyfin.Api/Controllers/SubtitleController.cs

@@ -11,6 +11,7 @@ using System.Threading;
 using System.Threading.Tasks;
 using Jellyfin.Api.Attributes;
 using Jellyfin.Api.Constants;
+using Jellyfin.Api.Models.SubtitleDtos;
 using MediaBrowser.Controller.Entities;
 using MediaBrowser.Controller.Library;
 using MediaBrowser.Controller.MediaEncoding;
@@ -317,6 +318,33 @@ namespace Jellyfin.Api.Controllers
             return File(Encoding.UTF8.GetBytes(builder.ToString()), MimeTypes.GetMimeType("playlist.m3u8"));
         }
 
+        /// <summary>
+        /// Upload an external subtitle file.
+        /// </summary>
+        /// <param name="itemId">The item the subtitle belongs to.</param>
+        /// <param name="body">The request body.</param>
+        /// <response code="204">Subtitle uploaded.</response>
+        /// <returns>A <see cref="NoContentResult"/>.</returns>
+        [HttpPost("Videos/{itemId}/Subtitles")]
+        public async Task<ActionResult> UploadSubtitle(
+            [FromRoute, Required] Guid itemId,
+            [FromBody, Required] UploadSubtitleDto body)
+        {
+            var video = (Video)_libraryManager.GetItemById(itemId);
+            var data = Convert.FromBase64String(body.Data);
+            await using var memoryStream = new MemoryStream(data);
+            await _subtitleManager.UploadSubtitle(
+                video,
+                new SubtitleResponse
+                {
+                    Format = body.Format,
+                    Language = body.Language,
+                    IsForced = body.IsForced,
+                    Stream = memoryStream
+                }).ConfigureAwait(false);
+            return NoContent();
+        }
+
         /// <summary>
         /// Encodes a subtitle in the specified format.
         /// </summary>

Jellyfin.Api/Models/SubtitleDtos/UploadSubtitleDto.cs

@@ -0,0 +1,34 @@
+using System.ComponentModel.DataAnnotations;
+
+namespace Jellyfin.Api.Models.SubtitleDtos
+{
+    /// <summary>
+    /// Upload subtitles dto.
+    /// </summary>
+    public class UploadSubtitleDto
+    {
+        /// <summary>
+        /// Gets or sets the subtitle language.
+        /// </summary>
+        [Required]
+        public string Language { get; set; } = string.Empty;
+
+        /// <summary>
+        /// Gets or sets the subtitle format.
+        /// </summary>
+        [Required]
+        public string Format { get; set; } = string.Empty;
+
+        /// <summary>
+        /// Gets or sets a value indicating whether the subtitle is forced.
+        /// </summary>
+        [Required]
+        public bool IsForced { get; set; }
+
+        /// <summary>
+        /// Gets or sets the subtitle data.
+        /// </summary>
+        [Required]
+        public string Data { get; set; } = string.Empty;
+    }
+}

MediaBrowser.Api/Subtitles/SubtitleService.cs

@@ -1,355 +0,0 @@
-using System;
-using System.Collections.Generic;
-using System.Globalization;
-using System.IO;
-using System.Linq;
-using System.Text;
-using System.Threading;
-using System.Threading.Tasks;
-using MediaBrowser.Controller.Configuration;
-using MediaBrowser.Controller.Entities;
-using MediaBrowser.Controller.Library;
-using MediaBrowser.Controller.MediaEncoding;
-using MediaBrowser.Controller.Net;
-using MediaBrowser.Controller.Providers;
-using MediaBrowser.Controller.Subtitles;
-using MediaBrowser.Model.Entities;
-using MediaBrowser.Model.IO;
-using MediaBrowser.Model.Providers;
-using MediaBrowser.Model.Services;
-using Microsoft.Extensions.Logging;
-using MimeTypes = MediaBrowser.Model.Net.MimeTypes;
-
-namespace MediaBrowser.Api.Subtitles
-{
-    [Route("/Videos/{Id}/Subtitles/{Index}", "DELETE", Summary = "Deletes an external subtitle file")]
-    [Authenticated(Roles = "Admin")]
-    public class DeleteSubtitle
-    {
-        /// <summary>
-        /// Gets or sets the id.
-        /// </summary>
-        /// <value>The id.</value>
-        [ApiMember(Name = "Id", Description = "Item Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "DELETE")]
-        public Guid Id { get; set; }
-
-        [ApiMember(Name = "Index", Description = "The subtitle stream index", IsRequired = true, DataType = "int", ParameterType = "path", Verb = "DELETE")]
-        public int Index { get; set; }
-    }
-
-    [Route("/Videos/{Id}/Subtitles", "POST", Summary = "Upload an external subtitle file")]
-    [Authenticated(Roles = "admin")]
-    public class PostSubtitle : IReturnVoid
-    {
-        /// <summary>
-        /// Gets or sets the id.
-        /// </summary>
-        /// <value>The id.</value>
-        [ApiMember(Name = "Id", Description = "Item Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "POST")]
-        public string Id { get; set; }
-
-        [ApiMember(Name = "Language", Description = "Language", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "POST")]
-        public string Language { get; set; }
-
-        [ApiMember(Name = "Format", Description = "Format", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "POST")]
-        public string Format { get; set; }
-
-        [ApiMember(Name = "IsForced", Description = "IsForced", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "POST")]
-        public string IsForced { get; set; }
-
-        [ApiMember(Name = "Data", Description = "Data", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "POST")]
-        public string Data { get; set; }
-
-    }
-
-    [Route("/Items/{Id}/RemoteSearch/Subtitles/{Language}", "GET")]
-    [Authenticated]
-    public class SearchRemoteSubtitles : IReturn<RemoteSubtitleInfo[]>
-    {
-        [ApiMember(Name = "Id", Description = "Item Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
-        public Guid Id { get; set; }
-
-        [ApiMember(Name = "Language", Description = "Language", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
-        public string Language { get; set; }
-
-        public bool? IsPerfectMatch { get; set; }
-    }
-
-    [Route("/Items/{Id}/RemoteSearch/Subtitles/{SubtitleId}", "POST")]
-    [Authenticated]
-    public class DownloadRemoteSubtitles : IReturnVoid
-    {
-        [ApiMember(Name = "Id", Description = "Item Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "POST")]
-        public Guid Id { get; set; }
-
-        [ApiMember(Name = "SubtitleId", Description = "SubtitleId", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "POST")]
-        public string SubtitleId { get; set; }
-    }
-
-    [Route("/Providers/Subtitles/Subtitles/{Id}", "GET")]
-    [Authenticated]
-    public class GetRemoteSubtitles : IReturnVoid
-    {
-        [ApiMember(Name = "Id", Description = "Item Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
-        public string Id { get; set; }
-    }
-
-    [Route("/Videos/{Id}/{MediaSourceId}/Subtitles/{Index}/Stream.{Format}", "GET", Summary = "Gets subtitles in a specified format.")]
-    [Route("/Videos/{Id}/{MediaSourceId}/Subtitles/{Index}/{StartPositionTicks}/Stream.{Format}", "GET", Summary = "Gets subtitles in a specified format.")]
-    public class GetSubtitle
-    {
-        /// <summary>
-        /// Gets or sets the id.
-        /// </summary>
-        /// <value>The id.</value>
-        [ApiMember(Name = "Id", Description = "Item Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
-        public Guid Id { get; set; }
-
-        [ApiMember(Name = "MediaSourceId", Description = "MediaSourceId", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
-        public string MediaSourceId { get; set; }
-
-        [ApiMember(Name = "Index", Description = "The subtitle stream index", IsRequired = true, DataType = "int", ParameterType = "path", Verb = "GET")]
-        public int Index { get; set; }
-
-        [ApiMember(Name = "Format", Description = "Format", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
-        public string Format { get; set; }
-
-        [ApiMember(Name = "StartPositionTicks", Description = "StartPositionTicks", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
-        public long StartPositionTicks { get; set; }
-
-        [ApiMember(Name = "EndPositionTicks", Description = "EndPositionTicks", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
-        public long? EndPositionTicks { get; set; }
-
-        [ApiMember(Name = "CopyTimestamps", Description = "CopyTimestamps", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
-        public bool CopyTimestamps { get; set; }
-        public bool AddVttTimeMap { get; set; }
-    }
-
-    [Route("/Videos/{Id}/{MediaSourceId}/Subtitles/{Index}/subtitles.m3u8", "GET", Summary = "Gets an HLS subtitle playlist.")]
-    [Authenticated]
-    public class GetSubtitlePlaylist
-    {
-        /// <summary>
-        /// Gets or sets the id.
-        /// </summary>
-        /// <value>The id.</value>
-        [ApiMember(Name = "Id", Description = "Item Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
-        public string Id { get; set; }
-
-        [ApiMember(Name = "MediaSourceId", Description = "MediaSourceId", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
-        public string MediaSourceId { get; set; }
-
-        [ApiMember(Name = "Index", Description = "The subtitle stream index", IsRequired = true, DataType = "int", ParameterType = "path", Verb = "GET")]
-        public int Index { get; set; }
-
-        [ApiMember(Name = "SegmentLength", Description = "The subtitle srgment length", IsRequired = true, DataType = "int", ParameterType = "query", Verb = "GET")]
-        public int SegmentLength { get; set; }
-    }
-
-    public class SubtitleService : BaseApiService
-    {
-        private readonly ILibraryManager _libraryManager;
-        private readonly ISubtitleManager _subtitleManager;
-        private readonly ISubtitleEncoder _subtitleEncoder;
-        private readonly IMediaSourceManager _mediaSourceManager;
-        private readonly IProviderManager _providerManager;
-        private readonly IFileSystem _fileSystem;
-        private readonly IAuthorizationContext _authContext;
-
-        public SubtitleService(
-            ILogger<SubtitleService> logger,
-            IServerConfigurationManager serverConfigurationManager,
-            IHttpResultFactory httpResultFactory,
-            ILibraryManager libraryManager,
-            ISubtitleManager subtitleManager,
-            ISubtitleEncoder subtitleEncoder,
-            IMediaSourceManager mediaSourceManager,
-            IProviderManager providerManager,
-            IFileSystem fileSystem,
-            IAuthorizationContext authContext)
-            : base(logger, serverConfigurationManager, httpResultFactory)
-        {
-            _libraryManager = libraryManager;
-            _subtitleManager = subtitleManager;
-            _subtitleEncoder = subtitleEncoder;
-            _mediaSourceManager = mediaSourceManager;
-            _providerManager = providerManager;
-            _fileSystem = fileSystem;
-            _authContext = authContext;
-        }
-
-        public async Task<object> Get(GetSubtitlePlaylist request)
-        {
-            var item = (Video)_libraryManager.GetItemById(new Guid(request.Id));
-
-            var mediaSource = await _mediaSourceManager.GetMediaSource(item, request.MediaSourceId, null, false, CancellationToken.None).ConfigureAwait(false);
-
-            var builder = new StringBuilder();
-
-            var runtime = mediaSource.RunTimeTicks ?? -1;
-
-            if (runtime <= 0)
-            {
-                throw new ArgumentException("HLS Subtitles are not supported for this media.");
-            }
-
-            var segmentLengthTicks = TimeSpan.FromSeconds(request.SegmentLength).Ticks;
-            if (segmentLengthTicks <= 0)
-            {
-                throw new ArgumentException("segmentLength was not given, or it was given incorrectly. (It should be bigger than 0)");
-            }
-
-            builder.AppendLine("#EXTM3U");
-            builder.AppendLine("#EXT-X-TARGETDURATION:" + request.SegmentLength.ToString(CultureInfo.InvariantCulture));
-            builder.AppendLine("#EXT-X-VERSION:3");
-            builder.AppendLine("#EXT-X-MEDIA-SEQUENCE:0");
-            builder.AppendLine("#EXT-X-PLAYLIST-TYPE:VOD");
-
-            long positionTicks = 0;
-
-            var accessToken = _authContext.GetAuthorizationInfo(Request).Token;
-
-            while (positionTicks < runtime)
-            {
-                var remaining = runtime - positionTicks;
-                var lengthTicks = Math.Min(remaining, segmentLengthTicks);
-
-                builder.AppendLine("#EXTINF:" + TimeSpan.FromTicks(lengthTicks).TotalSeconds.ToString(CultureInfo.InvariantCulture) + ",");
-
-                var endPositionTicks = Math.Min(runtime, positionTicks + segmentLengthTicks);
-
-                var url = string.Format("stream.vtt?CopyTimestamps=true&AddVttTimeMap=true&StartPositionTicks={0}&EndPositionTicks={1}&api_key={2}",
-                    positionTicks.ToString(CultureInfo.InvariantCulture),
-                    endPositionTicks.ToString(CultureInfo.InvariantCulture),
-                    accessToken);
-
-                builder.AppendLine(url);
-
-                positionTicks += segmentLengthTicks;
-            }
-
-            builder.AppendLine("#EXT-X-ENDLIST");
-
-            return ResultFactory.GetResult(Request, builder.ToString(), MimeTypes.GetMimeType("playlist.m3u8"), new Dictionary<string, string>());
-        }
-
-        public async Task<object> Get(GetSubtitle request)
-        {
-            if (string.Equals(request.Format, "js", StringComparison.OrdinalIgnoreCase))
-            {
-                request.Format = "json";
-            }
-            if (string.IsNullOrEmpty(request.Format))
-            {
-                var item = (Video)_libraryManager.GetItemById(request.Id);
-
-                var idString = request.Id.ToString("N", CultureInfo.InvariantCulture);
-                var mediaSource = _mediaSourceManager.GetStaticMediaSources(item, false, null)
-                    .First(i => string.Equals(i.Id, request.MediaSourceId ?? idString));
-
-                var subtitleStream = mediaSource.MediaStreams
-                    .First(i => i.Type == MediaStreamType.Subtitle && i.Index == request.Index);
-
-                return await ResultFactory.GetStaticFileResult(Request, subtitleStream.Path).ConfigureAwait(false);
-            }
-
-            if (string.Equals(request.Format, "vtt", StringComparison.OrdinalIgnoreCase) && request.AddVttTimeMap)
-            {
-                using var stream = await GetSubtitles(request).ConfigureAwait(false);
-                using var reader = new StreamReader(stream);
-
-                var text = reader.ReadToEnd();
-
-                text = text.Replace("WEBVTT", "WEBVTT\nX-TIMESTAMP-MAP=MPEGTS:900000,LOCAL:00:00:00.000");
-
-                return ResultFactory.GetResult(Request, text, MimeTypes.GetMimeType("file." + request.Format));
-            }
-
-            return ResultFactory.GetResult(Request, await GetSubtitles(request).ConfigureAwait(false), MimeTypes.GetMimeType("file." + request.Format));
-        }
-
-        private Task<Stream> GetSubtitles(GetSubtitle request)
-        {
-            var item = _libraryManager.GetItemById(request.Id);
-
-            return _subtitleEncoder.GetSubtitles(item,
-                request.MediaSourceId,
-                request.Index,
-                request.Format,
-                request.StartPositionTicks,
-                request.EndPositionTicks ?? 0,
-                request.CopyTimestamps,
-                CancellationToken.None);
-        }
-
-        public async Task<object> Get(SearchRemoteSubtitles request)
-        {
-            var video = (Video)_libraryManager.GetItemById(request.Id);
-
-            return await _subtitleManager.SearchSubtitles(video, request.Language, request.IsPerfectMatch, CancellationToken.None).ConfigureAwait(false);
-        }
-
-        public Task Delete(DeleteSubtitle request)
-        {
-            var item = _libraryManager.GetItemById(request.Id);
-            return _subtitleManager.DeleteSubtitles(item, request.Index);
-        }
-
-        public void Post(PostSubtitle request)
-        {
-            var video = (Video)_libraryManager.GetItemById(request.Id);
-
-            var bytes = Convert.FromBase64String(request.Data);
-            var memoryStream = new MemoryStream(bytes)
-            {
-                Position = 0
-            };
-
-            Task.Run(async () =>
-            {
-                try
-                {
-                    await _subtitleManager.UploadSubtitle(video, new SubtitleResponse {
-                        Format = request.Format,
-                        Language = request.Language,
-                        IsForced = Convert.ToBoolean(request.IsForced),
-                        Stream = memoryStream
-                    }).ConfigureAwait(false);
-
-                    _providerManager.QueueRefresh(video.Id, new MetadataRefreshOptions(new DirectoryService(_fileSystem)), RefreshPriority.High);
-                }
-                catch (Exception ex)
-                {
-                    Logger.LogError(ex, "Error uploading subtitle");
-                }
-            });
-        }
-
-        public async Task<object> Get(GetRemoteSubtitles request)
-        {
-            var result = await _subtitleManager.GetRemoteSubtitles(request.Id, CancellationToken.None).ConfigureAwait(false);
-
-            return ResultFactory.GetResult(Request, result.Stream, MimeTypes.GetMimeType("file." + result.Format));
-        }
-
-        public void Post(DownloadRemoteSubtitles request)
-        {
-            var video = (Video)_libraryManager.GetItemById(request.Id);
-
-            Task.Run(async () =>
-            {
-                try
-                {
-                    await _subtitleManager.DownloadSubtitles(video, request.SubtitleId, CancellationToken.None)
-                        .ConfigureAwait(false);
-
-                    _providerManager.QueueRefresh(video.Id, new MetadataRefreshOptions(new DirectoryService(_fileSystem)), RefreshPriority.High);
-                }
-                catch (Exception ex)
-                {
-                    Logger.LogError(ex, "Error downloading subtitles");
-                }
-            });
-        }
-    }
-}