Add PLS Parser

Makefile.am

@@ -139,6 +139,7 @@ mpd_headers = \
 	src/playlist_list.h \
 	src/playlist_queue.h \
 	src/playlist/m3u_playlist_plugin.h \
+	src/playlist/pls_playlist_plugin.h \
 	src/playlist/xspf_playlist_plugin.h \
 	src/playlist/lastfm_playlist_plugin.h \
 	src/poison.h \
@@ -649,6 +650,7 @@ endif
 
 PLAYLIST_SRC = \
 	src/playlist/m3u_playlist_plugin.c \
+	src/playlist/pls_playlist_plugin.c \
 	src/playlist/xspf_playlist_plugin.c \
 	src/playlist_list.c
 

NEWS

@@ -7,7 +7,7 @@ ver 0.16 (20??/??/??)
   - range support for "delete"
   - "previous" really plays the previous song
   - "addid" with negative position is deprecated
-  - "load" supports remote playlists (m3u, xspf, lastfm://)
+  - "load" supports remote playlists (m3u, pls, xspf, lastfm://)
 * input:
   - lastfm: obsolete plugin removed
 * tags:

src/playlist/pls_playlist_plugin.c

@@ -0,0 +1,215 @@
+/*
+ * 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/pls_playlist_plugin.h"
+#include "playlist_plugin.h"
+#include "input_stream.h"
+#include "uri.h"
+#include "song.h"
+#include "tag.h"
+#include <glib.h>
+
+struct pls_playlist {
+	struct playlist_provider base;
+
+	GSList *songs;
+};
+
+static void pls_parser(GKeyFile *keyfile, struct pls_playlist *playlist)
+{
+	gchar *key;
+	gchar *value;
+	int length;
+	GError *error = NULL;
+	int num_entries = g_key_file_get_integer(keyfile, "playlist",
+						 "NumberOfEntries", &error);
+	if (error) {
+		g_debug("Invalid PLS file: '%s'", error->message);
+		g_error_free(error);
+		error = NULL;
+
+		/* Hack to work around shoutcast failure to comform to spec */
+		num_entries = g_key_file_get_integer(keyfile, "playlist",
+						     "numberofentries", &error);
+		if (error) {
+			g_error_free(error);
+			error = NULL;
+		}
+	}
+
+	while (num_entries > 0) {
+		struct song *song;
+		key = g_strdup_printf("File%i", num_entries);
+		value = g_key_file_get_string(keyfile, "playlist", key,
+					      &error);
+		if(error) {
+			g_debug("Invalid PLS entry %s: '%s'",key, error->message);
+			g_error_free(error);
+			g_free(key);
+			return;
+		}
+		g_free(key);
+
+		/* Don't load local path */
+		if(!uri_has_scheme(value)){
+			g_free(value);
+			continue;
+		}
+
+		song = song_remote_new(value);
+		g_free(value);
+
+		key = g_strdup_printf("Title%i", num_entries);
+		value = g_key_file_get_string(keyfile, "playlist", key,
+					      &error);
+		g_free(key);
+		if(error == NULL && value){
+			if (song->tag == NULL)
+				song->tag = tag_new();
+			tag_add_item(song->tag,TAG_TITLE, value);
+		}
+		/* Ignore errors? Most likely value not present */
+		if(error) g_error_free(error);
+		error = NULL;
+		g_free(value);
+
+		key = g_strdup_printf("Length%i", num_entries);
+		length = g_key_file_get_integer(keyfile, "playlist", key,
+						&error);
+		g_free(key);
+		if(error == NULL && length > 0){
+			if (song->tag == NULL)
+				song->tag = tag_new();
+			song->tag->time = length;
+		}
+		/* Ignore errors? Most likely value not present */
+		if(error) g_error_free(error);
+		error = NULL;
+
+		playlist->songs = g_slist_prepend(playlist->songs, song);
+		num_entries--;
+	}
+
+}
+
+static struct playlist_provider *
+pls_open_stream(struct input_stream *is)
+{
+	GError *error = NULL;
+	size_t nbytes;
+	char buffer[1024];
+	bool success;
+	GKeyFile *keyfile;
+	struct pls_playlist *playlist;
+	GString *kf_data = g_string_new("");
+
+	do {
+		nbytes = input_stream_read(is, buffer, sizeof(buffer));
+		if(nbytes ==0)
+			break;
+		kf_data = g_string_append_len(kf_data, buffer,nbytes);
+		/* Limit to 64k */
+	} while(kf_data->len < 65536);
+
+	if (kf_data->len == 0) {
+		g_warning("KeyFile parser failed: No Data");
+		g_string_free(kf_data, TRUE);
+		return NULL;
+	}
+
+	keyfile = g_key_file_new();
+	success = g_key_file_load_from_data(keyfile,
+					    kf_data->str, kf_data->len,
+					    G_KEY_FILE_NONE, &error);
+
+	g_string_free(kf_data, TRUE);
+
+	if (!success) {
+		g_warning("KeyFile parser failed: %s", error->message);
+		g_error_free(error);
+		g_key_file_free(keyfile);
+		return NULL;
+	}
+
+	playlist = g_new(struct pls_playlist, 1);
+	playlist_provider_init(&playlist->base, &pls_playlist_plugin);
+	playlist->songs = NULL;
+
+	pls_parser(keyfile, playlist);
+
+	g_key_file_free(keyfile);
+	return &playlist->base;
+}
+
+
+static void
+song_free_callback(gpointer data, G_GNUC_UNUSED gpointer user_data)
+{
+	struct song *song = data;
+
+	song_free(song);
+}
+
+static void
+pls_close(struct playlist_provider *_playlist)
+{
+	struct pls_playlist *playlist = (struct pls_playlist *)_playlist;
+
+	g_slist_foreach(playlist->songs, song_free_callback, NULL);
+	g_slist_free(playlist->songs);
+
+	g_free(playlist);
+
+}
+
+static struct song *
+pls_read(struct playlist_provider *_playlist)
+{
+	struct pls_playlist *playlist = (struct pls_playlist *)_playlist;
+	struct song *song;
+
+	if (playlist->songs == NULL)
+		return NULL;
+
+	song = playlist->songs->data;
+	playlist->songs = g_slist_remove(playlist->songs, song);
+
+	return song;
+}
+
+static const char *const pls_suffixes[] = {
+	"pls",
+	NULL
+};
+
+static const char *const pls_mime_types[] = {
+	"audio/x-scpls",
+	NULL
+};
+
+const struct playlist_plugin pls_playlist_plugin = {
+	.name = "pls",
+
+	.open_stream = pls_open_stream,
+	.close = pls_close,
+	.read = pls_read,
+
+	.suffixes = pls_suffixes,
+	.mime_types = pls_mime_types,
+};

src/playlist/pls_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_PLS_PLAYLIST_PLUGIN_H
+#define MPD_PLAYLIST_PLS_PLAYLIST_PLUGIN_H
+
+extern const struct playlist_plugin pls_playlist_plugin;
+
+#endif

src/playlist_list.c

@@ -22,6 +22,7 @@
 #include "playlist/m3u_playlist_plugin.h"
 #include "playlist/xspf_playlist_plugin.h"
 #include "playlist/lastfm_playlist_plugin.h"
+#include "playlist/pls_playlist_plugin.h"
 #include "input_stream.h"
 #include "uri.h"
 #include "utils.h"
@@ -36,6 +37,7 @@
 static const struct playlist_plugin *const playlist_plugins[] = {
 	&m3u_playlist_plugin,
 	&xspf_playlist_plugin,
+	&pls_playlist_plugin,
 #ifdef ENABLE_LASTFM
 	&lastfm_playlist_plugin,
 #endif