1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
|
//
// AudioSettings.h - MrsWatson
// Created by Nik Reiman on 1/4/12.
// Copyright (c) 2012 Teragon Audio. All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
// * Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer.
// * Redistributions in binary form must reproduce the above copyright notice,
// this list of conditions and the following disclaimer in the documentation
// and/or other materials provided with the distribution.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.
//
#ifndef MrsWatson_AudioSettings_h
#define MrsWatson_AudioSettings_h
#include "base/Types.h"
#include "base/CharString.h"
#define DEFAULT_SAMPLE_RATE 44100.0f
#define DEFAULT_NUM_CHANNELS 2
#define DEFAULT_BLOCKSIZE 512l
#define DEFAULT_TIME_DIVISION 96
#define DEFAULT_BITRATE 16
#define DEFAULT_TEMPO 120.0f
#define DEFAULT_TIMESIG_BEATS_PER_MEASURE 4
#define DEFAULT_TIMESIG_NOTE_VALUE 4
typedef struct {
SampleRate sampleRate;
ChannelCount numChannels;
SampleCount blocksize;
Tempo tempo;
unsigned short timeSignatureBeatsPerMeasure;
unsigned short timeSignatureNoteValue;
} AudioSettingsMembers;
typedef AudioSettingsMembers *AudioSettings;
extern AudioSettings audioSettingsInstance;
/**
* Initialize the global audio settings instance. Since many different classes
* require quick access to the audio settings, this is one of the few classes
* that has a global singleton instance rather than a "new" allocator.
*/
void initAudioSettings(void);
/**
* Get the current sample rate.
* @return Sample rate in Hertz
*/
SampleRate getSampleRate(void);
/**
* Get the number of output channels.
* @return Number of channels
*/
ChannelCount getNumChannels(void);
/**
* Give the current block size, which is the number of sample frames sent to the
* plugin each time process is called. Note that the blocksize is the number of
* *frames* sent to the plugin, so if the channel count is 2 and the blocksize
* is 512, 1024 samples will be sent to the plugin. However in that case this
* function would still return 512.
* @return Blocksize, in sample frames
*/
SampleCount getBlocksize(void);
/**
* Get the current tempo, in beats per minute
* @return Temo in BPM
*/
Tempo getTempo(void);
/**
* Get the current time signature's numerator, the number of beats per measure.
* @return Time signature numerator
*/
unsigned short getTimeSignatureBeatsPerMeasure(void);
/**
* Get the current time signatures denominator, the value of one beat unit.
* @return Time signature denominator
*/
unsigned short getTimeSignatureNoteValue(void);
/**
* Set the sample rate to be used during processing. This must be set before the
* plugin chain is initialized. This function only requires a nonzero value,
* however some plugins may behave strangely when sent unusual sample rates.
* @param sampleRate Sample rate, in Hertz
* @return True if successfully set, false otherwise
*/
boolByte setSampleRate(const SampleRate sampleRate);
/**
* Set the number of channels to be used during processing. Note that if the
* input source defines a channel called, it may override this value.
* @param numChannels Number of channels
* @return True if successfully set, false otherwise
*/
boolByte setNumChannels(const ChannelCount numChannels);
/**
* Set the blocksize to be used during processing. Again this should be called
* before initializing the plugin chain.
* @param blocksize Blocksize in sample frames
* @return True if successfully set, false otherwise
*/
boolByte setBlocksize(const SampleCount blocksize);
/**
* Set tempo to be used during processing.
* @param tempo Tempo in beats per minute
* @return True if successfully set, false otherwise
*/
boolByte setTempo(const Tempo tempo);
/**
* MIDI files represent tempo in meta events with a three-byte payload. This
* method transforms the three byte sequence from such file into an actual tempo
* in beats per minute, and then sets the global tempo to this value.
* @param bytes Three byte sequence as read from a MIDI file
*/
void setTempoFromMidiBytes(const byte *bytes);
/**
* Set the time signature's numerator. This function does very little error
* checking, but it does require a non-zero value. However, many plugins may act
* strangely with unusual time signatures.
* @param beatsPerMeasure Time signature numerator
* @return True if successfully set, false otherwise
*/
boolByte setTimeSignatureBeatsPerMeasure(const unsigned short beatsPerMeasure);
/**
* Set the time signature's denominator. This function does very little error
* checking, but it does require a non-zero value. However, many plugins may act
* strangely with unusual time signatures.
* @param noteValue Time signature denominator
* @return True if successfully set, false otherwise
*/
boolByte setTimeSignatureNoteValue(const unsigned short noteValue);
/**
* MIDI files represent musical time signature with a two-byte sequence. This
* function takes two bytes, derives the corresponding time signature, and sets
* it in the global instance.
* @param bytes Two byte sequence as read from a MIDI file
* @return True if successfully set, false otherwise
*/
boolByte setTimeSignatureFromMidiBytes(const byte *bytes);
/**
* Set the time signature from a string, should look like "3/4".
* @param signature Time signature to set
* @return True if successfully set, false otherwise
*/
boolByte setTimeSignatureFromString(const CharString signature);
/**
* Release memory of the global audio settings instance. Any attempt to use the
* audio settings functions after this has been called will result in undefined
* behavior.
*/
void freeAudioSettings(void);
#endif
|
