< Summary - Jellyfin

Information
Class: Jellyfin.Server.Implementations.MediaSegments.MediaSegmentManager
Assembly: Jellyfin.Server.Implementations
File(s): /srv/git/jellyfin/Jellyfin.Server.Implementations/MediaSegments/MediaSegmentManager.cs
Line coverage
17%
Covered lines: 6
Uncovered lines: 28
Coverable lines: 34
Total lines: 275
Line coverage: 17.6%
Branch coverage
0%
Covered branches: 0
Total branches: 8
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%
Map(...)100%210%
Map(...)100%210%
HasSegments(...)100%210%
IsTypeSupported(...)0%620%
GetSupportedProviders(...)0%4260%
GetProviderId(...)100%210%

File(s)

/srv/git/jellyfin/Jellyfin.Server.Implementations/MediaSegments/MediaSegmentManager.cs

#LineLine coverage
 1using System;
 2using System.Collections.Generic;
 3using System.Collections.Immutable;
 4using System.Globalization;
 5using System.Linq;
 6using System.Threading;
 7using System.Threading.Tasks;
 8using Jellyfin.Database.Implementations;
 9using Jellyfin.Database.Implementations.Entities;
 10using Jellyfin.Database.Implementations.Enums;
 11using Jellyfin.Extensions;
 12using MediaBrowser.Common.Extensions;
 13using MediaBrowser.Controller.Entities;
 14using MediaBrowser.Controller.Entities.Audio;
 15using MediaBrowser.Controller.MediaSegments;
 16using MediaBrowser.Controller.Providers;
 17using MediaBrowser.Model;
 18using MediaBrowser.Model.Configuration;
 19using MediaBrowser.Model.MediaSegments;
 20using Microsoft.EntityFrameworkCore;
 21using Microsoft.Extensions.Logging;
 22
 23namespace Jellyfin.Server.Implementations.MediaSegments;
 24
 25/// <summary>
 26/// Manages media segments retrieval and storage.
 27/// </summary>
 28public class MediaSegmentManager : IMediaSegmentManager
 29{
 30    private readonly ILogger<MediaSegmentManager> _logger;
 31    private readonly IDbContextFactory<JellyfinDbContext> _dbProvider;
 32    private readonly IMediaSegmentProvider[] _segmentProviders;
 33
 34    /// <summary>
 35    /// Initializes a new instance of the <see cref="MediaSegmentManager"/> class.
 36    /// </summary>
 37    /// <param name="logger">Logger.</param>
 38    /// <param name="dbProvider">EFCore Database factory.</param>
 39    /// <param name="segmentProviders">List of all media segment providers.</param>
 40    public MediaSegmentManager(
 41        ILogger<MediaSegmentManager> logger,
 42        IDbContextFactory<JellyfinDbContext> dbProvider,
 43        IEnumerable<IMediaSegmentProvider> segmentProviders)
 44    {
 2145        _logger = logger;
 2146        _dbProvider = dbProvider;
 47
 2148        _segmentProviders = segmentProviders
 2149            .OrderBy(i => i is IHasOrder hasOrder ? hasOrder.Order : 0)
 2150            .ToArray();
 2151    }
 52
 53    /// <inheritdoc/>
 54    public async Task RunSegmentPluginProviders(BaseItem baseItem, LibraryOptions libraryOptions, bool forceOverwrite, C
 55    {
 56        var providers = _segmentProviders
 57            .Where(e => !libraryOptions.DisabledMediaSegmentProviders.Contains(GetProviderId(e.Name)))
 58            .OrderBy(i =>
 59                {
 60                    var index = libraryOptions.MediaSegmentProviderOrder.IndexOf(i.Name);
 61                    return index == -1 ? int.MaxValue : index;
 62                })
 63            .ToList();
 64
 65        if (providers.Count == 0)
 66        {
 67            _logger.LogDebug("Skipping media segment extraction as no providers are enabled for {MediaPath}", baseItem.P
 68            return;
 69        }
 70
 71        using var db = await _dbProvider.CreateDbContextAsync(cancellationToken).ConfigureAwait(false);
 72
 73        _logger.LogDebug("Start media segment extraction for {MediaPath} with {CountProviders} providers enabled", baseI
 74
 75        if (forceOverwrite)
 76        {
 77            // delete all existing media segments if forceOverwrite is set.
 78            await db.MediaSegments.Where(e => e.ItemId.Equals(baseItem.Id)).ExecuteDeleteAsync(cancellationToken).Config
 79        }
 80
 81        foreach (var provider in providers)
 82        {
 83            if (!await provider.Supports(baseItem).ConfigureAwait(false))
 84            {
 85                _logger.LogDebug("Media Segment provider {ProviderName} does not support item with path {MediaPath}", pr
 86                continue;
 87            }
 88
 89            IQueryable<MediaSegment> existingSegments;
 90            if (forceOverwrite)
 91            {
 92                existingSegments = Array.Empty<MediaSegment>().AsQueryable();
 93            }
 94            else
 95            {
 96                existingSegments = db.MediaSegments.Where(e => e.ItemId.Equals(baseItem.Id) && e.SegmentProviderId == Ge
 97            }
 98
 99            var requestItem = new MediaSegmentGenerationRequest()
 100            {
 101                ItemId = baseItem.Id,
 102                ExistingSegments = existingSegments.Select(e => Map(e)).ToArray()
 103            };
 104
 105            try
 106            {
 107                var segments = await provider.GetMediaSegments(requestItem, cancellationToken)
 108                    .ConfigureAwait(false);
 109
 110                if (!forceOverwrite)
 111                {
 112                    var existingSegmentsList = existingSegments.ToArray(); // Cannot use requestItem's list, as the prov
 113                    if (segments.Count == requestItem.ExistingSegments.Count && segments.All(e => existingSegmentsList.A
 114                    {
 115                        return
 116                            e.StartTicks == f.StartTicks &&
 117                            e.EndTicks == f.EndTicks &&
 118                            e.Type == f.Type;
 119                    })))
 120                    {
 121                        _logger.LogDebug("Media Segment provider {ProviderName} did not modify any segments for {MediaPa
 122                        continue;
 123                    }
 124
 125                    // delete existing media segments that were re-generated.
 126                    await existingSegments.ExecuteDeleteAsync(cancellationToken).ConfigureAwait(false);
 127                }
 128
 129                if (segments.Count == 0 && !requestItem.ExistingSegments.Any())
 130                {
 131                    _logger.LogDebug("Media Segment provider {ProviderName} did not find any segments for {MediaPath}", 
 132                    continue;
 133                }
 134                else if (segments.Count == 0 && requestItem.ExistingSegments.Any())
 135                {
 136                    _logger.LogDebug("Media Segment provider {ProviderName} deleted all segments for {MediaPath}", provi
 137                    continue;
 138                }
 139
 140                _logger.LogInformation("Media Segment provider {ProviderName} found {CountSegments} for {MediaPath}", pr
 141                var providerId = GetProviderId(provider.Name);
 142                foreach (var segment in segments)
 143                {
 144                    segment.ItemId = baseItem.Id;
 145                    await CreateSegmentAsync(segment, providerId).ConfigureAwait(false);
 146                }
 147            }
 148            catch (Exception ex)
 149            {
 150                _logger.LogError(ex, "Provider {ProviderName} failed to extract segments from {MediaPath}", provider.Nam
 151            }
 152        }
 153    }
 154
 155    /// <inheritdoc />
 156    public async Task<MediaSegmentDto> CreateSegmentAsync(MediaSegmentDto mediaSegment, string segmentProviderId)
 157    {
 158        ArgumentOutOfRangeException.ThrowIfLessThan(mediaSegment.EndTicks, mediaSegment.StartTicks);
 159
 160        using var db = await _dbProvider.CreateDbContextAsync().ConfigureAwait(false);
 161        db.MediaSegments.Add(Map(mediaSegment, segmentProviderId));
 162        await db.SaveChangesAsync().ConfigureAwait(false);
 163        return mediaSegment;
 164    }
 165
 166    /// <inheritdoc />
 167    public async Task DeleteSegmentAsync(Guid segmentId)
 168    {
 169        using var db = await _dbProvider.CreateDbContextAsync().ConfigureAwait(false);
 170        await db.MediaSegments.Where(e => e.Id.Equals(segmentId)).ExecuteDeleteAsync().ConfigureAwait(false);
 171    }
 172
 173    /// <inheritdoc />
 174    public async Task DeleteSegmentsAsync(Guid itemId, CancellationToken cancellationToken)
 175    {
 176        using var db = await _dbProvider.CreateDbContextAsync(cancellationToken).ConfigureAwait(false);
 177        await db.MediaSegments.Where(e => e.ItemId.Equals(itemId)).ExecuteDeleteAsync(cancellationToken).ConfigureAwait(
 178    }
 179
 180    /// <inheritdoc />
 181    public async Task<IEnumerable<MediaSegmentDto>> GetSegmentsAsync(BaseItem? item, IEnumerable<MediaSegmentType>? type
 182    {
 183        if (item is null)
 184        {
 185            _logger.LogError("Tried to request segments for an invalid item");
 186            return [];
 187        }
 188
 189        using var db = await _dbProvider.CreateDbContextAsync().ConfigureAwait(false);
 190
 191        var query = db.MediaSegments
 192            .Where(e => e.ItemId.Equals(item.Id));
 193
 194        if (typeFilter is not null)
 195        {
 196            query = query.Where(e => typeFilter.Contains(e.Type));
 197        }
 198
 199        if (filterByProvider)
 200        {
 201            var providerIds = _segmentProviders
 202                .Where(e => !libraryOptions.DisabledMediaSegmentProviders.Contains(GetProviderId(e.Name)))
 203                .Select(f => GetProviderId(f.Name))
 204                .ToArray();
 205            if (providerIds.Length == 0)
 206            {
 207                return [];
 208            }
 209
 210            query = query.Where(e => providerIds.Contains(e.SegmentProviderId));
 211        }
 212
 213        return query
 214            .OrderBy(e => e.StartTicks)
 215            .AsNoTracking()
 216            .AsEnumerable()
 217            .Select(Map)
 218            .ToArray();
 219    }
 220
 221    private static MediaSegmentDto Map(MediaSegment segment)
 222    {
 0223        return new MediaSegmentDto()
 0224        {
 0225            Id = segment.Id,
 0226            EndTicks = segment.EndTicks,
 0227            ItemId = segment.ItemId,
 0228            StartTicks = segment.StartTicks,
 0229            Type = segment.Type
 0230        };
 231    }
 232
 233    private static MediaSegment Map(MediaSegmentDto segment, string segmentProviderId)
 234    {
 0235        return new MediaSegment()
 0236        {
 0237            Id = segment.Id,
 0238            EndTicks = segment.EndTicks,
 0239            ItemId = segment.ItemId,
 0240            StartTicks = segment.StartTicks,
 0241            Type = segment.Type,
 0242            SegmentProviderId = segmentProviderId
 0243        };
 244    }
 245
 246    /// <inheritdoc />
 247    public bool HasSegments(Guid itemId)
 248    {
 0249        using var db = _dbProvider.CreateDbContext();
 0250        return db.MediaSegments.Any(e => e.ItemId.Equals(itemId));
 0251    }
 252
 253    /// <inheritdoc/>
 254    public bool IsTypeSupported(BaseItem baseItem)
 255    {
 0256        return baseItem.MediaType is Data.Enums.MediaType.Video or Data.Enums.MediaType.Audio;
 257    }
 258
 259    /// <inheritdoc/>
 260    public IEnumerable<(string Name, string Id)> GetSupportedProviders(BaseItem item)
 261    {
 0262        if (item is not (Video or Audio))
 263        {
 0264            return [];
 265        }
 266
 0267        return _segmentProviders
 0268            .Select(p => (p.Name, GetProviderId(p.Name)));
 269    }
 270
 271    private string GetProviderId(string name)
 0272        => name.ToLowerInvariant()
 0273            .GetMD5()
 0274            .ToString("N", CultureInfo.InvariantCulture);
 275}
Generated by: ReportGenerator 5.4.11.0
9/15/2025 - 12:10:57 AM
GitHub | reportgenerator.io

Methods/Properties

.ctor(Microsoft.Extensions.Logging.ILogger`1<Jellyfin.Server.Implementations.MediaSegments.MediaSegmentManager>,Microsoft.EntityFrameworkCore.IDbContextFactory`1<Jellyfin.Database.Implementations.JellyfinDbContext>,System.Collections.Generic.IEnumerable`1<MediaBrowser.Controller.MediaSegments.IMediaSegmentProvider>)
Map(Jellyfin.Database.Implementations.Entities.MediaSegment)
Map(MediaBrowser.Model.MediaSegments.MediaSegmentDto,System.String)
HasSegments(System.Guid)
IsTypeSupported(MediaBrowser.Controller.Entities.BaseItem)
GetSupportedProviders(MediaBrowser.Controller.Entities.BaseItem)
GetProviderId(System.String)