ahxm.h

   1 /*
   2
   3     Ann Hell Ex Machina - Music Software
   4     Copyright (C) 2003/2006 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 of full wave */
  49         int p_size;             /* size in frames of the page */
  50         int n_channels;         /* # of channels */
  51         sample_t ** wave;       /* the PCM waves */
  52         int s_rate;             /* original sample rate */
  53
  54         double loop_start;      /* start of loop (-1, no loop) */
  55         double loop_end;        /* end of loop */
  56
  57         double base_freq;       /* base frequency */
  58         double min_freq;        /* minimum frequency */
  59         double max_freq;        /* maximum frequency */
  60
  61         int first_channel;      /* first channel to spread into */
  62         int skip_channels;      /* channels to skip when spreading */
  63
  64         char * filename;        /* filename (for paged files) */
  65         long f_pos;             /* file position where the PCM files */
  66         int p_offset;           /* offset in frames of the page */
  67         int bits;               /* bits of the PCM wave (8, 16) */
  68         int sign;               /* sign of the PCM wave (1, -1) */
  69
  70         int page_faults;        /* number of times ss_load_page() was called */
  71 };
  72
  73 /* generators */
  74
  75 struct ss_gen
  76 {
  77         int note_id;            /* note ID */
  78         sample_t vol;           /* volume */
  79         struct ss_wave * w;     /* the wave data */
  80
  81         double cursor;          /* offset to next sample */
  82         double inc;             /* increment (frequency) */
  83
  84         int sustain;            /* number of frames to play after release */
  85         sample_t dvol;          /* volume decrement in sustain */
  86
  87         double vibrato;         /* vibrato oscillator */
  88         double vib_depth;       /* vibrato depth */
  89         double vib_inc;         /* increment for vibrato oscillator */
  90
  91         double portamento;      /* portamento sum to inc */
  92
  93         struct ss_gen * next;
  94         struct ss_gen * prev;
  95 };
  96
  97 /* software syntesizer instruments */
  98
  99 struct ss_ins
 100 {
 101         int n_layers;                   /* # of layers */
 102         struct ss_wave ** layers;       /* layers */
 103
 104         struct ss_gen * gens;           /* generator queue */
 105
 106         int n_channels;                 /* number of channels */
 107         sample_t * vols;                /* volumes (1 per channel) */
 108         struct ss_eff ** effs;          /* effect chains (1 per channel) */
 109
 110         double sustain;                 /* sustain in msecs */
 111         double vib_depth;               /* vibrato depth */
 112         double vib_freq;                /* vibrato frequency */
 113
 114         int disabled;                   /* if set, no processing is done */
 115
 116         double portamento;              /* portamento */
 117 };
 118
 119 /* digital effects */
 120
 121 struct ss_eff
 122 {
 123         struct ss_wave * wave;  /* wave buffer */
 124         sample_t gain;          /* effect gain */
 125         sample_t igain;         /* gain increment */
 126
 127         double lfo;             /* lfo value */
 128         double lfo_depth;       /* lfo depth */
 129         double lfo_inc;         /* lfo increment */
 130
 131         double cursor;          /* current buffer position */
 132
 133         sample_t (* func)(struct ss_eff *, sample_t);   /* processing function */
 134
 135         struct ss_eff * next;   /* next in chain */
 136 };
 137
 138 /* song events */
 139
 140 typedef enum
 141 {
 142         SONG_EV_TEMPO,
 143         SONG_EV_METER,
 144         SONG_EV_MEASURE,
 145
 146         SONG_EV_SS_SUSTAIN,
 147         SONG_EV_SS_VIBRATO,
 148         SONG_EV_SS_PORTAMENTO,
 149         SONG_EV_SS_CHANNEL,
 150
 151         SONG_EV_SS_WAV,
 152         SONG_EV_SS_PAT,
 153
 154         SONG_EV_SS_EFF_OFF,
 155         SONG_EV_SS_EFF_DELAY,
 156         SONG_EV_SS_EFF_ECHO,
 157         SONG_EV_SS_EFF_COMB,
 158         SONG_EV_SS_EFF_ALLPASS,
 159         SONG_EV_SS_EFF_FLANGER,
 160         SONG_EV_SS_EFF_WOBBLE,
 161         SONG_EV_SS_EFF_SQWOBBLE,
 162         SONG_EV_SS_EFF_HFWOBBLE,
 163         SONG_EV_SS_EFF_FADER,
 164         SONG_EV_SS_EFF_REVERB,
 165         SONG_EV_SS_EFF_FOLDBACK,
 166
 167         SONG_EV_MIDI_CHANNEL,
 168         SONG_EV_MIDI_PROGRAM,
 169
 170         SONG_EV_BACK,
 171         SONG_EV_NOTE,
 172         SONG_EV_SS_PITCH_STRETCH,
 173         SONG_EV_SS_PRINT_WAVE_TEMPO,
 174
 175         SONG_EV_SONG_INFO,
 176
 177         SONG_EV_NOTE_OFF,
 178         SONG_EV_NOTE_ON,
 179
 180         SONG_EV_EOT,
 181         SONG_EV_END
 182
 183 } song_ev_type;
 184
 185 struct song_ev_generic
 186 {
 187         song_ev_type type;      /* event type */
 188         double time;            /* event time (1: whole note) */
 189         int trk_id;             /* track id */
 190         int event_id;           /* event id */
 191 };
 192
 193 struct song_ev_note
 194 {
 195         song_ev_type type;      /* SONG_EV_NOTE */
 196         double time;
 197         int trk_id;
 198         int event_id;
 199         int note;               /* MIDI-like note */
 200         double len;             /* note length (1: whole note) */
 201         sample_t vol;           /* note volume (1: full volume) */
 202 };
 203
 204 struct song_ev_back
 205 {
 206         song_ev_type type;      /* SONG_EV_BACK */
 207         double time;
 208         int trk_id;
 209         int event_id;
 210         double len;             /* note length (1: whole note) */
 211 };
 212
 213 struct song_ev_tempo
 214 {
 215         song_ev_type type;      /* SONG_EV_TEMPO */
 216         double time;
 217         int trk_id;             /* always < 0 */
 218         int event_id;
 219         double tempo;           /* tempo in bpm */
 220 };
 221
 222 struct song_ev_meter
 223 {
 224         song_ev_type type;      /* SONG_EV_METER */
 225         double time;
 226         int trk_id;             /* always < 0 */
 227         int event_id;
 228         int num;                /* meter numerator */
 229         int den;                /* meter denominator */
 230 };
 231
 232 struct song_ev_measure
 233 {
 234         song_ev_type type;      /* SONG_EV_MEASURE */
 235         double time;
 236         int trk_id;
 237         int event_id;
 238         int line;               /* line number */
 239 };
 240
 241 struct song_ev_ss_pitch_stretch
 242 {
 243         song_ev_type type;      /* SONG_EV_SS_PITCH_STRETCH */
 244         double time;
 245         int trk_id;
 246         int event_id;
 247         int note;               /* MIDI-like note (to find the wave) */
 248         double len;             /* note length (1: whole note) */
 249         sample_t vol;           /* note volume (1: full volume) */
 250 };
 251
 252 struct song_ev_ss_print_wave_tempo
 253 {
 254         song_ev_type type;      /* SONG_EV_SS_PRINT_WAVE_TEMPO */
 255         double time;
 256         int trk_id;
 257         int event_id;
 258         int note;               /* MIDI-like note (to find the wave) */
 259         double len;             /* note length (1: whole note) */
 260 };
 261
 262 struct song_ev_ss_sustain
 263 {
 264         song_ev_type type;      /* SONG_EV_SS_SUSTAIN */
 265         double time;
 266         int trk_id;
 267         int event_id;
 268         double sustain;         /* sustain time (in msecs) */
 269 };
 270
 271 struct song_ev_ss_vibrato
 272 {
 273         song_ev_type type;      /* SONG_EV_SS_VIBRATO */
 274         double time;
 275         int trk_id;
 276         int event_id;
 277         double vib_depth;       /* vibrato depth (in msecs) */
 278         double vib_freq;        /* vibrato frequency (in Hzs) */
 279 };
 280
 281 struct song_ev_ss_portamento
 282 {
 283         song_ev_type type;      /* SONG_EV_SS_PORTAMENTO */
 284         double time;
 285         int trk_id;
 286         int event_id;
 287         double portamento;      /* portamento */
 288 };
 289
 290 struct song_ev_ss_channel
 291 {
 292         song_ev_type type;      /* SONG_EV_SS_CHANNEL */
 293         double time;
 294         int trk_id;
 295         int event_id;
 296         int channel;            /* channel */
 297         sample_t vol;           /* volume */
 298 };
 299
 300 struct song_ev_ss_wav
 301 {
 302         song_ev_type type;      /* SONG_EV_SS_WAV */
 303         double time;
 304         int trk_id;
 305         int event_id;
 306         char * file;            /* path to .wav file */
 307         int base;               /* MIDI-like base note */
 308         int min;                /* MIDI-like minimum note */
 309         int max;                /* MIDI-like maximum note */
 310         double loop_start;      /* start of loop */
 311         double loop_end;        /* end of loop */
 312         int first_channel;      /* first channel to start spreading */
 313         int skip_channels;      /* channels to skip when spreading */
 314 };
 315
 316 struct song_ev_ss_pat
 317 {
 318         song_ev_type type;      /* SONG_EV_SS_PAT */
 319         double time;
 320         int trk_id;
 321         int event_id;
 322         char * file;            /* path to .pat file */
 323 };
 324
 325 struct song_ev_ss_eff
 326 {
 327         song_ev_type type;      /* effect type */
 328         double time;
 329         int trk_id;
 330         int event_id;
 331         int channel;            /* channel */
 332         double size;            /* size of effect */
 333         sample_t gain;          /* gain */
 334         double depth;           /* depth */
 335         double freq;            /* freq */
 336         double phase;           /* phase */
 337         sample_t initial;       /* initial vol */
 338         sample_t final;         /* final vol */
 339 };
 340
 341 struct song_ev_midi_channel
 342 {
 343         song_ev_type type;      /* SONG_EV_MIDI_CHANNEL */
 344         double time;
 345         int trk_id;
 346         int event_id;
 347         int channel;            /* midi channel (1-16) */
 348 };
 349
 350 struct song_ev_midi_program
 351 {
 352         song_ev_type type;      /* SONG_EV_MIDI_PROGRAM */
 353         double time;
 354         int trk_id;
 355         int event_id;
 356         int program;            /* midi program (0-127) */
 357 };
 358
 359 struct song_ev_song_info
 360 {
 361         song_ev_type type;      /* SONG_EV_SONG_INFO */
 362         double time;
 363         int trk_id;
 364         int event_id;
 365         char * author;          /* track author */
 366         char * name;            /* track name */
 367 };
 368
 369 union song_ev
 370 {
 371         struct song_ev_generic generic;
 372
 373         struct song_ev_tempo tempo;
 374         struct song_ev_meter meter;
 375         struct song_ev_measure measure;
 376
 377         struct song_ev_note note;
 378         struct song_ev_back back;
 379
 380         struct song_ev_ss_pitch_stretch ss_pitch_stretch;
 381         struct song_ev_ss_print_wave_tempo ss_print_wave_tempo;
 382
 383         struct song_ev_ss_sustain ss_sustain;
 384         struct song_ev_ss_vibrato ss_vibrato;
 385         struct song_ev_ss_portamento ss_portamento;
 386         struct song_ev_ss_channel ss_channel;
 387
 388         struct song_ev_ss_wav ss_wav;
 389         struct song_ev_ss_pat ss_pat;
 390
 391         struct song_ev_ss_eff ss_eff;
 392
 393         struct song_ev_midi_channel midi_channel;
 394         struct song_ev_midi_program midi_program;
 395
 396         struct song_ev_song_info song_info;
 397 };
 398
 399
 400 /* GLOBALS */
 401
 402 /* in ss_core.c */
 403
 404 extern int ss_frequency;
 405 extern int ss_interpolation;
 406 extern int ss_nchannels;
 407
 408 /* in ss_input.c */
 409
 410 extern int ss_page_size;
 411
 412 /* in ss_output.c */
 413
 414 extern sample_t ss_master_volume;
 415 extern int ss_output_clipped;
 416 extern sample_t ss_optimal_volume;
 417 extern char * ss_cue_file_name;
 418
 419 /* in song.c */
 420
 421 extern union song_ev * song;
 422 extern int n_song_ev;
 423 extern int solo_track;
 424
 425 /* in support.c */
 426
 427 extern int verbose;
 428 extern int trace;
 429
 430 /* MACROS */
 431
 432 /* milliseconds to frames conversion */
 433 #define MS2F(ms) ((ms / 1000.0) * ss_frequency)
 434
 435 /* grows a dynamic array */
 436 #define GROW(b,n,t) b = (t *)realloc(b,((n) + 1) * sizeof(t))
 437
 438 /* PROTOTYPES */
 439
 440 /* in ss_core.c */
 441
 442 double ss_note_frequency(int note);
 443 struct ss_wave * ss_alloc_wave(int size, int n_channels, int s_rate, int p_size);
 444 void ss_free_wave(struct ss_wave * w);
 445 void ss_prepare_wave(struct ss_wave * w);
 446 sample_t ss_get_sample(struct ss_wave * w, int channel, double offset);
 447 double ss_tempo_from_wave(struct ss_wave * w, int note, double len);
 448 double ss_pitch_from_tempo(struct ss_wave * w, double tempo, double len);
 449
 450 /* in ss_gen.c */
 451
 452 void ss_gen_init(void);
 453 struct ss_gen * ss_gen_alloc(struct ss_gen ** q);
 454 void ss_gen_free(struct ss_gen ** q, struct ss_gen * g);
 455 void ss_gen_sustain(struct ss_gen * g, double sustain);
 456 void ss_gen_vibrato(struct ss_gen * g, double depth, double freq);
 457 void ss_gen_portamento(struct ss_gen * g, double portamento);
 458 void ss_gen_play(struct ss_gen * g, double freq, sample_t vol, int note_id,
 459         struct ss_wave * w);
 460 void ss_gen_release(struct ss_gen * g);
 461 int ss_gen_frame(struct ss_gen * g, int n_channels, sample_t frame[]);
 462
 463 /* in ss_ins.c */
 464
 465 void ss_ins_init(struct ss_ins * i);
 466 void ss_ins_disable(struct ss_ins * i);
 467 void ss_ins_add_layer(struct ss_ins * i, struct ss_wave * w);
 468 struct ss_wave * ss_ins_find_layer(struct ss_ins * i, double freq, int * off);
 469 void ss_ins_set_channel(struct ss_ins * i, int channel, sample_t vol);
 470 void ss_ins_set_sustain(struct ss_ins * i, double sustain);
 471 void ss_ins_set_vibrato(struct ss_ins * i, double depth, double freq);
 472 void ss_ins_set_portamento(struct ss_ins * i, double portamento);
 473 int ss_ins_play(struct ss_ins * i, double freq, sample_t vol, int note_id,
 474         struct ss_wave * w);
 475 int ss_ins_note_on(struct ss_ins * i, int note, sample_t vol, int note_id);
 476 void ss_ins_note_off(struct ss_ins * i, int note_id);
 477 void ss_ins_frame(struct ss_ins * i, sample_t frame[]);
 478
 479 /* in ss_output.c */
 480
 481 int ss_output_open(char * drvname, char * filename);
 482 void ss_output_init_frame(sample_t frame[]);
 483 int ss_output_write(sample_t frame[]);
 484 void ss_output_close(void);
 485 int cue_file_song_info(int frame, char * author, char * name);
 486
 487 /* in ss_input.c */
 488
 489 void load_pcm_wave(FILE * f, struct ss_wave * w);
 490 struct ss_wave * ss_load_wav_file(char * file,
 491         double base_freq, double min_freq, double max_freq,
 492         double loop_start, double loop_end,
 493         int first_channel, int skip_channels);
 494 int ss_load_pat_file(struct ss_ins * i, char * file);
 495
 496 /* in ss_eff.c */
 497
 498 void ss_eff_delay(struct ss_eff ** ec, double size);
 499 void ss_eff_echo(struct ss_eff ** ec, double size, sample_t gain);
 500 void ss_eff_comb(struct ss_eff ** ec, double size, sample_t gain);
 501 void ss_eff_allpass(struct ss_eff ** ec, double size, sample_t gain);
 502 void ss_eff_flanger(struct ss_eff ** ec, double size, sample_t gain,
 503         double depth, double freq, double phase);
 504 void ss_eff_wobble(struct ss_eff ** ec, double freq, double phase, sample_t gain);
 505 void ss_eff_square_wobble(struct ss_eff ** ec, double freq, double phase);
 506 void ss_eff_half_wobble(struct ss_eff ** ec, double freq, double phase);
 507 void ss_eff_fader(struct ss_eff ** ec, double size, sample_t initial, sample_t final);
 508 void ss_eff_reverb(struct ss_eff ** ec);
 509 void ss_eff_foldback(struct ss_eff ** ec, sample_t threshold);
 510
 511 sample_t ss_eff_process(struct ss_eff * e, sample_t s);
 512 void ss_eff_off(struct ss_eff ** ec);
 513
 514 /* in song.c */
 515
 516 void song_clear(void);
 517 void add_song_ev(song_ev_type type, double time, union song_ev * ev);
 518 void song_sort(void);
 519 int song_test_measure_boundary(double ev_time, int num, int den, int line);
 520
 521 /* in ss_song.c */
 522
 523 int ss_song_render(int skip_secs, char * driver, char * devfile);
 524
 525 /* in midi_song.c */
 526
 527 int midi_song_play(int skip_secs);
 528 int midi_device_open(char * devfile);
 529 void midi_device_close(void);
 530
 531 /* in compiler.y */
 532
 533 int compile_ahs_string(char * code);
 534 int compile_ahs(char * file);
 535
 536 /* in support.c */
 537
 538 void libpath_add(char * path, int strip);
 539 FILE * libpath_fopen(char * filename, char * mode);
 540 char * libpath_locate(char * filename);
 541 void transconv_add(char * from, char * to, char * convcmd);
 542 char * transconv(char * file, char * ext, char * dir);