ladybird/Userland/Applications/SoundPlayer/Player.cpp

166 lines
4.3 KiB
C++
Raw Normal View History

/*
* Copyright (c) 2021, Cesar Torres <shortanemoia@protonmail.com>
* Copyright (c) 2021, Leandro A. F. Pereira <leandro@tia.mat.br>
*
* SPDX-License-Identifier: BSD-2-Clause
*/
#include "Player.h"
#include <LibAudio/FlacLoader.h>
#include <LibFileSystem/FileSystem.h>
Player::Player(Audio::ConnectionToServer& audio_client_connection)
: m_audio_client_connection(audio_client_connection)
, m_playback_manager(audio_client_connection)
{
m_playback_manager.on_update = [&]() {
LibAudio+Userland: Use new audio queue in client-server communication Previously, we were sending Buffers to the server whenever we had new audio data for it. This meant that for every audio enqueue action, we needed to create a new shared memory anonymous buffer, send that buffer's file descriptor over IPC (+recfd on the other side) and then map the buffer into the audio server's memory to be able to play it. This was fine for sending large chunks of audio data, like when playing existing audio files. However, in the future we want to move to real-time audio in some applications like Piano. This means that the size of buffers that are sent need to be very small, as just the size of a buffer itself is part of the audio latency. If we were to try real-time audio with the existing system, we would run into problems really quickly. Dealing with a continuous stream of new anonymous files like the current audio system is rather expensive, as we need Kernel help in multiple places. Additionally, every enqueue incurs an IPC call, which are not optimized for >1000 calls/second (which would be needed for real-time audio with buffer sizes of ~40 samples). So a fundamental change in how we handle audio sending in userspace is necessary. This commit moves the audio sending system onto a shared single producer circular queue (SSPCQ) (introduced with one of the previous commits). This queue is intended to live in shared memory and be accessed by multiple processes at the same time. It was specifically written to support the audio sending case, so e.g. it only supports a single producer (the audio client). Now, audio sending follows these general steps: - The audio client connects to the audio server. - The audio client creates a SSPCQ in shared memory. - The audio client sends the SSPCQ's file descriptor to the audio server with the set_buffer() IPC call. - The audio server receives the SSPCQ and maps it. - The audio client signals start of playback with start_playback(). - At the same time: - The audio client writes its audio data into the shared-memory queue. - The audio server reads audio data from the shared-memory queue(s). Both sides have additional before-queue/after-queue buffers, depending on the exact application. - Pausing playback is just an IPC call, nothing happens to the buffer except that the server stops reading from it until playback is resumed. - Muting has nothing to do with whether audio data is read or not. - When the connection closes, the queues are unmapped on both sides. This should already improve audio playback performance in a bunch of places. Implementation & commit notes: - Audio loaders don't create LegacyBuffers anymore. LegacyBuffer is kept for WavLoader, see previous commit message. - Most intra-process audio data passing is done with FixedArray<Sample> or Vector<Sample>. - Improvements to most audio-enqueuing applications. (If necessary I can try to extract some of the aplay improvements.) - New APIs on LibAudio/ClientConnection which allows non-realtime applications to enqueue audio in big chunks like before. - Removal of status APIs from the audio server connection for information that can be directly obtained from the shared queue. - Split the pause playback API into two APIs with more intuitive names. I know this is a large commit, and you can kinda tell from the commit message. It's basically impossible to break this up without hacks, so please forgive me. These are some of the best changes to the audio subsystem and I hope that that makes up for this :yaktangle: commit. :yakring:
2022-02-20 12:01:22 +00:00
auto samples_played = m_playback_manager.loader()->loaded_samples();
auto sample_rate = m_playback_manager.loader()->sample_rate();
float source_to_dest_ratio = static_cast<float>(sample_rate) / m_playback_manager.device_sample_rate();
samples_played *= source_to_dest_ratio;
auto played_seconds = samples_played / sample_rate;
time_elapsed(played_seconds);
sound_buffer_played(m_playback_manager.current_buffer(), m_playback_manager.device_sample_rate(), samples_played);
};
m_playback_manager.on_finished_playing = [&]() {
set_play_state(PlayState::Stopped);
switch (loop_mode()) {
case LoopMode::File:
play_file_path(loaded_filename());
return;
case LoopMode::Playlist:
play_file_path(m_playlist.next());
return;
case LoopMode::None:
return;
}
};
}
void Player::play_file_path(DeprecatedString const& path)
{
if (path.is_null())
return;
if (!FileSystem::exists(path)) {
audio_load_error(path, "File does not exist"sv);
return;
}
if (is_playlist(path)) {
playlist_loaded(path, m_playlist.load(path));
return;
}
2021-11-27 16:00:19 +00:00
auto maybe_loader = Audio::Loader::create(path);
if (maybe_loader.is_error()) {
audio_load_error(path, maybe_loader.error().description);
return;
}
2021-11-27 16:00:19 +00:00
auto loader = maybe_loader.value();
m_loaded_filename = path;
// TODO: The combination of sample count, sample rate, and sample data should be properly abstracted for the source and the playback device.
total_samples_changed(loader->total_samples() * (static_cast<float>(loader->sample_rate()) / m_playback_manager.device_sample_rate()));
m_playback_manager.set_loader(move(loader));
file_name_changed(path);
play();
}
bool Player::is_playlist(DeprecatedString const& path)
{
return (path.ends_with(".m3u"sv, AK::CaseSensitivity::CaseInsensitive)
|| path.ends_with(".m3u8"sv, AK::CaseSensitivity::CaseInsensitive));
}
void Player::set_play_state(PlayState state)
{
if (m_play_state != state) {
m_play_state = state;
play_state_changed(state);
}
}
void Player::set_loop_mode(LoopMode mode)
{
if (m_loop_mode != mode) {
m_loop_mode = mode;
m_playlist.set_looping(mode == LoopMode::Playlist);
loop_mode_changed(mode);
}
}
void Player::set_volume(double volume)
{
m_volume = clamp(volume, 0, 1.5);
m_audio_client_connection.set_self_volume(m_volume);
volume_changed(m_volume);
}
void Player::set_mute(bool muted)
{
if (m_muted != muted) {
m_muted = muted;
m_audio_client_connection.set_self_muted(muted);
mute_changed(muted);
}
}
void Player::set_shuffle_mode(ShuffleMode mode)
{
if (m_shuffle_mode != mode) {
m_shuffle_mode = mode;
m_playlist.set_shuffling(mode == ShuffleMode::Shuffling);
shuffle_mode_changed(mode);
}
}
void Player::play()
{
m_playback_manager.play();
set_play_state(PlayState::Playing);
}
void Player::pause()
{
m_playback_manager.pause();
set_play_state(PlayState::Paused);
}
void Player::toggle_pause()
{
bool paused = m_playback_manager.toggle_pause();
set_play_state(paused ? PlayState::Paused : PlayState::Playing);
}
void Player::stop()
{
m_playback_manager.stop();
set_play_state(PlayState::Stopped);
}
void Player::mute()
{
set_mute(true);
}
void Player::toggle_mute()
{
set_mute(!m_muted);
}
void Player::seek(int sample)
{
sample *= (m_playback_manager.device_sample_rate() / static_cast<float>(m_playback_manager.loader()->sample_rate()));
m_playback_manager.seek(sample);
}
Vector<Audio::PictureData> const& Player::pictures() const
{
return m_playback_manager.loader()->pictures();
}