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