[Property] Support of DLNA.ORG_CI, DLNA.ORG_FLAGS and DLNA.ORG_OP

Fix https://github.com/01org/dleyna-server/issues/54

Add 3 new properties to Resource.
As for other Resources properties, they are also directly
available in MediaTiem2 or MediaContainer2 item by using the
algorithm for selecting resource, given in the section
"Transcoding and org.gnome.UPnP.MediaItem2".

Signed-off-by: Ludovic Ferrandis <ludovic.ferrandis@intel.com>

5 files changed, 197 insertions, 44 deletions

diff --git a/doc/server/dbus/API.txt b/doc/server/dbus/API.txt
index b04fcde..d040396 100644
--- a/doc/server/dbus/API.txt
+++ b/doc/server/dbus/API.txt
@@ -568,9 +568,12 @@ Additional properties unsupported by org.gnome.MediaContainer2
 | Resources              |aa{sv}|  o   |  Returns the set of resources      |
 |                        |      |      |  associated with a container       |
 |---------------------------------------------------------------------------|
-| DLNAProfile            |  s   |  o   |                                    |
-| MIMEType               |  s   |  o   |  See "Container properties"        |
-| Size                   |  x   |  o   |  paragraph below.                  |
+| DLNAConversion         | a{sb}|  o   |                                    |
+| DLNAFlags              | a{sb}|  o   |                                    |
+| DLNAOperation          | a{sb}|  o   |  See "Container properties"        |
+| DLNAProfile            |  s   |  o   |  paragraph below.                  |
+| MIMEType               |  s   |  o   |                                    |
+| Size                   |  x   |  o   |                                    |
 | UpdateCount            |  u   |  o   |                                    |
 | URLs                   |  as  |  o   |                                    |
 |---------------------------------------------------------------------------|
@@ -585,6 +588,8 @@ support different playlist formats, e.g., M3U, DIDL-S, etc. The
 properties of one of these resources may be duplicated directly in the
 Container object itself. The algorithm for selecting this resource
 is given in the section "Transcoding and org.gnome.UPnP.MediaItem2".
+In MediaItem2 section also, you will find the definition for these properties
+in Resources/Additional properties.
 
 New Methods:
 ------------
@@ -830,20 +835,42 @@ in the table below:
 The names of the properties included in this array are identical to
 the names of the org.gnome.UPnP.MediaItem2 properties to which they
 correspond, e.g., MIMEType, Size.
-However, one additional property is included.
+However, four additional properties are included.
 
-Additional property
--------------------
+Additional properties:
+----------------------
 
 |---------------------------------------------------------------------------|
-|     Name        | Type | m/o* |              Description                  |
+|     Name        | Type  | m/o* |              Description                 |
+|---------------------------------------------------------------------------|
+| DLNAConversion  | a{sb} |  o   |  Indicates whether the content of the    |
+|                 |       |      |  Resource is in original source format   |
+|                 |       |      |  or if the content is transcoded.        |
+|                 |       |      |  There are 1 key: Transcoded.            |
+|                 |       |      |  See Reference (4): DLNA.ORG_CI.         |
+|---------------------------------------------------------------------------|
+| DLNAFlags       | a{sb} |  o   |  A dictionary of boolean values          |
+|                 |       |      |  indicating the values of the various    |
+|                 |       |      |  operations supported by a resource.     |
+|                 |       |      |  There are 12 keys:                      |
+|                 |       |      |  SenderPaced, TimeBased, ByteBased,      |
+|                 |       |      |  PlayContainer, S0Increase, SNIncrease   |
+|                 |       |      |  RTSPPause, StreamingTM, InteractiveTM   |
+|                 |       |      |  BackgroundTM, ConnectionStall, DLNA_V15 |
+|                 |       |      |  See Reference (5): DLNA.ORG_FLAGS.      |
+|---------------------------------------------------------------------------|
+| DLNAOperation   | a{sb} |  o   |  A dictionary of boolean values          |
+|                 |       |      |  indicating the values of the various    |
+|                 |       |      |  DLNA Operation attributes. There are 2  |
+|                 |       |      |  keys: RangeSeek and TimeSeek.           |
+|                 |       |      |  See Reference (6): DLNA.ORG_OP.         |
 |---------------------------------------------------------------------------|
-| UpdateCount     |  u   |  o   |  Contains the number of times the         |
-|                 |      |      |  implementation detects that a change was |
-|                 |      |      |  made to the resource.                    |
+| UpdateCount     |  u    |  o   |  Contains the number of times the        |
+|                 |       |      |  implementation detects that a change    |
+|                 |       |      |  was made to the resource.               |
 |---------------------------------------------------------------------------|
 
-Please note that if you want this property to be included in the
+Please note that if you want these properties to be included in the
 results of a call to one of the List or the Search functions, and you
 are explicitly filtering properties, you must include "Resource" in
 the filter array.  The filter parameter also applies to the contents
@@ -935,3 +962,6 @@ References:
 2) DLNA Guidelines December 2011, Part 1 Architectures and Protocols
 (http://www.dlna.org/)
 3) MediaServer2Spec (http://live.gnome.org/Rygel/MediaServer2Spec)
+4) See 2) 7.4.1.3.22 MM ci-param (Conversion Indicator Flag)
+5) See 2) 7.4.1.3.23 MM flags-param (Flags Parameter)
+6) See 2) 7.4.1.3.19 MM op-param (Operations Parameter for HTTP)
diff --git a/libdleyna/server/interface.h b/libdleyna/server/interface.h
index 33fcc3b..371a6b6 100644
--- a/libdleyna/server/interface.h
+++ b/libdleyna/server/interface.h
@@ -89,6 +89,9 @@ enum dls_interface_type_ {
 /* Resources Properties */
 #define DLS_INTERFACE_PROP_MIME_TYPE "MIMEType"
 #define DLS_INTERFACE_PROP_DLNA_PROFILE "DLNAProfile"
+#define DLS_INTERFACE_PROP_DLNA_CONVERSION "DLNAConversion"
+#define DLS_INTERFACE_PROP_DLNA_OPERATION "DLNAOperation"
+#define DLS_INTERFACE_PROP_DLNA_FLAGS "DLNAFlags"
 #define DLS_INTERFACE_PROP_SIZE "Size"
 #define DLS_INTERFACE_PROP_DURATION "Duration"
 #define DLS_INTERFACE_PROP_BITRATE "Bitrate"
diff --git a/libdleyna/server/props.c b/libdleyna/server/props.c
index aada049..66f9739 100644
--- a/libdleyna/server/props.c
+++ b/libdleyna/server/props.c
@@ -22,6 +22,8 @@
 
 #include <string.h>
 #include <libgupnp-av/gupnp-didl-lite-contributor.h>
+#include <libgupnp-av/gupnp-dlna.h>
+#include <libgupnp-av/gupnp-protocol-info.h>
 
 #include <libdleyna/core/log.h>
 
@@ -97,11 +99,53 @@ static const gchar gMediaSpec2Image[] = "image";
 static const gchar gMediaSpec2Playlist[] = "playlist";
 static const gchar gMediaSpec2Item[] = "item";
 
+typedef struct dls_prop_dlna_t_ dls_prop_dlna_t;
+struct dls_prop_dlna_t_ {
+	guint dlna_flag;
+	const gchar *prop_name;
+};
+
+static const dls_prop_dlna_t g_prop_dlna_ci[] = {
+{GUPNP_DLNA_CONVERSION_TRANSCODED,		"Transcoded"},
+{0,						NULL}
+};
+
+static const dls_prop_dlna_t g_prop_dlna_op[] = {
+{GUPNP_DLNA_OPERATION_RANGE,			"RangeSeek"},
+{GUPNP_DLNA_OPERATION_TIMESEEK,			"TimeSeek"},
+{0,						NULL}
+};
+
+static const dls_prop_dlna_t g_prop_dlna_flags[] = {
+{GUPNP_DLNA_FLAGS_SENDER_PACED,			"SenderPaced"},
+{GUPNP_DLNA_FLAGS_TIME_BASED_SEEK,		"TimeBased"},
+{GUPNP_DLNA_FLAGS_BYTE_BASED_SEEK,		"ByteBased"},
+{GUPNP_DLNA_FLAGS_PLAY_CONTAINER,		"PlayContainer"},
+{GUPNP_DLNA_FLAGS_S0_INCREASE,			"S0Increase"},
+{GUPNP_DLNA_FLAGS_SN_INCREASE,			"SNIncrease"},
+{GUPNP_DLNA_FLAGS_RTSP_PAUSE,			"RTSPPause"},
+{GUPNP_DLNA_FLAGS_STREAMING_TRANSFER_MODE,	"StreamingTM"},
+{GUPNP_DLNA_FLAGS_INTERACTIVE_TRANSFER_MODE,	"InteractiveTM"},
+{GUPNP_DLNA_FLAGS_BACKGROUND_TRANSFER_MODE,	"BackgroundTM"},
+{GUPNP_DLNA_FLAGS_CONNECTION_STALL,		"ConnectionStall"},
+{GUPNP_DLNA_FLAGS_DLNA_V15,			"DLNA_V15"},
+{0,						NULL}
+};
+
+static const dls_prop_dlna_t g_prop_dlna_ocm[] = {
+{GUPNP_OCM_FLAGS_UPLOAD,			"Upload"},
+{GUPNP_OCM_FLAGS_CREATE_CONTAINER,		"CreateContainer"},
+{GUPNP_OCM_FLAGS_DESTROYABLE,			"Delete"},
+{GUPNP_OCM_FLAGS_UPLOAD_DESTROYABLE,		"UploadDelete"},
+{GUPNP_OCM_FLAGS_CHANGE_METADATA,		"ChangeMeta"},
+{0,						NULL}
+};
+
 static dls_prop_map_t *prv_prop_map_new(const gchar *prop_name,
-					    dls_upnp_prop_mask type,
-					    gboolean filter,
-					    gboolean searchable,
-					    gboolean updateable)
+					dls_upnp_prop_mask type,
+					gboolean filter,
+					gboolean searchable,
+					gboolean updateable)
 {
 	dls_prop_map_t *retval = g_new(dls_prop_map_t, 1);
 	retval->upnp_prop_name = prop_name;
@@ -252,6 +296,24 @@ void dls_prop_maps_new(GHashTable **property_map, GHashTable **filter_map)
 				       TRUE, FALSE, FALSE);
 	g_hash_table_insert(f_map, DLS_INTERFACE_PROP_DLNA_PROFILE, prop_t);
 
+	/* res@protocolInfo - DLNA CONVERSION*/
+	prop_t = prv_prop_map_new("res@protocolInfo",
+				       DLS_UPNP_MASK_PROP_DLNA_CONVERSION,
+				       TRUE, FALSE, FALSE);
+	g_hash_table_insert(f_map, DLS_INTERFACE_PROP_DLNA_CONVERSION, prop_t);
+
+		/* res@protocolInfo - DLNA OPERATION*/
+	prop_t = prv_prop_map_new("res@protocolInfo",
+				       DLS_UPNP_MASK_PROP_DLNA_OPERATION,
+				       TRUE, FALSE, FALSE);
+	g_hash_table_insert(f_map, DLS_INTERFACE_PROP_DLNA_OPERATION, prop_t);
+
+		/* res@protocolInfo - DLNA FLAGS*/
+	prop_t = prv_prop_map_new("res@protocolInfo",
+				       DLS_UPNP_MASK_PROP_DLNA_FLAGS,
+				       TRUE, FALSE, FALSE);
+	g_hash_table_insert(f_map, DLS_INTERFACE_PROP_DLNA_FLAGS, prop_t);
+
 	/* res@protocolInfo - MIME TYPES*/
 	prop_t = prv_prop_map_new("res@protocolInfo",
 					DLS_UPNP_MASK_PROP_MIME_TYPE,
@@ -636,6 +698,24 @@ static GVariant *prv_add_list_dlna_prop(GList *list)
 	return g_variant_builder_end(&vb);
 }
 
+static GVariant *prv_props_get_dlna_info_dict(guint flags,
+					      const dls_prop_dlna_t *dfa)
+{
+	GVariantBuilder builder;
+	gboolean set;
+	gint i = 0;
+
+	g_variant_builder_init(&builder, G_VARIANT_TYPE("a{sb}"));
+
+	while (dfa[i].dlna_flag) {
+		set = (flags & dfa[i].dlna_flag) != 0;
+		g_variant_builder_add(&builder, "{sb}", dfa[i].prop_name, set);
+		i++;
+	}
+
+	return g_variant_builder_end(&builder);
+}
+
 static void prv_add_list_artists_str(gpointer data, gpointer user_data)
 {
 	GVariantBuilder *vb = (GVariantBuilder *)user_data;
@@ -938,6 +1018,9 @@ static void prv_parse_common_resources(GVariantBuilder *item_vb,
 	gint64 int64_val;
 	guint uint_val;
 	const char *str_val;
+	GUPnPDLNAConversion conv;
+	GUPnPDLNAOperation ope;
+	GUPnPDLNAFlags flags;
 
 	if (filter_mask & DLS_UPNP_MASK_PROP_SIZE) {
 		int64_val = gupnp_didl_lite_resource_get_size64(res);
@@ -959,6 +1042,30 @@ static void prv_parse_common_resources(GVariantBuilder *item_vb,
 				    str_val);
 	}
 
+	if (filter_mask & DLS_UPNP_MASK_PROP_DLNA_CONVERSION) {
+		conv = gupnp_protocol_info_get_dlna_conversion(protocol_info);
+		prv_add_variant_prop(item_vb,
+				     DLS_INTERFACE_PROP_DLNA_CONVERSION,
+				     prv_props_get_dlna_info_dict(
+						conv, g_prop_dlna_ci));
+	}
+
+	if (filter_mask & DLS_UPNP_MASK_PROP_DLNA_OPERATION) {
+		ope = gupnp_protocol_info_get_dlna_operation(protocol_info);
+		prv_add_variant_prop(item_vb,
+				     DLS_INTERFACE_PROP_DLNA_OPERATION,
+				     prv_props_get_dlna_info_dict(
+						ope, g_prop_dlna_op));
+	}
+
+	if (filter_mask & DLS_UPNP_MASK_PROP_DLNA_FLAGS) {
+		flags = gupnp_protocol_info_get_dlna_flags(protocol_info);
+		prv_add_variant_prop(item_vb,
+				     DLS_INTERFACE_PROP_DLNA_FLAGS,
+				     prv_props_get_dlna_info_dict(
+						flags, g_prop_dlna_flags));
+	}
+
 	if (filter_mask & DLS_UPNP_MASK_PROP_MIME_TYPE) {
 		str_val = gupnp_protocol_info_get_mime_type(protocol_info);
 		prv_add_string_prop(item_vb, DLS_INTERFACE_PROP_MIME_TYPE,
@@ -1172,31 +1279,6 @@ on_error:
 	return retval;
 }
 
-static GVariant *prv_props_get_dlna_managed_dict(GUPnPOCMFlags flags)
-{
-	GVariantBuilder builder;
-	gboolean managed;
-
-	g_variant_builder_init(&builder, G_VARIANT_TYPE("a{sb}"));
-
-	managed = (flags & GUPNP_OCM_FLAGS_UPLOAD) != 0;
-	g_variant_builder_add(&builder, "{sb}", "Upload", managed);
-
-	managed = (flags & GUPNP_OCM_FLAGS_CREATE_CONTAINER) != 0;
-	g_variant_builder_add(&builder, "{sb}", "CreateContainer", managed);
-
-	managed = (flags & GUPNP_OCM_FLAGS_DESTROYABLE) != 0;
-	g_variant_builder_add(&builder, "{sb}", "Delete", managed);
-
-	managed = (flags & GUPNP_OCM_FLAGS_UPLOAD_DESTROYABLE) != 0;
-	g_variant_builder_add(&builder, "{sb}", "UploadDelete", managed);
-
-	managed = (flags & GUPNP_OCM_FLAGS_CHANGE_METADATA) != 0;
-	g_variant_builder_add(&builder, "{sb}", "ChangeMeta", managed);
-
-	return g_variant_builder_end(&builder);
-}
-
 static GVariant *prv_compute_resources(GUPnPDIDLLiteObject *object,
 				       dls_upnp_prop_mask filter_mask,
 				       gboolean all_res)
@@ -1312,7 +1394,8 @@ gboolean dls_props_add_object(GVariantBuilder *item_vb,
 		flags = gupnp_didl_lite_object_get_dlna_managed(object);
 		prv_add_variant_prop(item_vb,
 				     DLS_INTERFACE_PROP_DLNA_MANAGED,
-				     prv_props_get_dlna_managed_dict(flags));
+				     prv_props_get_dlna_info_dict(
+						flags, g_prop_dlna_ocm));
 	}
 
 	if ((filter_mask & DLS_UPNP_MASK_PROP_OBJECT_UPDATE_ID) &&
@@ -1510,6 +1593,9 @@ static GVariant *prv_get_common_resource_property(const gchar *prop,
 	const char *str_val;
 	GVariant *retval = NULL;
 	GUPnPProtocolInfo *protocol_info;
+	GUPnPDLNAConversion conv;
+	GUPnPDLNAOperation ope;
+	GUPnPDLNAFlags flags;
 
 	if (!strcmp(prop, DLS_INTERFACE_PROP_DLNA_PROFILE)) {
 		protocol_info = gupnp_didl_lite_resource_get_protocol_info(res);
@@ -1519,6 +1605,25 @@ static GVariant *prv_get_common_resource_property(const gchar *prop,
 		if (!str_val)
 			goto on_error;
 		retval = g_variant_ref_sink(g_variant_new_string(str_val));
+	} else if (!strcmp(prop, DLS_INTERFACE_PROP_DLNA_CONVERSION)) {
+		protocol_info = gupnp_didl_lite_resource_get_protocol_info(res);
+		conv = gupnp_protocol_info_get_dlna_conversion(protocol_info);
+		retval = prv_props_get_dlna_info_dict(conv, g_prop_dlna_ci);
+		if (retval)
+			retval = g_variant_ref_sink(retval);
+	} else if (!strcmp(prop, DLS_INTERFACE_PROP_DLNA_OPERATION)) {
+		protocol_info = gupnp_didl_lite_resource_get_protocol_info(res);
+		ope = gupnp_protocol_info_get_dlna_operation(protocol_info);
+		retval = prv_props_get_dlna_info_dict(ope, g_prop_dlna_op);
+		if (retval)
+			retval = g_variant_ref_sink(retval);
+	} else if (!strcmp(prop, DLS_INTERFACE_PROP_DLNA_FLAGS)) {
+		protocol_info = gupnp_didl_lite_resource_get_protocol_info(res);
+		flags = gupnp_protocol_info_get_dlna_flags(protocol_info);
+		retval =  prv_props_get_dlna_info_dict(flags,
+						       g_prop_dlna_flags);
+		if (retval)
+			retval = g_variant_ref_sink(retval);
 	} else if (!strcmp(prop, DLS_INTERFACE_PROP_MIME_TYPE)) {
 		protocol_info = gupnp_didl_lite_resource_get_protocol_info(res);
 		if (!protocol_info)
@@ -1679,8 +1784,8 @@ GVariant *dls_props_get_object_prop(const gchar *prop, const gchar *root_path,
 
 		DLEYNA_LOG_DEBUG("Prop %s = %0x", prop, dlna_managed);
 
-		retval = g_variant_ref_sink(
-				prv_props_get_dlna_managed_dict(dlna_managed));
+		retval = g_variant_ref_sink(prv_props_get_dlna_info_dict(
+						dlna_managed, g_prop_dlna_ocm));
 	} else if (!strcmp(prop, DLS_INTERFACE_PROP_OBJECT_UPDATE_ID) &&
 		   gupnp_didl_lite_object_update_id_is_set(object)) {
 		uint_val = gupnp_didl_lite_object_get_update_id(object);
diff --git a/libdleyna/server/props.h b/libdleyna/server/props.h
index 459dd30..f219573 100644
--- a/libdleyna/server/props.h
+++ b/libdleyna/server/props.h
@@ -48,7 +48,7 @@
 #define DLS_UPNP_MASK_PROP_WIDTH			(1LL << 19)
 #define DLS_UPNP_MASK_PROP_HEIGHT			(1LL << 20)
 #define DLS_UPNP_MASK_PROP_COLOR_DEPTH			(1LL << 21)
-#define DLS_UPNP_MASK_PROP_ALBUM_ART_URL		(1LL << 22)
+#define DLS_UPNP_MASK_PROP_ALBUM_ART_URL			(1LL << 22)
 #define DLS_UPNP_MASK_PROP_RESOURCES			(1LL << 23)
 #define DLS_UPNP_MASK_PROP_URL				(1LL << 24)
 #define DLS_UPNP_MASK_PROP_REFPATH			(1LL << 25)
@@ -61,6 +61,9 @@
 #define DLS_UPNP_MASK_PROP_UPDATE_COUNT			(1LL << 32)
 #define DLS_UPNP_MASK_PROP_CONTAINER_UPDATE_ID		(1LL << 33)
 #define DLS_UPNP_MASK_PROP_TOTAL_DELETED_CHILD_COUNT	(1LL << 34)
+#define DLS_UPNP_MASK_PROP_DLNA_CONVERSION		(1LL << 35)
+#define DLS_UPNP_MASK_PROP_DLNA_OPERATION		(1LL << 36)
+#define DLS_UPNP_MASK_PROP_DLNA_FLAGS			(1LL << 37)
 
 #define DLS_UPNP_MASK_ALL_PROPS 0xffffffffffffffff
 
diff --git a/libdleyna/server/server.c b/libdleyna/server/server.c
index 7a00624..3f290e6 100644
--- a/libdleyna/server/server.c
+++ b/libdleyna/server/server.c
@@ -301,6 +301,12 @@ static const gchar g_server_introspection[] =
 	"       access='read'/>"
 	"    <property type='s' name='"DLS_INTERFACE_PROP_DLNA_PROFILE"'"
 	"       access='read'/>"
+	"    <property type='a{sb}' name='"DLS_INTERFACE_PROP_DLNA_CONVERSION"'"
+	"       access='read'/>"
+	"    <property type='a{sb}' name='"DLS_INTERFACE_PROP_DLNA_OPERATION"'"
+	"       access='read'/>"
+	"    <property type='a{sb}' name='"DLS_INTERFACE_PROP_DLNA_FLAGS"'"
+	"       access='read'/>"
 	"    <property type='x' name='"DLS_INTERFACE_PROP_SIZE"'"
 	"       access='read'/>"
 	"  </interface>"
@@ -329,6 +335,12 @@ static const gchar g_server_introspection[] =
 	"       access='read'/>"
 	"    <property type='s' name='"DLS_INTERFACE_PROP_DLNA_PROFILE"'"
 	"       access='read'/>"
+	"    <property type='a{sb}' name='"DLS_INTERFACE_PROP_DLNA_CONVERSION"'"
+	"       access='read'/>"
+	"    <property type='a{sb}' name='"DLS_INTERFACE_PROP_DLNA_OPERATION"'"
+	"       access='read'/>"
+	"    <property type='a{sb}' name='"DLS_INTERFACE_PROP_DLNA_FLAGS"'"
+	"       access='read'/>"
 	"    <property type='i' name='"DLS_INTERFACE_PROP_TRACK_NUMBER"'"
 	"       access='read'/>"
 	"    <property type='x' name='"DLS_INTERFACE_PROP_SIZE"'"