mpd/src/filter/Filter.hxx

74 lines
1.9 KiB
C++
Raw Normal View History

/*
2018-10-31 17:54:59 +01:00
* Copyright 2003-2018 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.
*/
2018-01-01 18:48:34 +01:00
#ifndef MPD_FILTER_HXX
#define MPD_FILTER_HXX
#include "AudioFormat.hxx"
#include <assert.h>
template<typename T> struct ConstBuffer;
class Filter {
protected:
AudioFormat out_audio_format;
2018-01-01 19:23:01 +01:00
explicit Filter(AudioFormat _out_audio_format) noexcept
:out_audio_format(_out_audio_format) {
assert(out_audio_format.IsValid());
}
public:
2018-01-01 19:23:01 +01:00
virtual ~Filter() noexcept {}
/**
* Returns the #AudioFormat produced by FilterPCM().
*/
2018-01-01 19:23:01 +01:00
const AudioFormat &GetOutAudioFormat() const noexcept {
return out_audio_format;
}
2017-01-11 15:24:12 +01:00
/**
* Reset the filter's state, e.g. drop/flush buffers.
*/
2018-01-01 19:23:01 +01:00
virtual void Reset() noexcept {
2017-01-11 15:24:12 +01:00
}
/**
* Filters a block of PCM data.
*
* Throws std::runtime_error on error.
*
* @param src the input buffer
* @return the destination buffer on success (will be
* invalidated by deleting this object or the next FilterPCM()
2017-01-11 15:24:12 +01:00
* or Reset() call)
*/
virtual ConstBuffer<void> FilterPCM(ConstBuffer<void> src) = 0;
/**
* Flush pending data and return it. This should be called
2019-03-24 22:34:11 +01:00
* repeatedly until it returns nullptr.
*/
virtual ConstBuffer<void> Flush();
};
#endif