Added jack audio support, building with cmake only currently, feel free to add scons...
[blender-staging.git] / intern / audaspace / jack / AUD_JackDevice.h
1 /*
2  * $Id: AUD_SDLDevice.h 22328 2009-08-09 23:23:19Z gsrb3d $
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 #include "AUD_SoftwareDevice.h"
30 class AUD_Buffer;
31
32 #include <jack.h>
33
34 /**
35  * This device plays back through Jack.
36  */
37 class AUD_JackDevice : public AUD_SoftwareDevice
38 {
39 private:
40         /**
41          * The output ports of jack.
42          */
43         jack_port_t** m_ports;
44
45         /**
46          * The jack client.
47          */
48         jack_client_t* m_client;
49
50         /**
51          * The output buffer.
52          */
53         AUD_Buffer* m_buffer;
54
55         /**
56          * Whether the device is valid.
57          */
58         bool m_valid;
59
60         /**
61          * Invalidates the jack device.
62          * \param data The jack device that gets invalidet by jack.
63          */
64         static void jack_shutdown(void *data);
65
66         /**
67          * Mixes the next bytes into the buffer.
68          * \param length The length in samples to be filled.
69          * \param data A pointer to the jack device.
70          * \return 0 what shows success.
71          */
72         static int jack_mix(jack_nframes_t length, void *data);
73
74 protected:
75         virtual void playing(bool playing);
76
77 public:
78         /**
79          * Creates a Jack client for audio output.
80          * \param specs The wanted audio specification, where only the channel count is important.
81          * \exception AUD_Exception Thrown if the audio device cannot be opened.
82          */
83         AUD_JackDevice(AUD_Specs specs);
84
85         /**
86          * Closes the Jack client.
87          */
88         virtual ~AUD_JackDevice();
89 };
90
91 #endif //AUD_JACKDEVICE