AudioPlayerDeviceBase.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2006-2021 Istituto Italiano di Tecnologia (IIT)
 * SPDX-License-Identifier: BSD-3-Clause
 */
 
#include <vector>
 
#include <yarp/os/Searchable.h>
#include <yarp/dev/IAudioRender.h>
#include <yarp/dev/api.h>
#include <yarp/dev/CircularAudioBuffer.h>
#include <mutex>
 
#ifndef YARP_DEV_AUDIOPLAYERDEVICETEMPLATE_H
#define YARP_DEV_AUDIOPLAYERDEVICETEMPLATE_H
 
namespace yarp::dev {
 
 
class AudioDeviceDriverSettings
{
    public:
    size_t numSamples = 0;
    size_t numChannels = 0;
    size_t frequency = 0;
    size_t bytesPerSample = 2;
};
 
class YARP_dev_API AudioPlayerDeviceBase : public yarp::dev::IAudioRender
{
protected:
    bool                                m_enable_buffer_autoclear = false;
    bool                                m_playback_enabled = false;
    std::recursive_mutex                m_mutex;
    yarp::dev::CircularAudioBuffer_16t* m_outputBuffer = nullptr;
    AudioDeviceDriverSettings           m_audioplayer_cfg;
    double                              m_sw_gain = 1.0;
    double                              m_hw_gain = 1.0;
    bool                                m_audiobase_debug = false;
    enum { RENDER_APPEND = 0, RENDER_IMMEDIATE = 1 } m_renderMode= RENDER_APPEND;
 
public:
    virtual yarp::dev::ReturnValue renderSound(const yarp::sig::Sound& sound) override;
    virtual yarp::dev::ReturnValue startPlayback() override;
    virtual yarp::dev::ReturnValue stopPlayback() override;
    virtual yarp::dev::ReturnValue isPlaying(bool& playback_enabled) override;
    virtual yarp::dev::ReturnValue getPlaybackAudioBufferMaxSize(yarp::sig::AudioBufferSize& size) override;
    virtual yarp::dev::ReturnValue getPlaybackAudioBufferCurrentSize(yarp::sig::AudioBufferSize& size) override;
    virtual yarp::dev::ReturnValue resetPlaybackAudioBuffer() override;
    virtual yarp::dev::ReturnValue setSWGain(double gain) override;
 
    virtual ~AudioPlayerDeviceBase();
 
protected:
    virtual bool configureDeviceAndStart() = 0;
    virtual bool interruptDeviceAndClose() = 0;
    virtual void waitUntilPlaybackStreamIsComplete();
    virtual bool immediateSound(const yarp::sig::Sound& sound);
    virtual bool appendSound(const yarp::sig::Sound& sound);
 
    bool configurePlayerAudioDevice(yarp::os::Searchable& config, std::string device_name);
};
 
} // namespace yarp::dev
 
#endif