using System;
using System.Collections.Generic;
using System.Drawing;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace Tango.RemoteDesktop
{
    /// <summary>
    /// Represents a bitmap comparison engine which returns a difference object of type <see cref="TFrame"/> between a previous and current bitmaps.
    /// </summary>
    /// <typeparam name="TFrame">Type of frame</typeparam>
    public interface IBitmapComparer<TFrame> where TFrame : IFrame
    {
        /// <summary>
        /// Creates the difference result from two bitmaps.
        /// </summary>
        /// <param name="previousBitmap">The previous bitmap.</param>
        /// <param name="currentBitmap">The current bitmap.</param>
        /// <returns></returns>
        BitmapComparerResult<TFrame> CreateDifference(Bitmap previousBitmap, Bitmap currentBitmap);

        /// <summary>
        /// When max number of differences reached, the comparer will immediately return the current difference frame.
        /// This should enforce the screen capture engine to report 'No Difference Available'.
        /// The value of null (default) means infinite.
        /// </summary>
        long? MaxDifferencesThrow { get; set; }
    }
}