copy of docs from 2.4x for python modules that have been kept
[blender-staging.git] / intern / audaspace / SDL / AUD_SDLDevice.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_SDLDEVICE
27 #define AUD_SDLDEVICE
28
29 #include "AUD_SoftwareDevice.h"
30
31 #include <SDL.h>
32
33 /**
34  * This device plays back through SDL, the simple direct media layer.
35  */
36 class AUD_SDLDevice : public AUD_SoftwareDevice
37 {
38 private:
39         /**
40          * Mixes the next bytes into the buffer.
41          * \param data The SDL device.
42          * \param buffer The target buffer.
43          * \param length The length in bytes to be filled.
44          */
45         static void SDL_mix(void *data, Uint8* buffer, int length);
46
47 protected:
48         virtual void playing(bool playing);
49
50 public:
51         /**
52          * Opens the SDL audio device for playback.
53          * \param specs The wanted audio specification.
54          * \param buffersize The size of the internal buffer.
55          * \note The specification really used for opening the device may differ.
56          * \exception AUD_Exception Thrown if the audio device cannot be opened.
57          */
58         AUD_SDLDevice(AUD_DeviceSpecs specs,
59                                   int buffersize = AUD_DEFAULT_BUFFER_SIZE);
60
61         /**
62          * Closes the SDL audio device.
63          */
64         virtual ~AUD_SDLDevice();
65 };
66
67 #endif //AUD_SDLDEVICE