mpd/src/filter/FilterPlugin.hxx
2017-01-03 20:48:59 +01:00

65 lines
1.7 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
*
* This header declares the filter_plugin class. It describes a
* plugin API for objects which filter raw PCM data.
*/
#ifndef MPD_FILTER_PLUGIN_HXX
#define MPD_FILTER_PLUGIN_HXX
struct ConfigBlock;
class PreparedFilter;
struct FilterPlugin {
const char *name;
/**
* Allocates and configures a filter.
*/
PreparedFilter *(*init)(const ConfigBlock &block);
};
/**
* Creates a new instance of the specified filter plugin.
*
* Throws std::runtime_error on error.
*
* @param plugin the filter plugin
* @param block configuration section
*/
PreparedFilter *
filter_new(const FilterPlugin *plugin,
const ConfigBlock &block);
/**
* Creates a new filter, loads configuration and the plugin name from
* the specified configuration section.
*
* Throws std::runtime_error on error.
*
* @param block the configuration section
*/
PreparedFilter *
filter_configured_new(const ConfigBlock &block);
#endif