import type {VlcMeta} from "vlc-client/dist/Types.js";
import type {PollingOptions} from "../common.ts";
import type {CommonSourceConfig, CommonSourceData, CommonSourceOptions} from "./index.ts";

export interface VLCData extends CommonSourceData, PollingOptions {
    /**
     * URL:PORT of the VLC server to connect to
     *
     * To use this you must have the Web (http) interface module enabled and a password set
     *
     * @examples ["localhost:8080"]
     * @default "localhost:8080"
     * */
    url?: string

    /**
     * Password for the server
     * */
    password: string

}

export interface VLCSourceOptions extends CommonSourceOptions {
    /** A list of regular expressions to use to extract metadata (title, album, artist) from a filename
     *
     * Used when VLC reports only the filename for the current audio track
     * */
    filenamePatterns?: string | string[]
    /**
     * Log to DEBUG when a filename-only track is matched or not matched by filenamePatterns
     *
     * @default false
     * */
    logFilenamePatterns?: boolean
    /**
     * Dump all the metadata VLC reports for an audio track to DEBUG.
     *
     * Use this if reporting an issue with VLC not correctly capturing metadata for a track.
     *
     * @default false
     * */
    dumpVlcMetadata?: boolean
}

export interface VLCSourceConfig extends CommonSourceConfig {
    data: VLCData
    options?: VLCSourceOptions
}

export interface VLCSourceAIOConfig extends VLCSourceConfig {
    type: 'vlc'
}

export type PlayerState = 'playing' | 'stopped' | 'paused';

// if not provided the value is an EMPTY STRING or undefined
export interface VlcAudioMeta extends VlcMeta {
    track_id?: string
    date?: string
    description?: string
    album?: string
    genre?: string
    title?: string
    artist?: string
    /** alt for artist */
    Writer?: string
    ALBUMARTIST?: string
    artwork_url?: string
    StreamTitle?: string
    StreamArtist?: string
    StreamAlbum?: string
}
