src/music.h

   1 /***************************************
   2 ** Tsunagari Tile Engine              **
   3 ** music.h                            **
   4 ** Copyright 2011-2013 PariahSoft LLC **
   5 ***************************************/
   6
   7 // **********
   8 // Permission is hereby granted, free of charge, to any person obtaining a copy
   9 // of this software and associated documentation files (the "Software"), to
  10 // deal in the Software without restriction, including without limitation the
  11 // rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
  12 // sell copies of the Software, and to permit persons to whom the Software is
  13 // furnished to do so, subject to the following conditions:
  14 //
  15 // The above copyright notice and this permission notice shall be included in
  16 // all copies or substantial portions of the Software.
  17 //
  18 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  19 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  20 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  21 // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  22 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  23 // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
  24 // IN THE SOFTWARE.
  25 // **********
  26
  27 #ifndef MUSIC_H
  28 #define MUSIC_H
  29
  30 #include <Gosu/Audio.hpp> // for Gosu::SampleInstance
  31
  32 #include <memory>
  33 #include <string>
  34
  35 #include "cache-template.cpp"
  36 #include "readercache.h"
  37
  38 /**
  39  * State manager for currently playing music. Continuously controls which music
  40  * will play. At the moment, each Area has an INTRO music and a LOOP music.
  41  * Immediately upon entering an Area, the currently playing music is stopped
  42  * and the associated intro music started. Once the intro music finishes, or,
  43  * if there is no intro music, then immediately upon entering said Area, the
  44  * loop music begins. Loop music is looped forever until either the world is
  45  * exited or new music is specified, either by a script or by entering a new
  46  * Area.
  47  *
  48  * When switching to a new Area with the same intro or loop music as the
  49  * previous Area, the music is left alone, if possible.
  50  */
  51 class Music
  52 {
  53 public:
  54         Music();
  55         ~Music();
  56
  57         std::string getIntro();
  58         std::string getLoop();
  59
  60         void setIntro(const std::string& filename);
  61         void setLoop(const std::string& filename);
  62
  63         int getVolume();
  64         void setVolume(int level);
  65
  66         bool isPaused();
  67         void setPaused(bool p);
  68
  69         void stop();
  70
  71         void tick();
  72
  73         typedef std::shared_ptr<Gosu::Song> SongRef;
  74
  75 private:
  76         enum MUSIC_STATE
  77         {
  78                 NOT_PLAYING,
  79                 PLAYING_INTRO,
  80                 PLAYING_LOOP,
  81                 CHANGED_INTRO,
  82                 CHANGED_LOOP
  83         };
  84
  85         void setState(MUSIC_STATE state_);
  86         void playIntro();
  87         void playLoop();
  88
  89         SongRef getSong(const std::string& name);
  90
  91         ReaderCache<SongRef> songs;
  92
  93         SongRef musicInst, introMusic, loopMusic;
  94
  95         bool paused;
  96
  97         MUSIC_STATE state;
  98
  99         std::string newIntro;
 100         std::string newLoop;
 101         std::string curIntro;
 102         std::string curLoop;
 103 };
 104
 105 //! Register Music with Python.
 106 void exportMusic();
 107
 108 #endif
 109