/****************************************************************************
**
** Copyright (C) 2016 Research In Motion
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or (at your option) the GNU General
** Public license version 3 or any later version approved by the KDE Free
** Qt Foundation. The licenses are as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-2.0.html and
** https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/
#include "mmrendererutil.h"

#include <QDebug>
#include <QDir>
#include <QFile>
#include <QJsonDocument>
#include <QJsonObject>
#include <QJsonValue>
#include <QMutex>
#include <QMutex>
#include <QString>
#include <QXmlStreamReader>

#include <mm/renderer.h>

QT_BEGIN_NAMESPACE

struct MmError {
    int errorCode;
    const char *name;
};

#define MM_ERROR_ENTRY(error) { error, #error }
static const MmError mmErrors[] = {
    MM_ERROR_ENTRY(MMR_ERROR_NONE),
    MM_ERROR_ENTRY(MMR_ERROR_UNKNOWN ),
    MM_ERROR_ENTRY(MMR_ERROR_INVALID_PARAMETER ),
    MM_ERROR_ENTRY(MMR_ERROR_INVALID_STATE),
    MM_ERROR_ENTRY(MMR_ERROR_UNSUPPORTED_VALUE),
    MM_ERROR_ENTRY(MMR_ERROR_UNSUPPORTED_MEDIA_TYPE),
    MM_ERROR_ENTRY(MMR_ERROR_MEDIA_PROTECTED),
    MM_ERROR_ENTRY(MMR_ERROR_UNSUPPORTED_OPERATION),
    MM_ERROR_ENTRY(MMR_ERROR_READ),
    MM_ERROR_ENTRY(MMR_ERROR_WRITE),
    MM_ERROR_ENTRY(MMR_ERROR_MEDIA_UNAVAILABLE),
    MM_ERROR_ENTRY(MMR_ERROR_MEDIA_CORRUPTED),
    MM_ERROR_ENTRY(MMR_ERROR_OUTPUT_UNAVAILABLE),
    MM_ERROR_ENTRY(MMR_ERROR_NO_MEMORY),
    MM_ERROR_ENTRY(MMR_ERROR_RESOURCE_UNAVAILABLE),
    MM_ERROR_ENTRY(MMR_ERROR_MEDIA_DRM_NO_RIGHTS),
    MM_ERROR_ENTRY(MMR_ERROR_DRM_CORRUPTED_DATA_STORE),
    MM_ERROR_ENTRY(MMR_ERROR_DRM_OUTPUT_PROTECTION),
    MM_ERROR_ENTRY(MMR_ERROR_DRM_OPL_HDMI),
    MM_ERROR_ENTRY(MMR_ERROR_DRM_OPL_DISPLAYPORT),
    MM_ERROR_ENTRY(MMR_ERROR_DRM_OPL_DVI),
    MM_ERROR_ENTRY(MMR_ERROR_DRM_OPL_ANALOG_VIDEO),
    MM_ERROR_ENTRY(MMR_ERROR_DRM_OPL_ANALOG_AUDIO),
    MM_ERROR_ENTRY(MMR_ERROR_DRM_OPL_TOSLINK),
    MM_ERROR_ENTRY(MMR_ERROR_DRM_OPL_SPDIF),
    MM_ERROR_ENTRY(MMR_ERROR_DRM_OPL_BLUETOOTH),
    MM_ERROR_ENTRY(MMR_ERROR_DRM_OPL_WIRELESSHD),
};
static const unsigned int numMmErrors = sizeof(mmErrors) / sizeof(MmError);

static QBasicMutex roleMapMutex;
static bool roleMapInitialized = false;
static QString roleMap[QAudio::GameRole + 1];

template <typename T, size_t N>
constexpr size_t countof(T (&)[N])
{
    return N;
}

constexpr bool inBounds(QAudio::Role r)
{
    return r >= 0 && r < countof(roleMap);
}

QString keyValueMapsLocation()
{
    QByteArray qtKeyValueMaps = qgetenv("QT_KEY_VALUE_MAPS");
    if (qtKeyValueMaps.isNull())
        return QStringLiteral("/etc/qt/keyvaluemaps");
    else
        return qtKeyValueMaps;
}

QJsonObject loadMapObject(const QString &keyValueMapPath)
{
    QFile mapFile(keyValueMapsLocation() + keyValueMapPath);
    if (mapFile.open(QIODevice::ReadOnly)) {
        QByteArray mapFileContents = mapFile.readAll();
        QJsonDocument mapDocument = QJsonDocument::fromJson(mapFileContents);
        if (mapDocument.isObject()) {
            QJsonObject mapObject = mapDocument.object();
            return mapObject;
        }
    }
    return QJsonObject();
}

static void loadRoleMap()
{
    QMutexLocker locker(&roleMapMutex);

    if (!roleMapInitialized) {
        QJsonObject mapObject = loadMapObject("/QAudio/Role.json");
        if (!mapObject.isEmpty()) {
            // Wrapping the loads in a switch like this ensures that anyone adding
            // a new enumerator will be notified that this code must be updated. A
            // compile error will occur because the enumerator is missing from the
            // switch.  A compile error will also occur if the enumerator used to
            // size the mapping table isn't updated when a new enumerator is added.
            // One or more enumerators will be outside the bounds of the array when
            // the wrong enumerator is used to size the array.
            //
            // The code loads a mapping for each enumerator because role is set
            // to UnknownRole and all the cases drop through to the next case.
#pragma GCC diagnostic push
#pragma GCC diagnostic error "-Wswitch"
#define loadRoleMapping(r)                                                             \
    case QAudio::r:                                                                    \
        static_assert(inBounds(QAudio::r), #r " out-of-bounds."                        \
            "  Do you need to change the enumerator used to size the mapping table"    \
            " because you added new QAudio::Role enumerators?");                       \
            roleMap[QAudio::r] = mapObject.value(QLatin1String(#r)).toString();

            QAudio::Role role = QAudio::UnknownRole;
            switch (role) {
                loadRoleMapping(UnknownRole);
                loadRoleMapping(MusicRole);
                loadRoleMapping(VideoRole);
                loadRoleMapping(VoiceCommunicationRole);
                loadRoleMapping(AlarmRole);
                loadRoleMapping(NotificationRole);
                loadRoleMapping(RingtoneRole);
                loadRoleMapping(AccessibilityRole);
                loadRoleMapping(SonificationRole);
                loadRoleMapping(GameRole);
            }
#undef loadRoleMapping
#pragma GCC diagnostic pop
        }

        roleMapInitialized = true;
    }
}

QString mmErrorMessage(const QString &msg, mmr_context_t *context, int *errorCode)
{
    const mmr_error_info_t * const mmError = mmr_error_info(context);

    if (errorCode)
        *errorCode = mmError->error_code;

    if (mmError->error_code < numMmErrors) {
        return QString("%1: %2 (code %3)").arg(msg).arg(mmErrors[mmError->error_code].name)
                                          .arg(mmError->error_code);
    } else {
        return QString("%1: Unknown error code %2").arg(msg).arg(mmError->error_code);
    }
}

bool checkForDrmPermission()
{
    QDir sandboxDir = QDir::home(); // always returns 'data' directory
    sandboxDir.cdUp(); // change to app sandbox directory

    QFile file(sandboxDir.filePath("app/native/bar-descriptor.xml"));
    if (!file.open(QIODevice::ReadOnly)) {
        qWarning() << "checkForDrmPermission: Unable to open bar-descriptor.xml";
        return false;
    }

    QXmlStreamReader reader(&file);
    while (!reader.atEnd()) {
        reader.readNextStartElement();
        if (reader.name() == QLatin1String("action")
            || reader.name() == QLatin1String("permission")) {
            if (reader.readElementText().trimmed() == QLatin1String("access_protected_media"))
                return true;
        }
    }

    return false;
}

QString qnxAudioType(QAudio::Role role)
{
    loadRoleMap();

    if (role >= 0 && role < countof(roleMap))
        return roleMap[role];
    else
        return QString();
}

QList<QAudio::Role> qnxSupportedAudioRoles()
{
    loadRoleMap();

    QList<QAudio::Role> result;
    for (size_t i = 0; i < countof(roleMap); ++i) {
        if (!roleMap[i].isEmpty() || (i == QAudio::UnknownRole))
            result.append(static_cast<QAudio::Role>(i));
    }

    return result;
}

QT_END_NAMESPACE
