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