V3.9.1 Update

Author: quippy-git

README.md

@@ -1,4 +1,4 @@
-# JavaMod V3.8
+# JavaMod V3.9.1
 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), ...
@@ -17,6 +17,13 @@ To start the command line version enter:
 On Linux consider starting with OpenGL render pipeline activated:
    java -Dsun.java2d.opengl=true -jar ./javamod.jar
 
+## 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 most of XM with this version
+and a whole lot of other stuff as well. So I decided to release new version 
+with minor version number updates to have you participate in these changes!
+
 ## Download of compiled version and source code
 * https://javamod.de/javamod.php
 * https://quippy.de/mod.php
@@ -53,17 +60,113 @@ JavaMod incorporates modified versions of the following libraries:
 ## Known issues:
 * With PulseAudio: 
   * gapless audio streams do not work if SourceLine Buffers drain out
-  * scrambled sound
+  * scrambled sound (especially with PipeWire)
 * With KDE:
   * JDialogs, when set visible, will not come to front
-  * X-Mas Decoration does not work as intended
 * Tray Icon: mouse wheel (volume control) & keyboard shortcuts do not work
 
 ## Planned:
-* WavPack and MusePack support
-* MO3 support
-* Midi and AdLib/OPL with Mods
-* read 7z archives
+* finish loading of OMPT extended instrument / song data / mixer data
+* optimize recognition of different trackers - for whatever that is worth it
+* reading at least Midi Config with XMs / ITs
+* VSTiVolume, SamplePreAmp, MixLevels - look, what OMPT has to say
+* check for further missing MPTM Effects like Reverb and Surround commands
+* Quad Speaker mixing (rear speakers)
++ LongList:
+  * Midi and AdLib/OPL with Mods
+  * WavPack and MusePack support
+  * MO3 support
+  * read from 7z archives
+
+## New in Version 3.9.1
+* NEW: Colorful pattern display with previous and next pattern displayed in dim
+       colors. Following pattern optimized, drawn completely manually and with
+       full clipping of unseen parts to gain speed.
+       Effects are displayed in different colors per category, like MPT does it
+       During playback, you can select a pattern for seeking into the piece
+* NEW: Moved the UpdateThread of ModPatternDialog into a separate class and
+       moved wiring into ModContainer
+* NEW: added also an editor bar to the pattern display to move with cursor keys
+       and page up/down, home/end, ... plus modifier keys.
+       Press ESC to leave editor mode. (The editor mode is not a real editor!)
+* NEW: A double click on the instrument column will open instrument/sample
+       dialog for display
+* NEw: Zoom for instrument and sample display
+* NEW: Overhaul of most of the graphical implementations
+* NEW: removed test classes from project
+* NEW: Added a headless mode for command line usage. That way no GUI elements
+       are created.
+       (Explanation: So far we used the ConfigPanels to store the current config
+       of a mixer. Now this is done locally and only transported to/from the
+       GUIs, if they are present)
+* NEW: Added ModPlug Tracker MPTM-Files for loading. However, not all MPTM-
+       effects are yet supported (there are not that many missing though)
+       See next list:
+* NEW: added support for OMPT special "Extension Effect" feature
+* NEW: added OMPT extended song properties (not all yet!)
+* NEW: added OMPT extended instrument properties (by far not all yet!)
+* NEW: added OMPT cue points
+* NEW: added OMPT tempo modes CLASSIC, ALTERNATIVE and MODERN plus TempSwing
+* NEW: added OMPT pattern names / channel names / channel coloring
+* NEW: added OMPT 127 Channel support
+* NEW: added OMPT Kaiser interpolation and WindowedFIR with low pass filter
+* NEW: (BETA, UNTESTED) added support for XM version <0x0104, but could not test
+       as I am missing old FT2 XMs for that
+* NEW: more sanity checks in XM loading. Had found some very corrupted ones
+* NEW: Added ADPCM decoding for MODs, XMs, S3M and ITs - however, I am very sure
+       that nobody is using this encoder anymore
+* NEW: added a simulation of the E00/E01 filter effect with MODs and XMs (we re-
+       use the resonance low pass filter of ITs here...). If I ever implement
+       an A500/A1200 Paula filter we would use that one to get a more realistic
+       emulation
+* NEW: added FunkIt! (EFx effect) for mod files. Is that really used?!
+* NEW: added an info dialog for SID tunes (and fixed NULL-Pointer exception with
+       non existent info panels as well - there are none now however...)
+* NEW: added support for ITs in sample mode only (flags bit 2 not set)
+* FIX: setting FineTune via effect now works also in MOD/XM
+* FIX: XM: reading periods from tables instead of on the fly calculations
+* FIX: Enhanced ProTracker 1/2 compatibility by fixing everything to make these
+       test MODs work: https://wiki.openmpt.org/Development:_Test_Cases/MOD
+       (many, many changes...! Let's just say tempo and sample setting is very
+       different now - and many other things)
+* FIX: 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: Vibrato, Panbrello, Tremolo fixed for MOD, XM, S3M and IT
+* FIX: Overhaul of automatic volume ramping for new instruments. Is now only
+       done when a new tick starts (only on new row did not do the trick!) and
+       considers now the target mixing buffer size.
+       I don't do that like 8bitbubsy: add a new channel with a volume ramp
+       down for the "leaving" sample and do a ramp up with the new one. Did not
+       work for me with synthesis.mod from Rymix - still clicks...
+* FIX: As now volume ramping does work and we also have the smooth OMPT ramping
+       over one whole tick, we *must* deactivate that, if a volume is set
+* FIX: no silence at beginning of play back anymore - starts instantly now 
+* FIX: added tempo memory for IT tempo slides
+* FIX: S3M ignores illegal pattern break commands
+* FIX: (Smooth) Midi Macros for XMs fixed
+* FIX: Smooth midi macros initial value (lastZxxParam) must be 0x7F not 0
+* FIX: Effects Parameter Extension and smooth midi macros are swapped between 
+       XMs and ITs
+* FIX: PatternFrameDelays add up. After PatternDelay, PatternFrameDelays must be 
+       restored for ITs / S3M. With XMs we also need to process tick effects, 
+       not row effects. But fine effects (played on tick zero) must be played as
+       well. Fixed for all XMs, ITs, S3M, MPT
+* FIX: NoteDelay need to do row effects with EFG memory
+* FIX: Registering the Mixers at the ModPatternDialog resulted in an exception
+       when JavaMod was started on the command line. Also fixed with Headless
+* FIX: Renamed "Wide Stereo Mix" to "Surround Mix", as that is what is really
+       done
+* FIX: Loading and displaying of a play list is now much faster
+* FIX: CommandLine did not read parameter "buffer size" correctly
+* FIX: remove effect names when play back stopped
+* FIX: muting a channel will not stop its rendering anymore
+* FIX: Playback in Pattern- and SampleDialog must respect finetune settings
+* FIX: APE files in 8Bit were set to signed samples - which is wrong
+* FIX: MP3 ICY Streams with no song name meta tag yet send will identify as
+       "Streaming" and not pick a default name from the URL
+* FIX: On MacOS "mode.getRefreshRate" will return "REFRESHRATE_UNKNOWN" - which
+       is 0. Thanks to MasterFlomaster1 for finding this.
 
 ## New in Version 3.8
 * NEW: Implemented an automatic update check every 30 days. *Disable* it in the
@@ -303,7 +406,7 @@ JavaMod incorporates modified versions of the following libraries:
 * FIX: Log.debug (instead of Log.info) for missing effects
 * FIX: When a MOD was playing, changing MOD sample rate, channels, bits also
        changed current audio line, even though e.g. mp3 is playing. Not healthy
-       for playback if the global line is cut away during playing
+       for play back if the global line is cut away during playing
        (BTW: same for SIDs)
 * FIX: Instrument set, but no note - with XMs/ITs lookup in mapping resulted in
        Exception

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

@@ -940,7 +940,8 @@ public static enum PanBits { Pan4Bit, Pan6Bit, Pan8Bit }
 	// Table for Invert Loop and Funk Repeat effects (EFx, .MOD only)
 	public static final int modEFxTable[] =
 	{
-		 0,  5,  6,  7,  8, 10, 11, 13, 16, 19, 22, 26, 32, 43, 64, 128
+		0x00, 0x05, 0x06, 0x07, 0x08, 0x0A, 0x0B, 0x0D,
+		0x10, 0x13, 0x16, 0x1A, 0x20, 0x2B, 0x40, 0x80
 	};
 
 	/**

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

@@ -60,7 +60,15 @@ public EnvelopeImagePanel()
 		setDoubleBuffered(true);
 	}
 
-	private void drawGrid(Graphics g, int top, int left, int width, int height)
+	private int getX(final int xPos)
+	{
+		return (xPos * getWidth()) / MAX_WIDTH;
+	}
+	private int getY(final int yPos)
+	{
+		return getHeight() - ((yPos  * getHeight()) >> 6);
+	}
+	private void drawGrid(final Graphics g, final int top, final int left, final int width, final int height)
 	{
 		final int halfHeight = height>>1;
 
@@ -69,7 +77,7 @@ private void drawGrid(Graphics g, int top, int left, int width, int height)
 
 		for (int i=0; i<MAX_WIDTH; i++)
 		{
-			int x = (i * width) / MAX_WIDTH;
+			int x = getX(i);
 			if ((i % (SMALLESTGRID*4*4))==0)
 			{
 				g.setColor(GRID_COLOR);
@@ -89,19 +97,21 @@ private void drawGrid(Graphics g, int top, int left, int width, int height)
 			}
 		}
 	}
-	private int getX(final int xPos)
+	private void drawLoopLine(final Graphics g, final int startPoint, final int endPoint, final int width, final int height, final Color col)
 	{
-		return (xPos * getWidth()) / MAX_WIDTH;
-	}
-	private int getY(final int yPos)
-	{
-		return getHeight() - ((yPos  * getHeight()) >> 6);
+		g.setColor(col);
+		int x = getX(envelope.positions[startPoint]) - BOXWIDTH;
+		if (x<0) x=0; else if (x>width) x=width;
+		g.drawLine(x, 0, x, height);
+		x = getX(envelope.positions[endPoint]) + BOXWIDTH + 1;
+		if (x<0) x=0; else if (x>width) x=width;
+		g.drawLine(x, 0, x, height);
 	}
 	/**
 	 * @since 07.01.2024
 	 * @param gfx
 	 */
-	private void drawEnvelope(Graphics g)
+	private void drawEnvelope(final Graphics g)
 	{
 		final int width = getWidth();
 		final int height = getHeight();
@@ -131,26 +141,8 @@ private void drawEnvelope(Graphics g)
 				oldx = x;
 				oldy = y;
 			}
-			if (envelope.loop)
-			{
-				g.setColor(LOOP_COLOR);
-				int x = getX(envelope.positions[envelope.loopStartPoint]) - BOXWIDTH;
-				if (x<0) x=0; else if (x>width) x=width;
-				g.drawLine(x, 0, x, height);
-				x = getX(envelope.positions[envelope.loopEndPoint]) + BOXWIDTH + 1;
-				if (x<0) x=0; else if (x>width) x=width;
-				g.drawLine(x, 0, x, height);
-			}
-			if (envelope.sustain)
-			{
-				g.setColor(SUSTAINLOOP_COLOR);
-				int x = getX(envelope.positions[envelope.sustainStartPoint]) - BOXWIDTH;
-				if (x<0) x=0; else if (x>width) x=width;
-				g.drawLine(x, 0, x, height);
-				x = getY(envelope.positions[envelope.sustainEndPoint]) + BOXWIDTH + 1;
-				if (x<0) x=0; else if (x>width) x=width;
-				g.drawLine(x, 0, x, height);
-			}
+			if (envelope.loop) drawLoopLine(g, envelope.loopStartPoint, envelope.loopEndPoint, width, height, LOOP_COLOR);
+			if (envelope.sustain) drawLoopLine(g, envelope.sustainStartPoint, envelope.sustainEndPoint, width, height, SUSTAINLOOP_COLOR);
 		}
 	}
 	/**
@@ -176,4 +168,11 @@ public void setEnvelope(Envelope envelope)
 		this.envelope = envelope;
 		repaint();
 	}
+	/**
+	 * @return the envelope
+	 */
+	public Envelope getEnvelope()
+	{
+		return envelope;
+	}
 }

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

@@ -21,10 +21,17 @@
  */
 package de.quippy.javamod.multimedia.mod.gui;
 
+import java.awt.Dimension;
+import java.awt.EventQueue;
 import java.awt.GridBagLayout;
+import java.awt.Insets;
 import java.awt.LayoutManager;
+import java.awt.event.ItemEvent;
+import java.awt.event.ItemListener;
 
+import javax.swing.JComboBox;
 import javax.swing.JPanel;
+import javax.swing.JScrollPane;
 
 import de.quippy.javamod.main.gui.components.FixedStateCheckBox;
 import de.quippy.javamod.multimedia.mod.loader.instrument.Envelope;
@@ -38,6 +45,7 @@
 public class EnvelopePanel extends JPanel
 {
 	private static final long serialVersionUID = 5511415780545189305L;
+	private static String [] ZOOM_TYPES = new String [] { "Auto", "2:1", "4:1", "8:1", "16:1", "32:1" };
 
 	private EnvelopeImagePanel envelopeImagePanel = null;
 
@@ -46,6 +54,8 @@ public class EnvelopePanel extends JPanel
 	private FixedStateCheckBox isFilterEnabled = null;
 	private FixedStateCheckBox isLoopEnabled = null;
 	private FixedStateCheckBox isSustainEnabled = null;
+	private JComboBox<String> zoomSelector = null;
+	private JScrollPane imageBufferScrollPane = null;
 
 	/**
 	 * Constructor for EnvelopePanel
@@ -91,7 +101,8 @@ private void initialize()
 		add(getIsFilterEnabled(), 		Helpers.getGridBagConstraint(2, 0, 1, 1, java.awt.GridBagConstraints.NONE, java.awt.GridBagConstraints.WEST, 0.0, 0.0));
 		add(getIsLoopEnabled(), 		Helpers.getGridBagConstraint(3, 0, 1, 1, java.awt.GridBagConstraints.NONE, java.awt.GridBagConstraints.WEST, 0.0, 0.0));
 		add(getIsSustainEnabled(), 		Helpers.getGridBagConstraint(4, 0, 1, 1, java.awt.GridBagConstraints.NONE, java.awt.GridBagConstraints.WEST, 0.0, 0.0));
-		add(getEnvelopeImagePanel(), 	Helpers.getGridBagConstraint(0, 1, 1, 0, java.awt.GridBagConstraints.BOTH, java.awt.GridBagConstraints.WEST, 1.0, 1.0));
+		add(getZoomSelector(), 			Helpers.getGridBagConstraint(5, 0, 1, 1, java.awt.GridBagConstraints.NONE, java.awt.GridBagConstraints.WEST, 0.0, 0.0));
+		add(getImageBufferScrollPane(), Helpers.getGridBagConstraint(0, 1, 1, 0, java.awt.GridBagConstraints.BOTH, java.awt.GridBagConstraints.WEST, 1.0, 1.0));
 	}
 	private FixedStateCheckBox getIsEnabled()
 	{
@@ -148,6 +159,40 @@ private FixedStateCheckBox getIsSustainEnabled()
 		}
 		return isSustainEnabled;
 	}
+	private JComboBox getZoomSelector()
+	{
+		if (zoomSelector==null)
+		{
+			zoomSelector = new JComboBox<String>();
+			zoomSelector.setName("zoomSelector");
+			zoomSelector.setFont(Helpers.getDialogFont());
+
+			for (int i=0; i<ZOOM_TYPES.length; i++) zoomSelector.addItem(ZOOM_TYPES[i]);
+			zoomSelector.addItemListener(new ItemListener()
+			{
+				@Override
+				public void itemStateChanged(ItemEvent e)
+				{
+					final Envelope theEnvelope = getEnvelopeImagePanel().getEnvelope();
+					if (theEnvelope==null) return;
+					changeZoom(getZoomSelector().getSelectedIndex());
+				}
+			});
+		}
+		
+		return zoomSelector;
+	}
+	private JScrollPane getImageBufferScrollPane()
+	{
+		if (imageBufferScrollPane==null)
+		{
+			imageBufferScrollPane = new javax.swing.JScrollPane();
+			imageBufferScrollPane.setName("imageBufferScrollPane");
+			imageBufferScrollPane.setViewportView(getEnvelopeImagePanel());
+			imageBufferScrollPane.setDoubleBuffered(true);
+		}
+		return imageBufferScrollPane;
+	}
 	private EnvelopeImagePanel getEnvelopeImagePanel()
 	{
 		if (envelopeImagePanel==null)
@@ -156,6 +201,35 @@ private EnvelopeImagePanel getEnvelopeImagePanel()
 		}
 		return envelopeImagePanel;
 	}
+	private void changeZoom(final int newZoom)
+	{
+		final Dimension d = getEnvelopeImagePanel().getSize();
+		final Envelope theEnvelope = getEnvelopeImagePanel().getEnvelope();
+		if (theEnvelope!=null)
+		{
+			final int scrollBarHeight = getImageBufferScrollPane().getHorizontalScrollBar().getPreferredSize().height;
+			final Insets inset = getImageBufferScrollPane().getInsets();
+			d.height= getImageBufferScrollPane().getHeight() - inset.top - inset.bottom - (scrollBarHeight<<1);
+			d.width = (getImageBufferScrollPane().getWidth() - inset.left - inset.right) << newZoom;
+		}
+		EventQueue.invokeLater(new Runnable()
+		{
+			public void run()
+			{				
+				try
+				{
+					getEnvelopeImagePanel().setSize(d);
+					getEnvelopeImagePanel().setMinimumSize(d);
+					getEnvelopeImagePanel().setMaximumSize(d);
+					getEnvelopeImagePanel().setPreferredSize(d);
+				}
+				catch (Throwable ex)
+				{
+					// Keep it!
+				}
+			}
+		});
+	}
 	public void setEnvelope(final Envelope envelope)
 	{
 		if (envelope!=null)

source/de/quippy/javamod/multimedia/mod/loader/Module.java

@@ -1455,15 +1455,12 @@ protected boolean loadExtendedSongProperties(final ModfileInputStream inputStrea
 					break;
 				case 0x5350412E: //"SPA." - SamplePreAmp
 					mixingPreAmp = (int)inputStream.readIntelBytes(size);
-					if (mixingPreAmp > ModConstants.MAX_MIXING_PREAMP) mixingPreAmp = ModConstants.MAX_MIXING_PREAMP;
 					break;
 				case 0x56535456: //"VSTV" - VSTiVolume
 					synthMixingPreAmp = (int)inputStream.readIntelBytes(size);
-					if (synthMixingPreAmp > ModConstants.MAX_MIXING_PREAMP) synthMixingPreAmp = ModConstants.MAX_MIXING_PREAMP;
 					break;
 				case 0x4447562E: //"DGV." - defaultGlobalVolume
 					baseVolume = (int)inputStream.readIntelBytes(size);
-					if (baseVolume > ModConstants.MAXGLOBALVOLUME) baseVolume = ModConstants.MAXGLOBALVOLUME;
 					break;
 				case 0x52502E2E: //"RP.." - Song Restart
 					final int restartPosition = (int)inputStream.readIntelBytes(size);