/*
    SPDX-FileCopyrightText: 2017 Nicolas Carion
    SPDX-License-Identifier: GPL-3.0-only OR LicenseRef-KDE-Accepted-GPL
*/

#pragma once

#include "assets/abstractassetsrepository.hpp"
#include "definitions.h"
#include <memory>
#include <mutex>

/** @class TransitionsRepository
    @brief This class stores all the transitions that can be added by the user.
    You can query any transitions based on its name.
    Note that this class is a Singleton
 */
class TransitionsRepository : public AbstractAssetsRepository<AssetListType::AssetType>
{

public:
    friend class TransitionListWidget;

    /** @brief Returns the instance of the Singleton */
    static std::unique_ptr<TransitionsRepository> &get();

    /** @brief Creates and return an instance of a transition given its id.
     */
    std::unique_ptr<Mlt::Transition> getTransition(const QString &transitionId) const;

    /** @brief returns true if the transition corresponding to \@transitionId is a composition*/
    bool isComposition(const QString &transitionId) const;

    /** @brief returns true if the transition corresponding to \@transitionId is a luma file*/
    bool isLuma(const QString &transitionId) const;

    /** @brief returns true if the transition corresponding to \@transitionId is audio*/
    bool isAudio(const QString &transitionId) const;

    /** @brief Returns the id of the transition to be used for compositing */
    const QString getCompositingTransition();

    /** @brief Manually adda luma file */
    void addLuma(const QString &name, const QString &path);

    /** @brief Ensure favorite transitions really exist */
    void checkFavorites();

protected:
    // Constructor is protected because class is a Singleton
    TransitionsRepository();

    /** @brief Retrieves the list of all available effects from Mlt*/
    Mlt::Properties *retrieveListFromMlt() const override;

    /** @brief Retrieves additional info about effects from a custom XML file
       The resulting assets are stored in customAssets
     */
    void parseCustomAssetFile(const QString &file_name, std::unordered_map<QString, Info> &customAssets) const override;

    /** @brief Returns the paths where the custom transitions' descriptions are stored */
    QStringList assetDirs() const override;

    /** @brief Returns the path to the compositions that will be displayed*/
    QStringList assetIncludedPath() const override;

    /** @brief Returns the path to the compositions that will be hidden*/
    QStringList assetExcludedPath() const override;

    /** @brief Returns the path to the compositions that will be enabled but hidden*/
    QStringList assetHiddenPath() const override;

    /** @brief Returns the path to the effects' preferred list*/
    QString assetPreferredListPath() const override;

    void parseType(Mlt::Properties *metadata, Info &res) override;

    /** @brief Returns the metadata associated with the given asset*/
    Mlt::Properties *getMetadata(const QString &assetId) const override;

    /** @brief Returns all transitions that can be represented as Single Track Transitions*/
    static QSet<QString> getSingleTrackTransitions();

    static std::unique_ptr<TransitionsRepository> instance;
    static std::once_flag m_onceFlag; // flag to create the repository only once;
};
