AudioInterface.h

Go to the documentation of this file.

//*****************************************************************
/*
  JackTrip: A System for High-Quality Audio Network Performance
  over the Internet

  Copyright (c) 2008 Juan-Pablo Caceres, Chris Chafe.
  SoundWIRE group at CCRMA, Stanford University.

  Permission is hereby granted, free of charge, to any person
  obtaining a copy of this software and associated documentation
  files (the "Software"), to deal in the Software without
  restriction, including without limitation the rights to use,
  copy, modify, merge, publish, distribute, sublicense, and/or sell
  copies of the Software, and to permit persons to whom the
  Software is furnished to do so, subject to the following
  conditions:

  The above copyright notice and this permission notice shall be
  included in all copies or substantial portions of the Software.

  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
  OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
  HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
  WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  OTHER DEALINGS IN THE SOFTWARE.
*/
//*****************************************************************

#ifndef __AUDIOINTERFACE_H__
#define __AUDIOINTERFACE_H__

#include "ProcessPlugin.h"
#include "jacktrip_types.h"

#include <QVarLengthArray>
#include <QVector>
//#include "jacktrip_globals.h"

// Forward declarations
class JackTrip;

//using namespace JackTripNamespace;


class AudioInterface
{
public:

  enum audioBitResolutionT {
    BIT8  = 1, 
    BIT16 = 2, 
    BIT24 = 3, 
    BIT32 = 4  
          };

  enum samplingRateT {
    SR22, 
    SR32, 
    SR44, 
    SR48, 
    SR88, 
    SR96, 
    SR192, 
    UNDEF 
  };

  AudioInterface(JackTrip* jacktrip,
                 int NumInChans, int NumOutChans,
                 AudioInterface::audioBitResolutionT AudioBitResolution =
                 AudioInterface::BIT16);
  virtual ~AudioInterface();

  virtual void setup();
  virtual int startProcess() const = 0;
  virtual int stopProcess() const = 0;
  virtual void callback(QVarLengthArray<sample_t*>& in_buffer,
                        QVarLengthArray<sample_t*>& out_buffer,
                        unsigned int n_frames);
  virtual void appendProcessPlugin(ProcessPlugin* plugin);
  virtual void connectDefaultPorts() = 0;
  static void fromSampleToBitConversion(const sample_t* const input,
                                        int8_t* output,
                                        const AudioInterface::audioBitResolutionT targetBitResolution);
  static void fromBitToSampleConversion(const int8_t* const input,
                                        sample_t* output,
                                        const AudioInterface::audioBitResolutionT sourceBitResolution);

  //--------------SETTERS---------------------------------------------
  virtual void setNumInputChannels(int nchannels)
  { mNumInChans = nchannels; }
  virtual void setNumOutputChannels(int nchannels)
  { mNumOutChans = nchannels; }
  virtual void setSampleRate(uint32_t sample_rate)
  { mSampleRate = sample_rate; }
  virtual void setBufferSizeInSamples(uint32_t buf_size)
  { mBufferSizeInSamples = buf_size; }
  virtual void setClientName(const char* ClientName) = 0;
  //------------------------------------------------------------------

  //--------------GETTERS---------------------------------------------
  virtual int getNumInputChannels() const { return mNumInChans; }
  virtual int getNumOutputChannels() const  { return mNumOutChans; }
  virtual uint32_t getBufferSizeInSamples() const
  { return mBufferSizeInSamples; }
  virtual size_t getSizeInBytesPerChannel() const;
  virtual uint32_t getSampleRate() const
  { return mSampleRate; }
  virtual samplingRateT getSampleRateType() const;
  virtual int getAudioBitResolution() const { return mAudioBitResolution; }
  static int getSampleRateFromType(samplingRateT rate_type);
  //------------------------------------------------------------------


private:

  void computeProcessFromNetwork(QVarLengthArray<sample_t*>& out_buffer,
                                 unsigned int n_frames);
  void computeProcessToNetwork(QVarLengthArray<sample_t*>& in_buffer,
                               unsigned int n_frames);

  JackTrip* mJackTrip; 
  int mNumInChans;
  int mNumOutChans; 
  int mAudioBitResolution; 
  AudioInterface::audioBitResolutionT mBitResolutionMode; 
  uint32_t mSampleRate; 
  uint32_t mBufferSizeInSamples; 
  size_t mSizeInBytesPerChannel; 
  QVector<ProcessPlugin*> mProcessPlugins; 
  QVarLengthArray<sample_t*> mInProcessBuffer;
  QVarLengthArray<sample_t*> mOutProcessBuffer;
  int8_t* mInputPacket; 
  int8_t* mOutputPacket;  
};

#endif // __AUDIOINTERFACE_H__