blob: 51b44c061eb1f950052fa624064084ac57533569 (
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
|
/*
* Copyright 2003-2018 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_INPUT_PLUGIN_HXX
#define MPD_INPUT_PLUGIN_HXX
#include "Ptr.hxx"
#include "util/Compiler.h"
struct ConfigBlock;
class Mutex;
class EventLoop;
class RemoteTagScanner;
class RemoteTagHandler;
struct InputPlugin {
const char *name;
/**
* A nullptr-terminated list of URI prefixes handled by this
* plugin. This is usually a string in the form "scheme://".
*/
const char *const*prefixes;
/**
* Global initialization. This method is called when MPD starts.
*
* Throws #PluginUnavailable if the plugin is not available
* and shall be disabled.
*
* Throws std::runtime_error on (fatal) error.
*/
void (*init)(EventLoop &event_loop, const ConfigBlock &block);
/**
* Global deinitialization. Called once before MPD shuts
* down (only if init() has returned true).
*/
void (*finish)();
/**
* Attempt to open the given URI. Returns nullptr if the
* plugin does not support this URI.
*
* Throws std::runtime_error on error.
*/
InputStreamPtr (*open)(const char *uri, Mutex &mutex);
/**
* Prepare a #RemoteTagScanner. The operation must be started
* using RemoteTagScanner::Start(). Returns nullptr if the
* plugin does not support this URI.
*
* Throws on error.
*
* @return nullptr if the given URI is not supported.
*/
std::unique_ptr<RemoteTagScanner> (*scan_tags)(const char *uri,
RemoteTagHandler &handler) = nullptr;
gcc_pure
bool SupportsUri(const char *uri) const noexcept;
};
#endif
|
