project: Implement GESProject
authorThibault Saunier <thibault.saunier@collabora.com>
Sun, 2 Sep 2012 12:14:27 +0000 (15:14 +0300)
committerThibault Saunier <thibault.saunier@collabora.com>
Wed, 19 Dec 2012 21:59:49 +0000 (18:59 -0300)
Do not build yet, waiting for everythnig to be in place before doing so

Co-Authored-By: Volodymyr Rudyi <vladimir.rudoy@gmail.com>
docs/libs/ges-docs.sgml
docs/libs/ges-sections.txt
ges/ges-internal.h
ges/ges-project.c [new file with mode: 0644]
ges/ges-project.h [new file with mode: 0644]
ges/ges-types.h
ges/ges.h

index c1c17cb79582970466cba8dcc9fa55bdbccf7c26..0ee8e90b611ef10333308d6ecbf40c90b181352c 100644 (file)
@@ -100,6 +100,7 @@ platform as well as Windows. It is released under the GNU Library General Public
   <chapter>
     <title>Assets</title>
     <xi:include href="xml/ges-asset-file-source.xml"/>
+    <xi:include href="xml/ges-project.xml"/>
   </chapter>
 
   <chapter id="ges-hierarchy">
index 56cc08f8c30e5cc87b6094bca50d8f31888d4927..65f6fffc1da9420f9b27f7793e52a4d4f42b83f1 100644 (file)
@@ -278,6 +278,7 @@ ges_timeline_get_tracks
 ges_timeline_get_layers
 ges_timeline_get_track_for_pad
 ges_timeline_get_duration
+ges_timeline_get_project
 <SUBSECTION Standard>
 GESTimelinePrivate
 GESTimelineClass
@@ -988,3 +989,31 @@ GES_IS_ASSET_FILESOURCE
 GES_IS_ASSET_FILESOURCE_CLASS
 GES_ASSET_FILESOURCE_GET_CLASS
 </SECTION>
+
+<SECTION>
+<FILE>ges-project</FILE>
+<TITLE>GESProject</TITLE>
+GESProject
+ges_project_add_asset
+ges_project_remove_asset
+ges_project_list_assets
+ges_project_get_asset
+ges_project_save
+ges_project_create_asset
+ges_project_get_type
+ges_project_get_uri
+ges_project_new
+ges_project_add_encoding_profile
+ges_project_list_encoding_profiles
+GESProjectFindNewUriFunction
+<SUBSECTION Standard>
+GESProjectPrivate
+GES_PROJECT
+GES_PROJECT_CLASS
+GES_IS_PROJECT
+GES_IS_PROJECT_CLASS
+GES_PROJECT_GET_CLASS
+GES_TYPE_PROJECT
+</SECTION>
+
+</SECTION>
index 4893e5bb0bc4a66cb71aae6f64c5de927b9a15ae..feb490379fba42dd76d9c4078212d41221e7eab5 100644 (file)
@@ -102,4 +102,13 @@ GType
 ges_extractable_get_real_extractable_type_for_id (GType type, const gchar * id);
 
 gboolean ges_extractable_register_metas          (GType extractable_type, GESAsset *asset);
+
+#if 0
+/* GESProject internal methods */
+gboolean ges_project_set_loaded                  (GESProject * project,
+                                                  GESFormatter *formatter);
+gchar * ges_project_try_updating_id              (GESProject *self,
+                                                  GESAsset *asset,
+                                                  GError *error);
+#endif
 #endif /* __GES_INTERNAL_H__ */
diff --git a/ges/ges-project.c b/ges/ges-project.c
new file mode 100644 (file)
index 0000000..e5b91ab
--- /dev/null
@@ -0,0 +1,867 @@
+/* GStreamer Editing Services
+ *
+ * Copyright (C) <2012> Thibault Saunier <thibault.saunier@collabora.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., 59 Temple Place - Suite 330,
+ * Boston, MA 02111-1307, USA.
+ */
+/**
+ * SECTION: ges-project
+ * @short_description: A #GESAsset that is used to manage projects
+ *
+ * The #GESProject is used to control a set of #GESAsset and is a
+ * #GESAsset with #GES_TYPE_TIMELINE as @extractable_type itself. That
+ * means that you can extract #GESTimeline from a project as followed:
+ *
+ * |[
+ *  GESProject *project;
+ *  GESTimeline *timeline;
+ *
+ *  project = ges_project_new ("file:///path/to/a/valid/project/uri");
+ *
+ *  // Here you can connect to the various signal to get more infos about
+ *  // what is happening and recover from errors if possible
+ *  ...
+ *
+ *  timeline = ges_asset_extract (GES_ASSET (project));
+ * ]|
+ *
+ * The #GESProject class offers a higher level API to handle #GESAsset-s.
+ * It lets you request new asset, and it informs you about new assets through
+ * a set of signals. Also it handles problem such as missing files/missing
+ * #GstElement and lets you try to recover from those.
+ */
+#include "ges.h"
+#include "ges-internal.h"
+
+/* TODO We should rely on both extractable_type and @id to identify
+ * a Asset, not only @id
+ */
+G_DEFINE_TYPE (GESProject, ges_project, GES_TYPE_ASSET);
+
+struct _GESProjectPrivate
+{
+  GHashTable *assets;
+  GESAsset *formatter_asset;
+
+  GList *formatters;
+
+  gchar *uri;
+
+  GList *encoding_profiles;
+};
+
+typedef struct EmitLoadedInIdle
+{
+  GESProject *project;
+  GESTimeline *timeline;
+} EmitLoadedInIdle;
+
+enum
+{
+  LOADED_SIGNAL,
+  ERROR_LOADING_ASSET,
+  ASSET_ADDED_SIGNAL,
+  ASSET_REMOVED_SIGNAL,
+  MISSING_URI_SIGNAL,
+  LAST_SIGNAL
+};
+
+static guint _signals[LAST_SIGNAL] = { 0 };
+
+static guint nb_projects = 0;
+
+enum
+{
+  PROP_0,
+  PROP_URI,
+  PROP_LAST,
+};
+
+static GParamSpec *_properties[LAST_SIGNAL] = { 0 };
+
+static gboolean
+_emit_loaded_in_idle (EmitLoadedInIdle * data)
+{
+  g_signal_emit (data->project, _signals[LOADED_SIGNAL], 0, data->timeline);
+
+  gst_object_unref (data->project);
+  gst_object_unref (data->timeline);
+  g_slice_free (EmitLoadedInIdle, data);
+
+  return FALSE;
+}
+
+static void
+ges_project_add_formatter (GESProject * project, GESFormatter * formatter)
+{
+  GESProjectPrivate *priv = GES_PROJECT (project)->priv;
+
+  ges_formatter_set_project (formatter, project);
+  priv->formatters = g_list_append (priv->formatters, formatter);
+
+  g_object_ref_sink (formatter);
+}
+
+static void
+ges_project_remove_formatter (GESProject * project, GESFormatter * formatter)
+{
+  GList *tmp;
+  GESProjectPrivate *priv = GES_PROJECT (project)->priv;
+
+  for (tmp = priv->formatters; tmp; tmp = tmp->next) {
+    if (tmp->data == formatter) {
+      gst_object_unref (formatter);
+      priv->formatters = g_list_remove_link (priv->formatters, tmp);
+
+      return;
+    }
+  }
+}
+
+static void
+ges_project_set_uri (GESProject * project, const gchar * uri)
+{
+  GESProjectPrivate *priv;
+
+  g_return_if_fail (GES_IS_PROJECT (project));
+
+  priv = project->priv;
+  if (priv->uri) {
+    GST_WARNING_OBJECT (project, "Trying to rest URI, this is prohibited");
+
+    return;
+  }
+
+  if (uri == NULL || !gst_uri_is_valid (uri)) {
+    GST_LOG_OBJECT (project, "Invalid URI: %s", uri);
+    return;
+  }
+
+  priv->uri = g_strdup (uri);
+
+  /* We use that URI as ID */
+  ges_asset_set_id (GES_ASSET (project), uri);
+
+  return;
+}
+
+static gboolean
+_load_project (GESProject * project, GESTimeline * timeline, GError ** error)
+{
+  GError *lerr = NULL;
+  GESProjectPrivate *priv;
+  GESFormatter *formatter;
+
+  priv = GES_PROJECT (project)->priv;
+
+  if (priv->uri == NULL) {
+    EmitLoadedInIdle *data = g_slice_new (EmitLoadedInIdle);
+
+    GST_LOG_OBJECT (project, "%s, Loading an empty timeline %s"
+        " as no URI set yet", GST_OBJECT_NAME (timeline),
+        ges_asset_get_id (GES_ASSET (project)));
+
+    data->timeline = gst_object_ref (timeline);
+    data->project = gst_object_ref (project);
+
+    /* Make sure the signal is emitted after the functions ends */
+    g_idle_add ((GSourceFunc) _emit_loaded_in_idle, data);
+    return TRUE;
+  }
+
+  if (priv->formatter_asset == NULL)
+    priv->formatter_asset = _find_formatter_asset_for_uri (priv->uri);
+
+  if (priv->formatter_asset == NULL)
+    goto failed;
+
+  formatter = GES_FORMATTER (ges_asset_extract (priv->formatter_asset, &lerr));
+  if (lerr) {
+    GST_WARNING_OBJECT (project, "Could not create the formatter: %s",
+        (*error)->message);
+
+    goto failed;
+  }
+
+  ges_project_add_formatter (GES_PROJECT (project), formatter);
+  ges_formatter_load_from_uri (formatter, timeline, priv->uri, &lerr);
+  if (lerr) {
+    GST_WARNING_OBJECT (project, "Could not load the timeline,"
+        " returning: %s", lerr->message);
+    goto failed;
+  }
+
+  return TRUE;
+
+failed:
+  if (lerr)
+    g_propagate_error (error, lerr);
+  return FALSE;
+}
+
+static gboolean
+_uri_missing_accumulator (GSignalInvocationHint * ihint, GValue * return_accu,
+    const GValue * handler_return, gpointer data)
+{
+  const gchar *ret = g_value_get_string (handler_return);
+
+  if (ret && gst_uri_is_valid (ret)) {
+    g_value_set_string (return_accu, ret);
+    return FALSE;
+  }
+
+  return TRUE;
+}
+
+/* GESAsset vmethod implementation */
+static GESExtractable *
+ges_project_extract (GESAsset * project, GError ** error)
+{
+  GESTimeline *timeline = ges_timeline_new ();
+
+  if (_load_project (GES_PROJECT (project), timeline, error))
+    return GES_EXTRACTABLE (timeline);
+
+  gst_object_unref (timeline);
+  return NULL;
+}
+
+/* GObject vmethod implementation */
+static void
+_dispose (GObject * object)
+{
+  GList *tmp;
+  GESProjectPrivate *priv = GES_PROJECT (object)->priv;
+
+  if (priv->assets)
+    g_hash_table_unref (priv->assets);
+  if (priv->formatter_asset)
+    gst_object_unref (priv->formatter_asset);
+
+  for (tmp = priv->formatters; tmp; tmp = tmp->next)
+    ges_project_remove_formatter (GES_PROJECT (object), tmp->data);;
+
+  G_OBJECT_CLASS (ges_project_parent_class)->dispose (object);
+}
+
+static void
+_finalize (GObject * object)
+{
+  GESProjectPrivate *priv = GES_PROJECT (object)->priv;
+
+  if (priv->uri)
+    g_free (priv->uri);
+}
+
+static void
+_get_property (GESProject * project, guint property_id,
+    GValue * value, GParamSpec * pspec)
+{
+  GESProjectPrivate *priv = project->priv;
+
+  switch (property_id) {
+    case PROP_URI:
+      g_value_set_string (value, priv->uri);
+      break;
+    default:
+      G_OBJECT_WARN_INVALID_PROPERTY_ID (project, property_id, pspec);
+  }
+}
+
+static void
+_set_property (GESProject * project, guint property_id,
+    const GValue * value, GParamSpec * pspec)
+{
+  switch (property_id) {
+    case PROP_URI:
+      project->priv->uri = g_value_dup_string (value);
+      break;
+    default:
+      G_OBJECT_WARN_INVALID_PROPERTY_ID (project, property_id, pspec);
+  }
+}
+
+static void
+ges_project_class_init (GESProjectClass * klass)
+{
+  GObjectClass *object_class = G_OBJECT_CLASS (klass);
+
+  g_type_class_add_private (klass, sizeof (GESProjectPrivate));
+
+  klass->asset_added = NULL;
+  klass->missing_uri = NULL;
+  klass->loading_error = NULL;
+  klass->asset_removed = NULL;
+  object_class->get_property = (GObjectGetPropertyFunc) _get_property;
+  object_class->set_property = (GObjectSetPropertyFunc) _set_property;
+
+  /**
+   * GESProject::uri:
+   *
+   * The location of the project to use.
+   */
+  _properties[PROP_URI] = g_param_spec_string ("uri", "URI",
+      "uri of the project", NULL, G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY);
+
+  g_object_class_install_properties (object_class, PROP_LAST, _properties);
+
+  /**
+   * GESProject::asset-added:
+   * @formatter: the #GESProject
+   * @asset: The #GESAsset that has been added to @project
+   */
+  _signals[ASSET_ADDED_SIGNAL] =
+      g_signal_new ("asset-added", G_TYPE_FROM_CLASS (klass),
+      G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (GESProjectClass, asset_added),
+      NULL, NULL, g_cclosure_marshal_generic, G_TYPE_NONE, 1, GES_TYPE_ASSET);
+
+  /**
+   * GESProject::asset-removed:
+   * @formatter: the #GESProject
+   * @asset: The #GESAsset that has been removed from @project
+   */
+  _signals[ASSET_REMOVED_SIGNAL] =
+      g_signal_new ("asset-removed", G_TYPE_FROM_CLASS (klass),
+      G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (GESProjectClass, asset_removed),
+      NULL, NULL, g_cclosure_marshal_generic, G_TYPE_NONE, 1, GES_TYPE_ASSET);
+
+  /**
+   * GESProject::loaded:
+   * @project: the #GESProject that is done loading a project.
+   * @timeline: The #GESTimeline that complete loading
+   */
+  _signals[LOADED_SIGNAL] =
+      g_signal_new ("loaded", G_TYPE_FROM_CLASS (klass),
+      G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (GESProjectClass, loaded),
+      NULL, NULL, g_cclosure_marshal_generic, G_TYPE_NONE,
+      1, GES_TYPE_TIMELINE);
+
+  /**
+   * GESProject::missing-uri:
+   * @project: the #GESProject reporting that a file has moved
+   * @error: The error that happened
+   * @wrong_asset: The asset with the wrong ID, you should us it and its content
+   * only to find out what the new location is.
+   *
+   * |[
+   * static gchar
+   * source_moved_cb (GESProject *project, GError *error, const gchar *old_uri)
+   * {
+   *   return g_strdup ("file:///the/new/uri.ogg");
+   * }
+   *
+   * static int
+   * main (int argc, gchar ** argv)
+   * {
+   *   GESTimeline *timeline;
+   *   GESProject *project = ges_project_new ("file:///some/uri.xges");
+   *
+   *   g_signal_connect (project, "missing-uri", source_moved_cb, NULL);
+   *   timeline = ges_asset_extract (GES_ASSET (project));
+   * }
+   * ]|
+   *
+   * Returns: (transfer full) (allow-none): The new URI of @wrong_asset
+   */
+  _signals[MISSING_URI_SIGNAL] =
+      g_signal_new ("missing-uri", G_TYPE_FROM_CLASS (klass),
+      G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (GESProjectClass, missing_uri),
+      _uri_missing_accumulator, NULL, g_cclosure_marshal_generic,
+      G_TYPE_STRING, 2, G_TYPE_ERROR, GES_TYPE_ASSET);
+
+  /**
+   * GESProject::error-loading-asset:
+   * @project: the #GESProject on which a problem happend when creted a #GESAsset
+   * @error: The #GError defining the error that accured, might be %NULL
+   * @id: The @id of the asset that failed loading
+   * @extractable_type: The @extractable_type of the asset that
+   * failed loading
+   *
+   * Informs you that a #GESAsset could not be created. In case of
+   * missing GStreamer plugins, the error will be set to #GST_CORE_ERROR
+   * #GST_CORE_ERROR_MISSING_PLUGIN
+   */
+  _signals[ERROR_LOADING_ASSET] =
+      g_signal_new ("error-loading-asset", G_TYPE_FROM_CLASS (klass),
+      G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (GESProjectClass, loading_error),
+      NULL, NULL, g_cclosure_marshal_generic,
+      G_TYPE_NONE, 3, G_TYPE_ERROR, G_TYPE_STRING, G_TYPE_GTYPE);
+
+  object_class->dispose = _dispose;
+  object_class->dispose = _finalize;
+
+  GES_ASSET_CLASS (klass)->extract = ges_project_extract;
+}
+
+static void
+ges_project_init (GESProject * project)
+{
+  GESProjectPrivate *priv = project->priv =
+      G_TYPE_INSTANCE_GET_PRIVATE (project,
+      GES_TYPE_PROJECT, GESProjectPrivate);
+
+  priv->uri = NULL;
+  priv->formatters = NULL;
+  priv->formatter_asset = NULL;
+  priv->encoding_profiles = NULL;
+  priv->assets = g_hash_table_new_full (g_str_hash, g_str_equal,
+      g_free, gst_object_unref);
+}
+
+gchar *
+ges_project_try_updating_id (GESProject * project, GESAsset * asset,
+    GError * error)
+{
+  gchar *new_id = NULL;
+
+  g_return_val_if_fail (GES_IS_PROJECT (project), NULL);
+  g_return_val_if_fail (GES_IS_ASSET (asset), NULL);
+  g_return_val_if_fail (error, NULL);
+
+  GST_DEBUG_OBJECT (project, "Try to proxy %s", ges_asset_get_id (asset));
+  if (ges_asset_request_id_update (asset, &new_id, error) == FALSE) {
+    GST_DEBUG_OBJECT (project, "Type: %s can not be proxied for id: %s",
+        g_type_name (G_OBJECT_TYPE (asset)), ges_asset_get_id (asset));
+
+    return NULL;
+  }
+
+  if (new_id == NULL)
+    g_signal_emit (project, _signals[MISSING_URI_SIGNAL], 0, error, asset,
+        &new_id);
+
+  if (new_id) {
+    if (ges_asset_set_proxy (asset, new_id))
+      return new_id;
+    else
+      g_free (new_id);
+  }
+
+  return NULL;
+}
+
+static void
+new_asset_cb (GESAsset * source, GAsyncResult * res, GESProject * project)
+{
+  GError *error = NULL;
+  gchar *possible_id = NULL;
+  const gchar *id = ges_asset_get_id (source);
+  GESAsset *asset = ges_asset_request_finish (res, &error);
+
+  if (error) {
+    possible_id = ges_project_try_updating_id (project, source, error);
+    if (possible_id == NULL) {
+      g_signal_emit (project, _signals[ERROR_LOADING_ASSET], 0, error, id,
+          ges_asset_get_extractable_type (source));
+
+      return;
+    }
+    ges_asset_request_async (ges_asset_get_extractable_type (source),
+        possible_id, NULL, (GAsyncReadyCallback) new_asset_cb, project);
+
+    g_free (possible_id);
+    return;
+  }
+
+  ges_project_add_asset (project, asset);
+  if (asset)
+    gst_object_unref (asset);
+}
+
+/**
+ * ges_project_set_loaded:
+ * @project: The #GESProject from which to emit the "project-loaded" signal
+ *
+ * Emits the "loaded" signal. This method should be called by sublasses when
+ * the project is fully loaded.
+ *
+ * Returns: %TRUE if the signale could be emitted %FALSE otherwize
+ */
+gboolean
+ges_project_set_loaded (GESProject * project, GESFormatter * formatter)
+{
+  GST_INFO_OBJECT (project, "Emit project loaded");
+  g_signal_emit (project, _signals[LOADED_SIGNAL], 0, formatter->timeline);
+
+  /* We are now done with that formatter */
+  ges_project_remove_formatter (project, formatter);
+  return TRUE;
+}
+
+/**************************************
+ *                                    *
+ *         API Implementation         *
+ *                                    *
+ **************************************/
+
+/**
+ * ges_project_create_asset:
+ * @project: A #GESProject
+ * @id: The id of the asset to create and add to @project
+ * @extractable_type: The #GType of the asset to create
+ *
+ * Create and add a #GESAsset to @project. You should connect to the
+ * "asset-added" signal to get the asset when it finally gets added to
+ * @project
+ *
+ * Returns: %TRUE if the asset started to be added %FALSE it was already
+ * in the project
+ */
+gboolean
+ges_project_create_asset (GESProject * project, const gchar * id,
+    GType extractable_type)
+{
+  g_return_val_if_fail (GES_IS_PROJECT (project), FALSE);
+  g_return_val_if_fail (g_type_is_a (extractable_type, GES_TYPE_EXTRACTABLE),
+      FALSE);
+
+  if (g_hash_table_lookup (project->priv->assets, id))
+    return FALSE;
+
+  /* TODO Add a GCancellable somewhere in our API */
+  ges_asset_request_async (extractable_type, id, NULL,
+      (GAsyncReadyCallback) new_asset_cb, project);
+
+  return TRUE;
+}
+
+/**
+ * ges_project_add_asset:
+ * @project: A #GESProject
+ * @asset: (transfer none): A #GESAsset to add to @project
+ *
+ * Adds a #Asset to @project, the project will keep a reference on
+ * @asset.
+ *
+ * Returns: %TRUE if the asset could be added %FALSE it was already
+ * in the project
+ */
+gboolean
+ges_project_add_asset (GESProject * project, GESAsset * asset)
+{
+  g_return_val_if_fail (GES_IS_PROJECT (project), FALSE);
+
+  if (g_hash_table_lookup (project->priv->assets, ges_asset_get_id (asset)))
+    return FALSE;
+
+  g_hash_table_insert (project->priv->assets,
+      g_strdup (ges_asset_get_id (asset)), gst_object_ref (asset));
+
+  GST_DEBUG_OBJECT (project, "Asset added: %s", ges_asset_get_id (asset));
+  g_signal_emit (project, _signals[ASSET_ADDED_SIGNAL], 0, asset);
+
+  return TRUE;
+}
+
+/**
+ * ges_project_remove_asset:
+ * @project: A #GESProject
+ * @asset: (transfer none): A #GESAsset to remove from @project
+ *
+ * remove a @asset to from @project.
+ *
+ * Returns: %TRUE if the asset could be removed %FALSE otherwise
+ */
+gboolean
+ges_project_remove_asset (GESProject * project, GESAsset * asset)
+{
+  gboolean ret;
+
+  g_return_val_if_fail (GES_IS_PROJECT (project), FALSE);
+
+  ret = g_hash_table_remove (project->priv->assets, ges_asset_get_id (asset));
+
+  g_signal_emit (project, _signals[ASSET_REMOVED_SIGNAL], 0, asset);
+
+  return ret;
+}
+
+/**
+ * ges_project_get_asset:
+ * @project: A #GESProject
+ * @id: The id of the asset to retrieve
+ * @extractable_type: The extractable_type of the asset
+ * to retrieve from @object
+ *
+ * Returns: (transfer full) (allow-none): The #GESAsset with
+ * @id or %NULL if no asset with @id as an ID
+ */
+GESAsset *
+ges_project_get_asset (GESProject * project, const gchar * id,
+    GType extractable_type)
+{
+  GESAsset *asset;
+
+  g_return_val_if_fail (GES_IS_PROJECT (project), NULL);
+  g_return_val_if_fail (g_type_is_a (extractable_type, GES_TYPE_EXTRACTABLE),
+      NULL);
+
+  asset = g_hash_table_lookup (project->priv->assets, id);
+
+  if (asset)
+    return gst_object_ref (asset);
+
+  return NULL;
+}
+
+/**
+ * ges_project_list_assets:
+ * @project: A #GESProject
+ * @filter: Type of assets to list, #GES_TYPE_EXTRACTABLE will list
+ * all assets
+ *
+ * List all @asset contained in @project filtering per extractable_type
+ * as defined by @filter. It copies the asset and thus will not be updated
+ * in time.
+ *
+ * Returns: (transfer full) (element-type GESAsset): The list of
+ * #GESAsset the object contains
+ */
+GList *
+ges_project_list_assets (GESProject * project, GType filter)
+{
+  GList *ret = NULL;
+  GHashTableIter iter;
+  gpointer key, value;
+
+  g_return_val_if_fail (GES_IS_PROJECT (project), NULL);
+
+  g_hash_table_iter_init (&iter, project->priv->assets);
+  while (g_hash_table_iter_next (&iter, &key, &value)) {
+    if (g_type_is_a (ges_asset_get_extractable_type (GES_ASSET (value)),
+            filter))
+      ret = g_list_append (ret, g_object_ref (value));
+  }
+
+  return ret;
+}
+
+/**
+ * ges_project_save:
+ * @project: A #GESProject to save
+ * @timeline: The #GESTimeline to save, it must have been extracted from @project
+ * @uri: The uri where to save @project and @timeline
+ * @formatter_asset: (allow-none): The formatter asset to use or %NULL. If %NULL,
+ * will try to save in the same format as the one from which the timeline as been loaded
+ * or default to the formatter with highest rank
+ * @overwrite: %TRUE to overwrite file if it exists
+ * @error: (out) (allow-none): An error to be set in case something wrong happens or %NULL
+ *
+ * Save the timeline of @project to @uri. You should make sure that @timeline
+ * is one of the timelines that have been extracted from @project
+ * (using ges_asset_extract (@project);)
+ *
+ * Returns: %TRUE if the project could be save, %FALSE otherwize
+ */
+gboolean
+ges_project_save (GESProject * project, GESTimeline * timeline,
+    const gchar * uri, GESAsset * formatter_asset, gboolean overwrite,
+    GError ** error)
+{
+  GESAsset *tl_asset;
+  gboolean ret = TRUE;
+  GESFormatter *formatter = NULL;
+
+  g_return_val_if_fail (GES_IS_PROJECT (project), FALSE);
+  g_return_val_if_fail (formatter_asset == NULL ||
+      g_type_is_a (ges_asset_get_extractable_type (formatter_asset),
+          GES_TYPE_FORMATTER), FALSE);
+  g_return_val_if_fail ((error == NULL || *error == NULL), FALSE);
+
+  tl_asset = ges_extractable_get_asset (GES_EXTRACTABLE (timeline));
+  if (tl_asset == NULL && project->priv->uri == NULL) {
+    GESAsset *asset = ges_asset_cache_lookup (GES_TYPE_PROJECT, uri);
+
+    if (asset) {
+      GST_WARNING_OBJECT (project, "Trying to save project to %s but we already"
+          "have %" GST_PTR_FORMAT " for that uri, can not save", uri, asset);
+      goto out;
+    }
+
+    GST_DEBUG_OBJECT (project, "Timeline %" GST_PTR_FORMAT " has no asset"
+        " we have no uri set, so setting ourself as asset", timeline);
+
+    ges_extractable_set_asset (GES_EXTRACTABLE (timeline), GES_ASSET (project));
+  } else if (tl_asset != GES_ASSET (project)) {
+    GST_WARNING_OBJECT (project, "Timeline %" GST_PTR_FORMAT
+        " not created by this project can not save", timeline);
+
+    ret = FALSE;
+    goto out;
+  }
+
+  if (formatter_asset == NULL)
+    formatter_asset = gst_object_ref (ges_formatter_get_default ());
+
+  formatter = GES_FORMATTER (ges_asset_extract (formatter_asset, error));
+  if (formatter == NULL) {
+    GST_WARNING_OBJECT (project, "Could not create the formatter %s: Error: %s",
+        formatter_asset, (error && *error) ? (*error)->message : "Unknown");
+
+    ret = FALSE;
+    goto out;
+  }
+
+  ges_project_add_formatter (project, formatter);
+  ret = ges_formatter_save_to_uri (formatter, timeline, uri, overwrite, error);
+  if (ret && project->priv->uri == NULL)
+    ges_project_set_uri (project, uri);
+
+out:
+  if (formatter_asset)
+    gst_object_unref (formatter_asset);
+  ges_project_remove_formatter (project, formatter);
+
+  return ret;
+}
+
+/**
+ * ges_project_new:
+ * @uri: (allow-none): The uri to be set after creating the project.
+ *
+ * Creates a new #GESProject and sets its uri to @uri if provided. Note that
+ * if @uri is not valid or %NULL, the uri of the project will then be set
+ * the first time you save the project. If you then save the project to
+ * other locations, it will never be updated again and the first valid URI is
+ * the URI it will keep refering to.
+ *
+ * Returns: A newly created #GESProject
+ */
+GESProject *
+ges_project_new (const gchar * uri)
+{
+  gchar *id = (gchar *) uri;
+  GESProject *project;
+
+  if (uri == NULL)
+    id = g_strdup_printf ("project-%i", nb_projects++);
+
+  project = GES_PROJECT (ges_asset_request (GES_TYPE_TIMELINE, id, NULL));
+
+  if (project && uri)
+    ges_project_set_uri (project, uri);
+
+  return project;
+}
+
+/**
+ * ges_project_load:
+ * @project: A #GESProject that has an @uri set already
+ * @timeline: A blank timeline to load @project into
+ * @error: (out) (allow-none): An error to be set in case something wrong happens or %NULL
+ *
+ * Loads @project into @timeline
+ *
+ * Returns: %TRUE if the project could be loaded %FALSE otherwize.
+ */
+gboolean
+ges_project_load (GESProject * project, GESTimeline * timeline, GError ** error)
+{
+  g_return_val_if_fail (GES_IS_TIMELINE (timeline), FALSE);
+  g_return_val_if_fail (GES_IS_PROJECT (project), FALSE);
+  g_return_val_if_fail (ges_project_get_uri (project), FALSE);
+  g_return_val_if_fail (
+      (ges_extractable_get_asset (GES_EXTRACTABLE (timeline)) == NULL), FALSE);
+
+  if (!_load_project (project, timeline, error))
+    return FALSE;
+
+  ges_extractable_set_asset (GES_EXTRACTABLE (timeline), GES_ASSET (project));
+
+  return TRUE;
+}
+
+/**
+ * ges_project_get_uri:
+ * @project: A #GESProject
+ *
+ * Retrieve the uri that is currently set on @project
+ *
+ * Returns: The uri that is set on @project
+ */
+gchar *
+ges_project_get_uri (GESProject * project)
+{
+  GESProjectPrivate *priv;
+
+  g_return_val_if_fail (GES_IS_PROJECT (project), FALSE);
+
+  priv = project->priv;
+  if (priv->uri)
+    return g_strdup (priv->uri);
+  return NULL;
+}
+
+/**
+ * ges_project_add_encoding_profile:
+ * @project: A #GESProject
+ * @profile: A #GstEncodingProfile to add to the project. If a profile with
+ * the same name already exists, it will be replaced
+ *
+ * Adds @profile to the project. It lets you save in what format
+ * the project has been renders and keep a reference to those formats.
+ * Also, those formats will be saves to the project file when possible.
+ *
+ * Returns: %TRUE if @profile could be added, %FALSE otherwize
+ */
+gboolean
+ges_project_add_encoding_profile (GESProject * project,
+    GstEncodingProfile * profile)
+{
+  GList *tmp;
+  GESProjectPrivate *priv;
+
+  g_return_val_if_fail (GES_IS_PROJECT (project), FALSE);
+  g_return_val_if_fail (GST_IS_ENCODING_PROFILE (profile), FALSE);
+
+  priv = project->priv;
+  for (tmp = priv->encoding_profiles; tmp; tmp = tmp->next) {
+    GstEncodingProfile *tmpprofile = GST_ENCODING_PROFILE (tmp->data);
+
+    if (g_strcmp0 (gst_encoding_profile_get_name (tmpprofile),
+            gst_encoding_profile_get_name (profile)) == 0) {
+      GST_INFO_OBJECT (project, "Already have profile: %s, replacing it",
+          gst_encoding_profile_get_name (profile));
+
+      gst_object_unref (tmp->data);
+      tmp->data = gst_object_ref (profile);
+      return TRUE;
+    }
+  }
+
+  priv->encoding_profiles = g_list_prepend (priv->encoding_profiles,
+      gst_object_ref (profile));
+
+  return TRUE;
+}
+
+/**
+ * ges_project_list_encoding_profiles:
+ * @project: A #GESProject
+ *
+ * Lists the encoding profile that have been set to @project. The first one
+ * is the latest added.
+ *
+ * Returns: (transfer none) (element-type GstPbutils.EncodingProfile) (allow-none): The
+ * list of #GstEncodingProfile used in @project
+ */
+const GList *
+ges_project_list_encoding_profiles (GESProject * project)
+{
+  g_return_val_if_fail (GES_IS_PROJECT (project), FALSE);
+
+  return project->priv->encoding_profiles;
+}
diff --git a/ges/ges-project.h b/ges/ges-project.h
new file mode 100644 (file)
index 0000000..a47919b
--- /dev/null
@@ -0,0 +1,104 @@
+/* GStreamer Editing Services
+ *
+ * Copyright (C) <2012> Thibault Saunier <thibault.saunier@collabora.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., 59 Temple Place - Suite 330,
+ * Boston, MA 02111-1307, USA.
+ */
+#ifndef _GES_PROJECT_
+#define _GES_PROJECT_
+
+#include <glib-object.h>
+#include <gio/gio.h>
+#include <ges/ges-types.h>
+#include <ges/ges-asset.h>
+#include <gst/pbutils/encoding-profile.h>
+
+G_BEGIN_DECLS
+
+#define GES_TYPE_PROJECT            ges_project_get_type()
+#define GES_PROJECT(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GES_TYPE_PROJECT, GESProject))
+#define GES_PROJECT_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), GES_TYPE_PROJECT, GESProjectClass))
+#define GES_IS_PROJECT(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GES_TYPE_PROJECT))
+#define GES_IS_PROJECT_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GES_TYPE_PROJECT))
+#define GES_PROJECT_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), GES_TYPE_PROJECT, GESProjectClass))
+
+typedef struct _GESProjectPrivate GESProjectPrivate;
+
+GType ges_project_get_type (void);
+
+struct _GESProject
+{
+  GESAsset parent;
+
+  /* <private> */
+  GESProjectPrivate *priv;
+
+  /* Padding for API extension */
+  gpointer __ges_reserved[GES_PADDING_LARGE];
+};
+
+struct _GESProjectClass
+{
+  GESAssetClass parent_class;
+
+  /* Signals */
+  void     (*asset_added)    (GESProject * self,
+                              GESAsset   * asset);
+  void     (*asset_removed)  (GESProject * self,
+                              GESAsset   * asset);
+  gboolean (*missing_uri)    (GESProject * self,
+                              GError     * error,
+                              GESAsset   * wrong_asset);
+  gboolean (*loading_error)  (GESProject * self,
+                              GError     * error,
+                              gchar      * id,
+                              GType extractable_type);
+  gboolean (*loaded)         (GESProject  * self,
+                              GESTimeline * timeline);
+
+  gpointer _ges_reserved[GES_PADDING];
+};
+
+gboolean  ges_project_add_asset    (GESProject* project,
+                                    GESAsset *asset);
+gboolean  ges_project_remove_asset (GESProject *project,
+                                    GESAsset * asset);
+GList   * ges_project_list_assets  (GESProject * project,
+                                    GType filter);
+gboolean  ges_project_save         (GESProject * project,
+                                    GESTimeline * timeline,
+                                    const gchar *uri,
+                                    GESAsset * formatter_asset,
+                                    gboolean overwrite,
+                                    GError **error);
+gboolean  ges_project_load         (GESProject * project,
+                                    GESTimeline * timeline,
+                                    GError **error);
+GESProject * ges_project_new       (const gchar *uri);
+gchar      * ges_project_get_uri   (GESProject *project);
+GESAsset   * ges_project_get_asset (GESProject * project,
+                                    const gchar *id,
+                                    GType extractable_type);
+gboolean ges_project_create_asset  (GESProject * project,
+                                    const gchar *id,
+                                    GType extractable_type);
+
+gboolean ges_project_add_encoding_profile       (GESProject *project,
+                                                 GstEncodingProfile *profile);
+const GList *ges_project_list_encoding_profiles (GESProject *project);
+G_END_DECLS
+
+#endif  /* _GES_PROJECT */
index df0dae25c096d714aaeee70430a8a85ae98c8bd4..384c2accda998a3da1b601c309e76271353e7f99 100644 (file)
@@ -146,6 +146,9 @@ typedef struct _GESAssetClass GESAssetClass;
 typedef struct _GESAssetFileSource GESAssetFileSource;
 typedef struct _GESAssetFileSourceClass GESAssetFileSourceClass;
 
+typedef struct _GESProject GESProject;
+typedef struct _GESProjectClass GESProjectClass;
+
 typedef struct _GESExtractable GESExtractable;
 typedef struct _GESExtractableInterface GESExtractableInterface;
 
index 10ee7731276b10847156449be0f1ac778c434250..2350cc3460c54098bfdf4538fefb4d0d0fad0653 100644 (file)
--- a/ges/ges.h
+++ b/ges/ges.h
@@ -47,6 +47,9 @@
 #include <ges/ges-screenshot.h>
 #include <ges/ges-asset.h>
 #include <ges/ges-asset-file-source.h>
+#if 0
+#include <ges/ges-project.h>
+#endif
 #include <ges/ges-extractable.h>
 
 #include <ges/ges-track.h>