< Summary - Jellyfin

Information
Class: MediaBrowser.Providers.MediaInfo.VideoImageProvider
Assembly: MediaBrowser.Providers
File(s): /srv/git/jellyfin/MediaBrowser.Providers/MediaInfo/VideoImageProvider.cs
Line coverage
73%
Covered lines: 14
Uncovered lines: 5
Coverable lines: 19
Total lines: 132
Line coverage: 73.6%
Branch coverage
75%
Covered branches: 12
Total branches: 16
Branch coverage: 75%
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%
GetSupportedImages(...)100%210%
GetImage(...)100%88100%
Supports(...)50%12.1860%

File(s)

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

#LineLine coverage
 1using System;
 2using System.Collections.Generic;
 3using System.Linq;
 4using System.Threading;
 5using System.Threading.Tasks;
 6using MediaBrowser.Controller.Entities;
 7using MediaBrowser.Controller.Library;
 8using MediaBrowser.Controller.MediaEncoding;
 9using MediaBrowser.Controller.Persistence;
 10using MediaBrowser.Controller.Providers;
 11using MediaBrowser.Model.Drawing;
 12using MediaBrowser.Model.Dto;
 13using MediaBrowser.Model.Entities;
 14using MediaBrowser.Model.MediaInfo;
 15using Microsoft.Extensions.Logging;
 16
 17namespace MediaBrowser.Providers.MediaInfo
 18{
 19    /// <summary>
 20    /// Uses <see cref="IMediaEncoder"/> to create still images from the main video.
 21    /// </summary>
 22    public class VideoImageProvider : IDynamicImageProvider, IHasOrder
 23    {
 24        private readonly IMediaSourceManager _mediaSourceManager;
 25        private readonly IMediaEncoder _mediaEncoder;
 26        private readonly ILogger<VideoImageProvider> _logger;
 27
 28        /// <summary>
 29        /// Initializes a new instance of the <see cref="VideoImageProvider"/> class.
 30        /// </summary>
 31        /// <param name="mediaSourceManager">The media source manager for fetching item streams.</param>
 32        /// <param name="mediaEncoder">The media encoder for capturing images.</param>
 33        /// <param name="logger">The logger.</param>
 34        public VideoImageProvider(IMediaSourceManager mediaSourceManager, IMediaEncoder mediaEncoder, ILogger<VideoImage
 35        {
 2936            _mediaSourceManager = mediaSourceManager;
 2937            _mediaEncoder = mediaEncoder;
 2938            _logger = logger;
 2939        }
 40
 41        /// <inheritdoc />
 042        public string Name => "Screen Grabber";
 43
 44        /// <inheritdoc />
 45        // Make sure this comes after internet image providers
 046        public int Order => 100;
 47
 48        /// <inheritdoc />
 49        public IEnumerable<ImageType> GetSupportedImages(BaseItem item)
 50        {
 051            return new[] { ImageType.Primary };
 52        }
 53
 54        /// <inheritdoc />
 55        public Task<DynamicImageResponse> GetImage(BaseItem item, ImageType type, CancellationToken cancellationToken)
 56        {
 757            var video = (Video)item;
 58
 59            // No support for these
 760            if (video.IsPlaceHolder || video.VideoType == VideoType.Dvd)
 61            {
 162                return Task.FromResult(new DynamicImageResponse { HasImage = false });
 63            }
 64
 65            // Can't extract if we didn't find a video stream in the file
 666            if (!video.DefaultVideoStreamIndex.HasValue)
 67            {
 168                _logger.LogInformation("Skipping image extraction due to missing DefaultVideoStreamIndex for {Path}.", v
 169                return Task.FromResult(new DynamicImageResponse { HasImage = false });
 70            }
 71
 572            return GetVideoImage(video, cancellationToken);
 73        }
 74
 75        private async Task<DynamicImageResponse> GetVideoImage(Video item, CancellationToken cancellationToken)
 76        {
 77            MediaSourceInfo mediaSource = new MediaSourceInfo
 78            {
 79                VideoType = item.VideoType,
 80                IsoType = item.IsoType,
 81                Protocol = item.PathProtocol ?? MediaProtocol.File,
 82            };
 83
 84            // If we know the duration, grab it from 10% into the video. Otherwise just 10 seconds in.
 85            // Always use 10 seconds for dvd because our duration could be out of whack
 86            var imageOffset = item.VideoType != VideoType.Dvd && item.RunTimeTicks > 0
 87                                  ? TimeSpan.FromTicks(item.RunTimeTicks.Value / 10)
 88                                  : TimeSpan.FromSeconds(10);
 89
 90            var query = new MediaStreamQuery { ItemId = item.Id, Index = item.DefaultVideoStreamIndex };
 91            var videoStream = _mediaSourceManager.GetMediaStreams(query).FirstOrDefault();
 92            if (videoStream is null)
 93            {
 94                query.Type = MediaStreamType.Video;
 95                query.Index = null;
 96                videoStream = _mediaSourceManager.GetMediaStreams(query).FirstOrDefault();
 97            }
 98
 99            if (videoStream is null)
 100            {
 101                _logger.LogInformation("Skipping image extraction: no video stream found for {Path}.", item.Path ?? stri
 102                return new DynamicImageResponse { HasImage = false };
 103            }
 104
 105            string extractedImagePath = await _mediaEncoder.ExtractVideoImage(item.Path, item.Container, mediaSource, vi
 106
 107            return new DynamicImageResponse
 108            {
 109                Format = ImageFormat.Jpg,
 110                HasImage = true,
 111                Path = extractedImagePath,
 112                Protocol = MediaProtocol.File
 113            };
 114        }
 115
 116        /// <inheritdoc />
 117        public bool Supports(BaseItem item)
 118        {
 46119            if (item.IsShortcut)
 120            {
 0121                return false;
 122            }
 123
 46124            if (!item.IsFileProtocol)
 125            {
 0126                return false;
 127            }
 128
 46129            return item is Video video && !video.IsPlaceHolder && video.IsCompleteMedia;
 130        }
 131    }
 132}