/*
 * Copyright (C) 2023-2025  Yomitan Authors
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */

import type {TextToSpeechAudio} from '../../ext/js/media/text-to-speech-audio';
import type * as Audio from './audio';
import type * as AudioDownloader from './audio-downloader';
import type * as Settings from './settings';

export type CacheItem = {
    sourceMap: Map<number, CachedInfoList>;
    primaryCardAudio: PrimaryCardAudio | null;
};

export type CachedInfoList = {
    infoListPromise: Promise<AudioInfoList>;
    infoList: AudioInfoList | null;
};

export type AudioInfoList = AudioInfoListItem[];

export type AudioInfoListItem = {
    info: AudioDownloader.Info;
    audioPromise: Promise<GenericAudio> | null;
    audioResolved: boolean;
    audio: GenericAudio | null;
};

export type PrimaryCardAudio = {
    index: number;
    subIndex: number | null;
};

export type SourceInfo = {
    source: AudioSource | null;
    subIndex: number | null;
};

export type AudioSource = {
    index: number;
    type: Settings.AudioSourceType;
    url: string;
    voice: string;
    isInOptions: boolean;
    downloadable: boolean;
    name: string;
    nameIndex: number;
    nameUnique: boolean;
};

export type AudioSourceShort = {
    type: Settings.AudioSourceType;
    url: string;
    voice: string;
};

export type AudioMediaOptions = {
    sources: Audio.AudioSourceInfo[];
    preferredAudioIndex: number | null;
    enableDefaultAudioSources: boolean;
};

export type PlayAudioResult = {
    audio: GenericAudio | null;
    source: AudioSource | null;
    subIndex: number;
    valid: boolean;
};

export type TermAudio = {
    audio: GenericAudio;
    source: AudioSource;
    subIndex: number;
};

export type CreateAudioResult = {
    audio: GenericAudio | null;
    index: number;
    cacheUpdated: boolean;
};

export type GenericAudio = HTMLAudioElement | TextToSpeechAudio;

export type MenuItemEntry = {
    valid: boolean | null;
    index: number | null;
    name: string | null;
};