ges/ges-project.c

   1 /* GStreamer Editing Services
   2  *
   3  * Copyright (C) <2012> Thibault Saunier <thibault.saunier@collabora.com>
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Library General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2 of the License, or (at your option) any later version.
   9  *
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Library General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Library General Public
  16  * License along with this library; if not, write to the
  17  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18  * Boston, MA 02111-1307, USA.
  19  */
  20 /**
  21  * SECTION: ges-project
  22  * @short_description: A GESAsset that is used to manage projects
  23  *
  24  * The #GESProject is used to control a set of #GESAsset and is a
  25  * #GESAsset with #GES_TYPE_TIMELINE as @extractable_type itself. That
  26  * means that you can extract #GESTimeline from a project as followed:
  27  *
  28  * |[
  29  *  GESProject *project;
  30  *  GESTimeline *timeline;
  31  *
  32  *  project = ges_project_new ("file:///path/to/a/valid/project/uri");
  33  *
  34  *  // Here you can connect to the various signal to get more infos about
  35  *  // what is happening and recover from errors if possible
  36  *  ...
  37  *
  38  *  timeline = ges_asset_extract (GES_ASSET (project));
  39  * ]|
  40  *
  41  * The #GESProject class offers a higher level API to handle #GESAsset-s.
  42  * It lets you request new asset, and it informs you about new assets through
  43  * a set of signals. Also it handles problem such as missing files/missing
  44  * #GstElement and lets you try to recover from those.
  45  */
  46 #include "ges.h"
  47 #include "ges-internal.h"
  48
  49 /* TODO We should rely on both extractable_type and @id to identify
  50  * a Asset, not only @id
  51  */
  52 G_DEFINE_TYPE (GESProject, ges_project, GES_TYPE_ASSET);
  53
  54 struct _GESProjectPrivate
  55 {
  56   GHashTable *assets;
  57   /* Set of asset ID being loaded */
  58   GHashTable *loading_assets;
  59   GHashTable *loaded_with_error;
  60   GESAsset *formatter_asset;
  61
  62   GList *formatters;
  63
  64   gchar *uri;
  65
  66   GList *encoding_profiles;
  67 };
  68
  69 typedef struct EmitLoadedInIdle
  70 {
  71   GESProject *project;
  72   GESTimeline *timeline;
  73 } EmitLoadedInIdle;
  74
  75 enum
  76 {
  77   LOADED_SIGNAL,
  78   ERROR_LOADING_ASSET,
  79   ASSET_ADDED_SIGNAL,
  80   ASSET_REMOVED_SIGNAL,
  81   MISSING_URI_SIGNAL,
  82   LAST_SIGNAL
  83 };
  84
  85 static guint _signals[LAST_SIGNAL] = { 0 };
  86
  87 static guint nb_projects = 0;
  88
  89 enum
  90 {
  91   PROP_0,
  92   PROP_URI,
  93   PROP_LAST,
  94 };
  95
  96 static GParamSpec *_properties[LAST_SIGNAL] = { 0 };
  97
  98 static gboolean
  99 _emit_loaded_in_idle (EmitLoadedInIdle * data)
 100 {
 101   ges_timeline_commit (data->timeline);
 102   g_signal_emit (data->project, _signals[LOADED_SIGNAL], 0, data->timeline);
 103
 104   gst_object_unref (data->project);
 105   gst_object_unref (data->timeline);
 106   g_slice_free (EmitLoadedInIdle, data);
 107
 108   return FALSE;
 109 }
 110
 111 static void
 112 ges_project_add_formatter (GESProject * project, GESFormatter * formatter)
 113 {
 114   GESProjectPrivate *priv = GES_PROJECT (project)->priv;
 115
 116   ges_formatter_set_project (formatter, project);
 117   priv->formatters = g_list_append (priv->formatters, formatter);
 118
 119   gst_object_ref_sink (formatter);
 120 }
 121
 122 static void
 123 ges_project_remove_formatter (GESProject * project, GESFormatter * formatter)
 124 {
 125   GList *tmp;
 126   GESProjectPrivate *priv = GES_PROJECT (project)->priv;
 127
 128   for (tmp = priv->formatters; tmp; tmp = tmp->next) {
 129     if (tmp->data == formatter) {
 130       gst_object_unref (formatter);
 131       priv->formatters = g_list_delete_link (priv->formatters, tmp);
 132
 133       return;
 134     }
 135   }
 136 }
 137
 138 static void
 139 ges_project_set_uri (GESProject * project, const gchar * uri)
 140 {
 141   GESProjectPrivate *priv;
 142
 143   g_return_if_fail (GES_IS_PROJECT (project));
 144
 145   priv = project->priv;
 146   if (priv->uri) {
 147     GST_WARNING_OBJECT (project, "Trying to rest URI, this is prohibited");
 148
 149     return;
 150   }
 151
 152   if (uri == NULL || !gst_uri_is_valid (uri)) {
 153     GST_LOG_OBJECT (project, "Invalid URI: %s", uri);
 154     return;
 155   }
 156
 157   priv->uri = g_strdup (uri);
 158
 159   /* We use that URI as ID */
 160   ges_asset_set_id (GES_ASSET (project), uri);
 161
 162   return;
 163 }
 164
 165 static gboolean
 166 _load_project (GESProject * project, GESTimeline * timeline, GError ** error)
 167 {
 168   GError *lerr = NULL;
 169   GESProjectPrivate *priv;
 170   GESFormatter *formatter;
 171
 172   priv = GES_PROJECT (project)->priv;
 173
 174   if (priv->uri == NULL) {
 175     EmitLoadedInIdle *data = g_slice_new (EmitLoadedInIdle);
 176
 177     GST_LOG_OBJECT (project, "%s, Loading an empty timeline %s"
 178         " as no URI set yet", GST_OBJECT_NAME (timeline),
 179         ges_asset_get_id (GES_ASSET (project)));
 180
 181     data->timeline = gst_object_ref (timeline);
 182     data->project = gst_object_ref (project);
 183
 184     /* Make sure the signal is emitted after the functions ends */
 185     g_idle_add ((GSourceFunc) _emit_loaded_in_idle, data);
 186     return TRUE;
 187   }
 188
 189   if (priv->formatter_asset == NULL)
 190     priv->formatter_asset = _find_formatter_asset_for_uri (priv->uri);
 191
 192   if (priv->formatter_asset == NULL)
 193     goto failed;
 194
 195   formatter = GES_FORMATTER (ges_asset_extract (priv->formatter_asset, &lerr));
 196   if (lerr) {
 197     GST_WARNING_OBJECT (project, "Could not create the formatter: %s",
 198         (*error)->message);
 199
 200     goto failed;
 201   }
 202
 203   ges_project_add_formatter (GES_PROJECT (project), formatter);
 204   ges_formatter_load_from_uri (formatter, timeline, priv->uri, &lerr);
 205   if (lerr) {
 206     GST_WARNING_OBJECT (project, "Could not load the timeline,"
 207         " returning: %s", lerr->message);
 208     goto failed;
 209   }
 210
 211   return TRUE;
 212
 213 failed:
 214   if (lerr)
 215     g_propagate_error (error, lerr);
 216   return FALSE;
 217 }
 218
 219 static gboolean
 220 _uri_missing_accumulator (GSignalInvocationHint * ihint, GValue * return_accu,
 221     const GValue * handler_return, gpointer data)
 222 {
 223   const gchar *ret = g_value_get_string (handler_return);
 224
 225   if (ret && gst_uri_is_valid (ret)) {
 226     g_value_set_string (return_accu, ret);
 227     return FALSE;
 228   }
 229
 230   return TRUE;
 231 }
 232
 233 /* GESAsset vmethod implementation */
 234 static GESExtractable *
 235 ges_project_extract (GESAsset * project, GError ** error)
 236 {
 237   GESTimeline *timeline = ges_timeline_new ();
 238
 239   if (_load_project (GES_PROJECT (project), timeline, error))
 240     return GES_EXTRACTABLE (timeline);
 241
 242   gst_object_unref (timeline);
 243   return NULL;
 244 }
 245
 246 /* GObject vmethod implementation */
 247 static void
 248 _dispose (GObject * object)
 249 {
 250   GList *tmp;
 251   GESProjectPrivate *priv = GES_PROJECT (object)->priv;
 252
 253   if (priv->assets)
 254     g_hash_table_unref (priv->assets);
 255   if (priv->loading_assets)
 256     g_hash_table_unref (priv->loading_assets);
 257   if (priv->loaded_with_error)
 258     g_hash_table_unref (priv->loaded_with_error);
 259   if (priv->formatter_asset)
 260     gst_object_unref (priv->formatter_asset);
 261
 262   for (tmp = priv->formatters; tmp; tmp = tmp->next)
 263     ges_project_remove_formatter (GES_PROJECT (object), tmp->data);;
 264
 265   G_OBJECT_CLASS (ges_project_parent_class)->dispose (object);
 266 }
 267
 268 static void
 269 _finalize (GObject * object)
 270 {
 271   GESProjectPrivate *priv = GES_PROJECT (object)->priv;
 272
 273   if (priv->uri)
 274     g_free (priv->uri);
 275 }
 276
 277 static void
 278 _get_property (GESProject * project, guint property_id,
 279     GValue * value, GParamSpec * pspec)
 280 {
 281   GESProjectPrivate *priv = project->priv;
 282
 283   switch (property_id) {
 284     case PROP_URI:
 285       g_value_set_string (value, priv->uri);
 286       break;
 287     default:
 288       G_OBJECT_WARN_INVALID_PROPERTY_ID (project, property_id, pspec);
 289   }
 290 }
 291
 292 static void
 293 _set_property (GESProject * project, guint property_id,
 294     const GValue * value, GParamSpec * pspec)
 295 {
 296   switch (property_id) {
 297     case PROP_URI:
 298       project->priv->uri = g_value_dup_string (value);
 299       break;
 300     default:
 301       G_OBJECT_WARN_INVALID_PROPERTY_ID (project, property_id, pspec);
 302   }
 303 }
 304
 305 static void
 306 ges_project_class_init (GESProjectClass * klass)
 307 {
 308   GObjectClass *object_class = G_OBJECT_CLASS (klass);
 309
 310   g_type_class_add_private (klass, sizeof (GESProjectPrivate));
 311
 312   klass->asset_added = NULL;
 313   klass->missing_uri = NULL;
 314   klass->loading_error = NULL;
 315   klass->asset_removed = NULL;
 316   object_class->get_property = (GObjectGetPropertyFunc) _get_property;
 317   object_class->set_property = (GObjectSetPropertyFunc) _set_property;
 318
 319   /**
 320    * GESProject::uri:
 321    *
 322    * The location of the project to use.
 323    */
 324   _properties[PROP_URI] = g_param_spec_string ("uri", "URI",
 325       "uri of the project", NULL, G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY);
 326
 327   g_object_class_install_properties (object_class, PROP_LAST, _properties);
 328
 329   /**
 330    * GESProject::asset-added:
 331    * @formatter: the #GESProject
 332    * @asset: The #GESAsset that has been added to @project
 333    */
 334   _signals[ASSET_ADDED_SIGNAL] =
 335       g_signal_new ("asset-added", G_TYPE_FROM_CLASS (klass),
 336       G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (GESProjectClass, asset_added),
 337       NULL, NULL, g_cclosure_marshal_generic, G_TYPE_NONE, 1, GES_TYPE_ASSET);
 338
 339   /**
 340    * GESProject::asset-removed:
 341    * @formatter: the #GESProject
 342    * @asset: The #GESAsset that has been removed from @project
 343    */
 344   _signals[ASSET_REMOVED_SIGNAL] =
 345       g_signal_new ("asset-removed", G_TYPE_FROM_CLASS (klass),
 346       G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (GESProjectClass, asset_removed),
 347       NULL, NULL, g_cclosure_marshal_generic, G_TYPE_NONE, 1, GES_TYPE_ASSET);
 348
 349   /**
 350    * GESProject::loaded:
 351    * @project: the #GESProject that is done loading a project.
 352    * @timeline: The #GESTimeline that complete loading
 353    */
 354   _signals[LOADED_SIGNAL] =
 355       g_signal_new ("loaded", G_TYPE_FROM_CLASS (klass),
 356       G_SIGNAL_RUN_FIRST, G_STRUCT_OFFSET (GESProjectClass, loaded),
 357       NULL, NULL, g_cclosure_marshal_generic, G_TYPE_NONE,
 358       1, GES_TYPE_TIMELINE);
 359
 360   /**
 361    * GESProject::missing-uri:
 362    * @project: the #GESProject reporting that a file has moved
 363    * @error: The error that happened
 364    * @wrong_asset: The asset with the wrong ID, you should us it and its content
 365    * only to find out what the new location is.
 366    *
 367    * |[
 368    * static gchar
 369    * source_moved_cb (GESProject *project, GError *error, const gchar *old_uri)
 370    * {
 371    *   return g_strdup ("file:///the/new/uri.ogg");
 372    * }
 373    *
 374    * static int
 375    * main (int argc, gchar ** argv)
 376    * {
 377    *   GESTimeline *timeline;
 378    *   GESProject *project = ges_project_new ("file:///some/uri.xges");
 379    *
 380    *   g_signal_connect (project, "missing-uri", source_moved_cb, NULL);
 381    *   timeline = ges_asset_extract (GES_ASSET (project));
 382    * }
 383    * ]|
 384    *
 385    * Returns: (transfer full) (allow-none): The new URI of @wrong_asset
 386    */
 387   _signals[MISSING_URI_SIGNAL] =
 388       g_signal_new ("missing-uri", G_TYPE_FROM_CLASS (klass),
 389       G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (GESProjectClass, missing_uri),
 390       _uri_missing_accumulator, NULL, g_cclosure_marshal_generic,
 391       G_TYPE_STRING, 2, G_TYPE_ERROR, GES_TYPE_ASSET);
 392
 393   /**
 394    * GESProject::error-loading-asset:
 395    * @project: the #GESProject on which a problem happend when creted a #GESAsset
 396    * @error: The #GError defining the error that accured, might be %NULL
 397    * @id: The @id of the asset that failed loading
 398    * @extractable_type: The @extractable_type of the asset that
 399    * failed loading
 400    *
 401    * Informs you that a #GESAsset could not be created. In case of
 402    * missing GStreamer plugins, the error will be set to #GST_CORE_ERROR
 403    * #GST_CORE_ERROR_MISSING_PLUGIN
 404    */
 405   _signals[ERROR_LOADING_ASSET] =
 406       g_signal_new ("error-loading-asset", G_TYPE_FROM_CLASS (klass),
 407       G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (GESProjectClass, loading_error),
 408       NULL, NULL, g_cclosure_marshal_generic,
 409       G_TYPE_NONE, 3, G_TYPE_ERROR, G_TYPE_STRING, G_TYPE_GTYPE);
 410
 411   object_class->dispose = _dispose;
 412   object_class->dispose = _finalize;
 413
 414   GES_ASSET_CLASS (klass)->extract = ges_project_extract;
 415 }
 416
 417 static void
 418 ges_project_init (GESProject * project)
 419 {
 420   GESProjectPrivate *priv = project->priv =
 421       G_TYPE_INSTANCE_GET_PRIVATE (project,
 422       GES_TYPE_PROJECT, GESProjectPrivate);
 423
 424   priv->uri = NULL;
 425   priv->formatters = NULL;
 426   priv->formatter_asset = NULL;
 427   priv->encoding_profiles = NULL;
 428   priv->assets = g_hash_table_new_full (g_str_hash, g_str_equal,
 429       g_free, gst_object_unref);
 430   priv->loading_assets = g_hash_table_new_full (g_str_hash, g_str_equal,
 431       g_free, gst_object_unref);
 432   priv->loaded_with_error = g_hash_table_new_full (g_str_hash, g_str_equal,
 433       g_free, NULL);
 434 }
 435
 436 gchar *
 437 ges_project_try_updating_id (GESProject * project, GESAsset * asset,
 438     GError * error)
 439 {
 440   gchar *new_id = NULL;
 441
 442   g_return_val_if_fail (GES_IS_PROJECT (project), NULL);
 443   g_return_val_if_fail (GES_IS_ASSET (asset), NULL);
 444   g_return_val_if_fail (error, NULL);
 445
 446   GST_DEBUG_OBJECT (project, "Try to proxy %s", ges_asset_get_id (asset));
 447   if (ges_asset_request_id_update (asset, &new_id, error) == FALSE) {
 448     GST_DEBUG_OBJECT (project, "Type: %s can not be proxied for id: %s",
 449         g_type_name (G_OBJECT_TYPE (asset)), ges_asset_get_id (asset));
 450
 451     return NULL;
 452   }
 453
 454   if (new_id == NULL)
 455     g_signal_emit (project, _signals[MISSING_URI_SIGNAL], 0, error, asset,
 456         &new_id);
 457
 458   if (new_id) {
 459     if (!ges_asset_set_proxy (asset, new_id)) {
 460       g_free (new_id);
 461       new_id = NULL;
 462     }
 463   }
 464
 465   g_hash_table_remove (project->priv->loading_assets, ges_asset_get_id (asset));
 466
 467   return new_id;
 468 }
 469
 470 static void
 471 new_asset_cb (GESAsset * source, GAsyncResult * res, GESProject * project)
 472 {
 473   GError *error = NULL;
 474   gchar *possible_id = NULL;
 475   const gchar *id = ges_asset_get_id (source);
 476   GESAsset *asset = ges_asset_request_finish (res, &error);
 477
 478   if (error) {
 479     possible_id = ges_project_try_updating_id (project, source, error);
 480     if (possible_id == NULL) {
 481       g_hash_table_remove (project->priv->loading_assets, id);
 482       g_hash_table_add (project->priv->loaded_with_error, g_strdup (id));
 483       g_signal_emit (project, _signals[ERROR_LOADING_ASSET], 0, error, id,
 484           ges_asset_get_extractable_type (source));
 485
 486       return;
 487     }
 488
 489     ges_project_create_asset (project, possible_id,
 490         ges_asset_get_extractable_type (source));
 491
 492     g_free (possible_id);
 493     g_error_free (error);
 494     return;
 495   }
 496
 497   ges_project_add_asset (project, asset);
 498   if (asset)
 499     gst_object_unref (asset);
 500 }
 501
 502 /**
 503  * ges_project_set_loaded:
 504  * @project: The #GESProject from which to emit the "project-loaded" signal
 505  *
 506  * Emits the "loaded" signal. This method should be called by sublasses when
 507  * the project is fully loaded.
 508  *
 509  * Returns: %TRUE if the signale could be emitted %FALSE otherwize
 510  */
 511 gboolean
 512 ges_project_set_loaded (GESProject * project, GESFormatter * formatter)
 513 {
 514   GST_INFO_OBJECT (project, "Emit project loaded");
 515   ges_timeline_commit (formatter->timeline);
 516   g_signal_emit (project, _signals[LOADED_SIGNAL], 0, formatter->timeline);
 517
 518   /* We are now done with that formatter */
 519   ges_project_remove_formatter (project, formatter);
 520   return TRUE;
 521 }
 522
 523 void
 524 ges_project_add_loading_asset (GESProject * project, GType extractable_type,
 525     const gchar * id)
 526 {
 527   GESAsset *asset;
 528
 529   if ((asset = ges_asset_cache_lookup (extractable_type, id)))
 530     g_hash_table_insert (project->priv->loading_assets, g_strdup (id),
 531         gst_object_ref (asset));
 532 }
 533
 534 /**************************************
 535  *                                    *
 536  *         API Implementation         *
 537  *                                    *
 538  **************************************/
 539
 540 /**
 541  * ges_project_create_asset:
 542  * @project: A #GESProject
 543  * @id: (allow-none): The id of the asset to create and add to @project
 544  * @extractable_type: The #GType of the asset to create
 545  *
 546  * Create and add a #GESAsset to @project. You should connect to the
 547  * "asset-added" signal to get the asset when it finally gets added to
 548  * @project
 549  *
 550  * Returns: %TRUE if the asset started to be added %FALSE it was already
 551  * in the project
 552  */
 553 gboolean
 554 ges_project_create_asset (GESProject * project, const gchar * id,
 555     GType extractable_type)
 556 {
 557   g_return_val_if_fail (GES_IS_PROJECT (project), FALSE);
 558   g_return_val_if_fail (g_type_is_a (extractable_type, GES_TYPE_EXTRACTABLE),
 559       FALSE);
 560
 561   if (id == NULL)
 562     id = g_type_name (extractable_type);
 563
 564   if (g_hash_table_lookup (project->priv->assets, id) ||
 565       g_hash_table_lookup (project->priv->loading_assets, id) ||
 566       g_hash_table_lookup (project->priv->loaded_with_error, id))
 567     return FALSE;
 568
 569   /* TODO Add a GCancellable somewhere in our API */
 570   ges_asset_request_async (extractable_type, id, NULL,
 571       (GAsyncReadyCallback) new_asset_cb, project);
 572   ges_project_add_loading_asset (project, extractable_type, id);
 573
 574   return TRUE;
 575 }
 576
 577 /**
 578  * ges_project_add_asset:
 579  * @project: A #GESProject
 580  * @asset: (transfer none): A #GESAsset to add to @project
 581  *
 582  * Adds a #Asset to @project, the project will keep a reference on
 583  * @asset.
 584  *
 585  * Returns: %TRUE if the asset could be added %FALSE it was already
 586  * in the project
 587  */
 588 gboolean
 589 ges_project_add_asset (GESProject * project, GESAsset * asset)
 590 {
 591   g_return_val_if_fail (GES_IS_PROJECT (project), FALSE);
 592
 593   if (g_hash_table_lookup (project->priv->assets, ges_asset_get_id (asset)))
 594     return FALSE;
 595
 596   g_hash_table_insert (project->priv->assets,
 597       g_strdup (ges_asset_get_id (asset)), gst_object_ref (asset));
 598
 599   g_hash_table_remove (project->priv->loading_assets, ges_asset_get_id (asset));
 600   GST_DEBUG_OBJECT (project, "Asset added: %s", ges_asset_get_id (asset));
 601   g_signal_emit (project, _signals[ASSET_ADDED_SIGNAL], 0, asset);
 602
 603   return TRUE;
 604 }
 605
 606 /**
 607  * ges_project_remove_asset:
 608  * @project: A #GESProject
 609  * @asset: (transfer none): A #GESAsset to remove from @project
 610  *
 611  * remove a @asset to from @project.
 612  *
 613  * Returns: %TRUE if the asset could be removed %FALSE otherwise
 614  */
 615 gboolean
 616 ges_project_remove_asset (GESProject * project, GESAsset * asset)
 617 {
 618   gboolean ret;
 619
 620   g_return_val_if_fail (GES_IS_PROJECT (project), FALSE);
 621
 622   ret = g_hash_table_remove (project->priv->assets, ges_asset_get_id (asset));
 623   g_signal_emit (project, _signals[ASSET_REMOVED_SIGNAL], 0, asset);
 624
 625   return ret;
 626 }
 627
 628 /**
 629  * ges_project_get_asset:
 630  * @project: A #GESProject
 631  * @id: The id of the asset to retrieve
 632  * @extractable_type: The extractable_type of the asset
 633  * to retrieve from @object
 634  *
 635  * Returns: (transfer full) (allow-none): The #GESAsset with
 636  * @id or %NULL if no asset with @id as an ID
 637  */
 638 GESAsset *
 639 ges_project_get_asset (GESProject * project, const gchar * id,
 640     GType extractable_type)
 641 {
 642   GESAsset *asset;
 643
 644   g_return_val_if_fail (GES_IS_PROJECT (project), NULL);
 645   g_return_val_if_fail (g_type_is_a (extractable_type, GES_TYPE_EXTRACTABLE),
 646       NULL);
 647
 648   asset = g_hash_table_lookup (project->priv->assets, id);
 649
 650   if (asset)
 651     return gst_object_ref (asset);
 652
 653   return NULL;
 654 }
 655
 656 /**
 657  * ges_project_list_assets:
 658  * @project: A #GESProject
 659  * @filter: Type of assets to list, #GES_TYPE_EXTRACTABLE will list
 660  * all assets
 661  *
 662  * List all @asset contained in @project filtering per extractable_type
 663  * as defined by @filter. It copies the asset and thus will not be updated
 664  * in time.
 665  *
 666  * Returns: (transfer full) (element-type GESAsset): The list of
 667  * #GESAsset the object contains
 668  */
 669 GList *
 670 ges_project_list_assets (GESProject * project, GType filter)
 671 {
 672   GList *ret = NULL;
 673   GHashTableIter iter;
 674   gpointer key, value;
 675
 676   g_return_val_if_fail (GES_IS_PROJECT (project), NULL);
 677
 678   g_hash_table_iter_init (&iter, project->priv->assets);
 679   while (g_hash_table_iter_next (&iter, &key, &value)) {
 680     if (g_type_is_a (ges_asset_get_extractable_type (GES_ASSET (value)),
 681             filter))
 682       ret = g_list_append (ret, gst_object_ref (value));
 683   }
 684
 685   return ret;
 686 }
 687
 688 /**
 689  * ges_project_save:
 690  * @project: A #GESProject to save
 691  * @timeline: The #GESTimeline to save, it must have been extracted from @project
 692  * @uri: The uri where to save @project and @timeline
 693  * @formatter_asset: (allow-none): The formatter asset to use or %NULL. If %NULL,
 694  * will try to save in the same format as the one from which the timeline as been loaded
 695  * or default to the formatter with highest rank
 696  * @overwrite: %TRUE to overwrite file if it exists
 697  * @error: (out) (allow-none): An error to be set in case something wrong happens or %NULL
 698  *
 699  * Save the timeline of @project to @uri. You should make sure that @timeline
 700  * is one of the timelines that have been extracted from @project
 701  * (using ges_asset_extract (@project);)
 702  *
 703  * Returns: %TRUE if the project could be save, %FALSE otherwize
 704  */
 705 gboolean
 706 ges_project_save (GESProject * project, GESTimeline * timeline,
 707     const gchar * uri, GESAsset * formatter_asset, gboolean overwrite,
 708     GError ** error)
 709 {
 710   GESAsset *tl_asset;
 711   gboolean ret = TRUE;
 712   GESFormatter *formatter = NULL;
 713
 714   g_return_val_if_fail (GES_IS_PROJECT (project), FALSE);
 715   g_return_val_if_fail (formatter_asset == NULL ||
 716       g_type_is_a (ges_asset_get_extractable_type (formatter_asset),
 717           GES_TYPE_FORMATTER), FALSE);
 718   g_return_val_if_fail ((error == NULL || *error == NULL), FALSE);
 719
 720   tl_asset = ges_extractable_get_asset (GES_EXTRACTABLE (timeline));
 721   if (tl_asset == NULL && project->priv->uri == NULL) {
 722     GESAsset *asset = ges_asset_cache_lookup (GES_TYPE_PROJECT, uri);
 723
 724     if (asset) {
 725       GST_WARNING_OBJECT (project, "Trying to save project to %s but we already"
 726           "have %" GST_PTR_FORMAT " for that uri, can not save", uri, asset);
 727       goto out;
 728     }
 729
 730     GST_DEBUG_OBJECT (project, "Timeline %" GST_PTR_FORMAT " has no asset"
 731         " we have no uri set, so setting ourself as asset", timeline);
 732
 733     ges_extractable_set_asset (GES_EXTRACTABLE (timeline), GES_ASSET (project));
 734   } else if (tl_asset != GES_ASSET (project)) {
 735     GST_WARNING_OBJECT (project, "Timeline %" GST_PTR_FORMAT
 736         " not created by this project can not save", timeline);
 737
 738     ret = FALSE;
 739     goto out;
 740   }
 741
 742   if (formatter_asset == NULL)
 743     formatter_asset = gst_object_ref (ges_formatter_get_default ());
 744
 745   formatter = GES_FORMATTER (ges_asset_extract (formatter_asset, error));
 746   if (formatter == NULL) {
 747     GST_WARNING_OBJECT (project, "Could not create the formatter %p %s: %s",
 748         formatter_asset, ges_asset_get_id (formatter_asset),
 749         (error && *error) ? (*error)->message : "Unknown Error");
 750
 751     ret = FALSE;
 752     goto out;
 753   }
 754
 755   ges_project_add_formatter (project, formatter);
 756   ret = ges_formatter_save_to_uri (formatter, timeline, uri, overwrite, error);
 757   if (ret && project->priv->uri == NULL)
 758     ges_project_set_uri (project, uri);
 759
 760 out:
 761   if (formatter_asset)
 762     gst_object_unref (formatter_asset);
 763   ges_project_remove_formatter (project, formatter);
 764
 765   return ret;
 766 }
 767
 768 /**
 769  * ges_project_new:
 770  * @uri: (allow-none): The uri to be set after creating the project.
 771  *
 772  * Creates a new #GESProject and sets its uri to @uri if provided. Note that
 773  * if @uri is not valid or %NULL, the uri of the project will then be set
 774  * the first time you save the project. If you then save the project to
 775  * other locations, it will never be updated again and the first valid URI is
 776  * the URI it will keep refering to.
 777  *
 778  * Returns: A newly created #GESProject
 779  */
 780 GESProject *
 781 ges_project_new (const gchar * uri)
 782 {
 783   gchar *id = (gchar *) uri;
 784   GESProject *project;
 785
 786   if (uri == NULL)
 787     id = g_strdup_printf ("project-%i", nb_projects++);
 788
 789   project = GES_PROJECT (ges_asset_request (GES_TYPE_TIMELINE, id, NULL));
 790
 791   if (project && uri)
 792     ges_project_set_uri (project, uri);
 793
 794   return project;
 795 }
 796
 797 /**
 798  * ges_project_load:
 799  * @project: A #GESProject that has an @uri set already
 800  * @timeline: A blank timeline to load @project into
 801  * @error: (out) (allow-none): An error to be set in case something wrong happens or %NULL
 802  *
 803  * Loads @project into @timeline
 804  *
 805  * Returns: %TRUE if the project could be loaded %FALSE otherwize.
 806  */
 807 gboolean
 808 ges_project_load (GESProject * project, GESTimeline * timeline, GError ** error)
 809 {
 810   g_return_val_if_fail (GES_IS_TIMELINE (timeline), FALSE);
 811   g_return_val_if_fail (GES_IS_PROJECT (project), FALSE);
 812   g_return_val_if_fail (ges_project_get_uri (project), FALSE);
 813   g_return_val_if_fail (
 814       (ges_extractable_get_asset (GES_EXTRACTABLE (timeline)) == NULL), FALSE);
 815
 816   if (!_load_project (project, timeline, error))
 817     return FALSE;
 818
 819   ges_extractable_set_asset (GES_EXTRACTABLE (timeline), GES_ASSET (project));
 820
 821   return TRUE;
 822 }
 823
 824 /**
 825  * ges_project_get_uri:
 826  * @project: A #GESProject
 827  *
 828  * Retrieve the uri that is currently set on @project
 829  *
 830  * Returns: The uri that is set on @project
 831  */
 832 gchar *
 833 ges_project_get_uri (GESProject * project)
 834 {
 835   GESProjectPrivate *priv;
 836
 837   g_return_val_if_fail (GES_IS_PROJECT (project), FALSE);
 838
 839   priv = project->priv;
 840   if (priv->uri)
 841     return g_strdup (priv->uri);
 842   return NULL;
 843 }
 844
 845 /**
 846  * ges_project_add_encoding_profile:
 847  * @project: A #GESProject
 848  * @profile: A #GstEncodingProfile to add to the project. If a profile with
 849  * the same name already exists, it will be replaced
 850  *
 851  * Adds @profile to the project. It lets you save in what format
 852  * the project has been renders and keep a reference to those formats.
 853  * Also, those formats will be saves to the project file when possible.
 854  *
 855  * Returns: %TRUE if @profile could be added, %FALSE otherwize
 856  */
 857 gboolean
 858 ges_project_add_encoding_profile (GESProject * project,
 859     GstEncodingProfile * profile)
 860 {
 861   GList *tmp;
 862   GESProjectPrivate *priv;
 863
 864   g_return_val_if_fail (GES_IS_PROJECT (project), FALSE);
 865   g_return_val_if_fail (GST_IS_ENCODING_PROFILE (profile), FALSE);
 866
 867   priv = project->priv;
 868   for (tmp = priv->encoding_profiles; tmp; tmp = tmp->next) {
 869     GstEncodingProfile *tmpprofile = GST_ENCODING_PROFILE (tmp->data);
 870
 871     if (g_strcmp0 (gst_encoding_profile_get_name (tmpprofile),
 872             gst_encoding_profile_get_name (profile)) == 0) {
 873       GST_INFO_OBJECT (project, "Already have profile: %s, replacing it",
 874           gst_encoding_profile_get_name (profile));
 875
 876       gst_object_unref (tmp->data);
 877       tmp->data = gst_object_ref (profile);
 878       return TRUE;
 879     }
 880   }
 881
 882   priv->encoding_profiles = g_list_prepend (priv->encoding_profiles,
 883       gst_object_ref (profile));
 884
 885   return TRUE;
 886 }
 887
 888 /**
 889  * ges_project_list_encoding_profiles:
 890  * @project: A #GESProject
 891  *
 892  * Lists the encoding profile that have been set to @project. The first one
 893  * is the latest added.
 894  *
 895  * Returns: (transfer none) (element-type GstPbutils.EncodingProfile) (allow-none): The
 896  * list of #GstEncodingProfile used in @project
 897  */
 898 const GList *
 899 ges_project_list_encoding_profiles (GESProject * project)
 900 {
 901   g_return_val_if_fail (GES_IS_PROJECT (project), FALSE);
 902
 903   return project->priv->encoding_profiles;
 904 }
 905
 906 /**
 907  * ges_project_get_loading_assets:
 908  * @project: A #GESProject
 909  *
 910  * Get the assets that are being loaded
 911  *
 912  * Returns: (transfer full) (element-type GES.Asset): A set of loading asset
 913  * that will be added to @project. Note that those Asset are *not* loaded yet,
 914  * and thus can not be used
 915  */
 916 GList *
 917 ges_project_get_loading_assets (GESProject * project)
 918 {
 919   GHashTableIter iter;
 920   gpointer key, value;
 921
 922   GList *ret = NULL;
 923
 924   g_return_val_if_fail (GES_IS_PROJECT (project), NULL);
 925
 926   g_hash_table_iter_init (&iter, project->priv->loading_assets);
 927   while (g_hash_table_iter_next (&iter, &key, &value))
 928     ret = g_list_prepend (ret, gst_object_ref (value));
 929
 930   return ret;
 931 }