mirror of
https://github.com/wesnoth/wesnoth
synced 2025-04-28 10:38:13 +00:00
61fb097e5d
The music_track struct has been rewritten (and "promoted" to class) and music caching behavior in Wesnoth has changed a bit. This should not noticeably affect performance or be visible to users in other ways (if it is, we've got regressions). There's a hidden, disarmed core bomb in this commit. Can you find it? Formerly, the engine resolved binary paths to music files whenever it hit one in the playlist. Now it resolves the binary path when loading/editing the playlist, reducing the time it takes to play a new track by an insignificant amount of time. It will also consider a data/add-ons/foo/music/track1.ogg as a different file to data/core/music/track1.ogg as far as the music cache is concerned, since it now stores entries by real paths rather than just filenames.
100 lines
2.8 KiB
C++
100 lines
2.8 KiB
C++
/* $Id$ */
|
|
/*
|
|
Copyright (C) 2003 - 2009 by David White <dave@whitevine.net>
|
|
Part of the Battle for Wesnoth Project http://www.wesnoth.org/
|
|
|
|
This program is free software; you can redistribute it and/or modify
|
|
it under the terms of the GNU General Public License version 2
|
|
or at your option any later version.
|
|
This program is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY.
|
|
|
|
See the COPYING file for more details.
|
|
*/
|
|
#ifndef SOUND_HPP_INCLUDED
|
|
#define SOUND_HPP_INCLUDED
|
|
|
|
#include <string>
|
|
#include <vector>
|
|
#include "config.hpp"
|
|
#include "events.hpp"
|
|
|
|
namespace sound {
|
|
|
|
enum channel_group {
|
|
NULL_CHANNEL = -1,
|
|
SOUND_SOURCES = 0,
|
|
SOUND_BELL,
|
|
SOUND_TIMER,
|
|
SOUND_UI,
|
|
SOUND_FX
|
|
};
|
|
|
|
bool init_sound();
|
|
void close_sound();
|
|
void reset_sound();
|
|
|
|
void stop_music();
|
|
void stop_sound();
|
|
void stop_UI_sound();
|
|
void stop_bell();
|
|
|
|
// Read config entry, alter track list accordingly.
|
|
void play_music_config(const config &music_node);
|
|
// Act on any track list changes from above.
|
|
void commit_music_changes();
|
|
|
|
// Play this particular music file over and over and over.
|
|
void play_music_repeatedly(const std::string& id);
|
|
// Play this particular music file once, then silence.
|
|
void play_music_once(const std::string& id);
|
|
// Empty the playlist (and stop playing)
|
|
void play_no_music();
|
|
// Empty the playlist
|
|
void empty_playlist();
|
|
// Start playing current music.
|
|
void play_music();
|
|
|
|
// Change parameters of a playing sound, given its id
|
|
void reposition_sound(int id, unsigned int distance);
|
|
#define DISTANCE_SILENT 255
|
|
|
|
// Check if there's a sound associated with given id playing
|
|
bool is_sound_playing(int id);
|
|
|
|
// Stop sound associated with a given id
|
|
void stop_sound(int id);
|
|
|
|
// Play sound, or random one of comma-separated sounds.
|
|
void play_sound(const std::string& files, channel_group group = SOUND_FX, unsigned int repeats = 0);
|
|
|
|
// Play sound, or random one of comma-separated sounds. Use specified
|
|
// distance and associate it with specified id (of a sound source).
|
|
void play_sound_positioned(const std::string &files, int id, int repeats, unsigned int distance);
|
|
|
|
// Play sound, or random one of comma-separated sounds in bell channel
|
|
void play_bell(const std::string& files);
|
|
|
|
// Play sound, or random one of comma-separated sounds in timer channel
|
|
void play_timer(const std::string& files, int loop_ticks, int fadein_ticks);
|
|
|
|
// Play user-interface sound, or random one of comma-separated sounds.
|
|
void play_UI_sound(const std::string& files);
|
|
|
|
// A class to periodically check for new music that needs to be played
|
|
class music_thinker : public events::pump_monitor {
|
|
void process(events::pump_info &info);
|
|
};
|
|
|
|
// Save music playlist for snapshot
|
|
void write_music_play_list(config& snapshot);
|
|
|
|
void set_music_volume(int vol);
|
|
void set_sound_volume(int vol);
|
|
void set_bell_volume(int vol);
|
|
void set_UI_volume(int vol);
|
|
|
|
}
|
|
|
|
#endif
|