disable ffmpeg reports on windows (#220)

* disable ffmpeg reports for windows

* code cleanup

.config/dotnet-tools.json

@@ -3,7 +3,7 @@
   "isRoot": true,
   "tools": {
     "jetbrains.resharper.globaltools": {
-      "version": "2020.3.2",
+      "version": "2021.1.3",
       "commands": [
         "jb"
       ]

ErsatzTV.Application/FFmpegProfiles/Commands/UpdateFFmpegSettingsHandler.cs

@@ -1,11 +1,13 @@
 using System.Diagnostics;
 using System.IO;
+using System.Runtime.InteropServices;
 using System.Threading;
 using System.Threading.Tasks;
 using ErsatzTV.Core;
 using ErsatzTV.Core.Domain;
 using ErsatzTV.Core.Interfaces.Metadata;
 using ErsatzTV.Core.Interfaces.Repositories;
+using ErsatzTV.Core.Interfaces.Runtime;
 using LanguageExt;
 
 namespace ErsatzTV.Application.FFmpegProfiles.Commands
@@ -14,13 +16,16 @@ namespace ErsatzTV.Application.FFmpegProfiles.Commands
     {
         private readonly IConfigElementRepository _configElementRepository;
         private readonly ILocalFileSystem _localFileSystem;
+        private readonly IRuntimeInfo _runtimeInfo;
 
         public UpdateFFmpegSettingsHandler(
             IConfigElementRepository configElementRepository,
-            ILocalFileSystem localFileSystem)
+            ILocalFileSystem localFileSystem,
+            IRuntimeInfo runtimeInfo)
         {
             _configElementRepository = configElementRepository;
             _localFileSystem = localFileSystem;
+            _runtimeInfo = runtimeInfo;
         }
 
         public Task<Either<BaseError, Unit>> Handle(
@@ -31,8 +36,8 @@ namespace ErsatzTV.Application.FFmpegProfiles.Commands
                 .Bind(v => v.ToEitherAsync());
 
         private async Task<Validation<BaseError, Unit>> Validate(UpdateFFmpegSettings request) =>
-            (await FFmpegMustExist(request), await FFprobeMustExist(request))
+            (await FFmpegMustExist(request), await FFprobeMustExist(request), ReportsAreNotSupportedOnWindows(request))
-            .Apply((_, _) => Unit.Default);
+            .Apply((_, _, _) => Unit.Default);
 
         private Task<Validation<BaseError, Unit>> FFmpegMustExist(UpdateFFmpegSettings request) =>
             ValidateToolPath(request.Settings.FFmpegPath, "ffmpeg");
@@ -40,6 +45,16 @@ namespace ErsatzTV.Application.FFmpegProfiles.Commands
         private Task<Validation<BaseError, Unit>> FFprobeMustExist(UpdateFFmpegSettings request) =>
             ValidateToolPath(request.Settings.FFprobePath, "ffprobe");
 
+        private Validation<BaseError, Unit> ReportsAreNotSupportedOnWindows(UpdateFFmpegSettings request)
+        {
+            if (request.Settings.SaveReports && _runtimeInfo.IsOSPlatform(OSPlatform.Windows))
+            {
+                return BaseError.New("FFmpeg reports are not supported on Windows");
+            }
+
+            return Unit.Default;
+        }
+
         private async Task<Validation<BaseError, Unit>> ValidateToolPath(string path, string name)
         {
             if (!_localFileSystem.FileExists(path))

ErsatzTV.Application/Streaming/Queries/GetConcatProcessByChannelNumberHandler.cs

@@ -1,9 +1,11 @@
 using System.Diagnostics;
+using System.Runtime.InteropServices;
 using System.Threading.Tasks;
 using ErsatzTV.Core;
 using ErsatzTV.Core.Domain;
 using ErsatzTV.Core.FFmpeg;
 using ErsatzTV.Core.Interfaces.Repositories;
+using ErsatzTV.Core.Interfaces.Runtime;
 using LanguageExt;
 
 namespace ErsatzTV.Application.Streaming.Queries
@@ -12,15 +14,18 @@ namespace ErsatzTV.Application.Streaming.Queries
     {
         private readonly IConfigElementRepository _configElementRepository;
         private readonly FFmpegProcessService _ffmpegProcessService;
+        private readonly IRuntimeInfo _runtimeInfo;
 
         public GetConcatProcessByChannelNumberHandler(
             IChannelRepository channelRepository,
             IConfigElementRepository configElementRepository,
-            FFmpegProcessService ffmpegProcessService)
+            FFmpegProcessService ffmpegProcessService,
+            IRuntimeInfo runtimeInfo)
             : base(channelRepository, configElementRepository)
         {
             _configElementRepository = configElementRepository;
             _ffmpegProcessService = ffmpegProcessService;
+            _runtimeInfo = runtimeInfo;
         }
 
         protected override async Task<Either<BaseError, Process>> GetProcess(
@@ -28,7 +33,8 @@ namespace ErsatzTV.Application.Streaming.Queries
             Channel channel,
             string ffmpegPath)
         {
-            bool saveReports = await _configElementRepository.GetValue<bool>(ConfigElementKey.FFmpegSaveReports)
+            bool saveReports = !_runtimeInfo.IsOSPlatform(OSPlatform.Windows) && await _configElementRepository
+                .GetValue<bool>(ConfigElementKey.FFmpegSaveReports)
                 .Map(result => result.IfNone(false));
 
             return _ffmpegProcessService.ConcatChannel(

ErsatzTV.Application/Streaming/Queries/GetPlayoutItemProcessByChannelNumberHandler.cs

@@ -1,5 +1,6 @@
 using System;
 using System.Diagnostics;
+using System.Runtime.InteropServices;
 using System.Threading.Tasks;
 using ErsatzTV.Core;
 using ErsatzTV.Core.Domain;
@@ -10,6 +11,7 @@ using ErsatzTV.Core.Interfaces.Jellyfin;
 using ErsatzTV.Core.Interfaces.Metadata;
 using ErsatzTV.Core.Interfaces.Plex;
 using ErsatzTV.Core.Interfaces.Repositories;
+using ErsatzTV.Core.Interfaces.Runtime;
 using LanguageExt;
 using static LanguageExt.Prelude;
 
@@ -25,6 +27,7 @@ namespace ErsatzTV.Application.Streaming.Queries
         private readonly ILocalFileSystem _localFileSystem;
         private readonly IPlayoutRepository _playoutRepository;
         private readonly IPlexPathReplacementService _plexPathReplacementService;
+        private readonly IRuntimeInfo _runtimeInfo;
 
         public GetPlayoutItemProcessByChannelNumberHandler(
             IChannelRepository channelRepository,
@@ -34,7 +37,8 @@ namespace ErsatzTV.Application.Streaming.Queries
             ILocalFileSystem localFileSystem,
             IPlexPathReplacementService plexPathReplacementService,
             IJellyfinPathReplacementService jellyfinPathReplacementService,
-            IEmbyPathReplacementService embyPathReplacementService)
+            IEmbyPathReplacementService embyPathReplacementService,
+            IRuntimeInfo runtimeInfo)
             : base(channelRepository, configElementRepository)
         {
             _configElementRepository = configElementRepository;
@@ -44,6 +48,7 @@ namespace ErsatzTV.Application.Streaming.Queries
             _plexPathReplacementService = plexPathReplacementService;
             _jellyfinPathReplacementService = jellyfinPathReplacementService;
             _embyPathReplacementService = embyPathReplacementService;
+            _runtimeInfo = runtimeInfo;
         }
 
         protected override async Task<Either<BaseError, Process>> GetProcess(
@@ -68,7 +73,8 @@ namespace ErsatzTV.Application.Streaming.Queries
                         _ => throw new ArgumentOutOfRangeException(nameof(playoutItemWithPath))
                     };
 
-                    bool saveReports = await _configElementRepository.GetValue<bool>(ConfigElementKey.FFmpegSaveReports)
+                    bool saveReports = !_runtimeInfo.IsOSPlatform(OSPlatform.Windows) && await _configElementRepository
+                        .GetValue<bool>(ConfigElementKey.FFmpegSaveReports)
                         .Map(result => result.IfNone(false));
 
                     return Right<BaseError, Process>(
@@ -147,7 +153,6 @@ namespace ErsatzTV.Application.Streaming.Queries
         {
             string path = await GetPlayoutItemPath(playoutItem);
 
-            // TODO: this won't work with url streaming from plex
             if (_localFileSystem.FileExists(path))
             {
                 return new PlayoutItemWithPath(playoutItem, path);

ErsatzTV.Infrastructure/Images/ImageCache.cs

@@ -26,7 +26,7 @@ namespace ErsatzTV.Infrastructure.Images
         public async Task<Either<BaseError, byte[]>> ResizeImage(byte[] imageBuffer, int height)
         {
             await using var inStream = new MemoryStream(imageBuffer);
-            using var image = await Image.LoadAsync(inStream);
+            using Image image = await Image.LoadAsync(inStream);
 
             var size = new Size { Height = height };
 

ErsatzTV/Services/RunOnce/PlatformSettingsService.cs

@@ -0,0 +1,56 @@
+using System.Runtime.InteropServices;
+using System.Threading;
+using System.Threading.Tasks;
+using ErsatzTV.Core.Domain;
+using ErsatzTV.Core.Interfaces.Repositories;
+using ErsatzTV.Core.Interfaces.Runtime;
+using ErsatzTV.Infrastructure.Data;
+using LanguageExt;
+using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.Hosting;
+using Microsoft.Extensions.Logging;
+
+namespace ErsatzTV.Services.RunOnce
+{
+    public class PlatformSettingsService : IHostedService
+    {
+        private readonly ILogger<PlatformSettingsService> _logger;
+        private readonly IServiceScopeFactory _serviceScopeFactory;
+
+        public PlatformSettingsService(
+            IServiceScopeFactory serviceScopeFactory,
+            ILogger<PlatformSettingsService> logger)
+        {
+            _serviceScopeFactory = serviceScopeFactory;
+            _logger = logger;
+        }
+
+        public async Task StartAsync(CancellationToken cancellationToken)
+        {
+            using IServiceScope scope = _serviceScopeFactory.CreateScope();
+            await using TvContext dbContext = scope.ServiceProvider.GetRequiredService<TvContext>();
+
+            IRuntimeInfo runtimeInfo = scope.ServiceProvider.GetRequiredService<IRuntimeInfo>();
+            if (runtimeInfo != null && runtimeInfo.IsOSPlatform(OSPlatform.Windows))
+            {
+                _logger.LogInformation("Disabling ffmpeg reports on Windows platform");
+                IConfigElementRepository repo = scope.ServiceProvider.GetRequiredService<IConfigElementRepository>();
+                ConfigElementKey key = ConfigElementKey.FFmpegSaveReports;
+                Option<ConfigElement> maybeExisting = await repo.Get(key);
+                await maybeExisting.Match(
+                    ce =>
+                    {
+                        ce.Value = false.ToString();
+                        return repo.Update(ce);
+                    },
+                    () =>
+                    {
+                        var ce = new ConfigElement { Key = key.Key, Value = false.ToString() };
+                        return repo.Add(ce);
+                    });
+            }
+        }
+
+        public Task StopAsync(CancellationToken cancellationToken) => Task.CompletedTask;
+    }
+}

ErsatzTV/Startup.cs

@@ -256,6 +256,7 @@ namespace ErsatzTV
             services.AddHostedService<DatabaseMigratorService>();
             services.AddHostedService<CacheCleanerService>();
             services.AddHostedService<ResourceExtractorService>();
+            services.AddHostedService<PlatformSettingsService>();
             services.AddHostedService<EmbyService>();
             services.AddHostedService<JellyfinService>();
             services.AddHostedService<PlexService>();

docs/user-guide/search.md

@@ -18,6 +18,8 @@ The following fields are available for searching movies:
 - `plot`: The movie plot
 - `studio`: The movie studio
 - `actor`: An actor from the movie
+- `director`: A director from the movie
+- `writer`: A writer from the movie
 - `library_name`: The name of the library that contains the movie
 - `content_rating`: The movie content rating (case-sensitive) 
 - `language`: The movie audio stream language