2009-08-16 14:53:11 +00:00
|
|
|
/*
|
2011-02-18 23:47:37 +00:00
|
|
|
* ***** BEGIN GPL LICENSE BLOCK *****
|
2009-08-16 14:53:11 +00:00
|
|
|
*
|
2011-02-18 23:47:37 +00:00
|
|
|
* Copyright 2009-2011 Jörg Hermann Müller
|
2009-08-16 14:53:11 +00:00
|
|
|
*
|
|
|
|
* This file is part of AudaSpace.
|
|
|
|
*
|
2011-02-18 23:47:37 +00:00
|
|
|
* Audaspace 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
|
2009-08-16 14:53:11 +00:00
|
|
|
* (at your option) any later version.
|
|
|
|
*
|
|
|
|
* AudaSpace 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
|
2011-02-18 23:47:37 +00:00
|
|
|
* GNU General Public License for more details.
|
2009-08-16 14:53:11 +00:00
|
|
|
*
|
2011-02-18 23:47:37 +00:00
|
|
|
* You should have received a copy of the GNU General Public License
|
|
|
|
* along with Audaspace; if not, write to the Free Software Foundation,
|
|
|
|
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
2009-08-16 14:53:11 +00:00
|
|
|
*
|
2011-02-18 23:47:37 +00:00
|
|
|
* ***** END GPL LICENSE BLOCK *****
|
2009-08-16 14:53:11 +00:00
|
|
|
*/
|
|
|
|
|
2011-02-25 10:21:56 +00:00
|
|
|
/** \file audaspace/jack/AUD_JackDevice.h
|
|
|
|
* \ingroup audjack
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
2012-02-17 18:59:41 +00:00
|
|
|
#ifndef __AUD_JACKDEVICE_H__
|
|
|
|
#define __AUD_JACKDEVICE_H__
|
2009-08-16 14:53:11 +00:00
|
|
|
|
2009-08-20 09:18:55 +00:00
|
|
|
|
2009-08-16 14:53:11 +00:00
|
|
|
#include "AUD_SoftwareDevice.h"
|
2010-07-28 09:36:03 +00:00
|
|
|
#include "AUD_Buffer.h"
|
2009-08-16 14:53:11 +00:00
|
|
|
|
2010-08-03 08:07:21 +00:00
|
|
|
#include <string>
|
|
|
|
|
2011-12-12 22:17:02 +00:00
|
|
|
#if defined(__APPLE__) // always first include for jack weaklinking !
|
|
|
|
#include <weakjack.h>
|
|
|
|
#endif
|
|
|
|
|
2009-08-16 14:53:11 +00:00
|
|
|
#include <jack.h>
|
2010-02-11 20:09:45 +00:00
|
|
|
#include <ringbuffer.h>
|
2009-08-16 14:53:11 +00:00
|
|
|
|
2010-02-21 18:01:41 +00:00
|
|
|
typedef void (*AUD_syncFunction)(void*, int, float);
|
|
|
|
|
2009-08-16 14:53:11 +00:00
|
|
|
/**
|
|
|
|
* This device plays back through Jack.
|
|
|
|
*/
|
|
|
|
class AUD_JackDevice : public AUD_SoftwareDevice
|
|
|
|
{
|
|
|
|
private:
|
|
|
|
/**
|
|
|
|
* The output ports of jack.
|
|
|
|
*/
|
|
|
|
jack_port_t** m_ports;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* The jack client.
|
|
|
|
*/
|
|
|
|
jack_client_t* m_client;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* The output buffer.
|
|
|
|
*/
|
2010-07-28 09:36:03 +00:00
|
|
|
AUD_Buffer m_buffer;
|
2009-08-16 14:53:11 +00:00
|
|
|
|
2010-07-28 09:36:03 +00:00
|
|
|
/**
|
|
|
|
* The deinterleaving buffer.
|
|
|
|
*/
|
|
|
|
AUD_Buffer m_deinterleavebuf;
|
2010-02-11 20:09:45 +00:00
|
|
|
|
2010-02-21 18:01:41 +00:00
|
|
|
jack_ringbuffer_t** m_ringbuffers;
|
|
|
|
|
2009-08-16 14:53:11 +00:00
|
|
|
/**
|
|
|
|
* Whether the device is valid.
|
|
|
|
*/
|
|
|
|
bool m_valid;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Invalidates the jack device.
|
|
|
|
* \param data The jack device that gets invalidet by jack.
|
|
|
|
*/
|
|
|
|
static void jack_shutdown(void *data);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Mixes the next bytes into the buffer.
|
|
|
|
* \param length The length in samples to be filled.
|
|
|
|
* \param data A pointer to the jack device.
|
|
|
|
* \return 0 what shows success.
|
|
|
|
*/
|
|
|
|
static int jack_mix(jack_nframes_t length, void *data);
|
|
|
|
|
2010-02-21 18:01:41 +00:00
|
|
|
static int jack_sync(jack_transport_state_t state, jack_position_t* pos, void* data);
|
2010-02-11 20:09:45 +00:00
|
|
|
|
2010-02-21 18:01:41 +00:00
|
|
|
/**
|
2010-12-22 10:51:34 +00:00
|
|
|
* Next Jack Transport state (-1 if not expected to change).
|
2010-02-21 18:01:41 +00:00
|
|
|
*/
|
2010-12-22 10:51:34 +00:00
|
|
|
jack_transport_state_t m_nextState;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Current jack transport status.
|
|
|
|
*/
|
|
|
|
jack_transport_state_t m_state;
|
2010-02-11 20:09:45 +00:00
|
|
|
|
2010-02-21 18:01:41 +00:00
|
|
|
/**
|
|
|
|
* Syncronisation state.
|
|
|
|
*/
|
|
|
|
int m_sync;
|
2010-02-11 20:09:45 +00:00
|
|
|
|
|
|
|
/**
|
2010-02-21 18:01:41 +00:00
|
|
|
* External syncronisation callback function.
|
2010-02-11 20:09:45 +00:00
|
|
|
*/
|
2010-02-21 18:01:41 +00:00
|
|
|
AUD_syncFunction m_syncFunc;
|
2010-02-11 20:09:45 +00:00
|
|
|
|
2010-02-21 18:01:41 +00:00
|
|
|
/**
|
|
|
|
* Data for the sync function.
|
|
|
|
*/
|
|
|
|
void* m_syncFuncData;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* The mixing thread.
|
|
|
|
*/
|
|
|
|
pthread_t m_mixingThread;
|
|
|
|
|
2011-08-16 13:00:55 +00:00
|
|
|
/**
|
|
|
|
* Mutex for mixing.
|
|
|
|
*/
|
2010-02-21 18:01:41 +00:00
|
|
|
pthread_mutex_t m_mixingLock;
|
2010-02-11 20:09:45 +00:00
|
|
|
|
2011-08-16 13:00:55 +00:00
|
|
|
/**
|
|
|
|
* Condition for mixing.
|
|
|
|
*/
|
2010-02-21 18:01:41 +00:00
|
|
|
pthread_cond_t m_mixingCondition;
|
|
|
|
|
2011-08-16 13:00:55 +00:00
|
|
|
/**
|
|
|
|
* Mixing thread function.
|
|
|
|
* \param device The this pointer.
|
|
|
|
* \return NULL.
|
|
|
|
*/
|
2010-02-21 18:01:41 +00:00
|
|
|
static void* runMixingThread(void* device);
|
|
|
|
|
2011-08-16 13:00:55 +00:00
|
|
|
/**
|
|
|
|
* Updates the ring buffers.
|
|
|
|
*/
|
2010-02-21 18:01:41 +00:00
|
|
|
void updateRingBuffers();
|
2010-02-11 20:09:45 +00:00
|
|
|
|
2010-07-28 09:36:03 +00:00
|
|
|
// hide copy constructor and operator=
|
|
|
|
AUD_JackDevice(const AUD_JackDevice&);
|
|
|
|
AUD_JackDevice& operator=(const AUD_JackDevice&);
|
|
|
|
|
2009-08-16 14:53:11 +00:00
|
|
|
protected:
|
|
|
|
virtual void playing(bool playing);
|
|
|
|
|
|
|
|
public:
|
|
|
|
/**
|
|
|
|
* Creates a Jack client for audio output.
|
2010-08-03 08:07:21 +00:00
|
|
|
* \param name The client name.
|
2010-07-28 09:36:03 +00:00
|
|
|
* \param specs The wanted audio specification, where only the channel count
|
|
|
|
* is important.
|
2010-08-03 08:07:21 +00:00
|
|
|
* \param buffersize The size of the internal buffer.
|
2009-08-16 14:53:11 +00:00
|
|
|
* \exception AUD_Exception Thrown if the audio device cannot be opened.
|
|
|
|
*/
|
2010-08-03 08:07:21 +00:00
|
|
|
AUD_JackDevice(std::string name, AUD_DeviceSpecs specs, int buffersize = AUD_DEFAULT_BUFFER_SIZE);
|
2009-08-16 14:53:11 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Closes the Jack client.
|
|
|
|
*/
|
|
|
|
virtual ~AUD_JackDevice();
|
2010-02-21 18:01:41 +00:00
|
|
|
|
2011-08-16 13:00:55 +00:00
|
|
|
/**
|
|
|
|
* Starts jack transport playback.
|
|
|
|
*/
|
2010-02-21 18:01:41 +00:00
|
|
|
void startPlayback();
|
2011-08-16 13:00:55 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Stops jack transport playback.
|
|
|
|
*/
|
2010-02-21 18:01:41 +00:00
|
|
|
void stopPlayback();
|
2011-08-16 13:00:55 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Seeks jack transport playback.
|
|
|
|
* \param time The time to seek to.
|
|
|
|
*/
|
2010-02-21 18:01:41 +00:00
|
|
|
void seekPlayback(float time);
|
2011-08-16 13:00:55 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Sets the sync callback for jack transport playback.
|
|
|
|
* \param sync The callback function.
|
|
|
|
* \param data The data for the function.
|
|
|
|
*/
|
2010-02-21 18:01:41 +00:00
|
|
|
void setSyncCallback(AUD_syncFunction sync, void* data);
|
2011-08-16 13:00:55 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Retrieves the jack transport playback time.
|
|
|
|
* \return The current time position.
|
|
|
|
*/
|
2010-02-21 18:01:41 +00:00
|
|
|
float getPlaybackPosition();
|
2011-08-16 13:00:55 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Returns whether jack transport plays back.
|
|
|
|
* \return Whether jack transport plays back.
|
|
|
|
*/
|
2010-02-21 18:01:41 +00:00
|
|
|
bool doesPlayback();
|
2009-08-16 14:53:11 +00:00
|
|
|
};
|
|
|
|
|
2012-02-17 18:59:41 +00:00
|
|
|
#endif //__AUD_JACKDEVICE_H__
|