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