874 lines · 23.8 KB · C
RawDownload
/*  _______         ____    __         ___    ___ * \    _  \       \    /  \  /       \   \  /   /       '   '  ' *  |  | \  \       |  |    ||         |   \/   |         .      . *  |  |  |  |      |  |    ||         ||\  /|  | *  |  |  |  |      |  |    ||         || \/ |  |         '  '  ' *  |  |  |  |      |  |    ||         ||    |  |         .      . *  |  |_/  /        \  \__//          ||    |  | * /_______/ynamic    \____/niversal  /__\  /____\usic   /|  .  . ibliotheque *                                                      /  \ *                                                     / .  \ * internal/it.h - Internal stuff for IT playback     / / \  \ *                 and MOD/XM/S3M conversion.        | <  /   \_ *                                                   |  \/ /\   / * This header file provides access to the            \_  /  > / * internal structure of DUMB, and is liable            | \ / / * to change, mutate or cease to exist at any           |  ' / * moment. Include it at your own peril.                 \__/ * * ... * * Seriously. You don't need access to anything in this file. All right, you * probably do actually. But if you use it, you will be relying on a specific * version of DUMB, so please check DUMB_VERSION defined in dumb.h. Please * contact the authors so that we can provide a public API for what you need. */ #ifndef INTERNAL_IT_H#define INTERNAL_IT_H #define BIT_ARRAY_BULLSHIT #include <stddef.h> #include "barray.h"#include "tarray.h" /** TO DO: THINK ABOUT THE FOLLOWING: sigdata->flags & IT_COMPATIBLE_GXX                 Bit 5: On = Link Effect G's memory with Effect E/F. Also                            Gxx with an instrument present will cause the                            envelopes to be retriggered. If you change a                            sample on a row with Gxx, it'll adjust the                            frequency of the current note according to:                               NewFrequency = OldFrequency * NewC5 / OldC5;*/ /* These #defines are TEMPORARY. They are used to write alternative code to * handle ambiguities in the format specification. The correct code in each * case will be determined most likely by experimentation. *///#define STEREO_SAMPLES_COUNT_AS_TWO#define INVALID_ORDERS_END_SONG#define SUSTAIN_LOOP_OVERRIDES_NORMAL_LOOP#define VOLUME_OUT_OF_RANGE_SETS_MAXIMUM #define SIGTYPE_IT DUMB_ID('I', 'T', ' ', ' ') #define IT_SIGNATURE DUMB_ID('I', 'M', 'P', 'M')#define IT_INSTRUMENT_SIGNATURE DUMB_ID('I', 'M', 'P', 'I')#define IT_SAMPLE_SIGNATURE DUMB_ID('I', 'M', 'P', 'S') // olivier sux#define IT_MPTX_SIGNATURE DUMB_ID('X', 'T', 'P', 'M')#define IT_INSM_SIGNATURE DUMB_ID('M', 'S', 'N', 'I') /* This is divided by the tempo times 256 to get the interval between ticks. */#define TICK_TIME_DIVIDEND (65536 * 5 * 128) /* I'm not going to try to explain this, because I didn't derive it very * formally ;) *//* #define AMIGA_DIVISOR ((float)(4.0 * 14317056.0)) *//* I believe the following one to be more accurate. *///#define AMIGA_DIVISOR ((float)(8.0 * 7159090.5))#define AMIGA_CLOCK 3546895#define AMIGA_DIVISOR ((float)(16.0 * AMIGA_CLOCK)) typedef struct IT_MIDI IT_MIDI;typedef struct IT_FILTER_STATE IT_FILTER_STATE;typedef struct IT_ENVELOPE IT_ENVELOPE;typedef struct IT_INSTRUMENT IT_INSTRUMENT;typedef struct IT_SAMPLE IT_SAMPLE;typedef struct IT_ENTRY IT_ENTRY;typedef struct IT_PATTERN IT_PATTERN;typedef struct IT_PLAYING_ENVELOPE IT_PLAYING_ENVELOPE;typedef struct IT_PLAYING IT_PLAYING;typedef struct IT_CHANNEL IT_CHANNEL;typedef struct IT_CHECKPOINT IT_CHECKPOINT;typedef struct IT_CALLBACKS IT_CALLBACKS; struct IT_MIDI {    unsigned char SFmacro[16][16]; // read these from 0x120    unsigned char SFmacrolen[16];    unsigned short SFmacroz[16]; /* Bitfield; bit 0 set = z in first position */    unsigned char Zmacro[128][16]; // read these from 0x320    unsigned char Zmacrolen[128];}; struct IT_FILTER_STATE {    sample_t currsample, prevsample;}; #define IT_ENVELOPE_ON 1#define IT_ENVELOPE_LOOP_ON 2#define IT_ENVELOPE_SUSTAIN_LOOP 4#define IT_ENVELOPE_CARRY 8#define IT_ENVELOPE_PITCH_IS_FILTER 128 struct IT_ENVELOPE {    unsigned char flags;    unsigned char n_nodes;    unsigned char loop_start;    unsigned char loop_end;    unsigned char sus_loop_start;    unsigned char sus_loop_end;    signed char node_y[25];    unsigned short node_t[25];}; #define NNA_NOTE_CUT 0#define NNA_NOTE_CONTINUE 1#define NNA_NOTE_OFF 2#define NNA_NOTE_FADE 3 #define DCT_OFF 0#define DCT_NOTE 1#define DCT_SAMPLE 2#define DCT_INSTRUMENT 3 #define DCA_NOTE_CUT 0#define DCA_NOTE_OFF 1#define DCA_NOTE_FADE 2 struct IT_INSTRUMENT {    unsigned char name[27];    unsigned char filename[14];     int fadeout;     IT_ENVELOPE volume_envelope;    IT_ENVELOPE pan_envelope;    IT_ENVELOPE pitch_envelope;     unsigned char new_note_action;    unsigned char dup_check_type;    unsigned char dup_check_action;    signed char pp_separation;    unsigned char pp_centre;    unsigned char global_volume;    unsigned char default_pan;    unsigned char random_volume;    unsigned char random_pan;     unsigned char filter_cutoff;    unsigned char filter_resonance;     unsigned char map_note[120];    unsigned short map_sample[120];     // int output;}; #define IT_SAMPLE_EXISTS 1#define IT_SAMPLE_16BIT 2#define IT_SAMPLE_STEREO 4#define IT_SAMPLE_LOOP 16#define IT_SAMPLE_SUS_LOOP 32#define IT_SAMPLE_PINGPONG_LOOP 64#define IT_SAMPLE_PINGPONG_SUS_LOOP 128 #define IT_VIBRATO_SINE 0#define IT_VIBRATO_SAWTOOTH 1#define IT_VIBRATO_SQUARE 2#define IT_VIBRATO_RANDOM 3#define IT_VIBRATO_XM_SQUARE 4#define IT_VIBRATO_RAMP_DOWN 5#define IT_VIBRATO_RAMP_UP 6 struct IT_SAMPLE {    unsigned char name[35];    unsigned char filename[15];    unsigned char flags;    unsigned char global_volume;    unsigned char default_volume;    unsigned char default_pan;    /* default_pan:     *   0-255 for XM     *   ignored for MOD     *   otherwise, 0-64, and add 128 to enable     */     long length;    long loop_start;    long loop_end;    long C5_speed;    long sus_loop_start;    long sus_loop_end;     unsigned char vibrato_speed;    unsigned char vibrato_depth;    unsigned char vibrato_rate;    unsigned char vibrato_waveform;     signed short finetune;     void *data;     int max_resampling_quality;}; #define IT_ENTRY_NOTE 1#define IT_ENTRY_INSTRUMENT 2#define IT_ENTRY_VOLPAN 4#define IT_ENTRY_EFFECT 8 #define IT_SET_END_ROW(entry) ((entry)->channel = 255)#define IT_IS_END_ROW(entry) ((entry)->channel >= DUMB_IT_N_CHANNELS) #define IT_NOTE_OFF 255#define IT_NOTE_CUT 254 #define IT_ENVELOPE_SHIFT 8 #define IT_SURROUND 100#define IT_IS_SURROUND(pan) ((pan) > 64)#define IT_IS_SURROUND_SHIFTED(pan) ((pan) > 64 << IT_ENVELOPE_SHIFT) #define IT_SET_SPEED 1#define IT_JUMP_TO_ORDER 2#define IT_BREAK_TO_ROW 3#define IT_VOLUME_SLIDE 4#define IT_PORTAMENTO_DOWN 5#define IT_PORTAMENTO_UP 6#define IT_TONE_PORTAMENTO 7#define IT_VIBRATO 8#define IT_TREMOR 9#define IT_ARPEGGIO 10#define IT_VOLSLIDE_VIBRATO 11#define IT_VOLSLIDE_TONEPORTA 12#define IT_SET_CHANNEL_VOLUME 13#define IT_CHANNEL_VOLUME_SLIDE 14#define IT_SET_SAMPLE_OFFSET 15#define IT_PANNING_SLIDE 16#define IT_RETRIGGER_NOTE 17#define IT_TREMOLO 18#define IT_S 19#define IT_SET_SONG_TEMPO 20#define IT_FINE_VIBRATO 21#define IT_SET_GLOBAL_VOLUME 22#define IT_GLOBAL_VOLUME_SLIDE 23#define IT_SET_PANNING 24#define IT_PANBRELLO 25#define IT_MIDI_MACRO 26 // see MIDI.TXT /* Some effects needed for XM compatibility */#define IT_XM_PORTAMENTO_DOWN 27#define IT_XM_PORTAMENTO_UP 28#define IT_XM_FINE_VOLSLIDE_DOWN 29#define IT_XM_FINE_VOLSLIDE_UP 30#define IT_XM_RETRIGGER_NOTE 31#define IT_XM_KEY_OFF 32#define IT_XM_SET_ENVELOPE_POSITION 33 /* More effects needed for PTM compatibility */#define IT_PTM_NOTE_SLIDE_DOWN 34#define IT_PTM_NOTE_SLIDE_UP 35#define IT_PTM_NOTE_SLIDE_DOWN_RETRIG 36#define IT_PTM_NOTE_SLIDE_UP_RETRIG 37 /* More effects needed for OKT compatibility */#define IT_OKT_NOTE_SLIDE_DOWN 38#define IT_OKT_NOTE_SLIDE_DOWN_ROW 39#define IT_OKT_NOTE_SLIDE_UP 40#define IT_OKT_NOTE_SLIDE_UP_ROW 41#define IT_OKT_ARPEGGIO_3 42#define IT_OKT_ARPEGGIO_4 43#define IT_OKT_ARPEGGIO_5 44#define IT_OKT_VOLUME_SLIDE_DOWN 45#define IT_OKT_VOLUME_SLIDE_UP 46 #define IT_N_EFFECTS 47 /* These represent the top nibble of the command value. */#define IT_S_SET_FILTER 0            /* Greyed out in IT... */#define IT_S_SET_GLISSANDO_CONTROL 1 /* Greyed out in IT... */#define IT_S_FINETUNE 2              /* Greyed out in IT... */#define IT_S_SET_VIBRATO_WAVEFORM 3#define IT_S_SET_TREMOLO_WAVEFORM 4#define IT_S_SET_PANBRELLO_WAVEFORM 5#define IT_S_FINE_PATTERN_DELAY 6#define IT_S7 7#define IT_S_SET_PAN 8#define IT_S_SET_SURROUND_SOUND 9#define IT_S_SET_HIGH_OFFSET 10#define IT_S_PATTERN_LOOP 11#define IT_S_DELAYED_NOTE_CUT 12#define IT_S_NOTE_DELAY 13#define IT_S_PATTERN_DELAY 14#define IT_S_SET_MIDI_MACRO 15 /*S0x Set filterS1x Set glissando controlS2x Set finetune  S3x Set vibrato waveform to type xS4x Set tremelo waveform to type xS5x Set panbrello waveform to type x  Waveforms for commands S3x, S4x and S5x:    0: Sine wave    1: Ramp down    2: Square wave    3: Random waveS6x Pattern delay for x ticksS70 Past note cutS71 Past note offS72 Past note fadeS73 Set NNA to note cutS74 Set NNA to continueS75 Set NNA to note offS76 Set NNA to note fadeS77 Turn off volume envelopeS78 Turn on volume envelopeS79 Turn off panning envelopeS7A Turn on panning envelopeS7B Turn off pitch envelopeS7C Turn on pitch envelopeS8x Set panning positionS91 Set surround soundSAy Set high value of sample offset yxx00hSB0 Set loopback pointSBx Loop x times to loopback pointSCx Note cut after x ticksSDx Note delay for x ticksSEx Pattern delay for x rowsSFx Set parameterised MIDI Macro*/ struct IT_ENTRY {    unsigned char channel; /* End of row if channel >= DUMB_IT_N_CHANNELS */    unsigned char mask;    unsigned char note;    unsigned char instrument;    unsigned char volpan;    unsigned char effect;    unsigned char effectvalue;}; struct IT_PATTERN {    int n_rows;    int n_entries;    IT_ENTRY *entry;}; #define IT_STEREO 1#define IT_USE_INSTRUMENTS 4#define IT_LINEAR_SLIDES 8 /* If not set, use Amiga slides */#define IT_OLD_EFFECTS 16#define IT_COMPATIBLE_GXX 32 /* Make sure IT_WAS_AN_XM and IT_WAS_A_MOD aren't set accidentally */#define IT_REAL_FLAGS 63 #define IT_WAS_AN_XM 64 /* Set for both XMs and MODs */#define IT_WAS_A_MOD 128 #define IT_WAS_AN_S3M 256 #define IT_WAS_A_PTM 512 #define IT_WAS_A_669 1024 #define IT_WAS_AN_OKT 2048 #define IT_WAS_AN_STM 4096 #define IT_WAS_PROCESSED                                                       \    8192 /* Will be set the first time a sigdata passes through a sigrenderer  \          */ #define IT_ORDER_END 255#define IT_ORDER_SKIP 254 struct DUMB_IT_SIGDATA {    unsigned char name[65];     unsigned char *song_message;     int n_orders;    int n_instruments;    int n_samples;    int n_patterns;    int n_pchannels;     int flags;     int global_volume;    int mixing_volume;    int speed;    int tempo;    int pan_separation;     unsigned char channel_pan[DUMB_IT_N_CHANNELS];    unsigned char channel_volume[DUMB_IT_N_CHANNELS];     unsigned char *order;    unsigned char restart_position; /* for XM compatiblity */     IT_INSTRUMENT *instrument;    IT_SAMPLE *sample;    IT_PATTERN *pattern;     IT_MIDI *midi;     IT_CHECKPOINT *checkpoint;}; struct IT_PLAYING_ENVELOPE {    int next_node;    int tick;    int value;}; #define IT_PLAYING_BACKGROUND 1#define IT_PLAYING_SUSTAINOFF 2#define IT_PLAYING_FADING 4#define IT_PLAYING_DEAD 8#define IT_PLAYING_REVERSE 16 struct IT_PLAYING {    int flags;     int resampling_quality;     IT_CHANNEL *channel;    IT_SAMPLE *sample;    IT_INSTRUMENT *instrument;    IT_INSTRUMENT *env_instrument;     unsigned short sampnum;    unsigned char instnum;     unsigned char declick_stage;     float float_volume[2];    float ramp_volume[2];    float ramp_delta[2];     unsigned char channel_volume;     unsigned char volume;    unsigned short pan;     signed char volume_offset, panning_offset;     unsigned char note;     unsigned char enabled_envelopes;     unsigned char filter_cutoff;    unsigned char filter_resonance;     unsigned short        true_filter_cutoff; /* These incorporate the filter envelope, and will                               not */    unsigned char true_filter_resonance; /* be changed if they would be set to                                            127<<8 and 0.    */     unsigned char vibrato_speed;    unsigned char vibrato_depth;    unsigned char vibrato_n; /* May be specified twice: volpan & effect. */    unsigned char vibrato_time;    unsigned char vibrato_waveform;     unsigned char tremolo_speed;    unsigned char tremolo_depth;    unsigned char tremolo_time;    unsigned char tremolo_waveform;     unsigned char panbrello_speed;    unsigned char panbrello_depth;    unsigned char panbrello_time;    unsigned char panbrello_waveform;    signed char panbrello_random;     unsigned char sample_vibrato_time;    unsigned char sample_vibrato_waveform;    int sample_vibrato_depth; /* Starts at rate?0:depth, increases by rate */     int slide;    float delta;    int finetune;     IT_PLAYING_ENVELOPE volume_envelope;    IT_PLAYING_ENVELOPE pan_envelope;

Lines 1–500 of 874.

Keyboard shortcuts

General

Show keyboard shortcuts
?
Focus the current search
/

Issues and pull requests

Open filters
f

Issues, pull requests and Inbox

Select next item
j↓
Select previous item
k↑
Open selected item
Enter
Dismiss filters or clear selection
Esc

Repository code

Go to file
t