[gupnp-av] Add media collection class
- From: Jens Georg <jensgeorg src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gupnp-av] Add media collection class
- Date: Mon, 19 Nov 2012 12:31:34 +0000 (UTC)
commit b61e03ab2c64b3df664f8a08e6ac6b040c063318
Author: Jens Georg <mail jensge org>
Date: Tue Oct 30 21:37:15 2012 +0100
Add media collection class
doc/gupnp-av-docs.sgml | 1 +
doc/gupnp-av-sections.txt | 24 ++
doc/gupnp-av.types | 1 +
libgupnp-av/Makefile.am | 3 +
libgupnp-av/gupnp-av.h | 2 +-
libgupnp-av/gupnp-media-collection.c | 393 ++++++++++++++++++++++++++++++++++
libgupnp-av/gupnp-media-collection.h | 100 +++++++++
7 files changed, 523 insertions(+), 1 deletions(-)
---
diff --git a/doc/gupnp-av-docs.sgml b/doc/gupnp-av-docs.sgml
index 76f2336..93b6340 100644
--- a/doc/gupnp-av-docs.sgml
+++ b/doc/gupnp-av-docs.sgml
@@ -62,6 +62,7 @@
<xi:include href="xml/gupnp-protocol-info.xml"/>
<xi:include href="xml/gupnp-feature.xml"/>
<xi:include href="xml/gupnp-feature-list-parser.xml"/>
+ <xi:include href="xml/gupnp-media-collection.xml"/>
</chapter>
diff --git a/doc/gupnp-av-sections.txt b/doc/gupnp-av-sections.txt
index 3164f3f..65ec29c 100644
--- a/doc/gupnp-av-sections.txt
+++ b/doc/gupnp-av-sections.txt
@@ -432,6 +432,30 @@ gupnp_feature_list_parser_get_type
</SECTION>
<SECTION>
+<FILE>gupnp-media-collection</FILE>
+<TITLE>GUPnPMediaCollection</TITLE>
+GUPnPMediaCollectionType
+GUPnPMediaCollection
+GUPnPMediaCollectionClass
+gupnp_media_collection_new
+gupnp_media_collection_set_title
+gupnp_media_collection_get_title
+gupnp_media_collection_set_author
+gupnp_media_collection_get_author
+gupnp_media_collection_add_item
+gupnp_media_collection_get_string
+<SUBSECTION Standard>
+GUPNP_IS_MEDIA_COLLECTION
+GUPNP_IS_MEDIA_COLLECTION_CLASS
+GUPNP_MEDIA_COLLECTION
+GUPNP_MEDIA_COLLECTION_CLASS
+GUPNP_MEDIA_COLLECTION_GET_CLASS
+GUPNP_TYPE_MEDIA_COLLECTION
+GUPnPMediaCollectionPrivate
+gupnp_media_collection_get_type
+</SECTION>
+
+<SECTION>
<FILE>gupnp-av-error</FILE>
<TITLE>Error codes</TITLE>
GUPNP_PROTOCOL_ERROR
diff --git a/doc/gupnp-av.types b/doc/gupnp-av.types
index 6e75f28..1e488f9 100644
--- a/doc/gupnp-av.types
+++ b/doc/gupnp-av.types
@@ -14,3 +14,4 @@ gupnp_search_criteria_parser_get_type
gupnp_search_criteria_op_get_type
gupnp_feature_get_type
gupnp_feature_list_parser_get_type
+gupnp_media_collection_get_type
diff --git a/libgupnp-av/Makefile.am b/libgupnp-av/Makefile.am
index 5d0b6f9..0c8910c 100644
--- a/libgupnp-av/Makefile.am
+++ b/libgupnp-av/Makefile.am
@@ -27,6 +27,7 @@ libgupnp_av_inc_HEADERS = gupnp-didl-lite-object.h \
gupnp-protocol-info.h \
gupnp-search-criteria-parser.h \
gupnp-last-change-parser.h \
+ gupnp-media-collection.h \
gupnp-feature.h \
gupnp-feature-list-parser.h \
gupnp-dlna.h \
@@ -65,6 +66,7 @@ libgupnp_av_1_0_la_SOURCES = gupnp-didl-lite-object.c \
gupnp-protocol-info.c \
gupnp-search-criteria-parser.c \
gupnp-last-change-parser.c \
+ gupnp-media-collection.c \
gupnp-feature.c \
gupnp-feature-list-parser.c \
gupnp-dlna.c \
@@ -108,6 +110,7 @@ introspection_sources = \
$(top_srcdir)/libgupnp-av/gupnp-protocol-info.c \
$(top_srcdir)/libgupnp-av/gupnp-search-criteria-parser.c \
$(top_srcdir)/libgupnp-av/gupnp-last-change-parser.c \
+ $(top_srcdir)/libgupnp-av/gupnp-media-collection.c \
$(top_srcdir)/libgupnp-av/gupnp-feature.c \
$(top_srcdir)/libgupnp-av/gupnp-feature-list-parser.c \
$(top_srcdir)/libgupnp-av/gupnp-dlna.c \
diff --git a/libgupnp-av/gupnp-av.h b/libgupnp-av/gupnp-av.h
index 21da810..dbf9df0 100644
--- a/libgupnp-av/gupnp-av.h
+++ b/libgupnp-av/gupnp-av.h
@@ -36,4 +36,4 @@
#include "gupnp-feature.h"
#include "gupnp-feature-list-parser.h"
#include "gupnp-dlna.h"
-
+#include "gupnp-media-collection.h"
diff --git a/libgupnp-av/gupnp-media-collection.c b/libgupnp-av/gupnp-media-collection.c
new file mode 100644
index 0000000..16a0593
--- /dev/null
+++ b/libgupnp-av/gupnp-media-collection.c
@@ -0,0 +1,393 @@
+/*
+ * Copyright (C) 2012 Intel Corporation.
+ *
+ * Authors: Jens Georg <jensg openismus com>
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Library General Public
+ * License as published by the Free Software Foundation; either
+ * version 2 of the License, or (at your option) any later version.
+ *
+ * This library 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
+ * Library General Public License for more details.
+ *
+ * You should have received a copy of the GNU Library General Public
+ * License along with this library; if not, write to the
+ * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+ * Boston, MA 02110-1301, USA.
+ */
+
+/**
+ * SECTION:gupnp-media-collection
+ * @short_description: Media collection writer
+ *
+ * #GUPnPMediaCollection is a helper class for writing media collection files.
+ **/
+
+#include "gupnp-media-collection.h"
+#include "gupnp-didl-lite-writer.h"
+#include "gupnp-didl-lite-writer-private.h"
+
+// DIDL_S allowed tags as per DLNA Guidelines 11.1
+#define DIDL_S_FILTER "dc:title,dc:creator,upnp:class,upnp:album,res,item," \
+ "container,dlna:lifetime"
+
+G_DEFINE_TYPE (GUPnPMediaCollection,
+ gupnp_media_collection,
+ G_TYPE_OBJECT);
+
+struct _GUPnPMediaCollectionPrivate {
+ GUPnPDIDLLiteWriter *writer;
+ GUPnPDIDLLiteObject *container;
+ GList *items;
+};
+
+enum {
+ PROP_0,
+ PROP_AUTHOR,
+ PROP_TITLE,
+};
+
+static void
+reparent_children (GUPnPMediaCollection *collection)
+{
+ GList *it;
+ xmlNode *container_node;
+
+ container_node = gupnp_didl_lite_object_get_xml_node
+ (collection->priv->container);
+
+ /* Reverse iterate the list to get the correct order in XML */
+ it = g_list_last (collection->priv->items);
+ while (it) {
+ xmlNode *node;
+
+ node = gupnp_didl_lite_object_get_xml_node
+ (GUPNP_DIDL_LITE_OBJECT (it->data));
+ xmlUnlinkNode (node);
+ node = xmlAddChild (container_node, node);
+
+ it = it->prev;
+ }
+}
+
+
+static void
+gupnp_media_collection_init (GUPnPMediaCollection *collection)
+{
+ collection->priv = G_TYPE_INSTANCE_GET_PRIVATE
+ (collection,
+ GUPNP_TYPE_MEDIA_COLLECTION,
+ GUPnPMediaCollectionPrivate);
+}
+
+static void
+gupnp_media_collection_set_property (GObject *object,
+ guint property_id,
+ const GValue *value,
+ GParamSpec *pspec)
+{
+ GUPnPMediaCollection *collection;
+
+ collection = GUPNP_MEDIA_COLLECTION (object);
+
+ switch (property_id) {
+ case PROP_AUTHOR:
+ gupnp_media_collection_set_author (collection,
+ g_value_get_string (value));
+ break;
+ case PROP_TITLE:
+ gupnp_media_collection_set_title (collection,
+ g_value_get_string (value));
+ break;
+ default:
+ G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
+ break;
+ }
+}
+
+static void
+gupnp_media_collection_get_property (GObject *object,
+ guint property_id,
+ GValue *value,
+ GParamSpec *pspec)
+{
+ GUPnPMediaCollection *collection;
+
+ collection = GUPNP_MEDIA_COLLECTION (object);
+
+ switch (property_id) {
+ case PROP_AUTHOR:
+ g_value_set_string
+ (value, gupnp_media_collection_get_author (collection));
+ break;
+ case PROP_TITLE:
+ g_value_set_string
+ (value, gupnp_media_collection_get_title (collection));
+ break;
+ default:
+ G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
+ break;
+ }
+}
+
+static void
+gupnp_media_collection_constructed (GObject *object)
+{
+ GUPnPMediaCollection *collection;
+ GObjectClass *object_class;
+
+ collection = GUPNP_MEDIA_COLLECTION (object);
+ if (collection->priv->writer == NULL)
+ collection->priv->writer = gupnp_didl_lite_writer_new (NULL);
+
+ object_class = G_OBJECT_CLASS (gupnp_media_collection_parent_class);
+ if (object_class->constructed != NULL)
+ object_class->constructed (object);
+}
+
+static void
+gupnp_media_collection_dispose (GObject *object)
+{
+ GUPnPMediaCollection *collection;
+ GObjectClass *object_class;
+
+ collection = GUPNP_MEDIA_COLLECTION (object);
+
+ if (collection->priv->writer) {
+ g_object_unref (collection->priv->writer);
+ collection->priv->writer = NULL;
+ }
+
+ if (collection->priv->items) {
+ g_list_free_full (collection->priv->items, g_object_unref);
+ collection->priv->items = NULL;
+ }
+
+ if (collection->priv->container) {
+ g_object_unref (collection->priv->container);
+ collection->priv->container = NULL;
+ }
+
+ object_class = G_OBJECT_CLASS (gupnp_media_collection_parent_class);
+ object_class->dispose (object);
+}
+
+static void
+gupnp_media_collection_class_init (GUPnPMediaCollectionClass *klass)
+{
+ GObjectClass *object_class;
+
+ object_class = G_OBJECT_CLASS (klass);
+
+ object_class->set_property = gupnp_media_collection_set_property;
+ object_class->get_property = gupnp_media_collection_get_property;
+ object_class->constructed = gupnp_media_collection_constructed;
+ object_class->dispose = gupnp_media_collection_dispose;
+
+ g_type_class_add_private (klass, sizeof (GUPnPMediaCollectionPrivate));
+
+ /**
+ * GUPnPMediaCollection:author:
+ *
+ * The author of this media collection.
+ **/
+ g_object_class_install_property
+ (object_class,
+ PROP_AUTHOR,
+ g_param_spec_string ("author",
+ "Author",
+ "The author of this collection",
+ NULL,
+ G_PARAM_READWRITE |
+ G_PARAM_CONSTRUCT |
+ G_PARAM_STATIC_STRINGS));
+
+ /**
+ * GUPnPMediaCollection:title:
+ *
+ * The title of this media collection.
+ **/
+ g_object_class_install_property
+ (object_class,
+ PROP_AUTHOR,
+ g_param_spec_string ("title",
+ "Title",
+ "The title of this collection",
+ NULL,
+ G_PARAM_READWRITE |
+ G_PARAM_CONSTRUCT |
+ G_PARAM_STATIC_STRINGS));
+}
+
+/**
+ * gupnp_media_collection_new:
+ *
+ * Create a new writable media collection.
+ *
+ * Returns: (transfer full): A new #GUPnPMediaCollection.
+ **/
+GUPnPMediaCollection *
+gupnp_media_collection_new ()
+{
+ return g_object_new (GUPNP_TYPE_MEDIA_COLLECTION, NULL);
+}
+
+/**
+ * gupnp_media_collection_set_title:
+ * @collection: #GUPnPMediaCollection
+ * @title: New Title of this collection;
+ *
+ * Set the title of a #GUPnPMediaCollection.
+ **/
+void
+gupnp_media_collection_set_title (GUPnPMediaCollection *collection,
+ const char *title)
+{
+ GUPnPDIDLLiteContainer *container;
+
+ g_return_if_fail (GUPNP_IS_MEDIA_COLLECTION (collection));
+
+ if (title == NULL)
+ return;
+
+ if (collection->priv->container != NULL) {
+ gupnp_didl_lite_object_set_title (collection->priv->container,
+ title);
+
+ return;
+ }
+
+ if (collection->priv->writer == NULL)
+ collection->priv->writer = gupnp_didl_lite_writer_new (NULL);
+
+ container = gupnp_didl_lite_writer_add_container
+ (collection->priv->writer);
+ collection->priv->container = GUPNP_DIDL_LITE_OBJECT (container);
+
+ reparent_children (collection);
+
+ gupnp_didl_lite_object_set_title (collection->priv->container,
+ title);
+}
+
+/**
+ * gupnp_media_collection_get_title:
+ * @collection: #GUPnPMediaCollection
+ *
+ * Returns: The title of this media collection or %NULL if not set.
+ **/
+const char *
+gupnp_media_collection_get_title (GUPnPMediaCollection *collection)
+{
+ g_return_val_if_fail (GUPNP_IS_MEDIA_COLLECTION (collection), NULL);
+
+ if (collection->priv->container == NULL)
+ return NULL;
+
+ return gupnp_didl_lite_object_get_title (collection->priv->container);
+}
+
+/**
+ * gupnp_media_collection_set_author:
+ * @collection: #GUPnPMediaCollection
+ * @author: New author of this media collection.
+ *
+ * Set the author of the media collection
+ **/
+void
+gupnp_media_collection_set_author (GUPnPMediaCollection *collection,
+ const char *author)
+{
+ GUPnPDIDLLiteContainer *container;
+
+ g_return_if_fail (GUPNP_IS_MEDIA_COLLECTION (collection));
+
+ if (author == NULL)
+ return;
+
+ if (collection->priv->container != NULL) {
+ gupnp_didl_lite_object_set_creator (collection->priv->container,
+ author);
+
+ return;
+ }
+
+ if (collection->priv->writer == NULL)
+ collection->priv->writer = gupnp_didl_lite_writer_new (NULL);
+
+ container = gupnp_didl_lite_writer_add_container
+ (collection->priv->writer);
+ collection->priv->container = GUPNP_DIDL_LITE_OBJECT (container);
+
+ reparent_children (collection);
+
+ gupnp_didl_lite_object_set_creator (collection->priv->container,
+ author);
+}
+
+/**
+ * gupnp_media_collection_get_author:
+ * @collection: #GUPnPMediaCollection
+ *
+ * Returns: The author of this media collection or %NULL if not set.
+ **/
+const char *
+gupnp_media_collection_get_author (GUPnPMediaCollection *collection)
+{
+ g_return_val_if_fail (GUPNP_IS_MEDIA_COLLECTION (collection), NULL);
+
+ if (collection->priv->container == NULL)
+ return NULL;
+
+ return gupnp_didl_lite_object_get_creator (collection->priv->container);
+}
+
+/**
+ * gupnp_media_collection_add_item:
+ * @collection: #GUPnPMediaCollection
+ *
+ * Return value: (transfer full): A new #GUPnPDIDLLiteItem object. Unref after
+ * usage.
+ **/
+GUPnPDIDLLiteItem *
+gupnp_media_collection_add_item (GUPnPMediaCollection *collection)
+{
+ g_return_val_if_fail (collection != NULL, NULL);
+ g_return_val_if_fail (GUPNP_IS_MEDIA_COLLECTION (collection), NULL);
+ GUPnPDIDLLiteItem *item = NULL;
+
+ if (collection->priv->container != NULL)
+ item = gupnp_didl_lite_writer_add_container_child_item
+ (collection->priv->writer,
+ GUPNP_DIDL_LITE_CONTAINER (collection->priv->container));
+ else
+ item = gupnp_didl_lite_writer_add_item
+ (collection->priv->writer);
+
+ /* Keep a reference of the object in case we need to do reparenting */
+ collection->priv->items = g_list_append (collection->priv->items,
+ g_object_ref (item));
+
+ return item;
+}
+
+/**
+ * gupnp_media_collection_get_string:
+ * @collection: #GUPnPMediaCollection
+ *
+ * Return value: (transfer full): XML string representing this media
+ * collection. g_free() after use.
+ **/
+char *
+gupnp_media_collection_get_string (GUPnPMediaCollection *collection)
+{
+ g_return_val_if_fail (collection != NULL, NULL);
+ g_return_val_if_fail (GUPNP_IS_MEDIA_COLLECTION (collection), NULL);
+
+ gupnp_didl_lite_writer_filter_tags (collection->priv->writer,
+ DIDL_S_FILTER);
+ return gupnp_didl_lite_writer_get_string (collection->priv->writer);
+}
diff --git a/libgupnp-av/gupnp-media-collection.h b/libgupnp-av/gupnp-media-collection.h
new file mode 100644
index 0000000..fba0e42
--- /dev/null
+++ b/libgupnp-av/gupnp-media-collection.h
@@ -0,0 +1,100 @@
+/*
+ * Copyright (C) 2012 Intel Corporation.
+ *
+ * Authors: Jens Georg <jensg openismus com>
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Library General Public
+ * License as published by the Free Software Foundation; either
+ * version 2 of the License, or (at your option) any later version.
+ *
+ * This library 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
+ * Library General Public License for more details.
+ *
+ * You should have received a copy of the GNU Library General Public
+ * License along with this library; if not, write to the
+ * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+ * Boston, MA 02110-1301, USA.
+ */
+
+#ifndef __GUPNP_DIDL_LITE_MEDIA_COLLECTION_H__
+#define __GUPNP_DIDL_LITE_MEDIA_COLLECTION_H__
+
+#include <glib-object.h>
+
+#include "gupnp-didl-lite-item.h"
+
+G_BEGIN_DECLS
+
+GType
+gupnp_media_collection_get_type (void) G_GNUC_CONST;
+
+#define GUPNP_TYPE_MEDIA_COLLECTION \
+ (gupnp_media_collection_get_type ())
+#define GUPNP_MEDIA_COLLECTION(obj) \
+ (G_TYPE_CHECK_INSTANCE_CAST ((obj), \
+ GUPNP_TYPE_MEDIA_COLLECTION, \
+ GUPnPMediaCollection))
+#define GUPNP_MEDIA_COLLECTION_CLASS(obj) \
+ (G_TYPE_CHECK_CLASS_CAST ((obj), \
+ GUPNP_TYPE_MEDIA_COLLECTION, \
+ GUPnPMediaCollectionClass))
+#define GUPNP_IS_MEDIA_COLLECTION(obj) \
+ (G_TYPE_CHECK_INSTANCE_TYPE ((obj), \
+ GUPNP_TYPE_MEDIA_COLLECTION))
+#define GUPNP_IS_MEDIA_COLLECTION_CLASS(obj) \
+ (G_TYPE_CHECK_CLASS_TYPE ((obj), \
+ GUPNP_TYPE_MEDIA_COLLECTION))
+#define GUPNP_MEDIA_COLLECTION_GET_CLASS(obj) \
+ (G_TYPE_INSTANCE_GET_CLASS ((obj), \
+ GUPNP_TYPE_MEDIA_COLLECTION, \
+ GUPnPMediaCollectionClass))
+
+typedef struct _GUPnPMediaCollectionPrivate GUPnPMediaCollectionPrivate;
+typedef struct _GUPnPMediaCollection GUPnPMediaCollection;
+typedef struct _GUPnPMediaCollectionClass GUPnPMediaCollectionClass;
+
+struct _GUPnPMediaCollection {
+ GObject parent;
+
+ GUPnPMediaCollectionPrivate *priv;
+};
+
+struct _GUPnPMediaCollectionClass {
+ GObjectClass parent_class;
+
+ /* padding */
+ void (* _gupnp_reserved1) (void);
+ void (* _gupnp_reserved2) (void);
+ void (* _gupnp_reserved3) (void);
+ void (* _gupnp_reserved4) (void);
+};
+
+GUPnPMediaCollection *
+gupnp_media_collection_new ();
+
+void
+gupnp_media_collection_set_title (GUPnPMediaCollection *collection,
+ const char *title);
+
+const char *
+gupnp_media_collection_get_title (GUPnPMediaCollection *collection);
+
+void
+gupnp_media_collection_set_author (GUPnPMediaCollection *collection,
+ const char *author);
+
+const char *
+gupnp_media_collection_get_author (GUPnPMediaCollection *collection);
+
+GUPnPDIDLLiteItem *
+gupnp_media_collection_add_item (GUPnPMediaCollection *collection);
+
+char *
+gupnp_media_collection_get_string (GUPnPMediaCollection *collection);
+
+G_END_DECLS
+
+#endif /* __GUPNP_DIDL_LITE_MEDIA_COLLECTION_H__ */
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
