2009-03-13 18:43:16 +01:00
|
|
|
/*
|
2014-01-13 22:30:36 +01:00
|
|
|
* Copyright (C) 2003-2014 The Music Player Daemon Project
|
2009-03-13 18:43:16 +01:00
|
|
|
* http://www.musicpd.org
|
2004-02-24 00:41:20 +01: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.
|
2004-02-24 00:41:20 +01:00
|
|
|
*/
|
|
|
|
|
2013-01-04 08:41:16 +01:00
|
|
|
#ifndef MPD_DECODER_CONTROL_HXX
|
|
|
|
#define MPD_DECODER_CONTROL_HXX
|
2004-02-24 00:41:20 +01:00
|
|
|
|
2013-07-28 13:18:48 +02:00
|
|
|
#include "DecoderCommand.hxx"
|
2013-08-03 21:00:50 +02:00
|
|
|
#include "AudioFormat.hxx"
|
2013-10-26 14:19:34 +02:00
|
|
|
#include "MixRampInfo.hxx"
|
2013-01-27 17:20:50 +01:00
|
|
|
#include "thread/Mutex.hxx"
|
|
|
|
#include "thread/Cond.hxx"
|
2013-10-17 18:42:14 +02:00
|
|
|
#include "thread/Thread.hxx"
|
2014-08-27 18:38:41 +02:00
|
|
|
#include "Chrono.hxx"
|
2013-08-10 18:02:44 +02:00
|
|
|
#include "util/Error.hxx"
|
2009-08-13 23:33:46 +02:00
|
|
|
|
2008-11-08 15:48:00 +01:00
|
|
|
#include <assert.h>
|
2013-09-27 12:27:33 +02:00
|
|
|
#include <stdint.h>
|
|
|
|
|
|
|
|
/* damn you, windows.h! */
|
|
|
|
#ifdef ERROR
|
|
|
|
#undef ERROR
|
|
|
|
#endif
|
2008-11-08 15:48:00 +01:00
|
|
|
|
2014-01-07 21:39:47 +01:00
|
|
|
class DetachedSong;
|
2013-09-26 22:09:42 +02:00
|
|
|
class MusicBuffer;
|
2013-09-26 21:51:45 +02:00
|
|
|
class MusicPipe;
|
2013-07-28 13:25:12 +02:00
|
|
|
|
2013-09-27 12:27:33 +02:00
|
|
|
enum class DecoderState : uint8_t {
|
|
|
|
STOP = 0,
|
|
|
|
START,
|
|
|
|
DECODE,
|
2008-11-08 15:48:00 +01:00
|
|
|
|
|
|
|
/**
|
|
|
|
* The last "START" command failed, because there was an I/O
|
|
|
|
* error or because no decoder was able to decode the file.
|
|
|
|
* This state will only come after START; once the state has
|
|
|
|
* turned to DECODE, by definition no such error can occur.
|
|
|
|
*/
|
2013-09-27 12:27:33 +02:00
|
|
|
ERROR,
|
2008-11-03 21:48:17 +01:00
|
|
|
};
|
2004-05-18 15:13:55 +02:00
|
|
|
|
2013-10-28 10:09:21 +01:00
|
|
|
struct DecoderControl {
|
2013-10-17 18:42:14 +02:00
|
|
|
/**
|
|
|
|
* The handle of the decoder thread.
|
|
|
|
*/
|
|
|
|
Thread thread;
|
2009-01-25 13:44:27 +01:00
|
|
|
|
2009-08-13 23:33:46 +02:00
|
|
|
/**
|
|
|
|
* This lock protects #state and #command.
|
2013-10-28 10:09:04 +01:00
|
|
|
*
|
|
|
|
* This is usually a reference to PlayerControl::mutex, so
|
|
|
|
* that both player thread and decoder thread share a mutex.
|
|
|
|
* This simplifies synchronization with #cond and
|
|
|
|
* #client_cond.
|
2009-08-13 23:33:46 +02:00
|
|
|
*/
|
2013-10-28 10:09:04 +01:00
|
|
|
Mutex &mutex;
|
2009-08-13 23:33:46 +02:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Trigger this object after you have modified #command. This
|
|
|
|
* is also used by the decoder thread to notify the caller
|
|
|
|
* when it has finished a command.
|
|
|
|
*/
|
2013-01-27 17:20:50 +01:00
|
|
|
Cond cond;
|
2009-08-13 23:33:46 +02:00
|
|
|
|
2011-01-10 21:27:43 +01:00
|
|
|
/**
|
|
|
|
* The trigger of this object's client. It is signalled
|
|
|
|
* whenever an event occurs.
|
2013-10-28 10:09:04 +01:00
|
|
|
*
|
|
|
|
* This is usually a reference to PlayerControl::cond.
|
2011-01-10 21:27:43 +01:00
|
|
|
*/
|
2013-10-28 10:09:04 +01:00
|
|
|
Cond &client_cond;
|
2011-01-10 21:27:43 +01:00
|
|
|
|
2013-09-27 12:27:33 +02:00
|
|
|
DecoderState state;
|
2013-09-27 12:11:37 +02:00
|
|
|
DecoderCommand command;
|
2008-04-12 06:14:32 +02:00
|
|
|
|
2012-08-08 21:54:54 +02:00
|
|
|
/**
|
|
|
|
* The error that occurred in the decoder thread. This
|
2013-09-27 12:27:33 +02:00
|
|
|
* attribute is only valid if #state is #DecoderState::ERROR.
|
2012-08-08 21:54:54 +02:00
|
|
|
* The object must be freed when this object transitions to
|
2013-09-27 12:27:33 +02:00
|
|
|
* any other state (usually #DecoderState::START).
|
2012-08-08 21:54:54 +02:00
|
|
|
*/
|
2013-08-10 18:02:44 +02:00
|
|
|
Error error;
|
2012-08-08 21:54:54 +02:00
|
|
|
|
2008-12-28 19:48:53 +01:00
|
|
|
bool quit;
|
2013-11-06 23:10:05 +01:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Is the client currently waiting for the DecoderThread? If
|
|
|
|
* false, the DecoderThread may omit invoking Cond::signal(),
|
|
|
|
* reducing the number of system calls.
|
|
|
|
*/
|
|
|
|
bool client_is_waiting;
|
|
|
|
|
2008-11-03 21:43:02 +01:00
|
|
|
bool seek_error;
|
2008-10-30 08:38:54 +01:00
|
|
|
bool seekable;
|
2014-08-27 18:38:41 +02:00
|
|
|
SongTime seek_time;
|
2008-11-02 16:55:43 +01:00
|
|
|
|
|
|
|
/** the format of the song file */
|
2013-08-03 21:00:50 +02:00
|
|
|
AudioFormat in_audio_format;
|
2008-11-02 16:55:43 +01:00
|
|
|
|
|
|
|
/** the format being sent to the music pipe */
|
2013-08-03 21:00:50 +02:00
|
|
|
AudioFormat out_audio_format;
|
2008-11-02 16:55:43 +01:00
|
|
|
|
2009-11-03 20:02:19 +01:00
|
|
|
/**
|
|
|
|
* The song currently being decoded. This attribute is set by
|
2013-09-27 12:11:37 +02:00
|
|
|
* the player thread, when it sends the #DecoderCommand::START
|
2009-11-03 20:02:19 +01:00
|
|
|
* command.
|
2012-08-09 20:55:18 +02:00
|
|
|
*
|
|
|
|
* This is a duplicate, and must be freed when this attribute
|
|
|
|
* is cleared.
|
2009-11-03 20:02:19 +01:00
|
|
|
*/
|
2014-01-07 21:39:47 +01:00
|
|
|
DetachedSong *song;
|
2009-11-03 20:02:19 +01:00
|
|
|
|
2011-10-05 22:37:59 +02:00
|
|
|
/**
|
|
|
|
* The initial seek position (in milliseconds), e.g. to the
|
|
|
|
* start of a sub-track described by a CUE file.
|
|
|
|
*
|
|
|
|
* This attribute is set by dc_start().
|
|
|
|
*/
|
|
|
|
unsigned start_ms;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* The decoder will stop when it reaches this position (in
|
|
|
|
* milliseconds). 0 means don't stop before the end of the
|
|
|
|
* file.
|
|
|
|
*
|
|
|
|
* This attribute is set by dc_start().
|
|
|
|
*/
|
|
|
|
unsigned end_ms;
|
|
|
|
|
2008-11-03 21:44:12 +01:00
|
|
|
float total_time;
|
2009-03-06 00:42:03 +01:00
|
|
|
|
2014-08-12 15:56:41 +02:00
|
|
|
/** the #MusicChunk allocator */
|
2013-09-26 22:09:42 +02:00
|
|
|
MusicBuffer *buffer;
|
2009-03-06 00:42:03 +01:00
|
|
|
|
2009-11-03 21:18:22 +01:00
|
|
|
/**
|
|
|
|
* The destination pipe for decoded chunks. The caller thread
|
|
|
|
* owns this object, and is responsible for freeing it.
|
|
|
|
*/
|
2013-09-26 21:51:45 +02:00
|
|
|
MusicPipe *pipe;
|
2010-03-21 18:21:47 +01:00
|
|
|
|
2010-05-08 09:19:44 +02:00
|
|
|
float replay_gain_db;
|
|
|
|
float replay_gain_prev_db;
|
2013-10-26 14:19:34 +02:00
|
|
|
|
|
|
|
MixRampInfo mix_ramp, previous_mix_ramp;
|
2013-01-20 17:48:23 +01:00
|
|
|
|
2013-10-28 10:09:04 +01:00
|
|
|
/**
|
|
|
|
* @param _mutex see #mutex
|
|
|
|
* @param _client_cond see #client_cond
|
|
|
|
*/
|
|
|
|
DecoderControl(Mutex &_mutex, Cond &_client_cond);
|
2013-10-28 10:09:21 +01:00
|
|
|
~DecoderControl();
|
2013-01-21 10:13:29 +01:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Locks the object.
|
|
|
|
*/
|
|
|
|
void Lock() const {
|
2013-01-27 17:20:50 +01:00
|
|
|
mutex.lock();
|
2013-01-21 10:13:29 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Unlocks the object.
|
|
|
|
*/
|
|
|
|
void Unlock() const {
|
2013-01-27 17:20:50 +01:00
|
|
|
mutex.unlock();
|
2013-01-21 10:13:29 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Signals the object. This function is only valid in the
|
|
|
|
* player thread. The object should be locked prior to
|
|
|
|
* calling this function.
|
|
|
|
*/
|
|
|
|
void Signal() {
|
2013-01-27 17:20:50 +01:00
|
|
|
cond.signal();
|
2013-01-21 10:13:29 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2013-10-28 10:09:21 +01:00
|
|
|
* Waits for a signal on the #DecoderControl object. This function
|
2013-01-21 10:13:29 +01:00
|
|
|
* is only valid in the decoder thread. The object must be locked
|
|
|
|
* prior to calling this function.
|
|
|
|
*/
|
|
|
|
void Wait() {
|
2013-01-27 17:20:50 +01:00
|
|
|
cond.wait(mutex);
|
2013-01-21 10:13:29 +01:00
|
|
|
}
|
|
|
|
|
2013-01-20 17:48:23 +01:00
|
|
|
/**
|
|
|
|
* Waits for a signal from the decoder thread. This object
|
|
|
|
* must be locked prior to calling this function. This method
|
|
|
|
* is only valid in the player thread.
|
2013-11-06 23:10:05 +01:00
|
|
|
*
|
|
|
|
* Caller must hold the lock.
|
2013-01-20 17:48:23 +01:00
|
|
|
*/
|
2013-11-06 23:10:05 +01:00
|
|
|
void WaitForDecoder();
|
2008-08-26 08:45:14 +02:00
|
|
|
|
2013-01-21 10:13:29 +01:00
|
|
|
bool IsIdle() const {
|
2013-09-27 12:27:33 +02:00
|
|
|
return state == DecoderState::STOP ||
|
|
|
|
state == DecoderState::ERROR;
|
2012-08-08 21:54:54 +02:00
|
|
|
}
|
|
|
|
|
2013-01-21 10:13:29 +01:00
|
|
|
gcc_pure
|
|
|
|
bool LockIsIdle() const {
|
|
|
|
Lock();
|
|
|
|
bool result = IsIdle();
|
|
|
|
Unlock();
|
|
|
|
return result;
|
|
|
|
}
|
2009-08-13 23:33:46 +02:00
|
|
|
|
2013-01-21 10:13:29 +01:00
|
|
|
bool IsStarting() const {
|
2013-09-27 12:27:33 +02:00
|
|
|
return state == DecoderState::START;
|
2013-01-21 10:13:29 +01:00
|
|
|
}
|
2009-08-13 23:33:46 +02:00
|
|
|
|
2013-01-21 10:13:29 +01:00
|
|
|
gcc_pure
|
|
|
|
bool LockIsStarting() const {
|
|
|
|
Lock();
|
|
|
|
bool result = IsStarting();
|
|
|
|
Unlock();
|
|
|
|
return result;
|
|
|
|
}
|
2009-08-13 23:33:46 +02:00
|
|
|
|
2013-01-21 10:13:29 +01:00
|
|
|
bool HasFailed() const {
|
2013-09-27 12:11:37 +02:00
|
|
|
assert(command == DecoderCommand::NONE);
|
2009-08-13 23:33:46 +02:00
|
|
|
|
2013-09-27 12:27:33 +02:00
|
|
|
return state == DecoderState::ERROR;
|
2013-01-21 10:13:29 +01:00
|
|
|
}
|
2009-08-13 23:33:46 +02:00
|
|
|
|
2013-01-21 10:13:29 +01:00
|
|
|
gcc_pure
|
|
|
|
bool LockHasFailed() const {
|
|
|
|
Lock();
|
|
|
|
bool result = HasFailed();
|
|
|
|
Unlock();
|
|
|
|
return result;
|
|
|
|
}
|
2009-08-13 23:33:46 +02:00
|
|
|
|
2013-01-21 10:13:29 +01:00
|
|
|
/**
|
2013-08-10 18:02:44 +02:00
|
|
|
* Checks whether an error has occurred, and if so, returns a
|
|
|
|
* copy of the #Error object.
|
2013-01-21 10:13:29 +01:00
|
|
|
*
|
|
|
|
* Caller must lock the object.
|
|
|
|
*/
|
2013-08-10 18:02:44 +02:00
|
|
|
gcc_pure
|
|
|
|
Error GetError() const {
|
2013-09-27 12:11:37 +02:00
|
|
|
assert(command == DecoderCommand::NONE);
|
2013-09-27 12:27:33 +02:00
|
|
|
assert(state != DecoderState::ERROR || error.IsDefined());
|
2009-08-13 23:33:46 +02:00
|
|
|
|
2013-08-10 18:02:44 +02:00
|
|
|
Error result;
|
2013-09-27 12:27:33 +02:00
|
|
|
if (state == DecoderState::ERROR)
|
2013-08-10 18:02:44 +02:00
|
|
|
result.Set(error);
|
|
|
|
return result;
|
2013-01-21 10:13:29 +01:00
|
|
|
}
|
2009-08-13 23:33:46 +02:00
|
|
|
|
2013-01-21 10:13:29 +01:00
|
|
|
/**
|
|
|
|
* Like dc_get_error(), but locks and unlocks the object.
|
|
|
|
*/
|
2013-08-10 18:02:44 +02:00
|
|
|
gcc_pure
|
|
|
|
Error LockGetError() const {
|
2013-01-21 10:13:29 +01:00
|
|
|
Lock();
|
2013-08-10 18:02:44 +02:00
|
|
|
Error result = GetError();
|
2013-01-21 10:13:29 +01:00
|
|
|
Unlock();
|
|
|
|
return result;
|
|
|
|
}
|
2009-08-13 23:33:46 +02:00
|
|
|
|
2013-01-21 10:13:29 +01:00
|
|
|
/**
|
2013-08-10 18:02:44 +02:00
|
|
|
* Clear the error condition and free the #Error object (if any).
|
2013-01-21 10:13:29 +01:00
|
|
|
*
|
|
|
|
* Caller must lock the object.
|
|
|
|
*/
|
|
|
|
void ClearError() {
|
2013-09-27 12:27:33 +02:00
|
|
|
if (state == DecoderState::ERROR) {
|
2013-08-10 18:02:44 +02:00
|
|
|
error.Clear();
|
2013-09-27 12:27:33 +02:00
|
|
|
state = DecoderState::STOP;
|
2013-01-21 10:13:29 +01:00
|
|
|
}
|
|
|
|
}
|
2008-08-26 08:27:18 +02:00
|
|
|
|
2013-01-21 10:13:29 +01:00
|
|
|
/**
|
|
|
|
* Check if the specified song is currently being decoded. If the
|
|
|
|
* decoder is not running currently (or being started), then this
|
|
|
|
* function returns false in any case.
|
|
|
|
*
|
|
|
|
* Caller must lock the object.
|
|
|
|
*/
|
|
|
|
gcc_pure
|
2014-01-07 21:39:47 +01:00
|
|
|
bool IsCurrentSong(const DetachedSong &_song) const;
|
2013-01-21 10:13:29 +01:00
|
|
|
|
|
|
|
gcc_pure
|
2014-01-07 21:39:47 +01:00
|
|
|
bool LockIsCurrentSong(const DetachedSong &_song) const {
|
2013-01-21 10:13:29 +01:00
|
|
|
Lock();
|
|
|
|
const bool result = IsCurrentSong(_song);
|
|
|
|
Unlock();
|
|
|
|
return result;
|
|
|
|
}
|
2008-08-26 08:27:18 +02:00
|
|
|
|
2013-09-27 09:18:03 +02:00
|
|
|
private:
|
|
|
|
/**
|
|
|
|
* Wait for the command to be finished by the decoder thread.
|
|
|
|
*
|
|
|
|
* To be called from the client thread. Caller must lock the
|
|
|
|
* object.
|
|
|
|
*/
|
|
|
|
void WaitCommandLocked() {
|
2013-09-27 12:11:37 +02:00
|
|
|
while (command != DecoderCommand::NONE)
|
2013-09-27 09:18:03 +02:00
|
|
|
WaitForDecoder();
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Send a command to the decoder thread and synchronously wait
|
|
|
|
* for it to finish.
|
|
|
|
*
|
|
|
|
* To be called from the client thread. Caller must lock the
|
|
|
|
* object.
|
|
|
|
*/
|
2013-09-27 12:11:37 +02:00
|
|
|
void SynchronousCommandLocked(DecoderCommand cmd) {
|
2013-09-27 09:18:03 +02:00
|
|
|
command = cmd;
|
|
|
|
Signal();
|
|
|
|
WaitCommandLocked();
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Send a command to the decoder thread and synchronously wait
|
|
|
|
* for it to finish.
|
|
|
|
*
|
|
|
|
* To be called from the client thread. This method locks the
|
|
|
|
* object.
|
|
|
|
*/
|
2013-09-27 12:11:37 +02:00
|
|
|
void LockSynchronousCommand(DecoderCommand cmd) {
|
2013-09-27 09:18:03 +02:00
|
|
|
Lock();
|
|
|
|
ClearError();
|
|
|
|
SynchronousCommandLocked(cmd);
|
|
|
|
Unlock();
|
|
|
|
}
|
|
|
|
|
2013-09-27 12:11:37 +02:00
|
|
|
void LockAsynchronousCommand(DecoderCommand cmd) {
|
2013-09-27 09:18:03 +02:00
|
|
|
Lock();
|
|
|
|
command = cmd;
|
|
|
|
Signal();
|
|
|
|
Unlock();
|
|
|
|
}
|
|
|
|
|
|
|
|
public:
|
2013-01-21 10:13:29 +01:00
|
|
|
/**
|
|
|
|
* Start the decoder.
|
|
|
|
*
|
|
|
|
* @param song the song to be decoded; the given instance will be
|
|
|
|
* owned and freed by the decoder
|
2013-10-28 10:09:21 +01:00
|
|
|
* @param start_ms see #DecoderControl
|
|
|
|
* @param end_ms see #DecoderControl
|
2013-01-21 10:13:29 +01:00
|
|
|
* @param pipe the pipe which receives the decoded chunks (owned by
|
|
|
|
* the caller)
|
|
|
|
*/
|
2014-01-07 21:39:47 +01:00
|
|
|
void Start(DetachedSong *song, unsigned start_ms, unsigned end_ms,
|
2013-09-26 22:09:42 +02:00
|
|
|
MusicBuffer &buffer, MusicPipe &pipe);
|
2008-08-26 08:27:18 +02:00
|
|
|
|
2013-01-21 10:13:29 +01:00
|
|
|
void Stop();
|
2008-12-28 19:48:53 +01:00
|
|
|
|
2014-08-27 18:38:41 +02:00
|
|
|
bool Seek(SongTime t);
|
2010-03-21 18:21:47 +01:00
|
|
|
|
2013-01-21 10:13:29 +01:00
|
|
|
void Quit();
|
2010-03-21 18:21:47 +01:00
|
|
|
|
2013-10-26 14:08:09 +02:00
|
|
|
const char *GetMixRampStart() const {
|
2013-10-26 14:19:34 +02:00
|
|
|
return mix_ramp.GetStart();
|
2013-10-26 14:08:09 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
const char *GetMixRampEnd() const {
|
2013-10-26 14:19:34 +02:00
|
|
|
return mix_ramp.GetEnd();
|
2013-10-26 14:08:09 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
const char *GetMixRampPreviousEnd() const {
|
2013-10-26 14:19:34 +02:00
|
|
|
return previous_mix_ramp.GetEnd();
|
2013-10-26 14:08:09 +02:00
|
|
|
}
|
|
|
|
|
2013-10-26 14:19:34 +02:00
|
|
|
void SetMixRamp(MixRampInfo &&new_value) {
|
|
|
|
mix_ramp = std::move(new_value);
|
|
|
|
}
|
2013-10-26 14:12:10 +02:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Move mixramp_end to mixramp_prev_end and clear
|
|
|
|
* mixramp_start/mixramp_end.
|
|
|
|
*/
|
|
|
|
void CycleMixRamp();
|
2013-01-21 10:13:29 +01:00
|
|
|
};
|
2010-03-21 18:21:47 +01:00
|
|
|
|
2004-02-24 00:41:20 +01:00
|
|
|
#endif
|