Replace OpenAL by PortAudio #1040

roby2014 · 2024-02-27T22:22:42Z

Description

Replace OpenAL by PortAudio
PortAudio Implementation of AudioDevice
AudioDevice sample (output)
3D simple stuff

Checklist

Self-review changes.
Evaluate impact on the documentation.
Ensure test coverage.
Write new samples.
Add entry to the changelog's unreleased section.

…d implementation

github-actions · 2024-02-28T00:41:40Z

PR Preview Action v1.4.7
🚀 Deployed preview to https://GameDevTecnico.github.io/cubos/docs-preview/pr-1040/
on branch `gh-pages` at 2024-03-02 22:16 UTC

github-actions

⚠️ Clang-Tidy found issue(s) with the introduced code (1/1)

github-actions · 2024-02-28T00:42:05Z

core/samples/al/main.cpp

@@ -0,0 +1,15 @@
+#include <stdio.h>


⚠️ modernize-deprecated-headers ⚠️
inclusion of deprecated C++ header stdio.h; consider using cstdio instead

Suggested change

#include <stdio.h>

#include <cstdio>

github-actions · 2024-02-28T00:42:06Z

core/src/al/port_audio_device.cpp

+    auto err = Pa_Initialize();
+    if (err != paNoError)
+    {
+        CUBOS_FAIL("PortAudio failed to initialize: {}", Pa_GetErrorText(err));


⚠️ readability-identifier-naming ⚠️
invalid case style for global function Pa_GetErrorText

Suggested change

CUBOS_FAIL("PortAudio failed to initialize: {}", Pa_GetErrorText(err));

CUBOS_FAIL("PortAudio failed to initialize: {}", paGetErrorText(err));

github-actions · 2024-02-28T00:42:06Z

core/src/al/port_audio_device.cpp

+PortAudioDevice::PortAudioDevice(const std::string& specifier)
+{
+#ifdef WITH_PORTAUDIO
+    auto err = Pa_Initialize();


⚠️ readability-identifier-naming ⚠️
invalid case style for global function Pa_Initialize

Suggested change

auto err = Pa_Initialize();

auto err = paInitialize();

github-actions · 2024-02-28T00:42:06Z

core/src/al/port_audio_device.cpp

+PortAudioDevice::~PortAudioDevice()
+{
+#ifdef WITH_PORTAUDIO
+    Pa_Terminate();


⚠️ readability-identifier-naming ⚠️
invalid case style for global function Pa_Terminate

Suggested change

Pa_Terminate();

paTerminate();

github-actions · 2024-02-28T00:42:06Z

core/src/al/port_audio_device.cpp

+int PortAudioDevice::getDeviceCount()
+{
+#ifdef WITH_PORTAUDIO
+    return Pa_GetDeviceCount();


⚠️ readability-identifier-naming ⚠️
invalid case style for global function Pa_GetDeviceCount

Suggested change

return Pa_GetDeviceCount();

return paGetDeviceCount();

github-actions · 2024-02-28T00:42:06Z

core/src/al/port_audio_device.cpp

+    // TODO: should we store PaDeviceInfos instead of strings?
+    for (int i = 0; i < getDeviceCount(); i++)
+    {
+        devices.push_back(std::string(Pa_GetDeviceInfo(i)->name));


⚠️ readability-identifier-naming ⚠️
invalid case style for global function Pa_GetDeviceInfo

Suggested change

devices.push_back(std::string(Pa_GetDeviceInfo(i)->name));

devices.push_back(std::string(paGetDeviceInfo(i)->name));

github-actions · 2024-02-28T00:42:06Z

core/src/al/port_audio_device.cpp

+    // TODO: should we store PaDeviceInfos instead of strings?
+    for (int i = 0; i < getDeviceCount(); i++)
+    {
+        devices.push_back(std::string(Pa_GetDeviceInfo(i)->name));


⚠️ modernize-use-emplace ⚠️
use emplace_back instead of push_back

Suggested change

devices.push_back(std::string(Pa_GetDeviceInfo(i)->name));

devices.emplace_back(Pa_GetDeviceInfo(i)->name);

github-actions · 2024-02-28T00:42:06Z

core/src/al/port_audio_device.cpp

+#endif // WITH_PORTAUDIO
+}
+
+void PortAudioDevice::setListenerPosition(const glm::vec3&)


⚠️ readability-named-parameter ⚠️
all parameters should be named in a function

Suggested change

void PortAudioDevice::setListenerPosition(const glm::vec3&)

void PortAudioDevice::setListenerPosition(const glm::vec3& /*position*/)

github-actions · 2024-02-28T00:42:06Z

core/src/al/port_audio_device.cpp

+#endif // WITH_PORTAUDIO
+}
+
+void PortAudioDevice::setListenerOrientation(const glm::vec3&, const glm::vec3&)


⚠️ readability-named-parameter ⚠️
all parameters should be named in a function

Suggested change

void PortAudioDevice::setListenerOrientation(const glm::vec3&, const glm::vec3&)

void PortAudioDevice::setListenerOrientation(const glm::vec3& /*forward*/, const glm::vec3& /*up*/)

github-actions · 2024-02-28T00:42:06Z

core/src/al/port_audio_device.cpp

+#endif // WITH_PORTAUDIO
+}
+
+void PortAudioDevice::setListenerVelocity(const glm::vec3&)


⚠️ readability-named-parameter ⚠️
all parameters should be named in a function

Suggested change

void PortAudioDevice::setListenerVelocity(const glm::vec3&)

void PortAudioDevice::setListenerVelocity(const glm::vec3& /*velocity*/)

codecov · 2024-02-28T00:50:21Z

Codecov Report

Attention: Patch coverage is 0% with 93 lines in your changes are missing coverage. Please review.

Project coverage is 37.68%. Comparing base (bc3df3b) to head (02f11e5).
Report is 11 commits behind head on main.

❗ Current head 02f11e5 differs from pull request most recent head ac2742d. Consider uploading reports for the commit ac2742d to get more accurate results

Files	Patch %	Lines
core/src/al/port_audio_device.cpp	0.00%	83 Missing ⚠️
core/src/al/audio_device.cpp	0.00%	10 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1040      +/-   ##
==========================================
- Coverage   37.70%   37.68%   -0.03%     
==========================================
  Files         302      303       +1     
  Lines       25036    25051      +15     
==========================================
  Hits         9441     9441              
- Misses      15595    15610      +15

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

github-actions

⚠️ Clang-Tidy found issue(s) with the introduced code (1/3)

github-actions · 2024-02-28T17:27:15Z

core/src/al/port_audio_device.hpp

+        PortAudioOutputCallbackFn callback;
+
+    private:
+        int outputDeviceID;


⚠️ readability-identifier-naming ⚠️
invalid case style for private member outputDeviceID

Suggested change

int outputDeviceID;

int mOutputDeviceId;

github-actions · 2024-02-28T17:27:15Z

core/src/al/port_audio_device.hpp

+
+    private:
+        int outputDeviceID;
+        PaStream* stream;


⚠️ readability-identifier-naming ⚠️
invalid case style for private member stream

Suggested change

PaStream* stream;

PaStream* mStream;

github-actions · 2024-02-28T17:27:15Z

core/src/al/port_audio_device.cpp

+static int paCallback(const void*, void* outputBuffer, unsigned long framesPerBuffer,
+                                const PaStreamCallbackTimeInfo*, PaStreamCallbackFlags flags, void* userData)


⚠️ readability-named-parameter ⚠️
all parameters should be named in a function

Suggested change

static int paCallback(const void*, void* outputBuffer, unsigned long framesPerBuffer,

const PaStreamCallbackTimeInfo*, PaStreamCallbackFlags flags, void* userData)

static int paCallback(const void* /*unused*/, void* outputBuffer, unsigned long framesPerBuffer,

const PaStreamCallbackTimeInfo* /*unused*/, PaStreamCallbackFlags flags, void* userData)

github-actions · 2024-02-28T17:27:16Z

core/src/al/port_audio_device.cpp

+static int paCallback(const void*, void* outputBuffer, unsigned long framesPerBuffer,
+                                const PaStreamCallbackTimeInfo*, PaStreamCallbackFlags flags, void* userData)
+{
+    PortAudioDevice* portAudioDevice = static_cast<PortAudioDevice*>(userData);


⚠️ modernize-use-auto ⚠️
use auto when initializing with a cast to avoid duplicating the type name

Suggested change

PortAudioDevice* portAudioDevice = static_cast<PortAudioDevice*>(userData);

auto* portAudioDevice = static_cast<PortAudioDevice*>(userData);

github-actions · 2024-02-28T17:27:16Z

core/src/al/port_audio_device.cpp

+
+PortAudioDevice::~PortAudioDevice()
+{
+    if (stream)


⚠️ readability-implicit-bool-conversion ⚠️
implicit conversion PaStream * (aka void *) -> bool

Suggested change

if (stream)

if (stream != nullptr)

github-actions · 2024-02-28T17:27:16Z

core/src/al/port_audio_device.cpp

+    if (stream)
+    {
+        // FIXME: double stop?»
+        stop();


⚠️ clang-analyzer-optin.cplusplus.VirtualCall ⚠️
Call to virtual method PortAudioDevice::stop during destruction bypasses virtual dispatch

github-actions · 2024-02-28T17:27:16Z

core/src/al/port_audio_device.cpp

+    devices.clear();
+    for (int i = 0; i < deviceCount(); i++)
+    {
+        auto deviceInfo = Pa_GetDeviceInfo(i);


⚠️ readability-qualified-auto ⚠️
auto deviceInfo can be declared as const auto *deviceInfo

Suggested change

auto deviceInfo = Pa_GetDeviceInfo(i);

const auto *deviceInfo = Pa_GetDeviceInfo(i);

github-actions · 2024-02-28T17:27:16Z

core/src/al/port_audio_device.cpp

+    {
+        if (i == deviceIndex)
+        {
+            auto deviceInfo = Pa_GetDeviceInfo(i);


⚠️ readability-qualified-auto ⚠️
auto deviceInfo can be declared as const auto *deviceInfo

Suggested change

auto deviceInfo = Pa_GetDeviceInfo(i);

const auto *deviceInfo = Pa_GetDeviceInfo(i);

github-actions · 2024-02-28T17:27:16Z

core/src/al/port_audio_device.cpp

+    {
+        if (i == deviceIndex)
+        {
+            auto deviceInfo = Pa_GetDeviceInfo(i);


⚠️ readability-qualified-auto ⚠️
auto deviceInfo can be declared as const auto *deviceInfo

Suggested change

auto deviceInfo = Pa_GetDeviceInfo(i);

const auto *deviceInfo = Pa_GetDeviceInfo(i);

github-actions · 2024-02-28T17:27:16Z

core/src/al/port_audio_device.cpp

+#ifdef WITH_PORTAUDIO
+    CUBOS_TODO();
+#else
+    UNSUPPORTED();
+#endif // WITH_PORTAUDIO


⚠️ readability-named-parameter ⚠️
all parameters should be named in a function

Suggested change

#ifdef WITH_PORTAUDIO

CUBOS_TODO();

#else

UNSUPPORTED();

#endif // WITH_PORTAUDIO

#ifdef WITH_PORTAUDIO

CUBOS_TODO();

#else

UNSUPPORTED();

#endif // WITH_PORTAUDIO

github-actions

⚠️ Clang-Tidy found issue(s) with the introduced code (2/3)

github-actions · 2024-02-28T17:27:28Z

core/src/al/port_audio_device.hpp

+        PortAudioOutputCallbackFn callback;
+
+    private:
+        int outputDeviceID;


⚠️ readability-identifier-naming ⚠️
invalid case style for private member outputDeviceID

Suggested change

int outputDeviceID;

int mOutputDeviceId;

github-actions · 2024-02-28T17:27:28Z

core/src/al/port_audio_device.cpp

+}
+
+PortAudioDevice::PortAudioDevice(int deviceIndex)
+    : outputDeviceID(deviceIndex)


⚠️ readability-identifier-naming ⚠️
invalid case style for private member outputDeviceID

Suggested change

: outputDeviceID(deviceIndex)

: mOutputDeviceId(deviceIndex)

github-actions · 2024-02-28T17:27:28Z

core/src/al/port_audio_device.cpp

+
+    CUBOS_INFO("PortAudio initialized");
+
+    if (outputDeviceID == -1)


⚠️ readability-identifier-naming ⚠️
invalid case style for private member outputDeviceID

Suggested change

if (outputDeviceID == -1)

if (mOutputDeviceId == -1)

github-actions · 2024-02-28T17:27:28Z

core/src/al/port_audio_device.cpp

+        outputDeviceID = Pa_GetDefaultOutputDevice();
+        CUBOS_INFO("PortAudio will use default output device ('{}') :", outputDeviceID);
+        printDeviceInformation(outputDeviceID);


⚠️ readability-identifier-naming ⚠️
invalid case style for private member outputDeviceID

Suggested change

outputDeviceID = Pa_GetDefaultOutputDevice();

CUBOS_INFO("PortAudio will use default output device ('{}') :", outputDeviceID);

printDeviceInformation(outputDeviceID);

mOutputDeviceId = Pa_GetDefaultOutputDevice();

CUBOS_INFO("PortAudio will use default output device ('{}') :", mOutputDeviceId);

printDeviceInformation(mOutputDeviceId);

github-actions · 2024-02-28T17:27:28Z

core/src/al/port_audio_device.cpp

+    CUBOS_INFO("Custom output callback function set");
+
+    PaStreamParameters outputParameters;
+    outputParameters.device = outputDeviceID;


⚠️ readability-identifier-naming ⚠️
invalid case style for private member outputDeviceID

Suggested change

outputParameters.device = outputDeviceID;

outputParameters.device = mOutputDeviceId;

github-actions · 2024-02-28T17:27:28Z

core/src/al/port_audio_device.cpp

+    PaStreamParameters outputParameters;
+    outputParameters.device = outputDeviceID;
+    // FIXME: what should be specified by the user?
+    outputParameters.channelCount = Pa_GetDeviceInfo(outputDeviceID)->maxOutputChannels;


⚠️ readability-identifier-naming ⚠️
invalid case style for private member outputDeviceID

Suggested change

outputParameters.channelCount = Pa_GetDeviceInfo(outputDeviceID)->maxOutputChannels;

outputParameters.channelCount = Pa_GetDeviceInfo(mOutputDeviceId)->maxOutputChannels;

github-actions · 2024-02-28T17:27:28Z

core/src/al/port_audio_device.cpp

+    // FIXME: what should be specified by the user?
+    outputParameters.channelCount = Pa_GetDeviceInfo(outputDeviceID)->maxOutputChannels;
+    outputParameters.sampleFormat = paFloat32;
+    outputParameters.suggestedLatency = Pa_GetDeviceInfo(outputDeviceID)->defaultLowOutputLatency;


⚠️ readability-identifier-naming ⚠️
invalid case style for private member outputDeviceID

Suggested change

outputParameters.suggestedLatency = Pa_GetDeviceInfo(outputDeviceID)->defaultLowOutputLatency;

outputParameters.suggestedLatency = Pa_GetDeviceInfo(mOutputDeviceId)->defaultLowOutputLatency;

github-actions · 2024-02-28T17:27:29Z

core/src/al/port_audio_device.hpp

+
+    private:
+        int outputDeviceID;
+        PaStream* stream;


⚠️ modernize-use-default-member-init ⚠️
use default member initializer for stream

Suggested change

PaStream* stream;

PaStream* stream{nullptr};

github-actions · 2024-02-28T17:27:29Z

core/src/al/port_audio_device.cpp

+
+PortAudioDevice::PortAudioDevice(int deviceIndex)
+    : outputDeviceID(deviceIndex)
+    , stream(nullptr)


⚠️ modernize-use-default-member-init ⚠️
use default member initializer for stream

Suggested change

, stream(nullptr)

,

github-actions · 2024-02-28T17:27:29Z

core/src/al/port_audio_device.hpp

+
+    private:
+        int outputDeviceID;
+        PaStream* stream;


⚠️ readability-identifier-naming ⚠️
invalid case style for private member stream

github-actions

⚠️ Clang-Tidy found issue(s) with the introduced code (3/3)

github-actions · 2024-02-28T17:27:40Z

core/src/al/port_audio_device.hpp

+        PortAudioOutputCallbackFn callback;
+
+    private:
+        int outputDeviceID;


⚠️ readability-identifier-naming ⚠️
invalid case style for private member outputDeviceID

Suggested change

int outputDeviceID;

int mOutputDeviceId;

github-actions · 2024-02-28T17:27:41Z

core/src/al/port_audio_device.hpp

+
+    private:
+        int outputDeviceID;
+        PaStream* stream;


⚠️ readability-identifier-naming ⚠️
invalid case style for private member stream

Suggested change

PaStream* stream;

PaStream* mStream;

github-actions · 2024-02-28T17:27:41Z

core/samples/al/main.cpp

+    audio->enumerateDevices(devices, true);
+
+    audio->init([](void* outputBuffer, unsigned long framesPerBuffer, unsigned long, void*) -> int {
+        float* out = static_cast<float*>(outputBuffer);


⚠️ modernize-use-auto ⚠️
use auto when initializing with a cast to avoid duplicating the type name

Suggested change

float* out = static_cast<float*>(outputBuffer);

auto* out = static_cast<float*>(outputBuffer);

github-actions · 2024-02-28T17:27:41Z

core/samples/al/main.cpp

+        float* out = static_cast<float*>(outputBuffer);
+        for (unsigned int i = 0; i < framesPerBuffer; i++)
+        {
+            *out++ = 0.5f * static_cast<float>(std::sin(2.0 * 3.141592653589793 * 440.0 * i / 44100.0));


⚠️ readability-uppercase-literal-suffix ⚠️
floating point literal has suffix f, which is not uppercase

Suggested change

*out++ = 0.5f * static_cast<float>(std::sin(2.0 * 3.141592653589793 * 440.0 * i / 44100.0));

*out++ = 0.5F * static_cast<float>(std::sin(2.0 * 3.141592653589793 * 440.0 * i / 44100.0));

roby2014 · 2024-09-22T19:20:11Z

Closing due to: members already working in another solution

refactor(core): replace OpenAL by PortAudio

c91116e

roby2014 added A-Core B-Audio labels Feb 27, 2024

roby2014 self-assigned this Feb 27, 2024

roby2014 linked an issue Feb 27, 2024 that may be closed by this pull request

Replace OpenAL audio device by another backend #1005

Closed

roby2014 added 3 commits February 28, 2024 00:38

feat(core): AudioDevice impl for PortAudio

6d432ec

samples(al): add AudioDevice simple sample

0a40d6e

refactor(AudioDevice): impl getDeviceCount and changed default backen…

c2c3477

…d implementation

github-actions bot requested changes Feb 28, 2024

View reviewed changes

roby2014 added 2 commits February 28, 2024 17:25

portaudio audiodevice impl

d23827e

portaudio sample

02f11e5

github-actions bot requested changes Feb 28, 2024

View reviewed changes

sync

ac2742d

roby2014 closed this Sep 22, 2024

roby2014 deleted the 1005-replace-openal-audio-device-by-another-backend branch September 22, 2024 19:20

	CUBOS_FAIL("PortAudio failed to initialize: {}", Pa_GetErrorText(err));
	CUBOS_FAIL("PortAudio failed to initialize: {}", paGetErrorText(err));

	devices.push_back(std::string(Pa_GetDeviceInfo(i)->name));
	devices.push_back(std::string(paGetDeviceInfo(i)->name));

	devices.push_back(std::string(Pa_GetDeviceInfo(i)->name));
	devices.emplace_back(Pa_GetDeviceInfo(i)->name);

	void PortAudioDevice::setListenerPosition(const glm::vec3&)
	void PortAudioDevice::setListenerPosition(const glm::vec3& /position/)

	void PortAudioDevice::setListenerOrientation(const glm::vec3&, const glm::vec3&)
	void PortAudioDevice::setListenerOrientation(const glm::vec3& /forward/, const glm::vec3& /up/)

	void PortAudioDevice::setListenerVelocity(const glm::vec3&)
	void PortAudioDevice::setListenerVelocity(const glm::vec3& /velocity/)

		static int paCallback(const void, void outputBuffer, unsigned long framesPerBuffer,
		const PaStreamCallbackTimeInfo, PaStreamCallbackFlags flags, void userData)

	PortAudioDevice* portAudioDevice = static_cast<PortAudioDevice*>(userData);
	auto* portAudioDevice = static_cast<PortAudioDevice*>(userData);

	auto deviceInfo = Pa_GetDeviceInfo(i);
	const auto *deviceInfo = Pa_GetDeviceInfo(i);


		CUBOS_INFO("PortAudio initialized");

		if (outputDeviceID == -1)

	outputParameters.device = outputDeviceID;
	outputParameters.device = mOutputDeviceId;

	outputParameters.channelCount = Pa_GetDeviceInfo(outputDeviceID)->maxOutputChannels;
	outputParameters.channelCount = Pa_GetDeviceInfo(mOutputDeviceId)->maxOutputChannels;

	outputParameters.suggestedLatency = Pa_GetDeviceInfo(outputDeviceID)->defaultLowOutputLatency;
	outputParameters.suggestedLatency = Pa_GetDeviceInfo(mOutputDeviceId)->defaultLowOutputLatency;

	float* out = static_cast<float*>(outputBuffer);
	auto* out = static_cast<float*>(outputBuffer);

	out++ = 0.5f static_cast<float>(std::sin(2.0 * 3.141592653589793 * 440.0 * i / 44100.0));
	out++ = 0.5F static_cast<float>(std::sin(2.0 * 3.141592653589793 * 440.0 * i / 44100.0));

Replace OpenAL by PortAudio #1040

Replace OpenAL by PortAudio #1040

Conversation

roby2014 commented Feb 27, 2024 • edited Loading

Description

Checklist

github-actions bot commented Feb 28, 2024 • edited Loading

github-actions bot left a comment

Choose a reason for hiding this comment

github-actions bot Feb 28, 2024

Choose a reason for hiding this comment

github-actions bot Feb 28, 2024

Choose a reason for hiding this comment

github-actions bot Feb 28, 2024

Choose a reason for hiding this comment

github-actions bot Feb 28, 2024

Choose a reason for hiding this comment

github-actions bot Feb 28, 2024

Choose a reason for hiding this comment

github-actions bot Feb 28, 2024

Choose a reason for hiding this comment

github-actions bot Feb 28, 2024

Choose a reason for hiding this comment

github-actions bot Feb 28, 2024

Choose a reason for hiding this comment

github-actions bot Feb 28, 2024

Choose a reason for hiding this comment

github-actions bot Feb 28, 2024

Choose a reason for hiding this comment

codecov bot commented Feb 28, 2024 • edited Loading

Codecov Report

github-actions bot left a comment

Choose a reason for hiding this comment

github-actions bot Feb 28, 2024

Choose a reason for hiding this comment

github-actions bot Feb 28, 2024

Choose a reason for hiding this comment

github-actions bot Feb 28, 2024

Choose a reason for hiding this comment

github-actions bot Feb 28, 2024

Choose a reason for hiding this comment

github-actions bot Feb 28, 2024

Choose a reason for hiding this comment

github-actions bot Feb 28, 2024

Choose a reason for hiding this comment

github-actions bot Feb 28, 2024

Choose a reason for hiding this comment

github-actions bot Feb 28, 2024

Choose a reason for hiding this comment

github-actions bot Feb 28, 2024

Choose a reason for hiding this comment

github-actions bot Feb 28, 2024

Choose a reason for hiding this comment

github-actions bot left a comment

Choose a reason for hiding this comment

github-actions bot Feb 28, 2024

Choose a reason for hiding this comment

github-actions bot Feb 28, 2024

Choose a reason for hiding this comment

github-actions bot Feb 28, 2024

Choose a reason for hiding this comment

github-actions bot Feb 28, 2024

Choose a reason for hiding this comment

github-actions bot Feb 28, 2024

Choose a reason for hiding this comment

github-actions bot Feb 28, 2024

Choose a reason for hiding this comment

github-actions bot Feb 28, 2024

Choose a reason for hiding this comment

github-actions bot Feb 28, 2024

Choose a reason for hiding this comment

github-actions bot Feb 28, 2024

Choose a reason for hiding this comment

github-actions bot Feb 28, 2024

Choose a reason for hiding this comment

github-actions bot left a comment

Choose a reason for hiding this comment

github-actions bot Feb 28, 2024

Choose a reason for hiding this comment

github-actions bot Feb 28, 2024

roby2014 commented Feb 27, 2024 •

edited

Loading

github-actions bot commented Feb 28, 2024 •

edited

Loading

codecov bot commented Feb 28, 2024 •

edited

Loading