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: gesproject
  22  * @title: GESProject
  23  * @short_description: A GESAsset that is used to manage projects
  24  *
  25  * The #GESProject is used to control a set of #GESAsset and is a
  26  * #GESAsset with #GES_TYPE_TIMELINE as @extractable_type itself. That
  27  * means that you can extract #GESTimeline from a project as followed:
  28  *
  29  * |[
  30  *  GESProject *project;
  31  *  GESTimeline *timeline;
  32  *
  33  *  project = ges_project_new ("file:///path/to/a/valid/project/uri");
  34  *
  35  *  // Here you can connect to the various signal to get more infos about
  36  *  // what is happening and recover from errors if possible
  37  *  ...
  38  *
  39  *  timeline = ges_asset_extract (GES_ASSET (project));
  40  * ]|
  41  *
  42  * The #GESProject class offers a higher level API to handle #GESAsset-s.
  43  * It lets you request new asset, and it informs you about new assets through
  44  * a set of signals. Also it handles problem such as missing files/missing
  45  * #GstElement and lets you try to recover from those.
  46  */
  47 #include "ges.h"
  48 #include "ges-internal.h"
  49
  50 static GPtrArray *new_paths = NULL;
  51 static GHashTable *tried_uris = NULL;
  52
  53 /* TODO We should rely on both extractable_type and @id to identify
  54  * a Asset, not only @id
  55  */
  56 G_DEFINE_TYPE (GESProject, ges_project, GES_TYPE_ASSET);
  57
  58 struct _GESProjectPrivate
  59 {
  60   GHashTable *assets;
  61   /* Set of asset ID being loaded */
  62   GHashTable *loading_assets;
  63   GHashTable *loaded_with_error;
  64   GESAsset *formatter_asset;
  65
  66   GList *formatters;
  67
  68   gchar *uri;
  69
  70   GList *encoding_profiles;
  71 };
  72
  73 typedef struct EmitLoadedInIdle
  74 {
  75   GESProject *project;
  76   GESTimeline *timeline;
  77 } EmitLoadedInIdle;
  78
  79 enum
  80 {
  81   LOADED_SIGNAL,
  82   ERROR_LOADING_ASSET,
  83   ASSET_ADDED_SIGNAL,
  84   ASSET_REMOVED_SIGNAL,
  85   MISSING_URI_SIGNAL,
  86   ASSET_LOADING_SIGNAL,
  87   LAST_SIGNAL
  88 };
  89
  90 static guint _signals[LAST_SIGNAL] = { 0 };
  91
  92 static guint nb_projects = 0;
  93
  94 enum
  95 {
  96   PROP_0,
  97   PROP_URI,
  98   PROP_LAST,
  99 };
 100
 101 static GParamSpec *_properties[LAST_SIGNAL] = { 0 };
 102
 103 static gboolean
 104 _emit_loaded_in_idle (EmitLoadedInIdle * data)
 105 {
 106   g_signal_emit (data->project, _signals[LOADED_SIGNAL], 0, data->timeline);
 107
 108   gst_object_unref (data->project);
 109   gst_object_unref (data->timeline);
 110   g_slice_free (EmitLoadedInIdle, data);
 111
 112   return FALSE;
 113 }
 114
 115 static void
 116 ges_project_add_formatter (GESProject * project, GESFormatter * formatter)
 117 {
 118   GESProjectPrivate *priv = GES_PROJECT (project)->priv;
 119
 120   ges_formatter_set_project (formatter, project);
 121   priv->formatters = g_list_append (priv->formatters, formatter);
 122
 123   gst_object_ref_sink (formatter);
 124 }
 125
 126 static void
 127 ges_project_remove_formatter (GESProject * project, GESFormatter * formatter)
 128 {
 129   GList *tmp;
 130   GESProjectPrivate *priv = GES_PROJECT (project)->priv;
 131
 132   for (tmp = priv->formatters; tmp; tmp = tmp->next) {
 133     if (tmp->data == formatter) {
 134       gst_object_unref (formatter);
 135       priv->formatters = g_list_delete_link (priv->formatters, tmp);
 136
 137       return;
 138     }
 139   }
 140 }
 141
 142 static void
 143 ges_project_set_uri (GESProject * project, const gchar * uri)
 144 {
 145   GESProjectPrivate *priv;
 146
 147   g_return_if_fail (GES_IS_PROJECT (project));
 148
 149   priv = project->priv;
 150   if (priv->uri) {
 151     GST_WARNING_OBJECT (project, "Trying to rest URI, this is prohibited");
 152
 153     return;
 154   }
 155
 156   if (uri == NULL) {
 157     GST_LOG_OBJECT (project, "Uri should not be NULL");
 158     return;
 159   }
 160
 161   priv->uri = g_strdup (uri);
 162
 163   /* We use that URI as ID */
 164   ges_asset_set_id (GES_ASSET (project), uri);
 165
 166   return;
 167 }
 168
 169 static gboolean
 170 _load_project (GESProject * project, GESTimeline * timeline, GError ** error)
 171 {
 172   GError *lerr = NULL;
 173   GESProjectPrivate *priv;
 174   GESFormatter *formatter;
 175
 176   priv = GES_PROJECT (project)->priv;
 177
 178   if (priv->uri == NULL) {
 179     EmitLoadedInIdle *data = g_slice_new (EmitLoadedInIdle);
 180
 181     GST_LOG_OBJECT (project, "%s, Loading an empty timeline %s"
 182         " as no URI set yet", GST_OBJECT_NAME (timeline),
 183         ges_asset_get_id (GES_ASSET (project)));
 184
 185     data->timeline = gst_object_ref (timeline);
 186     data->project = gst_object_ref (project);
 187
 188     /* Make sure the signal is emitted after the functions ends */
 189     g_idle_add ((GSourceFunc) _emit_loaded_in_idle, data);
 190     return TRUE;
 191   }
 192
 193   if (priv->formatter_asset == NULL)
 194     priv->formatter_asset = _find_formatter_asset_for_id (priv->uri);
 195
 196   if (priv->formatter_asset == NULL) {
 197     lerr = g_error_new (GES_ERROR, 0, "Could not find a suitable formatter");
 198     goto failed;
 199   }
 200
 201   formatter = GES_FORMATTER (ges_asset_extract (priv->formatter_asset, &lerr));
 202   if (lerr) {
 203     GST_WARNING_OBJECT (project, "Could not create the formatter: %s",
 204         lerr->message);
 205
 206     goto failed;
 207   }
 208
 209   ges_project_add_formatter (GES_PROJECT (project), formatter);
 210   ges_formatter_load_from_uri (formatter, timeline, priv->uri, &lerr);
 211   if (lerr) {
 212     GST_WARNING_OBJECT (project, "Could not load the timeline,"
 213         " returning: %s", lerr->message);
 214     goto failed;
 215   }
 216
 217   return TRUE;
 218
 219 failed:
 220   if (lerr)
 221     g_propagate_error (error, lerr);
 222   return FALSE;
 223 }
 224
 225 static gboolean
 226 _uri_missing_accumulator (GSignalInvocationHint * ihint, GValue * return_accu,
 227     const GValue * handler_return, gpointer data)
 228 {
 229   const gchar *ret = g_value_get_string (handler_return);
 230
 231   if (ret) {
 232     if (!gst_uri_is_valid (ret)) {
 233       GST_INFO ("The uri %s was not valid, can not work with it!", ret);
 234       return TRUE;
 235     }
 236
 237     g_value_set_string (return_accu, ret);
 238     return FALSE;
 239   }
 240
 241   return TRUE;
 242 }
 243
 244 /* GESAsset vmethod implementation */
 245 static GESExtractable *
 246 ges_project_extract (GESAsset * project, GError ** error)
 247 {
 248   GESTimeline *timeline = g_object_new (GES_TYPE_TIMELINE, NULL);
 249
 250   ges_extractable_set_asset (GES_EXTRACTABLE (timeline), GES_ASSET (project));
 251   if (_load_project (GES_PROJECT (project), timeline, error))
 252     return GES_EXTRACTABLE (timeline);
 253
 254   gst_object_unref (timeline);
 255   return NULL;
 256 }
 257
 258 static void
 259 _add_media_new_paths_recursing (const gchar * value)
 260 {
 261   GFileInfo *info;
 262   GFileEnumerator *fenum;
 263   GFile *file = g_file_new_for_uri (value);
 264
 265   if (!(fenum = g_file_enumerate_children (file,
 266               "standard::*", G_FILE_QUERY_INFO_NONE, NULL, NULL))) {
 267     GST_INFO ("%s is not a folder", value);
 268
 269     goto done;
 270   }
 271
 272   GST_INFO ("Adding folder: %s", value);
 273   g_ptr_array_add (new_paths, g_strdup (value));
 274   info = g_file_enumerator_next_file (fenum, NULL, NULL);
 275   while (info != NULL) {
 276     if (g_file_info_get_file_type (info) == G_FILE_TYPE_DIRECTORY) {
 277       GFile *f = g_file_enumerator_get_child (fenum, info);
 278       gchar *uri = g_file_get_uri (f);
 279
 280       _add_media_new_paths_recursing (uri);
 281       gst_object_unref (f);
 282       g_free (uri);
 283     }
 284     g_object_unref (info);
 285     info = g_file_enumerator_next_file (fenum, NULL, NULL);
 286   }
 287
 288 done:
 289   gst_object_unref (file);
 290   if (fenum)
 291     gst_object_unref (fenum);
 292 }
 293
 294 gboolean
 295 ges_add_missing_uri_relocation_uri (const gchar * uri, gboolean recurse)
 296 {
 297   g_return_val_if_fail (gst_uri_is_valid (uri), FALSE);
 298
 299   if (new_paths == NULL)
 300     new_paths = g_ptr_array_new_with_free_func (g_free);
 301
 302   if (recurse)
 303     _add_media_new_paths_recursing (uri);
 304   else
 305     g_ptr_array_add (new_paths, g_strdup (uri));
 306
 307   return TRUE;
 308 }
 309
 310 static gchar *
 311 ges_missing_uri_default (GESProject * self, GError * error,
 312     GESAsset * wrong_asset)
 313 {
 314   guint i;
 315   const gchar *old_uri = ges_asset_get_id (wrong_asset);
 316
 317   if (new_paths == NULL)
 318     return NULL;
 319
 320   if (tried_uris == NULL)
 321     tried_uris = g_hash_table_new_full (g_str_hash, g_str_equal, g_free, NULL);
 322
 323   for (i = 0; i < new_paths->len; i++) {
 324     gchar *basename, *res;
 325
 326     basename = g_path_get_basename (old_uri);
 327     res = g_build_filename (new_paths->pdata[i], basename, NULL);
 328     g_free (basename);
 329
 330     if (g_strcmp0 (old_uri, res) == 0) {
 331       g_hash_table_add (tried_uris, res);
 332     } else if (g_hash_table_lookup (tried_uris, res)) {
 333       GST_DEBUG_OBJECT (self, "File already tried: %s", res);
 334       g_free (res);
 335     } else {
 336       g_hash_table_add (tried_uris, g_strdup (res));
 337       GST_DEBUG_OBJECT (self, "Trying: %s\n", res);
 338       return res;
 339     }
 340   }
 341
 342   return NULL;
 343 }
 344
 345 static void
 346 ges_uri_assets_validate_uri (const gchar * nid)
 347 {
 348   if (tried_uris)
 349     g_hash_table_remove (tried_uris, nid);
 350 }
 351
 352 /* GObject vmethod implementation */
 353 static void
 354 _dispose (GObject * object)
 355 {
 356   GList *tmp;
 357   GESProjectPrivate *priv = GES_PROJECT (object)->priv;
 358
 359   if (priv->assets)
 360     g_hash_table_unref (priv->assets);
 361   if (priv->loading_assets)
 362     g_hash_table_unref (priv->loading_assets);
 363   if (priv->loaded_with_error)
 364     g_hash_table_unref (priv->loaded_with_error);
 365   if (priv->formatter_asset)
 366     gst_object_unref (priv->formatter_asset);
 367
 368   for (tmp = priv->formatters; tmp; tmp = tmp->next)
 369     ges_project_remove_formatter (GES_PROJECT (object), tmp->data);;
 370
 371   G_OBJECT_CLASS (ges_project_parent_class)->dispose (object);
 372 }
 373
 374 static void
 375 _finalize (GObject * object)
 376 {
 377   GESProjectPrivate *priv = GES_PROJECT (object)->priv;
 378
 379   if (priv->uri)
 380     g_free (priv->uri);
 381
 382   G_OBJECT_CLASS (ges_project_parent_class)->finalize (object);
 383 }
 384
 385 static void
 386 _get_property (GESProject * project, guint property_id,
 387     GValue * value, GParamSpec * pspec)
 388 {
 389   GESProjectPrivate *priv = project->priv;
 390
 391   switch (property_id) {
 392     case PROP_URI:
 393       g_value_set_string (value, priv->uri);
 394       break;
 395     default:
 396       G_OBJECT_WARN_INVALID_PROPERTY_ID (project, property_id, pspec);
 397   }
 398 }
 399
 400 static void
 401 _set_property (GESProject * project, guint property_id,
 402     const GValue * value, GParamSpec * pspec)
 403 {
 404   switch (property_id) {
 405     case PROP_URI:
 406       project->priv->uri = g_value_dup_string (value);
 407       break;
 408     default:
 409       G_OBJECT_WARN_INVALID_PROPERTY_ID (project, property_id, pspec);
 410   }
 411 }
 412
 413 static void
 414 ges_project_class_init (GESProjectClass * klass)
 415 {
 416   GObjectClass *object_class = G_OBJECT_CLASS (klass);
 417
 418   g_type_class_add_private (klass, sizeof (GESProjectPrivate));
 419
 420   klass->asset_added = NULL;
 421   klass->missing_uri = ges_missing_uri_default;
 422   klass->loading_error = NULL;
 423   klass->asset_removed = NULL;
 424   object_class->get_property = (GObjectGetPropertyFunc) _get_property;
 425   object_class->set_property = (GObjectSetPropertyFunc) _set_property;
 426
 427   /**
 428    * GESProject::uri:
 429    *
 430    * The location of the project to use.
 431    */
 432   _properties[PROP_URI] = g_param_spec_string ("uri", "URI",
 433       "uri of the project", NULL, G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY);
 434
 435   g_object_class_install_properties (object_class, PROP_LAST, _properties);
 436
 437   /**
 438    * GESProject::asset-added:
 439    * @project: the #GESProject
 440    * @asset: The #GESAsset that has been added to @project
 441    */
 442   _signals[ASSET_ADDED_SIGNAL] =
 443       g_signal_new ("asset-added", G_TYPE_FROM_CLASS (klass),
 444       G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (GESProjectClass, asset_added),
 445       NULL, NULL, g_cclosure_marshal_generic, G_TYPE_NONE, 1, GES_TYPE_ASSET);
 446
 447   /**
 448    * GESProject::asset-loading:
 449    * @project: the #GESProject
 450    * @asset: The #GESAsset that started loading
 451    *
 452    * Since: 1.8
 453    */
 454   _signals[ASSET_LOADING_SIGNAL] =
 455       g_signal_new ("asset-loading", G_TYPE_FROM_CLASS (klass),
 456       G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (GESProjectClass, asset_loading),
 457       NULL, NULL, g_cclosure_marshal_generic, G_TYPE_NONE, 1, GES_TYPE_ASSET);
 458
 459   /**
 460    * GESProject::asset-removed:
 461    * @project: the #GESProject
 462    * @asset: The #GESAsset that has been removed from @project
 463    */
 464   _signals[ASSET_REMOVED_SIGNAL] =
 465       g_signal_new ("asset-removed", G_TYPE_FROM_CLASS (klass),
 466       G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (GESProjectClass, asset_removed),
 467       NULL, NULL, g_cclosure_marshal_generic, G_TYPE_NONE, 1, GES_TYPE_ASSET);
 468
 469   /**
 470    * GESProject::loaded:
 471    * @project: the #GESProject that is done loading a project.
 472    * @timeline: The #GESTimeline that complete loading
 473    */
 474   _signals[LOADED_SIGNAL] =
 475       g_signal_new ("loaded", G_TYPE_FROM_CLASS (klass),
 476       G_SIGNAL_RUN_FIRST, G_STRUCT_OFFSET (GESProjectClass, loaded),
 477       NULL, NULL, g_cclosure_marshal_generic, G_TYPE_NONE,
 478       1, GES_TYPE_TIMELINE);
 479
 480   /**
 481    * GESProject::missing-uri:
 482    * @project: the #GESProject reporting that a file has moved
 483    * @error: The error that happened
 484    * @wrong_asset: The asset with the wrong ID, you should us it and its content
 485    * only to find out what the new location is.
 486    *
 487    * |[
 488    * static gchar
 489    * source_moved_cb (GESProject *project, GError *error, GESAsset *asset_with_error)
 490    * {
 491    *   return g_strdup ("file:///the/new/uri.ogg");
 492    * }
 493    *
 494    * static int
 495    * main (int argc, gchar ** argv)
 496    * {
 497    *   GESTimeline *timeline;
 498    *   GESProject *project = ges_project_new ("file:///some/uri.xges");
 499    *
 500    *   g_signal_connect (project, "missing-uri", source_moved_cb, NULL);
 501    *   timeline = ges_asset_extract (GES_ASSET (project));
 502    * }
 503    * ]|
 504    *
 505    * Returns: (transfer full) (allow-none): The new URI of @wrong_asset
 506    */
 507   _signals[MISSING_URI_SIGNAL] =
 508       g_signal_new ("missing-uri", G_TYPE_FROM_CLASS (klass),
 509       G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (GESProjectClass, missing_uri),
 510       _uri_missing_accumulator, NULL, g_cclosure_marshal_generic,
 511       G_TYPE_STRING, 2, G_TYPE_ERROR, GES_TYPE_ASSET);
 512
 513   /**
 514    * GESProject::error-loading-asset:
 515    * @project: the #GESProject on which a problem happend when creted a #GESAsset
 516    * @error: The #GError defining the error that accured, might be %NULL
 517    * @id: The @id of the asset that failed loading
 518    * @extractable_type: The @extractable_type of the asset that
 519    * failed loading
 520    *
 521    * Informs you that a #GESAsset could not be created. In case of
 522    * missing GStreamer plugins, the error will be set to #GST_CORE_ERROR
 523    * #GST_CORE_ERROR_MISSING_PLUGIN
 524    */
 525   _signals[ERROR_LOADING_ASSET] =
 526       g_signal_new ("error-loading-asset", G_TYPE_FROM_CLASS (klass),
 527       G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (GESProjectClass, loading_error),
 528       NULL, NULL, g_cclosure_marshal_generic,
 529       G_TYPE_NONE, 3, G_TYPE_ERROR, G_TYPE_STRING, G_TYPE_GTYPE);
 530
 531   object_class->dispose = _dispose;
 532   object_class->finalize = _finalize;
 533
 534   GES_ASSET_CLASS (klass)->extract = ges_project_extract;
 535 }
 536
 537 static void
 538 ges_project_init (GESProject * project)
 539 {
 540   GESProjectPrivate *priv = project->priv =
 541       G_TYPE_INSTANCE_GET_PRIVATE (project,
 542       GES_TYPE_PROJECT, GESProjectPrivate);
 543
 544   priv->uri = NULL;
 545   priv->formatters = NULL;
 546   priv->formatter_asset = NULL;
 547   priv->encoding_profiles = NULL;
 548   priv->assets = g_hash_table_new_full (g_str_hash, g_str_equal,
 549       g_free, gst_object_unref);
 550   priv->loading_assets = g_hash_table_new_full (g_str_hash, g_str_equal,
 551       g_free, gst_object_unref);
 552   priv->loaded_with_error = g_hash_table_new_full (g_str_hash, g_str_equal,
 553       g_free, NULL);
 554 }
 555
 556 static void
 557 _send_error_loading_asset (GESProject * project, GESAsset * asset,
 558     GError * error)
 559 {
 560   const gchar *id = ges_asset_get_id (asset);
 561
 562   GST_DEBUG_OBJECT (project, "Sending error loading asset for %s", id);
 563   g_hash_table_remove (project->priv->loading_assets, id);
 564   g_hash_table_add (project->priv->loaded_with_error, g_strdup (id));
 565   g_signal_emit (project, _signals[ERROR_LOADING_ASSET], 0, error, id,
 566       ges_asset_get_extractable_type (asset));
 567 }
 568
 569 gchar *
 570 ges_project_try_updating_id (GESProject * project, GESAsset * asset,
 571     GError * error)
 572 {
 573   gchar *new_id = NULL;
 574   const gchar *id;
 575
 576   g_return_val_if_fail (GES_IS_PROJECT (project), NULL);
 577   g_return_val_if_fail (GES_IS_ASSET (asset), NULL);
 578   g_return_val_if_fail (error, NULL);
 579
 580   id = ges_asset_get_id (asset);
 581   GST_DEBUG_OBJECT (project, "Try to proxy %s", id);
 582   if (ges_asset_request_id_update (asset, &new_id, error) == FALSE) {
 583     GST_DEBUG_OBJECT (project, "Type: %s can not be proxied for id: %s "
 584         "and error: %s", g_type_name (G_OBJECT_TYPE (asset)), id,
 585         error->message);
 586     _send_error_loading_asset (project, asset, error);
 587
 588     return NULL;
 589   }
 590
 591   if (new_id == NULL) {
 592     GST_DEBUG_OBJECT (project, "Sending 'missing-uri' signal for %s", id);
 593     g_signal_emit (project, _signals[MISSING_URI_SIGNAL], 0, error, asset,
 594         &new_id);
 595   }
 596
 597   if (new_id) {
 598     GST_DEBUG_OBJECT (project, "new id found: %s", new_id);
 599     if (!ges_asset_try_proxy (asset, new_id)) {
 600       g_free (new_id);
 601       new_id = NULL;
 602     }
 603   } else {
 604     GST_DEBUG_OBJECT (project, "No new id found for %s", id);
 605   }
 606
 607   g_hash_table_remove (project->priv->loading_assets, id);
 608
 609   if (new_id == NULL)
 610     _send_error_loading_asset (project, asset, error);
 611
 612
 613   return new_id;
 614 }
 615
 616 static void
 617 new_asset_cb (GESAsset * source, GAsyncResult * res, GESProject * project)
 618 {
 619   GError *error = NULL;
 620   gchar *possible_id = NULL;
 621   GESAsset *asset = ges_asset_request_finish (res, &error);
 622
 623   if (error) {
 624     possible_id = ges_project_try_updating_id (project, source, error);
 625
 626     if (possible_id == NULL)
 627       return;
 628
 629     ges_project_create_asset (project, possible_id,
 630         ges_asset_get_extractable_type (source));
 631
 632     g_free (possible_id);
 633     g_error_free (error);
 634     return;
 635   }
 636
 637   ges_asset_set_proxy (NULL, asset);
 638   ges_project_add_asset (project, asset);
 639   if (asset)
 640     gst_object_unref (asset);
 641 }
 642
 643 /**
 644  * ges_project_set_loaded:
 645  * @project: The #GESProject from which to emit the "project-loaded" signal
 646  *
 647  * Emits the "loaded" signal. This method should be called by sublasses when
 648  * the project is fully loaded.
 649  *
 650  * Returns: %TRUE if the signale could be emitted %FALSE otherwize
 651  */
 652 gboolean
 653 ges_project_set_loaded (GESProject * project, GESFormatter * formatter)
 654 {
 655   GST_INFO_OBJECT (project, "Emit project loaded");
 656   if (GST_STATE (formatter->timeline) < GST_STATE_PAUSED) {
 657     timeline_fill_gaps (formatter->timeline);
 658   } else {
 659     ges_timeline_commit (formatter->timeline);
 660   }
 661
 662   g_signal_emit (project, _signals[LOADED_SIGNAL], 0, formatter->timeline);
 663
 664   /* We are now done with that formatter */
 665   ges_project_remove_formatter (project, formatter);
 666   return TRUE;
 667 }
 668
 669 void
 670 ges_project_add_loading_asset (GESProject * project, GType extractable_type,
 671     const gchar * id)
 672 {
 673   GESAsset *asset;
 674
 675   if ((asset = ges_asset_cache_lookup (extractable_type, id))) {
 676     if (g_hash_table_insert (project->priv->loading_assets, g_strdup (id),
 677             gst_object_ref (asset)))
 678       g_signal_emit (project, _signals[ASSET_LOADING_SIGNAL], 0, asset);
 679   }
 680 }
 681
 682 /**************************************
 683  *                                    *
 684  *         API Implementation         *
 685  *                                    *
 686  **************************************/
 687
 688 /**
 689  * ges_project_create_asset:
 690  * @project: A #GESProject
 691  * @id: (allow-none): The id of the asset to create and add to @project
 692  * @extractable_type: The #GType of the asset to create
 693  *
 694  * Create and add a #GESAsset to @project. You should connect to the
 695  * "asset-added" signal to get the asset when it finally gets added to
 696  * @project
 697  *
 698  * Returns: %TRUE if the asset started to be added %FALSE it was already
 699  * in the project
 700  */
 701 gboolean
 702 ges_project_create_asset (GESProject * project, const gchar * id,
 703     GType extractable_type)
 704 {
 705   g_return_val_if_fail (GES_IS_PROJECT (project), FALSE);
 706   g_return_val_if_fail (g_type_is_a (extractable_type, GES_TYPE_EXTRACTABLE),
 707       FALSE);
 708
 709   if (id == NULL)
 710     id = g_type_name (extractable_type);
 711
 712   if (g_hash_table_lookup (project->priv->assets, id) ||
 713       g_hash_table_lookup (project->priv->loading_assets, id) ||
 714       g_hash_table_lookup (project->priv->loaded_with_error, id))
 715     return FALSE;
 716
 717   /* TODO Add a GCancellable somewhere in our API */
 718   ges_asset_request_async (extractable_type, id, NULL,
 719       (GAsyncReadyCallback) new_asset_cb, project);
 720   ges_project_add_loading_asset (project, extractable_type, id);
 721
 722   return TRUE;
 723 }
 724
 725 /**
 726  * ges_project_create_asset_sync:
 727  * @project: A #GESProject
 728  * @id: (allow-none): The id of the asset to create and add to @project
 729  * @extractable_type: The #GType of the asset to create
 730  * @error: A #GError to be set in case of error
 731  *
 732  * Create and add a #GESAsset to @project. You should connect to the
 733  * "asset-added" signal to get the asset when it finally gets added to
 734  * @project
 735  *
 736  * Returns: (transfer full) (nullable): The newly created #GESAsset or %NULL.
 737  */
 738 GESAsset *
 739 ges_project_create_asset_sync (GESProject * project, const gchar * id,
 740     GType extractable_type, GError ** error)
 741 {
 742   GESAsset *asset;
 743   gchar *possible_id = NULL;
 744   gboolean retry = TRUE;
 745
 746   g_return_val_if_fail (GES_IS_PROJECT (project), FALSE);
 747   g_return_val_if_fail (g_type_is_a (extractable_type, GES_TYPE_EXTRACTABLE),
 748       FALSE);
 749
 750   if (id == NULL)
 751     id = g_type_name (extractable_type);
 752
 753   if ((asset = g_hash_table_lookup (project->priv->assets, id)))
 754     return asset;
 755   else if (g_hash_table_lookup (project->priv->loading_assets, id) ||
 756       g_hash_table_lookup (project->priv->loaded_with_error, id))
 757     return NULL;
 758
 759   /* TODO Add a GCancellable somewhere in our API */
 760   while (retry) {
 761
 762     if (g_type_is_a (extractable_type, GES_TYPE_URI_CLIP)) {
 763       asset = GES_ASSET (ges_uri_clip_asset_request_sync (id, error));
 764     } else {
 765       asset = ges_asset_request (extractable_type, id, error);
 766     }
 767
 768     if (asset) {
 769       retry = FALSE;
 770
 771       if ((!g_hash_table_lookup (project->priv->assets,
 772                   ges_asset_get_id (asset))))
 773         g_signal_emit (project, _signals[ASSET_LOADING_SIGNAL], 0, asset);
 774
 775       if (possible_id) {
 776         g_free (possible_id);
 777         ges_uri_assets_validate_uri (id);
 778       }
 779
 780       break;
 781     } else {
 782       GESAsset *tmpasset;
 783
 784       tmpasset = ges_asset_cache_lookup (extractable_type, id);
 785       g_signal_emit (project, _signals[ASSET_LOADING_SIGNAL], 0, tmpasset);
 786       g_signal_emit (project, _signals[ERROR_LOADING_ASSET], 0, *error, id,
 787           extractable_type);
 788       possible_id = ges_project_try_updating_id (project, tmpasset, *error);
 789
 790       if (possible_id == NULL)
 791         return NULL;
 792
 793       g_clear_error (error);
 794
 795       id = possible_id;
 796     }
 797   }
 798
 799   if (!ges_asset_get_proxy_target (asset))
 800     ges_asset_set_proxy (NULL, asset);
 801
 802   ges_project_add_asset (project, asset);
 803
 804   return asset;
 805 }
 806
 807 /**
 808  * ges_project_add_asset:
 809  * @project: A #GESProject
 810  * @asset: (transfer none): A #GESAsset to add to @project
 811  *
 812  * Adds a #Asset to @project, the project will keep a reference on
 813  * @asset.
 814  *
 815  * Returns: %TRUE if the asset could be added %FALSE it was already
 816  * in the project
 817  */
 818 gboolean
 819 ges_project_add_asset (GESProject * project, GESAsset * asset)
 820 {
 821   g_return_val_if_fail (GES_IS_PROJECT (project), FALSE);
 822
 823   if (g_hash_table_lookup (project->priv->assets, ges_asset_get_id (asset)))
 824     return TRUE;
 825
 826   g_hash_table_insert (project->priv->assets,
 827       g_strdup (ges_asset_get_id (asset)), gst_object_ref (asset));
 828
 829   g_hash_table_remove (project->priv->loading_assets, ges_asset_get_id (asset));
 830   GST_DEBUG_OBJECT (project, "Asset added: %s", ges_asset_get_id (asset));
 831   g_signal_emit (project, _signals[ASSET_ADDED_SIGNAL], 0, asset);
 832
 833   return TRUE;
 834 }
 835
 836 /**
 837  * ges_project_remove_asset:
 838  * @project: A #GESProject
 839  * @asset: (transfer none): A #GESAsset to remove from @project
 840  *
 841  * remove a @asset to from @project.
 842  *
 843  * Returns: %TRUE if the asset could be removed %FALSE otherwise
 844  */
 845 gboolean
 846 ges_project_remove_asset (GESProject * project, GESAsset * asset)
 847 {
 848   gboolean ret;
 849
 850   g_return_val_if_fail (GES_IS_PROJECT (project), FALSE);
 851
 852   ret = g_hash_table_remove (project->priv->assets, ges_asset_get_id (asset));
 853   g_signal_emit (project, _signals[ASSET_REMOVED_SIGNAL], 0, asset);
 854
 855   return ret;
 856 }
 857
 858 /**
 859  * ges_project_get_asset:
 860  * @project: A #GESProject
 861  * @id: The id of the asset to retrieve
 862  * @extractable_type: The extractable_type of the asset
 863  * to retrieve from @object
 864  *
 865  * Returns: (transfer full) (allow-none): The #GESAsset with
 866  * @id or %NULL if no asset with @id as an ID
 867  */
 868 GESAsset *
 869 ges_project_get_asset (GESProject * project, const gchar * id,
 870     GType extractable_type)
 871 {
 872   GESAsset *asset;
 873
 874   g_return_val_if_fail (GES_IS_PROJECT (project), NULL);
 875   g_return_val_if_fail (g_type_is_a (extractable_type, GES_TYPE_EXTRACTABLE),
 876       NULL);
 877
 878   asset = g_hash_table_lookup (project->priv->assets, id);
 879
 880   if (asset)
 881     return gst_object_ref (asset);
 882
 883   return NULL;
 884 }
 885
 886 /**
 887  * ges_project_list_assets:
 888  * @project: A #GESProject
 889  * @filter: Type of assets to list, #GES_TYPE_EXTRACTABLE will list
 890  * all assets
 891  *
 892  * List all @asset contained in @project filtering per extractable_type
 893  * as defined by @filter. It copies the asset and thus will not be updated
 894  * in time.
 895  *
 896  * Returns: (transfer full) (element-type GESAsset): The list of
 897  * #GESAsset the object contains
 898  */
 899 GList *
 900 ges_project_list_assets (GESProject * project, GType filter)
 901 {
 902   GList *ret = NULL;
 903   GHashTableIter iter;
 904   gpointer key, value;
 905
 906   g_return_val_if_fail (GES_IS_PROJECT (project), NULL);
 907
 908   g_hash_table_iter_init (&iter, project->priv->assets);
 909   while (g_hash_table_iter_next (&iter, &key, &value)) {
 910     if (g_type_is_a (ges_asset_get_extractable_type (GES_ASSET (value)),
 911             filter))
 912       ret = g_list_append (ret, gst_object_ref (value));
 913   }
 914
 915   return ret;
 916 }
 917
 918 /**
 919  * ges_project_save:
 920  * @project: A #GESProject to save
 921  * @timeline: The #GESTimeline to save, it must have been extracted from @project
 922  * @uri: The uri where to save @project and @timeline
 923  * @formatter_asset: (allow-none): The formatter asset to use or %NULL. If %NULL,
 924  * will try to save in the same format as the one from which the timeline as been loaded
 925  * or default to the formatter with highest rank
 926  * @overwrite: %TRUE to overwrite file if it exists
 927  * @error: (out) (allow-none): An error to be set in case something wrong happens or %NULL
 928  *
 929  * Save the timeline of @project to @uri. You should make sure that @timeline
 930  * is one of the timelines that have been extracted from @project
 931  * (using ges_asset_extract (@project);)
 932  *
 933  * Returns: %TRUE if the project could be save, %FALSE otherwize
 934  */
 935 gboolean
 936 ges_project_save (GESProject * project, GESTimeline * timeline,
 937     const gchar * uri, GESAsset * formatter_asset, gboolean overwrite,
 938     GError ** error)
 939 {
 940   GESAsset *tl_asset;
 941   gboolean ret = TRUE;
 942   GESFormatter *formatter = NULL;
 943
 944   g_return_val_if_fail (GES_IS_PROJECT (project), FALSE);
 945   g_return_val_if_fail (formatter_asset == NULL ||
 946       g_type_is_a (ges_asset_get_extractable_type (formatter_asset),
 947           GES_TYPE_FORMATTER), FALSE);
 948   g_return_val_if_fail ((error == NULL || *error == NULL), FALSE);
 949
 950   tl_asset = ges_extractable_get_asset (GES_EXTRACTABLE (timeline));
 951   if (tl_asset == NULL && project->priv->uri == NULL) {
 952     GESAsset *asset = ges_asset_cache_lookup (GES_TYPE_PROJECT, uri);
 953
 954     if (asset) {
 955       GST_WARNING_OBJECT (project, "Trying to save project to %s but we already"
 956           "have %" GST_PTR_FORMAT " for that uri, can not save", uri, asset);
 957       goto out;
 958     }
 959
 960     GST_DEBUG_OBJECT (project, "Timeline %" GST_PTR_FORMAT " has no asset"
 961         " we have no uri set, so setting ourself as asset", timeline);
 962
 963     ges_extractable_set_asset (GES_EXTRACTABLE (timeline), GES_ASSET (project));
 964   } else if (tl_asset != GES_ASSET (project)) {
 965     GST_WARNING_OBJECT (project, "Timeline %" GST_PTR_FORMAT
 966         " not created by this project can not save", timeline);
 967
 968     ret = FALSE;
 969     goto out;
 970   }
 971
 972   if (formatter_asset == NULL)
 973     formatter_asset = gst_object_ref (ges_formatter_get_default ());
 974
 975   formatter = GES_FORMATTER (ges_asset_extract (formatter_asset, error));
 976   if (formatter == NULL) {
 977     GST_WARNING_OBJECT (project, "Could not create the formatter %p %s: %s",
 978         formatter_asset, ges_asset_get_id (formatter_asset),
 979         (error && *error) ? (*error)->message : "Unknown Error");
 980
 981     ret = FALSE;
 982     goto out;
 983   }
 984
 985   ges_project_add_formatter (project, formatter);
 986   ret = ges_formatter_save_to_uri (formatter, timeline, uri, overwrite, error);
 987   if (ret && project->priv->uri == NULL)
 988     ges_project_set_uri (project, uri);
 989
 990 out:
 991   if (formatter_asset)
 992     gst_object_unref (formatter_asset);
 993   ges_project_remove_formatter (project, formatter);
 994
 995   return ret;
 996 }
 997
 998 /**
 999  * ges_project_new:
1000  * @uri: (allow-none): The uri to be set after creating the project.
1001  *
1002  * Creates a new #GESProject and sets its uri to @uri if provided. Note that
1003  * if @uri is not valid or %NULL, the uri of the project will then be set
1004  * the first time you save the project. If you then save the project to
1005  * other locations, it will never be updated again and the first valid URI is
1006  * the URI it will keep refering to.
1007  *
1008  * Returns: A newly created #GESProject
1009  */
1010 GESProject *
1011 ges_project_new (const gchar * uri)
1012 {
1013   gchar *id = (gchar *) uri;
1014   GESProject *project;
1015
1016   if (uri == NULL)
1017     id = g_strdup_printf ("project-%i", nb_projects++);
1018
1019   project = GES_PROJECT (ges_asset_request (GES_TYPE_TIMELINE, id, NULL));
1020
1021   if (project && uri)
1022     ges_project_set_uri (project, uri);
1023
1024   if (uri == NULL)
1025     g_free (id);
1026
1027   return project;
1028 }
1029
1030 /**
1031  * ges_project_load:
1032  * @project: A #GESProject that has an @uri set already
1033  * @timeline: A blank timeline to load @project into
1034  * @error: (out) (allow-none): An error to be set in case something wrong happens or %NULL
1035  *
1036  * Loads @project into @timeline
1037  *
1038  * Returns: %TRUE if the project could be loaded %FALSE otherwize.
1039  */
1040 gboolean
1041 ges_project_load (GESProject * project, GESTimeline * timeline, GError ** error)
1042 {
1043   g_return_val_if_fail (GES_IS_TIMELINE (timeline), FALSE);
1044   g_return_val_if_fail (GES_IS_PROJECT (project), FALSE);
1045   g_return_val_if_fail (ges_project_get_uri (project), FALSE);
1046   g_return_val_if_fail (timeline->tracks == NULL, FALSE);
1047
1048   if (!_load_project (project, timeline, error))
1049     return FALSE;
1050
1051   ges_extractable_set_asset (GES_EXTRACTABLE (timeline), GES_ASSET (project));
1052
1053   return TRUE;
1054 }
1055
1056 /**
1057  * ges_project_get_uri:
1058  * @project: A #GESProject
1059  *
1060  * Retrieve the uri that is currently set on @project
1061  *
1062  * Returns: (transfer full) (nullable): a newly allocated string representing uri.
1063  */
1064 gchar *
1065 ges_project_get_uri (GESProject * project)
1066 {
1067   GESProjectPrivate *priv;
1068
1069   g_return_val_if_fail (GES_IS_PROJECT (project), FALSE);
1070
1071   priv = project->priv;
1072   if (priv->uri)
1073     return g_strdup (priv->uri);
1074   return NULL;
1075 }
1076
1077 /**
1078  * ges_project_add_encoding_profile:
1079  * @project: A #GESProject
1080  * @profile: A #GstEncodingProfile to add to the project. If a profile with
1081  * the same name already exists, it will be replaced
1082  *
1083  * Adds @profile to the project. It lets you save in what format
1084  * the project has been renders and keep a reference to those formats.
1085  * Also, those formats will be saves to the project file when possible.
1086  *
1087  * Returns: %TRUE if @profile could be added, %FALSE otherwize
1088  */
1089 gboolean
1090 ges_project_add_encoding_profile (GESProject * project,
1091     GstEncodingProfile * profile)
1092 {
1093   GList *tmp;
1094   GESProjectPrivate *priv;
1095
1096   g_return_val_if_fail (GES_IS_PROJECT (project), FALSE);
1097   g_return_val_if_fail (GST_IS_ENCODING_PROFILE (profile), FALSE);
1098
1099   priv = project->priv;
1100   for (tmp = priv->encoding_profiles; tmp; tmp = tmp->next) {
1101     GstEncodingProfile *tmpprofile = GST_ENCODING_PROFILE (tmp->data);
1102
1103     if (g_strcmp0 (gst_encoding_profile_get_name (tmpprofile),
1104             gst_encoding_profile_get_name (profile)) == 0) {
1105       GST_INFO_OBJECT (project, "Already have profile: %s, replacing it",
1106           gst_encoding_profile_get_name (profile));
1107
1108       gst_object_unref (tmp->data);
1109       tmp->data = gst_object_ref (profile);
1110       return TRUE;
1111     }
1112   }
1113
1114   priv->encoding_profiles = g_list_prepend (priv->encoding_profiles,
1115       gst_object_ref (profile));
1116
1117   return TRUE;
1118 }
1119
1120 /**
1121  * ges_project_list_encoding_profiles:
1122  * @project: A #GESProject
1123  *
1124  * Lists the encoding profile that have been set to @project. The first one
1125  * is the latest added.
1126  *
1127  * Returns: (transfer none) (element-type GstPbutils.EncodingProfile) (allow-none): The
1128  * list of #GstEncodingProfile used in @project
1129  */
1130 const GList *
1131 ges_project_list_encoding_profiles (GESProject * project)
1132 {
1133   g_return_val_if_fail (GES_IS_PROJECT (project), FALSE);
1134
1135   return project->priv->encoding_profiles;
1136 }
1137
1138 /**
1139  * ges_project_get_loading_assets:
1140  * @project: A #GESProject
1141  *
1142  * Get the assets that are being loaded
1143  *
1144  * Returns: (transfer full) (element-type GES.Asset): A set of loading asset
1145  * that will be added to @project. Note that those Asset are *not* loaded yet,
1146  * and thus can not be used
1147  */
1148 GList *
1149 ges_project_get_loading_assets (GESProject * project)
1150 {
1151   GHashTableIter iter;
1152   gpointer key, value;
1153
1154   GList *ret = NULL;
1155
1156   g_return_val_if_fail (GES_IS_PROJECT (project), NULL);
1157
1158   g_hash_table_iter_init (&iter, project->priv->loading_assets);
1159   while (g_hash_table_iter_next (&iter, &key, &value))
1160     ret = g_list_prepend (ret, gst_object_ref (value));
1161
1162   return ret;
1163 }