FreeJ2ME: Introduce support for audio stream dumping

Mostly for debugging purposes, but it's also neat to have the
ability to dump audio data from J2ME apps, especially ones that
are encrypted and can't be easily opened up.

Supported on both AWT and Libretro. As for Anbu/SDL... that one
is in need of a UI rewrite, as it's still too barebones to have
features be tacked onto it.

The dump file path is (related to the jar): FreeJ2MEDumps/Audio/appname/*

Author: AShiningRay

src/javax/microedition/media/Manager.java

@@ -16,19 +16,59 @@
 */
 package javax.microedition.media;
 
+import java.io.ByteArrayInputStream;
+import java.io.ByteArrayOutputStream;
 import java.io.InputStream;
+import java.io.File;
+import java.io.FileOutputStream;
 import java.io.IOException;
+import java.io.OutputStream;
 
+import org.recompile.mobile.Mobile;
 import org.recompile.mobile.PlatformPlayer;
 
 public final class Manager
 {
 	public static final String TONE_DEVICE_LOCATOR = "device://tone";
 	public static Player midiPlayers[] = new Player[32]; /* Default max amount of players in FreeJ2ME's config  */
 	public static byte midiPlayersIndex = 0;
+	public static boolean dumpAudioStreams = false;
+	public static short audioDumpIndex = 0;
 
 	public static Player createPlayer(InputStream stream, String type) throws IOException, MediaException
 	{
+		if(dumpAudioStreams) 
+		{
+			// Copy the stream contents into a temporary stream to be saved as file
+			final ByteArrayOutputStream streamCopy = new ByteArrayOutputStream();
+			final byte[] copyBuffer = new byte[1024];
+			int copyLength;
+			while ((copyLength = stream.read(copyBuffer)) > -1 ) { streamCopy.write(copyBuffer, 0, copyLength); }
+			streamCopy.flush();
+
+			// Make sure the initial strem will still be available for FreeJ2ME
+			stream = new ByteArrayInputStream(streamCopy.toByteArray());
+
+			// And save the copy to the specified dir
+
+			OutputStream outStream;
+			String dumpPath = "." + File.separatorChar + "FreeJ2MEDumps" + File.separatorChar + "Audio" + File.separatorChar + Mobile.getPlatform().loader.suitename + File.separatorChar;
+			File dumpFile = new File(dumpPath);
+
+			if (!dumpFile.isDirectory()) { dumpFile.mkdirs(); }
+
+			if(type.equalsIgnoreCase("audio/mid") || type.equalsIgnoreCase("audio/midi") || type.equalsIgnoreCase("sp-midi") || type.equalsIgnoreCase("audio/spmidi")) 
+				{ dumpFile = new File(dumpPath + "Stream" + Short.toString(audioDumpIndex) + ".mid");}
+			else if(type.equalsIgnoreCase("audio/x-wav") || type.equalsIgnoreCase("audio/wav")) { dumpFile = new File(dumpPath + "Stream" + Short.toString(audioDumpIndex) + ".wav");}
+			else if(type.equalsIgnoreCase("audio/mpeg") || type.equalsIgnoreCase("audio/mp3")) { dumpFile = new File(dumpPath + "Stream" + Short.toString(audioDumpIndex) + ".mp3");}
+
+			outStream = new FileOutputStream(dumpFile);
+
+			streamCopy.writeTo(outStream);
+
+			audioDumpIndex++;
+		}
+
 		//System.out.println("Create Player Stream "+type);
 		if(type.equalsIgnoreCase("audio/mid") || type.equalsIgnoreCase("audio/midi") || type.equalsIgnoreCase("sp-midi") || type.equalsIgnoreCase("audio/spmidi"))
 		{

src/libretro/freej2me_libretro.c

@@ -146,6 +146,7 @@ int gameFPS; /* Auto(0), 60, 30, 15 */
 int soundEnabled; /* also acts as a boolean */
 int customMidi; /* Also acts as a boolean */
 int maxMidiPlayers; /* Maximum amount of MIDI Players allowed on FreeJ2ME at any given time */
+int dumpAudioStreams;
 /* Variables used to manage the pointer speed when controlled from an analog stick */
 int pointerXSpeed = 8;
 int pointerYSpeed = 8;
@@ -356,6 +357,13 @@ static void check_variables(bool first_time_startup)
 		else if (!strcmp(var.value, "96")) { maxMidiPlayers = 96; }
 	}
 
+	var.key = "freej2me_dumpaudiostreams";
+   if (Environ(RETRO_ENVIRONMENT_GET_VARIABLE, &var) && var.value)
+   {
+		if (!strcmp(var.value, "off"))     { dumpAudioStreams = 0; }
+		else if (!strcmp(var.value, "on")) { dumpAudioStreams = 1; }
+   }
+
    var.key = "freej2me_pointertype";
 	if (Environ(RETRO_ENVIRONMENT_GET_VARIABLE, &var) && var.value)
 	{
@@ -434,7 +442,7 @@ static void check_variables(bool first_time_startup)
 
 
 	/* Prepare a string to pass those core options to the Java app */
-	snprintf(options_update, PIPE_MAX_LEN, "FJ2ME_LR_OPTS:|%lux%lu|%d|%d|%d|%d|%d|%d|%d", screenRes[0], screenRes[1], rotateScreen, phoneType, gameFPS, soundEnabled, customMidi, maxMidiPlayers);
+	snprintf(options_update, PIPE_MAX_LEN, "FJ2ME_LR_OPTS:|%lux%lu|%d|%d|%d|%d|%d|%d|%d", screenRes[0], screenRes[1], rotateScreen, phoneType, gameFPS, soundEnabled, customMidi, maxMidiPlayers, dumpAudioStreams);
 	optstrlen = strlen(options_update);
 
 	/* 0xD = 13, which is the special case where the java app will receive the updated configs */
@@ -494,7 +502,7 @@ void retro_init(void)
 	 */
 	check_variables(true);
 
-	char resArg[2][4], rotateArg[2], phoneArg[2], fpsArg[3], soundArg[2], midiArg[2], maxMidiArg[3];
+	char resArg[2][4], rotateArg[2], phoneArg[2], fpsArg[3], soundArg[2], midiArg[2], maxMidiArg[3], dumpAudioArg[2];
 	sprintf(resArg[0], "%lu", screenRes[0]); /* Libretro config Width  */
 	sprintf(resArg[1], "%lu", screenRes[1]); /* Libretro config Height */
 	sprintf(rotateArg, "%d",  rotateScreen);
@@ -503,16 +511,17 @@ void retro_init(void)
 	sprintf(soundArg,  "%d",  soundEnabled);
 	sprintf(midiArg,   "%d",  customMidi);
 	sprintf(maxMidiArg,"%d",  maxMidiPlayers);
+	sprintf(dumpAudioArg,   "%d",  dumpAudioStreams);
 
 	/* start java process */
 	char *javapath;
 	Environ(RETRO_ENVIRONMENT_GET_SYSTEM_DIRECTORY, &javapath);
 	char *outPath = malloc(sizeof(char) * PATH_MAX_LENGTH);
 	fill_pathname_join(outPath, javapath, "freej2me-lr.jar", PATH_MAX_LENGTH);
-	char *params[] = { "java", "-jar", outPath, resArg[0], resArg[1], rotateArg, phoneArg, fpsArg, soundArg, midiArg, maxMidiArg, NULL };
+	char *params[] = { "java", "-jar", outPath, resArg[0], resArg[1], rotateArg, phoneArg, fpsArg, soundArg, midiArg, maxMidiArg, dumpAudioArg, NULL };
 
 	log_fn(RETRO_LOG_INFO, "Passing params: %s | %s | %s | %s | %s | %s | %s | %s | %s\n", *(params+3),
-		*(params+4), *(params+5), *(params+6), *(params+7), *(params+8), *(params+9), *(params+10));
+		*(params+4), *(params+5), *(params+6), *(params+7), *(params+8), *(params+9), *(params+10), *(params+11));
 	log_fn(RETRO_LOG_INFO, "Preparing to open FreeJ2ME's Java app (make sure freej2me-lr.jar is inside system/).\n");
 
 #ifdef __linux__
@@ -1005,7 +1014,7 @@ pid_t javaOpen(char *cmd, char **params)
 
 	log_fn(RETRO_LOG_INFO, "Opening: %s %s %s ...\n", *(params+0), *(params+1), *(params+2));
 	log_fn(RETRO_LOG_INFO, "Params: %s | %s | %s | %s | %s | %s | %s | %s | %s\n", *(params+3),
-		*(params+4), *(params+5), *(params+6), *(params+7), *(params+8), *(params+9), *(params+10));
+		*(params+4), *(params+5), *(params+6), *(params+7), *(params+8), *(params+9), *(params+10), *(params+11));
 
 	int fd_stdin  = 0;
 	int fd_stdout = 1;
@@ -1134,15 +1143,15 @@ void javaOpen(char *cmd, char **params)
 	sprintf(cmdWin, "javaw -jar %s", cmd);
 
 	log_fn(RETRO_LOG_INFO, "Opening: %s \n", cmd);
-	for (int i = 3; i <= 10; i++) /* There are 10 cmd arguments for now */
+	for (int i = 3; i <= 11; i++) /* There are 10 cmd arguments for now */
 	{
 		log_fn(RETRO_LOG_INFO, "Processing arg %d: %s \n", i, *(params+i));
 		sprintf(cmdWin, "%s %s", cmdWin, *(params+i));
 	}
 
 	log_fn(RETRO_LOG_INFO, "Creating proc: %s \n", cmdWin);
 	log_fn(RETRO_LOG_INFO, "Params: %s | %s | %s | %s | %s | %s | %s | %s | %s\n", *(params+3),
-		*(params+4), *(params+5), *(params+6), *(params+7), *(params+8), *(params+9), *(params+10));
+		*(params+4), *(params+5), *(params+6), *(params+7), *(params+8), *(params+9), *(params+10), *(params+11));
 
 	GetStartupInfo(&startInfo);
 	startInfo.dwFlags = STARTF_USESTDHANDLES;

src/libretro/freej2me_libretro.h

@@ -195,6 +195,20 @@ struct retro_core_option_v2_definition core_options[] =
         },
         "32"
     },
+    {
+        "freej2me_dumpaudiostreams",
+        "Advanced Settings > Dump Audio Streams",
+        "Dump Audio Streams",
+        "This option allows FreeJ2ME to dump incoming Audio Data into $SYSTEM/FreeJ2MEDumps/Audio/appname/*, mostly useful for debugging",
+        "This option allows FreeJ2ME to dump incoming Audio Data into $SYSTEM/FreeJ2MEDumps/Audio/appname/*, mostly useful for debugging",
+        "advanced_settings",
+        {
+            { "off",  "Disable"            },
+            { "on",  "Enable"              },
+            { NULL, NULL },
+        },
+        "off"
+    },
     {
         "freej2me_pointertype",
         "Advanced Settings > Pointer Type",
@@ -421,6 +435,17 @@ struct retro_core_option_definition core_options_v1 [] =
         },
         "32"
     },
+    {
+        "freej2me_dumpaudiostreams",
+        "Dump Audio Streams",
+        "This option allows FreeJ2ME to dump incoming Audio Data into $SYSTEM/FreeJ2MEDumps/Audio/appname/*, mostly useful for debugging",
+        {
+            { "off",  "Disable"            },
+            { "on",  "Enable"              },
+            { NULL, NULL },
+        },
+        "off"
+    },
     {
         "freej2me_pointertype",
         "Pointer Type",
@@ -547,29 +572,33 @@ static const struct retro_variable vars[] =
         "freej2me_maxmidiplayers",
         "Max MIDI Players: 32|1|2|4|8|16|48|64|96"
     },
+    { /* Dump Audio Streams */
+        "freej2me_dumpaudiostreams",
+        "Dump Audio Streams: off|on"
+    },
     { /* Pointer Type */
         "freej2me_pointertype",
-        "Pointer Type; Mouse|Touch|None",
+        "Pointer Type; Mouse|Touch|None"
     },
     { /* Screen Pointer X Speed */
         "freej2me_pointerxspeed",
-        "Pointer X Speed; 4|1|2|8|16",
+        "Pointer X Speed; 4|1|2|8|16"
     },
     { /* Screen Pointer Y Speed */
         "freej2me_pointeryspeed",
-        "Pointer Y Speed; 4|1|2|8|16",
+        "Pointer Y Speed; 4|1|2|8|16"
     },
     { /* Pointer's inner color */
         "freej2me_pointerinnercolor",
-        "Pointer Inner Color; White|Red|Green|Blue|Yellow|Pink|Cyan|Black",
+        "Pointer Inner Color; White|Red|Green|Blue|Yellow|Pink|Cyan|Black"
     },
     { /* Pointer's outline color */
         "freej2me_pointeroutercolor",
-        "Pointer Outline Color; Black|Red|Green|Blue|Yellow|Pink|Cyan|White",
+        "Pointer Outline Color; Black|Red|Green|Blue|Yellow|Pink|Cyan|White"
     },
     { /* Pointer's click indicator color */
         "freej2me_pointerclickcolor",
-        "Pointer Click Indicator Color; Yellow|Black|Red|Green|Blue|Pink|Cyan|White",
+        "Pointer Click Indicator Color; Yellow|Black|Red|Green|Blue|Pink|Cyan|White"
     },
     { NULL, NULL },
 };

src/org/recompile/freej2me/AWTGUI.java

@@ -23,6 +23,8 @@
 
 import java.util.Arrays;
 
+import javax.microedition.media.Manager;
+
 public final class AWTGUI 
 {
 	/* This is used to indicate to FreeJ2ME that it has to call "settingsChanged()" to apply changes made here */
@@ -740,8 +742,8 @@ public void itemStateChanged(ItemEvent e)
 		{
 			public void itemStateChanged(ItemEvent e) 
 			{
-				if(dumpAudioData.getState()){ /* TODO */ }
-				else{ /* TODO */ }
+				if(dumpAudioData.getState()){ Manager.dumpAudioStreams = true; }
+				else{ Manager.dumpAudioStreams = false; }
 			}
 		});
 

src/org/recompile/freej2me/Anbu.java

@@ -71,6 +71,8 @@ public Anbu(String args[])
 
 		Mobile.setPlatform(new MobilePlatform(lcdWidth, lcdHeight));
 
+		/* TODO: Anbu has no way of enabling "Dump Audio Streams", a UI rewrite might be in order */
+
 		config = new Config();
 		config.onChange = new Runnable() { public void run() { settingsChanged(); } };
 

src/org/recompile/freej2me/Libretro.java

@@ -135,6 +135,9 @@ public Libretro(String args[])
 		maxmidistreams = Integer.parseInt(args[7]);
 		Manager.updatePlayerNum((byte) maxmidistreams);
 
+		/* Dump Audio Streams will not be a per-game FreeJ2ME config, so it will have to be set every time for now */
+		if(Integer.parseInt(args[8]) == 1) { Manager.dumpAudioStreams = true; }
+
 		/* Once it finishes parsing all arguments, it's time to set up freej2me-lr */
 
 		surface = new BufferedImage(lcdWidth, lcdHeight, BufferedImage.TYPE_INT_ARGB); // libretro display
@@ -376,6 +379,9 @@ public void run()
 									if(Integer.parseInt(cfgtokens[8])==7) { config.settings.put("maxmidistreams", "64");}
 									if(Integer.parseInt(cfgtokens[8])==8) { config.settings.put("maxmidistreams", "96");}
 
+									if(Integer.parseInt(cfgtokens[9])==1) { Manager.dumpAudioStreams = true;  }
+									if(Integer.parseInt(cfgtokens[9])==0) { Manager.dumpAudioStreams = false; }
+
 									config.saveConfig();
 									settingsChanged();
 								break;