Duckstation/src/common/audio_stream.cpp

#include "audio_stream.h"
#include "assert.h"
#include <algorithm>
#include <cstring>

AudioStream::AudioStream() = default;

AudioStream::~AudioStream() = default;

bool AudioStream::Reconfigure(u32 output_sample_rate /*= DefaultOutputSampleRate*/, u32 channels /*= 1*/,
                              u32 buffer_size /*= DefaultBufferSize*/, u32 buffer_count /*= DefaultBufferCount*/)
{
  if (IsDeviceOpen())
    CloseDevice();

  m_output_sample_rate = output_sample_rate;
  m_channels = channels;
  m_buffer_size = buffer_size;
  AllocateBuffers(buffer_count);
  m_output_paused = true;

  if (!OpenDevice())
  {
    EmptyBuffers();
    m_buffers.clear();
    m_buffer_size = 0;
    m_output_sample_rate = 0;
    m_channels = 0;
    return false;
  }

  return true;
}

void AudioStream::SetOutputVolume(s32 volume)
{
  std::unique_lock<std::mutex> lock(m_buffer_mutex);
  m_output_volume = volume;
}

void AudioStream::PauseOutput(bool paused)
{
  if (m_output_paused == paused)
    return;

  PauseDevice(paused);
  m_output_paused = paused;

  // Empty buffers on pause.
  if (paused)
    EmptyBuffers();
}

void AudioStream::Shutdown()
{
  if (!IsDeviceOpen())
    return;

  CloseDevice();
  EmptyBuffers();
  m_buffers.clear();
  m_buffer_size = 0;
  m_output_sample_rate = 0;
  m_channels = 0;
  m_output_paused = true;
}

void AudioStream::BeginWrite(SampleType** buffer_ptr, u32* num_frames)
{
  m_buffer_mutex.lock();

  EnsureBuffer();

  Buffer& buffer = m_buffers[m_first_free_buffer];
  *buffer_ptr = buffer.data.data() + (buffer.write_position * m_channels);
  *num_frames = m_buffer_size - buffer.write_position;
}

void AudioStream::WriteFrames(const SampleType* frames, u32 num_frames)
{
  u32 remaining_frames = num_frames;
  std::unique_lock<std::mutex> lock(m_buffer_mutex);

  while (remaining_frames > 0)
  {
    EnsureBuffer();

    Buffer& buffer = m_buffers[m_first_free_buffer];
    const u32 to_this_buffer = std::min(m_buffer_size - buffer.write_position, remaining_frames);

    const u32 copy_count = to_this_buffer * m_channels;
    std::memcpy(&buffer.data[buffer.write_position * m_channels], frames, copy_count * sizeof(SampleType));
    frames += copy_count;

    remaining_frames -= to_this_buffer;
    buffer.write_position += to_this_buffer;

    // End of the buffer?
    if (buffer.write_position == m_buffer_size)
    {
      // Reset it back to the start, and enqueue it.
      buffer.write_position = 0;
      m_num_free_buffers--;
      m_first_free_buffer = (m_first_free_buffer + 1) % m_buffers.size();
      m_num_available_buffers++;
      BufferAvailable();
    }
  }
}

void AudioStream::EndWrite(u32 num_frames)
{
  Buffer& buffer = m_buffers[m_first_free_buffer];
  DebugAssert((buffer.write_position + num_frames) <= m_buffer_size);
  buffer.write_position += num_frames;

  // End of the buffer?
  if (buffer.write_position == m_buffer_size)
  {
    // Reset it back to the start, and enqueue it.
    // Log_DevPrintf("Enqueue buffer %u", m_first_free_buffer);
    buffer.write_position = 0;
    m_num_free_buffers--;
    m_first_free_buffer = (m_first_free_buffer + 1) % m_buffers.size();
    m_num_available_buffers++;
    BufferAvailable();
  }

  m_buffer_mutex.unlock();
}

float AudioStream::GetMinLatency(u32 sample_rate, u32 buffer_size, u32 buffer_count)
{
  return (static_cast<float>(buffer_size) / static_cast<float>(sample_rate));
}

float AudioStream::GetMaxLatency(u32 sample_rate, u32 buffer_size, u32 buffer_count)
{
  return (static_cast<float>(buffer_size * (buffer_count - 1)) / static_cast<float>(sample_rate));
}

u32 AudioStream::GetSamplesAvailable() const
{
  // TODO: Use atomic loads
  u32 available_buffers;
  {
    std::unique_lock<std::mutex> lock(m_buffer_mutex);
    available_buffers = m_num_available_buffers;
  }

  return available_buffers * m_buffer_size;
}

u32 AudioStream::ReadSamples(SampleType* samples, u32 num_samples)
{
  u32 remaining_samples = num_samples;
  std::unique_lock<std::mutex> lock(m_buffer_mutex);

  while (remaining_samples > 0 && m_num_available_buffers > 0)
  {
    Buffer& buffer = m_buffers[m_first_available_buffer];
    const u32 from_this_buffer = std::min(m_buffer_size - buffer.read_position, remaining_samples);

    const u32 copy_count = from_this_buffer * m_channels;
    const SampleType* read_pointer = &buffer.data[buffer.read_position * m_channels];
    for (u32 i = 0; i < copy_count; i++)
      *(samples++) = ApplyVolume(*(read_pointer++), m_output_volume);

    remaining_samples -= from_this_buffer;
    buffer.read_position += from_this_buffer;

    if (buffer.read_position == m_buffer_size)
    {
      // Log_DevPrintf("Finish dequeing buffer %u", m_first_available_buffer);
      // End of this buffer.
      buffer.read_position = 0;
      m_num_available_buffers--;
      m_first_available_buffer = (m_first_available_buffer + 1) % m_buffers.size();
      m_num_free_buffers++;
      m_buffer_available_cv.notify_one();
    }
  }

  return num_samples - remaining_samples;
}

void AudioStream::AllocateBuffers(u32 buffer_count)
{
  m_buffers.resize(buffer_count);
  for (u32 i = 0; i < buffer_count; i++)
  {
    Buffer& buffer = m_buffers[i];
    buffer.data.resize(m_buffer_size * m_channels);
    buffer.read_position = 0;
    buffer.write_position = 0;
  }

  m_first_available_buffer = 0;
  m_num_available_buffers = 0;
  m_first_free_buffer = 0;
  m_num_free_buffers = buffer_count;
}

void AudioStream::EnsureBuffer()
{
  if (m_num_free_buffers > 0)
    return;

  if (m_sync)
  {
    std::unique_lock<std::mutex> lock(m_buffer_mutex, std::adopt_lock);
    m_buffer_available_cv.wait(lock, [this]() { return m_num_free_buffers > 0; });
    lock.release();
  }
  else
  {
    DropBuffer();
  }
}

void AudioStream::DropBuffer()
{
  DebugAssert(m_num_available_buffers > 0);
  // Log_DevPrintf("Dropping buffer %u", m_first_free_buffer);

  // Out of space. We'll overwrite the oldest buffer with the new data.
  // At the same time, we shift the available buffer forward one.
  m_first_available_buffer = (m_first_available_buffer + 1) % m_buffers.size();
  m_num_available_buffers--;

  m_buffers[m_first_free_buffer].read_position = 0;
  m_buffers[m_first_free_buffer].write_position = 0;
  m_num_free_buffers++;
}

void AudioStream::EmptyBuffers()
{
  std::unique_lock<std::mutex> lock(m_buffer_mutex);

  for (Buffer& buffer : m_buffers)
  {
    buffer.read_position = 0;
    buffer.write_position = 0;
  }

  m_first_free_buffer = 0;
  m_num_free_buffers = static_cast<u32>(m_buffers.size());
  m_first_available_buffer = 0;
  m_num_available_buffers = 0;
}