Torque3D/Engine/lib/openal-soft/alc/backends/portaudio.cpp

/**
 * OpenAL cross platform audio library
 * Copyright (C) 1999-2007 by authors.
 * This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Library General Public
 *  License as published by the Free Software Foundation; either
 *  version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
 *  License along with this library; if not, write to the
 *  Free Software Foundation, Inc.,
 *  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 * Or go to http://www.gnu.org/copyleft/lgpl.html
 */

#include "config.h"

#include "portaudio.hpp"

#include <cmath>
#include <cstdio>
#include <cstdlib>
#include <cstring>

#include "alc/alconfig.h"
#include "core/device.h"
#include "core/logging.h"
#include "dynload.h"
#include "ringbuffer.h"

#include <portaudio.h>


namespace {

#if HAVE_DYNLOAD
void *pa_handle;
#define MAKE_FUNC(x) decltype(x) * p##x
MAKE_FUNC(Pa_Initialize);
MAKE_FUNC(Pa_Terminate);
MAKE_FUNC(Pa_GetErrorText);
MAKE_FUNC(Pa_StartStream);
MAKE_FUNC(Pa_StopStream);
MAKE_FUNC(Pa_OpenStream);
MAKE_FUNC(Pa_CloseStream);
MAKE_FUNC(Pa_GetDeviceCount);
MAKE_FUNC(Pa_GetDeviceInfo);
MAKE_FUNC(Pa_GetDefaultOutputDevice);
MAKE_FUNC(Pa_GetDefaultInputDevice);
MAKE_FUNC(Pa_GetStreamInfo);
#undef MAKE_FUNC

#ifndef IN_IDE_PARSER
#define Pa_Initialize                  pPa_Initialize
#define Pa_Terminate                   pPa_Terminate
#define Pa_GetErrorText                pPa_GetErrorText
#define Pa_StartStream                 pPa_StartStream
#define Pa_StopStream                  pPa_StopStream
#define Pa_OpenStream                  pPa_OpenStream
#define Pa_CloseStream                 pPa_CloseStream
#define Pa_GetDeviceCount              pPa_GetDeviceCount
#define Pa_GetDeviceInfo               pPa_GetDeviceInfo
#define Pa_GetDefaultOutputDevice      pPa_GetDefaultOutputDevice
#define Pa_GetDefaultInputDevice       pPa_GetDefaultInputDevice
#define Pa_GetStreamInfo               pPa_GetStreamInfo
#endif
#endif

struct DeviceEntry {
    std::string mName;
    uint mPlaybackChannels{};
    uint mCaptureChannels{};
};
std::vector<DeviceEntry> DeviceNames;

void EnumerateDevices()
{
    const auto devcount = Pa_GetDeviceCount();
    if(devcount < 0)
    {
        ERR("Error getting device count: {}", Pa_GetErrorText(devcount));
        return;
    }

    std::vector<DeviceEntry>(static_cast<uint>(devcount)).swap(DeviceNames);
    PaDeviceIndex idx{0};
    for(auto &entry : DeviceNames)
    {
        if(auto info = Pa_GetDeviceInfo(idx); info && info->name)
        {
            entry.mName = info->name;
            entry.mPlaybackChannels = static_cast<uint>(std::max(info->maxOutputChannels, 0));
            entry.mCaptureChannels = static_cast<uint>(std::max(info->maxInputChannels, 0));
            TRACE("Device {} \"{}\": {} playback, {} capture channels", idx, entry.mName,
                info->maxOutputChannels, info->maxInputChannels);
        }
        ++idx;
    }
}

struct StreamParamsExt : public PaStreamParameters { uint updateSize; };

struct PortPlayback final : public BackendBase {
    explicit PortPlayback(DeviceBase *device) noexcept : BackendBase{device} { }
    ~PortPlayback() override;

    int writeCallback(const void *inputBuffer, void *outputBuffer, unsigned long framesPerBuffer,
        const PaStreamCallbackTimeInfo *timeInfo, const PaStreamCallbackFlags statusFlags) noexcept;

    void createStream(PaDeviceIndex deviceid);

    void open(std::string_view name) override;
    bool reset() override;
    void start() override;
    void stop() override;

    PaStream *mStream{nullptr};
    StreamParamsExt mParams{};
    PaDeviceIndex mDeviceIdx{-1};
};

PortPlayback::~PortPlayback()
{
    PaError err{mStream ? Pa_CloseStream(mStream) : paNoError};
    if(err != paNoError)
        ERR("Error closing stream: {}", Pa_GetErrorText(err));
    mStream = nullptr;
}


int PortPlayback::writeCallback(const void*, void *outputBuffer, unsigned long framesPerBuffer,
    const PaStreamCallbackTimeInfo*, const PaStreamCallbackFlags) noexcept
{
    mDevice->renderSamples(outputBuffer, static_cast<uint>(framesPerBuffer),
        static_cast<uint>(mParams.channelCount));
    return 0;
}


void PortPlayback::createStream(PaDeviceIndex deviceid)
{
    auto &devinfo = DeviceNames.at(static_cast<uint>(deviceid));

    auto params = StreamParamsExt{};
    params.device = deviceid;
    params.suggestedLatency = mDevice->mBufferSize / static_cast<double>(mDevice->mSampleRate);
    params.hostApiSpecificStreamInfo = nullptr;
    params.channelCount = static_cast<int>(std::min(devinfo.mPlaybackChannels,
        mDevice->channelsFromFmt()));
    switch(mDevice->FmtType)
    {
    case DevFmtByte: params.sampleFormat = paInt8; break;
    case DevFmtUByte: params.sampleFormat = paUInt8; break;
    case DevFmtUShort: [[fallthrough]];
    case DevFmtShort: params.sampleFormat = paInt16; break;
    case DevFmtUInt: [[fallthrough]];
    case DevFmtInt: params.sampleFormat = paInt32; break;
    case DevFmtFloat: params.sampleFormat = paFloat32; break;
    }
    params.updateSize = mDevice->mUpdateSize;

    auto srate = uint{mDevice->mSampleRate};

    static constexpr auto writeCallback = [](const void *inputBuffer, void *outputBuffer,
        unsigned long framesPerBuffer, const PaStreamCallbackTimeInfo *timeInfo,
        const PaStreamCallbackFlags statusFlags, void *userData) noexcept
    {
        return static_cast<PortPlayback*>(userData)->writeCallback(inputBuffer, outputBuffer,
            framesPerBuffer, timeInfo, statusFlags);
    };
    while(PaError err{Pa_OpenStream(&mStream, nullptr, &params, srate, params.updateSize, paNoFlag,
        writeCallback, this)})
    {
        if(params.updateSize != DefaultUpdateSize)
            params.updateSize = DefaultUpdateSize;
        else if(srate != 48000u)
            srate = (srate != 44100u) ? 44100u : 48000u;
        else if(params.sampleFormat != paInt16)
            params.sampleFormat = paInt16;
        else if(params.channelCount != 2)
            params.channelCount = 2;
        else
            throw al::backend_exception{al::backend_error::NoDevice, "Failed to open stream: {}",
                Pa_GetErrorText(err)};
    }

    mParams = params;
}

void PortPlayback::open(std::string_view name)
{
    if(DeviceNames.empty())
        EnumerateDevices();

    PaDeviceIndex deviceid{-1};
    if(name.empty())
    {
        if(auto devidopt = ConfigValueInt({}, "port", "device"))
            deviceid = *devidopt;
        if(deviceid < 0 || static_cast<uint>(deviceid) >= DeviceNames.size())
            deviceid = Pa_GetDefaultOutputDevice();
        name = DeviceNames.at(static_cast<uint>(deviceid)).mName;
    }
    else
    {
        auto iter = std::find_if(DeviceNames.cbegin(), DeviceNames.cend(),
            [name](const DeviceEntry &entry)
            { return entry.mPlaybackChannels > 0 && name == entry.mName; });
        if(iter == DeviceNames.cend())
            throw al::backend_exception{al::backend_error::NoDevice,
                "Device name \"{}\" not found", name};
        deviceid = static_cast<int>(std::distance(DeviceNames.cbegin(), iter));
    }

    createStream(deviceid);
    mDeviceIdx = deviceid;

    mDeviceName = name;
}

bool PortPlayback::reset()
{
    if(mStream)
    {
        auto err = Pa_CloseStream(mStream);
        if(err != paNoError)
            ERR("Error closing stream: {}", Pa_GetErrorText(err));
        mStream = nullptr;
    }

    createStream(mDeviceIdx);

    switch(mParams.sampleFormat)
    {
    case paFloat32: mDevice->FmtType = DevFmtFloat; break;
    case paInt32: mDevice->FmtType = DevFmtInt; break;
    case paInt16: mDevice->FmtType = DevFmtShort; break;
    case paInt8: mDevice->FmtType = DevFmtByte; break;
    case paUInt8: mDevice->FmtType = DevFmtUByte; break;
    default:
        ERR("Unexpected PortAudio sample format: {}", mParams.sampleFormat);
        throw al::backend_exception{al::backend_error::NoDevice, "Invalid sample format: {}",
            mParams.sampleFormat};
    }

    if(mParams.channelCount != static_cast<int>(mDevice->channelsFromFmt()))
    {
        if(mParams.channelCount >= 2)
            mDevice->FmtChans = DevFmtStereo;
        else if(mParams.channelCount == 1)
            mDevice->FmtChans = DevFmtMono;
        mDevice->mAmbiOrder = 0;
    }

    const PaStreamInfo *streamInfo{Pa_GetStreamInfo(mStream)};
    mDevice->mSampleRate = static_cast<uint>(std::lround(streamInfo->sampleRate));
    mDevice->mUpdateSize = mParams.updateSize;
    mDevice->mBufferSize = mDevice->mUpdateSize * 2;
    if(streamInfo->outputLatency > 0.0f)
    {
        const double sampleLatency{streamInfo->outputLatency * streamInfo->sampleRate};
        TRACE("Reported stream latency: {:f} sec ({:f} samples)", streamInfo->outputLatency,
            sampleLatency);
        mDevice->mBufferSize = static_cast<uint>(std::clamp(sampleLatency,
            double(mDevice->mBufferSize), double{std::numeric_limits<int>::max()}));
    }

    setDefaultChannelOrder();

    return true;
}

void PortPlayback::start()
{
    if(const PaError err{Pa_StartStream(mStream)}; err != paNoError)
        throw al::backend_exception{al::backend_error::DeviceError, "Failed to start playback: {}",
            Pa_GetErrorText(err)};
}

void PortPlayback::stop()
{
    if(PaError err{Pa_StopStream(mStream)}; err != paNoError)
        ERR("Error stopping stream: {}", Pa_GetErrorText(err));
}


struct PortCapture final : public BackendBase {
    explicit PortCapture(DeviceBase *device) noexcept : BackendBase{device} { }
    ~PortCapture() override;

    int readCallback(const void *inputBuffer, void *outputBuffer, unsigned long framesPerBuffer,
        const PaStreamCallbackTimeInfo *timeInfo, const PaStreamCallbackFlags statusFlags) const noexcept;

    void open(std::string_view name) override;
    void start() override;
    void stop() override;
    void captureSamples(std::byte *buffer, uint samples) override;
    uint availableSamples() override;

    PaStream *mStream{nullptr};
    PaStreamParameters mParams{};

    RingBufferPtr mRing{nullptr};
};

PortCapture::~PortCapture()
{
    PaError err{mStream ? Pa_CloseStream(mStream) : paNoError};
    if(err != paNoError)
        ERR("Error closing stream: {}", Pa_GetErrorText(err));
    mStream = nullptr;
}


int PortCapture::readCallback(const void *inputBuffer, void*, unsigned long framesPerBuffer,
    const PaStreamCallbackTimeInfo*, const PaStreamCallbackFlags) const noexcept
{
    std::ignore = mRing->write(inputBuffer, framesPerBuffer);
    return 0;
}


void PortCapture::open(std::string_view name)
{
    if(DeviceNames.empty())
        EnumerateDevices();

    int deviceid{};
    if(name.empty())
    {
        if(auto devidopt = ConfigValueInt({}, "port", "capture"))
            deviceid = *devidopt;
        if(deviceid < 0 || static_cast<uint>(deviceid) >= DeviceNames.size())
            deviceid = Pa_GetDefaultInputDevice();
        name = DeviceNames.at(static_cast<uint>(deviceid)).mName;
    }
    else
    {
        auto iter = std::find_if(DeviceNames.cbegin(), DeviceNames.cend(),
            [name](const DeviceEntry &entry)
            { return entry.mCaptureChannels > 0 && name == entry.mName; });
        if(iter == DeviceNames.cend())
            throw al::backend_exception{al::backend_error::NoDevice,
                "Device name \"{}\" not found", name};
        deviceid = static_cast<int>(std::distance(DeviceNames.cbegin(), iter));
    }

    const uint samples{std::max(mDevice->mBufferSize, mDevice->mSampleRate/10u)};
    const uint frame_size{mDevice->frameSizeFromFmt()};

    mRing = RingBuffer::Create(samples, frame_size, false);

    mParams.device = deviceid;
    mParams.suggestedLatency = 0.0f;
    mParams.hostApiSpecificStreamInfo = nullptr;

    switch(mDevice->FmtType)
    {
    case DevFmtByte:
        mParams.sampleFormat = paInt8;
        break;
    case DevFmtUByte:
        mParams.sampleFormat = paUInt8;
        break;
    case DevFmtShort:
        mParams.sampleFormat = paInt16;
        break;
    case DevFmtInt:
        mParams.sampleFormat = paInt32;
        break;
    case DevFmtFloat:
        mParams.sampleFormat = paFloat32;
        break;
    case DevFmtUInt:
    case DevFmtUShort:
        throw al::backend_exception{al::backend_error::DeviceError, "{} samples not supported",
            DevFmtTypeString(mDevice->FmtType)};
    }
    mParams.channelCount = static_cast<int>(mDevice->channelsFromFmt());

    static constexpr auto readCallback = [](const void *inputBuffer, void *outputBuffer,
        unsigned long framesPerBuffer, const PaStreamCallbackTimeInfo *timeInfo,
        const PaStreamCallbackFlags statusFlags, void *userData) noexcept
    {
        return static_cast<PortCapture*>(userData)->readCallback(inputBuffer, outputBuffer,
            framesPerBuffer, timeInfo, statusFlags);
    };
    PaError err{Pa_OpenStream(&mStream, &mParams, nullptr, mDevice->mSampleRate,
        paFramesPerBufferUnspecified, paNoFlag, readCallback, this)};
    if(err != paNoError)
        throw al::backend_exception{al::backend_error::NoDevice, "Failed to open stream: {}",
            Pa_GetErrorText(err)};

    mDeviceName = name;
}


void PortCapture::start()
{
    if(const PaError err{Pa_StartStream(mStream)}; err != paNoError)
        throw al::backend_exception{al::backend_error::DeviceError,
            "Failed to start recording: {}", Pa_GetErrorText(err)};
}

void PortCapture::stop()
{
    if(PaError err{Pa_StopStream(mStream)}; err != paNoError)
        ERR("Error stopping stream: {}", Pa_GetErrorText(err));
}


uint PortCapture::availableSamples()
{ return static_cast<uint>(mRing->readSpace()); }

void PortCapture::captureSamples(std::byte *buffer, uint samples)
{ std::ignore = mRing->read(buffer, samples); }

} // namespace


bool PortBackendFactory::init()
{
#if HAVE_DYNLOAD
    if(!pa_handle)
    {
#ifdef _WIN32
# define PALIB "portaudio.dll"
#elif defined(__APPLE__) && defined(__MACH__)
# define PALIB "libportaudio.2.dylib"
#elif defined(__OpenBSD__)
# define PALIB "libportaudio.so"
#else
# define PALIB "libportaudio.so.2"
#endif

        pa_handle = LoadLib(PALIB);
        if(!pa_handle)
            return false;

#define LOAD_FUNC(f) do {                                                     \
    p##f = reinterpret_cast<decltype(p##f)>(GetSymbol(pa_handle, #f));        \
    if(p##f == nullptr)                                                       \
    {                                                                         \
        CloseLib(pa_handle);                                                  \
        pa_handle = nullptr;                                                  \
        return false;                                                         \
    }                                                                         \
} while(0)
        LOAD_FUNC(Pa_Initialize);
        LOAD_FUNC(Pa_Terminate);
        LOAD_FUNC(Pa_GetErrorText);
        LOAD_FUNC(Pa_StartStream);
        LOAD_FUNC(Pa_StopStream);
        LOAD_FUNC(Pa_OpenStream);
        LOAD_FUNC(Pa_CloseStream);
        LOAD_FUNC(Pa_GetDeviceCount);
        LOAD_FUNC(Pa_GetDeviceInfo);
        LOAD_FUNC(Pa_GetDefaultOutputDevice);
        LOAD_FUNC(Pa_GetDefaultInputDevice);
        LOAD_FUNC(Pa_GetStreamInfo);
#undef LOAD_FUNC

        const PaError err{Pa_Initialize()};
        if(err != paNoError)
        {
            ERR("Pa_Initialize() returned an error: {}", Pa_GetErrorText(err));
            CloseLib(pa_handle);
            pa_handle = nullptr;
            return false;
        }
    }
#else
    const PaError err{Pa_Initialize()};
    if(err != paNoError)
    {
        ERR("Pa_Initialize() returned an error: {}", Pa_GetErrorText(err));
        return false;
    }
#endif
    return true;
}

bool PortBackendFactory::querySupport(BackendType type)
{ return (type == BackendType::Playback || type == BackendType::Capture); }

auto PortBackendFactory::enumerate(BackendType type) -> std::vector<std::string>
{
    std::vector<std::string> devices;

    EnumerateDevices();
    int defaultid{-1};
    switch(type)
    {
    case BackendType::Playback:
        defaultid = Pa_GetDefaultOutputDevice();
        if(auto devidopt = ConfigValueInt({}, "port", "device"); devidopt && *devidopt >= 0
            && static_cast<uint>(*devidopt) < DeviceNames.size())
            defaultid = *devidopt;

        for(size_t i{0};i < DeviceNames.size();++i)
        {
            if(DeviceNames[i].mPlaybackChannels > 0)
            {
                if(defaultid >= 0 && static_cast<uint>(defaultid) == i)
                    devices.emplace(devices.cbegin(), DeviceNames[i].mName);
                else
                    devices.emplace_back(DeviceNames[i].mName);
            }
        }
        break;

    case BackendType::Capture:
        defaultid = Pa_GetDefaultInputDevice();
        if(auto devidopt = ConfigValueInt({}, "port", "capture"); devidopt && *devidopt >= 0
            && static_cast<uint>(*devidopt) < DeviceNames.size())
            defaultid = *devidopt;

        for(size_t i{0};i < DeviceNames.size();++i)
        {
            if(DeviceNames[i].mCaptureChannels > 0)
            {
                if(defaultid >= 0 && static_cast<uint>(defaultid) == i)
                    devices.emplace(devices.cbegin(), DeviceNames[i].mName);
                else
                    devices.emplace_back(DeviceNames[i].mName);
            }
        }
        break;
    }

    return devices;
}

BackendPtr PortBackendFactory::createBackend(DeviceBase *device, BackendType type)
{
    if(type == BackendType::Playback)
        return BackendPtr{new PortPlayback{device}};
    if(type == BackendType::Capture)
        return BackendPtr{new PortCapture{device}};
    return nullptr;
}

BackendFactory &PortBackendFactory::getFactory()
{
    static PortBackendFactory factory{};
    return factory;
}