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