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