85 lines
2.1 KiB
C++
85 lines
2.1 KiB
C++
/*
|
|
* Copyright 2003-2017 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.
|
|
*/
|
|
|
|
/** \file
|
|
*
|
|
* Internal stuff for the filter core and filter plugins.
|
|
*/
|
|
|
|
#ifndef MPD_FILTER_INTERNAL_HXX
|
|
#define MPD_FILTER_INTERNAL_HXX
|
|
|
|
#include "AudioFormat.hxx"
|
|
|
|
#include <assert.h>
|
|
#include <stddef.h>
|
|
|
|
struct AudioFormat;
|
|
template<typename T> struct ConstBuffer;
|
|
|
|
class Filter {
|
|
protected:
|
|
AudioFormat out_audio_format;
|
|
|
|
explicit Filter(AudioFormat _out_audio_format)
|
|
:out_audio_format(_out_audio_format) {
|
|
assert(out_audio_format.IsValid());
|
|
}
|
|
|
|
public:
|
|
virtual ~Filter() {}
|
|
|
|
/**
|
|
* Returns the #AudioFormat produced by FilterPCM().
|
|
*/
|
|
const AudioFormat &GetOutAudioFormat() const {
|
|
return out_audio_format;
|
|
}
|
|
|
|
/**
|
|
* 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()
|
|
* call)
|
|
*/
|
|
virtual ConstBuffer<void> FilterPCM(ConstBuffer<void> src) = 0;
|
|
};
|
|
|
|
class PreparedFilter {
|
|
public:
|
|
virtual ~PreparedFilter() {}
|
|
|
|
/**
|
|
* Opens the filter, preparing it for FilterPCM().
|
|
*
|
|
* Throws std::runtime_error on error.
|
|
*
|
|
* @param af the audio format of incoming data; the
|
|
* plugin may modify the object to enforce another input
|
|
* format
|
|
*/
|
|
virtual Filter *Open(AudioFormat &af) = 0;
|
|
};
|
|
|
|
#endif
|