sound Namespace Reference

Audio output for sound and music. More...

Classes
struct	driver_status
class	music_thinker
class	music_muter
class	music_track
	Internal representation of music tracks. More...

Enumerations
enum	channel_group {   NULL_CHANNEL = -1 , SOUND_SOURCES = 0 , SOUND_BELL , SOUND_TIMER ,   SOUND_UI , SOUND_FX }

Functions
void	flush_cache ()
utils::optional< unsigned int >	get_current_track_index ()
std::shared_ptr< music_track >	get_current_track ()
std::shared_ptr< music_track >	get_previous_music_track ()
void	set_previous_track (std::shared_ptr< music_track > track)
unsigned int	get_num_tracks ()
std::shared_ptr< music_track >	get_track (unsigned int i)
void	set_track (unsigned int i, const std::shared_ptr< music_track > &to)
void	remove_track (unsigned int i)
static void	channel_finished_hook (int channel)
std::string	current_driver ()
std::vector< std::string >	enumerate_drivers ()
bool	init_sound ()
void	close_sound ()
void	reset_sound ()
void	stop_music ()
void	stop_sound ()
void	stop_bell ()
void	stop_UI_sound ()
void	play_music_once (const std::string &file)
void	empty_playlist ()
void	play_music ()
void	play_track (unsigned int i)
static void	play_new_music ()
void	play_music_repeatedly (const std::string &id)
void	play_music_config (const config &music_node, bool allow_interrupt_current_track, int i)
void	commit_music_changes ()
void	write_music_play_list (config &snapshot)
void	reposition_sound (int id, unsigned int distance)
bool	is_sound_playing (int id)
void	stop_sound (int id)
void	play_sound (const std::string &files, channel_group group, unsigned int repeats)
void	play_sound_positioned (const std::string &files, int id, int repeats, unsigned int distance)
void	play_bell (const std::string &files)
void	play_timer (const std::string &files, const std::chrono::milliseconds &loop_ticks, const std::chrono::milliseconds &fadein_ticks)
void	play_UI_sound (const std::string &files)
int	get_music_volume ()
void	set_music_volume (int vol)
int	get_sound_volume ()
void	set_sound_volume (int vol)
void	set_bell_volume (int vol)
void	set_UI_volume (int vol)

Variables
static std::vector< Mix_Chunk * >	channel_chunks
static std::vector< int >	channel_ids

Detailed Description

Audio output for sound and music.

This module provides the ability to play music and sounds. Setting music volume to 0 will stop the music.

Enumeration Type Documentation

channel_group

enum sound::channel_group

Enumerator
NULL_CHANNEL
SOUND_SOURCES
SOUND_BELL
SOUND_TIMER
SOUND_UI
SOUND_FX

Definition at line 28 of file sound.hpp.

Function Documentation

channel_finished_hook()

static void sound::channel_finished_hook ( int  channel )

static

Definition at line 406 of file sound.cpp.

References channel_chunks, and channel_ids.

Referenced by init_sound().

close_sound()

void sound::close_sound

(

)

Definition at line 495 of file sound.cpp.

References ERR_AUDIO, LOG_AUDIO, stop_bell(), stop_music(), stop_sound(), and stop_UI_sound().

Referenced by reset_sound(), prefs::set_music(), prefs::set_sound(), prefs::set_turn_bell(), prefs::set_ui_sound(), and game_launcher::~game_launcher().

commit_music_changes()

void sound::commit_music_changes

(

)

Definition at line 842 of file sound.cpp.

References choose_track(), play_music(), and set_previous_track().

Referenced by game_events::event_handler::handle_event(), intf_music_commit(), and playsingle_controller::play_scenario().

current_driver()

std::string sound::current_driver

(

)

Definition at line 412 of file sound.cpp.

empty_playlist()

void sound::empty_playlist

(

)

Definition at line 612 of file sound.cpp.

Referenced by playsingle_controller::do_end_level(), do_gameloop(), intf_music_clear(), and campaign_controller::play_game().

enumerate_drivers()

std::vector< std::string > sound::enumerate_drivers

(

)

Definition at line 418 of file sound.cpp.

References n.

flush_cache()

void sound::flush_cache

(

)

Definition at line 195 of file sound.cpp.

Referenced by game_launcher::change_language(), events::console_handler::do_refresh(), and game_config_manager::reload_changed_game_config().

get_current_track()

std::shared_ptr< sound::music_track > sound::get_current_track

(

)

Definition at line 208 of file sound.cpp.

Referenced by impl_music_get().

get_current_track_index()

utils::optional< unsigned int > sound::get_current_track_index

(

)

Definition at line 201 of file sound.cpp.

Referenced by impl_music_get().

get_music_volume()

int sound::get_music_volume

(

)

Definition at line 1084 of file sound.cpp.

Referenced by impl_music_get().

get_num_tracks()

unsigned int sound::get_num_tracks

(

)

Definition at line 221 of file sound.cpp.

Referenced by impl_music_len(), impl_music_set(), and intf_music_next().

get_previous_music_track()

std::shared_ptr< sound::music_track > sound::get_previous_music_track

(

)

Definition at line 212 of file sound.cpp.

Referenced by impl_music_get().

get_sound_volume()

int sound::get_sound_volume

(

)

Definition at line 1104 of file sound.cpp.

Referenced by impl_audio_get().

get_track()

std::shared_ptr< music_track > sound::get_track

(

unsigned int

i

)

Definition at line 226 of file sound.cpp.

References i.

init_sound()

bool sound::init_sound

(

)

Definition at line 443 of file sound.cpp.

References gui2::dialogs::bell_volume(), channel_chunks, channel_finished_hook(), channel_ids, DBG_AUDIO, ERR_AUDIO, prefs::get(), LOG_AUDIO, gui2::dialogs::music_volume(), play_music(), set_bell_volume(), set_music_volume(), set_sound_volume(), set_UI_volume(), SOUND_BELL, SOUND_FX, SOUND_SOURCES, SOUND_TIMER, SOUND_UI, gui2::dialogs::sound_volume(), and gui2::dialogs::ui_volume().

Referenced by game_launcher::game_launcher(), reset_sound(), prefs::set_music(), prefs::set_sound(), prefs::set_turn_bell(), and prefs::set_ui_sound().

is_sound_playing()

bool sound::is_sound_playing

(

int

id

)

Definition at line 897 of file sound.cpp.

References channel_ids.

Referenced by soundsource::positional_source::update(), and soundsource::positional_source::update_positions().

play_bell()

void sound::play_bell

(

const std::string &

files

)

Definition at line 1061 of file sound.cpp.

References prefs::get(), SOUND_BELL, and game_config::sounds::turn_bell.

Referenced by playsingle_controller::before_human_turn(), and mp::ui_alerts::ready_for_start().

play_music()

void sound::play_music

(

)

Definition at line 617 of file sound.cpp.

Referenced by commit_music_changes(), init_sound(), play_music_config(), play_music_once(), play_music_repeatedly(), play_track(), and prefs::set_music().

play_music_config()

void sound::play_music_config	(	const config &	music_node,
		bool	allow_interrupt_current_track,
		int	i
	)

Definition at line 715 of file sound.cpp.

References sound::music_track::append(), ERR_AUDIO, sound::music_track::file_path(), i, sound::music_track::id(), sound::music_track::immediate(), play_music(), sound::music_track::play_once(), set_previous_track(), and sound::music_track::valid().

Referenced by gui2::dialogs::story_viewer::display_part(), do_gameloop(), impl_music_set(), intf_music_add(), and playsingle_controller::play_scenario().

play_music_once()

void sound::play_music_once

(

const std::string &

file

)

Definition at line 603 of file sound.cpp.

References play_music(), and set_previous_track().

Referenced by playsingle_controller::do_end_level(), editor::editor_controller::do_execute_command(), and intf_music_play().

play_music_repeatedly()

void sound::play_music_repeatedly

(

const std::string &

id

)

Definition at line 693 of file sound.cpp.

References play_music().

play_new_music()

static void sound::play_new_music ( )

static

Definition at line 641 of file sound.cpp.

References ERR_AUDIO, filename, prefs::get(), filesystem::get_localized_path(), LOG_AUDIO, filesystem::make_read_RWops(), and gui2::dialogs::music_on().

Referenced by sound::music_thinker::process().

play_sound()

void sound::play_sound	(	const std::string &	files,
		channel_group	group,
		unsigned int	repeats
	)

Definition at line 1046 of file sound.cpp.

References prefs::get(), and gui2::dialogs::sound().

Referenced by gui2::dialogs::story_viewer::display_part(), play_controller::init_side_end(), game_lua_kernel::intf_play_sound(), game_lua_kernel::intf_set_achievement(), gui2::dialogs::custom_tod::play_sound(), unit_frame::redraw(), and unit_display::unit_attack().

play_sound_positioned()

void sound::play_sound_positioned	(	const std::string &	files,
		int	id,
		int	repeats,
		unsigned int	distance
	)

Definition at line 1053 of file sound.cpp.

References prefs::get(), gui2::dialogs::sound(), and SOUND_SOURCES.

Referenced by gui2::dialogs::story_viewer::display_part(), and soundsource::positional_source::update().

play_timer()

void sound::play_timer	(	const std::string &	files,
		const std::chrono::milliseconds &	loop_ticks,
		const std::chrono::milliseconds &	fadein_ticks
	)

Definition at line 1069 of file sound.cpp.

References prefs::get(), gui2::dialogs::sound(), and SOUND_TIMER.

Referenced by countdown_clock::maybe_play_sound().

play_track()

void sound::play_track

(

unsigned int

i

)

Definition at line 629 of file sound.cpp.

References choose_track(), i, play_music(), and set_previous_track().

Referenced by impl_music_set(), and intf_music_next().

play_UI_sound()

void sound::play_UI_sound

(

const std::string &

files

)

Definition at line 1077 of file sound.cpp.

References prefs::get(), SOUND_UI, and gui2::dialogs::ui_sound_on().

Referenced by gui2::slider::child_callback_positioner_moved(), mp::ui_alerts::friend_message(), mp::ui_alerts::game_created(), mp::ui_alerts::game_has_begun(), gui::button::mouse_down(), gui::tristate_button::mouse_up(), gui::button::mouse_up(), mp::ui_alerts::player_joins(), mp::ui_alerts::player_leaves(), mp::ui_alerts::private_message(), mp::ui_alerts::public_message(), events::mouse_handler::select_hex(), mp::ui_alerts::server_message(), gui2::rich_label::signal_handler_left_button_click(), gui2::button::signal_handler_left_button_click(), gui2::menu_button::signal_handler_left_button_click(), gui2::multimenu_button::signal_handler_left_button_click(), gui2::toggle_button::signal_handler_left_button_click(), gui2::toggle_panel::signal_handler_left_button_click(), and gui2::repeating_button::signal_handler_left_button_down().

remove_track()

void sound::remove_track

(

unsigned int

i

)

Definition at line 246 of file sound.cpp.

References i.

Referenced by impl_music_set(), and intf_music_remove().

reposition_sound()

void sound::reposition_sound	(	int	id,
		unsigned int	distance
	)

Definition at line 881 of file sound.cpp.

References channel_ids, and DISTANCE_SILENT.

Referenced by stop_sound(), and soundsource::positional_source::update_positions().

reset_sound()

void sound::reset_sound

(

)

Definition at line 526 of file sound.cpp.

References close_sound(), ERR_AUDIO, prefs::get(), init_sound(), prefs::music_on(), prefs::sound(), stop_bell(), stop_music(), stop_sound(), stop_UI_sound(), prefs::turn_bell(), and prefs::ui_sound_on().

Referenced by prefs::save_sample_rate(), and prefs::save_sound_buffer_size().

set_bell_volume()

void sound::set_bell_volume

(

int

vol

)

Definition at line 1133 of file sound.cpp.

Referenced by init_sound(), and prefs::set_bell_volume().

set_music_volume()

void sound::set_music_volume

(

int

vol

)

Definition at line 1093 of file sound.cpp.

Referenced by impl_music_set(), init_sound(), and prefs::set_music_volume().

set_previous_track()

void sound::set_previous_track

(

std::shared_ptr< music_track >

track

)

Definition at line 216 of file sound.cpp.

Referenced by commit_music_changes(), play_music_config(), play_music_once(), play_track(), and sound::music_thinker::process().

set_sound_volume()

void sound::set_sound_volume

(

int

vol

)

Definition at line 1113 of file sound.cpp.

References i.

Referenced by impl_audio_set(), init_sound(), and prefs::set_sound_volume().

set_track()

void sound::set_track	(	unsigned int	i,
		const std::shared_ptr< music_track > &	to
	)

Definition at line 239 of file sound.cpp.

References i.

Referenced by impl_music_set().

set_UI_volume()

void sound::set_UI_volume

(

int

vol

)

Definition at line 1145 of file sound.cpp.

References i.

Referenced by init_sound(), and prefs::set_ui_volume().

stop_bell()

void sound::stop_bell

(

)

Definition at line 580 of file sound.cpp.

References c, SOUND_BELL, and SOUND_TIMER.

Referenced by close_sound(), reset_sound(), prefs::set_turn_bell(), and countdown_clock::~countdown_clock().

stop_music()

void sound::stop_music

(

)

Definition at line 557 of file sound.cpp.

Referenced by close_sound(), do_gameloop(), reset_sound(), and prefs::set_music().

stop_sound() [1/2]

void sound::stop_sound

(

)

Definition at line 565 of file sound.cpp.

References c, SOUND_FX, and SOUND_SOURCES.

Referenced by gui2::dialogs::story_viewer::display_part(), reset_sound(), prefs::set_sound(), and soundsource::positional_source::~positional_source().

stop_sound() [2/2]

void sound::stop_sound

(

int

id

)

Definition at line 903 of file sound.cpp.

References DISTANCE_SILENT, and reposition_sound().

Referenced by close_sound().

stop_UI_sound()

void sound::stop_UI_sound

(

)

Definition at line 592 of file sound.cpp.

References c, and SOUND_UI.

Referenced by close_sound(), reset_sound(), and prefs::set_ui_sound().

write_music_play_list()

void sound::write_music_play_list

(

config &

snapshot

)

Definition at line 871 of file sound.cpp.

Referenced by impl_music_get(), and play_controller::to_config().

Variable Documentation

channel_chunks

std::vector<Mix_Chunk*> sound::channel_chunks

static

Definition at line 43 of file sound.cpp.

Referenced by channel_finished_hook(), and init_sound().

channel_ids

std::vector<int> sound::channel_ids

static

Definition at line 47 of file sound.cpp.

Referenced by channel_finished_hook(), init_sound(), is_sound_playing(), and reposition_sound().