/usr/include/svxlink/AsyncAudioJitterFifo.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 | /**
@file AsyncAudioJitterFifo.h
@brief A FIFO for handling audio samples
@author Tobias Blomberg / SM0SVX
@date 2007-10-06
Implements a jitter-tolerant FIFO for storing samples.
\verbatim
Async - A library for programming event driven applications
Copyright (C) 2003-2009 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_JITTER_FIFO_INCLUDED
#define ASYNC_AUDIO_JITTER_FIFO_INCLUDED
/****************************************************************************
*
* System Includes
*
****************************************************************************/
/****************************************************************************
*
* Project Includes
*
****************************************************************************/
#include <AsyncAudioSink.h>
#include <AsyncAudioSource.h>
/****************************************************************************
*
* Local Includes
*
****************************************************************************/
/****************************************************************************
*
* Forward declarations
*
****************************************************************************/
/****************************************************************************
*
* Namespace
*
****************************************************************************/
namespace Async
{
/****************************************************************************
*
* Forward declarations of classes inside of the declared namespace
*
****************************************************************************/
/****************************************************************************
*
* Defines & typedefs
*
****************************************************************************/
/****************************************************************************
*
* Exported Global Variables
*
****************************************************************************/
/****************************************************************************
*
* Class definitions
*
****************************************************************************/
/**
@brief A FIFO class for handling audio samples
@author Tobias Blomberg / SM0SVX
@date 2007-10-06
This class implements a jitter-tolerant FIFO for handling audio samples.
The FIFO is intended to buffer samples that arrive with a certain amount
of sample rate or packet jitter. Under normal operation, the FIFO is kept
half full. Varying sample rates or packet rates slowly move the amount of
samples out of center. When the FIFO reaches a full or empty state, it is
automatically reset to the half-full state.
*/
class AudioJitterFifo : public AudioSink, public AudioSource
{
public:
/**
* @brief Constuctor
* @param fifo_size This is the size of the fifo expressed in number
* of samples.
*/
explicit AudioJitterFifo(unsigned fifo_size);
/**
* @brief Destructor
*/
virtual ~AudioJitterFifo(void);
/**
* @brief Set the size of the FIFO
* @param new_size This is the size of the fifo expressed in number
* of samples.
*
* Use this function to set the size of the FIFO. In doing this, the
* FIFO will also be cleared.
*/
void setSize(unsigned new_size);
/**
* @brief Check if the FIFO is empty
* @return Returns \em true if the FIFO is empty or else \em false
*/
bool empty(void) const { return (tail == head); }
/**
* @brief Find out how many samples there are in the FIFO
* @return Returns the number of samples in the FIFO
*/
unsigned samplesInFifo(void) const;
/**
* @brief Clear all samples from the FIFO
*
* This will immediately reset the FIFO and discard all samples.
* The source will be told that all samples have been flushed.
*/
void clear(void);
/**
* @brief Write samples into the FIFO
* @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 the FIFO. 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);
/**
* @brief Tell the FIFO to flush the previously written samples
*
* This function is used to tell the FIFO to flush previously written
* samples.
* This function is normally only called from a connected source object.
*/
virtual void flushSamples(void);
/**
* @brief Resume audio output to the connected sink
*
* This function will be called when the registered audio sink is ready
* to accept more samples.
* This function is normally only called from a connected sink object.
*/
virtual void resumeOutput(void);
protected:
/**
* @brief The registered sink has flushed all samples
*
* This function will be called when all samples have been flushed in the
* registered sink.
* This function is normally only called from a connected sink object.
*/
virtual void allSamplesFlushed(void);
private:
float *fifo;
unsigned fifo_size;
unsigned head, tail;
bool output_stopped;
bool prebuf;
bool is_flushing;
void writeSamplesFromFifo(void);
}; /* class AudioJitterFifo */
} /* namespace */
#endif /* ASYNC_AUDIO_JITTER_FIFO_INCLUDED */
/*
* This file has not been truncated
*/
|