Relicensing audaspace under GPL 2 or later.
[blender.git] / intern / audaspace / SDL / AUD_SDLDevice.h
1 /*
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * Copyright 2009-2011 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 General Public License as published by
12  * the Free Software Foundation; either version 2 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 General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with Audaspace; if not, write to the Free Software Foundation,
22  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
23  *
24  * ***** END GPL LICENSE BLOCK *****
25  */
26
27 #ifndef AUD_SDLDEVICE
28 #define AUD_SDLDEVICE
29
30 #include "AUD_SoftwareDevice.h"
31
32 #include <SDL.h>
33
34 /**
35  * This device plays back through SDL, the simple direct media layer.
36  */
37 class AUD_SDLDevice : public AUD_SoftwareDevice
38 {
39 private:
40         /**
41          * Mixes the next bytes into the buffer.
42          * \param data The SDL device.
43          * \param buffer The target buffer.
44          * \param length The length in bytes to be filled.
45          */
46         static void SDL_mix(void *data, Uint8* buffer, int length);
47
48         // hide copy constructor and operator=
49         AUD_SDLDevice(const AUD_SDLDevice&);
50         AUD_SDLDevice& operator=(const AUD_SDLDevice&);
51
52 protected:
53         virtual void playing(bool playing);
54
55 public:
56         /**
57          * Opens the SDL audio device for playback.
58          * \param specs The wanted audio specification.
59          * \param buffersize The size of the internal buffer.
60          * \note The specification really used for opening the device may differ.
61          * \exception AUD_Exception Thrown if the audio device cannot be opened.
62          */
63         AUD_SDLDevice(AUD_DeviceSpecs specs,
64                                   int buffersize = AUD_DEFAULT_BUFFER_SIZE);
65
66         /**
67          * Closes the SDL audio device.
68          */
69         virtual ~AUD_SDLDevice();
70 };
71
72 #endif //AUD_SDLDEVICE