3 Ann Hell Ex Machina - Music Software
4 Copyright (C) 2003/2005 Angel Ortega <angel@triptico.com>
6 ss_ins.c - Software synthesizer's instruments
8 This program is free software; you can redistribute it and/or
9 modify it under the terms of the GNU General Public License
10 as published by the Free Software Foundation; either version 2
11 of the License, or (at your option) any later version.
13 This program 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.
18 You should have received a copy of the GNU General Public License
19 along with this program; if not, write to the Free Software
20 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
22 http://www.triptico.com
37 #include "ss_output.h"
47 /* grows a dynamic array */
48 #define GROW(b,n,t) b=(t *)realloc(b,((n) + 1) * sizeof(t))
51 * ss_ins_init - Initializes an instrument.
54 * Initializes an instrument structure.
56 void ss_ins_init(struct ss_ins
* i
)
58 memset(i
, '\0', sizeof(struct ss_ins
));
60 /* default channels: stereo left and right, full volume */
61 ss_ins_set_channel(i
, 0, 1.0);
62 ss_ins_set_channel(i
, 1, 1.0);
64 /* sustain shouldn't be 0 to avoid end of note clicks */
65 ss_ins_set_sustain(i
, 50.0);
70 * ss_ins_add_layer - Adds a layer to an instrument.
72 * @w: wave describing the layer
74 * Adds a layer to an instrument.
76 * Returns 0 if the layer was added successfully.
78 void ss_ins_add_layer(struct ss_ins
* i
, struct ss_wave
* w
)
81 GROW(i
->layers
, i
->n_layers
, struct ss_wave
*);
83 i
->layers
[i
->n_layers
]=w
;
90 * ss_ins_find_layer - Finds a layer inside an instrument
92 * @freq: the desired frequency
93 * @off: pointer to element offset to start searching
95 * Finds a layer inside the @i instrument with a matching @freq, starting
96 * from the layer number pointed by @off. If a matching layer is found, its
97 * struct ss_wave is returned and @off is left pointing to the next layer
98 * (allowing it to be used as an enumerator). If no layer is found, NULL
101 struct ss_wave
* ss_ins_find_layer(struct ss_ins
* i
, double freq
, int * off
)
105 /* find a matching layer, starting from *off */
106 for(;*off
< i
->n_layers
;(*off
)++)
110 if(freq
>= w
->min_freq
&& freq
<= w
->max_freq
)
114 /* passed the end; none found */
115 if(*off
== i
->n_layers
)
125 * ss_ins_set_channel - Sets the volume for an instrument's channel.
127 * @channel: channel number
130 * Sets the volume for an instrument's channel. If the channel does
131 * not exist, it's created and space allocated for it in the volume and
132 * effect dynamic arrays.
134 void ss_ins_set_channel(struct ss_ins
* i
, int channel
, float vol
)
136 /* if channel is new, alloc space for it */
137 if(channel
<= i
->n_channels
)
141 GROW(i
->vols
, channel
, float);
142 GROW(i
->effs
, channel
, struct ss_eff
*);
144 /* fill newly allocated space */
145 for(n
=i
->n_channels
;n
<= channel
;n
++)
151 i
->n_channels
=channel
+ 1;
155 i
->vols
[channel
]=vol
;
160 * ss_ins_set_sustain - Sets the sustain for an instrument.
162 * @sustain: the sustain time in milliseconds
164 * Sets the sustain for an instrument. @sustain is expressed in
167 void ss_ins_set_sustain(struct ss_ins
* i
, double sustain
)
174 * ss_ins_play - Plays a note given the desired wave.
181 * Orders the instrument to start playing a note, given a specific wave.
182 * The wave is usually one of the instrument's layers, but it doesn't
185 * Returns zero if there were no free generators, or non-zero otherwise.
187 int ss_ins_play(struct ss_ins
* i
, double freq
, float vol
, int note_id
,
192 /* get a free generator, or fail */
193 if((g
=ss_gen_alloc(&i
->gens
)) == NULL
)
196 /* start the generator */
197 ss_gen_play(g
, freq
, vol
, note_id
, w
);
200 ss_gen_sustain(g
, i
->sustain
);
207 * ss_ins_note_on - Plays a note.
209 * @note: MIDI note to be played
213 * Locates a layer to play a note, and starts generators to
214 * play it. The @note is expressed as a MIDI note and the
215 * desired volume (from 0 to 1) stored in @vol. The note @id
216 * should be a positive, unique identifier for this note; no two
217 * simultaneously playing notes should share this id.
219 * Returns the number of generators that were activated.
221 int ss_ins_note_on(struct ss_ins
* i
, int note
, float vol
, int note_id
)
227 freq
=ss_note_frequency(note
);
229 for(n
=g
=0;(w
=ss_ins_find_layer(i
, freq
, &n
)) != NULL
;g
++)
231 if(!ss_ins_play(i
, freq
, vol
, note_id
, w
))
240 * ss_ins_note_off - Releases a note.
242 * @note_id: the id of the note to be released
244 * Releases a note. The generators associated to it will enter release mode.
246 void ss_ins_note_off(struct ss_ins
* i
, int note_id
)
250 /* releases all generators with that note_id */
251 for(g
=i
->gens
;g
!= NULL
;g
=g
->next
)
253 if(g
->note_id
== note_id
)
260 * ss_ins_frame - Generates a frame of samples.
262 * @frame: array where the output samples will be stored
264 * Generates a frame of samples mixing all the active generators
267 void ss_ins_frame(struct ss_ins
* i
, float frame
[])
272 float l_frame
[SS_MAX_CHANNELS
];
274 /* resets this local frame */
275 ss_output_init_frame(l_frame
);
277 /* loops through the generators */
278 for(g
=i
->gens
;g
!= NULL
;g
=t
)
282 /* if the generator has stopped, free it */
283 if(ss_gen_frame(g
, i
->n_channels
, l_frame
))
284 ss_gen_free(&i
->gens
, g
);
287 /* loops through the effects and remixes */
288 for(n
=0;n
< i
->n_channels
;n
++)
289 frame
[n
] += ss_eff_process(i
->effs
[n
],
290 l_frame
[n
] * i
->vols
[n
]);