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