annhell.h

   1 /*
   2
   3     Ann Hell Ex Machina - Music Software
   4     Copyright (C) 2003/2005 Angel Ortega <angel@triptico.com>
   5
   6     This program is free software; you can redistribute it and/or
   7     modify it under the terms of the GNU General Public License
   8     as published by the Free Software Foundation; either version 2
   9     of the License, or (at your option) any later version.
  10
  11     This program is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14     GNU General Public License for more details.
  15
  16     You should have received a copy of the GNU General Public License
  17     along with this program; if not, write to the Free Software
  18     Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  19
  20     http://www.triptico.com
  21
  22 */
  23
  24 /* HARD LIMITS */
  25
  26 #ifndef SS_MAX_CHANNELS
  27 #define SS_MAX_CHANNELS 16
  28 #endif
  29
  30 #ifndef SS_MAX_GENERATORS
  31 #define SS_MAX_GENERATORS 256
  32 #endif
  33
  34 #ifndef SS_MAX_INSTRUMENTS
  35 #define SS_MAX_INSTRUMENTS 256
  36 #endif
  37
  38 /* STRUCTURES */
  39
  40 /* waves */
  41
  42 struct ss_wave
  43 {
  44         double size;            /* size in frames */
  45         int n_channels;         /* # of channels */
  46         float ** wave;          /* the PCM waves */
  47         int s_rate;             /* original sample rate */
  48
  49         double loop_start;      /* start of loop (-1, no loop) */
  50         double loop_end;        /* end of loop */
  51
  52         double base_freq;       /* base frequency */
  53         double min_freq;        /* minimum frequency */
  54         double max_freq;        /* maximum frequency */
  55 };
  56
  57 /* generators */
  58
  59 struct ss_gen
  60 {
  61         int note_id;            /* note ID */
  62         float vol;              /* volume */
  63         struct ss_wave * w;     /* the wave data */
  64
  65         double cursor;          /* offset to next sample */
  66         double inc;             /* increment (frequency) */
  67
  68         int sustain;            /* number of frames to play after release */
  69         float dvol;             /* volume decrement in sustain */
  70
  71         double vibrato;         /* vibrato oscillator */
  72         double vib_depth;       /* vibrato depth */
  73         double vib_inc;         /* increment for vibrato oscillator */
  74
  75         double portamento;      /* portamento sum to inc */
  76
  77         struct ss_gen * next;
  78         struct ss_gen * prev;
  79 };
  80
  81 /* software syntesizer instruments */
  82
  83 struct ss_ins
  84 {
  85         int n_layers;                   /* # of layers */
  86         struct ss_wave ** layers;       /* layers */
  87
  88         struct ss_gen * gens;           /* generator queue */
  89
  90         int n_channels;                 /* number of channels */
  91         float * vols;                   /* volumes (1 per channel) */
  92         struct ss_eff ** effs;          /* effect chains (1 per channel) */
  93
  94         double sustain;                 /* sustain in msecs */
  95         double vib_depth;               /* vibrato depth */
  96         double vib_freq;                /* vibrato frequency */
  97 };
  98
  99 /* digital effects */
 100
 101 struct ss_eff
 102 {
 103         float * wave;           /* wave buffer */
 104         double size;            /* size of wave */
 105         float gain;             /* effect gain */
 106         float igain;            /* gain increment */
 107
 108         double lfo;             /* lfo value */
 109         double lfo_depth;       /* lfo depth */
 110         double lfo_inc;         /* lfo increment */
 111
 112         double cursor;          /* current buffer position */
 113
 114         float (* func)(struct ss_eff *, float); /* processing function */
 115
 116         struct ss_eff * next;   /* next in chain */
 117 };
 118
 119 /* song events */
 120
 121 typedef enum
 122 {
 123         SONG_EV_TEMPO,
 124         SONG_EV_METER,
 125         SONG_EV_MEASURE,
 126
 127         SONG_EV_SS_SUSTAIN,
 128         SONG_EV_SS_VIBRATO,
 129         SONG_EV_SS_CHANNEL,
 130
 131         SONG_EV_SS_WAV,
 132         SONG_EV_SS_PAT,
 133
 134         SONG_EV_SS_EFF_DELAY,
 135         SONG_EV_SS_EFF_ECHO,
 136         SONG_EV_SS_EFF_COMB,
 137         SONG_EV_SS_EFF_ALLPASS,
 138         SONG_EV_SS_EFF_FLANGER,
 139         SONG_EV_SS_EFF_WOBBLE,
 140         SONG_EV_SS_EFF_SQWOBBLE,
 141         SONG_EV_SS_EFF_FADER,
 142         SONG_EV_SS_EFF_REVERB,
 143         SONG_EV_SS_EFF_OFF,
 144
 145         SONG_EV_MIDI_CHANNEL,
 146         SONG_EV_MIDI_PROGRAM,
 147
 148         SONG_EV_NOTE,
 149         SONG_EV_SS_PITCH_STRETCH,
 150         SONG_EV_SS_PRINT_WAVE_TEMPO,
 151
 152         SONG_EV_NOTE_ON,
 153         SONG_EV_NOTE_OFF,
 154
 155         SONG_EV_END
 156
 157 } song_ev_type;
 158
 159 struct song_ev_generic
 160 {
 161         song_ev_type type;      /* event type */
 162         double time;            /* event time (1: whole note) */
 163         int trk_id;             /* track id */
 164 };
 165
 166 struct song_ev_note
 167 {
 168         song_ev_type type;      /* SONG_EV_NOTE */
 169         double time;
 170         int trk_id;
 171         int note;               /* MIDI-like note */
 172         double len;             /* note length (1: whole note) */
 173         float vol;              /* note volume (1: full volume) */
 174 };
 175
 176 struct song_ev_tempo
 177 {
 178         song_ev_type type;      /* SONG_EV_TEMPO */
 179         double time;
 180         int trk_id;             /* always < 0 */
 181         double tempo;           /* tempo in bpm */
 182 };
 183
 184 struct song_ev_meter
 185 {
 186         song_ev_type type;      /* SONG_EV_METER */
 187         double time;
 188         int trk_id;             /* always < 0 */
 189         int num;                /* meter numerator */
 190         int den;                /* meter denominator */
 191 };
 192
 193 struct song_ev_measure
 194 {
 195         song_ev_type type;      /* SONG_EV_MEASURE */
 196         double time;
 197         int trk_id;
 198         int line;               /* line number */
 199 };
 200
 201 struct song_ev_ss_pitch_stretch
 202 {
 203         song_ev_type type;      /* SONG_EV_SS_PITCH_STRETCH */
 204         double time;
 205         int trk_id;
 206         int note;               /* MIDI-like note (to find the wave) */
 207         double len;             /* note length (1: whole note) */
 208         float vol;              /* note volume (1: full volume) */
 209 };
 210
 211 struct song_ev_ss_print_wave_tempo
 212 {
 213         song_ev_type type;      /* SONG_EV_SS_PRINT_WAVE_TEMPO */
 214         double time;
 215         int trk_id;
 216         int note;               /* MIDI-like note (to find the wave) */
 217         double len;             /* note length (1: whole note) */
 218 };
 219
 220 struct song_ev_ss_sustain
 221 {
 222         song_ev_type type;      /* SONG_EV_SS_SUSTAIN */
 223         double time;
 224         int trk_id;
 225         double sustain;         /* sustain time (in msecs) */
 226 };
 227
 228 struct song_ev_ss_vibrato
 229 {
 230         song_ev_type type;      /* SONG_EV_SS_VIBRATO */
 231         double time;
 232         int trk_id;
 233         double vib_depth;       /* vibrato depth (in msecs) */
 234         double vib_freq;        /* vibrato frequency (in Hzs) */
 235 };
 236
 237 struct song_ev_ss_channel
 238 {
 239         song_ev_type type;      /* SONG_EV_SS_CHANNEL */
 240         double time;
 241         int trk_id;
 242         int channel;            /* channel */
 243         float vol;              /* volume */
 244 };
 245
 246 struct song_ev_ss_wav
 247 {
 248         song_ev_type type;      /* SONG_EV_SS_WAV */
 249         double time;
 250         int trk_id;
 251         char * file;            /* path to .wav file */
 252         int base;               /* MIDI-like base note */
 253         int min;                /* MIDI-like minimum note */
 254         int max;                /* MIDI-like maximum note */
 255         double loop_start;      /* start of loop */
 256         double loop_end;        /* end of loop */
 257 };
 258
 259 struct song_ev_ss_pat
 260 {
 261         song_ev_type type;      /* SONG_EV_SS_PAT */
 262         double time;
 263         int trk_id;
 264         char * file;            /* path to .pat file */
 265 };
 266
 267 struct song_ev_ss_eff
 268 {
 269         song_ev_type type;      /* effect type */
 270         double time;
 271         int trk_id;
 272         int channel;            /* channel */
 273         double size;            /* size of effect */
 274         float gain;             /* gain */
 275         double depth;           /* depth */
 276         double freq;            /* freq */
 277         double phase;           /* phase */
 278         float initial;          /* initial vol */
 279         float final;            /* final vol */
 280 };
 281
 282 struct song_ev_midi_channel
 283 {
 284         song_ev_type type;      /* SONG_EV_MIDI_CHANNEL */
 285         double time;
 286         int trk_id;
 287         int channel;            /* midi channel (1-16) */
 288 };
 289
 290 struct song_ev_midi_program
 291 {
 292         song_ev_type type;      /* SONG_EV_MIDI_PROGRAM */
 293         double time;
 294         int trk_id;
 295         int program;            /* midi program (0-127) */
 296 };
 297
 298 union song_ev
 299 {
 300         struct song_ev_generic generic;
 301
 302         struct song_ev_tempo tempo;
 303         struct song_ev_meter meter;
 304         struct song_ev_measure measure;
 305
 306         struct song_ev_note note;
 307
 308         struct song_ev_ss_pitch_stretch ss_pitch_stretch;
 309         struct song_ev_ss_print_wave_tempo ss_print_wave_tempo;
 310
 311         struct song_ev_ss_sustain ss_sustain;
 312         struct song_ev_ss_vibrato ss_vibrato;
 313         struct song_ev_ss_channel ss_channel;
 314
 315         struct song_ev_ss_wav ss_wav;
 316         struct song_ev_ss_pat ss_pat;
 317
 318         struct song_ev_ss_eff ss_eff;
 319
 320         struct song_ev_midi_channel midi_channel;
 321         struct song_ev_midi_program midi_program;
 322 };
 323
 324
 325 /* GLOBALS */
 326
 327 /* in ss_core.c */
 328
 329 extern int ss_frequency;
 330 extern int ss_interpolation;
 331 extern int ss_nchannels;
 332 extern int ss_debug;
 333
 334 /* in ss_output.c */
 335
 336 extern float ss_master_volume;
 337 extern int ss_output_clipped;
 338 extern float ss_optimal_volume;
 339
 340 /* in song.c */
 341
 342 extern union song_ev * song;
 343 extern int n_song_ev;
 344
 345
 346 /* MACROS */
 347
 348 /* milliseconds to frames conversion */
 349 #define MS2F(ms) ((ms / 1000.0) * ss_frequency)
 350
 351
 352 /* PROTOTYPES */
 353
 354 /* in ss_core.c */
 355
 356 double ss_note_frequency(int note);
 357 struct ss_wave * ss_alloc_wave(int size, int n_channels, int s_rate);
 358 float ss_get_sample(float * wave, double size, double offset);
 359 double ss_tempo_from_wave(struct ss_wave * w, int note, double len);
 360 double ss_pitch_from_tempo(struct ss_wave * w, double tempo, double len);
 361
 362 /* in ss_gen.c */
 363
 364 struct ss_gen * ss_gen_alloc(struct ss_gen ** q);
 365 void ss_gen_free(struct ss_gen ** q, struct ss_gen * g);
 366 void ss_gen_sustain(struct ss_gen * g, double sustain);
 367 void ss_gen_vibrato(struct ss_gen * g, double depth, double freq);
 368 void ss_gen_play(struct ss_gen * g, double freq, float vol, int note_id,
 369         struct ss_wave * w);
 370 void ss_gen_release(struct ss_gen * g);
 371 int ss_gen_frame(struct ss_gen * g, int n_channels, float frame[]);
 372
 373 /* in ss_ins.c */
 374
 375 void ss_ins_init(struct ss_ins * i);
 376 void ss_ins_add_layer(struct ss_ins * i, struct ss_wave * w);
 377 void ss_ins_copy_layers(struct ss_ins * i, struct ss_ins * o);
 378 struct ss_wave * ss_ins_find_layer(struct ss_ins * i, double freq, int * off);
 379 void ss_ins_set_channel(struct ss_ins * i, int channel, float vol);
 380 void ss_ins_set_sustain(struct ss_ins * i, double sustain);
 381 void ss_ins_set_vibrato(struct ss_ins * i, double depth, double freq);
 382 int ss_ins_play(struct ss_ins * i, double freq, float vol, int note_id,
 383         struct ss_wave * w);
 384 int ss_ins_note_on(struct ss_ins * i, int note, float vol, int note_id);
 385 void ss_ins_note_off(struct ss_ins * i, int note_id);
 386 void ss_ins_frame(struct ss_ins * i, float frame[]);
 387
 388 /* in ss_output.c */
 389
 390 int ss_output_open(char * drvname, char * filename);
 391 void ss_output_init_frame(float frame[]);
 392 int ss_output_write(float frame[]);
 393 void ss_output_close(void);
 394
 395 /* in ss_input.c */
 396
 397 struct ss_wave * ss_load_wav_file(char * file,
 398         double base_freq, double min_freq, double max_freq,
 399         double loop_start, double loop_end);
 400 int ss_load_pat_file(struct ss_ins * i, char * file);
 401
 402 /* in ss_eff.c */
 403
 404 void ss_eff_delay(struct ss_eff ** ec, double size);
 405 void ss_eff_echo(struct ss_eff ** ec, double size, float gain);
 406 void ss_eff_comb(struct ss_eff ** ec, double size, float gain);
 407 void ss_eff_allpass(struct ss_eff ** ec, double size, float gain);
 408 void ss_eff_flanger(struct ss_eff ** ec, double size, float gain,
 409         double depth, double freq, double phase);
 410 void ss_eff_wobble(struct ss_eff ** ec, double freq, double phase);
 411 void ss_eff_square_wobble(struct ss_eff ** ec, double freq, double phase);
 412 void ss_eff_fader(struct ss_eff ** ec, double size, float initial, float final);
 413 void ss_eff_reverb(struct ss_eff ** ec);
 414
 415 float ss_eff_process(struct ss_eff * e, float s);
 416 void ss_eff_off(struct ss_eff ** ec);
 417
 418 /* in song.c */
 419
 420 void song_clear(void);
 421 void add_song_ev(union song_ev * ev);
 422 void song_sort(void);
 423 int song_test_measure_boundary(double ev_time, int num, int den, int line);
 424
 425 /* in ss_song.c */
 426
 427 int ss_song_render(int skip_secs);
 428
 429 /* in midi_song.c */
 430
 431 int midi_song_play(int skip_secs);
 432
 433 /* in compiler.y */
 434
 435 int compile(char * code);
 436 int compile_file(char * file);
 437
 438 /* in support.c */
 439
 440 void add_to_library_path(char * path, int strip);
 441 FILE * path_fopen(char * filename, char * mode);