266edd0dfcc576e1f9a290015d7f972541fc169b
[blender.git] / intern / audaspace / SDL / AUD_SDLDevice.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * Copyright 2009-2011 Jörg Hermann Müller
5  *
6  * This file is part of AudaSpace.
7  *
8  * Audaspace is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation; either version 2 of the License, or
11  * (at your option) any later version.
12  *
13  * AudaSpace is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with Audaspace; if not, write to the Free Software Foundation,
20  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
21  *
22  * ***** END GPL LICENSE BLOCK *****
23  */
24
25 /** \file audaspace/SDL/AUD_SDLDevice.h
26  *  \ingroup audsdl
27  */
28
29
30 #ifndef __AUD_SDLDEVICE_H__
31 #define __AUD_SDLDEVICE_H__
32
33 #include "AUD_SoftwareDevice.h"
34
35 #include <SDL.h>
36
37 /**
38  * This device plays back through SDL, the simple direct media layer.
39  */
40 class AUD_SDLDevice : public AUD_SoftwareDevice
41 {
42 private:
43         /**
44          * Mixes the next bytes into the buffer.
45          * \param data The SDL device.
46          * \param buffer The target buffer.
47          * \param length The length in bytes to be filled.
48          */
49         static void SDL_mix(void *data, Uint8* buffer, int length);
50
51         // hide copy constructor and operator=
52         AUD_SDLDevice(const AUD_SDLDevice&);
53         AUD_SDLDevice& operator=(const AUD_SDLDevice&);
54
55 protected:
56         virtual void playing(bool playing);
57
58 public:
59         /**
60          * Opens the SDL audio device for playback.
61          * \param specs The wanted audio specification.
62          * \param buffersize The size of the internal buffer.
63          * \note The specification really used for opening the device may differ.
64          * \exception AUD_Exception Thrown if the audio device cannot be opened.
65          */
66         AUD_SDLDevice(AUD_DeviceSpecs specs,
67                                   int buffersize = AUD_DEFAULT_BUFFER_SIZE);
68
69         /**
70          * Closes the SDL audio device.
71          */
72         virtual ~AUD_SDLDevice();
73 };
74
75 #endif //__AUD_SDLDEVICE_H__