Mercurial > hg > dmlib
annotate minijss/jssmod.h @ 2256:fe974f670d1d
Rename a variable.
author | Matti Hamalainen <ccr@tnsp.org> |
---|---|
date | Sat, 15 Jun 2019 22:53:25 +0300 |
parents | 5cec199f49f8 |
children | 40ccc09f09be |
rev | line source |
---|---|
0 | 1 /* |
2 * miniJSS - Module structure and handling routines | |
3 * Programmed and designed by Matti 'ccr' Hamalainen | |
1163 | 4 * (C) Copyright 2006-2015 Tecnic Software productions (TNSP) |
0 | 5 */ |
6 #ifndef JSSMOD_H | |
7 #define JSSMOD_H | |
8 | |
9 #include "jss.h" | |
10 #include "dmres.h" | |
11 | |
358 | 12 #ifdef __cplusplus |
13 extern "C" { | |
14 #endif | |
0 | 15 |
16 // Max data size definitions | |
1220 | 17 #define jsetMaxChannels (128) |
18 #define jsetMaxRows (16*1024) // Number of rows checked against | |
1248
d8324718d4b9
Add define for default number of rows in pattern.
Matti Hamalainen <ccr@tnsp.org>
parents:
1246
diff
changeset
|
19 #define jsetDefaultRows (64) // Default number of rows in pattern |
1220 | 20 #define jsetMaxPatterns (1024) // Max patterns |
1215
66c79bae8704
Bump up some maximum values for JSS module data.
Matti Hamalainen <ccr@tnsp.org>
parents:
1210
diff
changeset
|
21 #define jsetMaxInstruments (1024) |
66c79bae8704
Bump up some maximum values for JSS module data.
Matti Hamalainen <ccr@tnsp.org>
parents:
1210
diff
changeset
|
22 #define jsetMaxOrders (512) |
0 | 23 #define jsetNNotes (11 * 12) |
1220 | 24 #define jsetMinNote (0) // Smallest note number |
0 | 25 #define jsetMaxNote (jsetNNotes - 1) |
1220 | 26 #define jsetMaxEnvPoints (64) // Max number of envelope points |
0 | 27 |
28 // Instrument envelope flags | |
29 #define jenvfUsed (0x01) // Envelope is used | |
30 #define jenvfSustain (0x02) // Envelope has a sustain point (XM) or has sustain loop (IT) | |
31 #define jenvfLooped (0x04) // Envelope is looped | |
32 | |
33 // Instrument vibrato waveform types | |
34 #define jvibSine (0) | |
35 #define jvibRamp (1) | |
36 #define jvibSquare (2) | |
37 #define jvibRandom (3) | |
38 | |
39 // General stuff | |
40 #define jsetNoteOff (-2) | |
41 #define jsetOrderEnd (-1) | |
42 #define jsetOrderSkip (-2) | |
43 | |
44 | |
45 // General module flags | |
46 #define jmdfAmigaPeriods (0x0001) // Use non-linear periods (Amiga) | |
47 #define jmdfAmigaLimits (0x0002) // Use Amiga-styled valuelimits | |
48 #define jmdfStereo (0x0008) // Use stereo output, if possible | |
49 | |
50 #define jmdfFT2Replay (0x0010) // Use FT2 replaying bugs/features | |
51 #define jmdfST300Slides (0x0020) // Use Scream Tracker 3.00 slides | |
52 #define jmdfByteLStart (0x0040) // LStart is in BYTES instead of WORDS (MOD only) | |
53 | |
54 | |
55 // Module format types | |
56 enum JMDT | |
57 { | |
58 jmdtMOD = 1, | |
59 jmdtS3M, | |
60 jmdtXM, | |
61 jmdtIT | |
62 }; | |
63 | |
64 | |
65 // Bits for sample conversion routines | |
66 #define jsampDelta (0x01) | |
67 #define jsampFlipSign (0x02) | |
68 #define jsampSwapEndianess (0x04) | |
69 #define jsampSplit (0x08) | |
70 | |
1236 | 71 #define jsampHasData (0x80) // Special flag |
72 | |
0 | 73 |
74 // Internal instrument structure | |
75 typedef struct | |
76 { | |
49
033c660c25f5
Restructure module playing, removing 8bit sample mixing (output can still be
Matti Hamalainen <ccr@tnsp.org>
parents:
44
diff
changeset
|
77 int size, // Length in units |
0 | 78 loopS, // Loop start position in units |
79 loopE; // Loop end position in units | |
80 int volume, // Volume [jsetMinVol...jsetMaxVol] | |
81 flags, // Flags - see jss.h jsfXXXX | |
82 C4BaseSpeed, // C4BaseSpeed | |
83 ERelNote, // Extended: Relative note value | |
84 EFineTune, // Extended: Fine-tune value | |
85 EPanning; // Extended: Panning | |
86 #ifndef JSS_LIGHT | |
87 char *desc; | |
88 #endif | |
89 void *data; // Sample data | |
90 | |
91 int convFlags; | |
92 } JSSInstrument; | |
93 | |
94 | |
95 // Envelope point structure | |
96 typedef struct | |
97 { | |
98 int frame, value; | |
99 } JSSEnvelopePoint; | |
100 | |
101 | |
102 // Envelope structure | |
103 typedef struct | |
104 { | |
105 int flags, | |
106 npoints, | |
107 sustain, | |
108 loopS, | |
109 loopE; | |
110 JSSEnvelopePoint points[jsetMaxEnvPoints]; | |
111 } JSSEnvelope; | |
112 | |
113 | |
114 // Extended instrument | |
115 typedef struct | |
116 { | |
117 #ifndef JSS_LIGHT | |
118 char *desc; | |
119 #endif | |
1178
f1bbac567942
Oops, forgot to commit this change to add the conversion table to
Matti Hamalainen <ccr@tnsp.org>
parents:
1163
diff
changeset
|
120 int nsamples, |
f1bbac567942
Oops, forgot to commit this change to add the conversion table to
Matti Hamalainen <ccr@tnsp.org>
parents:
1163
diff
changeset
|
121 sNumForNotes[jsetNNotes], |
1402
b47109fce375
Make JSSExtInstrument.instConvSamples dynamically allocated and add check
Matti Hamalainen <ccr@tnsp.org>
parents:
1349
diff
changeset
|
122 *instConvTable; |
b47109fce375
Make JSSExtInstrument.instConvSamples dynamically allocated and add check
Matti Hamalainen <ccr@tnsp.org>
parents:
1349
diff
changeset
|
123 |
0 | 124 JSSEnvelope volumeEnv, panningEnv; |
125 int vibratoType, | |
126 vibratoSweep, | |
127 vibratoDepth, | |
128 vibratoRate, | |
129 fadeOut; | |
130 } JSSExtInstrument; | |
131 | |
132 | |
133 // Internal pattern structures | |
134 typedef struct | |
135 { | |
136 int note, | |
137 instrument, | |
138 volume, | |
139 effect, | |
140 param; | |
141 } JSSNote; | |
142 | |
143 | |
144 typedef struct | |
145 { | |
146 int nrows, nchannels; | |
147 JSSNote *data; | |
148 } JSSPattern; | |
149 | |
150 | |
151 // Module structure | |
152 typedef struct | |
153 { | |
154 int moduleType; // Type of the module | |
155 char *moduleName; // Title/name | |
156 char *trackerName; // Tracker software name | |
157 int defSpeed, // Initial values | |
158 defTempo, | |
159 defFlags, | |
160 defRestartPos, | |
161 intVersion, // Format's internal version | |
162 nchannels, | |
163 ninstruments, | |
164 nextInstruments, | |
165 npatterns, | |
166 norders; | |
167 | |
168 int defPanning[jsetNChannels]; | |
169 int orderList[jsetMaxOrders]; | |
170 JSSPattern *patterns[jsetMaxPatterns + 1]; | |
171 JSSInstrument *instruments[jsetMaxInstruments]; | |
172 JSSExtInstrument *extInstruments[jsetMaxInstruments]; | |
173 | |
174 #ifdef JSS_SUP_THREADS | |
175 DMMutex *mutex; | |
176 #endif | |
177 | |
178 } JSSModule; | |
179 | |
180 | |
181 #ifdef JSS_SUP_JSSMOD | |
182 | |
1230 | 183 #define JSSMOD_VERSION (0x20) |
0 | 184 |
185 enum | |
186 { | |
187 PATMODE_RAW_HORIZ = 1, | |
188 PATMODE_COMP_HORIZ, | |
189 PATMODE_RAW_VERT, | |
190 PATMODE_COMP_VERT, | |
191 PATMODE_RAW_ELEM, | |
1127
e22d4ceb6414
Cosmetics pass, remove excess and trailing whitespace.
Matti Hamalainen <ccr@tnsp.org>
parents:
948
diff
changeset
|
192 PATMODE_LAST |
0 | 193 }; |
194 | |
195 /* JSSMOD typedefs | |
196 */ | |
2002
5cec199f49f8
Remove useless __packed__ attributes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1972
diff
changeset
|
197 typedef struct |
0 | 198 { |
1221
e0aa979e7188
Change sizes of some JSSMOD structure members.
Matti Hamalainen <ccr@tnsp.org>
parents:
1220
diff
changeset
|
199 char idMagic[2]; // "JM" |
e0aa979e7188
Change sizes of some JSSMOD structure members.
Matti Hamalainen <ccr@tnsp.org>
parents:
1220
diff
changeset
|
200 Uint8 idVersion; // 0x10 for 1.0, etc. |
e0aa979e7188
Change sizes of some JSSMOD structure members.
Matti Hamalainen <ccr@tnsp.org>
parents:
1220
diff
changeset
|
201 Uint16 |
e0aa979e7188
Change sizes of some JSSMOD structure members.
Matti Hamalainen <ccr@tnsp.org>
parents:
1220
diff
changeset
|
202 defFlags, // Flags field: see jmdf* flags |
e0aa979e7188
Change sizes of some JSSMOD structure members.
Matti Hamalainen <ccr@tnsp.org>
parents:
1220
diff
changeset
|
203 intVersion, // Internal version, format dependant |
0 | 204 norders, // Number of orders in orderlist |
205 npatterns, // Number of patterns | |
206 nextInstruments, // Number of extended instruments | |
207 ninstruments, // Number of sample-instruments | |
1221
e0aa979e7188
Change sizes of some JSSMOD structure members.
Matti Hamalainen <ccr@tnsp.org>
parents:
1220
diff
changeset
|
208 defRestartPos; // Default restart position in orderlist |
e0aa979e7188
Change sizes of some JSSMOD structure members.
Matti Hamalainen <ccr@tnsp.org>
parents:
1220
diff
changeset
|
209 |
e0aa979e7188
Change sizes of some JSSMOD structure members.
Matti Hamalainen <ccr@tnsp.org>
parents:
1220
diff
changeset
|
210 Uint8 |
e0aa979e7188
Change sizes of some JSSMOD structure members.
Matti Hamalainen <ccr@tnsp.org>
parents:
1220
diff
changeset
|
211 nchannels, // Number of channels |
0 | 212 defSpeed, // Default speed (ticks/row) |
213 defTempo, // Default tempo (BPM) | |
214 patMode; // Pattern data format mode | |
215 | |
216 /* | |
217 - After this, norders long orders table will follow, of type: | |
1253
a4816eb68558
Change one JSSMOD struct type Sint16 -> Uint16.
Matti Hamalainen <ccr@tnsp.org>
parents:
1248
diff
changeset
|
218 Uint16 orderList[norders]; |
1127
e22d4ceb6414
Cosmetics pass, remove excess and trailing whitespace.
Matti Hamalainen <ccr@tnsp.org>
parents:
948
diff
changeset
|
219 |
0 | 220 - Pattern data, format depends on patMode. |
1127
e22d4ceb6414
Cosmetics pass, remove excess and trailing whitespace.
Matti Hamalainen <ccr@tnsp.org>
parents:
948
diff
changeset
|
221 |
0 | 222 - Extended instruments (*) |
1127
e22d4ceb6414
Cosmetics pass, remove excess and trailing whitespace.
Matti Hamalainen <ccr@tnsp.org>
parents:
948
diff
changeset
|
223 |
0 | 224 - Sample instrument headers (*) |
1127
e22d4ceb6414
Cosmetics pass, remove excess and trailing whitespace.
Matti Hamalainen <ccr@tnsp.org>
parents:
948
diff
changeset
|
225 |
0 | 226 - Sample data (format depends) (*) |
1127
e22d4ceb6414
Cosmetics pass, remove excess and trailing whitespace.
Matti Hamalainen <ccr@tnsp.org>
parents:
948
diff
changeset
|
227 |
e22d4ceb6414
Cosmetics pass, remove excess and trailing whitespace.
Matti Hamalainen <ccr@tnsp.org>
parents:
948
diff
changeset
|
228 (*) Items are optional and may have been omitted. Fields in the |
0 | 229 module and other headers are used to indicate if these items exist. |
230 */ | |
231 } JSSMODHeader; | |
232 | |
233 | |
2002
5cec199f49f8
Remove useless __packed__ attributes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1972
diff
changeset
|
234 typedef struct |
0 | 235 { |
236 Uint16 frame, value; | |
237 } JSSMODEnvelopePoint; | |
238 | |
239 | |
2002
5cec199f49f8
Remove useless __packed__ attributes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1972
diff
changeset
|
240 typedef struct |
0 | 241 { |
1246
7bd50496c9ec
Work on improved module conversion.
Matti Hamalainen <ccr@tnsp.org>
parents:
1240
diff
changeset
|
242 Uint8 |
865
fc5bd0ccc260
Use struct packing and specific types for JSSMOD data.
Matti Hamalainen <ccr@tnsp.org>
parents:
796
diff
changeset
|
243 flags, |
0 | 244 npoints, |
245 sustain, | |
246 loopS, | |
247 loopE; | |
248 JSSMODEnvelopePoint points[jsetMaxEnvPoints]; | |
249 } JSSMODEnvelope; | |
250 | |
251 | |
2002
5cec199f49f8
Remove useless __packed__ attributes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1972
diff
changeset
|
252 typedef struct |
0 | 253 { |
1229
dff0dfddaf0a
Change some JSSMOD struct member types.
Matti Hamalainen <ccr@tnsp.org>
parents:
1224
diff
changeset
|
254 Uint8 nsamples, |
dff0dfddaf0a
Change some JSSMOD struct member types.
Matti Hamalainen <ccr@tnsp.org>
parents:
1224
diff
changeset
|
255 vibratoType; |
1221
e0aa979e7188
Change sizes of some JSSMOD structure members.
Matti Hamalainen <ccr@tnsp.org>
parents:
1220
diff
changeset
|
256 Uint16 vibratoSweep, |
e0aa979e7188
Change sizes of some JSSMOD structure members.
Matti Hamalainen <ccr@tnsp.org>
parents:
1220
diff
changeset
|
257 vibratoDepth, |
e0aa979e7188
Change sizes of some JSSMOD structure members.
Matti Hamalainen <ccr@tnsp.org>
parents:
1220
diff
changeset
|
258 vibratoRate, |
e0aa979e7188
Change sizes of some JSSMOD structure members.
Matti Hamalainen <ccr@tnsp.org>
parents:
1220
diff
changeset
|
259 fadeOut; |
1229
dff0dfddaf0a
Change some JSSMOD struct member types.
Matti Hamalainen <ccr@tnsp.org>
parents:
1224
diff
changeset
|
260 Uint32 sNumForNotes[jsetNNotes]; // 32bit because internally we use global indices |
0 | 261 JSSMODEnvelope volumeEnv, panningEnv; |
262 } JSSMODExtInstrument; | |
263 | |
264 | |
2002
5cec199f49f8
Remove useless __packed__ attributes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1972
diff
changeset
|
265 typedef struct |
0 | 266 { |
1236 | 267 Uint32 size, // Length in units |
0 | 268 loopS, // Loop start position in units |
269 loopE; // Loop end position in units | |
1236 | 270 Uint16 flags, // Flags - see jss.h jsfXXXX |
1349
5adf67d1dea4
Fix loading of instrument relative note, finetune and panning values, which should be signed.
Matti Hamalainen <ccr@tnsp.org>
parents:
1253
diff
changeset
|
271 C4BaseSpeed; // C4BaseSpeed |
5adf67d1dea4
Fix loading of instrument relative note, finetune and panning values, which should be signed.
Matti Hamalainen <ccr@tnsp.org>
parents:
1253
diff
changeset
|
272 Sint16 ERelNote, // Extended: Relative note value |
0 | 273 EFineTune, // Extended: Fine-tune value |
274 EPanning; // Extended: Panning | |
1236 | 275 Uint8 volume, // Volume [jsetMinVol...jsetMaxVol] |
276 convFlags; // Conversion flags .. jsampXXXX | |
277 // jsampHasData set if there is sample data | |
0 | 278 } JSSMODInstrument; |
279 | |
280 | |
1210
6b48bad13399
Rename pattern note packing flag COMP_* constants to JM_COMP_*.
Matti Hamalainen <ccr@tnsp.org>
parents:
1209
diff
changeset
|
281 #define JM_COMP_NOTE (0x01) |
6b48bad13399
Rename pattern note packing flag COMP_* constants to JM_COMP_*.
Matti Hamalainen <ccr@tnsp.org>
parents:
1209
diff
changeset
|
282 #define JM_COMP_INSTRUMENT (0x02) |
6b48bad13399
Rename pattern note packing flag COMP_* constants to JM_COMP_*.
Matti Hamalainen <ccr@tnsp.org>
parents:
1209
diff
changeset
|
283 #define JM_COMP_VOLUME (0x04) |
6b48bad13399
Rename pattern note packing flag COMP_* constants to JM_COMP_*.
Matti Hamalainen <ccr@tnsp.org>
parents:
1209
diff
changeset
|
284 #define JM_COMP_EFFECT (0x08) |
6b48bad13399
Rename pattern note packing flag COMP_* constants to JM_COMP_*.
Matti Hamalainen <ccr@tnsp.org>
parents:
1209
diff
changeset
|
285 #define JM_COMP_PARAM (0x10) |
6b48bad13399
Rename pattern note packing flag COMP_* constants to JM_COMP_*.
Matti Hamalainen <ccr@tnsp.org>
parents:
1209
diff
changeset
|
286 #define JM_COMP_ALL (JM_COMP_NOTE | JM_COMP_INSTRUMENT | JM_COMP_VOLUME | JM_COMP_EFFECT | JM_COMP_PARAM) |
0 | 287 |
288 | |
2002
5cec199f49f8
Remove useless __packed__ attributes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1972
diff
changeset
|
289 typedef struct |
0 | 290 { |
1221
e0aa979e7188
Change sizes of some JSSMOD structure members.
Matti Hamalainen <ccr@tnsp.org>
parents:
1220
diff
changeset
|
291 Uint32 size; |
e0aa979e7188
Change sizes of some JSSMOD structure members.
Matti Hamalainen <ccr@tnsp.org>
parents:
1220
diff
changeset
|
292 Uint16 nrows; |
0 | 293 } JSSMODPattern; |
294 | |
295 #endif | |
296 | |
1216 | 297 |
0 | 298 #ifndef JSS_LIGHT |
948 | 299 char * jssASCIItoStr(const char *src, const char endByte, const size_t len); |
1972
cedb5ca1533b
Clean up the sample conversion code a bit. Improve error handling in xm2jss.
Matti Hamalainen <ccr@tnsp.org>
parents:
1402
diff
changeset
|
300 int jssEncodeSample8(Uint8 *, const size_t, const int); |
cedb5ca1533b
Clean up the sample conversion code a bit. Improve error handling in xm2jss.
Matti Hamalainen <ccr@tnsp.org>
parents:
1402
diff
changeset
|
301 int jssEncodeSample16(Uint16 *, const size_t, const int); |
0 | 302 #endif |
1129
e466d10dae6d
Change API of jssDecodeSample{8,16}() functions to return dmlib error codes
Matti Hamalainen <ccr@tnsp.org>
parents:
1127
diff
changeset
|
303 int jssDecodeSample8(Uint8 *, const size_t, const int); |
e466d10dae6d
Change API of jssDecodeSample{8,16}() functions to return dmlib error codes
Matti Hamalainen <ccr@tnsp.org>
parents:
1127
diff
changeset
|
304 int jssDecodeSample16(Uint16 *, const size_t, const int); |
49
033c660c25f5
Restructure module playing, removing 8bit sample mixing (output can still be
Matti Hamalainen <ccr@tnsp.org>
parents:
44
diff
changeset
|
305 int jssConvertModuleForPlaying(JSSModule *module); |
1231 | 306 |
0 | 307 JSSModule * jssAllocateModule(void); |
1223
82cc143cb7d2
Add function argument names to prototypes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1221
diff
changeset
|
308 int jssFreeModule(JSSModule * module); |
1238 | 309 |
1223
82cc143cb7d2
Add function argument names to prototypes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1221
diff
changeset
|
310 JSSPattern * jssAllocatePattern(const int nrows, const int nchannels); |
1224
e667710aee8e
Add functions jssFreeInstrument(), jssFreeExtInstrument() and jssFreePattern().
Matti Hamalainen <ccr@tnsp.org>
parents:
1223
diff
changeset
|
311 void jssFreePattern(JSSPattern *pattern); |
1238 | 312 |
0 | 313 JSSInstrument * jssAllocateInstrument(void); |
1224
e667710aee8e
Add functions jssFreeInstrument(), jssFreeExtInstrument() and jssFreePattern().
Matti Hamalainen <ccr@tnsp.org>
parents:
1223
diff
changeset
|
314 void jssFreeInstrument(JSSInstrument *inst); |
1238 | 315 |
0 | 316 JSSExtInstrument * jssAllocateExtInstrument(void); |
1224
e667710aee8e
Add functions jssFreeInstrument(), jssFreeExtInstrument() and jssFreePattern().
Matti Hamalainen <ccr@tnsp.org>
parents:
1223
diff
changeset
|
317 void jssFreeExtInstrument(JSSExtInstrument *inst); |
0 | 318 |
319 #ifdef JSS_SUP_XM | |
1223
82cc143cb7d2
Add function argument names to prototypes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1221
diff
changeset
|
320 int jssLoadXM(DMResource *file, JSSModule **pmodule, BOOL probe); |
0 | 321 #endif |
322 | |
323 #ifdef JSS_SUP_JSSMOD | |
1223
82cc143cb7d2
Add function argument names to prototypes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1221
diff
changeset
|
324 int jssLoadJSSMOD(DMResource *file, JSSModule **pmodule, BOOL probe); |
0 | 325 #endif |
326 | |
1223
82cc143cb7d2
Add function argument names to prototypes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1221
diff
changeset
|
327 |
358 | 328 #ifdef __cplusplus |
329 } | |
330 #endif | |
331 | |
0 | 332 #endif // JSSMOD_H |