Class for storing sounds See Audio in YARP for additional documentation on YARP audio. More...
#include <yarp/sig/Sound.h>
Inheritance diagram for yarp::sig::Sound:Public Types | |
| typedef short int | audio_sample |
Public Member Functions | |
| Sound (size_t bytesPerSample=2) | |
| Sound (const Sound &alt) | |
| Copy constructor. | |
| virtual | ~Sound () |
| const Sound & | operator= (const Sound &alt) |
| Assignment operator. | |
| bool | operator== (const Sound &alt) const |
| Comparison operator. | |
| Sound & | operator+= (const Sound &alt) |
| Addition assignment operator. | |
| void | overwrite (const Sound &alt, size_t offset=0, size_t len=0) |
| It overwrites the sound with another sound, starting from a specified offset. | |
| Sound | subSound (size_t first_sample, size_t len) |
| Returns a subpart of the sound. | |
| void | clear () |
| void | resize (size_t samples, size_t channels=1) |
| Set the sound size. | |
| audio_sample | get (size_t sample, size_t channel=0) const |
| void | set (audio_sample value, size_t sample, size_t channel=0) |
| audio_sample | getSafe (size_t sample, size_t channel=0) const |
| void | setSafe (audio_sample value, size_t sample, size_t channel=0) |
| bool | isSample (size_t sample, size_t channel=0) const |
| Check whether a sample lies within the sound. | |
| void | zero () |
| set all the samples to zero (silence) | |
| void | normalizeChannel (size_t channel) |
| Normalize a specific channel of the sound. | |
| void | normalize () |
| Normalize a sound (the peak is searched among all channels) | |
| void | amplifyChannel (size_t channel, double gain) |
| Amplify a specific channel of the sound. | |
| void | amplify (double gain) |
| amplify a sound | |
| void | findPeakInChannel (size_t channelId, size_t &sampleId, audio_sample &sampleValue) const |
| find the peak in a specific channel of the sound | |
| void | findPeak (size_t &channelId, size_t &sampleId, audio_sample &sampleValue) const |
| find the peak in a sound | |
| double | sample2timestamp (size_t sampleid) const |
| Utility function: return the timestamp (in seconds) given the sample id. | |
| size_t | timestamp2sample (double time) const |
| Utility function: return the sample id given the timestamp (in seconds) | |
| bool | zeroChannel (size_t channel) |
| set to zero all the samples of the specified channel @ param channel the channel number | |
| int | getFrequency () const |
| Get the frequency of the sound (i.e. | |
| void | setFrequency (int freq) |
| Set the frequency of the sound (i.e. | |
| size_t | getBytesPerSample () const |
| Get the number of bytes per sample. | |
| size_t | getSamples () const |
| Get the number of samples contained in the sound. | |
| double | getDuration () const |
| Get the duration of sound in seconds. | |
| size_t | getChannels () const |
| Get the number of channels of the sound. | |
| Sound | extractChannelAsSound (size_t channel_id) const |
| Extract a single channel from the sound. | |
| std::vector< std::reference_wrapper< audio_sample > > | getChannel (size_t channel_id) |
| bool | replaceChannel (size_t id, Sound channel) |
| Replace a single channel of our current sound with a given sound constituted by a single channel The two sounds must have the same number of samples. | |
| std::vector< std::reference_wrapper< audio_sample > > | getInterleavedAudioRawData () const |
| Returns a serialized version of the sound, in interleaved format, e.g. | |
| std::vector< std::reference_wrapper< audio_sample > > | getNonInterleavedAudioRawData () const |
| Returns a serialized version of the sound, in non-interleaved format, e.g. | |
| std::string | toString () const |
| Print matrix to a string. | |
| void | add_marker (const std::string &marker_label, size_t sample_id, int channel=-1) |
| Adds a marker to the sound, identified by a label, a sample id and an optional channel number (if not specified, the marker is valid for all channels). | |
| bool | get_marker (const std::string &marker_label, size_t &sample_id, int &channel) const |
| Gets the sample id and channel number of a marker given its label. | |
| size_t | getMarkersCount () const |
| Gets the number of markers contained in the sound. | |
| yarp::sig::SoundMarker | getMarker (size_t index) const |
| Get the marker at the specified index. | |
| std::vector< yarp::sig::SoundMarker > | getMarkers () const |
| Get all the markers contained in the sound. | |
| void | remove_marker (const std::string &marker_label) |
| Removes a marker given its label. | |
| void | remove_all_markers () |
| Removes all the markers contained in the sound. | |
| Sound | subSound (std::string marker_start, std::string marker_end) |
| Returns a subSound of the current sound, starting from the sample identified by marker_start and ending at the sample identified by marker_end (including the two markers). | |
| bool | read (yarp::os::ConnectionReader &connection) override |
| Read this object from a network connection. | |
| bool | write (yarp::os::ConnectionWriter &connection) const override |
| Write this object to a network connection. | |
Public Member Functions inherited from yarp::os::Portable | |
| virtual Type | getType () const |
Public Member Functions inherited from yarp::os::PortReader | |
| virtual | ~PortReader () |
| Destructor. | |
| virtual Type | getReadType () const |
Public Member Functions inherited from yarp::os::PortWriter | |
| virtual | ~PortWriter () |
| Destructor. | |
| virtual void | onCompletion () const |
| This is called when the port has finished all writing operations. | |
| virtual void | onCommencement () const |
| This is called when the port is about to begin writing operations. | |
| virtual yarp::os::Type | getWriteType () const |
Additional Inherited Members | |
Static Public Member Functions inherited from yarp::os::Portable | |
| static bool | copyPortable (const PortWriter &writer, PortReader &reader) |
| Copy one portable to another, via writing and reading. | |
Class for storing sounds See Audio in YARP for additional documentation on YARP audio.
| typedef short int yarp::sig::Sound::audio_sample |
Adds a marker to the sound, identified by a label, a sample id and an optional channel number (if not specified, the marker is valid for all channels).
If a marker with the same label already exists, it will be overwritten.
| marker_label | the label of the marker |
| sample_id | the sample id of the marker |
| channel | the channel number of the marker (optional, default value = -1, meaning that the marker is valid for all channels) |
| void Sound::findPeak | ( | size_t & | channelId, |
| size_t & | sampleId, | ||
| audio_sample & | sampleValue | ||
| ) | const |
| void Sound::findPeakInChannel | ( | size_t | channelId, |
| size_t & | sampleId, | ||
| audio_sample & | sampleValue | ||
| ) | const |
find the peak in a specific channel of the sound
| [in] | channelId | the channel in which the peak is searched |
| [out] | sampleId | the returned sampleId in which the peak is detected |
| [out] | sampleValue | the returned value of the sample in which the peak is detected |
| Sound::audio_sample Sound::get | ( | size_t | sample, |
| size_t | channel = 0 |
||
| ) | const |
| bool Sound::get_marker | ( | const std::string & | marker_label, |
| size_t & | sample_id, | ||
| int & | channel | ||
| ) | const |
Gets the sample id and channel number of a marker given its label.
If the marker is not found, the method returns false and the output parameters are not modified.
| marker_label | the label of the marker |
| sample_id | the sample id of the marker (output parameter) |
| channel | the channel number of the marker (output parameter) |
| size_t Sound::getBytesPerSample | ( | ) | const |
| std::vector< std::reference_wrapper< Sound::audio_sample > > Sound::getChannel | ( | size_t | channel_id | ) |
| size_t Sound::getChannels | ( | ) | const |
| double Sound::getDuration | ( | ) | const |
| int Sound::getFrequency | ( | ) | const |
| std::vector< std::reference_wrapper< Sound::audio_sample > > Sound::getInterleavedAudioRawData | ( | ) | const |
| yarp::sig::SoundMarker yarp::sig::Sound::getMarker | ( | size_t | index | ) | const |
Get the marker at the specified index.
The order of the markers is not guaranteed and may change in the future. If the index is out of range, the method throws an std::out_of_range exception. Used by yarp bindings.
| index | the index of the marker to retrieve |
| std::vector< yarp::sig::SoundMarker > yarp::sig::Sound::getMarkers | ( | ) | const |
| size_t yarp::sig::Sound::getMarkersCount | ( | ) | const |
| std::vector< std::reference_wrapper< Sound::audio_sample > > Sound::getNonInterleavedAudioRawData | ( | ) | const |
|
inline |
| size_t Sound::getSamples | ( | ) | const |
| void Sound::normalize | ( | ) |
It overwrites the sound with another sound, starting from a specified offset.
| alt | the sound that will overwrite a portion of the current sound. |
| offset | the starting sample for the overwrite operation. Default value = 0. |
| len | the size (in samples) for the overwrite operation. If not specified, the whole alt sound will be used. |
|
overridevirtual |
Read this object from a network connection.
Override this for your particular class.
| reader | an interface to the network connection for reading |
Implements yarp::os::Portable.
| void Sound::remove_all_markers | ( | ) |
Replace a single channel of our current sound with a given sound constituted by a single channel The two sounds must have the same number of samples.
| id | the channel of our sound that we want to replace |
| channel | the single-channel sound that we want to put in our sound |
|
inline |
| void Sound::set | ( | audio_sample | value, |
| size_t | sample, | ||
| size_t | channel = 0 |
||
| ) |
| void Sound::setSafe | ( | audio_sample | value, |
| size_t | sample, | ||
| size_t | channel = 0 |
||
| ) |
| Sound Sound::subSound | ( | std::string | marker_start, |
| std::string | marker_end | ||
| ) |
Returns a subSound of the current sound, starting from the sample identified by marker_start and ending at the sample identified by marker_end (including the two markers).
If one of the two markers is not found, or if marker_start is after marker_end, the method throws an std::invalid_argument exception.
| marker_start | the label of the marker identifying the starting sample of the subSound |
| marker_end | the label of the marker identifying the ending sample of the subSound |
|
inline |
| std::string Sound::toString | ( | ) | const |
|
overridevirtual |
Write this object to a network connection.
Override this for your particular class. Be aware that depending on the nature of the connections a port has, and what protocol they use, and how efficient the YARP implementation is, this method may be called once, twice, or many times, as the result of a single call to Port::write
| writer | an interface to the network connection for writing |
Implements yarp::os::Portable.
| void Sound::zero | ( | ) |