# music.cpp

Go to the documentation of this file.

    00001 /* $Id: music.cpp 23214 2011-11-14 19:24:22Z rubidium $ */
    00002
    00003 /*
    00004  * This file is part of OpenTTD.
    00005  * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
    00006  * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
    00007  * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
    00008  */
    00009
    00012 #include "stdafx.h"
    00013
    00015 #define SET_TYPE "music"
    00016 #include "base_media_func.h"
    00017
    00018 INSTANTIATE_BASE_MEDIA_METHODS(BaseMedia<MusicSet>, MusicSet)
    00019
    00020
    00021 static const char * const _music_file_names[] = {
    00022   "theme",
    00023   "old_0", "old_1", "old_2", "old_3", "old_4", "old_5", "old_6", "old_7", "old_8", "old_9",
    00024   "new_0", "new_1", "new_2", "new_3", "new_4", "new_5", "new_6", "new_7", "new_8", "new_9",
    00025   "ezy_0", "ezy_1", "ezy_2", "ezy_3", "ezy_4", "ezy_5", "ezy_6", "ezy_7", "ezy_8", "ezy_9",
    00026 };
    00028 assert_compile(lengthof(_music_file_names) == NUM_SONGS_AVAILABLE);
    00029
    00030 template <class T, size_t Tnum_files, bool Tsearch_in_tars>
    00031 /* static */ const char * const *BaseSet<T, Tnum_files, Tsearch_in_tars>::file_names = _music_file_names;
    00032
    00033 template <class Tbase_set>
    00034 /* static */ const char *BaseMedia<Tbase_set>::GetExtension()
    00035 {
    00036   return ".obm"; // OpenTTD Base Music
    00037 }
    00038
    00039 template <class Tbase_set>
    00040 /* static */ bool BaseMedia<Tbase_set>::DetermineBestSet()
    00041 {
    00042   if (BaseMedia<Tbase_set>::used_set != NULL) return true;
    00043
    00044   const Tbase_set *best = NULL;
    00045   for (const Tbase_set *c = BaseMedia<Tbase_set>::available_sets; c != NULL; c = c->next) {
    00046     if (c->GetNumMissing() != 0) continue;
    00047
    00048     if (best == NULL ||
    00049         (best->fallback && !c->fallback) ||
    00050         best->valid_files < c->valid_files ||
    00051         (best->valid_files == c->valid_files &&
    00052           (best->shortname == c->shortname && best->version < c->version))) {
    00053       best = c;
    00054     }
    00055   }
    00056
    00057   BaseMedia<Tbase_set>::used_set = best;
    00058   return BaseMedia<Tbase_set>::used_set != NULL;
    00059 }
    00060
    00061 bool MusicSet::FillSetDetails(IniFile *ini, const char *path, const char *full_filename)
    00062 {
    00063   bool ret = this->BaseSet<MusicSet, NUM_SONGS_AVAILABLE, false>::FillSetDetails(ini, path, full_filename);
    00064   if (ret) {
    00065     this->num_available = 0;
    00066     IniGroup *names = ini->GetGroup("names");
    00067     for (uint i = 0, j = 1; i < lengthof(this->song_name); i++) {
    00068       const char *filename = this->files[i].filename;
    00069       if (names == NULL || StrEmpty(filename)) {
    00070         this->song_name[i][0] = '\0';
    00071         continue;
    00072       }
    00073
    00074       IniItem *item = NULL;
    00075       /* As we possibly add a path to the filename and we compare
    00076        * on the filename with the path as in the .obm, we need to
    00077        * keep stripping path elements until we find a match. */
    00078       for (const char *p = filename; p != NULL; p = strchr(p, PATHSEPCHAR)) {
    00079         /* Remove possible double path separator characters from
    00080          * the beginning, so we don't start reading e.g. root. */
    00081         while (*p == PATHSEPCHAR) p++;
    00082
    00083         item = names->GetItem(p, false);
    00084         if (item != NULL && !StrEmpty(item->value)) break;
    00085       }
    00086
    00087       if (item == NULL || StrEmpty(item->value)) {
    00088         DEBUG(grf, 0, "Base music set song name missing: %s", filename);
    00089         return false;
    00090       }
    00091
    00092       strecpy(this->song_name[i], item->value, lastof(this->song_name[i]));
    00093       this->track_nr[i] = j++;
    00094       this->num_available++;
    00095     }
    00096   }
    00097   return ret;
    00098 }