using System.Collections.ObjectModel;
using System.Text.Json.Serialization;

namespace Jellyfin.Plugin.JRay.Models;

/// <summary>
/// Root object of a scene-actor-extraction "truth" file
/// (schema_version 1, minimal verbosity). See SPEC.md §1.
/// </summary>
/// <remarks>
/// JRay <b>owns</b> this format; the extraction pipeline is its producer and the
/// public server carries a derived envelope. Because three repos ship
/// independently, breaking changes are batched into one coordinated
/// <c>schema_version</c> bump rather than made piecemeal.
///
/// This type is still the v1 shape. JR-002 replaces it: <c>anneal_sec</c> out,
/// an <c>extraction</c> provenance block and a <c>cut</c> block in, and
/// <c>scenes</c> becoming objects that carry belief and identification route.
/// </remarks>
// TRACES: JR-001, JR-002 | SR-003
public class TruthFile
{
    /// <summary>
    /// Gets or sets the schema version of this file.
    /// </summary>
    [JsonPropertyName("schema_version")]
    public int SchemaVersion { get; set; }

    /// <summary>
    /// Gets or sets the source media path at extraction time (informational).
    /// </summary>
    [JsonPropertyName("movie")]
    public string Movie { get; set; } = string.Empty;

    /// <summary>
    /// Gets or sets the sampling rate (frames per second) used during extraction.
    /// </summary>
    [JsonPropertyName("sample_fps")]
    public double SampleFps { get; set; }

    /// <summary>
    /// Gets or sets the gap (seconds) below which consecutive detections were merged into one scene.
    /// </summary>
    [JsonPropertyName("anneal_sec")]
    public double AnnealSec { get; set; }

    /// <summary>
    /// Gets the list of actors detected in the film, each with their on-screen scene windows.
    /// </summary>
    [JsonPropertyName("actors")]
    [JsonObjectCreationHandling(JsonObjectCreationHandling.Populate)]
    public Collection<TruthActor> Actors { get; } = new();
}