2009-03-13 18:43:16 +01:00
|
|
|
/*
|
2017-01-03 20:48:59 +01:00
|
|
|
* Copyright 2003-2017 The Music Player Daemon Project
|
2009-03-13 18:43:16 +01:00
|
|
|
* http://www.musicpd.org
|
2008-09-24 07:20:55 +02:00
|
|
|
*
|
|
|
|
* 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.
|
2008-09-24 07:20:55 +02:00
|
|
|
*/
|
|
|
|
|
2013-04-17 01:12:05 +02:00
|
|
|
#ifndef MPD_OUTPUT_INTERNAL_HXX
|
|
|
|
#define MPD_OUTPUT_INTERNAL_HXX
|
2008-09-24 07:20:55 +02:00
|
|
|
|
2013-08-03 21:00:50 +02:00
|
|
|
#include "AudioFormat.hxx"
|
2016-06-22 11:15:49 +02:00
|
|
|
#include "filter/Observer.hxx"
|
2016-12-27 07:36:12 +01:00
|
|
|
|
2016-06-22 11:15:49 +02:00
|
|
|
class PreparedFilter;
|
2013-09-26 21:51:45 +02:00
|
|
|
class MusicPipe;
|
2014-02-05 00:02:02 +01:00
|
|
|
class EventLoop;
|
2014-02-05 23:20:33 +01:00
|
|
|
class Mixer;
|
|
|
|
class MixerListener;
|
2014-08-12 15:56:41 +02:00
|
|
|
struct MusicChunk;
|
2015-01-21 22:13:44 +01:00
|
|
|
struct ConfigBlock;
|
2014-01-28 11:22:27 +01:00
|
|
|
struct AudioOutputPlugin;
|
2016-11-25 13:54:55 +01:00
|
|
|
struct ReplayGainConfig;
|
2011-09-16 23:31:48 +02:00
|
|
|
|
2014-12-24 22:11:57 +01:00
|
|
|
struct AudioOutput {
|
2008-09-24 07:21:46 +02:00
|
|
|
/**
|
|
|
|
* The device's configured display name.
|
|
|
|
*/
|
2008-09-24 07:20:55 +02:00
|
|
|
const char *name;
|
|
|
|
|
2008-09-24 07:21:46 +02:00
|
|
|
/**
|
|
|
|
* The plugin which implements this output device.
|
|
|
|
*/
|
2014-01-29 00:53:49 +01:00
|
|
|
const AudioOutputPlugin &plugin;
|
2008-09-24 07:20:55 +02:00
|
|
|
|
2009-03-26 18:23:23 +01:00
|
|
|
/**
|
|
|
|
* The #mixer object associated with this audio output device.
|
2013-10-19 18:19:03 +02:00
|
|
|
* May be nullptr if none is available, or if software volume is
|
2009-03-26 18:23:23 +01:00
|
|
|
* configured.
|
|
|
|
*/
|
2016-06-22 17:52:52 +02:00
|
|
|
Mixer *mixer = nullptr;
|
2009-03-26 18:23:23 +01:00
|
|
|
|
2009-10-21 22:37:28 +02:00
|
|
|
/**
|
|
|
|
* The configured audio format.
|
|
|
|
*/
|
2013-08-03 21:00:50 +02:00
|
|
|
AudioFormat config_audio_format;
|
2009-10-21 22:37:28 +02:00
|
|
|
|
2016-12-24 14:05:11 +01:00
|
|
|
/**
|
|
|
|
* The #AudioFormat which is emitted by the #Filter, with
|
|
|
|
* #config_audio_format already applied. This is used to
|
|
|
|
* decide whether this object needs to be closed and reopened
|
|
|
|
* upon #AudioFormat changes.
|
|
|
|
*/
|
|
|
|
AudioFormat filter_audio_format;
|
|
|
|
|
2008-09-24 07:21:46 +02:00
|
|
|
/**
|
|
|
|
* The audio_format which is really sent to the device. This
|
2009-02-10 21:50:51 +01:00
|
|
|
* is basically config_audio_format (if configured) or
|
|
|
|
* in_audio_format, but may have been modified by
|
2008-09-24 07:21:46 +02:00
|
|
|
* plugin->open().
|
|
|
|
*/
|
2013-08-03 21:00:50 +02:00
|
|
|
AudioFormat out_audio_format;
|
2008-09-24 07:21:46 +02:00
|
|
|
|
2009-07-06 10:01:47 +02:00
|
|
|
/**
|
|
|
|
* The filter object of this audio output. This is an
|
|
|
|
* instance of chain_filter_plugin.
|
|
|
|
*/
|
2016-06-22 11:15:49 +02:00
|
|
|
PreparedFilter *prepared_filter = nullptr;
|
2009-07-06 10:01:47 +02:00
|
|
|
|
2016-07-01 18:23:53 +02:00
|
|
|
/**
|
|
|
|
* The #VolumeFilter instance of this audio output. It is
|
|
|
|
* used by the #SoftwareMixer.
|
|
|
|
*/
|
2016-06-22 11:15:49 +02:00
|
|
|
FilterObserver volume_filter;
|
2016-07-01 18:23:53 +02:00
|
|
|
|
2010-02-14 17:04:39 +01:00
|
|
|
/**
|
|
|
|
* The replay_gain_filter_plugin instance of this audio
|
|
|
|
* output.
|
|
|
|
*/
|
2016-06-22 11:15:49 +02:00
|
|
|
PreparedFilter *prepared_replay_gain_filter = nullptr;
|
2010-02-14 17:04:39 +01:00
|
|
|
|
2010-05-02 15:57:59 +02:00
|
|
|
/**
|
|
|
|
* The replay_gain_filter_plugin instance of this audio
|
|
|
|
* output, to be applied to the second chunk during
|
|
|
|
* cross-fading.
|
|
|
|
*/
|
2016-06-22 11:15:49 +02:00
|
|
|
PreparedFilter *prepared_other_replay_gain_filter = nullptr;
|
2010-05-02 15:57:59 +02:00
|
|
|
|
2009-07-06 10:01:47 +02:00
|
|
|
/**
|
|
|
|
* The convert_filter_plugin instance of this audio output.
|
|
|
|
* It is the last item in the filter chain, and is responsible
|
|
|
|
* for converting the input data into the appropriate format
|
|
|
|
* for this audio output.
|
|
|
|
*/
|
2016-06-22 11:15:49 +02:00
|
|
|
FilterObserver convert_filter;
|
2008-09-24 07:20:55 +02:00
|
|
|
|
2016-10-28 22:41:07 +02:00
|
|
|
/**
|
|
|
|
* Throws #std::runtime_error on error.
|
|
|
|
*/
|
|
|
|
AudioOutput(const AudioOutputPlugin &_plugin,
|
|
|
|
const ConfigBlock &block);
|
|
|
|
|
2014-01-28 12:24:48 +01:00
|
|
|
~AudioOutput();
|
2014-01-28 11:39:12 +01:00
|
|
|
|
2016-11-09 12:04:54 +01:00
|
|
|
private:
|
2016-11-09 12:06:54 +01:00
|
|
|
void Configure(const ConfigBlock &block);
|
2014-01-28 11:39:12 +01:00
|
|
|
|
2016-11-09 12:04:54 +01:00
|
|
|
public:
|
2016-12-29 22:59:03 +01:00
|
|
|
void Setup(EventLoop &event_loop,
|
|
|
|
const ReplayGainConfig &replay_gain_config,
|
|
|
|
MixerListener &mixer_listener,
|
|
|
|
const ConfigBlock &block);
|
|
|
|
|
2017-05-23 00:17:23 +02:00
|
|
|
void BeginDestroy() noexcept;
|
|
|
|
void FinishDestroy() noexcept;
|
2014-01-28 11:39:12 +01:00
|
|
|
|
2016-12-29 23:23:28 +01:00
|
|
|
const char *GetName() const {
|
|
|
|
return name;
|
|
|
|
}
|
|
|
|
|
2016-12-27 14:55:56 +01:00
|
|
|
/**
|
|
|
|
* Throws #std::runtime_error on error.
|
|
|
|
*/
|
|
|
|
void Enable();
|
|
|
|
|
2017-05-23 00:17:23 +02:00
|
|
|
void Disable() noexcept;
|
2014-01-29 09:12:41 +01:00
|
|
|
|
2017-08-07 16:25:23 +02:00
|
|
|
/**
|
|
|
|
* Invoke OutputPlugin::close().
|
|
|
|
*
|
|
|
|
* Caller must not lock the mutex.
|
|
|
|
*/
|
2017-05-23 00:17:23 +02:00
|
|
|
void Close(bool drain) noexcept;
|
2016-12-13 21:46:27 +01:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Invoke OutputPlugin::open() and configure the
|
|
|
|
* #ConvertFilter.
|
|
|
|
*
|
2016-12-27 14:55:56 +01:00
|
|
|
* Throws #std::runtime_error on error.
|
2016-12-13 21:46:27 +01:00
|
|
|
*
|
2016-12-27 14:55:56 +01:00
|
|
|
* Caller must not lock the mutex.
|
2016-12-13 21:46:27 +01:00
|
|
|
*/
|
2016-12-27 14:55:56 +01:00
|
|
|
void OpenOutputAndConvert(AudioFormat audio_format);
|
2016-12-13 21:46:27 +01:00
|
|
|
|
2014-10-23 23:24:01 +02:00
|
|
|
/**
|
|
|
|
* Close the output plugin.
|
|
|
|
*
|
|
|
|
* Mutex must not be locked.
|
|
|
|
*/
|
2017-05-23 00:17:23 +02:00
|
|
|
void CloseOutput(bool drain) noexcept;
|
2014-10-23 23:24:01 +02:00
|
|
|
|
2014-10-24 00:28:58 +02:00
|
|
|
/**
|
|
|
|
* Mutex must not be locked.
|
|
|
|
*/
|
2017-08-07 18:32:43 +02:00
|
|
|
void CloseSoftwareMixer() noexcept;
|
2014-10-24 00:28:58 +02:00
|
|
|
|
2017-05-23 00:17:23 +02:00
|
|
|
void BeginPause() noexcept;
|
|
|
|
bool IteratePause() noexcept;
|
2017-04-28 22:01:20 +02:00
|
|
|
|
2017-05-23 00:17:23 +02:00
|
|
|
void EndPause() noexcept{
|
2017-04-28 21:45:47 +02:00
|
|
|
}
|
2008-09-24 07:20:55 +02:00
|
|
|
};
|
|
|
|
|
2008-09-24 07:21:46 +02:00
|
|
|
/**
|
|
|
|
* Notify object used by the thread's client, i.e. we will send a
|
|
|
|
* notify signal to this object, expecting the caller to wait on it.
|
|
|
|
*/
|
2008-09-24 07:20:55 +02:00
|
|
|
extern struct notify audio_output_client_notify;
|
|
|
|
|
2016-10-28 21:11:52 +02:00
|
|
|
/**
|
|
|
|
* Throws #std::runtime_error on error.
|
|
|
|
*/
|
2014-01-28 11:34:09 +01:00
|
|
|
AudioOutput *
|
2016-11-25 13:54:55 +01:00
|
|
|
audio_output_new(EventLoop &event_loop,
|
|
|
|
const ReplayGainConfig &replay_gain_config,
|
|
|
|
const ConfigBlock &block,
|
2017-05-23 00:31:13 +02:00
|
|
|
MixerListener &mixer_listener);
|
2011-09-16 23:31:48 +02:00
|
|
|
|
2008-09-24 07:20:55 +02:00
|
|
|
#endif
|