2.5 Audio:
[blender-staging.git] / intern / audaspace / jack / AUD_JackDevice.h
1 /*
2  * $Id$
3  *
4  * ***** BEGIN LGPL LICENSE BLOCK *****
5  *
6  * Copyright 2009 Jörg Hermann Müller
7  *
8  * This file is part of AudaSpace.
9  *
10  * AudaSpace is free software: you can redistribute it and/or modify
11  * it under the terms of the GNU Lesser General Public License as published by
12  * the Free Software Foundation, either version 3 of the License, or
13  * (at your option) any later version.
14  *
15  * AudaSpace is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU Lesser General Public License for more details.
19  *
20  * You should have received a copy of the GNU Lesser General Public License
21  * along with AudaSpace.  If not, see <http://www.gnu.org/licenses/>.
22  *
23  * ***** END LGPL LICENSE BLOCK *****
24  */
25
26 #ifndef AUD_JACKDEVICE
27 #define AUD_JACKDEVICE
28
29
30 #include "AUD_SoftwareDevice.h"
31 class AUD_Buffer;
32
33 #include <jack.h>
34 #include <ringbuffer.h>
35
36 typedef void (*AUD_syncFunction)(void*, int, float);
37
38 /**
39  * This device plays back through Jack.
40  */
41 class AUD_JackDevice : public AUD_SoftwareDevice
42 {
43 private:
44         /**
45          * The output ports of jack.
46          */
47         jack_port_t** m_ports;
48
49         /**
50          * The jack client.
51          */
52         jack_client_t* m_client;
53
54         /**
55          * The output buffer.
56          */
57         AUD_Buffer* m_buffer;
58
59         AUD_Buffer* m_deinterleavebuf;
60
61         jack_ringbuffer_t** m_ringbuffers;
62
63         /**
64          * Whether the device is valid.
65          */
66         bool m_valid;
67
68         /**
69          * Invalidates the jack device.
70          * \param data The jack device that gets invalidet by jack.
71          */
72         static void jack_shutdown(void *data);
73
74         /**
75          * Mixes the next bytes into the buffer.
76          * \param length The length in samples to be filled.
77          * \param data A pointer to the jack device.
78          * \return 0 what shows success.
79          */
80         static int jack_mix(jack_nframes_t length, void *data);
81
82         static int jack_sync(jack_transport_state_t state, jack_position_t* pos, void* data);
83
84         /**
85          * Last Jack Transport playing state.
86          */
87         bool m_playing;
88
89         /**
90          * Syncronisation state.
91          */
92         int m_sync;
93
94         /**
95          * External syncronisation callback function.
96          */
97         AUD_syncFunction m_syncFunc;
98
99         /**
100          * Data for the sync function.
101          */
102         void* m_syncFuncData;
103
104         /**
105          * The mixing thread.
106          */
107         pthread_t m_mixingThread;
108
109         pthread_mutex_t m_mixingLock;
110
111         pthread_cond_t m_mixingCondition;
112
113         static void* runMixingThread(void* device);
114
115         void updateRingBuffers();
116
117 protected:
118         virtual void playing(bool playing);
119
120 public:
121         /**
122          * Creates a Jack client for audio output.
123          * \param specs The wanted audio specification, where only the channel count is important.
124          * \exception AUD_Exception Thrown if the audio device cannot be opened.
125          */
126         AUD_JackDevice(AUD_DeviceSpecs specs, int buffersize = AUD_DEFAULT_BUFFER_SIZE);
127
128         /**
129          * Closes the Jack client.
130          */
131         virtual ~AUD_JackDevice();
132
133         void startPlayback();
134         void stopPlayback();
135         void seekPlayback(float time);
136         void setSyncCallback(AUD_syncFunction sync, void* data);
137         float getPlaybackPosition();
138         bool doesPlayback();
139 };
140
141 #endif //AUD_JACKDEVICE