mirror of
https://github.com/jellyfin/jellyfin.git
synced 2026-04-20 17:14:42 +01:00
Merge pull request #6689 from 1337joe/expand-image-extraction
This commit is contained in:
Claus Vium
@@ -0,0 +1,216 @@
|
||||
using System.Collections.Generic;
|
||||
using System.Linq;
|
||||
using System.Threading;
|
||||
using System.Threading.Tasks;
|
||||
using MediaBrowser.Controller.Entities;
|
||||
using MediaBrowser.Controller.Entities.Movies;
|
||||
using MediaBrowser.Controller.Entities.TV;
|
||||
using MediaBrowser.Controller.MediaEncoding;
|
||||
using MediaBrowser.Model.Drawing;
|
||||
using MediaBrowser.Model.Dto;
|
||||
using MediaBrowser.Model.Entities;
|
||||
using MediaBrowser.Providers.MediaInfo;
|
||||
using Moq;
|
||||
using Xunit;
|
||||
|
||||
namespace Jellyfin.Providers.Tests.MediaInfo
|
||||
{
|
||||
public class EmbeddedImageProviderTests
|
||||
{
|
||||
private static TheoryData<BaseItem> GetSupportedImages_UnsupportedBaseItems_ReturnsEmpty_TestData()
|
||||
{
|
||||
return new ()
|
||||
{
|
||||
new AudioBook(),
|
||||
new BoxSet(),
|
||||
new Series(),
|
||||
new Season(),
|
||||
};
|
||||
}
|
||||
|
||||
[Theory]
|
||||
[MemberData(nameof(GetSupportedImages_UnsupportedBaseItems_ReturnsEmpty_TestData))]
|
||||
public void GetSupportedImages_UnsupportedBaseItems_ReturnsEmpty(BaseItem item)
|
||||
{
|
||||
var embeddedImageProvider = GetEmbeddedImageProvider(null);
|
||||
Assert.Empty(embeddedImageProvider.GetSupportedImages(item));
|
||||
}
|
||||
|
||||
private static TheoryData<BaseItem, IEnumerable<ImageType>> GetSupportedImages_SupportedBaseItems_ReturnsPopulated_TestData()
|
||||
{
|
||||
return new TheoryData<BaseItem, IEnumerable<ImageType>>
|
||||
{
|
||||
{ new Episode(), new List<ImageType> { ImageType.Primary } },
|
||||
{ new Movie(), new List<ImageType> { ImageType.Logo, ImageType.Backdrop, ImageType.Primary } },
|
||||
};
|
||||
}
|
||||
|
||||
[Theory]
|
||||
[MemberData(nameof(GetSupportedImages_SupportedBaseItems_ReturnsPopulated_TestData))]
|
||||
public void GetSupportedImages_SupportedBaseItems_ReturnsPopulated(BaseItem item, IEnumerable<ImageType> expected)
|
||||
{
|
||||
var embeddedImageProvider = GetEmbeddedImageProvider(null);
|
||||
var actual = embeddedImageProvider.GetSupportedImages(item);
|
||||
Assert.Equal(expected.OrderBy(i => i.ToString()), actual.OrderBy(i => i.ToString()));
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async void GetImage_InputWithNoStreams_ReturnsNoImage()
|
||||
{
|
||||
var embeddedImageProvider = GetEmbeddedImageProvider(null);
|
||||
|
||||
var input = GetMovie(new List<MediaAttachment>(), new List<MediaStream>());
|
||||
|
||||
var actual = await embeddedImageProvider.GetImage(input, ImageType.Primary, CancellationToken.None);
|
||||
Assert.NotNull(actual);
|
||||
Assert.False(actual.HasImage);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async void GetImage_InputWithUnlabeledAttachments_ReturnsNoImage()
|
||||
{
|
||||
var embeddedImageProvider = GetEmbeddedImageProvider(null);
|
||||
|
||||
// add an attachment without a filename - has a list to look through but finds nothing
|
||||
var input = GetMovie(
|
||||
new List<MediaAttachment> { new () },
|
||||
new List<MediaStream>());
|
||||
|
||||
var actual = await embeddedImageProvider.GetImage(input, ImageType.Primary, CancellationToken.None);
|
||||
Assert.NotNull(actual);
|
||||
Assert.False(actual.HasImage);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async void GetImage_InputWithLabeledAttachments_ReturnsCorrectSelection()
|
||||
{
|
||||
// first tests file extension detection, second uses mimetype, third defaults to jpg
|
||||
MediaAttachment sampleAttachment1 = new () { FileName = "clearlogo.png", Index = 1 };
|
||||
MediaAttachment sampleAttachment2 = new () { FileName = "backdrop", MimeType = "image/bmp", Index = 2 };
|
||||
MediaAttachment sampleAttachment3 = new () { FileName = "poster", Index = 3 };
|
||||
string targetPath1 = "path1.png";
|
||||
string targetPath2 = "path2.bmp";
|
||||
string targetPath3 = "path2.jpg";
|
||||
|
||||
var mediaEncoder = new Mock<IMediaEncoder>(MockBehavior.Strict);
|
||||
mediaEncoder.Setup(encoder => encoder.ExtractVideoImage(It.IsAny<string>(), It.IsAny<string>(), It.IsAny<MediaSourceInfo>(), It.IsAny<MediaStream>(), 1, ".png", CancellationToken.None))
|
||||
.Returns(Task.FromResult(targetPath1));
|
||||
mediaEncoder.Setup(encoder => encoder.ExtractVideoImage(It.IsAny<string>(), It.IsAny<string>(), It.IsAny<MediaSourceInfo>(), It.IsAny<MediaStream>(), 2, ".bmp", CancellationToken.None))
|
||||
.Returns(Task.FromResult(targetPath2));
|
||||
mediaEncoder.Setup(encoder => encoder.ExtractVideoImage(It.IsAny<string>(), It.IsAny<string>(), It.IsAny<MediaSourceInfo>(), It.IsAny<MediaStream>(), 3, ".jpg", CancellationToken.None))
|
||||
.Returns(Task.FromResult(targetPath3));
|
||||
var embeddedImageProvider = GetEmbeddedImageProvider(mediaEncoder.Object);
|
||||
|
||||
var input = GetMovie(
|
||||
new List<MediaAttachment> { sampleAttachment1, sampleAttachment2, sampleAttachment3 },
|
||||
new List<MediaStream>());
|
||||
|
||||
var actualLogo = await embeddedImageProvider.GetImage(input, ImageType.Logo, CancellationToken.None);
|
||||
Assert.NotNull(actualLogo);
|
||||
Assert.True(actualLogo.HasImage);
|
||||
Assert.Equal(targetPath1, actualLogo.Path);
|
||||
Assert.Equal(ImageFormat.Png, actualLogo.Format);
|
||||
|
||||
var actualBackdrop = await embeddedImageProvider.GetImage(input, ImageType.Backdrop, CancellationToken.None);
|
||||
Assert.NotNull(actualBackdrop);
|
||||
Assert.True(actualBackdrop.HasImage);
|
||||
Assert.Equal(targetPath2, actualBackdrop.Path);
|
||||
Assert.Equal(ImageFormat.Bmp, actualBackdrop.Format);
|
||||
|
||||
var actualPrimary = await embeddedImageProvider.GetImage(input, ImageType.Primary, CancellationToken.None);
|
||||
Assert.NotNull(actualPrimary);
|
||||
Assert.True(actualPrimary.HasImage);
|
||||
Assert.Equal(targetPath3, actualPrimary.Path);
|
||||
Assert.Equal(ImageFormat.Jpg, actualPrimary.Format);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async void GetImage_InputWithUnlabeledEmbeddedImages_BackdropReturnsNoImage()
|
||||
{
|
||||
var embeddedImageProvider = GetEmbeddedImageProvider(null);
|
||||
|
||||
var input = GetMovie(
|
||||
new List<MediaAttachment>(),
|
||||
new List<MediaStream> { new () { Type = MediaStreamType.EmbeddedImage } });
|
||||
|
||||
var actual = await embeddedImageProvider.GetImage(input, ImageType.Backdrop, CancellationToken.None);
|
||||
Assert.NotNull(actual);
|
||||
Assert.False(actual.HasImage);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async void GetImage_InputWithUnlabeledEmbeddedImages_PrimaryReturnsImage()
|
||||
{
|
||||
MediaStream sampleStream = new () { Type = MediaStreamType.EmbeddedImage, Index = 1 };
|
||||
string targetPath = "path";
|
||||
|
||||
var mediaEncoder = new Mock<IMediaEncoder>(MockBehavior.Strict);
|
||||
mediaEncoder.Setup(encoder => encoder.ExtractVideoImage(It.IsAny<string>(), It.IsAny<string>(), It.IsAny<MediaSourceInfo>(), sampleStream, 1, ".jpg", CancellationToken.None))
|
||||
.Returns(Task.FromResult(targetPath));
|
||||
var embeddedImageProvider = GetEmbeddedImageProvider(mediaEncoder.Object);
|
||||
|
||||
var input = GetMovie(
|
||||
new List<MediaAttachment>(),
|
||||
new List<MediaStream> { sampleStream });
|
||||
|
||||
var actual = await embeddedImageProvider.GetImage(input, ImageType.Primary, CancellationToken.None);
|
||||
Assert.NotNull(actual);
|
||||
Assert.True(actual.HasImage);
|
||||
Assert.Equal(targetPath, actual.Path);
|
||||
Assert.Equal(ImageFormat.Jpg, actual.Format);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async void GetImage_InputWithLabeledEmbeddedImages_ReturnsCorrectSelection()
|
||||
{
|
||||
// primary is second stream to ensure it's not defaulting, backdrop is first
|
||||
MediaStream sampleStream1 = new () { Type = MediaStreamType.EmbeddedImage, Index = 1, Comment = "backdrop" };
|
||||
MediaStream sampleStream2 = new () { Type = MediaStreamType.EmbeddedImage, Index = 2, Comment = "cover" };
|
||||
string targetPath1 = "path1.jpg";
|
||||
string targetPath2 = "path2.jpg";
|
||||
|
||||
var mediaEncoder = new Mock<IMediaEncoder>(MockBehavior.Strict);
|
||||
mediaEncoder.Setup(encoder => encoder.ExtractVideoImage(It.IsAny<string>(), It.IsAny<string>(), It.IsAny<MediaSourceInfo>(), sampleStream1, 1, ".jpg", CancellationToken.None))
|
||||
.Returns(Task.FromResult(targetPath1));
|
||||
mediaEncoder.Setup(encoder => encoder.ExtractVideoImage(It.IsAny<string>(), It.IsAny<string>(), It.IsAny<MediaSourceInfo>(), sampleStream2, 2, ".jpg", CancellationToken.None))
|
||||
.Returns(Task.FromResult(targetPath2));
|
||||
var embeddedImageProvider = GetEmbeddedImageProvider(mediaEncoder.Object);
|
||||
|
||||
var input = GetMovie(
|
||||
new List<MediaAttachment>(),
|
||||
new List<MediaStream> { sampleStream1, sampleStream2 });
|
||||
|
||||
var actualPrimary = await embeddedImageProvider.GetImage(input, ImageType.Primary, CancellationToken.None);
|
||||
Assert.NotNull(actualPrimary);
|
||||
Assert.True(actualPrimary.HasImage);
|
||||
Assert.Equal(targetPath2, actualPrimary.Path);
|
||||
Assert.Equal(ImageFormat.Jpg, actualPrimary.Format);
|
||||
|
||||
var actualBackdrop = await embeddedImageProvider.GetImage(input, ImageType.Backdrop, CancellationToken.None);
|
||||
Assert.NotNull(actualBackdrop);
|
||||
Assert.True(actualBackdrop.HasImage);
|
||||
Assert.Equal(targetPath1, actualBackdrop.Path);
|
||||
Assert.Equal(ImageFormat.Jpg, actualBackdrop.Format);
|
||||
}
|
||||
|
||||
private static EmbeddedImageProvider GetEmbeddedImageProvider(IMediaEncoder? mediaEncoder)
|
||||
{
|
||||
return new EmbeddedImageProvider(mediaEncoder);
|
||||
}
|
||||
|
||||
private static Movie GetMovie(List<MediaAttachment> mediaAttachments, List<MediaStream> mediaStreams)
|
||||
{
|
||||
// Mocking IMediaSourceManager GetMediaAttachments and GetMediaStreams instead of mocking Movie works, but
|
||||
// has concurrency problems between this and VideoImageProviderTests due to BaseItem.MediaSourceManager
|
||||
// being static
|
||||
var movie = new Mock<Movie>();
|
||||
|
||||
movie.Setup(item => item.GetMediaSources(It.IsAny<bool>()))
|
||||
.Returns(new List<MediaSourceInfo> { new () { MediaAttachments = mediaAttachments } } );
|
||||
movie.Setup(item => item.GetMediaStreams())
|
||||
.Returns(mediaStreams);
|
||||
|
||||
return movie.Object;
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,176 @@
|
||||
using System;
|
||||
using System.Collections.Generic;
|
||||
using System.Threading;
|
||||
using System.Threading.Tasks;
|
||||
using MediaBrowser.Controller.Entities.Movies;
|
||||
using MediaBrowser.Controller.MediaEncoding;
|
||||
using MediaBrowser.Model.Drawing;
|
||||
using MediaBrowser.Model.Dto;
|
||||
using MediaBrowser.Model.Entities;
|
||||
using MediaBrowser.Providers.MediaInfo;
|
||||
using Microsoft.Extensions.Logging.Abstractions;
|
||||
using Moq;
|
||||
using Xunit;
|
||||
|
||||
namespace Jellyfin.Providers.Tests.MediaInfo
|
||||
{
|
||||
public class VideoImageProviderTests
|
||||
{
|
||||
[Fact]
|
||||
public async void GetImage_InputIsPlaceholder_ReturnsNoImage()
|
||||
{
|
||||
var videoImageProvider = GetVideoImageProvider(null);
|
||||
|
||||
var input = new Movie
|
||||
{
|
||||
IsPlaceHolder = true
|
||||
};
|
||||
|
||||
var actual = await videoImageProvider.GetImage(input, ImageType.Primary, CancellationToken.None);
|
||||
Assert.NotNull(actual);
|
||||
Assert.False(actual.HasImage);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async void GetImage_NoDefaultVideoStream_ReturnsNoImage()
|
||||
{
|
||||
var videoImageProvider = GetVideoImageProvider(null);
|
||||
|
||||
var input = new Movie
|
||||
{
|
||||
DefaultVideoStreamIndex = null
|
||||
};
|
||||
|
||||
var actual = await videoImageProvider.GetImage(input, ImageType.Primary, CancellationToken.None);
|
||||
Assert.NotNull(actual);
|
||||
Assert.False(actual.HasImage);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async void GetImage_DefaultSetButNoVideoStream_ReturnsNoImage()
|
||||
{
|
||||
var videoImageProvider = GetVideoImageProvider(null);
|
||||
|
||||
// set a default index but don't put anything there (invalid input, but provider shouldn't break)
|
||||
var input = GetMovie(0, null, new List<MediaStream>());
|
||||
|
||||
var actual = await videoImageProvider.GetImage(input, ImageType.Primary, CancellationToken.None);
|
||||
Assert.NotNull(actual);
|
||||
Assert.False(actual.HasImage);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async void GetImage_DefaultSetMultipleVideoStreams_ReturnsDefaultStreamImage()
|
||||
{
|
||||
MediaStream firstStream = new () { Type = MediaStreamType.Video, Index = 0 };
|
||||
MediaStream targetStream = new () { Type = MediaStreamType.Video, Index = 1 };
|
||||
string targetPath = "path.jpg";
|
||||
|
||||
var mediaEncoder = new Mock<IMediaEncoder>(MockBehavior.Strict);
|
||||
mediaEncoder.Setup(encoder => encoder.ExtractVideoImage(It.IsAny<string>(), It.IsAny<string>(), It.IsAny<MediaSourceInfo>(), firstStream, It.IsAny<Video3DFormat?>(), It.IsAny<TimeSpan?>(), CancellationToken.None))
|
||||
.Returns(Task.FromResult("wrong stream called!"));
|
||||
mediaEncoder.Setup(encoder => encoder.ExtractVideoImage(It.IsAny<string>(), It.IsAny<string>(), It.IsAny<MediaSourceInfo>(), targetStream, It.IsAny<Video3DFormat?>(), It.IsAny<TimeSpan?>(), CancellationToken.None))
|
||||
.Returns(Task.FromResult(targetPath));
|
||||
var videoImageProvider = GetVideoImageProvider(mediaEncoder.Object);
|
||||
|
||||
var input = GetMovie(1, targetStream, new List<MediaStream> { firstStream, targetStream } );
|
||||
|
||||
var actual = await videoImageProvider.GetImage(input, ImageType.Primary, CancellationToken.None);
|
||||
Assert.NotNull(actual);
|
||||
Assert.True(actual.HasImage);
|
||||
Assert.Equal(targetPath, actual.Path);
|
||||
Assert.Equal(ImageFormat.Jpg, actual.Format);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async void GetImage_InvalidDefaultSingleVideoStream_ReturnsFirstVideoStreamImage()
|
||||
{
|
||||
MediaStream targetStream = new () { Type = MediaStreamType.Video, Index = 0 };
|
||||
string targetPath = "path.jpg";
|
||||
|
||||
var mediaEncoder = new Mock<IMediaEncoder>(MockBehavior.Strict);
|
||||
mediaEncoder.Setup(encoder => encoder.ExtractVideoImage(It.IsAny<string>(), It.IsAny<string>(), It.IsAny<MediaSourceInfo>(), targetStream, It.IsAny<Video3DFormat?>(), It.IsAny<TimeSpan?>(), CancellationToken.None))
|
||||
.Returns(Task.FromResult(targetPath));
|
||||
var videoImageProvider = GetVideoImageProvider(mediaEncoder.Object);
|
||||
|
||||
// provide query results for default (empty) and all streams (populated)
|
||||
var input = GetMovie(5, null, new List<MediaStream> { targetStream });
|
||||
|
||||
var actual = await videoImageProvider.GetImage(input, ImageType.Primary, CancellationToken.None);
|
||||
Assert.NotNull(actual);
|
||||
Assert.True(actual.HasImage);
|
||||
Assert.Equal(targetPath, actual.Path);
|
||||
Assert.Equal(ImageFormat.Jpg, actual.Format);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async void GetImage_NoTimeSpanSet_CallsEncoderWithDefaultTime()
|
||||
{
|
||||
MediaStream targetStream = new () { Type = MediaStreamType.Video, Index = 0 };
|
||||
|
||||
// use a callback to catch the actual value
|
||||
// provides more information on failure than verifying a specific input was called on the mock
|
||||
TimeSpan? actualTimeSpan = null;
|
||||
var mediaEncoder = new Mock<IMediaEncoder>(MockBehavior.Strict);
|
||||
mediaEncoder.Setup(encoder => encoder.ExtractVideoImage(It.IsAny<string>(), It.IsAny<string>(), It.IsAny<MediaSourceInfo>(), It.IsAny<MediaStream>(), It.IsAny<Video3DFormat?>(), It.IsAny<TimeSpan?>(), CancellationToken.None))
|
||||
.Callback<string, string, MediaSourceInfo, MediaStream, Video3DFormat?, TimeSpan?, CancellationToken>((_, _, _, _, _, timeSpan, _) => actualTimeSpan = timeSpan)
|
||||
.Returns(Task.FromResult("path"));
|
||||
var videoImageProvider = GetVideoImageProvider(mediaEncoder.Object);
|
||||
|
||||
var input = GetMovie(0, targetStream, new List<MediaStream> { targetStream });
|
||||
|
||||
// not testing return, just verifying what gets requested for time span
|
||||
await videoImageProvider.GetImage(input, ImageType.Primary, CancellationToken.None);
|
||||
|
||||
Assert.Equal(TimeSpan.FromSeconds(10), actualTimeSpan);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async void GetImage_TimeSpanSet_CallsEncoderWithCalculatedTime()
|
||||
{
|
||||
MediaStream targetStream = new () { Type = MediaStreamType.Video, Index = 0 };
|
||||
|
||||
TimeSpan? actualTimeSpan = null;
|
||||
var mediaEncoder = new Mock<IMediaEncoder>(MockBehavior.Strict);
|
||||
mediaEncoder.Setup(encoder => encoder.ExtractVideoImage(It.IsAny<string>(), It.IsAny<string>(), It.IsAny<MediaSourceInfo>(), It.IsAny<MediaStream>(), It.IsAny<Video3DFormat?>(), It.IsAny<TimeSpan?>(), CancellationToken.None))
|
||||
.Callback<string, string, MediaSourceInfo, MediaStream, Video3DFormat?, TimeSpan?, CancellationToken>((_, _, _, _, _, timeSpan, _) => actualTimeSpan = timeSpan)
|
||||
.Returns(Task.FromResult("path"));
|
||||
var videoImageProvider = GetVideoImageProvider(mediaEncoder.Object);
|
||||
|
||||
var input = GetMovie(0, targetStream, new List<MediaStream> { targetStream });
|
||||
input.RunTimeTicks = 5000;
|
||||
|
||||
// not testing return, just verifying what gets requested for time span
|
||||
await videoImageProvider.GetImage(input, ImageType.Primary, CancellationToken.None);
|
||||
|
||||
Assert.Equal(TimeSpan.FromTicks(500), actualTimeSpan);
|
||||
}
|
||||
|
||||
private static VideoImageProvider GetVideoImageProvider(IMediaEncoder? mediaEncoder)
|
||||
{
|
||||
// strict to ensure this isn't accidentally used where a prepared mock is intended
|
||||
mediaEncoder ??= new Mock<IMediaEncoder>(MockBehavior.Strict).Object;
|
||||
return new VideoImageProvider(mediaEncoder, new NullLogger<VideoImageProvider>());
|
||||
}
|
||||
|
||||
private static Movie GetMovie(int defaultVideoStreamIndex, MediaStream? defaultStream, List<MediaStream> mediaStreams)
|
||||
{
|
||||
// Mocking IMediaSourceManager GetMediaStreams instead of mocking Movie works, but has concurrency problems
|
||||
// between this and EmbeddedImageProviderTests due to BaseItem.MediaSourceManager being static
|
||||
var movie = new Mock<Movie>
|
||||
{
|
||||
Object =
|
||||
{
|
||||
DefaultVideoStreamIndex = defaultVideoStreamIndex
|
||||
}
|
||||
};
|
||||
|
||||
movie.Setup(item => item.GetDefaultVideoStream())
|
||||
.Returns(defaultStream!);
|
||||
movie.Setup(item => item.GetMediaStreams())
|
||||
.Returns(mediaStreams);
|
||||
|
||||
return movie.Object;
|
||||
}
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user