PortAudioPlayerDeviceDriver.h

Go to the documentation of this file.

/*
 * Copyright (C) 2006-2020 Istituto Italiano di Tecnologia (IIT)
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser 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
 */
 
#ifndef PortAudioPlayerDeviceDriverh
#define PortAudioPlayerDeviceDriverh
 
#include <yarp/os/ManagedBytes.h>
#include <yarp/os/Thread.h>
 
#include <yarp/dev/DeviceDriver.h>
#include <yarp/dev/AudioGrabberInterfaces.h>
#include <yarp/dev/CircularAudioBuffer.h>
#include <portaudio.h>
#include <mutex>
 
#define DEFAULT_SAMPLE_RATE  (44100)
#define DEFAULT_NUM_CHANNELS    (2)
#define DEFAULT_DITHER_FLAG     (0)
#define DEFAULT_FRAMES_PER_BUFFER (512)
//#define DEFAULT_FRAMES_PER_BUFFER (1024)
 
 
class PortAudioPlayerDeviceDriverSettings
{
public:
    size_t cfg_rate = 0;
    size_t cfg_samples = 0;
    size_t cfg_playChannels = 0;
    int cfg_deviceNumber = 0;
};
 
class PlayStreamThread : public yarp::os::Thread
{
public:
    PlayStreamThread();
 
    void threadRelease() override;
    bool threadInit() override;
    void run() override;
 
    bool something_to_play;
    PaStream* stream;
 
private:
    PaError err;
    void handleError();
};
 
class PortAudioPlayerDeviceDriver :
        public yarp::dev::IAudioRender,
        public yarp::dev::DeviceDriver
{
private:
    PaStreamParameters  m_outputParameters;
    PaStream*           m_stream;
    PaError             m_err;
    yarp::dev::CircularAudioBuffer_16t* m_playDataBuffer;
    PortAudioPlayerDeviceDriverSettings m_config;
    PlayStreamThread    m_pThread;
    std::mutex     m_mutex;
 
public:
    PortAudioPlayerDeviceDriver();
    PortAudioPlayerDeviceDriver(const PortAudioPlayerDeviceDriver&) = delete;
    PortAudioPlayerDeviceDriver(PortAudioPlayerDeviceDriver&&) = delete;
    PortAudioPlayerDeviceDriver& operator=(const PortAudioPlayerDeviceDriver&) = delete;
    PortAudioPlayerDeviceDriver& operator=(PortAudioPlayerDeviceDriver&&) = delete;
 
    ~PortAudioPlayerDeviceDriver() override;
 
    bool open(yarp::os::Searchable& config) override;
 
    bool open(PortAudioPlayerDeviceDriverSettings& config);
 
    bool close() override;
    bool renderSound(const yarp::sig::Sound& sound) override;
    bool startPlayback() override;
    bool stopPlayback() override;
 
    bool abortSound();
    bool immediateSound(const yarp::sig::Sound& sound);
    bool appendSound(const yarp::sig::Sound& sound);
 
    bool getPlaybackAudioBufferMaxSize(yarp::dev::AudioBufferSize& size) override;
    bool getPlaybackAudioBufferCurrentSize(yarp::dev::AudioBufferSize& size) override;
    bool resetPlaybackAudioBuffer() override;
 
protected:
    void*   m_system_resource;
 
    PortAudioPlayerDeviceDriverSettings m_driverConfig;
    enum {RENDER_APPEND=0, RENDER_IMMEDIATE=1} renderMode;
    void handleError();
};
 
#endif