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