< Summary - Jellyfin

Information
Class: MediaBrowser.Providers.MediaInfo.ProbeProvider
Assembly: MediaBrowser.Providers
File(s): /srv/git/jellyfin/MediaBrowser.Providers/MediaInfo/ProbeProvider.cs
Line coverage
33%
Covered lines: 31
Uncovered lines: 61
Coverable lines: 92
Total lines: 306
Line coverage: 33.6%
Branch coverage
0%
Covered branches: 0
Total branches: 50
Branch coverage: 0%
Method coverage

Feature is only available for sponsors

Upgrade to PRO version

Coverage history

Coverage history 0 25 50 75 100

Metrics

MethodBranch coverage Crap Score Cyclomatic complexity Line coverage
.ctor(...)100%11100%
get_Name()100%210%
get_Order()100%210%
HasChanged(...)0%930300%
FetchAsync(...)100%210%
FetchAsync(...)100%210%
FetchAsync(...)100%210%
FetchAsync(...)100%210%
FetchAsync(...)100%210%
FetchAsync(...)100%210%
FetchAsync(...)100%210%
FetchVideoInfo(...)0%156120%
NormalizeStrmLine(...)100%210%
FetchShortcutInfo(...)100%210%
FetchAudioInfo(...)0%7280%

File(s)

/srv/git/jellyfin/MediaBrowser.Providers/MediaInfo/ProbeProvider.cs

#LineLine coverage
 1#nullable disable
 2
 3using System;
 4using System.Collections.Generic;
 5using System.IO;
 6using System.Linq;
 7using System.Threading;
 8using System.Threading.Tasks;
 9using Emby.Naming.Common;
 10using MediaBrowser.Controller.Chapters;
 11using MediaBrowser.Controller.Configuration;
 12using MediaBrowser.Controller.Entities;
 13using MediaBrowser.Controller.Entities.Audio;
 14using MediaBrowser.Controller.Entities.Movies;
 15using MediaBrowser.Controller.Entities.TV;
 16using MediaBrowser.Controller.Library;
 17using MediaBrowser.Controller.Lyrics;
 18using MediaBrowser.Controller.MediaEncoding;
 19using MediaBrowser.Controller.Persistence;
 20using MediaBrowser.Controller.Providers;
 21using MediaBrowser.Controller.Subtitles;
 22using MediaBrowser.Model.Entities;
 23using MediaBrowser.Model.Globalization;
 24using MediaBrowser.Model.IO;
 25using MediaBrowser.Model.MediaInfo;
 26using Microsoft.Extensions.Logging;
 27
 28namespace MediaBrowser.Providers.MediaInfo
 29{
 30    /// <summary>
 31    /// The probe provider.
 32    /// </summary>
 33    public class ProbeProvider : ICustomMetadataProvider<Episode>,
 34        ICustomMetadataProvider<MusicVideo>,
 35        ICustomMetadataProvider<Movie>,
 36        ICustomMetadataProvider<Trailer>,
 37        ICustomMetadataProvider<Video>,
 38        ICustomMetadataProvider<Audio>,
 39        ICustomMetadataProvider<AudioBook>,
 40        IHasOrder,
 41        IForcedProvider,
 42        IPreRefreshProvider,
 43        IHasItemChangeMonitor
 44    {
 45        private readonly ILogger<ProbeProvider> _logger;
 46        private readonly AudioResolver _audioResolver;
 47        private readonly SubtitleResolver _subtitleResolver;
 48        private readonly LyricResolver _lyricResolver;
 49        private readonly FFProbeVideoInfo _videoProber;
 50        private readonly AudioFileProber _audioProber;
 2151        private readonly Task<ItemUpdateType> _cachedTask = Task.FromResult(ItemUpdateType.None);
 52
 53        /// <summary>
 54        /// Initializes a new instance of the <see cref="ProbeProvider"/> class.
 55        /// </summary>
 56        /// <param name="mediaSourceManager">Instance of the <see cref="IMediaSourceManager"/> interface.</param>
 57        /// <param name="mediaEncoder">Instance of the <see cref="IMediaEncoder"/> interface.</param>
 58        /// <param name="itemRepo">Instance of the <see cref="IItemRepository"/> interface.</param>
 59        /// <param name="blurayExaminer">Instance of the <see cref="IBlurayExaminer"/> interface.</param>
 60        /// <param name="localization">Instance of the <see cref="ILocalizationManager"/> interface.</param>
 61        /// <param name="encodingManager">Instance of the <see cref="IEncodingManager"/> interface.</param>
 62        /// <param name="config">Instance of the <see cref="IServerConfigurationManager"/> interface.</param>
 63        /// <param name="subtitleManager">Instance of the <see cref="ISubtitleManager"/> interface.</param>
 64        /// <param name="chapterManager">Instance of the <see cref="IChapterRepository"/> interface.</param>
 65        /// <param name="libraryManager">Instance of the <see cref="ILibraryManager"/> interface.</param>
 66        /// <param name="loggerFactory">Instance of the <see cref="ILoggerFactory"/>.</param>
 67        /// <param name="fileSystem">Instance of the <see cref="IFileSystem"/> interface.</param>
 68        /// <param name="namingOptions">The <see cref="NamingOptions"/>.</param>
 69        /// <param name="lyricManager">Instance of the <see cref="ILyricManager"/> interface.</param>
 70        /// <param name="mediaAttachmentRepository">Instance of the <see cref="IMediaAttachmentRepository"/> interface.<
 71        /// <param name="mediaStreamRepository">Instance of the <see cref="IMediaStreamRepository"/> interface.</param>
 72        public ProbeProvider(
 73            IMediaSourceManager mediaSourceManager,
 74            IMediaEncoder mediaEncoder,
 75            IItemRepository itemRepo,
 76            IBlurayExaminer blurayExaminer,
 77            ILocalizationManager localization,
 78            IEncodingManager encodingManager,
 79            IServerConfigurationManager config,
 80            ISubtitleManager subtitleManager,
 81            IChapterRepository chapterManager,
 82            ILibraryManager libraryManager,
 83            IFileSystem fileSystem,
 84            ILoggerFactory loggerFactory,
 85            NamingOptions namingOptions,
 86            ILyricManager lyricManager,
 87            IMediaAttachmentRepository mediaAttachmentRepository,
 88            IMediaStreamRepository mediaStreamRepository)
 89        {
 2190            _logger = loggerFactory.CreateLogger<ProbeProvider>();
 2191            _audioResolver = new AudioResolver(loggerFactory.CreateLogger<AudioResolver>(), localization, mediaEncoder, 
 2192            _subtitleResolver = new SubtitleResolver(loggerFactory.CreateLogger<SubtitleResolver>(), localization, media
 2193            _lyricResolver = new LyricResolver(loggerFactory.CreateLogger<LyricResolver>(), localization, mediaEncoder, 
 94
 2195            _videoProber = new FFProbeVideoInfo(
 2196                loggerFactory.CreateLogger<FFProbeVideoInfo>(),
 2197                mediaSourceManager,
 2198                mediaEncoder,
 2199                itemRepo,
 21100                blurayExaminer,
 21101                localization,
 21102                encodingManager,
 21103                config,
 21104                subtitleManager,
 21105                chapterManager,
 21106                libraryManager,
 21107                _audioResolver,
 21108                _subtitleResolver,
 21109                mediaAttachmentRepository,
 21110                mediaStreamRepository);
 111
 21112            _audioProber = new AudioFileProber(
 21113                loggerFactory.CreateLogger<AudioFileProber>(),
 21114                mediaSourceManager,
 21115                mediaEncoder,
 21116                itemRepo,
 21117                libraryManager,
 21118                _lyricResolver,
 21119                lyricManager,
 21120                mediaStreamRepository);
 21121        }
 122
 123        /// <inheritdoc />
 0124        public string Name => "Probe Provider";
 125
 126        /// <inheritdoc />
 0127        public int Order => 100;
 128
 129        /// <inheritdoc />
 130        public bool HasChanged(BaseItem item, IDirectoryService directoryService)
 131        {
 0132            var video = item as Video;
 0133            if (video is null || video.VideoType == VideoType.VideoFile || video.VideoType == VideoType.Iso)
 134            {
 0135                var path = item.Path;
 136
 0137                if (!string.IsNullOrWhiteSpace(path) && item.IsFileProtocol)
 138                {
 0139                    var file = directoryService.GetFile(path);
 0140                    if (file is not null && file.LastWriteTimeUtc != item.DateModified)
 141                    {
 0142                        _logger.LogDebug("Refreshing {ItemPath} due to date modified timestamp change.", path);
 0143                        return true;
 144                    }
 145                }
 146            }
 147
 0148            if (video is not null
 0149                && item.SupportsLocalMetadata
 0150                && !video.IsPlaceHolder)
 151            {
 0152                var externalFiles = new HashSet<string>(_subtitleResolver.GetExternalFiles(video, directoryService, fals
 0153                if (!new HashSet<string>(video.SubtitleFiles, StringComparer.Ordinal).SetEquals(externalFiles))
 154                {
 0155                    _logger.LogDebug("Refreshing {ItemPath} due to external subtitles change.", item.Path);
 0156                    return true;
 157                }
 158
 0159                externalFiles = new HashSet<string>(_audioResolver.GetExternalFiles(video, directoryService, false).Sele
 0160                if (!new HashSet<string>(video.AudioFiles, StringComparer.Ordinal).SetEquals(externalFiles))
 161                {
 0162                    _logger.LogDebug("Refreshing {ItemPath} due to external audio change.", item.Path);
 0163                    return true;
 164                }
 165            }
 166
 0167            if (item is Audio audio
 0168                && item.SupportsLocalMetadata)
 169            {
 0170                var externalFiles = new HashSet<string>(_lyricResolver.GetExternalFiles(audio, directoryService, false).
 0171                if (!new HashSet<string>(audio.LyricFiles, StringComparer.Ordinal).SetEquals(externalFiles))
 172                {
 0173                    _logger.LogDebug("Refreshing {ItemPath} due to external lyrics change.", item.Path);
 0174                    return true;
 175                }
 176            }
 177
 0178            return false;
 179        }
 180
 181        /// <inheritdoc />
 182        public Task<ItemUpdateType> FetchAsync(Episode item, MetadataRefreshOptions options, CancellationToken cancellat
 183        {
 0184            return FetchVideoInfo(item, options, cancellationToken);
 185        }
 186
 187        /// <inheritdoc />
 188        public Task<ItemUpdateType> FetchAsync(MusicVideo item, MetadataRefreshOptions options, CancellationToken cancel
 189        {
 0190            return FetchVideoInfo(item, options, cancellationToken);
 191        }
 192
 193        /// <inheritdoc />
 194        public Task<ItemUpdateType> FetchAsync(Movie item, MetadataRefreshOptions options, CancellationToken cancellatio
 195        {
 0196            return FetchVideoInfo(item, options, cancellationToken);
 197        }
 198
 199        /// <inheritdoc />
 200        public Task<ItemUpdateType> FetchAsync(Trailer item, MetadataRefreshOptions options, CancellationToken cancellat
 201        {
 0202            return FetchVideoInfo(item, options, cancellationToken);
 203        }
 204
 205        /// <inheritdoc />
 206        public Task<ItemUpdateType> FetchAsync(Video item, MetadataRefreshOptions options, CancellationToken cancellatio
 207        {
 0208            return FetchVideoInfo(item, options, cancellationToken);
 209        }
 210
 211        /// <inheritdoc />
 212        public Task<ItemUpdateType> FetchAsync(Audio item, MetadataRefreshOptions options, CancellationToken cancellatio
 213        {
 0214            return FetchAudioInfo(item, options, cancellationToken);
 215        }
 216
 217        /// <inheritdoc />
 218        public Task<ItemUpdateType> FetchAsync(AudioBook item, MetadataRefreshOptions options, CancellationToken cancell
 219        {
 0220            return FetchAudioInfo(item, options, cancellationToken);
 221        }
 222
 223        /// <summary>
 224        /// Fetches video information for an item.
 225        /// </summary>
 226        /// <param name="item">The item.</param>
 227        /// <param name="options">The <see cref="MetadataRefreshOptions"/>.</param>
 228        /// <param name="cancellationToken">The <see cref="CancellationToken"/>.</param>
 229        /// <typeparam name="T">The type of item to resolve.</typeparam>
 230        /// <returns>A <see cref="Task"/> fetching the <see cref="ItemUpdateType"/> for an item.</returns>
 231        public Task<ItemUpdateType> FetchVideoInfo<T>(T item, MetadataRefreshOptions options, CancellationToken cancella
 232            where T : Video
 233        {
 0234            if (item.IsPlaceHolder)
 235            {
 0236                return _cachedTask;
 237            }
 238
 0239            if (!item.IsCompleteMedia)
 240            {
 0241                return _cachedTask;
 242            }
 243
 0244            if (item.IsVirtualItem)
 245            {
 0246                return _cachedTask;
 247            }
 248
 0249            if (!options.EnableRemoteContentProbe && !item.IsFileProtocol)
 250            {
 0251                return _cachedTask;
 252            }
 253
 0254            if (item.IsShortcut)
 255            {
 0256                FetchShortcutInfo(item);
 257            }
 258
 0259            return _videoProber.ProbeVideo(item, options, cancellationToken);
 260        }
 261
 262        private string NormalizeStrmLine(string line)
 263        {
 0264            return line.Replace("\t", string.Empty, StringComparison.Ordinal)
 0265                .Replace("\r", string.Empty, StringComparison.Ordinal)
 0266                .Replace("\n", string.Empty, StringComparison.Ordinal)
 0267                .Trim();
 268        }
 269
 270        private void FetchShortcutInfo(BaseItem item)
 271        {
 0272            item.ShortcutPath = File.ReadAllLines(item.Path)
 0273                .Select(NormalizeStrmLine)
 0274                .FirstOrDefault(i => !string.IsNullOrWhiteSpace(i) && !i.StartsWith('#'));
 0275        }
 276
 277        /// <summary>
 278        /// Fetches audio information for an item.
 279        /// </summary>
 280        /// <param name="item">The item.</param>
 281        /// <param name="options">The <see cref="MetadataRefreshOptions"/>.</param>
 282        /// <param name="cancellationToken">The <see cref="CancellationToken"/>.</param>
 283        /// <typeparam name="T">The type of item to resolve.</typeparam>
 284        /// <returns>A <see cref="Task"/> fetching the <see cref="ItemUpdateType"/> for an item.</returns>
 285        public Task<ItemUpdateType> FetchAudioInfo<T>(T item, MetadataRefreshOptions options, CancellationToken cancella
 286            where T : Audio
 287        {
 0288            if (item.IsVirtualItem)
 289            {
 0290                return _cachedTask;
 291            }
 292
 0293            if (!options.EnableRemoteContentProbe && !item.IsFileProtocol)
 294            {
 0295                return _cachedTask;
 296            }
 297
 0298            if (item.IsShortcut)
 299            {
 0300                FetchShortcutInfo(item);
 301            }
 302
 0303            return _audioProber.Probe(item, options, cancellationToken);
 304        }
 305    }
 306}
Generated by: ReportGenerator 5.4.5.0
4/3/2025 - 12:11:22 AM
GitHub | reportgenerator.io

Methods/Properties

.ctor(MediaBrowser.Controller.Library.IMediaSourceManager,MediaBrowser.Controller.MediaEncoding.IMediaEncoder,MediaBrowser.Controller.Persistence.IItemRepository,MediaBrowser.Model.MediaInfo.IBlurayExaminer,MediaBrowser.Model.Globalization.ILocalizationManager,MediaBrowser.Controller.MediaEncoding.IEncodingManager,MediaBrowser.Controller.Configuration.IServerConfigurationManager,MediaBrowser.Controller.Subtitles.ISubtitleManager,MediaBrowser.Controller.Chapters.IChapterRepository,MediaBrowser.Controller.Library.ILibraryManager,MediaBrowser.Model.IO.IFileSystem,Microsoft.Extensions.Logging.ILoggerFactory,Emby.Naming.Common.NamingOptions,MediaBrowser.Controller.Lyrics.ILyricManager,MediaBrowser.Controller.Persistence.IMediaAttachmentRepository,MediaBrowser.Controller.Persistence.IMediaStreamRepository)
get_Name()
get_Order()
HasChanged(MediaBrowser.Controller.Entities.BaseItem,MediaBrowser.Controller.Providers.IDirectoryService)
FetchAsync(MediaBrowser.Controller.Entities.TV.Episode,MediaBrowser.Controller.Providers.MetadataRefreshOptions,System.Threading.CancellationToken)
FetchAsync(MediaBrowser.Controller.Entities.MusicVideo,MediaBrowser.Controller.Providers.MetadataRefreshOptions,System.Threading.CancellationToken)
FetchAsync(MediaBrowser.Controller.Entities.Movies.Movie,MediaBrowser.Controller.Providers.MetadataRefreshOptions,System.Threading.CancellationToken)
FetchAsync(MediaBrowser.Controller.Entities.Trailer,MediaBrowser.Controller.Providers.MetadataRefreshOptions,System.Threading.CancellationToken)
FetchAsync(MediaBrowser.Controller.Entities.Video,MediaBrowser.Controller.Providers.MetadataRefreshOptions,System.Threading.CancellationToken)
FetchAsync(MediaBrowser.Controller.Entities.Audio.Audio,MediaBrowser.Controller.Providers.MetadataRefreshOptions,System.Threading.CancellationToken)
FetchAsync(MediaBrowser.Controller.Entities.AudioBook,MediaBrowser.Controller.Providers.MetadataRefreshOptions,System.Threading.CancellationToken)
FetchVideoInfo(T,MediaBrowser.Controller.Providers.MetadataRefreshOptions,System.Threading.CancellationToken)
NormalizeStrmLine(System.String)
FetchShortcutInfo(MediaBrowser.Controller.Entities.BaseItem)
FetchAudioInfo(T,MediaBrowser.Controller.Providers.MetadataRefreshOptions,System.Threading.CancellationToken)