README.md edited online with Bitbucket
[camargo/neiasound.git] / src / nSoundSystem.h
1 // Copyright (C) 2015 Lucas Pires Camargo
2 // 
3 // This file is part of neiasound - Qt-style OpenAL wrapper for games.
4 // 
5 // Redistribution and use in source and binary forms, with or without
6 // modification, are permitted provided that the following conditions are
7 // met:
8 // 
9 // 1. Redistributions of source code must retain the above copyright notice,
10 // this list of conditions and the following disclaimer.
11 // 
12 // 2. Redistributions in binary form must reproduce the above copyright notice,
13 // this list of conditions and the following disclaimer in the documentation
14 // and/or other materials provided with the distribution.
15 // 
16 // THIS SOFTWARE IS PROVIDED BY THE FREEBSD PROJECT ``AS IS'' AND ANY EXPRESS
17 // OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18 // OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN
19 // NO EVENT SHALL THE FREEBSD PROJECT OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
20 // INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21 // (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22 // LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
23 // ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25 // THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 #ifndef NSOUNDSYSTEM_H
27 #define NSOUNDSYSTEM_H
28
29 #include <QObject>
30 #include <QHash>
31 #include "nSoundSourceRole.h"
32 #include "nSoundFormat.h"
33
34 // *sigh* ugly but necessary
35 struct ALCcontext_struct;
36 struct ALCdevice_struct;
37 typedef struct ALCcontext_struct ALCcontext;
38 typedef struct ALCdevice_struct ALCdevice;
39
40 class nSoundSource;
41 class nSoundBuffer;
42 class nSoundListener;
43 class nSoundStreamer;
44 class nSoundStreamerPlaylist;
45
46 class nSoundSystem : public QObject
47 {
48     Q_OBJECT
49     Q_PROPERTY(int supportedAuxiliarySends READ supportedAuxiliarySends)
50     Q_PROPERTY(qreal masterGain READ masterGain WRITE setMasterGain NOTIFY masterGainChanged)
51     Q_PROPERTY(nSoundListener * listener READ listener)
52     Q_PROPERTY(ALCcontext * openalContext READ openalContext)
53     Q_PROPERTY(ALCdevice * openalDevice READ openalDevice)
54     Q_ENUMS(nSoundFormat)
55     Q_ENUMS(nSoundSourceRole)
56 public:
57     explicit nSoundSystem(QObject *parent = 0);
58     virtual ~nSoundSystem();
59
60     ALCcontext * openalContext(){return m_context;}
61     ALCdevice * openalDevice(){return m_device;}
62
63     nSoundListener * listener(){return m_listener;}
64
65     qreal masterGain();
66
67     int supportedAuxiliarySends(){return m_numSends;}
68
69 signals:
70
71     void masterGainChanged(qreal arg);
72
73 public slots:
74
75     void update(qreal);
76
77     void setMasterGain(qreal gain);
78
79     nSoundSource * createSource(QString name = "", nSoundSourceRole = SSR_SFX);
80     nSoundSource * source(QString name);
81     bool destroySource(QString name);
82     bool destroySource(nSoundSource * source);
83
84     nSoundBuffer * createBuffer(QString name);
85     nSoundBuffer * buffer(QString name);
86     bool destroyBuffer(QString name);
87     bool destroyBuffer(nSoundBuffer * buffer);
88
89
90     nSoundStreamer * createStreamer(QString name, nSoundSource * source, nSoundStreamerPlaylist * playlist = 0);
91     nSoundStreamerPlaylist * createStreamerPlaylist(QObject * parent);
92     nSoundStreamer * streamer(QString name);
93     bool destroyStreamer(QString name);
94     bool destroyStreamer(nSoundStreamer * streamer);
95
96 private:
97     QHash<QString, nSoundSource*> m_sources;
98     QHash<QString, nSoundBuffer*> m_buffers;
99     QHash<QString, nSoundStreamer*> m_streamers;
100
101     nSoundListener * m_listener;
102
103     bool m_success;
104     int m_numSends;
105     ALCcontext * m_context;
106     ALCdevice * m_device;
107     qreal m_masterGain;
108 };
109
110 #endif // NSOUNDSYSTEM_H