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