/**
 * @file llpanelvoiceeffect.cpp
 * @author Aimee
 * @brief Panel to select Voice Morphs.
 *
 * $LicenseInfo:firstyear=2010&license=viewerlgpl$
 * Second Life Viewer Source Code
 * Copyright (C) 2010, Linden Research, Inc.
 *
 * 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;
 * version 2.1 of the License only.
 *
 * 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, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 *
 * Linden Research, Inc., 945 Battery Street, San Francisco, CA  94111  USA
 * $/LicenseInfo$
 */

#include "llviewerprecompiledheaders.h"

#include "llpanelvoiceeffect.h"

#include "llcombobox.h"
#include "llfloaterreg.h"
#include "llpanel.h"
#include "lltrans.h"
#include "lltransientfloatermgr.h"
#include "llvoiceclient.h"
#include "llweb.h"

static LLPanelInjector<LLPanelVoiceEffect> t_panel_voice_effect("panel_voice_effect");

LLPanelVoiceEffect::LLPanelVoiceEffect()
    : mVoiceEffectCombo(NULL)
{
    mCommitCallbackRegistrar.add("Voice.CommitVoiceEffect", boost::bind(&LLPanelVoiceEffect::onCommitVoiceEffect, this));
}

LLPanelVoiceEffect::~LLPanelVoiceEffect()
{
    LLView* combo_list_view = mVoiceEffectCombo->getChildView("ComboBox");
    LLTransientFloaterMgr::getInstance()->removeControlView(combo_list_view);

    if(LLVoiceClient::instanceExists())
    {
        LLVoiceEffectInterface* effect_interface = LLVoiceClient::instance().getVoiceEffectInterface();
        if (effect_interface)
        {
            effect_interface->removeObserver(this);
        }
    }
}

// virtual
bool LLPanelVoiceEffect::postBuild()
{
    mVoiceEffectCombo = getChild<LLComboBox>("voice_effect");

    // Need to tell LLTransientFloaterMgr about the combo list, otherwise it can't
    // be clicked while in a docked floater as it extends outside the floater area.
    LLView* combo_list_view = mVoiceEffectCombo->getChildView("ComboBox");
    LLTransientFloaterMgr::getInstance()->addControlView(combo_list_view);

    LLVoiceEffectInterface* effect_interface = LLVoiceClient::instance().getVoiceEffectInterface();
    if (effect_interface)
    {
        effect_interface->addObserver(this);
    }

    update(true);

    return true;
}

//////////////////////////////////////////////////////////////////////////
/// PRIVATE SECTION
//////////////////////////////////////////////////////////////////////////

void LLPanelVoiceEffect::onCommitVoiceEffect()
{
    LLVoiceEffectInterface* effect_interface = LLVoiceClient::instance().getVoiceEffectInterface();
    if (!effect_interface)
    {
        mVoiceEffectCombo->setEnabled(false);
        return;
    }

    LLSD value = mVoiceEffectCombo->getValue();
    if (value.asInteger() == PREVIEW_VOICE_EFFECTS)
    {
        // Open the Voice Morph preview floater
        LLFloaterReg::showInstance("voice_effect");
    }
    else if (value.asInteger() == GET_VOICE_EFFECTS)
    {
        // Open the voice morphing info web page
        LLWeb::loadURL(LLTrans::getString("voice_morphing_url"));
    }
    else
    {
        effect_interface->setVoiceEffect(value.asUUID());
    }

    mVoiceEffectCombo->setValue(effect_interface->getVoiceEffect());
}

// virtual
void LLPanelVoiceEffect::onVoiceEffectChanged(bool effect_list_updated)
{
    update(effect_list_updated);
}

void LLPanelVoiceEffect::update(bool list_updated)
{
    if (mVoiceEffectCombo)
    {
        LLVoiceEffectInterface* effect_interface = LLVoiceClient::instance().getVoiceEffectInterface();
        if (!effect_interface) return;
        if (list_updated)
        {
            // Add the default "No Voice Morph" entry.
            mVoiceEffectCombo->removeall();
            mVoiceEffectCombo->add(getString("no_voice_effect"), LLUUID::null);
            mVoiceEffectCombo->addSeparator();

            // Add entries for each Voice Morph.
            const voice_effect_list_t& effect_list = effect_interface->getVoiceEffectList();
            if (!effect_list.empty())
            {
                for (voice_effect_list_t::const_iterator it = effect_list.begin(); it != effect_list.end(); ++it)
                {
                    mVoiceEffectCombo->add(it->first, it->second, ADD_BOTTOM);
                }

                mVoiceEffectCombo->addSeparator();
            }

            // Add the fixed entries to go to the preview floater or marketing page.
            mVoiceEffectCombo->add(getString("preview_voice_effects"), PREVIEW_VOICE_EFFECTS);
            mVoiceEffectCombo->add(getString("get_voice_effects"), GET_VOICE_EFFECTS);
        }

        if (effect_interface && LLVoiceClient::instance().isVoiceWorking())
        {
            // Select the current Voice Morph.
            mVoiceEffectCombo->setValue(effect_interface->getVoiceEffect());
            mVoiceEffectCombo->setEnabled(true);
        }
        else
        {
            // If voice isn't working or Voice Effects are not supported disable the control.
            mVoiceEffectCombo->setValue(LLUUID::null);
            mVoiceEffectCombo->setEnabled(false);
        }
    }
}