AudioRecorderDeviceBase.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/AudioGrabberInterfaces.h>
#include <yarp/dev/api.h>
#include <yarp/dev/CircularAudioBuffer.h>
#include <mutex>
 
#ifndef YARP_DEV_AUDIORECORDERDEVICETEMPLATE_H
#define YARP_DEV_AUDIORECORDERDEVICETEMPLATE_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 AudioRecorderDeviceBase : public yarp::dev::IAudioGrabberSound
{
protected:
    bool            m_enable_buffer_autoclear = false;
    bool            m_recording_enabled = false;
    std::mutex      m_mutex;
    yarp::dev::CircularAudioBuffer_16t* m_inputBuffer = nullptr;
    double          m_sw_gain = 1.0;
    double          m_hw_gain = 1.0;
    AudioDeviceDriverSettings m_audiorecorder_cfg;
    bool            m_audiobase_debug = false;
    int16_t         m_cliptol = 3;
 
public:
    virtual yarp::dev::ReturnValue getSound(yarp::sig::Sound& sound, size_t min_number_of_samples, size_t max_number_of_samples, double max_samples_timeout_s) override;
    virtual yarp::dev::ReturnValue startRecording() override;
    virtual yarp::dev::ReturnValue stopRecording() override;
    virtual yarp::dev::ReturnValue isRecording(bool& recording_enabled) override;
    virtual yarp::dev::ReturnValue getRecordingAudioBufferMaxSize(yarp::sig::AudioBufferSize& size) override;
    virtual yarp::dev::ReturnValue getRecordingAudioBufferCurrentSize(yarp::sig::AudioBufferSize& size) override;
    virtual yarp::dev::ReturnValue resetRecordingAudioBuffer() override;
    virtual yarp::dev::ReturnValue setSWGain(double gain) override;
 
    virtual ~AudioRecorderDeviceBase();
 
protected:
    bool configureRecorderAudioDevice(yarp::os::Searchable& config, std::string device_name);
};
 
} // namespace yarp::dev
 
#endif