Merge lp:~widelands-dev/widelands/previous_song_exclusion into lp:widelands

[ypopezios]

- Changed current_song_ from iterator into simple index.
- Changed calculation of random song to exclude current_song_ from the possible results.
- Unified handling of random and linear selection.

[bunnybot (widelandsofficial)]

Continuous integration builds have changed state:

Travis build 3581. State: failed. Details: https://travis-ci.org/widelands/widelands/builds/387978432.
Appveyor build 3384. State: failed. Details: https://ci.appveyor.com/project/widelands-dev/widelands/build/_widelands_dev_widelands_previous_song_exclusion-3384.

[GunChleoc (gunchleoc)]

Code LGTM, not tested

review: Approve

[bunnybot (widelandsofficial)]

Continuous integration builds have changed state:

Travis build 3585. State: errored. Details: https://travis-ci.org/widelands/widelands/builds/388279254.
Appveyor build 3388. State: failed. Details: https://ci.appveyor.com/project/widelands-dev/widelands/build/_widelands_dev_widelands_previous_song_exclusion-3388.

[GunChleoc (gunchleoc)]

Tested, thanks for the patch!

The Travis failure is caused by a problem in trunk, so I'm gonna force a merge

@bunnybot merge force

=== modified file 'src/sound/songset.cc'
--- src/sound/songset.cc	2018-04-07 16:59:00 +0000
+++ src/sound/songset.cc	2018-06-05 13:11:10 +0000
@@ -51,7 +51,7 @@
  */
 void Songset::add_song(const std::string& filename) {
 	songs_.push_back(filename);
-	current_song_ = songs_.begin();
+	current_song_ = 0;
 }
 
 /** Get a song from the songset. Depending on
@@ -66,14 +66,16 @@
 	if (g_sound_handler.get_disable_music() || songs_.empty())
 		return nullptr;
 
-	if (g_sound_handler.random_order_)
-		filename = songs_.at(g_sound_handler.rng_.rand() % songs_.size());
-	else {
-		if (current_song_ == songs_.end())
-			current_song_ = songs_.begin();
-
-		filename = *(current_song_++);
+	if (songs_.size() > 1) {
+		if (g_sound_handler.random_order_) {
+			// exclude current_song from playing two times in a row
+			current_song_ += 1 + g_sound_handler.rng_.rand() % (songs_.size() - 1);
+		} else {
+			++current_song_;
+		}
+    	current_song_ = current_song_ % songs_.size();
 	}
+	filename = songs_.at(current_song_);
 
 	// First, close the previous song and remove it from memory
 	if (m_) {

=== modified file 'src/sound/songset.h'
--- src/sound/songset.h	2018-04-07 16:59:00 +0000
+++ src/sound/songset.h	2018-06-05 13:11:10 +0000
@@ -53,10 +53,10 @@
 	/// The filenames of all configured songs
 	std::vector<std::string> songs_;
 
-	/** Pointer to the song that is currently playing (actually the one that
-	 * was last started); needed for linear playback
+	/** Index of the song that is currently playing
+	 * (actually the one that was last started)
 	 */
-	std::vector<std::string>::iterator current_song_;
+	uint32_t current_song_;
 
 	/// The current song
 	Mix_Music* m_;