diff options
author | Max Kellermann <max@duempel.org> | 2014-01-24 16:31:52 +0100 |
---|---|---|
committer | Max Kellermann <max@duempel.org> | 2014-01-24 16:43:57 +0100 |
commit | 7c52a1c04bccac68f4220c8bf3d3a59c16ed58db (patch) | |
tree | 6c1f8b99225343974584817b3278958599e2e12a /src/filter/FilterPlugin.hxx | |
parent | 9d34fc394ce30a28ec0e43f2ad7172b8de8b3be6 (diff) | |
download | mpd-7c52a1c04bccac68f4220c8bf3d3a59c16ed58db.tar.gz mpd-7c52a1c04bccac68f4220c8bf3d3a59c16ed58db.tar.xz mpd-7c52a1c04bccac68f4220c8bf3d3a59c16ed58db.zip |
Filter*: move to filter/
Diffstat (limited to 'src/filter/FilterPlugin.hxx')
-rw-r--r-- | src/filter/FilterPlugin.hxx | 67 |
1 files changed, 67 insertions, 0 deletions
diff --git a/src/filter/FilterPlugin.hxx b/src/filter/FilterPlugin.hxx new file mode 100644 index 000000000..443d29881 --- /dev/null +++ b/src/filter/FilterPlugin.hxx @@ -0,0 +1,67 @@ +/* + * Copyright (C) 2003-2014 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 config_param; +class Filter; +class Error; + +struct filter_plugin { + const char *name; + + /** + * Allocates and configures a filter. + */ + Filter *(*init)(const config_param ¶m, Error &error); +}; + +/** + * Creates a new instance of the specified filter plugin. + * + * @param plugin the filter plugin + * @param param optional configuration section + * @param error location to store the error occurring, or nullptr to + * ignore errors. + * @return a new filter object, or nullptr on error + */ +Filter * +filter_new(const struct filter_plugin *plugin, + const config_param ¶m, Error &error); + +/** + * Creates a new filter, loads configuration and the plugin name from + * the specified configuration section. + * + * @param param the configuration section + * @param error location to store the error occurring, or nullptr to + * ignore errors. + * @return a new filter object, or nullptr on error + */ +Filter * +filter_configured_new(const config_param ¶m, Error &error); + +#endif |