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