ScreenCapture.NET/ScreenCapture.NET/Model/CaptureZone.cs

// ReSharper disable MemberCanBePrivate.Global

using System;

namespace ScreenCapture.NET;

/// <summary>
/// Represents a duplicated region on the screen.
/// </summary>
public sealed class CaptureZone
{
    #region Properties & Fields

    /// <summary>
    /// Gets the unique id of this <see cref="CaptureZone"/>.
    /// </summary>
    public int Id { get; }

    /// <summary>
    /// Gets the x-location of the region on the screen.
    /// </summary>
    public int X { get; internal set; }

    /// <summary>
    /// Gets the y-location of the region on the screen.
    /// </summary>
    public int Y { get; internal set; }

    /// <summary>
    /// Gets the width of the captured region.
    /// </summary>
    public int Width { get; internal set; }

    /// <summary>
    /// Gets the height of the captured region.
    /// </summary>
    public int Height { get; internal set; }

    /// <summary>
    /// Gets the level of downscaling applied to the image of this region before copying to local memory. The calculation is (width and height)/2^downscaleLevel.
    /// </summary>
    public int DownscaleLevel { get; internal set; }

    /// <summary>
    /// Gets the original width of the region (this equals <see cref="Width"/> if <see cref="DownscaleLevel"/> is 0).
    /// </summary>
    public int UnscaledWidth { get; internal set; }

    /// <summary>
    /// Gets the original height of the region (this equals <see cref="Height"/> if <see cref="DownscaleLevel"/> is 0).
    /// </summary>
    public int UnscaledHeight { get; internal set; }

    /// <summary>
    /// Gets the amount of bytes per pixel in the image (most likely 3 [RGB] or 4 [ARGB]).
    /// </summary>
    public int BytesPerPixel { get; }

    /// <summary>
    /// Gets the size in bytes of a row in the region (<see cref="Width"/> * <see cref="BytesPerPixel"/>).
    /// </summary>
    public int Stride => Width * BytesPerPixel;

    /// <summary>
    /// Gets the buffer containing the image data. Format depends on the specific capture but is most likely BGRA32.
    /// </summary>
    public byte[] Buffer { get; internal set; }

    /// <summary>
    /// Gets the config for black-bar detection.
    /// </summary>
    public BlackBarDetection BlackBars { get; }

    /// <summary>
    /// Gets or sets if the <see cref="CaptureZone"/> should be automatically updated on every captured frame.
    /// </summary>
    public bool AutoUpdate { get; set; } = true;

    /// <summary>
    /// Gets if an update for the <see cref="CaptureZone"/> is requested on the next captured frame.
    /// </summary>
    public bool IsUpdateRequested { get; private set; }

    #endregion

    #region Events

    /// <summary>
    /// Occurs when the <see cref="CaptureZone"/> is updated.
    /// </summary>
    public event EventHandler? Updated;

    #endregion

    #region Constructors

    /// <summary>
    /// Initializes a new instance of the <see cref="CaptureZone"/> class.
    /// </summary>
    /// <param name="id">The unique id of this <see cref="CaptureZone"/>.</param>
    /// <param name="x">The x-location of the region on the screen.</param>
    /// <param name="y">The y-location of the region on the screen.</param>
    /// <param name="width">The width of the region on the screen.</param>
    /// <param name="height">The height of the region on the screen.</param>
    /// <param name="downscaleLevel">The level of downscaling applied to the image of this region before copying to local memory.</param>
    /// <param name="unscaledWidth">The original width of the region.</param>
    /// <param name="unscaledHeight">The original height of the region</param>
    /// <param name="buffer">The buffer containing the image data.</param>
    internal CaptureZone(int id, int x, int y, int width, int height, int bytesPerPixel, int downscaleLevel, int unscaledWidth, int unscaledHeight, byte[] buffer)
    {
        this.Id = id;
        this.X = x;
        this.Y = y;
        this.Width = width;
        this.Height = height;
        this.BytesPerPixel = bytesPerPixel;
        this.UnscaledWidth = unscaledWidth;
        this.UnscaledHeight = unscaledHeight;
        this.DownscaleLevel = downscaleLevel;
        this.Buffer = buffer;

        BlackBars = new BlackBarDetection(this);
    }

    #endregion

    #region Methods

    /// <summary>
    /// Requests to update this <see cref="CaptureZone"/> when the next frame is captured.
    /// Only necessary if <see cref="AutoUpdate"/> is set to <c>false</c>.
    /// </summary>
    public void RequestUpdate() => IsUpdateRequested = true;

    /// <summary>
    /// Marks the <see cref="CaptureZone"/> as updated.
    /// WARNING: This should not be called outside of an <see cref="IScreenCapture"/>!
    /// </summary>
    public void SetUpdated()
    {
        IsUpdateRequested = false;
        BlackBars.InvalidateCache();

        Updated?.Invoke(this, new EventArgs());
    }

    /// <summary>
    /// Determines whether this <see cref="CaptureZone"/> equals the given one.
    /// </summary>
    /// <param name="other">The <see cref="CaptureZone"/> to compare.</param>
    /// <returns><c>true</c> if the specified object is equal to the current object; otherwise, <c>false</c>.</returns>
    public bool Equals(CaptureZone other) => Id == other.Id;

    /// <inheritdoc />
    public override bool Equals(object? obj) => obj is CaptureZone other && Equals(other);

    /// <inheritdoc />
    public override int GetHashCode() => Id;

    #endregion
}