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-08-26 08:27:04 +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-08-26 08:27:04 +02:00
|
|
|
*/
|
|
|
|
|
2016-11-18 12:29:49 +01:00
|
|
|
#ifndef MPD_DECODER_BRIDGE_HXX
|
|
|
|
#define MPD_DECODER_BRIDGE_HXX
|
2008-08-26 08:27:04 +02:00
|
|
|
|
2016-11-18 07:13:35 +01:00
|
|
|
#include "Client.hxx"
|
2013-10-02 12:22:12 +02:00
|
|
|
#include "ReplayGainInfo.hxx"
|
2016-09-08 20:31:06 +02:00
|
|
|
|
|
|
|
#include <exception>
|
2008-08-26 08:27:04 +02:00
|
|
|
|
2013-11-13 19:10:43 +01:00
|
|
|
class PcmConvert;
|
2014-08-12 15:56:41 +02:00
|
|
|
struct MusicChunk;
|
2013-10-28 10:09:21 +01:00
|
|
|
struct DecoderControl;
|
2013-07-30 20:11:57 +02:00
|
|
|
struct Tag;
|
2009-03-06 00:42:01 +01:00
|
|
|
|
2016-11-18 12:29:49 +01:00
|
|
|
/**
|
|
|
|
* A bridge between the #DecoderClient interface and the MPD core
|
|
|
|
* (#DecoderControl, #MusicPipe etc.).
|
|
|
|
*/
|
|
|
|
class DecoderBridge final : public DecoderClient {
|
|
|
|
public:
|
2013-10-28 10:09:21 +01:00
|
|
|
DecoderControl &dc;
|
2009-10-31 19:22:56 +01:00
|
|
|
|
2013-11-13 19:10:43 +01:00
|
|
|
/**
|
|
|
|
* For converting input data to the configured audio format.
|
|
|
|
* nullptr means no conversion necessary.
|
|
|
|
*/
|
2016-09-08 20:34:39 +02:00
|
|
|
PcmConvert *convert = nullptr;
|
2008-08-26 08:27:14 +02:00
|
|
|
|
2009-12-25 19:47:33 +01:00
|
|
|
/**
|
|
|
|
* The time stamp of the next data chunk, in seconds.
|
|
|
|
*/
|
2016-09-08 20:34:39 +02:00
|
|
|
double timestamp = 0;
|
2009-12-25 19:47:33 +01:00
|
|
|
|
2018-02-17 13:10:00 +01:00
|
|
|
/**
|
|
|
|
* The time stamp of the next data chunk, in PCM frames.
|
|
|
|
*/
|
|
|
|
uint64_t absolute_frame = 0;
|
|
|
|
|
2011-09-21 23:17:34 +02:00
|
|
|
/**
|
|
|
|
* Is the initial seek (to the start position of the sub-song)
|
|
|
|
* pending, or has it been performed already?
|
|
|
|
*/
|
|
|
|
bool initial_seek_pending;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Is the initial seek currently running? During this time,
|
|
|
|
* the decoder command is SEEK. This flag is set by
|
|
|
|
* decoder_get_virtual_command(), when the virtual SEEK
|
|
|
|
* command is generated for the first time.
|
|
|
|
*/
|
2016-09-08 20:34:39 +02:00
|
|
|
bool initial_seek_running = false;
|
2011-09-21 23:17:34 +02:00
|
|
|
|
2011-09-21 22:59:11 +02:00
|
|
|
/**
|
2016-11-18 08:15:07 +01:00
|
|
|
* This flag is set by GetSeekTime(), and checked by
|
|
|
|
* CommandFinished(). It is used to clean up after seeking.
|
2011-09-21 22:59:11 +02:00
|
|
|
*/
|
2016-09-08 20:34:39 +02:00
|
|
|
bool seeking = false;
|
2008-11-03 18:24:01 +01:00
|
|
|
|
2009-04-13 19:25:53 +02:00
|
|
|
/**
|
|
|
|
* The tag from the song object. This is only used for local
|
|
|
|
* files, because we expect the stream server to send us a new
|
|
|
|
* tag each time we play it.
|
|
|
|
*/
|
2013-07-30 20:11:57 +02:00
|
|
|
Tag *song_tag;
|
2009-04-13 19:25:53 +02:00
|
|
|
|
2009-01-03 23:29:45 +01:00
|
|
|
/** the last tag received from the stream */
|
2016-09-08 20:34:39 +02:00
|
|
|
Tag *stream_tag = nullptr;
|
2009-01-03 23:29:45 +01:00
|
|
|
|
|
|
|
/** the last tag received from the decoder plugin */
|
2016-09-08 20:34:39 +02:00
|
|
|
Tag *decoder_tag = nullptr;
|
2009-03-06 00:42:01 +01:00
|
|
|
|
|
|
|
/** the chunk currently being written to */
|
2016-11-18 08:36:06 +01:00
|
|
|
MusicChunk *current_chunk = nullptr;
|
2010-01-03 22:44:23 +01:00
|
|
|
|
2013-10-25 19:09:22 +02:00
|
|
|
ReplayGainInfo replay_gain_info;
|
2010-02-14 17:04:39 +01:00
|
|
|
|
|
|
|
/**
|
|
|
|
* A positive serial number for checking if replay gain info
|
|
|
|
* has changed since the last check.
|
|
|
|
*/
|
2016-09-08 20:34:39 +02:00
|
|
|
unsigned replay_gain_serial = 0;
|
2013-01-02 20:36:28 +01:00
|
|
|
|
2013-11-13 20:57:09 +01:00
|
|
|
/**
|
|
|
|
* An error has occurred (in DecoderAPI.cxx), and the plugin
|
|
|
|
* will be asked to stop.
|
|
|
|
*/
|
2016-09-08 20:31:06 +02:00
|
|
|
std::exception_ptr error;
|
2013-11-13 20:57:09 +01:00
|
|
|
|
2016-11-18 12:29:49 +01:00
|
|
|
DecoderBridge(DecoderControl &_dc, bool _initial_seek_pending,
|
|
|
|
Tag *_tag)
|
2013-01-02 20:36:28 +01:00
|
|
|
:dc(_dc),
|
|
|
|
initial_seek_pending(_initial_seek_pending),
|
2016-09-08 20:34:39 +02:00
|
|
|
song_tag(_tag) {}
|
2013-01-04 22:02:52 +01:00
|
|
|
|
2016-11-18 12:29:49 +01:00
|
|
|
~DecoderBridge();
|
2008-08-26 08:27:04 +02:00
|
|
|
|
2016-11-21 22:07:03 +01:00
|
|
|
/**
|
|
|
|
* Should be read operation be cancelled? That is the case when the
|
|
|
|
* player thread has sent a command such as "STOP".
|
|
|
|
*
|
|
|
|
* Caller must lock the #DecoderControl object.
|
|
|
|
*/
|
|
|
|
gcc_pure
|
2017-05-08 14:44:49 +02:00
|
|
|
bool CheckCancelRead() const noexcept;
|
2016-11-21 22:07:03 +01:00
|
|
|
|
2013-11-13 19:13:47 +01:00
|
|
|
/**
|
|
|
|
* Returns the current chunk the decoder writes to, or allocates a new
|
|
|
|
* chunk if there is none.
|
|
|
|
*
|
|
|
|
* @return the chunk, or NULL if we have received a decoder command
|
|
|
|
*/
|
2017-05-08 14:44:49 +02:00
|
|
|
MusicChunk *GetChunk() noexcept;
|
2009-03-06 00:42:01 +01:00
|
|
|
|
2013-11-13 19:13:47 +01:00
|
|
|
/**
|
|
|
|
* Flushes the current chunk.
|
|
|
|
*
|
|
|
|
* Caller must not lock the #DecoderControl object.
|
|
|
|
*/
|
|
|
|
void FlushChunk();
|
2016-11-18 07:59:01 +01:00
|
|
|
|
|
|
|
/* virtual methods from DecoderClient */
|
|
|
|
void Ready(AudioFormat audio_format,
|
|
|
|
bool seekable, SignedSongTime duration) override;
|
2017-06-03 21:33:44 +02:00
|
|
|
DecoderCommand GetCommand() noexcept override;
|
2016-11-18 08:15:07 +01:00
|
|
|
void CommandFinished() override;
|
2017-06-03 21:33:44 +02:00
|
|
|
SongTime GetSeekTime() noexcept override;
|
|
|
|
uint64_t GetSeekFrame() noexcept override;
|
2016-11-18 08:15:07 +01:00
|
|
|
void SeekError() override;
|
2016-11-18 12:34:04 +01:00
|
|
|
InputStreamPtr OpenUri(const char *uri) override;
|
2016-11-17 22:21:36 +01:00
|
|
|
size_t Read(InputStream &is, void *buffer, size_t length) override;
|
2016-11-18 08:27:30 +01:00
|
|
|
void SubmitTimestamp(double t) override;
|
|
|
|
DecoderCommand SubmitData(InputStream *is,
|
|
|
|
const void *data, size_t length,
|
|
|
|
uint16_t kbit_rate) override;
|
|
|
|
DecoderCommand SubmitTag(InputStream *is, Tag &&tag) override ;
|
|
|
|
void SubmitReplayGain(const ReplayGainInfo *replay_gain_info) override;
|
|
|
|
void SubmitMixRamp(MixRampInfo &&mix_ramp) override;
|
2016-11-21 21:44:57 +01:00
|
|
|
|
|
|
|
private:
|
|
|
|
/**
|
|
|
|
* Checks if we need an "initial seek". If so, then the
|
|
|
|
* initial seek is prepared, and the function returns true.
|
|
|
|
*/
|
|
|
|
bool PrepareInitialSeek();
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Returns the current decoder command. May return a
|
|
|
|
* "virtual" synthesized command, e.g. to seek to the
|
|
|
|
* beginning of the CUE track.
|
|
|
|
*/
|
2017-05-08 14:44:49 +02:00
|
|
|
DecoderCommand GetVirtualCommand() noexcept;
|
|
|
|
DecoderCommand LockGetVirtualCommand() noexcept;
|
2016-11-21 21:44:57 +01:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Sends a #Tag as-is to the #MusicPipe. Flushes the current
|
|
|
|
* chunk (DecoderBridge::chunk) if there is one.
|
|
|
|
*/
|
|
|
|
DecoderCommand DoSendTag(const Tag &tag);
|
|
|
|
|
|
|
|
bool UpdateStreamTag(InputStream *is);
|
2013-11-13 19:13:47 +01:00
|
|
|
};
|
2009-03-06 00:42:01 +01:00
|
|
|
|
2008-08-26 08:27:04 +02:00
|
|
|
#endif
|