JackAudioInterface.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 __JACKAUDIOINTERFACE_H__
#define __JACKAUDIOINTERFACE_H__

#include <iostream>
//#include <tr1/memory> //for shared_ptr
#include <functional> //for mem_fun_ref
#include <jack/jack.h>

#include <QVector>
#include <QVarLengthArray>
#include <QMutex>


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

//class JackTrip; //forward declaration


class JackAudioInterface : public AudioInterface
{
public:

  JackAudioInterface(JackTrip* jacktrip,
                     int NumInChans, int NumOutChans,
                     AudioInterface::audioBitResolutionT AudioBitResolution = AudioInterface::BIT16,
                     const char* ClientName = "JackTrip");
  virtual ~JackAudioInterface();

  virtual void setup();
  virtual int startProcess() const;
  virtual int stopProcess() const;
  void connectDefaultPorts();

  //--------------SETTERS---------------------------------------------
  virtual void setClientName(const char* ClientName)
  { mClientName = ClientName; }
  virtual void setSampleRate(uint32_t /*sample_rate*/)
  { std::cout << "WARING: Setting the Sample Rate in Jack mode has no effect." << std::endl; }
  virtual void setBufferSizeInSamples(uint32_t /*buf_size*/)
  { std::cout << "WARING: Setting the Sample Rate in Jack mode has no effect." << std::endl; }
  //------------------------------------------------------------------

  //--------------GETTERS---------------------------------------------
  virtual uint32_t getSampleRate() const;
  virtual uint32_t getBufferSizeInSamples() const;
  virtual uint32_t getBufferSizeInBytes() const
  { return (getBufferSizeInSamples() * getAudioBitResolution()/8); }
  virtual size_t getSizeInBytesPerChannel() const;
  //------------------------------------------------------------------

private:

  void setupClient();
  void createChannels();
  static void jackShutdown(void*);
  void setProcessCallback();
  int processCallback(jack_nframes_t nframes);
  // reference : http://article.gmane.org/gmane.comp.audio.jackit/12873
  static int wrapperProcessCallback(jack_nframes_t nframes, void *arg) ;

  int mNumInChans;
  int mNumOutChans; 
  int mNumFrames; 
  //int mAudioBitResolution; ///< Bit resolution in audio samples
  AudioInterface::audioBitResolutionT mBitResolutionMode; 

  jack_client_t* mClient; 
  const char* mClientName; 
  QVarLengthArray<jack_port_t*> mInPorts; 
  QVarLengthArray<jack_port_t*> mOutPorts; 
  QVarLengthArray<sample_t*> mInBuffer; 
  QVarLengthArray<sample_t*> mOutBuffer; 
  size_t mSizeInBytesPerChannel; 
  QVector<ProcessPlugin*> mProcessPlugins; 
  JackTrip* mJackTrip; 
  static QMutex sJackMutex; 
};


#endif