preset: Do not save deprecated properties
[platform/upstream/gstreamer.git] / gst / gstpreset.c
1 /* GStreamer
2  * Copyright (C) 2006 Stefan Kost <ensonic@users.sf.net>
3  *
4  * gstpreset.c: helper interface for element presets
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Library General Public
8  * License as published by the Free Software Foundation; either
9  * version 2 of the License, or (at your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Library General Public License for more details.
15  *
16  * You should have received a copy of the GNU Library General Public
17  * License along with this library; if not, write to the
18  * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
19  * Boston, MA 02110-1301, USA.
20  */
21 /**
22  * SECTION:gstpreset
23  * @title: GstPreset
24  * @short_description: helper interface for element presets
25  *
26  * This interface offers methods to query and manipulate parameter preset sets.
27  * A preset is a bunch of property settings, together with meta data and a name.
28  * The name of a preset serves as key for subsequent method calls to manipulate
29  * single presets.
30  * All instances of one type will share the list of presets. The list is created
31  * on demand, if presets are not used, the list is not created.
32  *
33  * The interface comes with a default implementation that serves most plugins.
34  * Wrapper plugins will override most methods to implement support for the
35  * native preset format of those wrapped plugins.
36  * One method that is useful to be overridden is gst_preset_get_property_names().
37  * With that one can control which properties are saved and in which order.
38  * When implementing support for read-only presets, one should set the vmethods
39  * for gst_preset_save_preset() and gst_preset_delete_preset() to %NULL.
40  * Applications can use gst_preset_is_editable() to check for that.
41  *
42  * The default implementation supports presets located in a system directory,
43  * application specific directory and in the users home directory. When getting
44  * a list of presets individual presets are read and overlaid in 1) system,
45  * 2) application and 3) user order. Whenever an earlier entry is newer, the
46  * later entries will be updated. Since 1.8 you can also provide extra paths
47  * where to find presets through the GST_PRESET_PATH environment variable.
48  * Presets found in those paths will be concidered as "app presets".
49  */
50 /* FIXME:
51  * - non racyness
52  *   - we need to avoid two instances writing the preset file
53  *     -> flock(fileno()), http://www.ecst.csuchico.edu/~beej/guide/ipc/flock.html
54  *     -> open exclusive
55  *     -> better save the new file to a tempfile and then rename?
56  *   - we like to know when any other instance makes changes to the keyfile
57  *     - then ui can be updated
58  *     - and we make sure that we don't lose edits
59  *   -> its the same problem actually, once for inside a process, once system-
60  *      wide
61  *     - can we use a lock inside a names shared memory segment?
62  *
63  * - should there be a 'preset-list' property to get the preset list
64  *   (and to connect a notify:: to to listen for changes)
65  *   we could use gnome_vfs_monitor_add() to monitor the user preset_file.
66  *
67  * - should there be a 'preset-name' property so that we can set a preset via
68  *   gst-launch, or should we handle this with special syntax in gst-launch:
69  *   gst-launch element preset:<preset-name> property=value ...
70  *   - this would allow to have preset-bundles too (a preset on bins that
71  *     specifies presets for children
72  */
73
74 #include "gst_private.h"
75
76 #include "gstpreset.h"
77 #include "gstchildproxy.h"
78 #include "gstinfo.h"
79 #include "gstvalue.h"
80
81 #ifdef HAVE_UNISTD_H
82 #include <unistd.h>
83 #endif
84 #include <glib/gstdio.h>
85
86 #ifdef G_OS_WIN32
87 #define WIN32_LEAN_AND_MEAN
88 #include <windows.h>
89
90 extern HMODULE _priv_gst_dll_handle;
91 #endif
92
93 #define GST_CAT_DEFAULT preset_debug
94 GST_DEBUG_CATEGORY_STATIC (GST_CAT_DEFAULT);
95
96 /* defines for keyfile usage, this group contains the element type name and
97  * version these presets belong to. */
98 #define PRESET_HEADER "_presets_"
99
100 /* keys of the preset header section */
101 #define PRESET_HEADER_ELEMENT_NAME "element-name"
102 #define PRESET_HEADER_VERSION "version"
103
104 static GQuark preset_user_path_quark = 0;
105 static GQuark preset_app_path_quark = 0;
106 static GQuark preset_system_path_quark = 0;
107 static GQuark preset_quark = 0;
108
109 /* the application can set a custom path that is checked in addition to standard
110  * system and user dirs. This helps to develop new presets first local to the
111  * application.
112  */
113 static gchar *preset_app_dir = NULL;
114
115 /* default iface implementation */
116
117 static gboolean gst_preset_default_save_presets_file (GstPreset * preset);
118
119 /*
120  * preset_get_paths:
121  * @preset: a #GObject that implements #GstPreset
122  * @preset_user_path: (out) (allow-none): location for path or %NULL
123  * @preset_app_path: (out) (allow-none): location for path or %NULL
124  * @preset_system_path: (out) (allow-none): location for path or %NULL
125  *
126  * Fetch the preset_path for user local, application specific and system wide
127  * settings. Don't free after use.
128  *
129  * Returns: %FALSE if no paths could be found.
130  */
131 static gboolean
132 preset_get_paths (GstPreset * preset, const gchar ** preset_user_path,
133     const gchar ** preset_app_path, const gchar ** preset_system_path)
134 {
135   GType type = G_TYPE_FROM_INSTANCE (preset);
136   gchar *preset_path;
137   const gchar *element_name;
138
139   /* we use the element name when we must construct the paths */
140   element_name = G_OBJECT_TYPE_NAME (preset);
141   GST_INFO_OBJECT (preset, "element_name: '%s'", element_name);
142
143   if (preset_user_path) {
144     /* preset user path requested, see if we have it cached in the qdata */
145     if (!(preset_path = g_type_get_qdata (type, preset_user_path_quark))) {
146       gchar *preset_dir;
147
148       /* user presets go in  user's XDG data directory. */
149       preset_dir = g_build_filename (g_get_user_data_dir (),
150           "gstreamer-" GST_API_VERSION, "presets", NULL);
151       GST_INFO_OBJECT (preset, "user_preset_dir: '%s'", preset_dir);
152       preset_path =
153           g_strdup_printf ("%s" G_DIR_SEPARATOR_S "%s.prs", preset_dir,
154           element_name);
155       GST_INFO_OBJECT (preset, "user_preset_path: '%s'", preset_path);
156       /* create dirs */
157       g_mkdir_with_parents (preset_dir, 0755);
158       g_free (preset_dir);
159
160       /* cache the preset path to the type */
161       g_type_set_qdata (type, preset_user_path_quark, preset_path);
162     }
163     *preset_user_path = preset_path;
164   }
165
166   if (preset_app_path) {
167     if (preset_app_dir) {
168       if (!(preset_path = g_type_get_qdata (type, preset_system_path_quark))) {
169         preset_path = g_strdup_printf ("%s" G_DIR_SEPARATOR_S "%s.prs",
170             preset_app_dir, element_name);
171         GST_INFO_OBJECT (preset, "application_preset_path: '%s'", preset_path);
172
173         /* cache the preset path to the type */
174         g_type_set_qdata (type, preset_app_path_quark, preset_path);
175       }
176       *preset_app_path = preset_path;
177     } else {
178       *preset_app_path = NULL;
179     }
180   }
181
182   if (preset_system_path) {
183     /* preset system path requested, see if we have it cached in the qdata */
184     if (!(preset_path = g_type_get_qdata (type, preset_system_path_quark))) {
185       gchar *preset_dir;
186
187       /* system presets in '$GST_DATADIR/gstreamer-1.0/presets/GstAudioPanorama.prs' */
188 #ifdef G_OS_WIN32
189       gchar *basedir =
190           g_win32_get_package_installation_directory_of_module
191           (_priv_gst_dll_handle);
192       preset_dir =
193           g_build_filename (basedir, "share", "gstreamer-" GST_API_VERSION,
194           "presets", NULL);
195       g_free (basedir);
196 #else
197       preset_dir = g_build_filename (GST_DATADIR, "gstreamer-" GST_API_VERSION,
198           "presets", NULL);
199 #endif
200       GST_INFO_OBJECT (preset, "system_preset_dir: '%s'", preset_dir);
201       preset_path = g_strdup_printf ("%s" G_DIR_SEPARATOR_S "%s.prs",
202           preset_dir, element_name);
203       GST_INFO_OBJECT (preset, "system_preset_path: '%s'", preset_path);
204       /* create dirs */
205       g_mkdir_with_parents (preset_dir, 0755);
206       g_free (preset_dir);
207
208       /* cache the preset path to the type */
209       g_type_set_qdata (type, preset_system_path_quark, preset_path);
210     }
211     *preset_system_path = preset_path;
212   }
213   return TRUE;
214 }
215
216 static gboolean
217 preset_skip_property (GParamSpec * property)
218 {
219   if (((property->flags & G_PARAM_READWRITE) != G_PARAM_READWRITE) ||
220       (property->flags & G_PARAM_CONSTRUCT_ONLY))
221     return TRUE;
222   /* FIXME: skip GST_PARAM_NOT_PRESETABLE, see #522205 */
223   return FALSE;
224 }
225
226 static guint64
227 preset_parse_version (const gchar * str_version)
228 {
229   guint major, minor, micro, nano;
230   gint num;
231
232   major = minor = micro = nano = 0;
233
234   /* parse version (e.g. 0.10.15.1) to guint64 */
235   num = sscanf (str_version, "%u.%u.%u.%u", &major, &minor, &micro, &nano);
236   /* make sure we have at least "major.minor" */
237   if (num > 1) {
238     guint64 version;
239
240     version = ((((major << 8 | minor) << 8) | micro) << 8) | nano;
241     GST_DEBUG ("version %s -> %" G_GUINT64_FORMAT, str_version, version);
242     return version;
243   }
244   return G_GUINT64_CONSTANT (0);
245 }
246
247 static GKeyFile *
248 preset_open_and_parse_header (GstPreset * preset, const gchar * preset_path,
249     guint64 * preset_version)
250 {
251   GKeyFile *in;
252   GError *error = NULL;
253   gboolean res;
254   const gchar *element_name;
255   gchar *name;
256
257   in = g_key_file_new ();
258
259   res = g_key_file_load_from_file (in, preset_path,
260       G_KEY_FILE_KEEP_COMMENTS | G_KEY_FILE_KEEP_TRANSLATIONS, &error);
261   if (!res || error != NULL)
262     goto load_error;
263
264   /* element type name and preset name must match or we are dealing with a wrong
265    * preset file */
266   element_name = G_OBJECT_TYPE_NAME (preset);
267   name =
268       g_key_file_get_value (in, PRESET_HEADER, PRESET_HEADER_ELEMENT_NAME,
269       NULL);
270
271   if (!name || strcmp (name, element_name))
272     goto wrong_name;
273
274   g_free (name);
275
276   /* get the version now so that the caller can check it */
277   if (preset_version) {
278     gchar *str =
279         g_key_file_get_value (in, PRESET_HEADER, PRESET_HEADER_VERSION, NULL);
280     *preset_version = preset_parse_version (str);
281     g_free (str);
282   }
283
284   return in;
285
286   /* ERRORS */
287 load_error:
288   {
289     GST_INFO_OBJECT (preset, "Unable to read preset file %s: %s",
290         preset_path, error->message);
291     g_error_free (error);
292     g_key_file_free (in);
293     return NULL;
294   }
295 wrong_name:
296   {
297     GST_WARNING_OBJECT (preset,
298         "Wrong element name in preset file %s. Expected %s, got %s",
299         preset_path, element_name, GST_STR_NULL (name));
300     g_free (name);
301     g_key_file_free (in);
302     return NULL;
303   }
304 }
305
306 static void
307 preset_merge (GKeyFile * system, GKeyFile * user)
308 {
309   gchar *str;
310   gchar **groups, **keys;
311   gsize i, j, num_groups, num_keys;
312
313   /* copy file comment if there is any */
314   if ((str = g_key_file_get_comment (user, NULL, NULL, NULL))) {
315     g_key_file_set_comment (system, NULL, NULL, str, NULL);
316     g_free (str);
317   }
318
319   /* get groups in user and copy into system */
320   groups = g_key_file_get_groups (user, &num_groups);
321   for (i = 0; i < num_groups; i++) {
322     /* copy group comment if there is any */
323     if ((str = g_key_file_get_comment (user, groups[i], NULL, NULL))) {
324       g_key_file_set_comment (system, groups[i], NULL, str, NULL);
325       g_free (str);
326     }
327
328     /* ignore private groups */
329     if (groups[i][0] == '_')
330       continue;
331
332     /* if group already exists in system, remove and re-add keys from user */
333     if (g_key_file_has_group (system, groups[i])) {
334       g_key_file_remove_group (system, groups[i], NULL);
335     }
336
337     keys = g_key_file_get_keys (user, groups[i], &num_keys, NULL);
338     for (j = 0; j < num_keys; j++) {
339       /* copy key comment if there is any */
340       if ((str = g_key_file_get_comment (user, groups[i], keys[j], NULL))) {
341         g_key_file_set_comment (system, groups[i], keys[j], str, NULL);
342         g_free (str);
343       }
344       str = g_key_file_get_value (user, groups[i], keys[j], NULL);
345       g_key_file_set_value (system, groups[i], keys[j], str);
346       g_free (str);
347     }
348     g_strfreev (keys);
349   }
350   g_strfreev (groups);
351 }
352
353 typedef struct
354 {
355   GKeyFile *preset;
356   guint64 version;
357 } PresetAndVersion;
358
359 static gint
360 compare_preset_and_version (gconstpointer a, gconstpointer b,
361     gpointer user_data)
362 {
363   const PresetAndVersion *pa = a, *pb = b;
364
365   if (pa->version > pb->version)
366     return -1;
367   if (pa->version < pb->version)
368     return 1;
369   else
370     return 0;
371 }
372
373 /* reads the user and system presets files and merges them together. This
374  * function caches the GKeyFile on the element type. If there is no existing
375  * preset file, a new in-memory GKeyFile will be created. */
376 static GKeyFile *
377 preset_get_keyfile (GstPreset * preset)
378 {
379   GKeyFile *presets;
380   GType type = G_TYPE_FROM_INSTANCE (preset);
381
382   /* first see if the have a cached version for the type */
383   if (!(presets = g_type_get_qdata (type, preset_quark))) {
384     const gchar *preset_user_path, *preset_app_path, *preset_system_path;
385     guint64 version_system = G_GUINT64_CONSTANT (0);
386     guint64 version_app = G_GUINT64_CONSTANT (0);
387     guint64 version_user = G_GUINT64_CONSTANT (0);
388     guint64 version = G_GUINT64_CONSTANT (0);
389     gboolean merged = FALSE;
390     GKeyFile *in_user, *in_app = NULL, *in_system;
391     GQueue in_env = G_QUEUE_INIT;
392     gboolean have_env = FALSE;
393     const gchar *envvar;
394
395     /* try to load the user, app and system presets, we do this to get the
396      * versions of all files. */
397     preset_get_paths (preset, &preset_user_path, &preset_app_path,
398         &preset_system_path);
399     in_user = preset_open_and_parse_header (preset, preset_user_path,
400         &version_user);
401
402     if (preset_app_path) {
403       in_app = preset_open_and_parse_header (preset, preset_app_path,
404           &version_app);
405     }
406
407     envvar = g_getenv ("GST_PRESET_PATH");
408     if (envvar) {
409       gint i;
410       gchar **preset_dirs = g_strsplit (envvar, G_SEARCHPATH_SEPARATOR_S, -1);
411
412       for (i = 0; preset_dirs[i]; i++) {
413         gchar *preset_path = g_strdup_printf ("%s" G_DIR_SEPARATOR_S "%s.prs",
414             preset_dirs[i], G_OBJECT_TYPE_NAME (preset));
415         GKeyFile *env_file;
416         guint64 env_version;
417
418         env_file = preset_open_and_parse_header (preset, preset_path,
419             &env_version);
420         g_free (preset_path);
421         if (env_file) {
422           PresetAndVersion *pv = g_new (PresetAndVersion, 1);
423           pv->preset = env_file;
424           pv->version = env_version;
425           g_queue_push_tail (&in_env, pv);
426           have_env = TRUE;
427         }
428       }
429       g_strfreev (preset_dirs);
430     }
431
432     in_system = preset_open_and_parse_header (preset, preset_system_path,
433         &version_system);
434
435     /* compare version to check for merge */
436     if (in_system) {
437       presets = in_system;
438       version = version_system;
439     }
440
441     if (have_env) {
442       GList *l;
443
444       /* merge the ones from the environment paths. If any of them has a
445        * higher version, take that as the "master" version. Lower versions are
446        * then just merged in. */
447       g_queue_sort (&in_env, compare_preset_and_version, NULL);
448       /* highest version to lowest */
449       for (l = in_env.head; l; l = l->next) {
450         PresetAndVersion *pv = l->data;
451
452         if (version > pv->version) {
453           preset_merge (presets, pv->preset);
454           g_key_file_free (pv->preset);
455         } else {
456           if (presets)
457             g_key_file_free (presets);
458           presets = pv->preset;
459           version = pv->version;
460         }
461         g_free (pv);
462       }
463       g_queue_clear (&in_env);
464     }
465
466     if (in_app) {
467       /* if system/env version is higher, merge */
468       if (version > version_app) {
469         preset_merge (presets, in_app);
470         g_key_file_free (in_app);
471       } else {
472         if (presets)
473           g_key_file_free (presets);
474         presets = in_app;
475         version = version_app;
476       }
477     }
478     if (in_user) {
479       /* if system/env or app version is higher, merge */
480       if (version > version_user) {
481         preset_merge (presets, in_user);
482         g_key_file_free (in_user);
483         merged = TRUE;
484       } else {
485         if (presets)
486           g_key_file_free (presets);
487         presets = in_user;
488       }
489     }
490
491     if (!presets) {
492       /* we did not load a user, app or system presets file, create a new one */
493       presets = g_key_file_new ();
494       g_key_file_set_string (presets, PRESET_HEADER, PRESET_HEADER_ELEMENT_NAME,
495           G_OBJECT_TYPE_NAME (preset));
496     }
497
498     /* attach the preset to the type */
499     g_type_set_qdata (type, preset_quark, (gpointer) presets);
500
501     if (merged) {
502       gst_preset_default_save_presets_file (preset);
503     }
504   }
505   return presets;
506 }
507
508 static gint
509 compare_strings (gchar ** a, gchar ** b, gpointer user_data)
510 {
511   return g_strcmp0 (*a, *b);
512 }
513
514 /* get a list of all supported preset names for an element */
515 static gchar **
516 gst_preset_default_get_preset_names (GstPreset * preset)
517 {
518   GKeyFile *presets;
519   gsize i, num_groups;
520   gchar **groups;
521
522   /* get the presets from the type */
523   if (!(presets = preset_get_keyfile (preset)))
524     goto no_presets;
525
526   /* get the groups, which are also the preset names */
527   if (!(groups = g_key_file_get_groups (presets, &num_groups)))
528     goto no_groups;
529
530   /* remove all private group names starting with '_' from the array */
531   for (i = 0; i < num_groups; i++) {
532     if (groups[i][0] == '_') {
533       /* free private group */
534       g_free (groups[i]);
535       /* move last element of list down */
536       num_groups--;
537       /* move last element into removed element */
538       groups[i] = groups[num_groups];
539       groups[num_groups] = NULL;
540     }
541   }
542   if (!num_groups) {
543     GST_INFO_OBJECT (preset, "Empty preset file");
544     g_strfreev (groups);
545     return NULL;
546   }
547
548   /* sort the array now */
549   g_qsort_with_data (groups, num_groups, sizeof (gchar *),
550       (GCompareDataFunc) compare_strings, NULL);
551
552   return groups;
553
554   /* ERRORS */
555 no_presets:
556   {
557     GST_WARNING_OBJECT (preset, "Could not load presets");
558     return NULL;
559   }
560 no_groups:
561   {
562     GST_WARNING_OBJECT (preset, "Could not find preset groups");
563     return NULL;
564   }
565 }
566
567 /* get a list of all property names that are used for presets */
568 static gchar **
569 gst_preset_default_get_property_names (GstPreset * preset)
570 {
571   GParamSpec **props;
572   guint i, j = 0, n_props;
573   GObjectClass *gclass;
574   gboolean is_child_proxy;
575   gchar **result = NULL;
576
577   gclass = G_OBJECT_CLASS (GST_ELEMENT_GET_CLASS (preset));
578   is_child_proxy = GST_IS_CHILD_PROXY (preset);
579
580   /* get a list of object properties */
581   props = g_object_class_list_properties (gclass, &n_props);
582   if (props) {
583     /* allocate array big enough to hold the worst case, including a terminating
584      * NULL pointer. */
585     result = g_new (gchar *, n_props + 1);
586
587     /* now filter out the properties that we can use for presets */
588     GST_DEBUG_OBJECT (preset, "  filtering properties: %u", n_props);
589     for (i = 0; i < n_props; i++) {
590       if (preset_skip_property (props[i]))
591         continue;
592       GST_DEBUG_OBJECT (preset, "    using: %s", props[i]->name);
593       result[j++] = g_strdup (props[i]->name);
594     }
595     g_free (props);
596   }
597
598   if (is_child_proxy) {
599     guint c, n_children;
600     GObject *child;
601
602     n_children = gst_child_proxy_get_children_count ((GstChildProxy *) preset);
603     for (c = 0; c < n_children; c++) {
604       child = gst_child_proxy_get_child_by_index ((GstChildProxy *) preset, c);
605       gclass = G_OBJECT_CLASS (GST_ELEMENT_GET_CLASS (child));
606
607       props = g_object_class_list_properties (gclass, &n_props);
608       if (props) {
609         /* resize property name array */
610         result = g_renew (gchar *, result, j + n_props + 1);
611
612         /* now filter out the properties that we can use for presets */
613         GST_DEBUG_OBJECT (preset, "  filtering properties: %u", n_props);
614         for (i = 0; i < n_props; i++) {
615           if (preset_skip_property (props[i]))
616             continue;
617           GST_DEBUG_OBJECT (preset, "    using: %s::%s",
618               GST_OBJECT_NAME (child), props[i]->name);
619           result[j++] = g_strdup_printf ("%s::%s", GST_OBJECT_NAME (child),
620               props[i]->name);
621         }
622         g_free (props);
623       }
624
625       g_object_unref (child);
626     }
627   }
628   if (!result) {
629     GST_INFO_OBJECT (preset, "object has no properties");
630   } else {
631     result[j] = NULL;
632   }
633   return result;
634 }
635
636 /* load the presets of @name for the instance @preset. Returns %FALSE if something
637  * failed. */
638 static gboolean
639 gst_preset_default_load_preset (GstPreset * preset, const gchar * name)
640 {
641   GKeyFile *presets;
642   gchar **props;
643   guint i;
644   GObjectClass *gclass;
645   gboolean is_child_proxy;
646
647   /* get the presets from the type */
648   if (!(presets = preset_get_keyfile (preset)))
649     goto no_presets;
650
651   /* get the preset name */
652   if (!g_key_file_has_group (presets, name))
653     goto no_group;
654
655   GST_DEBUG_OBJECT (preset, "loading preset : '%s'", name);
656
657   /* get the properties that we can configure in this element */
658   if (!(props = gst_preset_get_property_names (preset)))
659     goto no_properties;
660
661   gclass = G_OBJECT_CLASS (GST_ELEMENT_GET_CLASS (preset));
662   is_child_proxy = GST_IS_CHILD_PROXY (preset);
663
664   /* for each of the property names, find the preset parameter and try to
665    * configure the property with its value */
666   for (i = 0; props[i]; i++) {
667     gchar *str;
668     GValue gvalue = { 0, };
669     GParamSpec *property = NULL;
670
671     /* check if we have a settings for this element property */
672     if (!(str = g_key_file_get_value (presets, name, props[i], NULL))) {
673       /* the element has a property but the parameter is not in the keyfile */
674       GST_INFO_OBJECT (preset, "parameter '%s' not in preset", props[i]);
675       continue;
676     }
677
678     GST_DEBUG_OBJECT (preset, "setting value '%s' for property '%s'", str,
679         props[i]);
680
681     if (is_child_proxy) {
682       gst_child_proxy_lookup ((GstChildProxy *) preset, props[i], NULL,
683           &property);
684     } else {
685       property = g_object_class_find_property (gclass, props[i]);
686     }
687     if (!property) {
688       /* the parameter was in the keyfile, the element said it supported it but
689        * then the property was not found in the element. This should not happen. */
690       GST_WARNING_OBJECT (preset, "property '%s' not in object", props[i]);
691       g_free (str);
692       continue;
693     }
694
695     /* try to deserialize the property value from the keyfile and set it as
696      * the object property */
697     g_value_init (&gvalue, property->value_type);
698     if (gst_value_deserialize (&gvalue, str)) {
699       if (is_child_proxy) {
700         gst_child_proxy_set_property ((GstChildProxy *) preset, props[i],
701             &gvalue);
702       } else {
703         g_object_set_property ((GObject *) preset, props[i], &gvalue);
704       }
705     } else {
706       GST_WARNING_OBJECT (preset,
707           "deserialization of value '%s' for property '%s' failed", str,
708           props[i]);
709     }
710     g_value_unset (&gvalue);
711     g_free (str);
712   }
713   g_strfreev (props);
714
715   return TRUE;
716
717   /* ERRORS */
718 no_presets:
719   {
720     GST_WARNING_OBJECT (preset, "no presets");
721     return FALSE;
722   }
723 no_group:
724   {
725     GST_WARNING_OBJECT (preset, "no preset named '%s'", name);
726     return FALSE;
727   }
728 no_properties:
729   {
730     GST_INFO_OBJECT (preset, "no properties");
731     return FALSE;
732   }
733 }
734
735 /* save the presets file. A copy of the existing presets file is stored in a
736  * .bak file */
737 static gboolean
738 gst_preset_default_save_presets_file (GstPreset * preset)
739 {
740   GKeyFile *presets;
741   const gchar *preset_path;
742   GError *error = NULL;
743   gchar *bak_file_name;
744   gboolean backup = TRUE;
745   gchar *data;
746   gsize data_size;
747
748   preset_get_paths (preset, &preset_path, NULL, NULL);
749
750   /* get the presets from the type */
751   if (!(presets = preset_get_keyfile (preset)))
752     goto no_presets;
753
754   GST_DEBUG_OBJECT (preset, "saving preset file: '%s'", preset_path);
755
756   /* create backup if possible */
757   bak_file_name = g_strdup_printf ("%s.bak", preset_path);
758   if (g_file_test (bak_file_name, G_FILE_TEST_EXISTS)) {
759     if (g_unlink (bak_file_name)) {
760       backup = FALSE;
761       GST_INFO_OBJECT (preset, "cannot remove old backup file : %s",
762           bak_file_name);
763     }
764   }
765   if (backup) {
766     if (g_rename (preset_path, bak_file_name)) {
767       GST_INFO_OBJECT (preset, "cannot backup file : %s -> %s", preset_path,
768           bak_file_name);
769     }
770   }
771   g_free (bak_file_name);
772
773   /* update gstreamer version */
774   g_key_file_set_string (presets, PRESET_HEADER, PRESET_HEADER_VERSION,
775       PACKAGE_VERSION);
776
777   /* get new contents, wee need this to save it */
778   if (!(data = g_key_file_to_data (presets, &data_size, &error)))
779     goto convert_failed;
780
781   /* write presets */
782   if (!g_file_set_contents (preset_path, data, data_size, &error))
783     goto write_failed;
784
785   g_free (data);
786
787   return TRUE;
788
789   /* ERRORS */
790 no_presets:
791   {
792     GST_WARNING_OBJECT (preset,
793         "no presets, trying to unlink possibly existing preset file: '%s'",
794         preset_path);
795     g_unlink (preset_path);
796     return FALSE;
797   }
798 convert_failed:
799   {
800     GST_WARNING_OBJECT (preset, "can not get the keyfile contents: %s",
801         error->message);
802     g_error_free (error);
803     g_free (data);
804     return FALSE;
805   }
806 write_failed:
807   {
808     GST_WARNING_OBJECT (preset, "Unable to store preset file %s: %s",
809         preset_path, error->message);
810     g_error_free (error);
811     g_free (data);
812     return FALSE;
813   }
814 }
815
816 /* save the preset with the given name */
817 static gboolean
818 gst_preset_default_save_preset (GstPreset * preset, const gchar * name)
819 {
820   GKeyFile *presets;
821   gchar **props;
822   guint i;
823   GObjectClass *gclass;
824   gboolean is_child_proxy;
825
826   GST_INFO_OBJECT (preset, "saving new preset: %s", name);
827
828   /* get the presets from the type */
829   if (!(presets = preset_get_keyfile (preset)))
830     goto no_presets;
831
832   /* take copies of current gobject properties from preset */
833   if (!(props = gst_preset_get_property_names (preset)))
834     goto no_properties;
835
836   gclass = G_OBJECT_CLASS (GST_ELEMENT_GET_CLASS (preset));
837   is_child_proxy = GST_IS_CHILD_PROXY (preset);
838
839   /* loop over the object properties and store the property value in the
840    * keyfile */
841   for (i = 0; props[i]; i++) {
842     GValue gvalue = { 0, };
843     gchar *str;
844     GParamSpec *property = NULL;
845
846     if (is_child_proxy) {
847       gst_child_proxy_lookup ((GstChildProxy *) preset, props[i], NULL,
848           &property);
849     } else {
850       property = g_object_class_find_property (gclass, props[i]);
851     }
852     if (!property) {
853       /* the element said it supported the property but then it does not have
854        * that property. This should not happen. */
855       GST_WARNING_OBJECT (preset, "property '%s' not in object", props[i]);
856       continue;
857     }
858
859     if (property->flags & G_PARAM_DEPRECATED) {
860       GST_INFO_OBJECT (preset, "Not saving property %s as it is deprecated",
861           property->name);
862       continue;
863     }
864
865     if (property->flags & G_PARAM_DEPRECATED) {
866       GST_INFO_OBJECT (preset, "Not saving property %s as it is deprecated",
867           property->name);
868       continue;
869     }
870
871     g_value_init (&gvalue, property->value_type);
872     if (is_child_proxy) {
873       gst_child_proxy_get_property ((GstChildProxy *) preset, props[i],
874           &gvalue);
875     } else {
876       g_object_get_property ((GObject *) preset, props[i], &gvalue);
877     }
878
879     if ((str = gst_value_serialize (&gvalue))) {
880       g_key_file_set_string (presets, name, props[i], (gpointer) str);
881       g_free (str);
882     } else {
883       GST_WARNING_OBJECT (preset, "serialization for property '%s' failed",
884           props[i]);
885     }
886     g_value_unset (&gvalue);
887   }
888   GST_INFO_OBJECT (preset, "  saved");
889   g_strfreev (props);
890
891   /* save updated version */
892   return gst_preset_default_save_presets_file (preset);
893
894   /* ERRORS */
895 no_presets:
896   {
897     GST_WARNING_OBJECT (preset, "no presets");
898     return FALSE;
899   }
900 no_properties:
901   {
902     GST_INFO_OBJECT (preset, "no properties");
903     return FALSE;
904   }
905 }
906
907 /* copies all keys and comments from one group to another, deleting the old
908  * group. */
909 static gboolean
910 gst_preset_default_rename_preset (GstPreset * preset, const gchar * old_name,
911     const gchar * new_name)
912 {
913   GKeyFile *presets;
914   gchar *str;
915   gchar **keys;
916   gsize i, num_keys;
917
918   /* get the presets from the type */
919   if (!(presets = preset_get_keyfile (preset)))
920     goto no_presets;
921
922   if (!g_key_file_has_group (presets, old_name))
923     goto no_group;
924
925   /* copy group comment if there is any */
926   if ((str = g_key_file_get_comment (presets, old_name, NULL, NULL))) {
927     g_key_file_set_comment (presets, new_name, NULL, str, NULL);
928     g_free (str);
929   }
930
931   /* get all keys from the old group and copy them in the new group */
932   keys = g_key_file_get_keys (presets, old_name, &num_keys, NULL);
933   for (i = 0; i < num_keys; i++) {
934     /* copy key comment if there is any */
935     if ((str = g_key_file_get_comment (presets, old_name, keys[i], NULL))) {
936       g_key_file_set_comment (presets, new_name, keys[i], str, NULL);
937       g_free (str);
938     }
939     /* copy key value */
940     str = g_key_file_get_value (presets, old_name, keys[i], NULL);
941     g_key_file_set_value (presets, new_name, keys[i], str);
942     g_free (str);
943   }
944   g_strfreev (keys);
945
946   /* remove old group */
947   g_key_file_remove_group (presets, old_name, NULL);
948
949   /* save updated version */
950   return gst_preset_default_save_presets_file (preset);
951
952   /* ERRORS */
953 no_presets:
954   {
955     GST_WARNING_OBJECT (preset, "no presets");
956     return FALSE;
957   }
958 no_group:
959   {
960     GST_WARNING_OBJECT (preset, "no preset named %s", old_name);
961     return FALSE;
962   }
963 }
964
965 /* delete a group from the keyfile */
966 static gboolean
967 gst_preset_default_delete_preset (GstPreset * preset, const gchar * name)
968 {
969   GKeyFile *presets;
970
971   /* get the presets from the type */
972   if (!(presets = preset_get_keyfile (preset)))
973     goto no_presets;
974
975   /* get the group */
976   if (!g_key_file_has_group (presets, name))
977     goto no_group;
978
979   /* remove the group */
980   g_key_file_remove_group (presets, name, NULL);
981
982   /* save updated version */
983   return gst_preset_default_save_presets_file (preset);
984
985   /* ERRORS */
986 no_presets:
987   {
988     GST_WARNING_OBJECT (preset, "no presets");
989     return FALSE;
990   }
991 no_group:
992   {
993     GST_WARNING_OBJECT (preset, "no preset named %s", name);
994     return FALSE;
995   }
996 }
997
998 static gboolean
999 gst_preset_default_set_meta (GstPreset * preset, const gchar * name,
1000     const gchar * tag, const gchar * value)
1001 {
1002   GKeyFile *presets;
1003   gchar *key;
1004
1005   /* get the presets from the type */
1006   if (!(presets = preset_get_keyfile (preset)))
1007     goto no_presets;
1008
1009   key = g_strdup_printf ("_meta/%s", tag);
1010   if (value && *value) {
1011     g_key_file_set_value (presets, name, key, value);
1012   } else {
1013     g_key_file_remove_key (presets, name, key, NULL);
1014   }
1015   g_free (key);
1016
1017   /* save updated keyfile */
1018   return gst_preset_default_save_presets_file (preset);
1019
1020   /* ERRORS */
1021 no_presets:
1022   {
1023     GST_WARNING_OBJECT (preset, "no presets");
1024     return FALSE;
1025   }
1026 }
1027
1028 /* the caller must free @value after usage */
1029 static gboolean
1030 gst_preset_default_get_meta (GstPreset * preset, const gchar * name,
1031     const gchar * tag, gchar ** value)
1032 {
1033   GKeyFile *presets;
1034   gchar *key;
1035
1036   /* get the presets from the type */
1037   if (!(presets = preset_get_keyfile (preset)))
1038     goto no_presets;
1039
1040   key = g_strdup_printf ("_meta/%s", tag);
1041   *value = g_key_file_get_value (presets, name, key, NULL);
1042   g_free (key);
1043
1044   return TRUE;
1045
1046   /* ERRORS */
1047 no_presets:
1048   {
1049     GST_WARNING_OBJECT (preset, "no presets");
1050     *value = NULL;
1051     return FALSE;
1052   }
1053 }
1054
1055 /* wrapper */
1056
1057 /**
1058  * gst_preset_get_preset_names:
1059  * @preset: a #GObject that implements #GstPreset
1060  *
1061  * Get a copy of preset names as a %NULL terminated string array.
1062  *
1063  * Returns: (transfer full) (array zero-terminated=1) (element-type gchar*):
1064  *     list with names, use g_strfreev() after usage.
1065  */
1066 gchar **
1067 gst_preset_get_preset_names (GstPreset * preset)
1068 {
1069   g_return_val_if_fail (GST_IS_PRESET (preset), NULL);
1070
1071   return (GST_PRESET_GET_INTERFACE (preset)->get_preset_names (preset));
1072 }
1073
1074 /**
1075  * gst_preset_get_property_names:
1076  * @preset: a #GObject that implements #GstPreset
1077  *
1078  * Get a the names of the GObject properties that can be used for presets.
1079  *
1080  * Returns: (transfer full) (array zero-terminated=1) (element-type gchar*): an
1081  *   array of property names which should be freed with g_strfreev() after use.
1082  */
1083 gchar **
1084 gst_preset_get_property_names (GstPreset * preset)
1085 {
1086   g_return_val_if_fail (GST_IS_PRESET (preset), NULL);
1087
1088   return (GST_PRESET_GET_INTERFACE (preset)->get_property_names (preset));
1089 }
1090
1091 /**
1092  * gst_preset_load_preset:
1093  * @preset: a #GObject that implements #GstPreset
1094  * @name: preset name to load
1095  *
1096  * Load the given preset.
1097  *
1098  * Returns: %TRUE for success, %FALSE if e.g. there is no preset with that @name
1099  */
1100 gboolean
1101 gst_preset_load_preset (GstPreset * preset, const gchar * name)
1102 {
1103   g_return_val_if_fail (GST_IS_PRESET (preset), FALSE);
1104   g_return_val_if_fail (name, FALSE);
1105
1106   return (GST_PRESET_GET_INTERFACE (preset)->load_preset (preset, name));
1107 }
1108
1109 /**
1110  * gst_preset_save_preset:
1111  * @preset: a #GObject that implements #GstPreset
1112  * @name: preset name to save
1113  *
1114  * Save the current object settings as a preset under the given name. If there
1115  * is already a preset by this @name it will be overwritten.
1116  *
1117  * Returns: %TRUE for success, %FALSE
1118  */
1119 gboolean
1120 gst_preset_save_preset (GstPreset * preset, const gchar * name)
1121 {
1122   g_return_val_if_fail (GST_IS_PRESET (preset), FALSE);
1123   g_return_val_if_fail (name, FALSE);
1124
1125   return (GST_PRESET_GET_INTERFACE (preset)->save_preset (preset, name));
1126 }
1127
1128 /**
1129  * gst_preset_rename_preset:
1130  * @preset: a #GObject that implements #GstPreset
1131  * @old_name: current preset name
1132  * @new_name: new preset name
1133  *
1134  * Renames a preset. If there is already a preset by the @new_name it will be
1135  * overwritten.
1136  *
1137  * Returns: %TRUE for success, %FALSE if e.g. there is no preset with @old_name
1138  */
1139 gboolean
1140 gst_preset_rename_preset (GstPreset * preset, const gchar * old_name,
1141     const gchar * new_name)
1142 {
1143   g_return_val_if_fail (GST_IS_PRESET (preset), FALSE);
1144   g_return_val_if_fail (old_name, FALSE);
1145   g_return_val_if_fail (new_name, FALSE);
1146
1147   return (GST_PRESET_GET_INTERFACE (preset)->rename_preset (preset, old_name,
1148           new_name));
1149 }
1150
1151 /**
1152  * gst_preset_delete_preset:
1153  * @preset: a #GObject that implements #GstPreset
1154  * @name: preset name to remove
1155  *
1156  * Delete the given preset.
1157  *
1158  * Returns: %TRUE for success, %FALSE if e.g. there is no preset with that @name
1159  */
1160 gboolean
1161 gst_preset_delete_preset (GstPreset * preset, const gchar * name)
1162 {
1163   g_return_val_if_fail (GST_IS_PRESET (preset), FALSE);
1164   g_return_val_if_fail (name, FALSE);
1165
1166   return (GST_PRESET_GET_INTERFACE (preset)->delete_preset (preset, name));
1167 }
1168
1169 /**
1170  * gst_preset_set_meta:
1171  * @preset: a #GObject that implements #GstPreset
1172  * @name: preset name
1173  * @tag: meta data item name
1174  * @value: (allow-none): new value
1175  *
1176  * Sets a new @value for an existing meta data item or adds a new item. Meta
1177  * data @tag names can be something like e.g. "comment". Supplying %NULL for the
1178  * @value will unset an existing value.
1179  *
1180  * Returns: %TRUE for success, %FALSE if e.g. there is no preset with that @name
1181  */
1182 gboolean
1183 gst_preset_set_meta (GstPreset * preset, const gchar * name, const gchar * tag,
1184     const gchar * value)
1185 {
1186   g_return_val_if_fail (GST_IS_PRESET (preset), FALSE);
1187   g_return_val_if_fail (name, FALSE);
1188   g_return_val_if_fail (tag, FALSE);
1189
1190   return GST_PRESET_GET_INTERFACE (preset)->set_meta (preset, name, tag, value);
1191 }
1192
1193 /**
1194  * gst_preset_get_meta:
1195  * @preset: a #GObject that implements #GstPreset
1196  * @name: preset name
1197  * @tag: meta data item name
1198  * @value: (out callee-allocates): value
1199  *
1200  * Gets the @value for an existing meta data @tag. Meta data @tag names can be
1201  * something like e.g. "comment". Returned values need to be released when done.
1202  *
1203  * Returns: %TRUE for success, %FALSE if e.g. there is no preset with that @name
1204  * or no value for the given @tag
1205  */
1206 gboolean
1207 gst_preset_get_meta (GstPreset * preset, const gchar * name, const gchar * tag,
1208     gchar ** value)
1209 {
1210   g_return_val_if_fail (GST_IS_PRESET (preset), FALSE);
1211   g_return_val_if_fail (name, FALSE);
1212   g_return_val_if_fail (tag, FALSE);
1213   g_return_val_if_fail (value, FALSE);
1214
1215   return GST_PRESET_GET_INTERFACE (preset)->get_meta (preset, name, tag, value);
1216 }
1217
1218 /**
1219  * gst_preset_set_app_dir:
1220  * @app_dir: the application specific preset dir
1221  *
1222  * Sets an extra directory as an absolute path that should be considered when
1223  * looking for presets. Any presets in the application dir will shadow the
1224  * system presets.
1225  *
1226  * Returns: %TRUE for success, %FALSE if the dir already has been set
1227  */
1228 gboolean
1229 gst_preset_set_app_dir (const gchar * app_dir)
1230 {
1231   g_return_val_if_fail (app_dir, FALSE);
1232
1233   if (!preset_app_dir) {
1234     preset_app_dir = g_strdup (app_dir);
1235     return TRUE;
1236   }
1237   return FALSE;
1238 }
1239
1240 /**
1241  * gst_preset_get_app_dir:
1242  *
1243  * Gets the directory for application specific presets if set by the
1244  * application.
1245  *
1246  * Returns: (nullable): the directory or %NULL, don't free or modify
1247  * the string
1248  */
1249 const gchar *
1250 gst_preset_get_app_dir (void)
1251 {
1252   return preset_app_dir;
1253 }
1254
1255 /**
1256  * gst_preset_is_editable:
1257  * @preset: a #GObject that implements #GstPreset
1258  *
1259  * Check if one can add new presets, change existing ones and remove presets.
1260  *
1261  * Returns: %TRUE if presets are editable or %FALSE if they are static
1262  *
1263  * Since: 1.6
1264  */
1265 gboolean
1266 gst_preset_is_editable (GstPreset * preset)
1267 {
1268   GstPresetInterface *iface = GST_PRESET_GET_INTERFACE (preset);
1269
1270   return iface->save_preset && iface->delete_preset;
1271 }
1272
1273 /* class internals */
1274
1275 static void
1276 gst_preset_class_init (GstPresetInterface * iface)
1277 {
1278   iface->get_preset_names = gst_preset_default_get_preset_names;
1279   iface->get_property_names = gst_preset_default_get_property_names;
1280
1281   iface->load_preset = gst_preset_default_load_preset;
1282   iface->save_preset = gst_preset_default_save_preset;
1283   iface->rename_preset = gst_preset_default_rename_preset;
1284   iface->delete_preset = gst_preset_default_delete_preset;
1285
1286   iface->set_meta = gst_preset_default_set_meta;
1287   iface->get_meta = gst_preset_default_get_meta;
1288 }
1289
1290 static void
1291 gst_preset_base_init (gpointer g_class)
1292 {
1293   static gboolean initialized = FALSE;
1294
1295   if (!initialized) {
1296     /* init default implementation */
1297     GST_DEBUG_CATEGORY_INIT (GST_CAT_DEFAULT, "preset",
1298         GST_DEBUG_FG_WHITE | GST_DEBUG_BG_BLACK, "preset interface");
1299
1300     /* create quarks for use with g_type_{g,s}et_qdata() */
1301     preset_quark = g_quark_from_static_string ("GstPreset::presets");
1302     preset_user_path_quark =
1303         g_quark_from_static_string ("GstPreset::user_path");
1304     preset_app_path_quark = g_quark_from_static_string ("GstPreset::app_path");
1305     preset_system_path_quark =
1306         g_quark_from_static_string ("GstPreset::system_path");
1307
1308 #if 0
1309     /* create interface properties, each element would need to override this
1310      *   g_object_class_override_property(gobject_class, PROP_PRESET_NAME, "preset-name");
1311      * and in _set_property() do
1312      *   case PROP_PRESET_NAME: {
1313      *     gchar *name = g_value_get_string (value);
1314      *     if (name)
1315      *       gst_preset_load_preset(preset, name);
1316      *   } break;
1317      */
1318     g_object_interface_install_property (g_class,
1319         g_param_spec_string ("preset-name",
1320             "preset-name property",
1321             "load given preset", NULL, G_PARAM_WRITABLE));
1322 #endif
1323
1324     initialized = TRUE;
1325   }
1326 }
1327
1328 GType
1329 gst_preset_get_type (void)
1330 {
1331   static volatile gsize type = 0;
1332
1333   if (g_once_init_enter (&type)) {
1334     GType _type;
1335     const GTypeInfo info = {
1336       sizeof (GstPresetInterface),
1337       (GBaseInitFunc) gst_preset_base_init,     /* base_init */
1338       NULL,                     /* base_finalize */
1339       (GClassInitFunc) gst_preset_class_init,   /* class_init */
1340       NULL,                     /* class_finalize */
1341       NULL,                     /* class_data */
1342       0,
1343       0,                        /* n_preallocs */
1344       NULL                      /* instance_init */
1345     };
1346     _type = g_type_register_static (G_TYPE_INTERFACE, "GstPreset", &info, 0);
1347     g_once_init_leave (&type, _type);
1348   }
1349   return type;
1350 }