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
|
/*
* 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.
*/
/** \file
*
* Internal stuff for the filter core and filter plugins.
*/
#ifndef MPD_FILTER_INTERNAL_HXX
#define MPD_FILTER_INTERNAL_HXX
#include <stddef.h>
struct AudioFormat;
class Error;
class Filter {
public:
virtual ~Filter() {}
/**
* Opens the filter, preparing it for FilterPCM().
*
* @param filter the filter object
* @param audio_format the audio format of incoming data; the
* plugin may modify the object to enforce another input
* format
* @param error location to store the error occurring, or nullptr
* to ignore errors.
* @return the format of outgoing data or
* AudioFormat::Undefined() on error
*/
virtual AudioFormat Open(AudioFormat &af, Error &error) = 0;
/**
* Closes the filter. After that, you may call Open() again.
*/
virtual void Close() = 0;
/**
* Filters a block of PCM data.
*
* @param filter the filter object
* @param src the input buffer
* @param src_size the size of #src_buffer in bytes
* @param dest_size_r the size of the returned buffer
* @param error location to store the error occurring, or nullptr
* to ignore errors.
* @return the destination buffer on success (will be
* invalidated by filter_close() or filter_filter()), nullptr on
* error
*/
virtual const void *FilterPCM(const void *src, size_t src_size,
size_t *dest_size_r,
Error &error) = 0;
};
#endif
|
