new archive api, input_archive stream

1 files changed, 94 insertions, 0 deletions

diff --git a/src/archive_api.h b/src/archive_api.h
new file mode 100644
index 000000000..3c9e979f6
--- /dev/null
+++ b/src/archive_api.h
@@ -0,0 +1,94 @@
+/* the Music Player Daemon (MPD)
+ * Copyright (C) 2008 Viliam Mateicka <viliam.mateicka@gmail.com>
+ * This project's homepage is: 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ */
+
+#ifndef MPD_ARCHIVE_API_H
+#define MPD_ARCHIVE_API_H
+
+/*
+ * This is the public API which is used by archive plugins to
+ * provide transparent archive decompression layer for mpd
+ *
+ */
+
+#include "archive_internal.h"
+#include "input_stream.h"
+
+#include <stdbool.h>
+
+struct archive_file;
+
+struct archive_plugin {
+	const char *name;
+
+	/**
+	 * optional, set this to NULL if the archive plugin doesn't
+	 * have/need one this must false if there is an error and
+	 * true otherwise
+	 */
+	bool (*init)(void);
+
+	/**
+	 * optional, set this to NULL if the archive plugin doesn't
+	 * have/need one
+	 */
+	void (*finish)(void);
+
+	/**
+	 * tryes to open archive file and associates handle with archive
+	 * returns pointer to handle used is all operations with this archive
+	 * or NULL when opening fails
+	 */
+	struct archive_file *(*open)(char * pathname);
+
+	/**
+	 * reset routine will move current read index in archive to default
+	 * position and then the filenames from archives can be read
+	 * via scan_next routine
+	 */
+	void  (*scan_reset)(struct archive_file *);
+
+	/**
+	 * the read method will return corresponding files from archive
+	 * (as pathnames) and move read index to next file. When there is no
+	 * next file it return NULL.
+	 */
+	char *(*scan_next)(struct archive_file *);
+
+	/**
+	 * this is used to setup input stream handle, to be able to read
+	 * from archive. open method of inputstream can be the used to
+	 * extract particular file
+	 */
+	void (*setup_stream)(struct archive_file *, struct input_stream *is);
+
+	/**
+	 * closes archive file.
+	 */
+	void (*close)(struct archive_file *);
+
+	/**
+	 * suffixes handled by this plugin.
+	 * last element in these arrays must always be a NULL
+	 */
+	const char *const*suffixes;
+};
+
+bool archive_lookup(char *pathname, char **archive, char **inpath, char **suffix);
+
+#endif
+