/*
 * Copyright (C) 2014 Sune Vuorela <sune@vuorela.dk>
 * Copyright (C) 2016-2024 Matthias Klumpp <matthias@tenstral.net>
 *
 * Licensed under the GNU Lesser General Public License Version 2.1
 *
 * This library is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 2.1 of the license, or
 * (at your option) any later version.
 *
 * This library 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this library.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef APPSTREAMQT_SCREENSHOT_H
#define APPSTREAMQT_SCREENSHOT_H

#include <QObject>
#include <QSharedDataPointer>
#include <optional>
#include "appstreamqt_export.h"

#include <QString>
#include <QList>

struct _AsScreenshot;
namespace AppStream
{

class Image;
class Video;
class ScreenshotData;

/**
 * Class to represent a reference to a screenshot
 * A screenshot might appear in various resolutions
 */

class APPSTREAMQT_EXPORT Screenshot
{
    Q_GADGET

public:
    enum Kind {
        KindUnknown,
        KindDefault,
        KindExtra
    };
    Q_ENUM(Kind)

    enum MediaKind {
        MediaKindUnknown,
        MediaKindImage,
        MediaKindVideo
    };
    Q_ENUM(MediaKind)

    static Kind stringToKind(const QString &kindString);
    static QString kindToString(Kind kind);

    Screenshot();
    Screenshot(_AsScreenshot *scr);
    Screenshot(const Screenshot &other);
    ~Screenshot();
    Screenshot &operator=(const Screenshot &other);

    /**
     * \returns the internally stored AsScreenshot
     */
    _AsScreenshot *cPtr() const;

    /**
     * \return true if it is the default screenshot
     * A \ref Component should in general only have one default
     */
    bool isDefault() const;

    /**
     * \return the kind of this screenshot (default or extra)
     */
    Kind kind() const;
    void setKind(Kind kind);

    /**
     * \return true if this screenshot is valid (has at least one image or video)
     */
    bool isValid() const;

    /**
     * \return the kind of media (image or video) that this screenshot consists of
     */
    MediaKind mediaKind() const;

    /**
     * \return the language-specific images for this screenshot
     */
    QList<AppStream::Image> images() const;

    /**
     * \return all images for this screenshot
     */
    QList<AppStream::Image> imagesAll() const;

    /**
     * \return retrieve an image that roughly matches the selected size constraints
     */
    std::optional<AppStream::Image> image(uint width, uint height, uint scale) const;

    void addImage(const AppStream::Image &image);
    void clearImages();

    /**
     * \return the language-specific videos for this screenshot
     */
    QList<AppStream::Video> videos() const;

    /**
     * \return all videos for this screenshot
     */
    QList<AppStream::Video> videosAll() const;

    void addVideo(const AppStream::Video &video);

    /**
     * \return caption for this image or a null QString if no caption
     */
    QString caption() const;
    void setCaption(const QString &caption, const QString &lang = {});

    /**
     * \return GUI environment ID this screenshot was recorded in.
     */
    QString environment() const;
    void setEnvironment(const QString &guiEnvId);

private:
    QSharedDataPointer<ScreenshotData> d;
};
}

APPSTREAMQT_EXPORT QDebug operator<<(QDebug s, const AppStream::Screenshot &screenshot);

#endif // APPSTREAMQT_SCREENSHOT_H
