Audio output for sound and music. More...

Classes
struct	chunk_load_exception

class	music_thinker

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
static void	play_sound_internal (const std::string &files, channel_group group, unsigned int repeats=0, unsigned int distance=0, int id=-1, int loop_ticks=0, int fadein_ticks=0)

static void	channel_finished_hook (int channel)

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 ()

static void	play_new_music ()

void	play_music_repeatedly (const std::string &id)

void	play_music_config (const config &music_node)

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_positioned (const std::string &files, int id, int repeats, unsigned int distance)

static Mix_Chunk *	load_chunk (const std::string &file, channel_group group)

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

void	play_bell (const std::string &files)

void	play_timer (const std::string &files, int loop_ticks, int fadein_ticks)

void	play_UI_sound (const std::string &files)

void	set_music_volume (int vol)

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

enum sound::channel_group

Enumerator
NULL_CHANNEL
SOUND_SOURCES
SOUND_BELL
SOUND_TIMER
SOUND_UI
SOUND_FX

Definition at line 25 of file sound.hpp.

Function Documentation

static void sound::channel_finished_hook ( int channel )

static

Definition at line 308 of file sound.cpp.

References channel_chunks, and channel_ids.

Referenced by init_sound().

void sound::close_sound ( )

Definition at line 362 of file sound.cpp.

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

Referenced by reset_sound(), preferences::set_music(), preferences::set_sound(), preferences::set_turn_bell(), preferences::set_UI_sound(), and game_launcher::~game_launcher().

void sound::commit_music_changes ( )

Definition at line 621 of file sound.cpp.

References choose_track(), and play_music().

Referenced by do_gameloop(), enter_lobby_mode(), intf_set_music(), and playsingle_controller::play_scenario().

void sound::empty_playlist ( )

Definition at line 480 of file sound.cpp.

Referenced by do_gameloop(), enter_lobby_mode(), and campaign_controller::play_game().

bool sound::init_sound ( )

bool sound::is_sound_playing ( int id )

Definition at line 678 of file sound.cpp.

References channel_ids, and gui2::event::find().

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

static Mix_Chunk* sound::load_chunk	(	const std::string &	file,
		channel_group	group
	)

static

Definition at line 698 of file sound.cpp.

References channel_chunks, ERR_AUDIO, gui2::event::find(), filesystem::get_binary_file_location(), filesystem::load_RWops(), LOG_AUDIO, and NULL_CHANNEL.

Referenced by play_sound_internal().

void sound::play_bell ( const std::string & files )

Definition at line 826 of file sound.cpp.

References play_sound_internal(), SOUND_BELL, and preferences::turn_bell().

Referenced by playsingle_controller::before_human_turn(), and mp_ui_alerts::ready_for_start().

void sound::play_music ( )

Definition at line 485 of file sound.cpp.

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

void sound::play_music_config ( const config & music_node )

Definition at line 552 of file sound.cpp.

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

Referenced by do_gameloop(), enter_lobby_mode(), intf_set_music(), and playsingle_controller::play_scenario().

void sound::play_music_once ( const std::string & file )

Definition at line 472 of file sound.cpp.

References play_music().

Referenced by editor::editor_controller::execute_command(), and playsingle_controller::play_scenario().

void sound::play_music_repeatedly ( const std::string & id )

Definition at line 536 of file sound.cpp.

References play_music().

Referenced by do_gameloop(), mp::lobby::lobby(), and storyscreen::part_ui::show().

static void sound::play_new_music ( )

static

Definition at line 493 of file sound.cpp.

References ERR_AUDIO, itor, filesystem::load_RWops(), LOG_AUDIO, and preferences::music_on().

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

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

Definition at line 818 of file sound.cpp.

References play_sound_internal(), and preferences::sound_on().

Referenced by play_controller::init_side_end(), game_lua_kernel::intf_play_sound(), unit_frame::redraw(), storyscreen::part_ui::show(), and unit_display::unit_attack().

void sound::play_sound_internal	(	const std::string &	files,
		channel_group	group,
		unsigned int	repeats = `0`,
		unsigned int	distance = `0`,
		int	id = `-1`,
		int	loop_ticks = `0`,
		int	fadein_ticks = `0`
	)