/usr/include/svxlink/AsyncAudioSink.h is in libasyncaudio-dev 17.12.1-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 | /**
@file AsyncAudioSink.h
@brief This file contains the base class for an audio sink
@author Tobias Blomberg / SM0SVX
@date 2005-04-17
\verbatim
Async - A library for programming event driven applications
Copyright (C) 2003-2015 Tobias Blomberg / SM0SVX
This program is free 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 2 of the License, or
(at your option) any later version.
This program 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 this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
\endverbatim
*/
#ifndef ASYNC_AUDIO_SINK_INCLUDED
#define ASYNC_AUDIO_SINK_INCLUDED
/****************************************************************************
*
* System Includes
*
****************************************************************************/
#include <cassert>
/****************************************************************************
*
* Project Includes
*
****************************************************************************/
/****************************************************************************
*
* Local Includes
*
****************************************************************************/
/****************************************************************************
*
* Forward declarations
*
****************************************************************************/
/****************************************************************************
*
* Namespace
*
****************************************************************************/
namespace Async
{
/****************************************************************************
*
* Forward declarations of classes inside of the declared namespace
*
****************************************************************************/
class AudioSource;
/****************************************************************************
*
* Defines & typedefs
*
****************************************************************************/
/****************************************************************************
*
* Exported Global Variables
*
****************************************************************************/
/****************************************************************************
*
* Class definitions
*
****************************************************************************/
/**
@brief The base class for an audio sink
@author Tobias Blomberg
@date 2005-04-17
This is the base class for an audio sink. An audio sink is a class that
can consume audio.
*/
class AudioSink
{
public:
/**
* @brief Default constuctor
*/
AudioSink(void) : m_source(0), m_handler(0), m_auto_unreg_sink(false) {}
/**
* @brief Destructor
*/
virtual ~AudioSink(void);
/**
* @brief Register an audio source to provide samples to this sink
* @param source The audio source to use
* @return Returns \em true on success or else \em false
*/
bool registerSource(AudioSource *source);
/**
* @brief Unregister the previously registered audio source
*/
void unregisterSource(void);
/**
* @brief Check if an audio source has been registered
* @return Returns \em true if there is an audio source registerd
*/
bool isRegistered(void) const { return m_source != 0; }
/**
* @brief Get the registered audio source
* @return Returns the registered audio source if any registered or else
* returns 0.
*/
AudioSource *source(void) const { return m_source; }
/**
* @brief Write samples into this audio sink
* @param samples The buffer containing the samples
* @param count The number of samples in the buffer
* @return Returns the number of samples that has been taken care of
*
* This function is used to write audio into this audio sink. If it
* returns 0, no more samples should be written until the resumeOutput
* function in the source have been called.
* This function is normally only called from a connected source object.
*/
virtual int writeSamples(const float *samples, int count)
{
assert(m_handler != 0);
return m_handler->writeSamples(samples, count);
}
/**
* @brief Tell the sink to flush the previously written samples
*
* This function is used to tell the sink to flush previously written
* samples. When done flushing, the sink should call the
* sourceAllSamplesFlushed function.
* This function is normally only called from a connected source object.
*/
virtual void flushSamples(void)
{
assert(m_handler != 0);
m_handler->flushSamples();
}
protected:
/**
* @brief Tell the source that we are ready to accept more samples
*/
void sourceResumeOutput(void);
/**
* @brief Tell the source that all samples have been flushed
*
* This function is called by the inheriting class to indicate that
* all samples have been flushed. It may only be called after a
* flushSamples call has been received and no more samples has been
* written to the sink.
*/
void sourceAllSamplesFlushed(void);
/**
* @brief Setup another sink to handle the incoming audio
* @param handler The sink to handle the audio
* @return Returns \em true on success or else \em false
*
* This function will setup another sink to handle incoming audio.
* This can be used when an internal object should handle the audio
* for this object.
*/
bool setHandler(AudioSink *handler);
/**
* @brief Clear a handler that was previously setup with setHandler.
*/
void clearHandler(void);
/*
* @brief Return the handler
* @return Returns the handler previously set with setHandler or 0
* if none have been set
*/
AudioSink *handler(void) const { return m_handler; }
private:
AudioSource *m_source;
AudioSink *m_handler;
bool m_auto_unreg_sink;
bool registerSourceInternal(AudioSource *source, bool reg_sink);
}; /* class AudioSink */
} /* namespace */
#endif /* ASYNC_AUDIO_SINK_INCLUDED */
/*
* This file has not been truncated
*/
|