path: root/indra/newview/llagentpilot.cpp

/**
 * @file llagentpilot.cpp
 * @brief LLAgentPilot class implementation
 *
 * $LicenseInfo:firstyear=2002&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 <iostream>
#include <fstream>
#include <iomanip>

#include "llagentpilot.h"
#include "llagent.h"
#include "llappviewer.h"
#include "llviewercontrol.h"
#include "llviewercamera.h"
#include "llsdserialize.h"
#include "llsdutil_math.h"

LLAgentPilot gAgentPilot;

LLAgentPilot::LLAgentPilot() :
    mNumRuns(-1),
    mQuitAfterRuns(false),
    mRecording(false),
    mLastRecordTime(0.f),
    mStarted(false),
    mPlaying(false),
    mCurrentAction(0),
    mOverrideCamera(false),
    mLoop(true),
    mReplaySession(false)
{
}

LLAgentPilot::~LLAgentPilot()
{
}

void LLAgentPilot::load()
{
    std::string txt_filename = gSavedSettings.getString("StatsPilotFile");
    std::string xml_filename = gSavedSettings.getString("StatsPilotXMLFile");
    if (LLFile::isfile(xml_filename))
    {
        loadXML(xml_filename);
    }
    else if (LLFile::isfile(txt_filename))
    {
        loadTxt(txt_filename);
    }
    else
    {
        LL_DEBUGS() << "no autopilot file found" << LL_ENDL;
        return;
    }
}

void LLAgentPilot::loadTxt(const std::string& filename)
{
    if(filename.empty())
    {
        return;
    }

    llifstream file(filename.c_str());

    if (!file)
    {
        LL_DEBUGS() << "Couldn't open " << filename
            << ", aborting agentpilot load!" << LL_ENDL;
        return;
    }
    else
    {
        LL_INFOS() << "Opening pilot file " << filename << LL_ENDL;
    }

    mActions.clear();
    S32 num_actions;

    file >> num_actions;

    mActions.reserve(num_actions);
    for (S32 i = 0; i < num_actions; i++)
    {
        S32 action_type;
        Action new_action;
        file >> new_action.mTime >> action_type;
        file >> new_action.mTarget.mdV[VX] >> new_action.mTarget.mdV[VY] >> new_action.mTarget.mdV[VZ];
        new_action.mType = (EActionType)action_type;
        mActions.push_back(new_action);
    }

    mOverrideCamera = false;

    file.close();
}

void LLAgentPilot::loadXML(const std::string& filename)
{
    if(filename.empty())
    {
        return;
    }

    llifstream file(filename.c_str());

    if (!file)
    {
        LL_DEBUGS() << "Couldn't open " << filename
            << ", aborting agentpilot load!" << LL_ENDL;
        return;
    }
    else
    {
        LL_INFOS() << "Opening pilot file " << filename << LL_ENDL;
    }

    mActions.clear();
    LLSD record;
    while (!file.eof() && LLSDParser::PARSE_FAILURE != LLSDSerialize::fromXML(record, file))
    {
        Action action;
        action.mTime = record["time"].asReal();
        action.mType = (EActionType)record["type"].asInteger();
        action.mCameraView = (F32)record["camera_view"].asReal();
        action.mTarget = ll_vector3d_from_sd(record["target"]);
        action.mCameraOrigin = ll_vector3_from_sd(record["camera_origin"]);
        action.mCameraXAxis = ll_vector3_from_sd(record["camera_xaxis"]);
        action.mCameraYAxis = ll_vector3_from_sd(record["camera_yaxis"]);
        action.mCameraZAxis = ll_vector3_from_sd(record["camera_zaxis"]);
        mActions.push_back(action);
    }
    mOverrideCamera = true;
    file.close();
}

void LLAgentPilot::save()
{
    std::string txt_filename = gSavedSettings.getString("StatsPilotFile");
    std::string xml_filename = gSavedSettings.getString("StatsPilotXMLFile");
    saveTxt(txt_filename);
    saveXML(xml_filename);
}

void LLAgentPilot::saveTxt(const std::string& filename)
{
    llofstream file;
    file.open(filename.c_str());

    if (!file)
    {
        LL_INFOS() << "Couldn't open " << filename << ", aborting agentpilot save!" << LL_ENDL;
    }

    file << mActions.size() << '\n';

    S32 i;
    for (i = 0; i < mActions.size(); i++)
    {
        file << mActions[i].mTime << "\t" << mActions[i].mType << "\t";
        file << std::setprecision(32) << mActions[i].mTarget.mdV[VX] << "\t" << mActions[i].mTarget.mdV[VY] << "\t" << mActions[i].mTarget.mdV[VZ];
        file << '\n';
    }

    file.close();
}

void LLAgentPilot::saveXML(const std::string& filename)
{
    llofstream file;
    file.open(filename.c_str());

    if (!file)
    {
        LL_INFOS() << "Couldn't open " << filename << ", aborting agentpilot save!" << LL_ENDL;
    }

    S32 i;
    for (i = 0; i < mActions.size(); i++)
    {
        Action& action = mActions[i];
        LLSD record;
        record["time"] = (LLSD::Real)action.mTime;
        record["type"] = (LLSD::Integer)action.mType;
        record["camera_view"] = (LLSD::Real)action.mCameraView;
        record["target"] = ll_sd_from_vector3d(action.mTarget);
        record["camera_origin"] = ll_sd_from_vector3(action.mCameraOrigin);
        record["camera_xaxis"] = ll_sd_from_vector3(action.mCameraXAxis);
        record["camera_yaxis"] = ll_sd_from_vector3(action.mCameraYAxis);
        record["camera_zaxis"] = ll_sd_from_vector3(action.mCameraZAxis);
        LLSDSerialize::toXML(record, file);
    }
    file.close();
}

void LLAgentPilot::startRecord()
{
    mActions.clear();
    mTimer.reset();
    addAction(STRAIGHT);
    mRecording = true;
}

void LLAgentPilot::stopRecord()
{
    gAgentPilot.addAction(STRAIGHT);
    gAgentPilot.save();
    mRecording = false;
}

void LLAgentPilot::addAction(enum EActionType action_type)
{
    LL_INFOS() << "Adding waypoint: " << gAgent.getPositionGlobal() << LL_ENDL;
    Action action;
    action.mType = action_type;
    action.mTarget = gAgent.getPositionGlobal();
    action.mTime = mTimer.getElapsedTimeF32();
    LLViewerCamera *cam = LLViewerCamera::getInstance();
    action.mCameraView = cam->getView();
    action.mCameraOrigin = cam->getOrigin();
    action.mCameraXAxis = cam->getXAxis();
    action.mCameraYAxis = cam->getYAxis();
    action.mCameraZAxis = cam->getZAxis();
    mLastRecordTime = (F32)action.mTime;
    mActions.push_back(action);
}

void LLAgentPilot::startPlayback()
{
    if (!mPlaying)
    {
        mPlaying = true;
        mCurrentAction = 0;
        mTimer.reset();

        if (mActions.size())
        {
            LL_INFOS() << "Starting playback, moving to waypoint 0" << LL_ENDL;
            gAgent.startAutoPilotGlobal(mActions[0].mTarget);
            moveCamera();
            mStarted = false;
        }
        else
        {
            LL_INFOS() << "No autopilot data, cancelling!" << LL_ENDL;
            mPlaying = false;
        }
    }
}

void LLAgentPilot::stopPlayback()
{
    if (mPlaying)
    {
        mPlaying = false;
        mCurrentAction = 0;
        mTimer.reset();
        gAgent.stopAutoPilot();
    }

    if (mReplaySession)
    {
        LLAppViewer::instance()->forceQuit();
    }
}

void LLAgentPilot::moveCamera()
{
    if (!getOverrideCamera())
        return;

    if (mCurrentAction<mActions.size())
    {
        S32 start_index = llmax(mCurrentAction-1,0);
        S32 end_index = mCurrentAction;
        F32 t = 0.0;
        F32 timedelta = (F32)(mActions[end_index].mTime - mActions[start_index].mTime);
        F32 tickelapsed = mTimer.getElapsedTimeF32()-(F32)mActions[start_index].mTime;
        if (timedelta > 0.0)
        {
            t = tickelapsed/timedelta;
        }

        if ((t<0.0)||(t>1.0))
        {
            LL_WARNS() << "mCurrentAction is invalid, t = " << t << LL_ENDL;
            return;
        }

        Action& start = mActions[start_index];
        Action& end = mActions[end_index];

        F32 view = lerp(start.mCameraView, end.mCameraView, t);
        LLVector3 origin = lerp(start.mCameraOrigin, end.mCameraOrigin, t);
        LLQuaternion start_quat(start.mCameraXAxis, start.mCameraYAxis, start.mCameraZAxis);
        LLQuaternion end_quat(end.mCameraXAxis, end.mCameraYAxis, end.mCameraZAxis);
        LLQuaternion quat = nlerp(t, start_quat, end_quat);
        LLMatrix3 mat(quat);

        LLViewerCamera::getInstance()->setView(view);
        LLViewerCamera::getInstance()->setOrigin(origin);
        LLViewerCamera::getInstance()->mXAxis = LLVector3(mat.mMatrix[0]);
        LLViewerCamera::getInstance()->mYAxis = LLVector3(mat.mMatrix[1]);
        LLViewerCamera::getInstance()->mZAxis = LLVector3(mat.mMatrix[2]);
    }
}

void LLAgentPilot::updateTarget()
{
    if (mPlaying)
    {
        if (mCurrentAction < mActions.size())
        {
            if (0 == mCurrentAction)
            {
                if (gAgent.getAutoPilot())
                {
                    // Wait until we get to the first location before starting.
                    return;
                }
                else
                {
                    if (!mStarted)
                    {
                        LL_INFOS() << "At start, beginning playback" << LL_ENDL;
                        mTimer.reset();
                        mStarted = true;
                    }
                }
            }
            if (mTimer.getElapsedTimeF32() > mActions[mCurrentAction].mTime)
            {
                //gAgent.stopAutoPilot();
                mCurrentAction++;

                if (mCurrentAction < mActions.size())
                {
                    gAgent.startAutoPilotGlobal(mActions[mCurrentAction].mTarget);
                    moveCamera();
                }
                else
                {
                    stopPlayback();
                    mNumRuns--;
                    if (mLoop)
                    {
                        if ((mNumRuns < 0) || (mNumRuns > 0))
                        {
                            LL_INFOS() << "Looping, restarting playback" << LL_ENDL;
                            startPlayback();
                        }
                        else if (mQuitAfterRuns)
                        {
                            LL_INFOS() << "Done with all runs, quitting viewer!" << LL_ENDL;
                            LLAppViewer::instance()->forceQuit();
                        }
                        else
                        {
                            LL_INFOS() << "Done with all runs, disabling pilot" << LL_ENDL;
                            stopPlayback();
                        }
                    }
                }
            }
        }
        else
        {
            stopPlayback();
        }
    }
    else if (mRecording)
    {
        if (mTimer.getElapsedTimeF32() - mLastRecordTime > 1.f)
        {
            addAction(STRAIGHT);
        }
    }
}

void LLAgentPilot::addWaypoint()
{
    addAction(STRAIGHT);
}