YARP
Yet Another Robot Platform
 
Loading...
Searching...
No Matches
AudioToFileDevice.h
Go to the documentation of this file.
1/*
2 * SPDX-FileCopyrightText: 2006-2021 Istituto Italiano di Tecnologia (IIT)
3 * SPDX-License-Identifier: BSD-3-Clause
4 */
5
8#include <yarp/sig/Sound.h>
12
13#include <string>
14#include <mutex>
15#include <deque>
16
49{
50public:
56 ~AudioToFileDevice() override;
57
58 // Device Driver interface
59 bool open(yarp::os::Searchable &config) override;
60 bool close() override;
61
62public:
63 virtual yarp::dev::ReturnValue renderSound(const yarp::sig::Sound& sound) override;
64 virtual yarp::dev::ReturnValue startPlayback() override;
65 virtual yarp::dev::ReturnValue stopPlayback()override;
66 virtual yarp::dev::ReturnValue setHWGain(double gain) override;
67 virtual bool configureDeviceAndStart() override;
68 virtual bool interruptDeviceAndClose() override;
69 virtual void waitUntilPlaybackStreamIsComplete() override;
70
71private:
72 yarp::sig::Sound m_audioFile;
73 std::deque<yarp::sig::Sound> m_sounds;
74 size_t m_filename_counter = 0;
75
76 enum save_mode_t
77 {
78 save_overwrite_file = 0,
79 save_append_data =1,
80 save_rename_file =2,
81 save_break_file =3
82 } m_save_mode_enum = save_overwrite_file;
83
84 void save_to_file();
85};
This class is the parameters parser for class AudioToFileDevice.
audioToFileDevice : This device driver, wrapped by default by AudioPlayerWrapper, is used to save to ...
bool close() override
Close the DeviceDriver.
AudioToFileDevice(const AudioToFileDevice &)=delete
AudioToFileDevice & operator=(AudioToFileDevice &&)=delete
virtual yarp::dev::ReturnValue setHWGain(double gain) override
Sets the hardware gain of the playback device (if supported by the hardware)
virtual yarp::dev::ReturnValue startPlayback() override
Start the playback.
virtual bool configureDeviceAndStart() override
virtual void waitUntilPlaybackStreamIsComplete() override
virtual yarp::dev::ReturnValue stopPlayback() override
Stop the playback.
AudioToFileDevice & operator=(const AudioToFileDevice &)=delete
virtual yarp::dev::ReturnValue renderSound(const yarp::sig::Sound &sound) override
Render a sound using a device (i.e.
virtual bool interruptDeviceAndClose() override
AudioToFileDevice(AudioToFileDevice &&)=delete
bool open(yarp::os::Searchable &config) override
Open the DeviceDriver.
AudioPlayerDeviceBase : a base class for all audio player devices
Interface implemented by all device drivers.
A base class for nested structures that can be searched.
Definition Searchable.h:31
Class for storing sounds See Audio in YARP for additional documentation on YARP audio.
Definition Sound.h:25