using System;
using System.Collections.Generic;
using System.Collections.ObjectModel;
using System.Threading;
using System.Threading.Tasks;
using MediaBrowser.Model.Tasks;
using Microsoft.Extensions.Logging;
namespace ConfusedPolarBear.Plugin.IntroSkipper;
///
/// Fingerprint all queued episodes at the set time.
///
public class FingerprinterTask : IScheduledTask {
private readonly ILogger _logger;
///
/// Minimum time (in seconds) for a contiguous time range to be considered an introduction.
///
private const int MINIMUM_INTRO_DURATION = 18;
///
/// Maximum number of bits (out of 32 total) that can be different between segments before they are considered dissimilar.
///
private const double MAXIMUM_DIFFERENCES = 5;
///
/// Maximum time permitted between timestamps before they are considered non-contiguous.
///
private const double MAXIMUM_DISTANCE = 3.25;
///
/// Seconds of audio in one number from the fingerprint. Defined by Chromaprint.
///
private const double SAMPLES_TO_SECONDS = 0.128;
///
/// Constructor.
///
public FingerprinterTask(ILogger logger)
{
_logger = logger;
}
///
/// Task name.
///
public string Name => "Analyze episodes";
///
/// Task category.
///
public string Category => "Intro Skipper";
///
/// Task description.
///
public string Description => "Analyzes the audio of all television episodes to find introduction sequences.";
///
/// Key.
///
public string Key => "CPBIntroSkipperRunFingerprinter";
///
/// Analyze all episodes in the queue.
///
/// Progress.
/// Cancellation token.
public Task ExecuteAsync(IProgress progress, CancellationToken cancellationToken)
{
var queue = Plugin.Instance!.AnalysisQueue;
var totalProcessed = 0;
foreach (var season in queue) {
var first = season.Value[0];
// Don't analyze seasons with <= 1 episode or specials
if (season.Value.Count <= 1 || first.SeasonNumber == 0)
{
continue;
}
_logger.LogInformation(
"Analyzing {Count} episodes from {Name} season {Season}",
season.Value.Count,
first.SeriesName,
first.SeasonNumber);
// Ensure there are an even number of episodes
var episodes = season.Value;
if (episodes.Count % 2 != 0) {
episodes.Add(episodes[episodes.Count - 2]);
}
// Analyze each pair of episodes in the current season
var everFoundIntro = false;
var failures = 0;
for (var i = 0; i < episodes.Count; i += 2)
{
if (cancellationToken.IsCancellationRequested)
{
break;
}
var lhs = episodes[i];
var rhs = episodes[i+1];
// TODO: make configurable
if (!everFoundIntro && failures >= 6)
{
_logger.LogWarning(
"Failed to find an introduction in {Series} season {Season}",
lhs.SeriesName,
lhs.SeasonNumber);
break;
}
// FIXME: add retry logic
var alreadyDone = Plugin.Instance!.Intros;
if (alreadyDone.ContainsKey(lhs.EpisodeId) && alreadyDone.ContainsKey(rhs.EpisodeId))
{
_logger.LogDebug(
"Episodes {LHS} and {RHS} have both already been fingerprinted",
lhs.EpisodeId,
rhs.EpisodeId);
continue;
}
try
{
_logger.LogDebug("Analyzing {LHS} and {RHS}", lhs.Path, rhs.Path);
if (FingerprintEpisodes(lhs, rhs))
{
everFoundIntro = true;
}
else
{
failures += 2;
}
}
catch (FingerprintException ex)
{
_logger.LogError("Caught fingerprint error: {Ex}", ex);
}
finally
{
totalProcessed += 2;
progress.Report((totalProcessed * 100) / Plugin.Instance!.TotalQueued);
}
}
Plugin.Instance!.SaveTimestamps();
if (cancellationToken.IsCancellationRequested)
{
break;
}
}
return Task.CompletedTask;
}
///
/// Analyze two episodes to find an introduction sequence shared between them.
///
/// First episode to analyze.
/// Second episode to analyze.
/// true if an intro was found in both episodes, otherwise false.
private bool FingerprintEpisodes(QueuedEpisode lhsEpisode, QueuedEpisode rhsEpisode)
{
var lhs = FPCalc.Fingerprint(lhsEpisode);
var rhs = FPCalc.Fingerprint(rhsEpisode);
var lhsRanges = new List();
var rhsRanges = new List();
// Compare all elements of the shortest fingerprint to the other fingerprint.
var limit = Math.Min(lhs.Count, rhs.Count);
// First, test if an intro can be found within the first 5 seconds of the episodes (±5/0.128 = ±40 samples).
var (lhsContiguous, rhsContiguous) = shiftEpisodes(lhs, rhs, -40, 40);
lhsRanges.AddRange(lhsContiguous);
rhsRanges.AddRange(rhsContiguous);
// If no valid ranges were found, re-analyze the episodes considering all possible shifts.
if (lhsRanges.Count == 0)
{
_logger.LogDebug("using full scan");
(lhsContiguous, rhsContiguous) = shiftEpisodes(lhs, rhs, -1 * limit, limit);
lhsRanges.AddRange(lhsContiguous);
rhsRanges.AddRange(rhsContiguous);
}
else
{
_logger.LogDebug("intro found with quick scan");
}
if (lhsRanges.Count == 0)
{
_logger.LogDebug(
"Unable to find a shared introduction sequence between {LHS} and {RHS}",
lhsEpisode.Path,
rhsEpisode.Path);
// TODO: if an episode fails but others in the season succeed, reanalyze it against two that succeeded.
// TODO: is this the optimal way to indicate that an intro couldn't be found?
// the goal here is to not waste time every task run reprocessing episodes that we know will fail.
storeIntro(lhsEpisode.EpisodeId, 0, 0);
storeIntro(rhsEpisode.EpisodeId, 0, 0);
return false;
}
// After comparing both episodes at all possible shift positions, store the longest time range as the intro.
lhsRanges.Sort();
rhsRanges.Sort();
var lhsIntro = lhsRanges[0];
var rhsIntro = rhsRanges[0];
// If the intro starts early in the episode, move it to the beginning.
if (lhsIntro.Start <= 5)
{
lhsIntro.Start = 0;
}
if (rhsIntro.Start <= 5)
{
rhsIntro.Start = 0;
}
storeIntro(lhsEpisode.EpisodeId, lhsIntro.Start, lhsIntro.End);
storeIntro(rhsEpisode.EpisodeId, rhsIntro.Start, rhsIntro.End);
return true;
}
///
/// Shifts episodes through the range of provided shift amounts and returns discovered contiguous time ranges.
///
/// First episode fingerprint.
/// Second episode fingerprint.
/// Lower end of the shift range.
/// Upper end of the shift range.
private static (List, List) shiftEpisodes(
ReadOnlyCollection lhs,
ReadOnlyCollection rhs,
int lower,
int upper
) {
var lhsRanges = new List();
var rhsRanges = new List();
for (int amount = lower; amount <= upper; amount++)
{
var (lRange, rRange) = findContiguous(lhs, rhs, amount);
if (lRange.End == 0 && rRange.End == 0)
{
continue;
}
lhsRanges.Add(lRange);
rhsRanges.Add(rRange);
}
return (lhsRanges, rhsRanges);
}
///
/// Finds the longest contiguous region of similar audio between two fingerprints using the provided shift amount.
///
/// First fingerprint to compare.
/// Second fingerprint to compare.
/// Amount to shift one fingerprint by.
private static (TimeRange, TimeRange) findContiguous(
ReadOnlyCollection lhs,
ReadOnlyCollection rhs,
int shiftAmount
) {
var leftOffset = 0;
var rightOffset = 0;
// Calculate the offsets for the left and right hand sides.
if (shiftAmount < 0) {
leftOffset -= shiftAmount;
} else {
rightOffset += shiftAmount;
}
// Store similar times for both LHS and RHS.
var lhsTimes = new List();
var rhsTimes = new List();
var upperLimit = Math.Min(lhs.Count, rhs.Count) - Math.Abs(shiftAmount);
// XOR all elements in LHS and RHS, using the shift amount from above.
for (var i = 0; i < upperLimit; i++) {
// XOR both samples at the current position.
var lhsPosition = i + leftOffset;
var rhsPosition = i + rightOffset;
var diff = lhs[lhsPosition] ^ rhs[rhsPosition];
// If the difference between the samples is small (< 5/32), flag both times as similar.
if (countBits(diff) > MAXIMUM_DIFFERENCES)
{
continue;
}
var lhsTime = lhsPosition * SAMPLES_TO_SECONDS;
var rhsTime = rhsPosition * SAMPLES_TO_SECONDS;
lhsTimes.Add(lhsTime);
rhsTimes.Add(rhsTime);
}
// Ensure the last timestamp is checked
lhsTimes.Add(Double.MaxValue);
rhsTimes.Add(Double.MaxValue);
// Now that both fingerprints have been compared at this shift, see if there's a contiguous time range.
var lContiguous = TimeRangeHelpers.FindContiguous(lhsTimes.ToArray(), MAXIMUM_DISTANCE);
if (lContiguous is null || lContiguous.Duration < MINIMUM_INTRO_DURATION)
{
return (new TimeRange(), new TimeRange());
}
// Since LHS had a contiguous time range, RHS must have one also.
var rContiguous = TimeRangeHelpers.FindContiguous(rhsTimes.ToArray(), MAXIMUM_DISTANCE)!;
// Tweak the end timestamps just a bit to ensure as little content as possible is skipped over.
if (lContiguous.Duration >= 90)
{
lContiguous.End -= 6;
rContiguous.End -= 6;
}
else if (lContiguous.Duration >= 35)
{
lContiguous.End -= 3;
rContiguous.End -= 3;
}
return (lContiguous, rContiguous);
}
private static void storeIntro(Guid episode, double introStart, double introEnd)
{
// Recommend that the skip button appears 5 seconds ahead of the intro
// and that it disappears 10 seconds after the intro begins.
Plugin.Instance!.Intros[episode] = new Intro()
{
EpisodeId = episode,
Valid = introEnd > 0,
IntroStart = introStart,
IntroEnd = introEnd,
ShowSkipPromptAt = Math.Max(0, introStart - 5),
HideSkipPromptAt = introStart + 10
};
}
private static int countBits(uint number) {
var count = 0;
for (var i = 0; i < 32; i++) {
var low = (number >> i) & 1;
if (low == 1) {
count++;
}
}
return count;
}
///
/// Get task triggers.
///
public IEnumerable GetDefaultTriggers()
{
return new[]
{
new TaskTriggerInfo
{
Type = TaskTriggerInfo.TriggerDaily,
TimeOfDayTicks = TimeSpan.FromDays(24).Ticks
}
};
}
}