From f87c9f83b400e55ef8a11d2bd3bae47215ab6923 Mon Sep 17 00:00:00 2001
From: sigatrev <vertagis@gmail.com>
Date: Sat, 19 Jul 2014 15:03:54 -0500
Subject: [PATCH] add SOUND:IsTimingDelayed method and fixed
 SOUND:PlayMusicPart

PlayMusicPart does not immediately start the new music. IsTimingDelayed
will return true until the new music has started.

The "applyRate" argument of PlayMusicPart was being applied to the
"align_beat" property. Added an additional argument to for "align_beat"
and made "applyRate" work properly.
---
 Docs/Luadoc/Lua.xml              |  1 +
 Docs/Luadoc/LuaDocumentation.xml |  8 ++++++--
 src/GameSoundManager.cpp         | 11 +++++++++--
 3 files changed, 16 insertions(+), 4 deletions(-)

diff --git a/Docs/Luadoc/Lua.xml b/Docs/Luadoc/Lua.xml
index bc4e99d244..6009181605 100644
--- a/Docs/Luadoc/Lua.xml
+++ b/Docs/Luadoc/Lua.xml
@@ -731,6 +731,7 @@
 			<Function name='PlayMusicPart'/>
 			<Function name='PlayOnce'/>
 			<Function name='StopMusic'/>
+			<Function name='IsTimingDelayed'/>
 		</Class>
 		<Class name='GameState'>
 			<Function name='AddStageToPlayer'/>
diff --git a/Docs/Luadoc/LuaDocumentation.xml b/Docs/Luadoc/LuaDocumentation.xml
index 61886525d3..cad9107811 100644
--- a/Docs/Luadoc/LuaDocumentation.xml
+++ b/Docs/Luadoc/LuaDocumentation.xml
@@ -2190,12 +2190,13 @@ save yourself some time, copy this for undocumented things:
 	<Function name='PlayAnnouncer' return='void' arguments='string sPath'>
 		Plays a sound from the current announcer.
 	</Function>
-	<Function name='PlayMusicPart' return='void' arguments='string musicPath, float musicStart, float musicLength, float fadeIn, float fadeOut, bool loop, bool applyRate'>
+	<Function name='PlayMusicPart' return='void' arguments='string musicPath, float musicStart, float musicLength, float fadeIn, float fadeOut, bool loop, bool applyRate, bool alignBeat'>
  		Play the sound at <code>musicPath</code> starting from <code>musicStart</code> for
  		<code>musicLength</code> seconds one time. Both <code>fadeIn</code> and
 		<code>fadeOut</code> can be customized as required.  <code>loop</code>
 		tells the sound manager to loop the music part.  <code>applyRate</code>
-		tells the sound manager to apply the current music rate.
+		tells the sound manager to apply the current music rate. If <code>alignBeat</code> 
+		is true or nil, the length is automatically adjusted to cover an integer number of beats.
 	</Function>
 	<Function name='PlayOnce' return='void' arguments='string sPath'>
 		Play the sound at <code>sPath</code> one time.
@@ -2203,6 +2204,9 @@ save yourself some time, copy this for undocumented things:
 	<Function name='StopMusic' return='void' arguments='void'>
 		Stops the music.
 	</Function>
+	<Function name='IsTimingDelayed' return='void' arguments='void'>
+		When music is requested to change, the new music does not start immediately due to latency and buffering. This will return true if the newest music has not yet actually begun.
+	</Function>
 </Class>
 <Class name='GameState'>
 	<Function name='AddStageToPlayer' return='void' arguments='PlayerNumber pn'>
diff --git a/src/GameSoundManager.cpp b/src/GameSoundManager.cpp
index 18b95670cb..c9c1f33ab9 100644
--- a/src/GameSoundManager.cpp
+++ b/src/GameSoundManager.cpp
@@ -834,6 +834,7 @@ public:
 		float fadeOut = 0;
 		bool loop= false;
 		bool applyRate= false;
+		bool alignBeat= true;
 		if (lua_gettop(L) >= 4 && !lua_isnil(L,4))
 		{
 			fadeIn = FArg(4);
@@ -846,16 +847,21 @@ public:
 					if (lua_gettop(L) >= 7 && !lua_isnil(L,7))
 					{
 						applyRate = BArg(7);
+						if (lua_gettop(L) >= 8 && !lua_isnil(L,8))
+						{
+							alignBeat = BArg(8);
+						}
 					}
 				}
 			}
 		}
 		p->PlayMusic(musicPath, NULL, loop, musicStart, musicLength,
-			fadeIn, fadeOut, applyRate);
+			fadeIn, fadeOut, alignBeat, applyRate);
 		return 0;
 	}
 
-	static int StopMusic( T* p, lua_State *L ) { p->StopMusic(); return 0; }
+	static int StopMusic( T* p, lua_State *L )			{ p->StopMusic(); return 0; }
+	static int IsTimingDelayed( T* p, lua_State *L )	{ lua_pushboolean( L, g_Playing->m_bTimingDelayed ); return 1; }
 	
 	LunaGameSoundManager()
 	{
@@ -865,6 +871,7 @@ public:
 		ADD_METHOD( GetPlayerBalance );
 		ADD_METHOD( PlayMusicPart );
 		ADD_METHOD( StopMusic );
+		ADD_METHOD( IsTimingDelayed );
 	}
 };