2.5 Audio: The jack backend is now realtime capable and will not produce so much...
[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 class AUD_Buffer;
32
33 #include <jack.h>
34 #include <ringbuffer.h>
35
36 /**
37  * This device plays back through Jack.
38  */
39 class AUD_JackDevice : public AUD_SoftwareDevice
40 {
41 private:
42         /**
43          * The output ports of jack.
44          */
45         jack_port_t** m_ports;
46
47         /**
48          * The jack client.
49          */
50         jack_client_t* m_client;
51
52         /**
53          * The output buffer.
54          */
55         AUD_Buffer* m_buffer;
56
57         AUD_Buffer* m_deinterleavebuf;
58
59         /**
60          * Whether the device is valid.
61          */
62         bool m_valid;
63
64         /**
65          * Invalidates the jack device.
66          * \param data The jack device that gets invalidet by jack.
67          */
68         static void jack_shutdown(void *data);
69
70         /**
71          * Mixes the next bytes into the buffer.
72          * \param length The length in samples to be filled.
73          * \param data A pointer to the jack device.
74          * \return 0 what shows success.
75          */
76         static int jack_mix(jack_nframes_t length, void *data);
77
78         static void* runThread(void* device);
79
80         void updateRingBuffers();
81
82         jack_ringbuffer_t** m_ringbuffers;
83
84         /**
85          * The streaming thread.
86          */
87         pthread_t m_thread;
88
89         pthread_mutex_t m_lock;
90
91         pthread_cond_t m_condition;
92
93 protected:
94         virtual void playing(bool playing);
95
96 public:
97         /**
98          * Creates a Jack client for audio output.
99          * \param specs The wanted audio specification, where only the channel count is important.
100          * \exception AUD_Exception Thrown if the audio device cannot be opened.
101          */
102         AUD_JackDevice(AUD_DeviceSpecs specs, int buffersize = AUD_DEFAULT_BUFFER_SIZE);
103
104         /**
105          * Closes the Jack client.
106          */
107         virtual ~AUD_JackDevice();
108 };
109
110 #endif //AUD_JACKDEVICE