feat(zscript): music seeking functions for ogg and mp3

Author: Moosh64

resources/docs/ZScript_Additions.txt

@@ -7768,18 +7768,17 @@ rgb ConvertRGBFrom(float[] buf, int color_space)
 ///  Audio->  ///
 /////////////////								// Audio
 
-bool PlayOgg(int filename[], int track);
- * Similar to PlayEnhancedMusic(), but only for OGG files.
- * Supports seeking, and other special instructions.
+int GetMusicPos();
+ * Returns the current seek position of the currently playing enhanced music in seconds.
+ * CURRENTLY ONLY SUPPORTS MP3
 
-int GetOggPos();
- * Returns the current seek position of an OGG started with PlayOgg, in ms.
-
-void SetOggPos(int new_pos);
- * Sets the play position for an OGG started with PlayOgg(), in ms.
+void SetMusicPos(int new_pos);
+ * Sets the play position for the currently playing enhanced music in seconds.
+ * CURRENTLY ONLY SUPPORTS MP3
 
-void SetOggSpeed(int newspeed);
- * Sets the playback speed of an OGG started with PlayOgg();
+void SetMusicSpeed(int newspeed);
+ * Sets the playback speed of the currently playing enhanced music.
+ * CURRENTLY ONLY SUPPORTS MP3
 
 
 void PlaySound(int soundid);	ZASM Instruction: 

src/parser/symbols/AudioSymbols.cpp

@@ -22,9 +22,9 @@ static AccessorTable AudioTable[] =
 	//Undocumented intentionally
 	{ "AdjustSound",             0,          ZTID_VOID,   -1,               FL_DEPR,  { ZTID_AUDIO, ZTID_FLOAT, ZTID_FLOAT, ZTID_BOOL },{} },
 	{ "PlayOgg",                 0,          ZTID_BOOL,   -1,               FL_DEPR,  { ZTID_AUDIO, ZTID_FLOAT, ZTID_FLOAT },{} },
-	{ "GetOggPos",               0,         ZTID_FLOAT,   -1,               FL_DEPR,  { ZTID_AUDIO },{} },
-	{ "SetOggPos",               0,          ZTID_VOID,   -1,               FL_DEPR,  { ZTID_AUDIO, ZTID_FLOAT },{} },
-	{ "SetOggSpeed",             0,          ZTID_VOID,   -1,               FL_DEPR,  { ZTID_AUDIO, ZTID_FLOAT },{} },
+	{ "GetMusicPos",               0,         ZTID_FLOAT,   -1,               FL_DEPR,  { ZTID_AUDIO },{} },
+	{ "SetMusicPos",               0,          ZTID_VOID,   -1,               FL_DEPR,  { ZTID_AUDIO, ZTID_FLOAT },{} },
+	{ "SetMusicSpeed",             0,          ZTID_VOID,   -1,               FL_DEPR,  { ZTID_AUDIO, ZTID_FLOAT },{} },
 	{ "getVolume[]",             0,         ZTID_FLOAT,   AUDIOVOLUME,      FL_DEPR,  { ZTID_AUDIO, ZTID_FLOAT },{} },
 	{ "setVolume[]",             0,          ZTID_VOID,   AUDIOVOLUME,      FL_DEPR,  { ZTID_AUDIO, ZTID_FLOAT, ZTID_FLOAT },{} },
 
@@ -230,7 +230,7 @@ void AudioSymbols::generateCode()
 	}
 	//int32_t GetEnhancedMusicPos(game)
 {
-		Function* function = getFunction("GetOggPos");
+		Function* function = getFunction("GetMusicPos");
 		int32_t label = function->getLabel();
 		vector<shared_ptr<Opcode>> code;
 		//pop pointer, and ignore it
@@ -242,7 +242,7 @@ void AudioSymbols::generateCode()
 }
 	 //void SetEnhancedMusicPos(game, int32_t)
 	{
-		Function* function = getFunction("SetOggPos");
+		Function* function = getFunction("SetMusicPos");
 		int32_t label = function->getLabel();
 		vector<shared_ptr<Opcode>> code;
 		//pop off the params
@@ -256,7 +256,7 @@ void AudioSymbols::generateCode()
 	}
 	//void SetEnhancedMusicSpeed(game, int32_t)
 	{
-		Function* function = getFunction("SetOggSpeed");
+		Function* function = getFunction("SetMusicSpeed");
 		int32_t label = function->getLabel();
 		vector<shared_ptr<Opcode>> code;
 		//pop off the params

src/zc/ffscript.cpp

@@ -29523,43 +29523,23 @@ void do_enh_music(bool v)
 	}
 }
 
-void FFScript::do_playogg_ex(const bool v)
+void FFScript::do_set_music_position(const bool v)
 {
-	int32_t arrayptr = SH::get_arg(sarg1, v) / 10000;
-	int32_t track = (SH::get_arg(sarg2, v) / 10000)-1;
-	
-	if(arrayptr == 0)
-		music_stop();
-	else // Pointer to a string..
-	{
-		string filename_str;
-		char filename_char[256];
-		bool ret;
-		ArrayH::getString(arrayptr, filename_str, 256);
-		strncpy(filename_char, filename_str.c_str(), 255);
-		filename_char[255]='\0';
-		ret=try_zcmusic_ex(filename_char, track, -1000);
-		set_register(sarg2, ret ? 10000 : 0);
-	}
-}
-
-void FFScript::do_set_oggex_position(const bool v)
-{
-	int32_t newposition = SH::get_arg(sarg1, v) / 10;
+	int32_t newposition = SH::get_arg(sarg1, v);
 
 	set_zcmusicpos(newposition);
 }
 
-void FFScript::go_get_oggex_position()
+void FFScript::do_get_music_position()
 {
-	int32_t pos = get_zcmusicpos()*10;
+	int32_t pos = get_zcmusicpos();
 	// zprint("ZC OGG Position is %d\n", pos);
 	set_register(sarg1, pos);
 }
 
-void FFScript::do_set_oggex_speed(const bool v)
+void FFScript::do_set_music_speed(const bool v)
 {
-	int32_t newspeed = SH::get_arg(sarg1, v) / 10;
+	int32_t newspeed = SH::get_arg(sarg1, v);
 
 	set_zcmusicspeed(newspeed);
 }
@@ -34258,19 +34238,20 @@ int32_t run_script_int(bool is_jitted)
 			}
 
 			case PLAYENHMUSICEX:
-				FFCore.do_playogg_ex(false);
+				// DEPRECATED
+				do_enh_music(false);
 				break;
 
 			case GETENHMUSICPOS:
-				FFCore.go_get_oggex_position();
+				FFCore.do_get_music_position();
 				break;
 
 			case SETENHMUSICPOS:
-				FFCore.do_set_oggex_position(false);
+				FFCore.do_set_music_position(false);
 				break;
 
 			case SETENHMUSICSPEED:
-				FFCore.do_set_oggex_speed(false);
+				FFCore.do_set_music_speed(false);
 				break;
 
 			case DIREXISTS:

src/zc/ffscript.h

@@ -1209,10 +1209,9 @@ void do_isvalidbitmap();
 void do_isallocatedbitmap();
 
 //OGG Ex --dimi
-void do_playogg_ex(const bool v);
-void do_set_oggex_position(const bool v);
-void go_get_oggex_position();
-void do_set_oggex_speed(const bool v);
+void do_set_music_position(const bool v);
+void do_get_music_position();
+void do_set_music_speed(const bool v);
 
 BITMAP* GetScriptBitmap(int32_t id, bool skipError = false);
 

src/zc/zc_sys.cpp

@@ -8157,8 +8157,7 @@ void set_zcmusicpos(int32_t position)
 
 void set_zcmusicspeed(int32_t speed)
 {
-	int32_t newspeed = vbound(speed, 0, 10000);
-	zcmusic_set_speed(zcmusic, newspeed);
+	zcmusic_set_speed(zcmusic, speed);
 }
 
 void jukebox(int32_t index,int32_t loop)