Add TpBaseMediaCallContent and TpCallContentMediaDescription objects

1 files changed, 614 insertions, 0 deletions

diff --git a/telepathy-glib/base-media-call-content.c b/telepathy-glib/base-media-call-content.c
new file mode 100644
index 000000000..6bbefde9e
--- /dev/null
+++ b/telepathy-glib/base-media-call-content.c
@@ -0,0 +1,614 @@
+/*
+ * base-media-call-content.c - Source for TpBaseMediaCallContent
+ * Copyright (C) 2009-2011 Collabora Ltd.
+ * @author Sjoerd Simons <sjoerd.simons@collabora.co.uk>
+ * @author Xavier Claessens <xavier.claessens@collabora.co.uk>
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 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
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+ */
+
+/**
+ * SECTION:base-media-call-content
+ * @title: TpBaseMediaCallContent
+ * @short_description: base class for #TpSvcCallContentInterfaceMedia
+ *  implementations
+ * @see_also: #TpSvcCallContentInterfaceMedia, #TpBaseCallChannel,
+ *  #TpBaseCallContent and #TpBaseCallStream
+ *
+ * This base class makes it easier to write #TpSvcCallContentInterfaceMedia
+ * implementations by implementing its properties and methods.
+ *
+ * Subclasses must still implement #TpBaseCallContent's virtual methods.
+ *
+ * Since: 0.UNRELEASED
+ */
+
+/**
+ * TpBaseMediaCallContent:
+ *
+ * A base class for media call content implementations
+ *
+ * Since: 0.UNRELEASED
+ */
+
+/**
+ * TpBaseMediaCallContentClass:
+ *
+ * The class structure for #TpBaseMediaCallContent
+ *
+ * Since: 0.UNRELEASED
+ */
+
+#include "config.h"
+#include "base-media-call-content.h"
+
+#define DEBUG_FLAG TP_DEBUG_CALL
+#include "telepathy-glib/base-call-internal.h"
+#include "telepathy-glib/base-connection.h"
+#include "telepathy-glib/dbus.h"
+#include "telepathy-glib/debug-internal.h"
+#include "telepathy-glib/gtypes.h"
+#include "telepathy-glib/interfaces.h"
+#include "telepathy-glib/svc-call.h"
+#include "telepathy-glib/svc-properties-interface.h"
+#include "telepathy-glib/util.h"
+#include "telepathy-glib/_gen/signals-marshal.h"
+
+static void call_content_media_iface_init (gpointer, gpointer);
+
+G_DEFINE_TYPE_WITH_CODE(TpBaseMediaCallContent, tp_base_media_call_content,
+    TP_TYPE_BASE_CALL_CONTENT,
+    G_IMPLEMENT_INTERFACE (TP_TYPE_SVC_CALL_CONTENT_INTERFACE_MEDIA,
+      call_content_media_iface_init);
+    );
+
+static const gchar *tp_base_media_call_content_interfaces[] = {
+    TP_IFACE_CALL_CONTENT_INTERFACE_MEDIA,
+    NULL
+};
+
+/* properties */
+enum
+{
+  PROP_REMOTE_MEDIA_DESCRIPTIONS = 1,
+  PROP_LOCAL_MEDIA_DESCRIPTIONS,
+  PROP_MEDIA_DESCRIPTION_OFFER,
+  PROP_PACKETIZATION,
+  PROP_CURRENT_DTMF_EVENT,
+  PROP_CURRENT_DTMF_STATE
+};
+
+enum /* signals */
+{
+  LOCAL_MEDIA_DESCRIPTION_UPDATED,
+  LAST_SIGNAL
+};
+
+static guint _signals[LAST_SIGNAL] = { 0, };
+
+/* private structure */
+struct _TpBaseMediaCallContentPrivate
+{
+  /* TpHandle -> reffed GHashTable */
+  GHashTable *remote_media_descriptions;
+  /* TpHandle -> reffed GHashTable */
+  GHashTable *local_media_descriptions;
+  TpCallContentMediaDescription *current_offer;
+  TpCallContentPacketizationType packetization;
+  TpDTMFEvent current_dtmf_event;
+  TpSendingState current_dtmf_state;
+
+  /* GQueue of reffed TpCallContentMediaDescription */
+  GQueue *outstanding_offers;
+  GCancellable *current_offer_cancellable;
+};
+
+static void
+tp_base_media_call_content_init (TpBaseMediaCallContent *self)
+{
+  self->priv = G_TYPE_INSTANCE_GET_PRIVATE (self,
+      TP_TYPE_BASE_MEDIA_CALL_CONTENT, TpBaseMediaCallContentPrivate);
+
+  self->priv->outstanding_offers = g_queue_new ();
+  self->priv->local_media_descriptions = g_hash_table_new_full (NULL, NULL,
+      NULL, (GDestroyNotify) g_hash_table_unref);
+  self->priv->remote_media_descriptions = g_hash_table_new_full (NULL, NULL,
+      NULL, (GDestroyNotify) g_hash_table_unref);
+}
+
+static void
+call_content_deinit (TpBaseCallContent *base)
+{
+  TpBaseMediaCallContent *self = TP_BASE_MEDIA_CALL_CONTENT (base);
+
+  g_queue_foreach (self->priv->outstanding_offers, (GFunc) g_object_unref, NULL);
+  g_queue_clear (self->priv->outstanding_offers);
+
+  if (self->priv->current_offer_cancellable != NULL)
+    g_cancellable_cancel (self->priv->current_offer_cancellable);
+
+  TP_BASE_CALL_CONTENT_CLASS (
+      tp_base_media_call_content_parent_class)->deinit (base);
+}
+
+static void
+tp_base_media_call_content_dispose (GObject *object)
+{
+  TpBaseMediaCallContent *self = TP_BASE_MEDIA_CALL_CONTENT (object);
+
+  g_assert (self->priv->current_offer == NULL);
+  g_assert (g_queue_is_empty (self->priv->outstanding_offers));
+
+  tp_clear_pointer (&self->priv->local_media_descriptions, g_hash_table_unref);
+  tp_clear_pointer (&self->priv->remote_media_descriptions, g_hash_table_unref);
+
+  if (G_OBJECT_CLASS (tp_base_media_call_content_parent_class)->dispose)
+    G_OBJECT_CLASS (tp_base_media_call_content_parent_class)->dispose (object);
+}
+
+static void
+tp_base_media_call_content_finalize (GObject *object)
+{
+  TpBaseMediaCallContent *self = TP_BASE_MEDIA_CALL_CONTENT (object);
+
+  g_queue_free (self->priv->outstanding_offers);
+
+  if (G_OBJECT_CLASS (tp_base_media_call_content_parent_class)->finalize)
+    G_OBJECT_CLASS (tp_base_media_call_content_parent_class)->finalize (object);
+}
+
+static void
+tp_base_media_call_content_get_property (GObject *object,
+    guint property_id,
+    GValue *value,
+    GParamSpec *pspec)
+{
+  TpBaseMediaCallContent *self = TP_BASE_MEDIA_CALL_CONTENT (object);
+
+  switch (property_id)
+    {
+      case PROP_REMOTE_MEDIA_DESCRIPTIONS:
+        g_value_set_boxed (value, self->priv->remote_media_descriptions);
+        break;
+      case PROP_LOCAL_MEDIA_DESCRIPTIONS:
+        g_value_set_boxed (value, self->priv->local_media_descriptions);
+        break;
+      case PROP_MEDIA_DESCRIPTION_OFFER:
+        {
+          const gchar *object_path = "/";
+          TpHandle contact = 0;
+          GHashTable *properties;
+          GValueArray *value_array;
+
+          if (self->priv->current_offer != NULL)
+            {
+              object_path = tp_call_content_media_description_get_object_path (
+                  self->priv->current_offer);
+              contact = tp_call_content_media_description_get_remote_contact (
+                  self->priv->current_offer);
+              properties = _tp_call_content_media_description_dup_properties (
+                  self->priv->current_offer);
+            }
+          else
+            {
+              properties = g_hash_table_new (NULL, NULL);
+            }
+
+          value_array = tp_value_array_build (3,
+              DBUS_TYPE_G_OBJECT_PATH, object_path,
+              G_TYPE_UINT, contact,
+              TP_HASH_TYPE_MEDIA_DESCRIPTION_PROPERTIES, properties,
+              G_TYPE_INVALID);
+
+          g_value_take_boxed (value, value_array);
+          g_hash_table_unref (properties);
+          break;
+        }
+      case PROP_PACKETIZATION:
+        g_value_set_uint (value, self->priv->packetization);
+        break;
+      case PROP_CURRENT_DTMF_EVENT:
+        g_value_set_uchar (value, self->priv->current_dtmf_event);
+        break;
+      case PROP_CURRENT_DTMF_STATE:
+        g_value_set_uint (value, self->priv->current_dtmf_state);
+        break;
+      default:
+        G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
+        break;
+    }
+}
+
+static void
+tp_base_media_call_content_class_init (TpBaseMediaCallContentClass *klass)
+{
+  GObjectClass *object_class = G_OBJECT_CLASS (klass);
+  TpBaseCallContentClass *bcc_class = TP_BASE_CALL_CONTENT_CLASS (klass);
+  GParamSpec *param_spec;
+  static TpDBusPropertiesMixinPropImpl content_media_props[] = {
+    { "RemoteMediaDescriptions", "remote-media-descriptions", NULL },
+    { "LocalMediaDescriptions", "local-media-descriptions", NULL },
+    { "MediaDescriptionOffer", "media-description-offer", NULL },
+    { "Packetization", "packetization", NULL },
+    { "CurrentDTMFEvent", "current-dtmf-event", NULL },
+    { "CurrentDTMFState", "current-dtmf-state", NULL },
+    { NULL }
+  };
+
+  g_type_class_add_private (klass, sizeof (TpBaseMediaCallContentPrivate));
+
+  object_class->get_property = tp_base_media_call_content_get_property;
+  object_class->dispose = tp_base_media_call_content_dispose;
+  object_class->finalize = tp_base_media_call_content_finalize;
+
+  bcc_class->extra_interfaces = tp_base_media_call_content_interfaces;
+  bcc_class->deinit = call_content_deinit;
+
+  /**
+   * TpBaseMediaCallContent:remote-media-descriptions:
+   *
+   * #GHashTable{contact #TpHandle, properties #GHashTable}
+   * The map of contacts to remote media descriptions.
+   *
+   * Since: 0.UNRELEASED
+   */
+  param_spec = g_param_spec_boxed ("remote-media-descriptions",
+      "RemoteMediaDescriptions",
+      "The map of contacts to remote media descriptions",
+      TP_HASH_TYPE_CONTACT_MEDIA_DESCRIPTION_PROPERTIES_MAP,
+      G_PARAM_READABLE | G_PARAM_STATIC_STRINGS);
+  g_object_class_install_property (object_class, PROP_REMOTE_MEDIA_DESCRIPTIONS,
+      param_spec);
+
+  /**
+   * TpBaseMediaCallContent:local-media-descriptions:
+   *
+   * #GHashTable{contact #TpHandle, properties #GHashTable}
+   * The map of contacts to local media descriptions.
+   *
+   * Since: 0.UNRELEASED
+   */
+  param_spec = g_param_spec_boxed ("local-media-descriptions",
+      "LocalMediaDescriptions",
+      "The map of contacts to local media descriptions",
+      TP_HASH_TYPE_CONTACT_MEDIA_DESCRIPTION_PROPERTIES_MAP,
+      G_PARAM_READABLE | G_PARAM_STATIC_STRINGS);
+  g_object_class_install_property (object_class, PROP_LOCAL_MEDIA_DESCRIPTIONS,
+      param_spec);
+
+  /**
+   * TpBaseMediaCallContent:media-description-offer:
+   *
+   * #GValueArray{object-path, contact #TpHandle, properties #GHashTable}.
+   * The current media description offer if any.
+   *
+   * Since: 0.UNRELEASED
+   */
+  param_spec = g_param_spec_boxed ("media-description-offer",
+      "MediaDescriptionOffer",
+      "The current media description offer if any",
+      TP_STRUCT_TYPE_MEDIA_DESCRIPTION_OFFER,
+      G_PARAM_READABLE | G_PARAM_STATIC_STRINGS);
+  g_object_class_install_property (object_class, PROP_MEDIA_DESCRIPTION_OFFER,
+      param_spec);
+
+  /**
+   * TpBaseMediaCallContent:packetization:
+   *
+   * The #TpCallContentPacketizationType of this content.
+   *
+   * Since: 0.UNRELEASED
+   */
+  param_spec = g_param_spec_uint ("packetization", "Packetization",
+      "The Packetization of this content",
+      0, G_MAXUINT, TP_CALL_CONTENT_PACKETIZATION_TYPE_RTP,
+      G_PARAM_READABLE | G_PARAM_STATIC_STRINGS);
+  g_object_class_install_property (object_class, PROP_PACKETIZATION,
+      param_spec);
+
+  /**
+   * TpBaseMediaCallContent:current-dtmf-event:
+   *
+   * The currently being played #TpDTMFEvent if any
+   *
+   * Since: 0.UNRELEASED
+   */
+  param_spec = g_param_spec_uchar ("current-dtmf-event",
+      "CurrentDTMFEvent",
+      "The currently being played dtmf event if any",
+      0, NUM_TP_DTMF_EVENTS - 1, 0,
+      G_PARAM_READABLE | G_PARAM_STATIC_STRINGS);
+  g_object_class_install_property (object_class, PROP_CURRENT_DTMF_EVENT,
+      param_spec);
+
+  /**
+   * TpBaseMediaCallContent:current-dtmf-state:
+   *
+   * The #TpSendingState of the dtmf events
+   *
+   * Since: 0.UNRELEASED
+   */
+  param_spec = g_param_spec_uint ("current-dtmf-state",
+      "CurrentDTMFState",
+      "The sending state of the dtmf events",
+      0, NUM_TP_SENDING_STATES - 1, TP_SENDING_STATE_NONE,
+      G_PARAM_READABLE | G_PARAM_STATIC_STRINGS);
+  g_object_class_install_property (object_class, PROP_CURRENT_DTMF_STATE,
+      param_spec);
+
+  /**
+   * TpBaseMediaCallContent::local-media-description-updated
+   * @self: the #TpCallChannel
+   * @contact: the remote contact
+   * @properties: the new media description properties asv
+   *
+   * The ::local-media-description-changed signal is emitted whenever the local
+   * media description changes for a remote contact.
+   *
+   * Since: 0.UNRELEASED
+   */
+  _signals[LOCAL_MEDIA_DESCRIPTION_UPDATED] = g_signal_new (
+      "local-media-description-updated",
+      G_OBJECT_CLASS_TYPE (klass),
+      G_SIGNAL_RUN_LAST,
+      0, NULL, NULL,
+      _tp_marshal_VOID__UINT_BOXED,
+      G_TYPE_NONE,
+      2, G_TYPE_UINT, G_TYPE_HASH_TABLE);
+
+  tp_dbus_properties_mixin_implement_interface (object_class,
+      TP_IFACE_QUARK_CALL_CONTENT_INTERFACE_MEDIA,
+      tp_dbus_properties_mixin_getter_gobject_properties,
+      NULL,
+      content_media_props);
+}
+
+static void
+set_local_properties (TpBaseMediaCallContent *self,
+    TpHandle contact,
+    GHashTable *properties)
+{
+  DEBUG ("Set local properties for contact %u", contact);
+
+  g_hash_table_insert (self->priv->local_media_descriptions,
+      GUINT_TO_POINTER (contact),
+      g_hash_table_ref (properties));
+
+  g_signal_emit (self, _signals[LOCAL_MEDIA_DESCRIPTION_UPDATED], 0,
+      contact, properties);
+
+  tp_svc_call_content_interface_media_emit_local_media_description_changed (
+      self, contact, properties);
+}
+
+static void
+set_remote_properties (TpBaseMediaCallContent *self,
+    TpHandle contact,
+    GHashTable *properties)
+{
+  GHashTable *update;
+
+  DEBUG ("Set remote properties for contact %u", contact);
+
+  g_hash_table_insert (self->priv->remote_media_descriptions,
+      GUINT_TO_POINTER (contact),
+      g_hash_table_ref (properties));
+
+  update = g_hash_table_new (NULL, NULL);
+  g_hash_table_insert (update,
+      GUINT_TO_POINTER (contact),
+      properties);
+
+  tp_svc_call_content_interface_media_emit_remote_media_descriptions_changed (
+      self, update);
+
+  g_hash_table_unref (update);
+}
+
+static void next_offer (TpBaseMediaCallContent *self);
+
+static void
+offer_finished_cb (GObject *source,
+    GAsyncResult *result,
+    gpointer user_data)
+{
+  TpBaseMediaCallContent *self = user_data;
+  TpCallContentMediaDescription *md = (TpCallContentMediaDescription *) source;
+  GHashTable *local_properties = NULL;
+  GHashTable *remote_properties = NULL;
+  TpHandle contact;
+  GError *error = NULL;
+
+  g_assert (self->priv->current_offer == md);
+
+  if (!_tp_call_content_media_description_offer_finish (md, result,
+          &local_properties, &error))
+    {
+      DEBUG ("Offer failed: %s", error->message);
+      g_clear_error (&error);
+      goto out;
+    }
+
+  DEBUG ("Accepted offer: %s",
+      tp_call_content_media_description_get_object_path (md));
+
+  /* Accepted, update local and remote MediaDescription */
+  remote_properties = _tp_call_content_media_description_dup_properties (md);
+  contact = tp_call_content_media_description_get_remote_contact (md);
+  set_local_properties (self, contact, local_properties);
+  set_remote_properties (self, contact, remote_properties);
+
+out:
+  g_clear_object (&self->priv->current_offer);
+  g_clear_object (&self->priv->current_offer_cancellable);
+  tp_svc_call_content_interface_media_emit_media_description_offer_done (self);
+
+  next_offer (self);
+
+  tp_clear_pointer (&local_properties, g_hash_table_unref);
+  tp_clear_pointer (&remote_properties, g_hash_table_unref);
+  g_object_unref (self);
+}
+
+static void
+next_offer (TpBaseMediaCallContent *self)
+{
+  const gchar *object_path;
+  TpHandle contact;
+  GHashTable *properties;
+
+  if (self->priv->current_offer != NULL)
+    {
+      DEBUG ("Waiting for the current offer to finish"
+        " before starting the next one");
+      return;
+    }
+
+  self->priv->current_offer = g_queue_pop_head (self->priv->outstanding_offers);
+  if (self->priv->current_offer == NULL)
+    {
+      DEBUG ("No more offers outstanding");
+      return;
+    }
+
+  g_assert (self->priv->current_offer_cancellable == NULL);
+  self->priv->current_offer_cancellable = g_cancellable_new ();
+
+  _tp_call_content_media_description_offer_async (self->priv->current_offer,
+      self->priv->current_offer_cancellable,
+      offer_finished_cb,
+      g_object_ref (self));
+
+  object_path = tp_call_content_media_description_get_object_path (
+      self->priv->current_offer);
+  contact = tp_call_content_media_description_get_remote_contact (
+      self->priv->current_offer);
+  properties = _tp_call_content_media_description_dup_properties (
+      self->priv->current_offer);
+
+  DEBUG ("emitting NewMediaDescriptionOffer: %s", object_path);
+  tp_svc_call_content_interface_media_emit_new_media_description_offer (self,
+      object_path, contact, properties);
+  g_hash_table_unref (properties);
+}
+
+/**
+ * tp_base_media_call_content_get_local_media_description:
+ * @self: a #TpBaseMediaCallContent
+ * @contact: the contact
+ *
+ * Get the media description used to stream to @contact.
+ *
+ * Returns: borrowed #GHashTable mapping iface propery string to #GValue.
+ * Since: 0.UNRELEASED
+ */
+GHashTable *
+tp_base_media_call_content_get_local_media_description (
+    TpBaseMediaCallContent *self,
+    TpHandle contact)
+{
+  g_return_val_if_fail (TP_IS_BASE_MEDIA_CALL_CONTENT (self), NULL);
+
+  return g_hash_table_lookup (self->priv->local_media_descriptions,
+      GUINT_TO_POINTER (contact));
+}
+
+/**
+ * tp_base_media_call_content_offer_media_description:
+ * @self: a #TpBaseMediaCallContent
+ * @md: a #TpCallContentMediaDescription
+ *
+ * Offer @md for media description negociation.
+ *
+ * Since: 0.UNRELEASED
+ */
+void
+tp_base_media_call_content_offer_media_description (
+    TpBaseMediaCallContent *self,
+    TpCallContentMediaDescription *md)
+{
+  g_return_if_fail (TP_IS_BASE_MEDIA_CALL_CONTENT (self));
+  g_return_if_fail (TP_IS_CALL_CONTENT_MEDIA_DESCRIPTION (md));
+
+  g_queue_push_tail (self->priv->outstanding_offers, g_object_ref (md));
+  next_offer (self);
+}
+
+static void
+tp_base_media_call_content_update_local_media_description (
+    TpSvcCallContentInterfaceMedia *iface,
+    guint contact,
+    GHashTable *properties,
+    DBusGMethodInvocation *context)
+{
+  TpBaseMediaCallContent *self = TP_BASE_MEDIA_CALL_CONTENT (iface);
+  GHashTable *current_properties;
+
+  if (self->priv->current_offer != NULL)
+    {
+      GError error = { TP_ERRORS, TP_ERROR_NOT_AVAILABLE,
+          "There is a codec offer around so "
+          "UpdateCodecs shouldn't be called." };
+      dbus_g_method_return_error (context, &error);
+      return;
+    }
+
+  current_properties = g_hash_table_lookup (
+      self->priv->local_media_descriptions,
+      GUINT_TO_POINTER (contact));
+
+  if (current_properties == NULL)
+    {
+      GError error = { TP_ERRORS, TP_ERROR_NOT_AVAILABLE,
+          "The initial MediaDescription object has not yet appeared" };
+      dbus_g_method_return_error (context, &error);
+      return;
+    }
+
+  set_local_properties (self, contact, properties);
+
+  tp_svc_call_content_interface_media_return_from_update_local_media_description
+      (context);
+}
+
+static void
+tp_base_media_call_content_fail (TpSvcCallContentInterfaceMedia *iface,
+    const GValueArray *reason_array,
+    DBusGMethodInvocation *context)
+{
+  TpBaseMediaCallContent *self = TP_BASE_MEDIA_CALL_CONTENT (iface);
+  TpBaseCallContent *content = (TpBaseCallContent *) self;
+  TpBaseCallChannel *channel;
+
+  channel = _tp_base_call_content_get_channel (content);
+  _tp_base_call_channel_remove_content_internal (channel, content,
+      reason_array);
+
+  tp_svc_call_content_interface_media_return_from_fail (context);
+}
+
+static void
+call_content_media_iface_init (gpointer g_iface, gpointer iface_data)
+{
+  TpSvcCallContentInterfaceMediaClass *klass =
+    (TpSvcCallContentInterfaceMediaClass *) g_iface;
+
+#define IMPLEMENT(x) tp_svc_call_content_interface_media_implement_##x (\
+    klass, tp_base_media_call_content_##x)
+  IMPLEMENT(update_local_media_description);
+  //IMPLEMENT(acknowledge_dtmf_change);
+  IMPLEMENT(fail);
+#undef IMPLEMENT
+}