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 
44 #include <QVarLengthArray>
45 #include <QVector>
46 //#include "jacktrip_globals.h"
47 
48 // Forward declarations
49 class JackTrip;
50 
51 //using namespace JackTripNamespace;
52 
53 
57 {
58 public:
59 
62  BIT8 = 1,
63  BIT16 = 2,
64  BIT24 = 3,
65  BIT32 = 4
66  };
67 
70  SR22,
71  SR32,
72  SR44,
73  SR48,
74  SR88,
75  SR96,
77  UNDEF
78  };
79 
86  AudioInterface(JackTrip* jacktrip,
87  int NumInChans, int NumOutChans,
88  #ifdef WAIR // wair
89  int NumNetRevChans,
90  #endif // endwhere
91  AudioInterface::audioBitResolutionT AudioBitResolution =
94  virtual ~AudioInterface();
95 
103  virtual void setup();
107  virtual int startProcess() const = 0;
110  virtual int stopProcess() const = 0;
118  virtual void callback(QVarLengthArray<sample_t*>& in_buffer,
119  QVarLengthArray<sample_t*>& out_buffer,
120  unsigned int n_frames);
127  virtual void appendProcessPlugin(ProcessPlugin* plugin);
128  virtual void connectDefaultPorts() = 0;
136  static void fromSampleToBitConversion(const sample_t* const input,
137  int8_t* output,
138  const AudioInterface::audioBitResolutionT targetBitResolution);
146  static void fromBitToSampleConversion(const int8_t* const input,
147  sample_t* output,
148  const AudioInterface::audioBitResolutionT sourceBitResolution);
149 
150  //--------------SETTERS---------------------------------------------
151  virtual void setNumInputChannels(int nchannels)
152  { mNumInChans = nchannels; }
153  virtual void setNumOutputChannels(int nchannels)
154  { mNumOutChans = nchannels; }
155  virtual void setSampleRate(uint32_t sample_rate)
156  { mSampleRate = sample_rate; }
157  virtual void setDeviceID(uint32_t device_id)
158  { mDeviceID = device_id; }
159  virtual void setBufferSizeInSamples(uint32_t buf_size)
160  { mBufferSizeInSamples = buf_size; }
162  virtual void setClientName(QString ClientName) = 0;
163  //------------------------------------------------------------------
164 
165  //--------------GETTERS---------------------------------------------
167  virtual int getNumInputChannels() const { return mNumInChans; }
169  virtual int getNumOutputChannels() const { return mNumOutChans; }
171  { return mBufferSizeInSamples; }
172  virtual uint32_t getDeviceID() const
173  { return mDeviceID; }
174  virtual size_t getSizeInBytesPerChannel() const;
176  virtual uint32_t getSampleRate() const
177  { return mSampleRate; }
180  virtual samplingRateT getSampleRateType() const;
185  virtual int getAudioBitResolution() const { return mAudioBitResolution; }
191  static int getSampleRateFromType(samplingRateT rate_type);
192  //------------------------------------------------------------------
193 
194 
195 private:
196 
198  void computeProcessFromNetwork(QVarLengthArray<sample_t*>& out_buffer,
199  unsigned int n_frames);
201  void computeProcessToNetwork(QVarLengthArray<sample_t*>& in_buffer,
202  unsigned int n_frames);
203 
204  JackTrip* mJackTrip;
205  int mNumInChans;
206  int mNumOutChans;
207 #ifdef WAIR // wair
208  int mNumNetRevChans;
209  QVarLengthArray<sample_t*> mNetInBuffer;
210  QVarLengthArray<sample_t*> mAPInBuffer;
211 #endif // endwhere
212  int mAudioBitResolution;
213  AudioInterface::audioBitResolutionT mBitResolutionMode;
214  uint32_t mSampleRate;
215  uint32_t mDeviceID;
216  uint32_t mBufferSizeInSamples;
217  size_t mSizeInBytesPerChannel;
218  QVector<ProcessPlugin*> mProcessPlugins;
219  QVarLengthArray<sample_t*> mInProcessBuffer;
220  QVarLengthArray<sample_t*> mOutProcessBuffer;
221  int8_t* mInputPacket;
222  int8_t* mOutputPacket;
223 };
224 
225 #endif // __AUDIOINTERFACE_H__
AudioInterface::SR192
@ SR192
192000 Hz
Definition: AudioInterface.h:76
AudioInterface::UNDEF
@ UNDEF
Undefined.
Definition: AudioInterface.h:77
AudioInterface::SR48
@ SR48
48000 Hz
Definition: AudioInterface.h:73
AudioInterface::getNumOutputChannels
virtual int getNumOutputChannels() const
Get Number of Output Channels.
Definition: AudioInterface.h:169
AudioInterface::getSampleRateType
virtual samplingRateT getSampleRateType() const
Get the Jack Server Sampling Rate Enum Type samplingRateT.
Definition: AudioInterface.cpp:544
AudioInterface::getDeviceID
virtual uint32_t getDeviceID() const
Definition: AudioInterface.h:172
AudioInterface::~AudioInterface
virtual ~AudioInterface()
The class destructor.
Definition: AudioInterface.cpp:92
JackTrip
Main class to creates a SERVER (to listen) or a CLIENT (to connect to a listening server) to send aud...
Definition: JackTrip.h:68
int8_t
qint8 int8_t
Typedef for unsigned long long int. This type is guaranteed to be 64-bit.
Definition: jacktrip_types.h:78
AudioInterface::SR96
@ SR96
96000 Hz
Definition: AudioInterface.h:75
AudioInterface::SR44
@ SR44
44100 Hz
Definition: AudioInterface.h:72
AudioInterface::AudioInterface
AudioInterface(JackTrip *jacktrip, int NumInChans, int NumOutChans, AudioInterface::audioBitResolutionT AudioBitResolution=AudioInterface::BIT16)
The class constructor.
Definition: AudioInterface.cpp:46
AudioInterface::fromBitToSampleConversion
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:494
AudioInterface::fromSampleToBitConversion
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:444
AudioInterface::setNumOutputChannels
virtual void setNumOutputChannels(int nchannels)
Definition: AudioInterface.h:153
AudioInterface::setNumInputChannels
virtual void setNumInputChannels(int nchannels)
Definition: AudioInterface.h:151
AudioInterface::setBufferSizeInSamples
virtual void setBufferSizeInSamples(uint32_t buf_size)
Definition: AudioInterface.h:159
AudioInterface::SR88
@ SR88
88200 Hz
Definition: AudioInterface.h:74
AudioInterface::BIT24
@ BIT24
24 bits
Definition: AudioInterface.h:64
AudioInterface::callback
virtual void callback(QVarLengthArray< sample_t * > &in_buffer, QVarLengthArray< sample_t * > &out_buffer, unsigned int n_frames)
Process callback. Subclass should call this callback after obtaining the in_buffer and out_buffer poi...
Definition: AudioInterface.cpp:201
ProcessPlugin
Interface for the process plugins to add to the JACK callback process in JackAudioInterface.
Definition: ProcessPlugin.h:53
AudioInterface::appendProcessPlugin
virtual void appendProcessPlugin(ProcessPlugin *plugin)
Append a ProcessPlugin. The order of processing is determined by the order by which appending is done...
Definition: AudioInterface.cpp:535
sample_t
float sample_t
Audio sample type.
Definition: jacktrip_types.h:56
AudioInterface::getNumInputChannels
virtual int getNumInputChannels() const
Get Number of Input Channels.
Definition: AudioInterface.h:167
AudioInterface::BIT8
@ BIT8
8 bits
Definition: AudioInterface.h:62
AudioInterface::BIT32
@ BIT32
32 bits
Definition: AudioInterface.h:65
AudioInterface::audioBitResolutionT
audioBitResolutionT
Enum for Audio Resolution in bits.
Definition: AudioInterface.h:61
AudioInterface::getBufferSizeInSamples
virtual uint32_t getBufferSizeInSamples() const
Definition: AudioInterface.h:170
AudioInterface::getSizeInBytesPerChannel
virtual size_t getSizeInBytesPerChannel() const
Definition: AudioInterface.cpp:194
AudioInterface::getSampleRateFromType
static int getSampleRateFromType(samplingRateT rate_type)
Helper function to get the sample rate (in Hz) for a JackAudioInterface::samplingRateT.
Definition: AudioInterface.cpp:567
uint32_t
quint32 uint32_t
Typedef for unsigned int. This type is guaranteed to be 32-bit.
Definition: jacktrip_types.h:73
AudioInterface::getAudioBitResolution
virtual int getAudioBitResolution() const
Get the Audio Bit Resolution, in bits.
Definition: AudioInterface.h:185
AudioInterface::setClientName
virtual void setClientName(QString ClientName)=0
Set Client Name to something different that the default (JackTrip)
ProcessPlugin.h
AudioInterface::BIT16
@ BIT16
16 bits (default)
Definition: AudioInterface.h:63
AudioInterface::samplingRateT
samplingRateT
Sampling Rates supported by JACK.
Definition: AudioInterface.h:69
AudioInterface::startProcess
virtual int startProcess() const =0
Tell the audio server that we are ready to roll. The process-callback will start running....
AudioInterface::SR22
@ SR22
22050 Hz
Definition: AudioInterface.h:70
AudioInterface::stopProcess
virtual int stopProcess() const =0
Stops the process-callback thread.
jacktrip_types.h
AudioInterface::SR32
@ SR32
32000 Hz
Definition: AudioInterface.h:71
AudioInterface::setDeviceID
virtual void setDeviceID(uint32_t device_id)
Definition: AudioInterface.h:157
AudioInterface
Base Class that provides an interface with audio.
Definition: AudioInterface.h:57
AudioInterface::setSampleRate
virtual void setSampleRate(uint32_t sample_rate)
Definition: AudioInterface.h:155
AudioInterface::setup
virtual void setup()
Setup the client. This function should be called just before.
Definition: AudioInterface.cpp:122
AudioInterface::getSampleRate
virtual uint32_t getSampleRate() const
Get the Jack Server Sampling Rate, in samples/second.
Definition: AudioInterface.h:176
AudioInterface::connectDefaultPorts
virtual void connectDefaultPorts()=0