2013-01-24 19:14:40 +01:00
|
|
|
/*
|
2014-01-13 22:30:36 +01:00
|
|
|
* Copyright (C) 2003-2014 The Music Player Daemon Project
|
2013-01-24 19:14:40 +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.
|
|
|
|
*
|
|
|
|
* 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.
|
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef MPD_INPUT_STREAM_HXX
|
|
|
|
#define MPD_INPUT_STREAM_HXX
|
|
|
|
|
|
|
|
#include "check.h"
|
2013-01-27 17:20:50 +01:00
|
|
|
#include "thread/Mutex.hxx"
|
2013-10-15 09:21:13 +02:00
|
|
|
#include "Compiler.h"
|
2013-01-24 19:14:40 +01:00
|
|
|
|
2013-01-28 23:41:45 +01:00
|
|
|
#include <string>
|
2013-01-24 19:14:40 +01:00
|
|
|
|
2013-01-28 20:32:23 +01:00
|
|
|
#include <assert.h>
|
2013-10-17 09:43:55 +02:00
|
|
|
#include <stdint.h>
|
2013-01-28 20:32:23 +01:00
|
|
|
|
2013-10-17 10:06:31 +02:00
|
|
|
class Cond;
|
2013-09-05 00:06:31 +02:00
|
|
|
class Error;
|
|
|
|
struct Tag;
|
2013-10-17 10:20:57 +02:00
|
|
|
struct InputPlugin;
|
2013-09-05 00:06:31 +02:00
|
|
|
|
2014-05-11 15:34:48 +02:00
|
|
|
class InputStream {
|
|
|
|
public:
|
2013-10-17 09:43:55 +02:00
|
|
|
typedef int64_t offset_type;
|
|
|
|
|
2014-05-11 15:34:48 +02:00
|
|
|
private:
|
2013-01-24 19:14:40 +01:00
|
|
|
/**
|
|
|
|
* the plugin which implements this input stream
|
|
|
|
*/
|
2013-10-17 10:20:57 +02:00
|
|
|
const InputPlugin &plugin;
|
2013-01-24 19:14:40 +01:00
|
|
|
|
|
|
|
/**
|
2013-01-28 23:41:45 +01:00
|
|
|
* The absolute URI which was used to open this stream.
|
2013-01-24 19:14:40 +01:00
|
|
|
*/
|
2013-01-28 23:41:45 +01:00
|
|
|
std::string uri;
|
2013-01-24 19:14:40 +01:00
|
|
|
|
2014-05-11 15:34:48 +02:00
|
|
|
public:
|
2013-01-24 19:14:40 +01:00
|
|
|
/**
|
|
|
|
* A mutex that protects the mutable attributes of this object
|
|
|
|
* and its implementation. It must be locked before calling
|
|
|
|
* any of the public methods.
|
|
|
|
*
|
|
|
|
* This object is allocated by the client, and the client is
|
|
|
|
* responsible for freeing it.
|
|
|
|
*/
|
2013-01-28 23:35:01 +01:00
|
|
|
Mutex &mutex;
|
2013-01-24 19:14:40 +01:00
|
|
|
|
|
|
|
/**
|
|
|
|
* A cond that gets signalled when the state of this object
|
|
|
|
* changes from the I/O thread. The client of this object may
|
2013-10-19 18:19:03 +02:00
|
|
|
* wait on it. Optional, may be nullptr.
|
2013-01-24 19:14:40 +01:00
|
|
|
*
|
|
|
|
* This object is allocated by the client, and the client is
|
|
|
|
* responsible for freeing it.
|
|
|
|
*/
|
2013-01-28 23:35:01 +01:00
|
|
|
Cond &cond;
|
2013-01-24 19:14:40 +01:00
|
|
|
|
|
|
|
/**
|
|
|
|
* indicates whether the stream is ready for reading and
|
|
|
|
* whether the other attributes in this struct are valid
|
|
|
|
*/
|
|
|
|
bool ready;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* if true, then the stream is fully seekable
|
|
|
|
*/
|
|
|
|
bool seekable;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* the size of the resource, or -1 if unknown
|
|
|
|
*/
|
2013-10-17 09:43:55 +02:00
|
|
|
offset_type size;
|
2013-01-24 19:14:40 +01:00
|
|
|
|
2014-05-11 15:34:48 +02:00
|
|
|
public:
|
2013-01-24 19:14:40 +01:00
|
|
|
/**
|
|
|
|
* the current offset within the stream
|
|
|
|
*/
|
2013-10-17 09:43:55 +02:00
|
|
|
offset_type offset;
|
2013-01-24 19:14:40 +01:00
|
|
|
|
2014-05-11 15:34:48 +02:00
|
|
|
private:
|
2013-01-24 19:14:40 +01:00
|
|
|
/**
|
2013-01-28 23:41:45 +01:00
|
|
|
* the MIME content type of the resource, or empty if unknown.
|
2013-01-24 19:14:40 +01:00
|
|
|
*/
|
2013-01-28 23:41:45 +01:00
|
|
|
std::string mime;
|
2013-01-28 20:32:23 +01:00
|
|
|
|
2014-05-11 15:34:48 +02:00
|
|
|
public:
|
2013-10-23 22:08:59 +02:00
|
|
|
InputStream(const InputPlugin &_plugin,
|
|
|
|
const char *_uri, Mutex &_mutex, Cond &_cond)
|
2013-01-28 23:41:45 +01:00
|
|
|
:plugin(_plugin), uri(_uri),
|
2013-01-28 23:35:01 +01:00
|
|
|
mutex(_mutex), cond(_cond),
|
2013-01-28 20:32:23 +01:00
|
|
|
ready(false), seekable(false),
|
2013-01-28 23:41:45 +01:00
|
|
|
size(-1), offset(0) {
|
2013-10-19 18:19:03 +02:00
|
|
|
assert(_uri != nullptr);
|
2013-01-28 20:32:23 +01:00
|
|
|
}
|
2013-01-24 19:14:40 +01:00
|
|
|
|
2014-05-11 16:59:19 +02:00
|
|
|
/**
|
|
|
|
* Close the input stream and free resources.
|
|
|
|
*
|
|
|
|
* The caller must not lock the mutex.
|
|
|
|
*/
|
|
|
|
virtual ~InputStream();
|
|
|
|
|
2013-09-05 00:06:31 +02:00
|
|
|
/**
|
|
|
|
* Opens a new input stream. You may not access it until the "ready"
|
|
|
|
* flag is set.
|
|
|
|
*
|
|
|
|
* @param mutex a mutex that is used to protect this object; must be
|
|
|
|
* locked before calling any of the public methods
|
|
|
|
* @param cond a cond that gets signalled when the state of
|
2013-10-19 18:19:03 +02:00
|
|
|
* this object changes; may be nullptr if the caller doesn't want to get
|
2013-09-05 00:06:31 +02:00
|
|
|
* notifications
|
2013-10-23 22:08:59 +02:00
|
|
|
* @return an #InputStream object on success, nullptr on error
|
2013-09-05 00:06:31 +02:00
|
|
|
*/
|
|
|
|
gcc_nonnull_all
|
|
|
|
gcc_malloc
|
2013-10-23 22:08:59 +02:00
|
|
|
static InputStream *Open(const char *uri, Mutex &mutex, Cond &cond,
|
|
|
|
Error &error);
|
2013-09-05 00:06:31 +02:00
|
|
|
|
2013-12-29 18:08:49 +01:00
|
|
|
/**
|
|
|
|
* Just like Open(), but waits for the stream to become ready.
|
|
|
|
* It is a wrapper for Open(), WaitReady() and Check().
|
|
|
|
*/
|
|
|
|
gcc_malloc gcc_nonnull_all
|
|
|
|
static InputStream *OpenReady(const char *uri,
|
|
|
|
Mutex &mutex, Cond &cond,
|
|
|
|
Error &error);
|
|
|
|
|
2014-05-11 15:34:48 +02:00
|
|
|
const InputPlugin &GetPlugin() const {
|
|
|
|
return plugin;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* The absolute URI which was used to open this stream.
|
|
|
|
*
|
|
|
|
* No lock necessary for this method.
|
|
|
|
*/
|
|
|
|
const char *GetURI() const {
|
|
|
|
return uri.c_str();
|
|
|
|
}
|
|
|
|
|
2013-09-05 00:06:31 +02:00
|
|
|
void Lock() {
|
|
|
|
mutex.lock();
|
|
|
|
}
|
|
|
|
|
|
|
|
void Unlock() {
|
|
|
|
mutex.unlock();
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Check for errors that may have occurred in the I/O thread.
|
|
|
|
*
|
|
|
|
* @return false on error
|
|
|
|
*/
|
|
|
|
bool Check(Error &error);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Update the public attributes. Call before accessing attributes
|
|
|
|
* such as "ready" or "offset".
|
|
|
|
*/
|
|
|
|
void Update();
|
|
|
|
|
2014-05-11 15:34:48 +02:00
|
|
|
void SetReady();
|
|
|
|
|
2013-09-05 00:06:31 +02:00
|
|
|
/**
|
2014-05-11 15:34:48 +02:00
|
|
|
* Return whether the stream is ready for reading and whether
|
|
|
|
* the other attributes in this struct are valid.
|
2013-09-05 00:06:31 +02:00
|
|
|
*
|
|
|
|
* The caller must lock the mutex.
|
|
|
|
*/
|
2014-05-11 15:34:48 +02:00
|
|
|
bool IsReady() const {
|
|
|
|
return ready;
|
|
|
|
}
|
|
|
|
|
2013-09-05 00:06:31 +02:00
|
|
|
void WaitReady();
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Wrapper for WaitReady() which locks and unlocks the mutex;
|
|
|
|
* the caller must not be holding it already.
|
|
|
|
*/
|
|
|
|
void LockWaitReady();
|
|
|
|
|
2014-05-11 15:34:48 +02:00
|
|
|
gcc_pure
|
|
|
|
bool HasMimeType() const {
|
|
|
|
assert(ready);
|
|
|
|
|
|
|
|
return !mime.empty();
|
|
|
|
}
|
|
|
|
|
2013-09-05 00:06:31 +02:00
|
|
|
gcc_pure
|
|
|
|
const char *GetMimeType() const {
|
|
|
|
assert(ready);
|
|
|
|
|
|
|
|
return mime.empty() ? nullptr : mime.c_str();
|
|
|
|
}
|
|
|
|
|
2014-05-11 15:34:48 +02:00
|
|
|
gcc_nonnull_all
|
|
|
|
void SetMimeType(const char *_mime) {
|
|
|
|
assert(!ready);
|
|
|
|
|
|
|
|
mime = _mime;
|
|
|
|
}
|
|
|
|
|
|
|
|
void SetMimeType(std::string &&_mime) {
|
|
|
|
assert(!ready);
|
|
|
|
|
|
|
|
mime = std::move(_mime);
|
|
|
|
}
|
|
|
|
|
2013-09-05 00:06:31 +02:00
|
|
|
gcc_nonnull_all
|
|
|
|
void OverrideMimeType(const char *_mime) {
|
|
|
|
assert(ready);
|
|
|
|
|
|
|
|
mime = _mime;
|
|
|
|
}
|
|
|
|
|
|
|
|
gcc_pure
|
2013-10-17 09:43:55 +02:00
|
|
|
offset_type GetSize() const {
|
2013-09-05 00:06:31 +02:00
|
|
|
assert(ready);
|
|
|
|
|
|
|
|
return size;
|
|
|
|
}
|
|
|
|
|
2014-05-11 15:34:48 +02:00
|
|
|
void AddOffset(offset_type delta) {
|
|
|
|
assert(ready);
|
|
|
|
assert(offset >= 0);
|
|
|
|
assert(delta >= 0);
|
|
|
|
|
|
|
|
offset += delta;
|
|
|
|
}
|
|
|
|
|
2013-09-05 00:06:31 +02:00
|
|
|
gcc_pure
|
2013-10-17 09:43:55 +02:00
|
|
|
offset_type GetOffset() const {
|
2013-09-05 00:06:31 +02:00
|
|
|
assert(ready);
|
|
|
|
|
|
|
|
return offset;
|
|
|
|
}
|
|
|
|
|
|
|
|
gcc_pure
|
|
|
|
bool IsSeekable() const {
|
|
|
|
assert(ready);
|
|
|
|
|
|
|
|
return seekable;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Determines whether seeking is cheap. This is true for local files.
|
|
|
|
*/
|
|
|
|
gcc_pure
|
|
|
|
bool CheapSeeking() const;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Seeks to the specified position in the stream. This will most
|
|
|
|
* likely fail if the "seekable" flag is false.
|
|
|
|
*
|
|
|
|
* The caller must lock the mutex.
|
|
|
|
*
|
|
|
|
* @param offset the relative offset
|
|
|
|
* @param whence the base of the seek, one of SEEK_SET, SEEK_CUR, SEEK_END
|
|
|
|
*/
|
2013-10-17 09:43:55 +02:00
|
|
|
bool Seek(offset_type offset, int whence, Error &error);
|
2013-09-05 00:06:31 +02:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Wrapper for Seek() which locks and unlocks the mutex; the
|
|
|
|
* caller must not be holding it already.
|
|
|
|
*/
|
2013-10-17 09:43:55 +02:00
|
|
|
bool LockSeek(offset_type offset, int whence, Error &error);
|
2013-09-05 00:06:31 +02:00
|
|
|
|
2013-10-23 21:22:29 +02:00
|
|
|
/**
|
|
|
|
* Rewind to the beginning of the stream. This is a wrapper
|
|
|
|
* for Seek(0, SEEK_SET, error).
|
|
|
|
*/
|
|
|
|
bool Rewind(Error &error);
|
|
|
|
bool LockRewind(Error &error);
|
|
|
|
|
2013-09-05 00:06:31 +02:00
|
|
|
/**
|
|
|
|
* Returns true if the stream has reached end-of-file.
|
|
|
|
*
|
|
|
|
* The caller must lock the mutex.
|
|
|
|
*/
|
|
|
|
gcc_pure
|
|
|
|
bool IsEOF();
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Wrapper for IsEOF() which locks and unlocks the mutex; the
|
|
|
|
* caller must not be holding it already.
|
|
|
|
*/
|
|
|
|
gcc_pure
|
|
|
|
bool LockIsEOF();
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Reads the tag from the stream.
|
|
|
|
*
|
|
|
|
* The caller must lock the mutex.
|
|
|
|
*
|
|
|
|
* @return a tag object which must be freed by the caller, or
|
|
|
|
* nullptr if the tag has not changed since the last call
|
|
|
|
*/
|
|
|
|
gcc_malloc
|
|
|
|
Tag *ReadTag();
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Wrapper for ReadTag() which locks and unlocks the mutex;
|
|
|
|
* the caller must not be holding it already.
|
|
|
|
*/
|
|
|
|
gcc_malloc
|
|
|
|
Tag *LockReadTag();
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Returns true if the next read operation will not block: either data
|
|
|
|
* is available, or end-of-stream has been reached, or an error has
|
|
|
|
* occurred.
|
|
|
|
*
|
|
|
|
* The caller must lock the mutex.
|
|
|
|
*/
|
|
|
|
gcc_pure
|
|
|
|
bool IsAvailable();
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Reads data from the stream into the caller-supplied buffer.
|
|
|
|
* Returns 0 on error or eof (check with IsEOF()).
|
|
|
|
*
|
|
|
|
* The caller must lock the mutex.
|
|
|
|
*
|
2013-10-23 22:08:59 +02:00
|
|
|
* @param is the InputStream object
|
2013-09-05 00:06:31 +02:00
|
|
|
* @param ptr the buffer to read into
|
|
|
|
* @param size the maximum number of bytes to read
|
|
|
|
* @return the number of bytes read
|
|
|
|
*/
|
|
|
|
gcc_nonnull_all
|
|
|
|
size_t Read(void *ptr, size_t size, Error &error);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Wrapper for Read() which locks and unlocks the mutex;
|
|
|
|
* the caller must not be holding it already.
|
|
|
|
*/
|
|
|
|
gcc_nonnull_all
|
|
|
|
size_t LockRead(void *ptr, size_t size, Error &error);
|
|
|
|
};
|
2013-01-24 19:14:40 +01:00
|
|
|
|
|
|
|
#endif
|