JackTrip
AudioInterface.h
Go to the documentation of this file.
1 //*****************************************************************
2 /*
3  JackTrip: A System for High-Quality Audio Network Performance
4  over the Internet
5 
6  Copyright (c) 2008 Juan-Pablo Caceres, Chris Chafe.
7  SoundWIRE group at CCRMA, Stanford University.
8 
9  Permission is hereby granted, free of charge, to any person
10  obtaining a copy of this software and associated documentation
11  files (the "Software"), to deal in the Software without
12  restriction, including without limitation the rights to use,
13  copy, modify, merge, publish, distribute, sublicense, and/or sell
14  copies of the Software, and to permit persons to whom the
15  Software is furnished to do so, subject to the following
16  conditions:
17 
18  The above copyright notice and this permission notice shall be
19  included in all copies or substantial portions of the Software.
20 
21  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
22  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
23  OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
24  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
25  HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
26  WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
27  FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
28  OTHER DEALINGS IN THE SOFTWARE.
29 */
30 //*****************************************************************
31 
38 #ifndef __AUDIOINTERFACE_H__
39 #define __AUDIOINTERFACE_H__
40 
41 #include "ProcessPlugin.h"
42 #include "jacktrip_types.h"
43 #include "AudioTester.h"
44 
45 #include <QVarLengthArray>
46 #include <QVector>
47 //#include "jacktrip_globals.h"
48 
49 // Forward declarations
50 class JackTrip;
51 
52 //using namespace JackTripNamespace;
53 
54 
58 {
59 public:
60 
63  BIT8 = 1,
64  BIT16 = 2,
65  BIT24 = 3,
66  BIT32 = 4
67  };
68 
71  SR22,
72  SR32,
73  SR44,
74  SR48,
75  SR88,
76  SR96,
78  UNDEF
79  };
80 
87  AudioInterface(JackTrip* jacktrip,
88  int NumInChans, int NumOutChans,
89  #ifdef WAIR // wair
90  int NumNetRevChans,
91  #endif // endwhere
92  AudioInterface::audioBitResolutionT AudioBitResolution =
95  virtual ~AudioInterface();
96 
104  virtual void setup();
108  virtual int startProcess() const = 0;
111  virtual int stopProcess() const = 0;
119  virtual void broadcastCallback(QVarLengthArray<sample_t*>& mon_buffer,
120  unsigned int n_frames);
121  virtual void callback(QVarLengthArray<sample_t*>& in_buffer,
122  QVarLengthArray<sample_t*>& out_buffer,
123  unsigned int n_frames);
131  virtual void appendProcessPluginToNetwork(ProcessPlugin* plugin);
140  virtual void appendProcessPluginFromNetwork(ProcessPlugin* plugin);
145  void initPlugins();
146  virtual void connectDefaultPorts() = 0;
154  static void fromSampleToBitConversion(const sample_t* const input,
155  int8_t* output,
156  const AudioInterface::audioBitResolutionT targetBitResolution);
164  static void fromBitToSampleConversion(const int8_t* const input,
165  sample_t* output,
166  const AudioInterface::audioBitResolutionT sourceBitResolution);
167 
168  //--------------SETTERS---------------------------------------------
169  virtual void setNumInputChannels(int nchannels)
170  { mNumInChans = nchannels; }
171  virtual void setNumOutputChannels(int nchannels)
172  { mNumOutChans = nchannels; }
173  virtual void setSampleRate(uint32_t sample_rate)
174  { mSampleRate = sample_rate; }
175  virtual void setDeviceID(uint32_t device_id)
176  { mDeviceID = device_id; }
177  virtual void setBufferSizeInSamples(uint32_t buf_size)
178  { mBufferSizeInSamples = buf_size; }
180  virtual void setClientName(QString ClientName) = 0;
181  virtual void setLoopBack(bool b) { mLoopBack = b; }
182  virtual void enableBroadcastOutput() {}
183  virtual void setAudioTesterP(AudioTester* atp) { mAudioTesterP = atp; }
184  //------------------------------------------------------------------
185 
186  //--------------GETTERS---------------------------------------------
188  virtual int getNumInputChannels() const { return mNumInChans; }
190  virtual int getNumOutputChannels() const { return mNumOutChans; }
192  { return mBufferSizeInSamples; }
193  virtual uint32_t getDeviceID() const
194  { return mDeviceID; }
195  virtual size_t getSizeInBytesPerChannel() const;
197  virtual uint32_t getSampleRate() const
198  { return mSampleRate; }
201  virtual samplingRateT getSampleRateType() const;
206  virtual int getAudioBitResolution() const { return mAudioBitResolution; }
212  static int getSampleRateFromType(samplingRateT rate_type);
213  //------------------------------------------------------------------
214 
215 
216 private:
217 
219  void computeProcessFromNetwork(QVarLengthArray<sample_t*>& out_buffer,
220  unsigned int n_frames);
222  void computeProcessToNetwork(QVarLengthArray<sample_t*>& in_buffer,
223  unsigned int n_frames);
224 
225  JackTrip* mJackTrip;
226  int mNumInChans;
227  int mNumOutChans;
228 #ifdef WAIR // wair
229  int mNumNetRevChans;
230  QVarLengthArray<sample_t*> mNetInBuffer;
231  QVarLengthArray<sample_t*> mAPInBuffer;
232 #endif // endwhere
233  QVarLengthArray<sample_t*> mInBufCopy;
234  int mAudioBitResolution;
235  AudioInterface::audioBitResolutionT mBitResolutionMode;
236  uint32_t mSampleRate;
237  uint32_t mDeviceID;
238  uint32_t mBufferSizeInSamples;
239  size_t mSizeInBytesPerChannel;
240  QVector<ProcessPlugin*> mProcessPluginsFromNetwork;
241  QVector<ProcessPlugin*> mProcessPluginsToNetwork;
242  QVarLengthArray<sample_t*> mInProcessBuffer;
243  QVarLengthArray<sample_t*> mOutProcessBuffer;
244  int8_t* mInputPacket;
245  int8_t* mOutputPacket;
246  bool mLoopBack;
247  AudioTester* mAudioTesterP { nullptr };
248 protected:
251 };
252 
253 #endif // __AUDIOINTERFACE_H__
Base Class that provides an interface with audio.
Definition: AudioInterface.h:58
virtual void appendProcessPluginFromNetwork(ProcessPlugin *plugin)
appendProcessPluginFromNetwork(): Same as appendProcessPluginToNetwork() except that these plugins op...
Definition: AudioInterface.cpp:635
virtual uint32_t getSampleRate() const
Get the Jack Server Sampling Rate, in samples/second.
Definition: AudioInterface.h:197
virtual samplingRateT getSampleRateType() const
Get the Jack Server Sampling Rate Enum Type samplingRateT.
Definition: AudioInterface.cpp:667
virtual int stopProcess() const =0
Stops the process-callback thread.
virtual size_t getSizeInBytesPerChannel() const
Definition: AudioInterface.cpp:210
virtual int startProcess() const =0
Tell the audio server that we are ready to roll. The process-callback will start running....
virtual int getNumOutputChannels() const
Get Number of Output Channels.
Definition: AudioInterface.h:190
const uint32_t MAX_AUDIO_BUFFER_SIZE
Definition: AudioInterface.h:250
virtual void callback(QVarLengthArray< sample_t * > &in_buffer, QVarLengthArray< sample_t * > &out_buffer, unsigned int n_frames)
Definition: AudioInterface.cpp:217
samplingRateT
Sampling Rates supported by JACK.
Definition: AudioInterface.h:70
@ SR22
22050 Hz
Definition: AudioInterface.h:71
@ SR48
48000 Hz
Definition: AudioInterface.h:74
@ SR88
88200 Hz
Definition: AudioInterface.h:75
@ SR192
192000 Hz
Definition: AudioInterface.h:77
@ UNDEF
Undefined.
Definition: AudioInterface.h:78
@ SR32
32000 Hz
Definition: AudioInterface.h:72
@ SR44
44100 Hz
Definition: AudioInterface.h:73
@ SR96
96000 Hz
Definition: AudioInterface.h:76
virtual void appendProcessPluginToNetwork(ProcessPlugin *plugin)
appendProcessPluginToNetwork(): Append a ProcessPlugin for outgoing audio. The processing order equal...
Definition: AudioInterface.cpp:619
virtual int getNumInputChannels() const
Get Number of Input Channels.
Definition: AudioInterface.h:188
virtual int getAudioBitResolution() const
Get the Audio Bit Resolution, in bits.
Definition: AudioInterface.h:206
static void fromSampleToBitConversion(const sample_t *const input, int8_t *output, const AudioInterface::audioBitResolutionT targetBitResolution)
Convert a 32bit number (sample_t) into one of the bit resolution supported (audioBitResolutionT).
Definition: AudioInterface.cpp:524
virtual uint32_t getDeviceID() const
Definition: AudioInterface.h:193
virtual void setAudioTesterP(AudioTester *atp)
Definition: AudioInterface.h:183
virtual void setNumOutputChannels(int nchannels)
Definition: AudioInterface.h:171
virtual void setup()
Setup the client. This function should be called just before.
Definition: AudioInterface.cpp:138
virtual void setBufferSizeInSamples(uint32_t buf_size)
Definition: AudioInterface.h:177
virtual void broadcastCallback(QVarLengthArray< sample_t * > &mon_buffer, unsigned int n_frames)
Process callback. Subclass should call this callback after obtaining the in_buffer and out_buffer poi...
Definition: AudioInterface.cpp:392
audioBitResolutionT
Enum for Audio Resolution in bits.
Definition: AudioInterface.h:62
@ BIT32
32 bits
Definition: AudioInterface.h:66
@ BIT8
8 bits
Definition: AudioInterface.h:63
@ BIT16
16 bits (default)
Definition: AudioInterface.h:64
@ BIT24
24 bits
Definition: AudioInterface.h:65
virtual ~AudioInterface()
The class destructor.
Definition: AudioInterface.cpp:98
static int getSampleRateFromType(samplingRateT rate_type)
Helper function to get the sample rate (in Hz) for a JackAudioInterface::samplingRateT.
Definition: AudioInterface.cpp:690
bool mProcessingAudio
Set when processing an audio callback buffer pair.
Definition: AudioInterface.h:249
virtual void connectDefaultPorts()=0
virtual void setNumInputChannels(int nchannels)
Definition: AudioInterface.h:169
virtual void enableBroadcastOutput()
Definition: AudioInterface.h:182
AudioInterface(JackTrip *jacktrip, int NumInChans, int NumOutChans, AudioInterface::audioBitResolutionT AudioBitResolution=AudioInterface::BIT16)
The class constructor.
Definition: AudioInterface.cpp:47
virtual void setClientName(QString ClientName)=0
Set Client Name to something different that the default (JackTrip)
static void fromBitToSampleConversion(const int8_t *const input, sample_t *output, const AudioInterface::audioBitResolutionT sourceBitResolution)
Convert a audioBitResolutionT bit resolution number into a 32bit number (sample_t)
Definition: AudioInterface.cpp:578
virtual void setDeviceID(uint32_t device_id)
Definition: AudioInterface.h:175
virtual uint32_t getBufferSizeInSamples() const
Definition: AudioInterface.h:191
void initPlugins()
initPlugins(): Initialize all ProcessPlugin modules. The audio sampling rate (mSampleRate) must be se...
Definition: AudioInterface.cpp:651
virtual void setSampleRate(uint32_t sample_rate)
Definition: AudioInterface.h:173
virtual void setLoopBack(bool b)
Definition: AudioInterface.h:181
Definition: AudioTester.h:54
Main class to creates a SERVER (to listen) or a CLIENT (to connect to a listening server) to send aud...
Definition: JackTrip.h:72
Interface for the process plugins to add to the JACK callback process in JackAudioInterface.
Definition: ProcessPlugin.h:53
float sample_t
Audio sample type.
Definition: jacktrip_types.h:56
quint32 uint32_t
Typedef for unsigned int. This type is guaranteed to be 32-bit.
Definition: jacktrip_types.h:73
qint8 int8_t
Typedef for unsigned long long int. This type is guaranteed to be 64-bit.
Definition: jacktrip_types.h:78