aboutsummaryrefslogtreecommitdiff
path: root/src/filter/ChainFilterPlugin.cxx
blob: b232d6568703334f88e852a6896749398f6c6d01 (plain)
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
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
/*
 * Copyright (C) 2003-2013 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.
 */

#include "config.h"
#include "ChainFilterPlugin.hxx"
#include "conf.h"
#include "FilterPlugin.hxx"
#include "FilterInternal.hxx"
#include "FilterRegistry.hxx"
#include "audio_format.h"

#include <glib.h>

#include <list>

#include <assert.h>

struct ChainFilter {
	/** the base class */
	struct filter base;

	std::list<struct filter *> children;

	ChainFilter() {
		filter_init(&base, &chain_filter_plugin);
	}

	~ChainFilter() {
		for (auto i : children)
			filter_free(i);
	}
};

static inline GQuark
filter_quark(void)
{
	return g_quark_from_static_string("filter");
}

static struct filter *
chain_filter_init(gcc_unused const struct config_param *param,
		  gcc_unused GError **error_r)
{
	ChainFilter *chain = new ChainFilter();

	return &chain->base;
}

static void
chain_filter_finish(struct filter *_filter)
{
	ChainFilter *chain = (ChainFilter *)_filter;

	delete chain;
}

/**
 * Close all filters in the chain until #until is reached.  #until
 * itself is not closed.
 */
static void
chain_close_until(ChainFilter *chain, const struct filter *until)
{
	for (auto filter : chain->children) {
		if (filter == until)
			/* don't close this filter */
			return;

		/* close this filter */
		filter_close(filter);
	}

	/* this assertion fails if #until does not exist (anymore) */
	assert(false);
}

static const struct audio_format *
chain_open_child(struct filter *filter,
		 const struct audio_format *prev_audio_format,
		 GError **error_r)
{
	struct audio_format conv_audio_format = *prev_audio_format;
	const struct audio_format *next_audio_format;

	next_audio_format = filter_open(filter, &conv_audio_format, error_r);
	if (next_audio_format == NULL)
		return NULL;

	if (!audio_format_equals(&conv_audio_format, prev_audio_format)) {
		struct audio_format_string s;

		filter_close(filter);
		g_set_error(error_r, filter_quark(), 0,
			    "Audio format not supported by filter '%s': %s",
			    filter->plugin->name,
			    audio_format_to_string(prev_audio_format, &s));
		return NULL;
	}

	return next_audio_format;
}

static const struct audio_format *
chain_filter_open(struct filter *_filter, struct audio_format *in_audio_format,
		  GError **error_r)
{
	ChainFilter *chain = (ChainFilter *)_filter;
	const struct audio_format *audio_format = in_audio_format;

	for (auto filter : chain->children) {
		audio_format = chain_open_child(filter, audio_format, error_r);
		if (audio_format == NULL) {
			/* rollback, close all children */
			chain_close_until(chain, filter);
			return NULL;
		}
	}

	/* return the output format of the last filter */
	return audio_format;
}

static void
chain_filter_close(struct filter *_filter)
{
	ChainFilter *chain = (ChainFilter *)_filter;

	for (auto filter : chain->children)
		filter_close(filter);
}

static const void *
chain_filter_filter(struct filter *_filter,
		    const void *src, size_t src_size,
		    size_t *dest_size_r, GError **error_r)
{
	ChainFilter *chain = (ChainFilter *)_filter;

	for (auto filter : chain->children) {
		/* feed the output of the previous filter as input
		   into the current one */
		src = filter_filter(filter, src, src_size, &src_size, error_r);
		if (src == NULL)
			return NULL;
	}

	/* return the output of the last filter */
	*dest_size_r = src_size;
	return src;
}

const struct filter_plugin chain_filter_plugin = {
	"chain",
	chain_filter_init,
	chain_filter_finish,
	chain_filter_open,
	chain_filter_close,
	chain_filter_filter,
};

struct filter *
filter_chain_new(void)
{
	struct filter *filter = filter_new(&chain_filter_plugin, NULL, NULL);
	/* chain_filter_init() never fails */
	assert(filter != NULL);

	return filter;
}

void
filter_chain_append(struct filter *_chain, struct filter *filter)
{
	ChainFilter *chain = (ChainFilter *)_chain;

	chain->children.push_back(filter);
}