MPD
input_plugin.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2003-2010 The Music Player Daemon Project
3  * http://www.musicpd.org
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License as published by
7  * the Free Software Foundation; either version 2 of the License, or
8  * (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License along
16  * with this program; if not, write to the Free Software Foundation, Inc.,
17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
18  */
19 
20 #ifndef MPD_INPUT_PLUGIN_H
21 #define MPD_INPUT_PLUGIN_H
22 
23 #include "input_stream.h"
24 
25 #include <stddef.h>
26 #include <stdbool.h>
27 #include <sys/types.h>
28 
29 struct config_param;
30 struct input_stream;
31 
32 struct input_plugin {
33  const char *name;
34 
43  bool (*init)(const struct config_param *param, GError **error_r);
44 
49  void (*finish)(void);
50 
51  struct input_stream *(*open)(const char *uri, GError **error_r);
52  void (*close)(struct input_stream *is);
53 
54  struct tag *(*tag)(struct input_stream *is);
55  int (*buffer)(struct input_stream *is, GError **error_r);
56  size_t (*read)(struct input_stream *is, void *ptr, size_t size,
57  GError **error_r);
58  bool (*eof)(struct input_stream *is);
59  bool (*seek)(struct input_stream *is, goffset offset, int whence,
60  GError **error_r);
61 };
62 
63 #endif