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