mirror of https://github.com/qTox/qTox
114 lines
3.5 KiB
C++
114 lines
3.5 KiB
C++
/*
|
|
Copyright © 2019 by The qTox Project Contributors
|
|
|
|
This file is part of qTox, a Qt-based graphical interface for Tox.
|
|
|
|
qTox is libre software: you can redistribute it and/or modify
|
|
it under the terms of the GNU General Public License as published by
|
|
the Free Software Foundation, either version 3 of the License, or
|
|
(at your option) any later version.
|
|
|
|
qTox 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 General Public License for more details.
|
|
|
|
You should have received a copy of the GNU General Public License
|
|
along with qTox. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
#ifndef IAUDIOSINK_H
|
|
#define IAUDIOSINK_H
|
|
|
|
#include <cassert>
|
|
|
|
#include <QObject>
|
|
|
|
/**
|
|
* @brief The IAudioSink class represents an interface to devices that can play audio.
|
|
*
|
|
* @enum IAudioSink::Sound
|
|
* @brief Provides the different sounds for use in the getSound function.
|
|
* @see getSound
|
|
*
|
|
* @value NewMessage Returns the new message notification sound.
|
|
* @value Test Returns the test sound.
|
|
* @value IncomingCall Returns the incoming call sound.
|
|
* @value OutgoingCall Returns the outgoing call sound.
|
|
*
|
|
* @fn QString IAudioSink::getSound(Sound s)
|
|
* @brief Function to get the path of the requested sound.
|
|
*
|
|
* @param s Name of the sound to get the path of.
|
|
* @return The path of the requested sound.
|
|
*
|
|
* @fn void IAudioSink::playAudioBuffer(const int16_t* data, int samples,
|
|
* unsigned channels, int sampleRate)
|
|
* @brief adds a number of audio frames to the play buffer
|
|
*
|
|
* @param[in] data 16bit mono or stereo PCM data with alternating channel
|
|
* mapping for stereo (LRLR)
|
|
* @param[in] samples number of samples per channel
|
|
* @param[in] channels number of channels, currently 1 or 2 is supported
|
|
* @param[in] sampleRate sample rate in Hertz
|
|
*
|
|
* @fn void IAudioSink::playMono16Sound(const Sound& sound)
|
|
* @brief Play a 44100Hz mono 16bit PCM sound from the builtin sounds.
|
|
*
|
|
* @param[in] sound The sound to play
|
|
*
|
|
* @fn void IAudioSink::startLoop()
|
|
* @brief starts looping the sound played with playMono16Sound(...)
|
|
*
|
|
* @fn void IAudioSink::stopLoop()
|
|
* @brief stops looping the sound played with playMono16Sound(...)
|
|
*
|
|
*/
|
|
|
|
class IAudioSink : public QObject
|
|
{
|
|
Q_OBJECT
|
|
public:
|
|
enum class Sound
|
|
{
|
|
NewMessage,
|
|
Test,
|
|
IncomingCall,
|
|
OutgoingCall,
|
|
CallEnd
|
|
};
|
|
|
|
inline static QString getSound(Sound s)
|
|
{
|
|
switch (s) {
|
|
case Sound::Test:
|
|
return QStringLiteral(":/audio/notification.s16le.pcm");
|
|
case Sound::NewMessage:
|
|
return QStringLiteral(":/audio/notification.s16le.pcm");
|
|
case Sound::IncomingCall:
|
|
return QStringLiteral(":/audio/ToxIncomingCall.s16le.pcm");
|
|
case Sound::OutgoingCall:
|
|
return QStringLiteral(":/audio/ToxOutgoingCall.s16le.pcm");
|
|
case Sound::CallEnd:
|
|
return QStringLiteral(":/audio/ToxEndCall.s16le.pcm");
|
|
}
|
|
assert(false);
|
|
return {};
|
|
}
|
|
|
|
virtual ~IAudioSink() {}
|
|
virtual void playAudioBuffer(const int16_t* data, int samples, unsigned channels,
|
|
int sampleRate) const = 0;
|
|
virtual void playMono16Sound(const Sound& sound) = 0;
|
|
virtual void startLoop() = 0;
|
|
virtual void stopLoop() = 0;
|
|
|
|
virtual operator bool() const = 0;
|
|
|
|
signals:
|
|
void finishedPlaying();
|
|
void invalidated();
|
|
};
|
|
|
|
#endif // IAUDIOSINK_H
|