From 21c6836fe070e2ea1dc810c0b036ee952b6d2f98 Mon Sep 17 00:00:00 2001
From: Steel Titanium <steeltitanium1@gmail.com>
Date: Tue, 9 Jul 2019 00:19:21 -0400
Subject: [PATCH] Some few comments

---
 src/sdl/mixer_sound.c | 14 ++++++++++----
 1 file changed, 10 insertions(+), 4 deletions(-)

diff --git a/src/sdl/mixer_sound.c b/src/sdl/mixer_sound.c
index 8127edd605..28cedcf279 100644
--- a/src/sdl/mixer_sound.c
+++ b/src/sdl/mixer_sound.c
@@ -1116,6 +1116,12 @@ boolean I_LoadSong(char *data, size_t len)
 	size_t probesize;
 	int result;
 
+	/*
+		If the size of the data to be checked is bigger than the recommended size (> 2048)
+		Let's just set the probe size to the recommended size
+		Otherwise let's give it the full data size
+	*/
+
 	if (len > openmpt_probe_file_header_get_recommended_size())
 		probesize = openmpt_probe_file_header_get_recommended_size();
 	else
@@ -1126,7 +1132,7 @@ boolean I_LoadSong(char *data, size_t len)
 	if (result == OPENMPT_PROBE_FILE_HEADER_RESULT_SUCCESS) // We only cared if it succeeded, continue on if not.
 	{
 		openmpt_mhandle = openmpt_module_create_from_memory2(data, len, NULL, NULL, NULL, NULL, NULL, NULL, NULL);
-		if (!openmpt_mhandle)
+		if (!openmpt_mhandle) // Failed to create module handle? Show error and return!
 		{
 			mod_err = openmpt_module_error_get_last(openmpt_mhandle);
 			mod_err_str = openmpt_error_string(mod_err);
@@ -1134,10 +1140,11 @@ boolean I_LoadSong(char *data, size_t len)
 			return false;
 		}
 		else
-			return true;
+			return true; // All good and we're ready for music playback!
 	}
-#endif	
+#endif
 
+	// Let's see if Mixer is able to load this.
 	rw = SDL_RWFromMem(data, len);
 	if (rw != NULL)
 	{
@@ -1149,7 +1156,6 @@ boolean I_LoadSong(char *data, size_t len)
 		return false;
 	}
 
-
 	// Find the OGG loop point.
 	loop_point = 0.0f;
 	song_length = 0.0f;
-- 
GitLab