MezzanineEngine
Main Page
Related Pages
Namespaces
Classes
Files
File List
File Members
All
Classes
Namespaces
Files
Functions
Variables
Typedefs
Enumerations
Enumerator
Friends
Macros
Pages
Mezzanine
src
Audio
audioenumerations.h
1
// © Copyright 2010 - 2014 BlackTopp Studios Inc.
2
/* This file is part of The Mezzanine Engine.
3
4
The Mezzanine Engine is free software: you can redistribute it and/or modify
5
it under the terms of the GNU General Public License as published by
6
the Free Software Foundation, either version 3 of the License, or
7
(at your option) any later version.
8
9
The Mezzanine Engine is distributed in the hope that it will be useful,
10
but WITHOUT ANY WARRANTY; without even the implied warranty of
11
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12
GNU General Public License for more details.
13
14
You should have received a copy of the GNU General Public License
15
along with The Mezzanine Engine. If not, see <http://www.gnu.org/licenses/>.
16
*/
17
/* The original authors have included a copy of the license specified above in the
18
'Docs' folder. See 'gpl.txt'
19
*/
20
/* We welcome the use of the Mezzanine engine to anyone, including companies who wish to
21
Build professional software and charge for their product.
22
23
However there are some practical restrictions, so if your project involves
24
any of the following you should contact us and we will try to work something
25
out:
26
- DRM or Copy Protection of any kind(except Copyrights)
27
- Software Patents You Do Not Wish to Freely License
28
- Any Kind of Linking to Non-GPL licensed Works
29
- Are Currently In Violation of Another Copyright Holder's GPL License
30
- If You want to change our code and not add a few hundred MB of stuff to
31
your distribution
32
33
These and other limitations could cause serious legal problems if you ignore
34
them, so it is best to simply contact us or the Free Software Foundation, if
35
you have any questions.
36
37
Joseph Toppi - toppij@gmail.com
38
John Blackwood - makoenergy02@gmail.com
39
*/
40
#ifndef _audioenumerations_h
41
#define _audioenumerations_h
42
///////////////////////////////////////////////////////////////////////////////
43
//Any global enumerations shared between multiple classes in the Audio namespace is to be declared here.
44
///////////////////////////////////////
45
46
namespace
Mezzanine
47
{
48
namespace
Audio
49
{
50
/// @enum BitConfig
51
/// @brief Used to describe the different bit configurations supported by this audio system.
52
enum
BitConfig
53
{
54
BC_8Bit_Mono = 1,
55
BC_8Bit_Stereo,
56
BC_16Bit_Mono,
57
BC_16Bit_Stereo,
58
BC_24Bit_Mono,
59
BC_24Bit_Stereo
60
};
61
62
/// @enum Encoding
63
/// @brief The encoding to use when reading or writing an audio buffer.
64
enum
Encoding
65
{
66
Enc_RAW
= 1,
///< Unknown or error condition.
67
Enc_WAV
= 2,
///< Used in .wav files.
68
Enc_FLAC
= 3,
///< Used in .flac files.
69
Enc_VORBIS
= 4,
///< Used in .ogg files.
70
Enc_MP3
= 5,
///< Used in .mp3 files.
71
Enc_SPEEX
= 6,
///< Used in .spx files.
72
Enc_OPUS
= 7
///< Used in .opus files.
73
};
74
75
/// @enum EffectType
76
/// @brief Used by the @ref iEffect class to describe what type of effect it is.
77
enum
EffectType
78
{
79
ET_Null
,
///< Null type with no values.
80
ET_EAX_Reverb
,
///< See @ref EAXReverbParameters.
81
ET_Reverb
,
///< See @ref ReverbParameters.
82
ET_Chorus
,
///< See @ref ChorusParameters.
83
ET_Distortion
,
///< See @ref DistortionParameters.
84
ET_Echo
,
///< See @ref EchoParameters.
85
ET_Flanger
,
///< See @ref FlangerParameters.
86
ET_Frequency_Shifter
,
///< See @ref FrequencyShifterParameters.
87
ET_Vocal_Morpher
,
///< See @ref VocalMorpherParameters.
88
ET_Pitch_Shifter
,
///< See @ref PitchShifterParameters.
89
ET_Ring_Modulator
,
///< See @ref RingModulatorParameters.
90
ET_Autowah
,
///< See @ref AutowahParameters.
91
ET_Compressor
,
///< See @ref CompressorParameters.
92
ET_Equalizer
///< See @ref RqualizerParameters.
93
};
94
95
/// @enum FilterType
96
/// @brief Used by the @ref iFilter class to describe what type of filter it is.
97
enum
FilterType
98
{
99
FT_Null
,
///< Null type with no values.
100
FT_LowPass
,
///< Filters out high frequency audio from a sound beyond a certain threshold.
101
FT_HighPass
,
///< Filters out low frequency audio from a sound below a certain threshold.
102
FT_BandPass
///< Filters out both high and low frequency audio from a sound outside of specified thresholds.
103
};
104
105
/// @enum SoundType
106
/// @brief Used by the @ref iSound class to describe what type of sound it is.
107
enum
SoundType
108
{
109
ST_Ambient
= 1,
///< Environmental sounds. Bird's chirping, water washing against rocks, etc.
110
ST_Dialog
= 2,
///< Character sounds and speech.
111
ST_Effect
= 3,
///< Various effects such as objects colliding, explosions, guns firing, etc.
112
ST_Music
= 4
///< Self explanitory. The game SoundTrack.
113
};
114
}
//audio
115
}
//Mezzanine
116
117
#endif
Generated on Mon Jan 6 2014 20:58:04 for MezzanineEngine by
1.8.4