3.9.4

Author: quippy-git

README.md

@@ -1,4 +1,6 @@
-# JavaMod V3.9.3
+V3.9.4
+
+# JavaMod V3.9.4
 JavaMod - a java based multimedia player for Protracker, Fast Tracker, 
 Impulse Tracker, Scream Tracker and other mod files plus
 SID, MP3, WAV, OGG, APE, FLAC, MIDI, AdLib ROL-Files (OPL), ...
@@ -20,8 +22,8 @@ On Linux consider starting with OpenGL render pipeline activated:
 ## Remarks to 3.9.x version updates
 With JavaMod versions 4.0 to 5.0 I want to integrate Midi and AdLib support.
 However, before starting that I want to have all test mods of Schism and
-Open ModPlug Tracker to work. We finished MOD and XM with this version
-and a whole lot of other stuff as well. So I decided to release new version 
+Open ModPlug Tracker to work. We finished MOD, XM, STM and S3M with this version
+and a whole lot of other stuff as well. So I decided to release new versions
 with minor version number updates to have you participate in these changes!
 
 ## Download of compiled version and source code
@@ -78,12 +80,66 @@ JavaMod incorporates modified versions of the following libraries:
   * MO3 support
   * read from 7z archives
 
+## New in Version 3.9.4
+* NEW: Supporting STX (ScreamTracker Music Interface Kit)
+* NEW: moved all STM, S3M, IT, ModPlug specific coding into ScreamTrackerMixer
+* NEW: PatternImagePanel now knows about unused (muted) channels with IT - with
+       S3Ms I still throw them out (can be changed by a "compile switch").
+* NEW: also XMs, when saved with ModPlug (not when compatibility mode), get
+       rainbow colored headers in pattern dialog
+* NEW: Same with S3Ms when OPL3 is needed
+* NEW: recognizing MPTM "sample on disc" to output an error. I do not support
+       that, and I don't want to support all the sample sources MPTM can load.
+* NEW: AdLib Instruments loaded for MPTP and S3M plus display in sample dialog
+* FIX: Finished - (except those tests that require OPL):
+       Enhanced ScreamTracker 2 compatibility by fixing everything to make these
+       test MODs work: https://wiki.openmpt.org/Development:_Test_Cases/S3M
+       (many, many changes...!)
+       Remarks to the loop tests. They are now played, as ST3 (V3.21) does it.  
+       The loops run differently when you mute channels in ST3, because then the
+       SB0 and SBx commands of the muted channels are not executed. JavaMod on
+       the other hand does not simulated that. If you mute a channel, effects
+       are still executed. Only channels that were saved as muted are ignored.
+* FIX: Bugs after finishing MODs and XMs. I broke XMs without instruments.
+       And the overflow check at preparePortaToNoteEffect was checking a period
+       against an index.
+* FIX: XM GlobalVolSlide only on Tick Zero.
+* FIX: XM porta2Note with new instrument - really ignore it. Was now dead code.
+* FIX: XM and low notes - removed security checks, FT2 does not do them.
+       However, we simulate the uint8 note value to get negative wrap around.
+* FIX: XM show correct frequency and transposed note in sample dialog
+* FIX: XM only in modplug mode support extended XM effects >0xE2x
+* FIX: XM ignores sample offset, if no note is present
+* FIX: IT, STM, S3M jumpLoops
+* FIX: IT, STM, S3M vibrato depths fixed
+* FIX: IT Global Tempo Slide on ticks>0 and not (and not only) on tick 0
+* FIX: IT moving noteCut to a method: NNA/DNA must also call that. *ARGH!*
+* FIX: IT recognizing different SavedWithTracker names
+* FIX: S3M Loading: recognize different trackers now, ModPlug recognition
+       optimized
+* FIX: S3M reading song flags now correctly
+* FIX: S3M if AmigaLimits is now active - set correct borders
+* FIX: S3M calculation of periods was too precise (cannot believe I say that)
+* FIX: S3M double clean up of pattern removed
+* FIX: Empty S3Ms are better loaded now
+* FIX: STM special speed set (also added ST2Tempo for S3M, if set in song flags,
+       but did not check)
+* FIX: STM is mono (as is STX)
+* FIX: STM / S3M Arpeggios were one half note off
+* FIX: STM Zero Effects - no effect memo
+* FIX: STM unsupported effects: you can edit beyond arpeggio effect, but are not
+       implemented in ScreamTracker 2.21
+* FIX: STM recognition optimized (false positive STX and some Schism)
+* FIX: Reworked proceedToNextRow - patternFineDelay plus PatternBreak failed
+* FIX: PatternImagePanel: no IndexArrayOutOfBounds with initial currentIndex=-1
+       (went unnoticed - was just catched and "walked off")
+       
 ## New in Version 3.9.3
-* FIX: finished:
+* FIX: Finished:
        Enhanced FastTracker 2 compatibility by fixing everything to make these
        test MODs work: https://wiki.openmpt.org/Development:_Test_Cases/XM
        (many, many changes...!)
-* FIX: When fixing (Fine) Volslides for XMs: MODs do not have effect memory with
+* FIX: When fixing (Fine) VolSlides for XMs: MODs do not have effect memory with
        fine volume slides
 * FIX: Note Delays with XMs did not work correctly anymore, due to other fixes.
        Refixed...

source/de/quippy/javamod/io/RandomAccessInputStreamImpl.java

@@ -91,11 +91,11 @@ public RandomAccessInputStreamImpl(File file) throws IOException, FileNotFoundEx
 	 * @param fileName
 	 * @throws FileNotFoundException
 	 */
-	public RandomAccessInputStreamImpl(String fileName) throws IOException, FileNotFoundException
+	public RandomAccessInputStreamImpl(final String fileName) throws IOException, FileNotFoundException
 	{
 		this(new File(fileName));
 	}
-	public RandomAccessInputStreamImpl(URL fromUrl) throws IOException, FileNotFoundException
+	public RandomAccessInputStreamImpl(final URL fromUrl) throws IOException, FileNotFoundException
 	{
 		super();
 		if (Helpers.isFile(fromUrl))
@@ -143,6 +143,21 @@ public RandomAccessInputStreamImpl(URL fromUrl) throws IOException, FileNotFound
 			}
 		}
 	}
+	/**
+	 * Constructor for RandomAccessInputStreamImpl from a direct byte array
+	 * @param fromByteArray
+	 * @throws IOException
+	 * @throws FileNotFoundException
+	 */
+	public RandomAccessInputStreamImpl(final byte[] fromByteArray) throws IOException, FileNotFoundException
+	{
+		super();
+		fullFileCache = fromByteArray;
+		fullFileCache_length = fullFileCache.length;
+		fullFileCache_readPointer = 0;
+		raFile = null;
+		localFile = null;
+	}
 	/**
 	 * @since 04.01.2011
 	 * @param file

source/de/quippy/javamod/main/gui/MainForm.java

@@ -55,7 +55,6 @@
 import java.net.URISyntaxException;
 import java.net.URL;
 import java.time.LocalDate;
-import java.time.format.DateTimeFormatter;
 import java.util.ArrayList;
 import java.util.HashMap;
 import java.util.Iterator;
@@ -116,6 +115,7 @@
 import de.quippy.javamod.multimedia.MultimediaContainerEvent;
 import de.quippy.javamod.multimedia.MultimediaContainerEventListener;
 import de.quippy.javamod.multimedia.MultimediaContainerManager;
+import de.quippy.javamod.multimedia.mod.ModConstants;
 import de.quippy.javamod.system.Helpers;
 import de.quippy.javamod.system.Log;
 import de.quippy.javamod.system.LogMessageCallBack;
@@ -342,7 +342,6 @@ public class MainForm extends JFrame implements DspProcessorCallBack, PlayThread
 	private float currentBalance; /* -1.0 - 1.0 */
 
 	private LocalDate lastUpdateCheck;
-	private static final DateTimeFormatter DATE_FORMATER = DateTimeFormatter.ofPattern("yyyy-MM-dd");
 	private static final LocalDate today = LocalDate.now();
 
 	private ArrayList<URL> lastLoaded;
@@ -490,7 +489,7 @@ private void readPropertyFile()
 			getSALMeterPanel().setDrawWhatTo(saMeterLeftDrawType);
 			getSARMeterPanel().setDrawWhatTo(saMeterRightDrawType);
 
-			lastUpdateCheck = LocalDate.from(DATE_FORMATER.parse(props.getProperty(PROPERTY_LAST_UPDATECHECK, DATE_FORMATER.format(today))));
+			lastUpdateCheck = LocalDate.from(ModConstants.DATE_FORMATER.parse(props.getProperty(PROPERTY_LAST_UPDATECHECK, ModConstants.DATE_FORMATER.format(today))));
 
 			if (currentEqualizer!=null)
 			{
@@ -573,7 +572,7 @@ private void writePropertyFile()
 			props.setProperty(PROPERTY_XMASCONFIG_VISABLE, Boolean.toString(getXmasConfigDialog().isVisible()));
 			props.setProperty(PROPERTY_SAMETER_LEFT_DRAWTYPE, Integer.toString(getSALMeterPanel().getDrawWhat()));
 			props.setProperty(PROPERTY_SAMETER_RIGHT_DRAWTYPE, Integer.toString(getSARMeterPanel().getDrawWhat()));
-			props.setProperty(PROPERTY_LAST_UPDATECHECK, DATE_FORMATER.format(lastUpdateCheck));
+			props.setProperty(PROPERTY_LAST_UPDATECHECK, ModConstants.DATE_FORMATER.format(lastUpdateCheck));
 
 			if (currentEqualizer!=null)
 			{

source/de/quippy/javamod/multimedia/mod/ModConstants.java

@@ -21,6 +21,9 @@
  */
 package de.quippy.javamod.multimedia.mod;
 
+import java.time.LocalDate;
+import java.time.format.DateTimeFormatter;
+
 /**
  * @author Daniel Becker
  * @since 02.08.2020
@@ -84,9 +87,12 @@ public ModConstants()
 		0xB0, 0xB4, 0xB8, 0xBC,	// 24-31
 	};
 
-	// Panning values for old ProTracker and STMs
+	// Panning values for old ProTracker and STMs / S3Ms
 	public static final int OLD_PANNING_LEFT	= 0;								// 0: full left, 64: quarter left
 	public static final int OLD_PANNING_RIGHT	= 256 - OLD_PANNING_LEFT;
+	// Special panning values for S3M and IT
+	public static final int CHANNEL_IS_MUTED	= 0x80<<2;							// IT and S3M use this
+	public static final int CHANNEL_IS_SURROUND = 100<<2;							// IT uses this (YES, not hex!)
 
 	// Volume constants
 	public static final int MAXGLOBALVOLUME		= 128; 								// the maximum global volume at mod loading
@@ -133,19 +139,18 @@ public ModConstants()
 	public static enum PanBits { Pan4Bit, Pan6Bit, Pan8Bit } 
 
 	// Constants for different supported samples
-	public static final int SM_PCMS		= 	0x00;					// PCM 8 Bit Signed
-	public static final int SM_PCMU		= 	0x01;					// PCM 8 Bit unsigned
-	public static final int SM_PCMD 	=	0x02;					// PCM 8 Bit delta values
-	public static final int SM_16BIT 	=	0x04;					// 16 BIT
-	public static final int SM_STEREO	= 	0x08;					// STEREO
-	public static final int SM_PCM16D 	=	SM_PCMD | SM_16BIT;		// PCM 16 Bit delta values
+	public static final int SM_PCMS			= 	0x0001;					// PCM 8 Bit Signed
+	public static final int SM_PCMU			= 	0x0002;					// PCM 8 Bit unsigned
+	public static final int SM_PCMD			=	0x0004;					// PCM 8 Bit delta values
+	public static final int SM_16BIT		=	0x0008;					// 16 BIT
+	public static final int SM_BigEndian	=	0x0010;					// 16 Bit in BigEndian order 
+	public static final int SM_STEREO		= 	0x0020;					// STEREO
 	// IT Packed (>2.14)
-	public static final int SM_IT2148	=	0x10;					// IT 2.14  8Bit compressed - can have stereo set
-	public static final int SM_IT21416	=	SM_IT2148 | SM_16BIT;	// IT 2.14 16Bit compressed - can have stereo set
-	public static final int SM_IT2158	=	0x12;					// IT 2.15  8Bit compressed - can have stereo set
-	public static final int SM_IT21516	=	SM_IT2158 | SM_16BIT;	// IT 2.15 16Bit compressed - can have stereo set
+	public static final int SM_IT214		=	0x0040;					// IT 2.14 compressed
+	public static final int SM_IT215		=	0x0080;					// IT 2.15 compressed
+	public static final int SM_PTM8Dto16 	=	0x0100;					// IT PTM8to16
 	// XM ADPCM ModPlug
-	public static final int SM_ADPCM	=	0x20;					// ModPlug ADPCM
+	public static final int SM_ADPCM		=	0x0200;					// ModPlug ADPCM
 
 	// Loop Types
 	public static final int LOOP_ON						=	0x01;
@@ -201,6 +206,12 @@ public static enum PanBits { Pan4Bit, Pan6Bit, Pan8Bit }
 	public static final int SONG_AMIGALIMITS	= 0x00040;
 	public static final int SONG_ISSTEREO		= 0x00080;
 	public static final int SONG_USEINSTRUMENTS = 0x00100;
+	public static final int SONG_ST2VIBRATO		= 0x00200;
+	public static final int SONG_ST2TEMPO		= 0x00400;
+	public static final int SONG_AMIGASLIDES	= 0x00800;
+	public static final int SONG_VOL0MIXOPTI	= 0x01000;
+	public static final int SONG_USEMIDIPITCH	= 0x02000;
+	public static final int SONG_S3M_GUS		= 0x80000;
 
 	// Player flags
 	public static final int PLAYER_LOOP_DEACTIVATED = 0x00;
@@ -1018,12 +1029,30 @@ public static String getAsHex(final int value, final int digits)
 		for (int shift=(digits-1)<<2; shift>=0; shift-=4)
 			result.append(numbers[(value>>shift)&0xF]);
 		return result.toString();
+	}
+	/**
+	 * Displays a value as a hex-value, using #digits. If the digits are not
+	 * sufficient, the number is cut!
+	 * @param value
+	 * @param digits
+	 * @return
+	 */
+	public static String getAsHex(final long value, final int digits)
+	{
+		StringBuilder result = new StringBuilder();
+		for (int shift=(digits-1)<<2; shift>=0; shift-=4)
+			result.append(numbers[(int)(value>>shift)&0xF]);
+		return result.toString();
 //		Old standard way, much slower, much more fail safe.		
 //		final String hex = Integer.toHexString(value).toUpperCase();
 //		final int zeros = digits - hex.length();
 //		for (int i=0; i<zeros; i++) result.append('0');
 //		return (result.append(hex)).toString();
 	}
+	/**
+	 * Our standard Date formatter
+	 */
+	public static final DateTimeFormatter DATE_FORMATER = DateTimeFormatter.ofPattern("yyyy-MM-dd");
 	/**
 	 * convert the ModPlug version information to a readable string
 	 * @param version
@@ -1032,10 +1061,68 @@ public static String getAsHex(final int value, final int digits)
 	public static String getModPlugVersionString(final int version)
 	{
 		if (version==0) return "Unknown";
-		if ((version&0xFFFF)==0) return getAsHex((version>>24)&0xFF, 2) + '.' + getAsHex((version>>16)&0xFF, 2);
-		final String versionString = getAsHex((version>>24)&0xFF, 2) + '.' + getAsHex((version>>16)&0xFF, 2) + '.' + getAsHex((version>>8)&0xFF, 2) + '.' + getAsHex(version&0xFF, 2);
-		if (versionString.charAt(0)=='0') return versionString.substring(1); else return versionString;
+		if ((version&0xFFFF)==0) return String.format("%x.%02x", Integer.valueOf((version>>24)&0xFF), Integer.valueOf((version>>16)&0xFF));
+		return String.format("%x.%02x.%02x.%02x", Integer.valueOf((version>>24)&0xFF), Integer.valueOf((version>>16)&0xFF), Integer.valueOf((version>>8)&0xFF), Integer.valueOf(version&0xFF));
 	}
+	/**
+	 * convert the Schism version information to a readable string
+	 * @since 19.07.2024
+	 * @param version
+	 * @return
+	 */
+	public static String getSchismVersionString(final int version)
+	{
+		final int cwtv = (version>>16) & 0xFFF;
+		final int extVersion = version&0xFFFF;
+		if (cwtv>0x50)
+		{
+			// version is days from 2009-10-31
+			LocalDate d = LocalDate.of(2009, 10, 31);
+			if (cwtv<0xFFF)
+				d = d.plusDays(cwtv-0x50);
+			else
+				d = d.plusDays(extVersion);
+			return DATE_FORMATER.format(d);
+		}
+		return String.format("0.%x", Integer.valueOf(cwtv));
+	}
+//	private static final int ST2TempoFactor[] = { 140, 50, 25, 15, 10, 7, 6, 4, 3, 3, 2, 2, 2, 2, 1, 1 };
+//	private static final int st2MixingRate = 23863; // Highest possible setting in ST2
+//	public static int convertST2tempo(final int tempo)
+//	{
+//		// This underflows at tempo 06...0F, and the resulting tick lengths depend on the mixing rate.
+//		// Note: ST2.3 uses the constant 50 below, earlier versions use 49 but they also play samples at a different speed.
+//		int samplesPerTick = st2MixingRate / (50 - ((ST2TempoFactor[tempo >> 4] * (tempo & 0x0F)) >> 4));
+//		if(samplesPerTick <= 0)
+//			samplesPerTick += 65536;
+//		return (st2MixingRate<<5)/(samplesPerTick<<2);
+//	}
+	private static final int st2_tempo_table[][] = 
+	{
+	  	{ 125,  117,  110,  102,   95,   87,   80,   72,   62,   55,   47,   40,   32,   25,   17,   10, },
+	  	{ 125,  122,  117,  115,  110,  107,  102,  100,   95,   90,   87,   82,   80,   75,   72,   67, },
+	  	{ 125,  125,  122,  120,  117,  115,  112,  110,  107,  105,  102,  100,   97,   95,   92,   90, },
+	  	{ 125,  125,  122,  122,  120,  117,  117,  115,  112,  112,  110,  110,  107,  105,  105,  102, },
+	  	{ 125,  125,  125,  122,  122,  120,  120,  117,  117,  117,  115,  115,  112,  112,  110,  110, },
+	  	{ 125,  125,  125,  122,  122,  122,  120,  120,  117,  117,  117,  115,  115,  115,  112,  112, },
+	  	{ 125,  125,  125,  125,  122,  122,  122,  122,  120,  120,  120,  120,  117,  117,  117,  117, },
+	  	{ 125,  125,  125,  125,  125,  125,  122,  122,  122,  122,  122,  120,  120,  120,  120,  120, },
+	  	{ 125,  125,  125,  125,  125,  125,  122,  122,  122,  122,  122,  120,  120,  120,  120,  120, },
+	  	{ 125,  125,  125,  125,  125,  125,  125,  125,  122,  122,  122,  122,  122,  122,  122,  122, },
+	  	{ 125,  125,  125,  125,  125,  125,  125,  125,  122,  122,  122,  122,  122,  122,  122,  122, },
+	  	{ 125,  125,  125,  125,  125,  125,  125,  125,  122,  122,  122,  122,  122,  122,  122,  122, },
+	  	{ 125,  125,  125,  125,  125,  125,  125,  125,  122,  122,  122,  122,  122,  122,  122,  122, },
+	  	{ 125,  125,  125,  125,  125,  125,  125,  125,  125,  125,  125,  125,  125,  125,  125,  125, },
+	  	{ 125,  125,  125,  125,  125,  125,  125,  125,  125,  125,  125,  125,  125,  125,  125,  125, },
+	};
+	public static int convertST2tempo(final int tempo)
+	{
+		final int tpr = ((tempo>>4)!=0)?(tempo>>4):1;
+		final int scale = tempo&0xF;
+		return st2_tempo_table[tpr-1][scale];
+	}
+
+
 	// Conversions for read bytes! *********************************************
 //	/**
 //	 * Converts an Intel like stored word to an integer

source/de/quippy/javamod/multimedia/mod/gui/ModPatternDialog.java

@@ -989,6 +989,9 @@ private void updateMuteStatus()
 			final int channels = patternContainer.getChannels();
 			for (int i=0; i<channels; i++)
 			{
+				if (!patternContainer.getIsChannelActive(i))
+					channelButtons[i].setForeground(Color.lightGray);
+				else
 				if (muteStatus!=null && i<muteStatus.length && i<internalMuteStatus.length)
 					channelButtons[i].setForeground((!(internalMuteStatus[i] = muteStatus[i]))?Color.black:Color.lightGray);
 				else
@@ -1320,6 +1323,7 @@ public void run()
 					fillButtonsForChannels(0, patternContainer.getChannels());
 					setCurrentPattern(0);
 					setPreferredSize(getSize());
+					updateMuteStatus();
 					pack();
 				}
 				catch (Throwable ex)
@@ -1389,6 +1393,7 @@ public void getStatusInformation(final StatusInformation infoObject)
 		else
 		if (!isPlaying)
 		{
+			if (currentIndex<0) return; // Obviously we do not display anything yet, so nothing to do
 			EventQueue.invokeLater(new Runnable()
 			{
 				public void run()