Add support for sound backends & some miniaudio changes (#4978)
Miniaudio now runs everything in a separate audio thread - this uses boost::asio's io_context. Our miniaudio implementation is now also much simplified - it does not use its own resource manager or device. This might end up being stupid if sounds don't work after changing output device or locking or w/e I've made the sound controller into an interface, meaning we can support multiple sound backends in Chatterino. I've added a Null sound backend that disables all sound. A QMediaPlayer or QSoundEffect or Qt backend could be added. Miniaudio might idle & disable the device now too, not sure I've added some unrelated changes in the form of a new setting type, and a new setting page helper function for it, which will hopefully make adding new enum settings easier in the future. This setting stores its value as a string instead of an int, and uses magic_enum to convert between that string value and its enum value.
This commit is contained in:
pajlada
@@ -3,7 +3,7 @@
|
||||
#include "Application.hpp"
|
||||
#include "common/QLogging.hpp"
|
||||
#include "controllers/notifications/NotificationModel.hpp"
|
||||
#include "controllers/sound/SoundController.hpp"
|
||||
#include "controllers/sound/ISoundController.hpp"
|
||||
#include "messages/Message.hpp"
|
||||
#include "providers/twitch/api/Helix.hpp"
|
||||
#include "providers/twitch/TwitchIrcServer.hpp"
|
||||
@@ -105,7 +105,7 @@ void NotificationController::playSound()
|
||||
getSettings()->notificationPathSound.getValue())
|
||||
: QUrl("qrc:/sounds/ping2.wav");
|
||||
|
||||
getApp()->sound->play(highlightSoundUrl);
|
||||
getIApp()->getSound()->play(highlightSoundUrl);
|
||||
}
|
||||
|
||||
NotificationModel *NotificationController::createModel(QObject *parent,
|
||||
|
||||
@@ -0,0 +1,38 @@
|
||||
#pragma once
|
||||
|
||||
#include "common/Singleton.hpp"
|
||||
|
||||
#include <QUrl>
|
||||
|
||||
namespace chatterino {
|
||||
|
||||
class Settings;
|
||||
class Paths;
|
||||
|
||||
enum class SoundBackend {
|
||||
Miniaudio,
|
||||
Null,
|
||||
};
|
||||
|
||||
/**
|
||||
* @brief Handles sound loading & playback
|
||||
**/
|
||||
class ISoundController : public Singleton
|
||||
{
|
||||
public:
|
||||
ISoundController() = default;
|
||||
~ISoundController() override = default;
|
||||
ISoundController(const ISoundController &) = delete;
|
||||
ISoundController(ISoundController &&) = delete;
|
||||
ISoundController &operator=(const ISoundController &) = delete;
|
||||
ISoundController &operator=(ISoundController &&) = delete;
|
||||
|
||||
// Play a sound from the given url
|
||||
// If the url points to something that isn't a local file, it will play
|
||||
// the default sound initialized in the initialize method
|
||||
//
|
||||
// This function should not block
|
||||
virtual void play(const QUrl &sound) = 0;
|
||||
};
|
||||
|
||||
} // namespace chatterino
|
||||
@@ -0,0 +1,299 @@
|
||||
#include "controllers/sound/MiniaudioBackend.hpp"
|
||||
|
||||
#include "Application.hpp"
|
||||
#include "common/QLogging.hpp"
|
||||
#include "debug/Benchmark.hpp"
|
||||
#include "singletons/Paths.hpp"
|
||||
#include "singletons/Settings.hpp"
|
||||
#include "singletons/WindowManager.hpp"
|
||||
#include "widgets/Window.hpp"
|
||||
|
||||
#include <boost/asio/executor_work_guard.hpp>
|
||||
|
||||
#define MINIAUDIO_IMPLEMENTATION
|
||||
#include <miniaudio.h>
|
||||
#include <QFile>
|
||||
|
||||
#include <limits>
|
||||
#include <memory>
|
||||
|
||||
namespace {
|
||||
|
||||
using namespace chatterino;
|
||||
|
||||
// The duration after which a sound is played we should try to stop the sound engine, hopefully
|
||||
// returning the handle to idle letting the computer or monitors sleep
|
||||
constexpr const auto STOP_AFTER_DURATION = std::chrono::seconds(30);
|
||||
|
||||
void miniaudioLogCallback(void *userData, ma_uint32 level, const char *pMessage)
|
||||
{
|
||||
(void)userData;
|
||||
|
||||
QString message{pMessage};
|
||||
|
||||
switch (level)
|
||||
{
|
||||
case MA_LOG_LEVEL_DEBUG: {
|
||||
qCDebug(chatterinoSound).noquote()
|
||||
<< "ma debug: " << message.trimmed();
|
||||
}
|
||||
break;
|
||||
case MA_LOG_LEVEL_INFO: {
|
||||
qCDebug(chatterinoSound).noquote()
|
||||
<< "ma info: " << message.trimmed();
|
||||
}
|
||||
break;
|
||||
case MA_LOG_LEVEL_WARNING: {
|
||||
qCWarning(chatterinoSound).noquote()
|
||||
<< "ma warning:" << message.trimmed();
|
||||
}
|
||||
break;
|
||||
case MA_LOG_LEVEL_ERROR: {
|
||||
qCWarning(chatterinoSound).noquote()
|
||||
<< "ma error: " << message.trimmed();
|
||||
}
|
||||
break;
|
||||
default: {
|
||||
qCWarning(chatterinoSound).noquote()
|
||||
<< "ma unknown:" << message.trimmed();
|
||||
}
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
} // namespace
|
||||
|
||||
namespace chatterino {
|
||||
|
||||
// NUM_SOUNDS specifies how many simultaneous default ping sounds & decoders to create
|
||||
constexpr const auto NUM_SOUNDS = 4;
|
||||
|
||||
void MiniaudioBackend::initialize(Settings &settings, Paths &paths)
|
||||
{
|
||||
(void)(settings);
|
||||
(void)(paths);
|
||||
|
||||
boost::asio::post(this->ioContext, [this] {
|
||||
ma_result result{};
|
||||
|
||||
// We are leaking this log object on purpose
|
||||
auto *logger = new ma_log;
|
||||
|
||||
result = ma_log_init(nullptr, logger);
|
||||
if (result != MA_SUCCESS)
|
||||
{
|
||||
qCWarning(chatterinoSound)
|
||||
<< "Error initializing logger:" << result;
|
||||
return;
|
||||
}
|
||||
|
||||
result = ma_log_register_callback(
|
||||
logger, ma_log_callback_init(miniaudioLogCallback, nullptr));
|
||||
if (result != MA_SUCCESS)
|
||||
{
|
||||
qCWarning(chatterinoSound)
|
||||
<< "Error registering logger callback:" << result;
|
||||
return;
|
||||
}
|
||||
|
||||
auto contextConfig = ma_context_config_init();
|
||||
contextConfig.pLog = logger;
|
||||
|
||||
/// Initialize context
|
||||
result =
|
||||
ma_context_init(nullptr, 0, &contextConfig, this->context.get());
|
||||
if (result != MA_SUCCESS)
|
||||
{
|
||||
qCWarning(chatterinoSound)
|
||||
<< "Error initializing context:" << result;
|
||||
return;
|
||||
}
|
||||
|
||||
/// Load default sound
|
||||
QFile defaultPingFile(":/sounds/ping2.wav");
|
||||
if (!defaultPingFile.open(QIODevice::ReadOnly))
|
||||
{
|
||||
qCWarning(chatterinoSound) << "Error loading default ping sound";
|
||||
return;
|
||||
}
|
||||
this->defaultPingData = defaultPingFile.readAll();
|
||||
|
||||
/// Initialize engine
|
||||
auto engineConfig = ma_engine_config_init();
|
||||
engineConfig.pContext = this->context.get();
|
||||
engineConfig.noAutoStart = MA_TRUE;
|
||||
|
||||
result = ma_engine_init(&engineConfig, this->engine.get());
|
||||
if (result != MA_SUCCESS)
|
||||
{
|
||||
qCWarning(chatterinoSound)
|
||||
<< "Error initializing engine:" << result;
|
||||
return;
|
||||
}
|
||||
|
||||
/// Initialize default ping sounds
|
||||
{
|
||||
// TODO: Can we optimize this?
|
||||
BenchmarkGuard b("init sounds");
|
||||
|
||||
ma_uint32 soundFlags = 0;
|
||||
// Decode the sound during loading instead of during playback
|
||||
soundFlags |= MA_SOUND_FLAG_DECODE;
|
||||
// Disable pitch control (we don't use it, so this saves some performance)
|
||||
soundFlags |= MA_SOUND_FLAG_NO_PITCH;
|
||||
// Disable spatialization control, this brings the volume up to "normal levels"
|
||||
soundFlags |= MA_SOUND_FLAG_NO_SPATIALIZATION;
|
||||
|
||||
auto decoderConfig =
|
||||
ma_decoder_config_init(ma_format_f32, 0, 48000);
|
||||
// This must match the encoding format of our default ping sound
|
||||
decoderConfig.encodingFormat = ma_encoding_format_wav;
|
||||
|
||||
for (auto i = 0; i < NUM_SOUNDS; ++i)
|
||||
{
|
||||
auto dec = std::make_unique<ma_decoder>();
|
||||
auto snd = std::make_unique<ma_sound>();
|
||||
|
||||
result = ma_decoder_init_memory(
|
||||
(void *)this->defaultPingData.data(),
|
||||
this->defaultPingData.size() * sizeof(char), &decoderConfig,
|
||||
dec.get());
|
||||
if (result != MA_SUCCESS)
|
||||
{
|
||||
qCWarning(chatterinoSound) << "Error initializing default "
|
||||
"ping decoder from memory:"
|
||||
<< result;
|
||||
return;
|
||||
}
|
||||
|
||||
result = ma_sound_init_from_data_source(this->engine.get(),
|
||||
dec.get(), soundFlags,
|
||||
nullptr, snd.get());
|
||||
if (result != MA_SUCCESS)
|
||||
{
|
||||
qCWarning(chatterinoSound)
|
||||
<< "Error initializing default sound from data source:"
|
||||
<< result;
|
||||
return;
|
||||
}
|
||||
|
||||
this->defaultPingDecoders.emplace_back(std::move(dec));
|
||||
this->defaultPingSounds.emplace_back(std::move(snd));
|
||||
}
|
||||
}
|
||||
|
||||
qCInfo(chatterinoSound) << "miniaudio sound system initialized";
|
||||
|
||||
this->initialized = true;
|
||||
});
|
||||
|
||||
this->audioThread = std::make_unique<std::thread>([this] {
|
||||
this->ioContext.run();
|
||||
});
|
||||
}
|
||||
|
||||
MiniaudioBackend::MiniaudioBackend()
|
||||
: context(std::make_unique<ma_context>())
|
||||
, engine(std::make_unique<ma_engine>())
|
||||
, workGuard(boost::asio::make_work_guard(this->ioContext))
|
||||
, sleepTimer(this->ioContext)
|
||||
{
|
||||
qCInfo(chatterinoSound) << "Initializing miniaudio sound backend";
|
||||
}
|
||||
|
||||
MiniaudioBackend::~MiniaudioBackend()
|
||||
{
|
||||
// NOTE: This destructor is never called because the `runGui` function calls _exit before that happens
|
||||
// I have manually called the destructor prior to _exit being called to ensure this logic is sound
|
||||
|
||||
boost::asio::post(this->ioContext, [this] {
|
||||
for (const auto &snd : this->defaultPingSounds)
|
||||
{
|
||||
ma_sound_uninit(snd.get());
|
||||
}
|
||||
for (const auto &dec : this->defaultPingDecoders)
|
||||
{
|
||||
ma_decoder_uninit(dec.get());
|
||||
}
|
||||
|
||||
ma_engine_uninit(this->engine.get());
|
||||
ma_context_uninit(this->context.get());
|
||||
|
||||
this->workGuard.reset();
|
||||
});
|
||||
|
||||
if (this->audioThread->joinable())
|
||||
{
|
||||
this->audioThread->join();
|
||||
}
|
||||
else
|
||||
{
|
||||
qCWarning(chatterinoSound) << "Audio thread not joinable";
|
||||
}
|
||||
}
|
||||
|
||||
void MiniaudioBackend::play(const QUrl &sound)
|
||||
{
|
||||
boost::asio::post(this->ioContext, [this, sound] {
|
||||
static size_t i = 0;
|
||||
|
||||
this->tgPlay.guard();
|
||||
|
||||
if (!this->initialized)
|
||||
{
|
||||
qCWarning(chatterinoSound) << "Can't play sound, sound controller "
|
||||
"didn't initialize correctly";
|
||||
return;
|
||||
}
|
||||
|
||||
auto result = ma_engine_start(this->engine.get());
|
||||
if (result != MA_SUCCESS)
|
||||
{
|
||||
qCWarning(chatterinoSound) << "Error starting engine " << result;
|
||||
return;
|
||||
}
|
||||
|
||||
if (sound.isLocalFile())
|
||||
{
|
||||
auto soundPath = sound.toLocalFile();
|
||||
auto result = ma_engine_play_sound(this->engine.get(),
|
||||
qPrintable(soundPath), nullptr);
|
||||
if (result != MA_SUCCESS)
|
||||
{
|
||||
qCWarning(chatterinoSound) << "Failed to play sound" << sound
|
||||
<< soundPath << ":" << result;
|
||||
}
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
// Play default sound, loaded from our resources in the constructor
|
||||
auto &snd = this->defaultPingSounds[++i % NUM_SOUNDS];
|
||||
ma_sound_seek_to_pcm_frame(snd.get(), 0);
|
||||
result = ma_sound_start(snd.get());
|
||||
if (result != MA_SUCCESS)
|
||||
{
|
||||
qCWarning(chatterinoSound)
|
||||
<< "Failed to play default ping" << result;
|
||||
}
|
||||
|
||||
this->sleepTimer.expires_from_now(STOP_AFTER_DURATION);
|
||||
this->sleepTimer.async_wait([this](const auto &ec) {
|
||||
if (ec)
|
||||
{
|
||||
// Timer was most likely cancelled
|
||||
return;
|
||||
}
|
||||
|
||||
auto result = ma_engine_stop(this->engine.get());
|
||||
if (result != MA_SUCCESS)
|
||||
{
|
||||
qCWarning(chatterinoSound)
|
||||
<< "Error stopping miniaudio engine " << result;
|
||||
return;
|
||||
}
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
} // namespace chatterino
|
||||
+14
-20
@@ -1,8 +1,9 @@
|
||||
#pragma once
|
||||
|
||||
#include "common/Singleton.hpp"
|
||||
#include "controllers/sound/ISoundController.hpp"
|
||||
#include "util/ThreadGuard.hpp"
|
||||
|
||||
#include <boost/asio.hpp>
|
||||
#include <QByteArray>
|
||||
#include <QString>
|
||||
#include <QUrl>
|
||||
@@ -19,33 +20,25 @@ struct ma_decoder;
|
||||
|
||||
namespace chatterino {
|
||||
|
||||
class Settings;
|
||||
class Paths;
|
||||
|
||||
/**
|
||||
* @brief Handles sound loading & playback
|
||||
**/
|
||||
class SoundController : public Singleton
|
||||
class MiniaudioBackend : public ISoundController
|
||||
{
|
||||
SoundController();
|
||||
|
||||
void initialize(Settings &settings, Paths &paths) override;
|
||||
|
||||
public:
|
||||
~SoundController() override;
|
||||
MiniaudioBackend();
|
||||
~MiniaudioBackend() override;
|
||||
|
||||
// Play a sound from the given url
|
||||
// If the url points to something that isn't a local file, it will play
|
||||
// the default sound initialized in the initialize method
|
||||
void play(const QUrl &sound);
|
||||
void play(const QUrl &sound) final;
|
||||
|
||||
private:
|
||||
// Used for selecting & initializing an appropriate sound backend
|
||||
std::unique_ptr<ma_context> context;
|
||||
// Used for storing & reusing sounds to be played
|
||||
std::unique_ptr<ma_resource_manager> resourceManager;
|
||||
// The sound device we're playing sound into
|
||||
std::unique_ptr<ma_device> device{nullptr};
|
||||
// The engine is a high-level API for playing sounds from paths in a simple & efficient-enough manner
|
||||
std::unique_ptr<ma_engine> engine;
|
||||
|
||||
@@ -62,14 +55,15 @@ private:
|
||||
// Ensures play is only ever called from the same thread
|
||||
ThreadGuard tgPlay;
|
||||
|
||||
bool initialized{false};
|
||||
std::chrono::system_clock::time_point lastSoundPlay;
|
||||
|
||||
// Recreates the sound device
|
||||
// This is used during initialization, and can also be used if the device
|
||||
// needs to be recreated during playback
|
||||
//
|
||||
// Returns false on failure
|
||||
bool recreateDevice();
|
||||
boost::asio::io_context ioContext{1};
|
||||
boost::asio::executor_work_guard<boost::asio::io_context::executor_type>
|
||||
workGuard;
|
||||
std::unique_ptr<std::thread> audioThread;
|
||||
boost::asio::steady_timer sleepTimer;
|
||||
|
||||
bool initialized{false};
|
||||
|
||||
friend class Application;
|
||||
};
|
||||
@@ -0,0 +1,18 @@
|
||||
#include "controllers/sound/NullBackend.hpp"
|
||||
|
||||
#include "common/QLogging.hpp"
|
||||
|
||||
namespace chatterino {
|
||||
|
||||
NullBackend::NullBackend()
|
||||
{
|
||||
qCInfo(chatterinoSound) << "Initializing null sound backend";
|
||||
}
|
||||
|
||||
void NullBackend::play(const QUrl &sound)
|
||||
{
|
||||
// Do nothing
|
||||
qCDebug(chatterinoSound) << "null backend asked to play" << sound;
|
||||
}
|
||||
|
||||
} // namespace chatterino
|
||||
@@ -0,0 +1,26 @@
|
||||
#pragma once
|
||||
|
||||
#include "controllers/sound/ISoundController.hpp"
|
||||
|
||||
namespace chatterino {
|
||||
|
||||
/**
|
||||
* @brief This sound backend does nothing
|
||||
**/
|
||||
class NullBackend final : public ISoundController
|
||||
{
|
||||
public:
|
||||
NullBackend();
|
||||
~NullBackend() override = default;
|
||||
NullBackend(const NullBackend &) = delete;
|
||||
NullBackend(NullBackend &&) = delete;
|
||||
NullBackend &operator=(const NullBackend &) = delete;
|
||||
NullBackend &operator=(NullBackend &&) = delete;
|
||||
|
||||
// Play a sound from the given url
|
||||
// If the url points to something that isn't a local file, it will play
|
||||
// the default sound initialized in the initialize method
|
||||
void play(const QUrl &sound) final;
|
||||
};
|
||||
|
||||
} // namespace chatterino
|
||||
@@ -1,331 +0,0 @@
|
||||
#include "controllers/sound/SoundController.hpp"
|
||||
|
||||
#include "common/QLogging.hpp"
|
||||
#include "debug/Benchmark.hpp"
|
||||
#include "singletons/Paths.hpp"
|
||||
#include "singletons/Settings.hpp"
|
||||
|
||||
#define MINIAUDIO_IMPLEMENTATION
|
||||
#include <miniaudio.h>
|
||||
#include <QFile>
|
||||
|
||||
#include <limits>
|
||||
#include <memory>
|
||||
|
||||
namespace {
|
||||
|
||||
using namespace chatterino;
|
||||
|
||||
void miniaudioLogCallback(void *userData, ma_uint32 level, const char *pMessage)
|
||||
{
|
||||
(void)userData;
|
||||
|
||||
QString message{pMessage};
|
||||
|
||||
switch (level)
|
||||
{
|
||||
case MA_LOG_LEVEL_DEBUG: {
|
||||
qCDebug(chatterinoSound).noquote()
|
||||
<< "ma debug: " << message.trimmed();
|
||||
}
|
||||
break;
|
||||
case MA_LOG_LEVEL_INFO: {
|
||||
qCDebug(chatterinoSound).noquote()
|
||||
<< "ma info: " << message.trimmed();
|
||||
}
|
||||
break;
|
||||
case MA_LOG_LEVEL_WARNING: {
|
||||
qCWarning(chatterinoSound).noquote()
|
||||
<< "ma warning:" << message.trimmed();
|
||||
}
|
||||
break;
|
||||
case MA_LOG_LEVEL_ERROR: {
|
||||
qCWarning(chatterinoSound).noquote()
|
||||
<< "ma error: " << message.trimmed();
|
||||
}
|
||||
break;
|
||||
default: {
|
||||
qCWarning(chatterinoSound).noquote()
|
||||
<< "ma unknown:" << message.trimmed();
|
||||
}
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
} // namespace
|
||||
|
||||
namespace chatterino {
|
||||
|
||||
// NUM_SOUNDS specifies how many simultaneous default ping sounds & decoders to create
|
||||
constexpr const auto NUM_SOUNDS = 4;
|
||||
|
||||
SoundController::SoundController()
|
||||
: context(std::make_unique<ma_context>())
|
||||
, resourceManager(std::make_unique<ma_resource_manager>())
|
||||
, engine(std::make_unique<ma_engine>())
|
||||
{
|
||||
}
|
||||
|
||||
void SoundController::initialize(Settings &settings, Paths &paths)
|
||||
{
|
||||
(void)(settings);
|
||||
(void)(paths);
|
||||
|
||||
ma_result result{};
|
||||
|
||||
// We are leaking this log object on purpose
|
||||
auto *logger = new ma_log;
|
||||
|
||||
result = ma_log_init(nullptr, logger);
|
||||
if (result != MA_SUCCESS)
|
||||
{
|
||||
qCWarning(chatterinoSound) << "Error initializing logger:" << result;
|
||||
return;
|
||||
}
|
||||
|
||||
result = ma_log_register_callback(
|
||||
logger, ma_log_callback_init(miniaudioLogCallback, nullptr));
|
||||
if (result != MA_SUCCESS)
|
||||
{
|
||||
qCWarning(chatterinoSound)
|
||||
<< "Error registering logger callback:" << result;
|
||||
return;
|
||||
}
|
||||
|
||||
auto contextConfig = ma_context_config_init();
|
||||
contextConfig.pLog = logger;
|
||||
|
||||
/// Initialize context
|
||||
result = ma_context_init(nullptr, 0, &contextConfig, this->context.get());
|
||||
if (result != MA_SUCCESS)
|
||||
{
|
||||
qCWarning(chatterinoSound) << "Error initializing context:" << result;
|
||||
return;
|
||||
}
|
||||
|
||||
/// Initialize resource manager
|
||||
auto resourceManagerConfig = ma_resource_manager_config_init();
|
||||
resourceManagerConfig.decodedFormat = ma_format_f32;
|
||||
// Use native channel count
|
||||
resourceManagerConfig.decodedChannels = 0;
|
||||
resourceManagerConfig.decodedSampleRate = 48000;
|
||||
|
||||
result = ma_resource_manager_init(&resourceManagerConfig,
|
||||
this->resourceManager.get());
|
||||
if (result != MA_SUCCESS)
|
||||
{
|
||||
qCWarning(chatterinoSound)
|
||||
<< "Error initializing resource manager:" << result;
|
||||
return;
|
||||
}
|
||||
|
||||
/// Load default sound
|
||||
QFile defaultPingFile(":/sounds/ping2.wav");
|
||||
if (!defaultPingFile.open(QIODevice::ReadOnly))
|
||||
{
|
||||
qCWarning(chatterinoSound) << "Error loading default ping sound";
|
||||
return;
|
||||
}
|
||||
this->defaultPingData = defaultPingFile.readAll();
|
||||
|
||||
/// Initialize a sound device
|
||||
if (!this->recreateDevice())
|
||||
{
|
||||
qCWarning(chatterinoSound) << "Failed to create the initial device";
|
||||
return;
|
||||
}
|
||||
|
||||
/// Initialize engine
|
||||
auto engineConfig = ma_engine_config_init();
|
||||
engineConfig.pResourceManager = this->resourceManager.get();
|
||||
engineConfig.pDevice = this->device.get();
|
||||
engineConfig.pContext = this->context.get();
|
||||
|
||||
result = ma_engine_init(&engineConfig, this->engine.get());
|
||||
if (result != MA_SUCCESS)
|
||||
{
|
||||
qCWarning(chatterinoSound) << "Error initializing engine:" << result;
|
||||
return;
|
||||
}
|
||||
|
||||
/// Initialize default ping sounds
|
||||
{
|
||||
// TODO: Can we optimize this?
|
||||
BenchmarkGuard b("init sounds");
|
||||
|
||||
ma_uint32 soundFlags = 0;
|
||||
// Decode the sound during loading instead of during playback
|
||||
soundFlags |= MA_SOUND_FLAG_DECODE;
|
||||
// Disable pitch control (we don't use it, so this saves some performance)
|
||||
soundFlags |= MA_SOUND_FLAG_NO_PITCH;
|
||||
// Disable spatialization control, this brings the volume up to "normal levels"
|
||||
soundFlags |= MA_SOUND_FLAG_NO_SPATIALIZATION;
|
||||
|
||||
auto decoderConfig = ma_decoder_config_init(ma_format_f32, 0, 48000);
|
||||
// This must match the encoding format of our default ping sound
|
||||
decoderConfig.encodingFormat = ma_encoding_format_wav;
|
||||
|
||||
for (auto i = 0; i < NUM_SOUNDS; ++i)
|
||||
{
|
||||
auto dec = std::make_unique<ma_decoder>();
|
||||
auto snd = std::make_unique<ma_sound>();
|
||||
|
||||
result = ma_decoder_init_memory(
|
||||
(void *)this->defaultPingData.data(),
|
||||
this->defaultPingData.size() * sizeof(char), &decoderConfig,
|
||||
dec.get());
|
||||
if (result != MA_SUCCESS)
|
||||
{
|
||||
qCWarning(chatterinoSound)
|
||||
<< "Error initializing default ping decoder from memory:"
|
||||
<< result;
|
||||
return;
|
||||
}
|
||||
|
||||
result = ma_sound_init_from_data_source(
|
||||
this->engine.get(), dec.get(), soundFlags, nullptr, snd.get());
|
||||
if (result != MA_SUCCESS)
|
||||
{
|
||||
qCWarning(chatterinoSound)
|
||||
<< "Error initializing default sound from data source:"
|
||||
<< result;
|
||||
return;
|
||||
}
|
||||
|
||||
this->defaultPingDecoders.emplace_back(std::move(dec));
|
||||
this->defaultPingSounds.emplace_back(std::move(snd));
|
||||
}
|
||||
}
|
||||
|
||||
qCInfo(chatterinoSound) << "miniaudio sound system initialized";
|
||||
|
||||
this->initialized = true;
|
||||
}
|
||||
|
||||
SoundController::~SoundController()
|
||||
{
|
||||
// NOTE: This destructor is never called because the `runGui` function calls _exit before that happens
|
||||
// I have manually called the destructor prior to _exit being called to ensure this logic is sound
|
||||
|
||||
for (const auto &snd : this->defaultPingSounds)
|
||||
{
|
||||
ma_sound_uninit(snd.get());
|
||||
}
|
||||
for (const auto &dec : this->defaultPingDecoders)
|
||||
{
|
||||
ma_decoder_uninit(dec.get());
|
||||
}
|
||||
|
||||
ma_engine_uninit(this->engine.get());
|
||||
if (this->device)
|
||||
{
|
||||
ma_device_uninit(this->device.get());
|
||||
this->device.reset();
|
||||
}
|
||||
ma_resource_manager_uninit(this->resourceManager.get());
|
||||
ma_context_uninit(this->context.get());
|
||||
}
|
||||
|
||||
void SoundController::play(const QUrl &sound)
|
||||
{
|
||||
static size_t i = 0;
|
||||
|
||||
this->tgPlay.guard();
|
||||
|
||||
if (!this->initialized)
|
||||
{
|
||||
qCWarning(chatterinoSound) << "Can't play sound, sound controller "
|
||||
"didn't initialize correctly";
|
||||
return;
|
||||
}
|
||||
|
||||
auto deviceState = ma_device_get_state(this->device.get());
|
||||
|
||||
if (deviceState != ma_device_state_started)
|
||||
{
|
||||
// Device state is not as it should be, try to restart it
|
||||
qCWarning(chatterinoSound)
|
||||
<< "Sound device was not started, attempting to restart it"
|
||||
<< deviceState;
|
||||
|
||||
auto result = ma_device_start(this->device.get());
|
||||
if (result != MA_SUCCESS)
|
||||
{
|
||||
qCWarning(chatterinoSound)
|
||||
<< "Failed to start the sound device" << result;
|
||||
|
||||
if (!this->recreateDevice())
|
||||
{
|
||||
qCWarning(chatterinoSound) << "Failed to recreate device";
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
qCInfo(chatterinoSound) << "Successfully restarted the sound device";
|
||||
}
|
||||
|
||||
if (sound.isLocalFile())
|
||||
{
|
||||
auto soundPath = sound.toLocalFile();
|
||||
auto result = ma_engine_play_sound(this->engine.get(),
|
||||
qPrintable(soundPath), nullptr);
|
||||
if (result != MA_SUCCESS)
|
||||
{
|
||||
qCWarning(chatterinoSound) << "Failed to play sound" << sound
|
||||
<< soundPath << ":" << result;
|
||||
}
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
// Play default sound, loaded from our resources in the constructor
|
||||
auto &snd = this->defaultPingSounds[++i % NUM_SOUNDS];
|
||||
ma_sound_seek_to_pcm_frame(snd.get(), 0);
|
||||
auto result = ma_sound_start(snd.get());
|
||||
if (result != MA_SUCCESS)
|
||||
{
|
||||
qCWarning(chatterinoSound) << "Failed to play default ping" << result;
|
||||
}
|
||||
}
|
||||
|
||||
bool SoundController::recreateDevice()
|
||||
{
|
||||
ma_result result{};
|
||||
|
||||
if (this->device)
|
||||
{
|
||||
// Release the previous device first
|
||||
qCDebug(chatterinoSound) << "Uniniting previously created device";
|
||||
ma_device_uninit(this->device.get());
|
||||
}
|
||||
|
||||
this->device = std::make_unique<ma_device>();
|
||||
|
||||
auto deviceConfig = ma_device_config_init(ma_device_type_playback);
|
||||
deviceConfig.playback.pDeviceID = nullptr;
|
||||
deviceConfig.playback.format = this->resourceManager->config.decodedFormat;
|
||||
deviceConfig.playback.channels = 0;
|
||||
deviceConfig.pulse.pStreamNamePlayback = "Chatterino MA";
|
||||
deviceConfig.sampleRate = this->resourceManager->config.decodedSampleRate;
|
||||
deviceConfig.dataCallback = ma_engine_data_callback_internal;
|
||||
deviceConfig.pUserData = this->engine.get();
|
||||
|
||||
result =
|
||||
ma_device_init(this->context.get(), &deviceConfig, this->device.get());
|
||||
if (result != MA_SUCCESS)
|
||||
{
|
||||
qCWarning(chatterinoSound) << "Error initializing device:" << result;
|
||||
return false;
|
||||
}
|
||||
|
||||
result = ma_device_start(this->device.get());
|
||||
if (result != MA_SUCCESS)
|
||||
{
|
||||
qCWarning(chatterinoSound) << "Error starting device:" << result;
|
||||
return false;
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
} // namespace chatterino
|
||||
Reference in New Issue
Block a user