dmlib: tools/xm2jss.c comparison

comparison tools/xm2jss.c @ 2285:25398f2eba64

Merge.

author	Matti Hamalainen <ccr@tnsp.org>
date	Tue, 18 Jun 2019 14:23:02 +0300
parents	6c3c3355007d
children	dcf1016f3d27

comparison

equal deleted inserted replaced

-:519c8726b235
+:25398f2eba64
 /*
 * xm2jss - Convert XM module to JSSMOD
 * Programmed and designed by Matti 'ccr' Hamalainen
-* (C) Copyright 2006-2017 Tecnic Software productions (TNSP)
+* (C) Copyright 2006-2019 Tecnic Software productions (TNSP)
 *
 * Please read file 'COPYING' for information on license and distribution.
 */
 #include "dmtool.h"
 #include <stdio.h>
 return TRUE;
 }
+static inline const JSSNote * jssGetNotePtr(const JSSPattern *pattern, const int channel, const int row)
+{
+if (!pattern->used[channel])
+return NULL;
+else
+return pattern->data + (pattern->nchannels * row) + channel;
+}
 /* These functions and the macro mess are meant to make the
 * conversion routines themselves clearer and simpler.
 */
 BOOL jsPutByte(Uint8 *patBuf, size_t patBufSize, size_t *npatBuf, Uint8 val)
 {
 } while (0)
 /* Convert a note
 */
-static int jssConvertNote(
+static int jssDoConvertNote(
 Uint8 *patBuf, const size_t patBufSize,
 size_t *patSize, const JSSNote *pnote)
 {
 Uint8 tmp;
 if (pnote->note == jsetNotSet)
 }
 /* Compress a note
 */
-static int jssCompressNote(
+static int jssDoCompressNote(
 Uint8 *patBuf, const size_t patBufSize,
 size_t *patSize, const JSSNote *pnote)
 {
 Uint8 qflags = 0;
 int qcomp = 0;
 JSCOMPPUT(JM_COMP_INSTRUMENT, pnote->instrument, "Instrument");
 JSCOMPPUT(JM_COMP_VOLUME, pnote->volume, "Volume");
 JSCOMPPUT(JM_COMP_EFFECT, pnote->effect, "Effect");
 JSCOMPPUT(JM_COMP_PARAM, pnote->param, "Param");
+return DMERR_OK;
 }
 else
 {
 // Was 4 bytes or more, just dump it all in ..
-return jssConvertNote(patBuf, patBufSize, patSize, pnote);
+return jssDoConvertNote(patBuf, patBufSize, patSize, pnote);
 }
+}
+static int jssCompressNote(
+Uint8 *patBuf, const size_t patBufSize,
+size_t *patSize, const JSSPattern *pattern,
+const int channel, const int row)
+{
+const JSSNote *pnote = jssGetNotePtr(pattern, channel, row);
+if (pnote != NULL)
+{
+int res = jssDoCompressNote(patBuf, patBufSize, patSize, pnote);
+if (res != DMERR_OK)
+{
+JSSERROR(res, res, "Note compression failed [patBuf=%p, patBufSize=%d, patSize=%d, row=%d, chn=%d]\n",
+patBuf, patBufSize, *patSize, row, channel);
+return res;
+}
+}
 return DMERR_OK;
 }
 /* Compress pattern
 *patSize = 0;
 for (int row = 0; row < pattern->nrows; row++)
 for (int channel = 0; channel < pattern->nchannels; channel++)
 {
-const JSSNote *pnote = &pattern->data[(pattern->nchannels * row) + channel];
+int res = jssCompressNote(patBuf, patBufSize, patSize, pattern, channel, row);
-const int res = jssCompressNote(patBuf, patBufSize, patSize, pnote);
 if (res != DMERR_OK)
-{
-JSSERROR(res, res, "Note compression failed [patBuf=%p, patBufSize=%d, patSize=%d, row=%d, chn=%d]\n",
-patBuf, patBufSize, *patSize, row, channel);
 return res;
-}
 }
 return DMERR_OK;
 }
 *patSize = 0;
 for (int channel = 0; channel < pattern->nchannels; channel++)
 for (int row = 0; row < pattern->nrows; row++)
 {
-const JSSNote *pnote = &pattern->data[(pattern->nchannels * row) + channel];
+int res = jssCompressNote(patBuf, patBufSize, patSize, pattern, channel, row);
-const int res = jssCompressNote(patBuf, patBufSize, patSize, pnote);
 if (res != DMERR_OK)
-{
+return res;
-JSSERROR(res, res, "Note compression failed [patBuf=%p, patBufSize=%d, patSize=%d, row=%d, chn=%d]\n",
+}
+return DMERR_OK;
+}
+/* Convert a pattern
+*/
+static int jssConvertNote(
+Uint8 *patBuf, const size_t patBufSize,
+size_t *patSize, const JSSPattern *pattern,
+const int channel, const int row)
+{
+const JSSNote *pnote = jssGetNotePtr(pattern, channel, row);
+if (pnote != NULL)
+{
+int res = jssDoConvertNote(patBuf, patBufSize, patSize, pnote);
+if (res != DMERR_OK)
+{
+JSSERROR(res, res, "Note conversion failed [patBuf=%p, patBufSize=%d, patSize=%d, row=%d, chn=%d]\n",
 patBuf, patBufSize, *patSize, row, channel);
 return res;
 }
 }
 return DMERR_OK;
 }
-/* Convert a pattern
-*/
 static int jssConvertPatternRawHoriz(
 Uint8 *patBuf, const size_t patBufSize,
 size_t *patSize, const JSSPattern *pattern)
 {
 *patSize = 0;
 for (int row = 0; row < pattern->nrows; row++)
 for (int channel = 0; channel < pattern->nchannels; channel++)
 {
-const JSSNote *pnote = &pattern->data[(pattern->nchannels * row) + channel];
+int res = jssConvertNote(patBuf, patBufSize, patSize, pattern, channel, row);
-const int res = jssConvertNote(patBuf, patBufSize, patSize, pnote);
 if (res != DMERR_OK)
-{
-JSSERROR(res, res, "Note conversion failed [patBuf=%p, patBufSize=%d, patSize=%d, row=%d, chn=%d]\n",
-patBuf, patBufSize, *patSize, row, channel);
 return res;
-}
 }
 return DMERR_OK;
 }
 *patSize = 0;
 for (int channel = 0; channel < pattern->nchannels; channel++)
 for (int row = 0; row < pattern->nrows; row++)
 {
-const JSSNote *pnote = &pattern->data[(pattern->nchannels * row) + channel];
+int res = jssConvertNote(patBuf, patBufSize, patSize, pattern, channel, row);
-const int res = jssConvertNote(patBuf, patBufSize, patSize, pnote);
 if (res != DMERR_OK)
-{
-JSSERROR(res, res, "Note conversion failed [patBuf=%p, patBufSize=%d, patSize=%d, row=%d, chn=%d]\n",
-patBuf, patBufSize, *patSize, row, channel);
 return res;
-}
 }
 return DMERR_OK;
 }
 #define JSFOREACHNOTE1                                                              \
 for (channel = 0; channel < pattern->nchannels; channel++)                        \
 for (row = 0; row < pattern->nrows; row++) {                                      \
-const JSSNote *pnote = &pattern->data[(pattern->nchannels * row) + channel];
+const JSSNote *pnote = jssGetNotePtr(pattern, channel, row); \
+if (pnote != NULL) {
-#define JSFOREACHNOTE2 }
+#define JSFOREACHNOTE2 } }
 static int jssConvertPatternRawElem(
 Uint8 *patBuf, const size_t patBufSize,
 size_t *patSize, const JSSPattern *pattern)
 {
 "Error allocating memory for pattern compression buffer.\n");
 }
 // Convert and write patterns
 for (totalSize = index = 0; index < module->npatterns; index++)
-if (module->patterns[index] != NULL)
 {
 JSSPattern *pattern = module->patterns[index];
 size_t dataSize = 0;
 int ret;
+if (pattern == NULL)
+{
+dmMsg(1,
+"Pattern #%d is NULL.\n", index);
+pattern = module->patterns[module->npatterns];
+}
 if (pattern->nrows > jsetMaxRows)
 {
 JSSERROR(DMERR_INVALID_DATA, DMERR_INVALID_DATA,
 "Pattern #%d has %d rows > %d max.\n",
 dmMsg(3, " - Pattern %d size %d bytes\n", index, dataSize);
 totalSize += dataSize + sizeof(JSSMODPattern);
 if (!dm_fwrite_le32(outFile, dataSize) ||
 !dm_fwrite_le16(outFile, pattern->nrows) ||
-!dm_fwrite_str(outFile, patBuf, dataSize))
+!dm_fwrite_le16(outFile, pattern->nmap))
 {
 JSSERROR(DMERR_FWRITE, DMERR_FWRITE,
-"Error writing JSSMOD pattern #%d.\n",
+"Error writing JSSMOD pattern header #%d.\n",
 index);
 }
-}
-else
+if (pattern->nmap != pattern->nchannels)
 {
-JSSERROR(DMERR_NULLPTR, DMERR_NULLPTR,
+if (!dm_fwrite_str(outFile, pattern->map,
-"Pattern #%d was NULL.\n", index);
+sizeof(pattern->map[0]) * pattern->nmap))
+{
+JSSERROR(DMERR_FWRITE, DMERR_FWRITE,
+"Error writing JSSMOD channel map for pattern #%d.\n",
+index);
+}
+}
+if (!dm_fwrite_str(outFile, patBuf, dataSize))
+{
+JSSERROR(DMERR_FWRITE, DMERR_FWRITE,
+"Error writing JSSMOD pattern data #%d.\n",
+index);
+}
 }
 dmFree(patBuf);
 dmMsg(1," * %d patterns, %d bytes.\n",
 module->npatterns, totalSize);
 if (einst == NULL)
 {
 einst = &tmpEInst;
 memset(&tmpEInst, 0, sizeof(tmpEInst));
-JSSWARNING(DMERR_NULLPTR, DMERR_NULLPTR,
+dmMsg(1,
-"Extended instrument #%d NULL!\n",
+"Extended instrument #%d is NULL!\n",
 index);
 }
 // Misc data
 BOOL ok =
 /* Scan given pattern for used instruments and channels.
 * Also checks if the pattern is empty.
 */
-void scanPattern(const JSSModule *module, const JSSPattern *pattern,
+BOOL jssScanPattern(const JSSModule *module, const JSSPattern *pattern,
-const int npattern, BOOL *usedExtInstruments, BOOL *usedChannels, BOOL *empty)
+const int npattern, BOOL *usedExtInstruments, BOOL *usedChannels)
 {
 JSSNote *n = pattern->data;
-*empty = FALSE;
+BOOL empty = TRUE;
 // Check all notes in this pattern
 for (int row = 0; row < pattern->nrows; row++)
 for (int channel = 0; channel < pattern->nchannels; channel++, n++)
 {
 // Is the instrument set?
-if (n->instrument != jsetNotSet)
+if (usedExtInstruments != NULL &&
+n->instrument != jsetNotSet)
 {
 // Is it valid?
 if (n->instrument >= 0 && n->instrument < module->nextInstruments)
 usedExtInstruments[n->instrument] = TRUE;
 else
 n->instrument != jsetNotSet ||
 n->volume != jsetNotSet ||
 n->effect != jsetNotSet ||
 n->param != jsetNotSet)
 {
-usedChannels[channel] = TRUE;
+if (usedChannels != NULL)
-*empty = FALSE;
+usedChannels[channel] = TRUE;
-}
-}
+empty = FALSE;
+}
+}
+return empty;
 }
 /* Check if two given patterns are dupes
 */
-BOOL comparePattern(const JSSPattern *pat1, const JSSPattern *pat2)
+BOOL jssComparePattern(const JSSPattern *pat1, const JSSPattern *pat2)
 {
 return
 pat1->nrows     == pat2->nrows &&
 pat1->nchannels == pat2->nchannels &&
 memcmp(pat1->data, pat2->data, sizeof(JSSNote) * pat1->nrows * pat1->nchannels) == 0;
 }
 /* Optimize a given module
 */
-JSSModule *optimizeModule(JSSModule *m)
+JSSModule *jssOptimizeModule(JSSModule *m)
 {
 BOOL usedPatterns[jsetMaxPatterns + 1],
 usedInstruments[jsetMaxInstruments + 1],
-usedExtInstruments[jsetMaxInstruments + 1],
+usedExtInstruments[jsetMaxInstruments + 1];
-usedChannels[jsetMaxChannels];
 int  mapExtInstruments[jsetMaxInstruments + 1],
 mapInstruments[jsetMaxInstruments + 1],
 mapPatterns[jsetMaxPatterns + 1],
 dupPatterns[jsetMaxPatterns + 1];
 r->norders          = m->norders;
 for (int i = 0; i < jsetNChannels; i++)
 {
 r->defPanning[i] = m->defPanning[i];
-usedChannels[i]  = FALSE;
 }
 // Initialize values
 for (int i = 0; i <= jsetMaxInstruments; i++)
 {
 if (npat >= 0 && npat < m->npatterns)
 {
 JSSPattern *pattern = m->patterns[npat];
 if (pattern != NULL)
 {
-BOOL empty;
+// Scan for used instruments etc
+BOOL empty = jssScanPattern(m, pattern, npat, usedExtInstruments, NULL);
-// Mark this pattern as used
-usedPatterns[npat] = TRUE;
-// Scan for used instruments and channels
-scanPattern(m, pattern, npat, usedExtInstruments, usedChannels, &empty);
 // Empty patterns with known number of rows are "removed"
 if (empty && pattern->nrows == jsetDefaultRows)
 {
 m->orderList[norder] = jsetNotSet;
 usedPatterns[npat] = FALSE;
 }
+else
+usedPatterns[npat] = TRUE;
 }
 else
 {
 dmErrorMsg("Pattern 0x%x is used on order 0x%x, but has no data!\n",
 npat, norder);
 // Check for duplicate patterns of "pat1" and mark them as such
 for (int pat2 = 0; pat2 < m->npatterns; pat2++)
 if (pat1 != pat2 && m->patterns[pat2] != NULL &&
 dupPatterns[pat2] == jsetNotSet &&
-comparePattern(m->patterns[pat1], m->patterns[pat2]))
+jssComparePattern(m->patterns[pat1], m->patterns[pat2]))
 {
 dmPrint(1, " * %d and %d are dupes.\n", pat1, pat2);
 dupPatterns[pat2] = pat1;
 ndupes++;
 }
 dmPrint(2, "\n");
 dmMsg(1, "%d extended instruments (%d unused).\n",
 r->nextInstruments, nunused);
 //
-// Check for actually used channels
-// XXX TODO: Actually remove the unused channels.
-//
-nunused = 0;
-for (int i = 0; i < r->nchannels; i++)
-{
-if(!usedChannels[i])
-nunused++;
-}
-dmMsg(1, "%d channels (%d unused).\n",
-r->nchannels - nunused, nunused);
-//
 // Remap pattern data with remapped instrument data
 //
 for (int i = 0; i < r->npatterns; i++)
 {
 JSSPattern *p = r->patterns[i];
 r->orderList[i] = map;
 }
 if (nunused)
 dmPrint(2, "\n");
+//
+// Do final pass on patterns to remove unused channels
+//
+for (int i = 0; i < r->npatterns; i++)
+{
+JSSPattern *p = r->patterns[i];
+jssScanPattern(r, p, i, NULL, p->used);
+p->nmap = 0;
+for (int i = 0; i < r->nchannels; i++)
+{
+if (p->used[i])
+p->map[p->nmap++] = i;
+}
+if (p->nmap != p->nchannels)
+{
+dmMsg(2, "Pattern %d: %d/%d used channels (%d unused).\n",
+i, p->nchannels - p->nmap, p->nchannels, p->nmap);
+}
+}
 return r;
 }
 int main(int argc, char *argv[])
 DMResource *inFile = NULL;
 FILE *outFile = NULL;
 JSSModule *sm, *dm;
 int result;
-dmInitProg("xm2jss", "XM to JSSMOD converter", "0.7", NULL, NULL);
+dmInitProg("xm2jss", "XM to JSSMOD converter", "0.8", NULL, NULL);
 dmVerbosity = 0;
 // Parse arguments
 if (!dmArgsProcess(argc, argv, optList, optListN,
 argHandleOpt, argHandleFile, OPTH_BAILOUT))
 // Run the optimization procedure
 if (optOptimize)
 {
 dmMsg(1, "Optimizing module data...\n");
-dm = optimizeModule(sm);
+dm = jssOptimizeModule(sm);
 } else
 dm = sm;
 // Write output file
 if ((outFile = fopen(optOutFilename, "wb")) == NULL)

Mercurial > hg > dmlib

comparison tools/xm2jss.c @ 2285:25398f2eba64