e6d332e1160d36cea825592cef03fd48312bd2d9
[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 #ifdef WITH_JACK
30
31 #include "AUD_SoftwareDevice.h"
32 class AUD_Buffer;
33
34 #include <jack.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         /**
58          * Whether the device is valid.
59          */
60         bool m_valid;
61
62         /**
63          * Invalidates the jack device.
64          * \param data The jack device that gets invalidet by jack.
65          */
66         static void jack_shutdown(void *data);
67
68         /**
69          * Mixes the next bytes into the buffer.
70          * \param length The length in samples to be filled.
71          * \param data A pointer to the jack device.
72          * \return 0 what shows success.
73          */
74         static int jack_mix(jack_nframes_t length, void *data);
75
76 protected:
77         virtual void playing(bool playing);
78
79 public:
80         /**
81          * Creates a Jack client for audio output.
82          * \param specs The wanted audio specification, where only the channel count is important.
83          * \exception AUD_Exception Thrown if the audio device cannot be opened.
84          */
85         AUD_JackDevice(AUD_Specs specs);
86
87         /**
88          * Closes the Jack client.
89          */
90         virtual ~AUD_JackDevice();
91 };
92
93 #endif //WITH_JACK
94
95 #endif //AUD_JACKDEVICE