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
|
/*
* 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.
*/
#ifndef MPD_DECODER_PLUGIN_HXX
#define MPD_DECODER_PLUGIN_HXX
#include "Compiler.h"
struct config_param;
struct input_stream;
struct Tag;
struct tag_handler;
/**
* Opaque handle which the decoder plugin passes to the functions in
* this header.
*/
struct decoder;
struct DecoderPlugin {
const char *name;
/**
* Initialize the decoder plugin. Optional method.
*
* @param param a configuration block for this plugin, or nullptr
* if none is configured
* @return true if the plugin was initialized successfully,
* false if the plugin is not available
*/
bool (*init)(const config_param ¶m);
/**
* Deinitialize a decoder plugin which was initialized
* successfully. Optional method.
*/
void (*finish)(void);
/**
* Decode a stream (data read from an #input_stream object).
*
* Either implement this method or file_decode(). If
* possible, it is recommended to implement this method,
* because it is more versatile.
*/
void (*stream_decode)(struct decoder *decoder,
struct input_stream *is);
/**
* Decode a local file.
*
* Either implement this method or stream_decode().
*/
void (*file_decode)(struct decoder *decoder, const char *path_fs);
/**
* Scan metadata of a file.
*
* @return false if the operation has failed
*/
bool (*scan_file)(const char *path_fs,
const struct tag_handler *handler,
void *handler_ctx);
/**
* Scan metadata of a file.
*
* @return false if the operation has failed
*/
bool (*scan_stream)(struct input_stream *is,
const struct tag_handler *handler,
void *handler_ctx);
/**
* @brief Return a "virtual" filename for subtracks in
* container formats like flac
* @param const char* pathname full pathname for the file on fs
* @param const unsigned int tnum track number
*
* @return nullptr if there are no multiple files
* a filename for every single track according to tnum (param 2)
* do not include full pathname here, just the "virtual" file
*/
char* (*container_scan)(const char *path_fs, const unsigned int tnum);
/* last element in these arrays must always be a nullptr: */
const char *const*suffixes;
const char *const*mime_types;
/**
* Initialize a decoder plugin.
*
* @param param a configuration block for this plugin, or nullptr if none
* is configured
* @return true if the plugin was initialized successfully, false if
* the plugin is not available
*/
bool Init(const config_param ¶m) const {
return init != nullptr
? init(param)
: true;
}
/**
* Deinitialize a decoder plugin which was initialized successfully.
*/
void Finish() const {
if (finish != nullptr)
finish();
}
/**
* Decode a stream.
*/
void StreamDecode(decoder &decoder, input_stream &is) const {
stream_decode(&decoder, &is);
}
/**
* Decode a file.
*/
void FileDecode(decoder &decoder, const char *path_fs) const {
file_decode(&decoder, path_fs);
}
/**
* Read the tag of a file.
*/
bool ScanFile(const char *path_fs,
const tag_handler &handler, void *handler_ctx) const {
return scan_file != nullptr
? scan_file(path_fs, &handler, handler_ctx)
: false;
}
/**
* Read the tag of a stream.
*/
bool ScanStream(input_stream &is,
const tag_handler &handler, void *handler_ctx) const {
return scan_stream != nullptr
? scan_stream(&is, &handler, handler_ctx)
: false;
}
/**
* return "virtual" tracks in a container
*/
char *ContainerScan(const char *path, const unsigned int tnum) const {
return container_scan(path, tnum);
}
/**
* Does the plugin announce the specified file name suffix?
*/
gcc_pure gcc_nonnull_all
bool SupportsSuffix(const char *suffix) const;
/**
* Does the plugin announce the specified MIME type?
*/
gcc_pure gcc_nonnull_all
bool SupportsMimeType(const char *mime_type) const;
};
#endif
|
