//
//  AudioInjectorOptions.cpp
//  libraries/audio/src
//
//  Created by Stephen Birarda on 1/2/2014.
//  Copyright 2014 High Fidelity, Inc.
//  Copyright 2023 Overte e.V.
//
//  Distributed under the Apache License, Version 2.0.
//  See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
//  SPDX-License-Identifier: Apache-2.0
//

#include "AudioInjectorOptions.h"

#include <ScriptValueIterator.h>
#include <ScriptValueUtils.h>
#include <ScriptEngine.h>

#include "AudioLogging.h"

AudioInjectorOptions::AudioInjectorOptions() :
    position(0.0f, 0.0f, 0.0f),
    positionSet(true),  // default to legacy behavior
    volume(1.0f),
    loop(false),
    orientation(glm::vec3(0.0f, 0.0f, 0.0f)),
    stereo(false),
    ambisonic(false),
    ignorePenumbra(false),
    localOnly(false),
    secondOffset(0.0f),
    pitch(1.0f)
{
}

ScriptValue injectorOptionsToScriptValue(ScriptEngine* engine, const AudioInjectorOptions& injectorOptions) {
    ScriptValue obj = engine->newObject();
    if (injectorOptions.positionSet) {
        obj.setProperty("position", vec3ToScriptValue(engine, injectorOptions.position));
    }
    obj.setProperty("volume", injectorOptions.volume);
    obj.setProperty("loop", injectorOptions.loop);
    obj.setProperty("orientation", quatToScriptValue(engine, injectorOptions.orientation));
    obj.setProperty("ignorePenumbra", injectorOptions.ignorePenumbra);
    obj.setProperty("localOnly", injectorOptions.localOnly);
    obj.setProperty("secondOffset", injectorOptions.secondOffset);
    obj.setProperty("pitch", injectorOptions.pitch);
    return obj;
}

/*@jsdoc
 * Configures where and how an audio injector plays its audio.
 * @typedef {object} AudioInjector.AudioInjectorOptions
 * @property {Vec3} position=Vec3.ZERO - The position in the domain to play the sound.
 * @property {Quat} orientation=Quat.IDENTITY - The orientation in the domain to play the sound in.
 * @property {number} volume=1.0 - Playback volume, between <code>0.0</code> and <code>1.0</code>.
 * @property {number} pitch=1.0 - Alter the pitch of the sound, within +/- 4 octaves. The value is the relative sample rate to
 *     resample the sound at, range <code>0.0625</code> &ndash; <code>16.0</code>.<br />
 *     A value of <code>0.0625</code> lowers the pitch by 4 octaves.<br />
 *     A value of <code>1.0</code> means there is no change in pitch.<br />
 *     A value of <code>16.0</code> raises the pitch by 4 octaves.
 * @property {boolean} loop=false - If <code>true</code>, the sound is played repeatedly until playback is stopped.
 * @property {number} secondOffset=0 - Starts playback from a specified time (seconds) within the sound file, &ge; 
 *     <code>0</code>.
 * @property {boolean} localOnly=false - If <code>true</code>, the sound is played back locally on the client rather than to
 *     others via the audio mixer.
 * @property {boolean} ignorePenumbra=false - <p class="important">Deprecated: This property is deprecated and will be
 *     removed.</p>
 */
bool injectorOptionsFromScriptValue(const ScriptValue& object, AudioInjectorOptions& injectorOptions) {
    if (!object.isObject()) {
        qWarning() << "Audio injector options is not an object.";
        return false;
    }

    if (injectorOptions.positionSet == false) {
        qWarning() << "Audio injector options: injectorOptionsFromScriptValue() called more than once?";
    }
    injectorOptions.positionSet = false;

    ScriptValueIteratorPointer it(object.newIterator());
    while (it->hasNext()) {
        it->next();

        if (it->name() == "position") {
            vec3FromScriptValue(object.property("position"), injectorOptions.position);
            injectorOptions.positionSet = true;
        } else if (it->name() == "orientation") {
            quatFromScriptValue(object.property("orientation"), injectorOptions.orientation);
        } else if (it->name() == "volume") {
            if (it->value().isNumber()) {
                injectorOptions.volume = it->value().toNumber();
            } else {
                qCWarning(audio) << "Audio injector options: volume is not a number";
            }
        } else if (it->name() == "loop") {
            if (it->value().isBool()) {
                injectorOptions.loop = it->value().toBool();
            } else {
                qCWarning(audio) << "Audio injector options: loop is not a boolean";
            }
        } else if (it->name() == "ignorePenumbra") {
            if (it->value().isBool()) {
                injectorOptions.ignorePenumbra = it->value().toBool();
            } else {
                qCWarning(audio) << "Audio injector options: ignorePenumbra is not a boolean";
            }
        } else if (it->name() == "localOnly") {
            if (it->value().isBool()) {
                injectorOptions.localOnly = it->value().toBool();
            } else {
                qCWarning(audio) << "Audio injector options: localOnly is not a boolean";
            }
        } else if (it->name() == "secondOffset") {
            if (it->value().isNumber()) {
                injectorOptions.secondOffset = it->value().toNumber();
            } else {
                qCWarning(audio) << "Audio injector options: secondOffset is not a number";
            }
        } else if (it->name() == "pitch") {
            if (it->value().isNumber()) {
                injectorOptions.pitch = it->value().toNumber();
            } else {
                qCWarning(audio) << "Audio injector options: pitch is not a number";
            }
        } else {
            qCWarning(audio) << "Unknown audio injector option:" << it->name();
        }
    }
    return true;
}