2009-07-03 01:02:53 +02:00
|
|
|
/*
|
2018-10-31 17:54:59 +01:00
|
|
|
* Copyright 2003-2018 The Music Player Daemon Project
|
2009-07-03 01:02:53 +02: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.
|
|
|
|
*/
|
|
|
|
|
2018-01-01 18:48:34 +01:00
|
|
|
#ifndef MPD_FILTER_HXX
|
|
|
|
#define MPD_FILTER_HXX
|
2009-07-03 01:02:53 +02:00
|
|
|
|
2016-06-22 11:15:49 +02:00
|
|
|
#include "AudioFormat.hxx"
|
|
|
|
|
2017-01-06 11:17:55 +01:00
|
|
|
#include <assert.h>
|
2013-08-10 18:02:44 +02:00
|
|
|
|
2014-08-12 16:09:07 +02:00
|
|
|
template<typename T> struct ConstBuffer;
|
2013-02-01 18:40:36 +01:00
|
|
|
|
|
|
|
class Filter {
|
2016-06-22 11:15:49 +02:00
|
|
|
protected:
|
|
|
|
AudioFormat out_audio_format;
|
|
|
|
|
2018-01-01 19:23:01 +01:00
|
|
|
explicit Filter(AudioFormat _out_audio_format) noexcept
|
2017-01-06 11:17:55 +01:00
|
|
|
:out_audio_format(_out_audio_format) {
|
|
|
|
assert(out_audio_format.IsValid());
|
|
|
|
}
|
2016-06-22 11:15:49 +02:00
|
|
|
|
2013-02-01 18:40:36 +01:00
|
|
|
public:
|
2018-01-01 19:23:01 +01:00
|
|
|
virtual ~Filter() noexcept {}
|
2013-02-01 18:40:36 +01:00
|
|
|
|
|
|
|
/**
|
2016-06-22 11:15:49 +02:00
|
|
|
* Returns the #AudioFormat produced by FilterPCM().
|
2013-02-01 18:40:36 +01:00
|
|
|
*/
|
2018-01-01 19:23:01 +01:00
|
|
|
const AudioFormat &GetOutAudioFormat() const noexcept {
|
2016-06-22 11:15:49 +02:00
|
|
|
return out_audio_format;
|
|
|
|
}
|
2013-02-01 18:40:36 +01:00
|
|
|
|
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
|
|
|
}
|
|
|
|
|
2013-02-01 18:40:36 +01:00
|
|
|
/**
|
|
|
|
* Filters a block of PCM data.
|
|
|
|
*
|
2016-09-04 14:32:09 +02:00
|
|
|
* Throws std::runtime_error on error.
|
|
|
|
*
|
2013-02-01 18:40:36 +01:00
|
|
|
* @param src the input buffer
|
|
|
|
* @return the destination buffer on success (will be
|
2016-06-22 11:15:49 +02:00
|
|
|
* invalidated by deleting this object or the next FilterPCM()
|
2017-01-11 15:24:12 +01:00
|
|
|
* or Reset() call)
|
2013-02-01 18:40:36 +01:00
|
|
|
*/
|
2016-09-04 14:32:09 +02:00
|
|
|
virtual ConstBuffer<void> FilterPCM(ConstBuffer<void> src) = 0;
|
2018-01-01 19:22:45 +01:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Flush pending data and return it. This should be called
|
|
|
|
* repepatedly until it returns nullptr.
|
|
|
|
*/
|
|
|
|
virtual ConstBuffer<void> Flush();
|
2013-02-01 18:40:36 +01:00
|
|
|
};
|
2009-07-03 01:02:53 +02:00
|
|
|
|
|
|
|
#endif
|