2021-03-21 11:49:14 +00:00
|
|
|
/*
|
|
|
|
* Copyright (c) 2021, Cesar Torres <shortanemoia@protonmail.com>
|
2022-02-10 19:28:48 +00:00
|
|
|
* Copyright (c) 2022, the SerenityOS developers.
|
2021-03-21 11:49:14 +00:00
|
|
|
*
|
2021-04-22 08:24:48 +00:00
|
|
|
* SPDX-License-Identifier: BSD-2-Clause
|
2021-03-21 11:49:14 +00:00
|
|
|
*/
|
|
|
|
|
|
|
|
#pragma once
|
|
|
|
|
|
|
|
#include "PlaybackManager.h"
|
2021-09-30 04:55:42 +00:00
|
|
|
#include "Playlist.h"
|
2021-03-26 00:26:12 +00:00
|
|
|
#include "PlaylistWidget.h"
|
2021-03-23 23:12:50 +00:00
|
|
|
#include <AK/RefPtr.h>
|
2022-10-03 23:07:18 +00:00
|
|
|
#include <LibAudio/GenericTypes.h>
|
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
|
|
|
#include <LibAudio/Sample.h>
|
2021-03-23 23:12:50 +00:00
|
|
|
|
2021-03-21 11:49:14 +00:00
|
|
|
class Player {
|
|
|
|
public:
|
2021-09-30 04:55:42 +00:00
|
|
|
enum class PlayState {
|
|
|
|
NoFileLoaded,
|
|
|
|
Paused,
|
|
|
|
Stopped,
|
|
|
|
Playing,
|
|
|
|
};
|
|
|
|
enum class LoopMode {
|
|
|
|
None,
|
|
|
|
File,
|
|
|
|
Playlist,
|
|
|
|
};
|
2021-09-30 14:41:00 +00:00
|
|
|
enum class ShuffleMode {
|
|
|
|
None,
|
|
|
|
Shuffling,
|
|
|
|
};
|
2021-03-23 23:12:50 +00:00
|
|
|
|
2022-07-17 09:31:01 +00:00
|
|
|
explicit Player(Audio::ConnectionToServer& audio_client_connection);
|
2022-02-10 19:28:48 +00:00
|
|
|
virtual ~Player() = default;
|
2021-03-23 23:12:50 +00:00
|
|
|
|
2023-12-16 14:19:34 +00:00
|
|
|
void play_file_path(ByteString const& path);
|
|
|
|
bool is_playlist(ByteString const& path);
|
2021-09-30 04:55:42 +00:00
|
|
|
|
|
|
|
Playlist& playlist() { return m_playlist; }
|
2023-03-07 16:32:05 +00:00
|
|
|
PlaybackManager const& playback_manager() const { return m_playback_manager; }
|
2023-12-16 14:19:34 +00:00
|
|
|
ByteString const& loaded_filename() const { return m_loaded_filename; }
|
2021-09-30 04:55:42 +00:00
|
|
|
|
|
|
|
PlayState play_state() const { return m_play_state; }
|
2021-09-30 14:41:00 +00:00
|
|
|
void set_play_state(PlayState);
|
2021-09-30 04:55:42 +00:00
|
|
|
|
|
|
|
LoopMode loop_mode() const { return m_loop_mode; }
|
2021-09-30 14:41:00 +00:00
|
|
|
void set_loop_mode(LoopMode);
|
|
|
|
|
|
|
|
ShuffleMode shuffle_mode() const { return m_shuffle_mode; }
|
|
|
|
void set_shuffle_mode(ShuffleMode);
|
2021-09-30 04:55:42 +00:00
|
|
|
|
|
|
|
double volume() const { return m_volume; }
|
|
|
|
void set_volume(double value);
|
|
|
|
|
2021-11-02 01:31:05 +00:00
|
|
|
bool is_muted() const { return m_muted; }
|
|
|
|
void set_mute(bool);
|
|
|
|
|
2021-09-30 04:55:42 +00:00
|
|
|
void play();
|
|
|
|
void pause();
|
|
|
|
void toggle_pause();
|
|
|
|
void stop();
|
|
|
|
void seek(int sample);
|
2021-11-02 01:31:05 +00:00
|
|
|
void mute();
|
|
|
|
void toggle_mute();
|
2021-09-30 04:55:42 +00:00
|
|
|
|
|
|
|
virtual void play_state_changed(PlayState) = 0;
|
|
|
|
virtual void loop_mode_changed(LoopMode) = 0;
|
|
|
|
virtual void time_elapsed(int) = 0;
|
|
|
|
virtual void file_name_changed(StringView) = 0;
|
2021-09-30 14:41:00 +00:00
|
|
|
virtual void playlist_loaded(StringView, bool) = 0;
|
|
|
|
virtual void audio_load_error(StringView, StringView) = 0;
|
|
|
|
virtual void shuffle_mode_changed(ShuffleMode) = 0;
|
|
|
|
virtual void volume_changed(double) = 0;
|
2021-11-02 01:31:05 +00:00
|
|
|
virtual void mute_changed(bool) = 0;
|
2021-09-30 14:41:00 +00:00
|
|
|
virtual void total_samples_changed(int) = 0;
|
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
|
|
|
virtual void sound_buffer_played(FixedArray<Audio::Sample> const&, [[maybe_unused]] int sample_rate, [[maybe_unused]] int samples_played) = 0;
|
2021-09-30 04:55:42 +00:00
|
|
|
|
2022-10-03 23:07:18 +00:00
|
|
|
Vector<Audio::PictureData> const& pictures() const;
|
|
|
|
|
2021-09-30 04:55:42 +00:00
|
|
|
protected:
|
|
|
|
void done_initializing()
|
2021-03-26 00:26:12 +00:00
|
|
|
{
|
2021-09-30 04:55:42 +00:00
|
|
|
set_play_state(PlayState::NoFileLoaded);
|
|
|
|
set_loop_mode(LoopMode::None);
|
|
|
|
time_elapsed(0);
|
|
|
|
set_volume(1.);
|
2021-11-02 01:31:05 +00:00
|
|
|
set_mute(false);
|
2021-03-23 23:12:50 +00:00
|
|
|
}
|
|
|
|
|
2021-09-30 04:55:42 +00:00
|
|
|
private:
|
|
|
|
Playlist m_playlist;
|
2022-03-18 07:28:16 +00:00
|
|
|
PlayState m_play_state { PlayState::NoFileLoaded };
|
|
|
|
LoopMode m_loop_mode { LoopMode::None };
|
|
|
|
ShuffleMode m_shuffle_mode { ShuffleMode::None };
|
2021-03-23 23:12:50 +00:00
|
|
|
|
2022-07-17 09:31:01 +00:00
|
|
|
Audio::ConnectionToServer& m_audio_client_connection;
|
2021-09-30 04:55:42 +00:00
|
|
|
PlaybackManager m_playback_manager;
|
2021-04-15 17:43:29 +00:00
|
|
|
|
2023-12-16 14:19:34 +00:00
|
|
|
ByteString m_loaded_filename;
|
2021-09-30 04:55:42 +00:00
|
|
|
double m_volume { 0 };
|
2021-11-02 01:31:05 +00:00
|
|
|
bool m_muted { false };
|
2021-03-21 11:49:14 +00:00
|
|
|
};
|