svn merge -r 31314:31370 https://svn.blender.org/svnroot/bf-blender/trunk/blender
[blender.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 #include "AUD_Buffer.h"
32
33 #include <string>
34
35 #include <jack.h>
36 #include <ringbuffer.h>
37
38 typedef void (*AUD_syncFunction)(void*, int, float);
39
40 /**
41  * This device plays back through Jack.
42  */
43 class AUD_JackDevice : public AUD_SoftwareDevice
44 {
45 private:
46         /**
47          * The output ports of jack.
48          */
49         jack_port_t** m_ports;
50
51         /**
52          * The jack client.
53          */
54         jack_client_t* m_client;
55
56         /**
57          * The output buffer.
58          */
59         AUD_Buffer m_buffer;
60
61         /**
62          * The deinterleaving buffer.
63          */
64         AUD_Buffer m_deinterleavebuf;
65
66         jack_ringbuffer_t** m_ringbuffers;
67
68         /**
69          * Whether the device is valid.
70          */
71         bool m_valid;
72
73         /**
74          * Invalidates the jack device.
75          * \param data The jack device that gets invalidet by jack.
76          */
77         static void jack_shutdown(void *data);
78
79         /**
80          * Mixes the next bytes into the buffer.
81          * \param length The length in samples to be filled.
82          * \param data A pointer to the jack device.
83          * \return 0 what shows success.
84          */
85         static int jack_mix(jack_nframes_t length, void *data);
86
87         static int jack_sync(jack_transport_state_t state, jack_position_t* pos, void* data);
88
89         /**
90          * Last Jack Transport playing state.
91          */
92         bool m_playing;
93
94         /**
95          * Syncronisation state.
96          */
97         int m_sync;
98
99         /**
100          * External syncronisation callback function.
101          */
102         AUD_syncFunction m_syncFunc;
103
104         /**
105          * Data for the sync function.
106          */
107         void* m_syncFuncData;
108
109         /**
110          * The mixing thread.
111          */
112         pthread_t m_mixingThread;
113
114         pthread_mutex_t m_mixingLock;
115
116         pthread_cond_t m_mixingCondition;
117
118         static void* runMixingThread(void* device);
119
120         void updateRingBuffers();
121
122         // hide copy constructor and operator=
123         AUD_JackDevice(const AUD_JackDevice&);
124         AUD_JackDevice& operator=(const AUD_JackDevice&);
125
126 protected:
127         virtual void playing(bool playing);
128
129 public:
130         /**
131          * Creates a Jack client for audio output.
132          * \param name The client name.
133          * \param specs The wanted audio specification, where only the channel count
134          *              is important.
135          * \param buffersize The size of the internal buffer.
136          * \exception AUD_Exception Thrown if the audio device cannot be opened.
137          */
138         AUD_JackDevice(std::string name, AUD_DeviceSpecs specs, int buffersize = AUD_DEFAULT_BUFFER_SIZE);
139
140         /**
141          * Closes the Jack client.
142          */
143         virtual ~AUD_JackDevice();
144
145         void startPlayback();
146         void stopPlayback();
147         void seekPlayback(float time);
148         void setSyncCallback(AUD_syncFunction sync, void* data);
149         float getPlaybackPosition();
150         bool doesPlayback();
151 };
152
153 #endif //AUD_JACKDEVICE