/** * @file streamingaudio_fmodstudio.cpp * @brief LLStreamingAudio_FMODSTUDIO implementation * * $LicenseInfo:firstyear=2020&license=viewerlgpl$ * Second Life Viewer Source Code * Copyright (C) 2020, 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 "linden_common.h" #include "llmath.h" #include "fmodstudio/fmod.hpp" #include "fmodstudio/fmod_errors.h" #include "llstreamingaudio_fmodstudio.h" class LLAudioStreamManagerFMODSTUDIO { public: LLAudioStreamManagerFMODSTUDIO(FMOD::System *system, const std::string& url); FMOD::Channel* startStream(); bool stopStream(); // Returns true if the stream was successfully stopped. bool ready(); const std::string& getURL() { return mInternetStreamURL; } FMOD_OPENSTATE getOpenState(unsigned int* percentbuffered = NULL, bool* starving = NULL, bool* diskbusy = NULL); protected: FMOD::System* mSystem; FMOD::Channel* mStreamChannel; FMOD::Sound* mInternetStream; bool mReady; std::string mInternetStreamURL; }; //--------------------------------------------------------------------------- // Internet Streaming //--------------------------------------------------------------------------- LLStreamingAudio_FMODSTUDIO::LLStreamingAudio_FMODSTUDIO(FMOD::System *system) : mSystem(system), mCurrentInternetStreamp(NULL), mFMODInternetStreamChannelp(NULL), mGain(1.0f) { // Number of milliseconds of audio to buffer for the audio card. // Must be larger than the usual Second Life frame stutter time. const U32 buffer_seconds = 10; //sec const U32 estimated_bitrate = 128; //kbit/sec mSystem->setStreamBufferSize(estimated_bitrate * buffer_seconds * 128/*bytes/kbit*/, FMOD_TIMEUNIT_RAWBYTES); // Here's where we set the size of the network buffer and some buffering // parameters. In this case we want a network buffer of 16k, we want it // to prebuffer 40% of that when we first connect, and we want it // to rebuffer 80% of that whenever we encounter a buffer underrun. // Leave the net buffer properties at the default. //FSOUND_Stream_Net_SetBufferProperties(20000, 40, 80); } LLStreamingAudio_FMODSTUDIO::~LLStreamingAudio_FMODSTUDIO() { // nothing interesting/safe to do. } void LLStreamingAudio_FMODSTUDIO::start(const std::string& url) { //if (!mInited) //{ // LL_WARNS() << "startInternetStream before audio initialized" << LL_ENDL; // return; //} // "stop" stream but don't clear url, etc. in case url == mInternetStreamURL stop(); if (!url.empty()) { LL_INFOS() << "Starting internet stream: " << url << LL_ENDL; mCurrentInternetStreamp = new LLAudioStreamManagerFMODSTUDIO(mSystem, url); mURL = url; } else { LL_INFOS() << "Set internet stream to null" << LL_ENDL; mURL.clear(); } } void LLStreamingAudio_FMODSTUDIO::update() { // Kill dead internet streams, if possible std::list<LLAudioStreamManagerFMODSTUDIO *>::iterator iter; for (iter = mDeadStreams.begin(); iter != mDeadStreams.end();) { LLAudioStreamManagerFMODSTUDIO *streamp = *iter; if (streamp->stopStream()) { LL_INFOS() << "Closed dead stream" << LL_ENDL; delete streamp; mDeadStreams.erase(iter++); } else { iter++; } } // Don't do anything if there are no streams playing if (!mCurrentInternetStreamp) { return; } unsigned int progress; bool starving; bool diskbusy; FMOD_OPENSTATE open_state = mCurrentInternetStreamp->getOpenState(&progress, &starving, &diskbusy); if (open_state == FMOD_OPENSTATE_READY) { // Stream is live // start the stream if it's ready if (!mFMODInternetStreamChannelp && (mFMODInternetStreamChannelp = mCurrentInternetStreamp->startStream())) { // Reset volume to previously set volume setGain(getGain()); mFMODInternetStreamChannelp->setPaused(false); } } else if (open_state == FMOD_OPENSTATE_ERROR) { stop(); return; } if (mFMODInternetStreamChannelp) { FMOD::Sound *sound = NULL; if (mFMODInternetStreamChannelp->getCurrentSound(&sound) == FMOD_OK && sound) { FMOD_TAG tag; S32 tagcount, dirtytagcount; if (sound->getNumTags(&tagcount, &dirtytagcount) == FMOD_OK && dirtytagcount) { for (S32 i = 0; i < tagcount; ++i) { if (sound->getTag(NULL, i, &tag) != FMOD_OK) continue; if (tag.type == FMOD_TAGTYPE_FMOD) { if (!strcmp(tag.name, "Sample Rate Change")) { LL_INFOS() << "Stream forced changing sample rate to " << *((float *)tag.data) << LL_ENDL; mFMODInternetStreamChannelp->setFrequency(*((float *)tag.data)); } continue; } } } if (starving) { bool paused = false; mFMODInternetStreamChannelp->getPaused(&paused); if (!paused) { LL_INFOS() << "Stream starvation detected! Pausing stream until buffer nearly full." << LL_ENDL; LL_INFOS() << " (diskbusy=" << diskbusy << ")" << LL_ENDL; LL_INFOS() << " (progress=" << progress << ")" << LL_ENDL; mFMODInternetStreamChannelp->setPaused(true); } } else if (progress > 80) { mFMODInternetStreamChannelp->setPaused(false); } } } } void LLStreamingAudio_FMODSTUDIO::stop() { if (mFMODInternetStreamChannelp) { mFMODInternetStreamChannelp->setPaused(true); mFMODInternetStreamChannelp->setPriority(0); mFMODInternetStreamChannelp = NULL; } if (mCurrentInternetStreamp) { LL_INFOS() << "Stopping internet stream: " << mCurrentInternetStreamp->getURL() << LL_ENDL; if (mCurrentInternetStreamp->stopStream()) { delete mCurrentInternetStreamp; } else { LL_WARNS() << "Pushing stream to dead list: " << mCurrentInternetStreamp->getURL() << LL_ENDL; mDeadStreams.push_back(mCurrentInternetStreamp); } mCurrentInternetStreamp = NULL; //mURL.clear(); } } void LLStreamingAudio_FMODSTUDIO::pause(int pauseopt) { if (pauseopt < 0) { pauseopt = mCurrentInternetStreamp ? 1 : 0; } if (pauseopt) { if (mCurrentInternetStreamp) { stop(); } } else { start(getURL()); } } // A stream is "playing" if it has been requested to start. That // doesn't necessarily mean audio is coming out of the speakers. int LLStreamingAudio_FMODSTUDIO::isPlaying() { if (mCurrentInternetStreamp) { return 1; // Active and playing } else if (!mURL.empty()) { return 2; // "Paused" } else { return 0; } } F32 LLStreamingAudio_FMODSTUDIO::getGain() { return mGain; } std::string LLStreamingAudio_FMODSTUDIO::getURL() { return mURL; } void LLStreamingAudio_FMODSTUDIO::setGain(F32 vol) { mGain = vol; if (mFMODInternetStreamChannelp) { vol = llclamp(vol * vol, 0.f, 1.f); //should vol be squared here? mFMODInternetStreamChannelp->setVolume(vol); } } /////////////////////////////////////////////////////// // manager of possibly-multiple internet audio streams LLAudioStreamManagerFMODSTUDIO::LLAudioStreamManagerFMODSTUDIO(FMOD::System *system, const std::string& url) : mSystem(system), mStreamChannel(NULL), mInternetStream(NULL), mReady(false) { mInternetStreamURL = url; FMOD_RESULT result = mSystem->createStream(url.c_str(), FMOD_2D | FMOD_NONBLOCKING | FMOD_IGNORETAGS, 0, &mInternetStream); if (result != FMOD_OK) { LL_WARNS() << "Couldn't open fmod stream, error " << FMOD_ErrorString(result) << LL_ENDL; mReady = false; return; } mReady = true; } FMOD::Channel *LLAudioStreamManagerFMODSTUDIO::startStream() { // We need a live and opened stream before we try and play it. if (!mInternetStream || getOpenState() != FMOD_OPENSTATE_READY) { LL_WARNS() << "No internet stream to start playing!" << LL_ENDL; return NULL; } if (mStreamChannel) return mStreamChannel; //Already have a channel for this stream. mSystem->playSound(mInternetStream, NULL, true, &mStreamChannel); return mStreamChannel; } bool LLAudioStreamManagerFMODSTUDIO::stopStream() { if (mInternetStream) { bool close = true; switch (getOpenState()) { case FMOD_OPENSTATE_CONNECTING: close = false; break; default: close = true; } if (close) { mInternetStream->release(); mStreamChannel = NULL; mInternetStream = NULL; return true; } else { return false; } } else { return true; } } FMOD_OPENSTATE LLAudioStreamManagerFMODSTUDIO::getOpenState(unsigned int* percentbuffered, bool* starving, bool* diskbusy) { FMOD_OPENSTATE state; mInternetStream->getOpenState(&state, percentbuffered, starving, diskbusy); return state; } void LLStreamingAudio_FMODSTUDIO::setBufferSizes(U32 streambuffertime, U32 decodebuffertime) { mSystem->setStreamBufferSize(streambuffertime / 1000 * 128 * 128, FMOD_TIMEUNIT_RAWBYTES); FMOD_ADVANCEDSETTINGS settings; memset(&settings, 0, sizeof(settings)); settings.cbSize = sizeof(settings); settings.defaultDecodeBufferSize = decodebuffertime;//ms mSystem->setAdvancedSettings(&settings); }