playlist_plugin: new plugin API for playlist parsers

Based on this API, we will add parsers for EXTM3U, PLS, ASX, last.fm
radio and others.

There is no integration into the MPD core yet.  Right now, we have a
command line test program.  This is work in progress.

5 files changed, 451 insertions, 0 deletions

diff --git a/src/playlist/m3u_playlist_plugin.c b/src/playlist/m3u_playlist_plugin.c
new file mode 100644
index 000000000..1eb2680a9
--- /dev/null
+++ b/src/playlist/m3u_playlist_plugin.c
@@ -0,0 +1,89 @@
+/*
+ * Copyright (C) 2003-2009 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.
+ */
+
+#include "playlist/m3u_playlist_plugin.h"
+#include "playlist_plugin.h"
+#include "text_input_stream.h"
+#include "uri.h"
+#include "song.h"
+
+#include <glib.h>
+
+struct m3u_playlist {
+	struct playlist_provider base;
+
+	struct text_input_stream *tis;
+};
+
+static struct playlist_provider *
+m3u_open_stream(struct input_stream *is)
+{
+	struct m3u_playlist *playlist = g_new(struct m3u_playlist, 1);
+
+	playlist_provider_init(&playlist->base, &m3u_playlist_plugin);
+	playlist->tis = text_input_stream_new(is);
+
+	return &playlist->base;
+}
+
+static void
+m3u_close(struct playlist_provider *_playlist)
+{
+	struct m3u_playlist *playlist = (struct m3u_playlist *)_playlist;
+
+	text_input_stream_free(playlist->tis);
+	g_free(playlist);
+}
+
+static struct song *
+m3u_read(struct playlist_provider *_playlist)
+{
+	struct m3u_playlist *playlist = (struct m3u_playlist *)_playlist;
+	const char *line;
+
+	do {
+		line = text_input_stream_read(playlist->tis);
+		if (line == NULL)
+			return NULL;
+
+		while (*line != 0 && g_ascii_isspace(*line))
+			++line;
+	} while (line[0] == '#' || !uri_has_scheme(line));
+
+	return song_remote_new(line);
+}
+
+static const char *const m3u_suffixes[] = {
+	"m3u",
+	NULL
+};
+
+static const char *const m3u_mime_types[] = {
+	"audio/x-mpegurl",
+	NULL
+};
+
+const struct playlist_plugin m3u_playlist_plugin = {
+	.open_stream = m3u_open_stream,
+	.close = m3u_close,
+	.read = m3u_read,
+
+	.suffixes = m3u_suffixes,
+	.mime_types = m3u_mime_types,
+};
diff --git a/src/playlist/m3u_playlist_plugin.h b/src/playlist/m3u_playlist_plugin.h
new file mode 100644
index 000000000..3cb4b8874
--- /dev/null
+++ b/src/playlist/m3u_playlist_plugin.h
@@ -0,0 +1,25 @@
+/*
+ * Copyright (C) 2003-2009 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_M3U_PLAYLIST_PLUGIN_H
+#define MPD_PLAYLIST_M3U_PLAYLIST_PLUGIN_H
+
+extern const struct playlist_plugin m3u_playlist_plugin;
+
+#endif
diff --git a/src/playlist_list.c b/src/playlist_list.c
new file mode 100644
index 000000000..c9cd1304c
--- /dev/null
+++ b/src/playlist_list.c
@@ -0,0 +1,146 @@
+/*
+ * Copyright (C) 2003-2009 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.
+ */
+
+#include "playlist_list.h"
+#include "playlist_plugin.h"
+#include "playlist/m3u_playlist_plugin.h"
+#include "input_stream.h"
+#include "uri.h"
+#include "utils.h"
+
+#include <glib.h>
+
+#include <assert.h>
+
+static const struct playlist_plugin *const playlist_plugins[] = {
+	&m3u_playlist_plugin,
+	NULL
+};
+
+/** which plugins have been initialized successfully? */
+static bool playlist_plugins_enabled[G_N_ELEMENTS(playlist_plugins)];
+
+void
+playlist_list_global_init(void)
+{
+	for (unsigned i = 0; playlist_plugins[i] != NULL; ++i)
+		playlist_plugins_enabled[i] =
+			playlist_plugin_init(playlist_plugins[i], NULL);
+}
+
+void
+playlist_list_global_finish(void)
+{
+	for (unsigned i = 0; playlist_plugins[i] != NULL; ++i)
+		if (playlist_plugins_enabled[i])
+			playlist_plugin_finish(playlist_plugins[i]);
+}
+
+struct playlist_provider *
+playlist_list_open_uri(const char *uri)
+{
+	char *scheme;
+	struct playlist_provider *playlist;
+
+	assert(uri != NULL);
+
+	scheme = g_uri_parse_scheme(uri);
+	if (scheme == NULL)
+		return NULL;
+
+	for (unsigned i = 0; playlist_plugins[i] != NULL; ++i) {
+		const struct playlist_plugin *plugin = playlist_plugins[i];
+
+		if (playlist_plugins_enabled[i] &&
+		    stringFoundInStringArray(plugin->schemes, scheme)) {
+			playlist = playlist_plugin_open_uri(plugin, uri);
+			if (playlist != NULL)
+				break;
+		}
+	}
+
+	g_free(scheme);
+	return playlist;
+}
+
+static struct playlist_provider *
+playlist_list_open_stream_mime(struct input_stream *is)
+{
+	struct playlist_provider *playlist;
+
+	assert(is != NULL);
+	assert(is->mime != NULL);
+
+	for (unsigned i = 0; playlist_plugins[i] != NULL; ++i) {
+		const struct playlist_plugin *plugin = playlist_plugins[i];
+
+		if (playlist_plugins_enabled[i] &&
+		    stringFoundInStringArray(plugin->mime_types, is->mime)) {
+			playlist = playlist_plugin_open_stream(plugin, is);
+			if (playlist != NULL)
+				return playlist;
+		}
+	}
+
+	return NULL;
+}
+
+static struct playlist_provider *
+playlist_list_open_stream_suffix(struct input_stream *is, const char *suffix)
+{
+	struct playlist_provider *playlist;
+
+	assert(is != NULL);
+	assert(suffix != NULL);
+
+	for (unsigned i = 0; playlist_plugins[i] != NULL; ++i) {
+		const struct playlist_plugin *plugin = playlist_plugins[i];
+
+		if (playlist_plugins_enabled[i] &&
+		    stringFoundInStringArray(plugin->suffixes, suffix)) {
+			playlist = playlist_plugin_open_stream(plugin, is);
+			if (playlist != NULL)
+				return playlist;
+		}
+	}
+
+	return NULL;
+}
+
+struct playlist_provider *
+playlist_list_open_stream(struct input_stream *is, const char *uri)
+{
+	const char *suffix;
+	struct playlist_provider *playlist;
+
+	if (is->mime != NULL) {
+		playlist = playlist_list_open_stream_mime(is);
+		if (playlist != NULL)
+			return playlist;
+	}
+
+	suffix = uri != NULL ? uri_get_suffix(uri) : NULL;
+	if (suffix != NULL) {
+		playlist = playlist_list_open_stream_suffix(is, suffix);
+		if (playlist != NULL)
+			return playlist;
+	}
+
+	return NULL;
+}
diff --git a/src/playlist_list.h b/src/playlist_list.h
new file mode 100644
index 000000000..b5ac52a6f
--- /dev/null
+++ b/src/playlist_list.h
@@ -0,0 +1,54 @@
+/*
+ * Copyright (C) 2003-2009 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_LIST_H
+#define MPD_PLAYLIST_LIST_H
+
+struct playlist_provider;
+struct input_stream;
+
+/**
+ * Initializes all playlist plugins.
+ */
+void
+playlist_list_global_init(void);
+
+/**
+ * Deinitializes all playlist plugins.
+ */
+void
+playlist_list_global_finish(void);
+
+/**
+ * Opens a playlist by its URI.
+ */
+struct playlist_provider *
+playlist_list_open_uri(const char *uri);
+
+/**
+ * Opens a playlist from an input stream.
+ *
+ * @param is an #input_stream object which is open and ready
+ * @param uri optional URI which was used to open the stream; may be
+ * used to select the appropriate playlist plugin
+ */
+struct playlist_provider *
+playlist_list_open_stream(struct input_stream *is, const char *uri);
+
+#endif
diff --git a/src/playlist_plugin.h b/src/playlist_plugin.h
new file mode 100644
index 000000000..3515af109
--- /dev/null
+++ b/src/playlist_plugin.h
@@ -0,0 +1,137 @@
+/*
+ * Copyright (C) 2003-2009 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_H
+#define MPD_PLAYLIST_PLUGIN_H
+
+#include <stdbool.h>
+#include <stddef.h>
+
+struct config_param;
+struct input_stream;
+struct tag;
+
+/**
+ * An object which provides the contents of a playlist.
+ */
+struct playlist_provider {
+	const struct playlist_plugin *plugin;
+};
+
+static inline void
+playlist_provider_init(struct playlist_provider *playlist,
+		       const struct playlist_plugin *plugin)
+{
+	playlist->plugin = plugin;
+}
+
+struct playlist_plugin {
+	const char *name;
+
+	/**
+	 * Initialize the plugin.  Optional method.
+	 *
+	 * @param param a configuration block for this plugin, or NULL
+	 * if none is configured
+	 * @return true if the plugin was initialized successfully,
+	 * false if the plugin is not available
+	 */
+	bool (*init)(const struct config_param *param);
+
+	/**
+	 * Deinitialize a plugin which was initialized successfully.
+	 * Optional method.
+	 */
+	void (*finish)(void);
+
+	/**
+	 * Opens the playlist on the specified URI.  This URI has
+	 * either matched one of the schemes or one of the suffixes.
+	 */
+	struct playlist_provider *(*open_uri)(const char *uri);
+
+	/**
+	 * Opens the playlist in the specified input stream.  It has
+	 * either matched one of the suffixes or one of the MIME
+	 * types.
+	 */
+	struct playlist_provider *(*open_stream)(struct input_stream *is);
+
+	void (*close)(struct playlist_provider *playlist);
+
+	struct song *(*read)(struct playlist_provider *playlist);
+
+	const char *const*schemes;
+	const char *const*suffixes;
+	const char *const*mime_types;
+};
+
+/**
+ * Initialize a plugin.
+ *
+ * @param param a configuration block for this plugin, or NULL 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 struct config_param *param)
+{
+	return plugin->init != NULL
+		? plugin->init(param)
+		: true;
+}
+
+/**
+ * Deinitialize a plugin which was initialized successfully.
+ */
+static inline void
+playlist_plugin_finish(const struct playlist_plugin *plugin)
+{
+	if (plugin->finish != NULL)
+		plugin->finish();
+}
+
+static inline struct playlist_provider *
+playlist_plugin_open_uri(const struct playlist_plugin *plugin, const char *uri)
+{
+	return plugin->open_uri(uri);
+}
+
+static inline struct playlist_provider *
+playlist_plugin_open_stream(const struct playlist_plugin *plugin,
+			    struct input_stream *is)
+{
+	return plugin->open_stream(is);
+}
+
+static inline void
+playlist_plugin_close(struct playlist_provider *playlist)
+{
+	playlist->plugin->close(playlist);
+}
+
+static inline struct song *
+playlist_plugin_read(struct playlist_provider *playlist)
+{
+	return playlist->plugin->read(playlist);
+}
+
+#endif