MPD

src/archive_plugin.h

Go to the documentation of this file.
00001 /*
00002  * Copyright (C) 2003-2010 The Music Player Daemon Project
00003  * http://www.musicpd.org
00004  *
00005  * This program is free software; you can redistribute it and/or modify
00006  * it under the terms of the GNU General Public License as published by
00007  * the Free Software Foundation; either version 2 of the License, or
00008  * (at your option) any later version.
00009  *
00010  * This program is distributed in the hope that it will be useful,
00011  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00012  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00013  * GNU General Public License for more details.
00014  *
00015  * You should have received a copy of the GNU General Public License along
00016  * with this program; if not, write to the Free Software Foundation, Inc.,
00017  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
00018  */
00019 
00020 #ifndef MPD_ARCHIVE_PLUGIN_H
00021 #define MPD_ARCHIVE_PLUGIN_H
00022 
00023 #include <glib.h>
00024 
00025 #include <stdbool.h>
00026 
00027 struct input_stream;
00028 struct archive_file;
00029 
00030 struct archive_plugin {
00031         const char *name;
00032 
00038         bool (*init)(void);
00039 
00044         void (*finish)(void);
00045 
00051         struct archive_file *(*open)(const char *path_fs, GError **error_r);
00052 
00058         void  (*scan_reset)(struct archive_file *);
00059 
00065         char *(*scan_next)(struct archive_file *);
00066 
00074         struct input_stream *(*open_stream)(struct archive_file *af,
00075                                             const char *path,
00076                                             GError **error_r);
00077 
00081         void (*close)(struct archive_file *);
00082 
00087         const char *const*suffixes;
00088 };
00089 
00090 struct archive_file *
00091 archive_file_open(const struct archive_plugin *plugin, const char *path,
00092                   GError **error_r);
00093 
00094 void
00095 archive_file_close(struct archive_file *file);
00096 
00097 void
00098 archive_file_scan_reset(struct archive_file *file);
00099 
00100 char *
00101 archive_file_scan_next(struct archive_file *file);
00102 
00103 struct input_stream *
00104 archive_file_open_stream(struct archive_file *file,
00105                          const char *path, GError **error_r);
00106 
00107 #endif