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
|
/*
* Copyright 2003-2017 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_PLAYLIST_PLUGIN_HXX
#define MPD_PLAYLIST_PLUGIN_HXX
#include "input/Ptr.hxx"
struct ConfigBlock;
struct Tag;
class Mutex;
class Cond;
class SongEnumerator;
struct playlist_plugin {
const char *name;
/**
* Initialize the plugin. Optional method.
*
* @param block 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 ConfigBlock &block);
/**
* Deinitialize a plugin which was initialized successfully.
* Optional method.
*/
void (*finish)();
/**
* Opens the playlist on the specified URI. This URI has
* either matched one of the schemes or one of the suffixes.
*/
SongEnumerator *(*open_uri)(const char *uri,
Mutex &mutex, Cond &cond);
/**
* Opens the playlist in the specified input stream. It has
* either matched one of the suffixes or one of the MIME
* types.
*
* @parm is the input stream; the pointer will not be
* invalidated when the function returns nullptr
*/
SongEnumerator *(*open_stream)(InputStreamPtr &&is);
const char *const*schemes;
const char *const*suffixes;
const char *const*mime_types;
};
/**
* Initialize a plugin.
*
* @param block 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
*/
static inline bool
playlist_plugin_init(const struct playlist_plugin *plugin,
const ConfigBlock &block)
{
return plugin->init != nullptr
? plugin->init(block)
: true;
}
/**
* Deinitialize a plugin which was initialized successfully.
*/
static inline void
playlist_plugin_finish(const struct playlist_plugin *plugin)
{
if (plugin->finish != nullptr)
plugin->finish();
}
static inline SongEnumerator *
playlist_plugin_open_uri(const struct playlist_plugin *plugin, const char *uri,
Mutex &mutex, Cond &cond)
{
return plugin->open_uri(uri, mutex, cond);
}
static inline SongEnumerator *
playlist_plugin_open_stream(const struct playlist_plugin *plugin,
InputStreamPtr &&is)
{
return plugin->open_stream(std::move(is));
}
#endif
|
