1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
|
/*
* Copyright (C) 2003-2015 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 Filter;
class Error;
struct filter_plugin {
const char *name;
/**
* Allocates and configures a filter.
*/
Filter *(*init)(const ConfigBlock &block, Error &error);
};
/**
* Creates a new instance of the specified filter plugin.
*
* @param plugin the filter plugin
* @param block 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 ConfigBlock &block, Error &error);
/**
* Creates a new filter, loads configuration and the plugin name from
* the specified configuration section.
*
* @param block 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 ConfigBlock &block, Error &error);
#endif
|