mpd/src/output/OutputCommand.cxx

/*
 * Copyright 2003-2016 The Music Player Daemon Project
 * http://www.musicpd.org
 *
 * This program 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; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program 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.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

/*
 * Glue functions for controlling the audio outputs over the MPD
 * protocol.  These functions perform extra validation on all
 * parameters, because they might be from an untrusted source.
 *
 */

#include "config.h"
#include "OutputCommand.hxx"
#include "MultipleOutputs.hxx"
#include "Internal.hxx"
#include "player/Control.hxx"
#include "mixer/MixerControl.hxx"
#include "mixer/Volume.hxx"
#include "Idle.hxx"

extern unsigned audio_output_state_version;

bool
audio_output_enable_index(MultipleOutputs &outputs, unsigned idx)
{
	if (idx >= outputs.Size())
		return false;

	AudioOutput &ao = outputs.Get(idx);
	if (ao.enabled)
		return true;

	ao.enabled = true;
	idle_add(IDLE_OUTPUT);

	if (ao.mixer != nullptr) {
		InvalidateHardwareVolume();
		idle_add(IDLE_MIXER);
	}

	ao.player_control->LockUpdateAudio();

	++audio_output_state_version;

	return true;
}

bool
audio_output_disable_index(MultipleOutputs &outputs, unsigned idx)
{
	if (idx >= outputs.Size())
		return false;

	AudioOutput &ao = outputs.Get(idx);
	if (!ao.enabled)
		return true;

	ao.enabled = false;
	idle_add(IDLE_OUTPUT);

	Mixer *mixer = ao.mixer;
	if (mixer != nullptr) {
		mixer_close(mixer);
		InvalidateHardwareVolume();
		idle_add(IDLE_MIXER);
	}

	ao.player_control->LockUpdateAudio();

	++audio_output_state_version;

	return true;
}

bool
audio_output_toggle_index(MultipleOutputs &outputs, unsigned idx)
{
	if (idx >= outputs.Size())
		return false;

	AudioOutput &ao = outputs.Get(idx);
	const bool enabled = ao.enabled = !ao.enabled;
	idle_add(IDLE_OUTPUT);

	if (!enabled) {
		Mixer *mixer = ao.mixer;
		if (mixer != nullptr) {
			mixer_close(mixer);
			InvalidateHardwareVolume();
			idle_add(IDLE_MIXER);
		}
	}

	ao.player_control->LockUpdateAudio();

	++audio_output_state_version;

	return true;
}
audio: moved code to output_command.c The output_command library provides a command interface to the audio outputs. It assumes the input comes from an untrusted source (i.e. the client) and verifies all parameters. 2009-02-11 18:02:45 +01:00			`/*`
update copyright year to 2016 2016-02-26 17:54:05 +01:00			`* Copyright 2003-2016 The Music Player Daemon Project`
audio: moved code to output_command.c The output_command library provides a command interface to the audio outputs. It assumes the input comes from an untrusted source (i.e. the client) and verifies all parameters. 2009-02-11 18:02:45 +01:00			`* http://www.musicpd.org`
			`*`
			`* This program 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; either version 2 of the License, or`
			`* (at your option) any later version.`
			`*`
			`* This program 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. See the`
			`* GNU General Public License for more details.`
all: Update copyright header. This updates the copyright header to all be the same, which is pretty much an update of where to mail request for a copy of the GPL and the years of the MPD project. This also puts all committers under 'The Music Player Project' umbrella. These entries should go individually in the AUTHORS file, for consistancy. 2009-03-13 18:43:16 +01:00			`*`
			`* You should have received a copy of the GNU General Public License along`
			`* with this program; if not, write to the Free Software Foundation, Inc.,`
			`* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.`
audio: moved code to output_command.c The output_command library provides a command interface to the audio outputs. It assumes the input comes from an untrusted source (i.e. the client) and verifies all parameters. 2009-02-11 18:02:45 +01:00			`*/`

			`/*`
			`* Glue functions for controlling the audio outputs over the MPD`
			`* protocol. These functions perform extra validation on all`
			`* parameters, because they might be from an untrusted source.`
			`*`
			`*/`

include config.h in all sources After we've been hit by Large File Support problems several times in the past week (which only occur on 32 bit platforms, which I don't have), this is yet another attempt to fix the issue. 2009-11-12 09:12:38 +01:00			`#include "config.h"`
output_*: convert to C++ 2013-01-04 09:46:41 +01:00			`#include "OutputCommand.hxx"`
OutputAll: convert to class, move instance to class Partition Another big chunk of code for multi-player support. 2014-01-27 08:20:25 +01:00			`#include "MultipleOutputs.hxx"`
output: rename source files 2014-01-28 11:42:54 +01:00			`#include "Internal.hxx"`
PlayerThread, ...: move to src/player/ 2015-08-15 15:55:46 +02:00			`#include "player/Control.hxx"`
Mixer*: move to mixer/ 2014-01-24 16:25:21 +01:00			`#include "mixer/MixerControl.hxx"`
output/Command: flush the mixer cache when enabling/disabling output Fixes mixer lag (http://bugs.musicpd.org/view.php?id=4425). 2015-10-26 16:29:07 +01:00			`#include "mixer/Volume.hxx"`
idle: convert to C++ 2013-01-09 08:36:52 +01:00			`#include "Idle.hxx"`
output_*: convert to C++ 2013-01-04 09:46:41 +01:00
state_file: save only if something has changed If nothing has changed since the last save, don't save the state file. Saving will spin up the hard drive, which is undesirable on hosts where MPD is idling in background. 2009-10-08 15:22:39 +02:00			`extern unsigned audio_output_state_version;`

audio: moved code to output_command.c The output_command library provides a command interface to the audio outputs. It assumes the input comes from an untrusted source (i.e. the client) and verifies all parameters. 2009-02-11 18:02:45 +01:00			`bool`
OutputAll: convert to class, move instance to class Partition Another big chunk of code for multi-player support. 2014-01-27 08:20:25 +01:00			`audio_output_enable_index(MultipleOutputs &outputs, unsigned idx)`
audio: moved code to output_command.c The output_command library provides a command interface to the audio outputs. It assumes the input comes from an untrusted source (i.e. the client) and verifies all parameters. 2009-02-11 18:02:45 +01:00			`{`
OutputAll: convert to class, move instance to class Partition Another big chunk of code for multi-player support. 2014-01-27 08:20:25 +01:00			`if (idx >= outputs.Size())`
audio: moved code to output_command.c The output_command library provides a command interface to the audio outputs. It assumes the input comes from an untrusted source (i.e. the client) and verifies all parameters. 2009-02-11 18:02:45 +01:00			`return false;`

output: rename struct audio_output to AudioOutput 2014-01-28 11:34:09 +01:00			`AudioOutput &ao = outputs.Get(idx);`
OutputAll: convert to class, move instance to class Partition Another big chunk of code for multi-player support. 2014-01-27 08:20:25 +01:00			`if (ao.enabled)`
output_plugin: added methods enable() and disable() With these methods, an output plugin can allocate some global resources only if it is actually enabled. The method enable() is called after daemonization, which allows for more sophisticated resource allocation during that method. 2009-10-23 10:55:52 +02:00			`return true;`
audio: moved code to output_command.c The output_command library provides a command interface to the audio outputs. It assumes the input comes from an untrusted source (i.e. the client) and verifies all parameters. 2009-02-11 18:02:45 +01:00
OutputAll: convert to class, move instance to class Partition Another big chunk of code for multi-player support. 2014-01-27 08:20:25 +01:00			`ao.enabled = true;`
audio: moved code to output_command.c The output_command library provides a command interface to the audio outputs. It assumes the input comes from an untrusted source (i.e. the client) and verifies all parameters. 2009-02-11 18:02:45 +01:00			`idle_add(IDLE_OUTPUT);`

output/Command: flush the mixer cache when enabling/disabling output Fixes mixer lag (http://bugs.musicpd.org/view.php?id=4425). 2015-10-26 16:29:07 +01:00			`if (ao.mixer != nullptr) {`
			`InvalidateHardwareVolume();`
			`idle_add(IDLE_MIXER);`
			`}`

player/Control: add Lock prefix to locking method names 2015-11-11 16:50:57 +01:00			`ao.player_control->LockUpdateAudio();`
output_plugin: added methods enable() and disable() With these methods, an output plugin can allocate some global resources only if it is actually enabled. The method enable() is called after daemonization, which allows for more sophisticated resource allocation during that method. 2009-10-23 10:55:52 +02:00
state_file: save only if something has changed If nothing has changed since the last save, don't save the state file. Saving will spin up the hard drive, which is undesirable on hosts where MPD is idling in background. 2009-10-08 15:22:39 +02:00			`++audio_output_state_version;`

audio: moved code to output_command.c The output_command library provides a command interface to the audio outputs. It assumes the input comes from an untrusted source (i.e. the client) and verifies all parameters. 2009-02-11 18:02:45 +01:00			`return true;`
			`}`

			`bool`
OutputAll: convert to class, move instance to class Partition Another big chunk of code for multi-player support. 2014-01-27 08:20:25 +01:00			`audio_output_disable_index(MultipleOutputs &outputs, unsigned idx)`
audio: moved code to output_command.c The output_command library provides a command interface to the audio outputs. It assumes the input comes from an untrusted source (i.e. the client) and verifies all parameters. 2009-02-11 18:02:45 +01:00			`{`
OutputAll: convert to class, move instance to class Partition Another big chunk of code for multi-player support. 2014-01-27 08:20:25 +01:00			`if (idx >= outputs.Size())`
audio: moved code to output_command.c The output_command library provides a command interface to the audio outputs. It assumes the input comes from an untrusted source (i.e. the client) and verifies all parameters. 2009-02-11 18:02:45 +01:00			`return false;`

output: rename struct audio_output to AudioOutput 2014-01-28 11:34:09 +01:00			`AudioOutput &ao = outputs.Get(idx);`
OutputAll: convert to class, move instance to class Partition Another big chunk of code for multi-player support. 2014-01-27 08:20:25 +01:00			`if (!ao.enabled)`
output_plugin: added methods enable() and disable() With these methods, an output plugin can allocate some global resources only if it is actually enabled. The method enable() is called after daemonization, which allows for more sophisticated resource allocation during that method. 2009-10-23 10:55:52 +02:00			`return true;`
audio: moved code to output_command.c The output_command library provides a command interface to the audio outputs. It assumes the input comes from an untrusted source (i.e. the client) and verifies all parameters. 2009-02-11 18:02:45 +01:00
OutputAll: convert to class, move instance to class Partition Another big chunk of code for multi-player support. 2014-01-27 08:20:25 +01:00			`ao.enabled = false;`
audio: moved code to output_command.c The output_command library provides a command interface to the audio outputs. It assumes the input comes from an untrusted source (i.e. the client) and verifies all parameters. 2009-02-11 18:02:45 +01:00			`idle_add(IDLE_OUTPUT);`

OutputAll: convert to class, move instance to class Partition Another big chunk of code for multi-player support. 2014-01-27 08:20:25 +01:00			`Mixer *mixer = ao.mixer;`
*: use nullptr instead of NULL 2013-10-19 18:19:03 +02:00			`if (mixer != nullptr) {`
mixer_control: don't touch mixers of disabled outputs When an audio output device is disabled, also disable its mixer. 2009-03-12 18:40:03 +01:00			`mixer_close(mixer);`
output/Command: flush the mixer cache when enabling/disabling output Fixes mixer lag (http://bugs.musicpd.org/view.php?id=4425). 2015-10-26 16:29:07 +01:00			`InvalidateHardwareVolume();`
mixer_control: don't touch mixers of disabled outputs When an audio output device is disabled, also disable its mixer. 2009-03-12 18:40:03 +01:00			`idle_add(IDLE_MIXER);`
			`}`

player/Control: add Lock prefix to locking method names 2015-11-11 16:50:57 +01:00			`ao.player_control->LockUpdateAudio();`
output_plugin: added methods enable() and disable() With these methods, an output plugin can allocate some global resources only if it is actually enabled. The method enable() is called after daemonization, which allows for more sophisticated resource allocation during that method. 2009-10-23 10:55:52 +02:00
state_file: save only if something has changed If nothing has changed since the last save, don't save the state file. Saving will spin up the hard drive, which is undesirable on hosts where MPD is idling in background. 2009-10-08 15:22:39 +02:00			`++audio_output_state_version;`

audio: moved code to output_command.c The output_command library provides a command interface to the audio outputs. It assumes the input comes from an untrusted source (i.e. the client) and verifies all parameters. 2009-02-11 18:02:45 +01:00			`return true;`
			`}`
Commands: new command "toggleoutput" 2013-08-04 23:20:56 +02:00
			`bool`
OutputAll: convert to class, move instance to class Partition Another big chunk of code for multi-player support. 2014-01-27 08:20:25 +01:00			`audio_output_toggle_index(MultipleOutputs &outputs, unsigned idx)`
Commands: new command "toggleoutput" 2013-08-04 23:20:56 +02:00			`{`
OutputAll: convert to class, move instance to class Partition Another big chunk of code for multi-player support. 2014-01-27 08:20:25 +01:00			`if (idx >= outputs.Size())`
Commands: new command "toggleoutput" 2013-08-04 23:20:56 +02:00			`return false;`

output: rename struct audio_output to AudioOutput 2014-01-28 11:34:09 +01:00			`AudioOutput &ao = outputs.Get(idx);`
OutputAll: convert to class, move instance to class Partition Another big chunk of code for multi-player support. 2014-01-27 08:20:25 +01:00			`const bool enabled = ao.enabled = !ao.enabled;`
Commands: new command "toggleoutput" 2013-08-04 23:20:56 +02:00			`idle_add(IDLE_OUTPUT);`

			`if (!enabled) {`
OutputAll: convert to class, move instance to class Partition Another big chunk of code for multi-player support. 2014-01-27 08:20:25 +01:00			`Mixer *mixer = ao.mixer;`
Commands: new command "toggleoutput" 2013-08-04 23:20:56 +02:00			`if (mixer != nullptr) {`
			`mixer_close(mixer);`
output/Command: flush the mixer cache when enabling/disabling output Fixes mixer lag (http://bugs.musicpd.org/view.php?id=4425). 2015-10-26 16:29:07 +01:00			`InvalidateHardwareVolume();`
Commands: new command "toggleoutput" 2013-08-04 23:20:56 +02:00			`idle_add(IDLE_MIXER);`
			`}`
			`}`

player/Control: add Lock prefix to locking method names 2015-11-11 16:50:57 +01:00			`ao.player_control->LockUpdateAudio();`
Commands: new command "toggleoutput" 2013-08-04 23:20:56 +02:00
			`++audio_output_state_version;`

			`return true;`
			`}`