2009-02-16 01:37:42 +01:00
|
|
|
/*
|
2017-01-03 20:48:59 +01:00
|
|
|
* Copyright 2003-2017 The Music Player Daemon Project
|
2009-02-16 01:37:42 +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.
|
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.
|
2009-02-16 01:37:42 +01:00
|
|
|
*/
|
|
|
|
|
2013-04-17 01:12:05 +02:00
|
|
|
#ifndef MPD_OUTPUT_PLUGIN_HXX
|
|
|
|
#define MPD_OUTPUT_PLUGIN_HXX
|
2009-02-16 01:37:42 +01:00
|
|
|
|
2013-10-15 09:21:13 +02:00
|
|
|
#include "Compiler.h"
|
2012-08-02 18:20:46 +02:00
|
|
|
|
2016-12-28 21:44:18 +01:00
|
|
|
#include <chrono>
|
|
|
|
|
2009-02-16 01:37:42 +01:00
|
|
|
#include <stddef.h>
|
|
|
|
|
2015-01-21 22:13:44 +01:00
|
|
|
struct ConfigBlock;
|
2013-08-03 21:00:50 +02:00
|
|
|
struct AudioFormat;
|
2013-07-30 20:11:57 +02:00
|
|
|
struct Tag;
|
2014-01-28 11:34:09 +01:00
|
|
|
struct AudioOutput;
|
2014-02-05 17:22:34 +01:00
|
|
|
struct MixerPlugin;
|
2017-01-25 09:47:43 +01:00
|
|
|
class EventLoop;
|
2009-02-16 01:37:42 +01:00
|
|
|
|
|
|
|
/**
|
|
|
|
* A plugin which controls an audio output device.
|
|
|
|
*/
|
2014-01-28 11:22:27 +01:00
|
|
|
struct AudioOutputPlugin {
|
2009-02-16 01:37:42 +01:00
|
|
|
/**
|
|
|
|
* the plugin's name
|
|
|
|
*/
|
|
|
|
const char *name;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Test if this plugin can provide a default output, in case
|
|
|
|
* none has been configured. This method is optional.
|
|
|
|
*/
|
2015-03-03 20:05:08 +01:00
|
|
|
bool (*test_default_device)();
|
2009-02-16 01:37:42 +01:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Configure and initialize the device, but do not open it
|
|
|
|
* yet.
|
|
|
|
*
|
2016-10-28 21:11:52 +02:00
|
|
|
* Throws #std::runtime_error on error.
|
|
|
|
*
|
2013-10-19 18:19:03 +02:00
|
|
|
* @param param the configuration section, or nullptr if there is
|
2009-02-16 01:37:42 +01:00
|
|
|
* no configuration
|
|
|
|
*/
|
2017-01-25 09:47:43 +01:00
|
|
|
AudioOutput *(*init)(EventLoop &event_loop, const ConfigBlock &block);
|
2009-02-16 01:37:42 +01:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Free resources allocated by this device.
|
|
|
|
*/
|
2014-01-28 11:34:09 +01:00
|
|
|
void (*finish)(AudioOutput *data);
|
2009-02-16 01:37:42 +01:00
|
|
|
|
2009-10-23 10:55:52 +02:00
|
|
|
/**
|
|
|
|
* Enable the device. This may allocate resources, preparing
|
2016-10-28 21:09:22 +02:00
|
|
|
* for the device to be opened.
|
2009-10-23 10:55:52 +02:00
|
|
|
*
|
2016-10-28 20:33:57 +02:00
|
|
|
* Throws #std::runtime_error on error.
|
2009-10-23 10:55:52 +02:00
|
|
|
*/
|
2016-11-09 11:56:01 +01:00
|
|
|
void (*enable)(AudioOutput *data);
|
2009-10-23 10:55:52 +02:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Disables the device. It is closed before this method is
|
|
|
|
* called.
|
|
|
|
*/
|
2014-01-28 11:34:09 +01:00
|
|
|
void (*disable)(AudioOutput *data);
|
2009-10-23 10:55:52 +02:00
|
|
|
|
2009-02-16 01:37:42 +01:00
|
|
|
/**
|
|
|
|
* Really open the device.
|
2009-02-26 22:04:59 +01:00
|
|
|
*
|
2016-10-28 20:33:57 +02:00
|
|
|
* Throws #std::runtime_error on error.
|
|
|
|
*
|
2009-02-16 01:37:42 +01:00
|
|
|
* @param audio_format the audio format in which data is going
|
|
|
|
* to be delivered; may be modified by the plugin
|
|
|
|
*/
|
2016-11-09 11:56:01 +01:00
|
|
|
void (*open)(AudioOutput *data, AudioFormat &audio_format);
|
2009-02-16 01:37:42 +01:00
|
|
|
|
2009-02-16 01:38:09 +01:00
|
|
|
/**
|
|
|
|
* Close the device.
|
|
|
|
*/
|
2014-01-28 11:34:09 +01:00
|
|
|
void (*close)(AudioOutput *data);
|
2009-02-16 01:38:09 +01:00
|
|
|
|
2010-11-05 08:02:38 +01:00
|
|
|
/**
|
2016-09-19 18:53:40 +02:00
|
|
|
* Returns a positive number if the output thread shall further
|
|
|
|
* delay the next call to play() or pause(), which will happen
|
|
|
|
* until this function returns 0. This should be implemented
|
2016-10-28 21:09:22 +02:00
|
|
|
* instead of doing a sleep inside the plugin, because this
|
2016-09-19 18:53:40 +02:00
|
|
|
* allows MPD to listen to commands meanwhile.
|
2010-11-05 08:02:38 +01:00
|
|
|
*
|
2016-12-28 21:44:18 +01:00
|
|
|
* @return the duration to wait
|
2010-11-05 08:02:38 +01:00
|
|
|
*/
|
2016-12-28 21:44:18 +01:00
|
|
|
std::chrono::steady_clock::duration (*delay)(AudioOutput *data);
|
2010-11-05 08:02:38 +01:00
|
|
|
|
2009-02-16 01:38:09 +01:00
|
|
|
/**
|
|
|
|
* Display metadata for the next chunk. Optional method,
|
|
|
|
* because not all devices can display metadata.
|
|
|
|
*/
|
2014-12-26 22:27:01 +01:00
|
|
|
void (*send_tag)(AudioOutput *data, const Tag &tag);
|
2009-02-16 01:38:09 +01:00
|
|
|
|
2009-02-16 01:37:42 +01:00
|
|
|
/**
|
|
|
|
* Play a chunk of audio data.
|
2009-02-23 09:29:56 +01:00
|
|
|
*
|
2016-10-28 20:33:57 +02:00
|
|
|
* Throws #std::runtime_error on error.
|
|
|
|
*
|
2016-11-09 11:56:01 +01:00
|
|
|
* @return the number of bytes played
|
2009-02-16 01:37:42 +01:00
|
|
|
*/
|
2014-01-28 11:34:09 +01:00
|
|
|
size_t (*play)(AudioOutput *data,
|
2016-11-09 11:56:01 +01:00
|
|
|
const void *chunk, size_t size);
|
2009-02-16 01:37:42 +01:00
|
|
|
|
2009-10-29 15:59:40 +01:00
|
|
|
/**
|
|
|
|
* Wait until the device has finished playing.
|
|
|
|
*/
|
2014-01-28 11:34:09 +01:00
|
|
|
void (*drain)(AudioOutput *data);
|
2009-10-29 15:59:40 +01:00
|
|
|
|
2009-02-16 01:38:09 +01:00
|
|
|
/**
|
|
|
|
* Try to cancel data which may still be in the device's
|
|
|
|
* buffers.
|
|
|
|
*/
|
2014-01-28 11:34:09 +01:00
|
|
|
void (*cancel)(AudioOutput *data);
|
2009-02-16 01:38:09 +01:00
|
|
|
|
2009-02-16 01:37:42 +01:00
|
|
|
/**
|
|
|
|
* Pause the device. If supported, it may perform a special
|
|
|
|
* action, which keeps the device open, but does not play
|
|
|
|
* anything. Output plugins like "shout" might want to play
|
|
|
|
* silence during pause, so their clients won't be
|
|
|
|
* disconnected. Plugins which do not support pausing will
|
|
|
|
* simply be closed, and have to be reopened when unpaused.
|
|
|
|
*
|
2016-10-28 21:09:22 +02:00
|
|
|
* @return false on error (output will be closed by caller),
|
|
|
|
* true for continue to pause
|
2009-02-16 01:37:42 +01:00
|
|
|
*/
|
2014-01-28 11:34:09 +01:00
|
|
|
bool (*pause)(AudioOutput *data);
|
2009-03-26 18:23:23 +01:00
|
|
|
|
|
|
|
/**
|
|
|
|
* The mixer plugin associated with this output plugin. This
|
2013-10-19 18:19:03 +02:00
|
|
|
* may be nullptr if no mixer plugin is implemented. When
|
2016-10-28 11:38:37 +02:00
|
|
|
* created, this mixer plugin gets the same #ConfigParam as
|
2009-03-26 18:23:23 +01:00
|
|
|
* this audio output device.
|
|
|
|
*/
|
2014-02-05 17:22:34 +01:00
|
|
|
const MixerPlugin *mixer_plugin;
|
2009-02-16 01:37:42 +01:00
|
|
|
};
|
|
|
|
|
2009-02-16 01:38:10 +01:00
|
|
|
static inline bool
|
2014-01-28 11:22:27 +01:00
|
|
|
ao_plugin_test_default_device(const AudioOutputPlugin *plugin)
|
2009-02-16 01:38:10 +01:00
|
|
|
{
|
2013-10-19 18:19:03 +02:00
|
|
|
return plugin->test_default_device != nullptr
|
2009-02-16 01:38:10 +01:00
|
|
|
? plugin->test_default_device()
|
|
|
|
: false;
|
|
|
|
}
|
|
|
|
|
2012-08-02 18:15:49 +02:00
|
|
|
gcc_malloc
|
2014-01-28 11:34:09 +01:00
|
|
|
AudioOutput *
|
2017-01-25 09:47:43 +01:00
|
|
|
ao_plugin_init(EventLoop &event_loop,
|
|
|
|
const AudioOutputPlugin &plugin,
|
2016-11-09 11:56:01 +01:00
|
|
|
const ConfigBlock &block);
|
2009-02-16 01:38:10 +01:00
|
|
|
|
2011-09-16 23:31:48 +02:00
|
|
|
void
|
2014-01-28 11:34:09 +01:00
|
|
|
ao_plugin_finish(AudioOutput *ao);
|
2009-02-16 01:38:10 +01:00
|
|
|
|
2016-11-09 11:56:01 +01:00
|
|
|
void
|
2017-01-25 09:48:59 +01:00
|
|
|
ao_plugin_enable(AudioOutput &ao);
|
2009-10-23 10:55:52 +02:00
|
|
|
|
2011-09-16 23:31:48 +02:00
|
|
|
void
|
2017-01-25 09:48:59 +01:00
|
|
|
ao_plugin_disable(AudioOutput &ao);
|
2009-10-23 10:55:52 +02:00
|
|
|
|
2016-11-09 11:56:01 +01:00
|
|
|
void
|
2017-01-25 09:48:59 +01:00
|
|
|
ao_plugin_open(AudioOutput &ao, AudioFormat &audio_format);
|
2009-02-16 01:38:10 +01:00
|
|
|
|
2011-09-16 23:31:48 +02:00
|
|
|
void
|
2017-01-25 09:48:59 +01:00
|
|
|
ao_plugin_close(AudioOutput &ao);
|
2009-02-16 01:38:10 +01:00
|
|
|
|
2012-08-02 18:15:49 +02:00
|
|
|
gcc_pure
|
2016-12-28 21:44:18 +01:00
|
|
|
std::chrono::steady_clock::duration
|
2017-01-25 09:48:59 +01:00
|
|
|
ao_plugin_delay(AudioOutput &ao);
|
2010-11-05 08:02:38 +01:00
|
|
|
|
2011-09-16 23:31:48 +02:00
|
|
|
void
|
2017-01-25 09:48:59 +01:00
|
|
|
ao_plugin_send_tag(AudioOutput &ao, const Tag &tag);
|
2009-02-16 01:38:10 +01:00
|
|
|
|
2011-09-16 23:31:48 +02:00
|
|
|
size_t
|
2017-01-25 09:48:59 +01:00
|
|
|
ao_plugin_play(AudioOutput &ao, const void *chunk, size_t size);
|
2009-02-16 01:38:10 +01:00
|
|
|
|
2011-09-16 23:31:48 +02:00
|
|
|
void
|
2017-01-25 09:48:59 +01:00
|
|
|
ao_plugin_drain(AudioOutput &ao);
|
2009-10-29 15:59:40 +01:00
|
|
|
|
2011-09-16 23:31:48 +02:00
|
|
|
void
|
2017-01-25 09:48:59 +01:00
|
|
|
ao_plugin_cancel(AudioOutput &ao);
|
2009-02-16 01:38:10 +01:00
|
|
|
|
2011-09-16 23:31:48 +02:00
|
|
|
bool
|
2017-01-25 09:48:59 +01:00
|
|
|
ao_plugin_pause(AudioOutput &ao);
|
2009-02-16 01:38:10 +01:00
|
|
|
|
2009-02-16 01:37:42 +01:00
|
|
|
#endif
|