mpd/src/decoder/DecoderBuffer.hxx

119 lines
3.0 KiB
C++
Raw Normal View History

/*
2016-02-26 17:54:05 +01:00
* Copyright 2003-2016 The Music Player Daemon Project
* 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.
*/
2013-04-17 22:45:10 +02:00
#ifndef MPD_DECODER_BUFFER_HXX
#define MPD_DECODER_BUFFER_HXX
2014-01-06 22:16:56 +01:00
#include "Compiler.h"
#include "util/DynamicFifoBuffer.hxx"
#include "util/ConstBuffer.hxx"
2014-01-06 22:16:56 +01:00
#include <stddef.h>
DecoderBuffer: add missing include > In file included from src/decoder/DecoderBuffer.cxx:21:0: > src/decoder/DecoderBuffer.hxx:41:20: error: 'uint8_t' was not declared in this scope > DynamicFifoBuffer<uint8_t> buffer; > ^ > src/decoder/DecoderBuffer.hxx:41:27: error: template argument 1 is invalid > DynamicFifoBuffer<uint8_t> buffer; > ^ > src/decoder/DecoderBuffer.hxx: In member function 'void DecoderBuffer::Clear()': > src/decoder/DecoderBuffer.hxx:61:10: error: request for member 'Clear' in '((DecoderBuffer*)this)->DecoderBuffer::buffer', which is of non-class type 'int' > buffer.Clear(); > ^ > src/decoder/DecoderBuffer.hxx: In member function 'size_t DecoderBuffer::GetAvailable() const': > src/decoder/DecoderBuffer.hxx:78:17: error: request for member 'GetAvailable' in '((const DecoderBuffer*)this)->DecoderBuffer::buffer', which is of non-class type 'const int' > return buffer.GetAvailable(); > ^ > src/decoder/DecoderBuffer.hxx: In member function 'ConstBuffer<void> DecoderBuffer::Read() const': > src/decoder/DecoderBuffer.hxx:87:19: error: request for member 'Read' in '((const DecoderBuffer*)this)->DecoderBuffer::buffer', which is of non-class type 'const int' > auto r = buffer.Read(); > ^ > src/decoder/DecoderBuffer.hxx:88:27: error: could not convert '{<expression error>, <expression error>}' from '<brace-enclosed initializer list>' to 'ConstBuffer<void>' > return { r.data, r.size }; > ^ > src/decoder/DecoderBuffer.hxx: In member function 'void DecoderBuffer::Consume(size_t)': > src/decoder/DecoderBuffer.hxx:105:10: error: request for member 'Consume' in '((DecoderBuffer*)this)->DecoderBuffer::buffer', which is of non-class type 'int' > buffer.Consume(nbytes); > ^ This seems to be caused by a lacking include, fixed by the below patch. I'm unsure what made this appear now, though, compiler and toolchain libraries seem to be the same upstream versions that built 0.19.14-1 just fine in late March.
2016-04-24 22:00:56 +02:00
#include <stdint.h>
struct Decoder;
2014-05-11 15:34:48 +02:00
class InputStream;
/**
* This objects handles buffered reads in decoder plugins easily. You
* create a buffer object, and use its high-level methods to fill and
* read it. It will automatically handle shifting the buffer.
*/
2014-09-22 08:49:14 +02:00
class DecoderBuffer {
Decoder *const decoder;
InputStream &is;
DynamicFifoBuffer<uint8_t> buffer;
2014-09-22 08:49:14 +02:00
public:
/**
* Creates a new buffer.
*
* @param _decoder the decoder object, used for decoder_read(),
* may be nullptr
* @param _is the input stream object where we should read from
* @param _size the maximum size of the buffer
*/
DecoderBuffer(Decoder *_decoder, InputStream &_is,
size_t _size)
:decoder(_decoder), is(_is), buffer(_size) {}
const InputStream &GetStream() const {
return is;
}
void Clear() {
buffer.Clear();
}
2014-01-06 21:46:10 +01:00
/**
* Read data from the #InputStream and append it to the buffer.
*
* @return true if data was appended; false if there is no
* data available (yet), end of file, I/O error or a decoder
* command was received
*/
bool Fill();
/**
* How many bytes are stored in the buffer?
*/
gcc_pure
size_t GetAvailable() const {
return buffer.GetAvailable();
}
2014-07-12 00:14:15 +02:00
/**
* Reads data from the buffer. This data is not yet consumed,
* you have to call Consume() to do that. The returned buffer
* becomes invalid after a Fill() or a Consume() call.
*/
ConstBuffer<void> Read() const {
auto r = buffer.Read();
return { r.data, r.size };
}
/**
* Wait until this number of bytes are available. Returns nullptr on
* error.
*/
ConstBuffer<void> Need(size_t min_size);
/**
* Consume (delete, invalidate) a part of the buffer. The
* "nbytes" parameter must not be larger than the length
* returned by Read().
*
* @param nbytes the number of bytes to consume
*/
void Consume(size_t nbytes) {
buffer.Consume(nbytes);
}
/**
* Skips the specified number of bytes, discarding its data.
*
* @param nbytes the number of bytes to skip
* @return true on success, false on error
*/
bool Skip(size_t nbytes);
};
#endif