gst-libs/gst/pbutils/encoding-target.c

   1 /* GStreamer encoding profile registry
   2  * Copyright (C) 2010 Edward Hervey <edward.hervey@collabora.co.uk>
   3  *           (C) 2010 Nokia Corporation
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Library General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2 of the License, or (at your option) any later version.
   9  *
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Library General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Library General Public
  16  * License along with this library; if not, write to the
  17  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18  * Boston, MA 02111-1307, USA.
  19  */
  20
  21 #ifdef HAVE_CONFIG_H
  22 #include "config.h"
  23 #endif
  24
  25 #include <locale.h>
  26 #include <string.h>
  27 #include "encoding-target.h"
  28
  29 /*
  30  * File format
  31  *
  32  * GKeyFile style.
  33  *
  34  * [_gstencodingtarget_]
  35  * name : <name>
  36  * category : <category>
  37  * description : <description> #translatable
  38  *
  39  * [profile-<profile1name>]
  40  * name : <name>
  41  * description : <description> #optional
  42  * format : <format>
  43  * preset : <preset>
  44  *
  45  * [streamprofile-<id>]
  46  * parent : <encodingprofile.name>[,<encodingprofile.name>..]
  47  * type : <type> # "audio", "video", "text"
  48  * format : <format>
  49  * preset : <preset>
  50  * restriction : <restriction>
  51  * presence : <presence>
  52  * pass : <pass>
  53  * variableframerate : <variableframerate>
  54  *  */
  55
  56 /*
  57  * Location of profile files
  58  *
  59  * $GST_DATADIR/gstreamer-GST_MAJORMINOR/encoding-profile
  60  * $HOME/gstreamer-GST_MAJORMINOR/encoding-profile
  61  *
  62  * Naming convention
  63  *   $(target.category)/$(target.name).gep
  64  *
  65  * Naming restrictions:
  66  *  lowercase ASCII letter for the first character
  67  *  Same for all other characters + numerics + hyphens
  68  */
  69
  70
  71 #define GST_ENCODING_TARGET_HEADER "_gstencodingtarget_"
  72 #define GST_ENCODING_TARGET_DIRECTORY "encoding-profiles"
  73 #define GST_ENCODING_TARGET_SUFFIX ".gep"
  74
  75 struct _GstEncodingTarget
  76 {
  77   GstMiniObject parent;
  78
  79   gchar *name;
  80   gchar *category;
  81   gchar *description;
  82   GList *profiles;
  83
  84   /*< private > */
  85   gchar *keyfile;
  86 };
  87
  88 G_DEFINE_TYPE (GstEncodingTarget, gst_encoding_target, GST_TYPE_MINI_OBJECT);
  89
  90 static void
  91 gst_encoding_target_init (GstEncodingTarget * target)
  92 {
  93   /* Nothing to initialize */
  94 }
  95
  96 static void
  97 gst_encoding_target_finalize (GstEncodingTarget * target)
  98 {
  99   GST_DEBUG ("Finalizing");
 100
 101   if (target->name)
 102     g_free (target->name);
 103   if (target->category)
 104     g_free (target->category);
 105   if (target->description)
 106     g_free (target->description);
 107
 108   g_list_foreach (target->profiles, (GFunc) gst_mini_object_unref, NULL);
 109   g_list_free (target->profiles);
 110 }
 111
 112 static void
 113 gst_encoding_target_class_init (GstMiniObjectClass * klass)
 114 {
 115   klass->finalize =
 116       (GstMiniObjectFinalizeFunction) gst_encoding_target_finalize;
 117 }
 118
 119 /**
 120  * gst_encoding_target_get_name:
 121  * @target: a #GstEncodingTarget
 122  *
 123  * Since: 0.10.32
 124  *
 125  * Returns: (transfer none): The name of the @target.
 126  */
 127 const gchar *
 128 gst_encoding_target_get_name (GstEncodingTarget * target)
 129 {
 130   return target->name;
 131 }
 132
 133 /**
 134  * gst_encoding_target_get_category:
 135  * @target: a #GstEncodingTarget
 136  *
 137  * Since: 0.10.32
 138  *
 139  * Returns: (transfer none): The category of the @target. For example:
 140  * #GST_ENCODING_CATEGORY_DEVICE.
 141  */
 142 const gchar *
 143 gst_encoding_target_get_category (GstEncodingTarget * target)
 144 {
 145   return target->category;
 146 }
 147
 148 /**
 149  * gst_encoding_target_get_description:
 150  * @target: a #GstEncodingTarget
 151  *
 152  * Since: 0.10.32
 153  *
 154  * Returns: (transfer none): The description of the @target.
 155  */
 156 const gchar *
 157 gst_encoding_target_get_description (GstEncodingTarget * target)
 158 {
 159   return target->description;
 160 }
 161
 162 /**
 163  * gst_encoding_target_get_profiles:
 164  * @target: a #GstEncodingTarget
 165  *
 166  * Since: 0.10.32
 167  *
 168  * Returns: (transfer none) (element-type Gst.EncodingProfile): A list of
 169  * #GstEncodingProfile(s) this @target handles.
 170  */
 171 const GList *
 172 gst_encoding_target_get_profiles (GstEncodingTarget * target)
 173 {
 174   return target->profiles;
 175 }
 176
 177 /**
 178  * gst_encoding_target_get_profile:
 179  * @target: a #GstEncodingTarget
 180  * @name: the name of the profile to retrieve
 181  *
 182  * Since: 0.10.32
 183  *
 184  * Returns: (transfer full): The matching #GstEncodingProfile, or %NULL.
 185  */
 186 GstEncodingProfile *
 187 gst_encoding_target_get_profile (GstEncodingTarget * target, const gchar * name)
 188 {
 189   GList *tmp;
 190
 191   g_return_val_if_fail (GST_IS_ENCODING_TARGET (target), NULL);
 192   g_return_val_if_fail (name != NULL, NULL);
 193
 194   for (tmp = target->profiles; tmp; tmp = tmp->next) {
 195     GstEncodingProfile *tprof = (GstEncodingProfile *) tmp->data;
 196
 197     if (!g_strcmp0 (gst_encoding_profile_get_name (tprof), name)) {
 198       gst_encoding_profile_ref (tprof);
 199       return tprof;
 200     }
 201   }
 202
 203   return NULL;
 204 }
 205
 206 static inline gboolean
 207 validate_name (const gchar * name)
 208 {
 209   guint i, len;
 210
 211   len = strlen (name);
 212   if (len == 0)
 213     return FALSE;
 214
 215   /* First character can only be a lower case ASCII character */
 216   if (!g_ascii_isalpha (name[0]) || !g_ascii_islower (name[0]))
 217     return FALSE;
 218
 219   /* All following characters can only by:
 220    * either a lower case ASCII character
 221    * or an hyphen
 222    * or a numeric */
 223   for (i = 1; i < len; i++) {
 224     /* if uppercase ASCII letter, return */
 225     if (g_ascii_isupper (name[i]))
 226       return FALSE;
 227     /* if a digit, continue */
 228     if (g_ascii_isdigit (name[i]))
 229       continue;
 230     /* if an hyphen, continue */
 231     if (name[i] == '-')
 232       continue;
 233     /* remaining should only be ascii letters */
 234     if (!g_ascii_isalpha (name[i]))
 235       return FALSE;
 236   }
 237
 238   return TRUE;
 239 }
 240
 241 /**
 242  * gst_encoding_target_new:
 243  * @name: The name of the target.
 244  * @category: (transfer none): The name of the category to which this @target
 245  * belongs. For example: #GST_ENCODING_CATEGORY_DEVICE.
 246  * @description: (transfer none): A description of #GstEncodingTarget in the
 247  * current locale.
 248  * @profiles: (transfer none) (element-type Gst.EncodingProfile): A #GList of
 249  * #GstEncodingProfile.
 250  *
 251  * Creates a new #GstEncodingTarget.
 252  *
 253  * The name and category can only consist of lowercase ASCII letters for the
 254  * first character, followed by either lowercase ASCII letters, digits or
 255  * hyphens ('-').
 256  *
 257  * The @category <emphasis>should</emphasis> be one of the existing
 258  * well-defined categories, like #GST_ENCODING_CATEGORY_DEVICE, but it
 259  * <emphasis>can</emphasis> be a application or user specific category if
 260  * needed.
 261  *
 262  * Since: 0.10.32
 263  *
 264  * Returns: (transfer full): The newly created #GstEncodingTarget or %NULL if
 265  * there was an error.
 266  */
 267
 268 GstEncodingTarget *
 269 gst_encoding_target_new (const gchar * name, const gchar * category,
 270     const gchar * description, const GList * profiles)
 271 {
 272   GstEncodingTarget *res;
 273
 274   g_return_val_if_fail (name != NULL, NULL);
 275   g_return_val_if_fail (category != NULL, NULL);
 276   g_return_val_if_fail (description != NULL, NULL);
 277
 278   /* Validate name */
 279   if (!validate_name (name))
 280     goto invalid_name;
 281   if (!validate_name (category))
 282     goto invalid_category;
 283
 284   res = (GstEncodingTarget *) gst_mini_object_new (GST_TYPE_ENCODING_TARGET);
 285   res->name = g_strdup (name);
 286   res->category = g_strdup (category);
 287   res->description = g_strdup (description);
 288
 289   while (profiles) {
 290     GstEncodingProfile *prof = (GstEncodingProfile *) profiles->data;
 291
 292     res->profiles =
 293         g_list_append (res->profiles, gst_encoding_profile_ref (prof));
 294     profiles = profiles->next;
 295   }
 296
 297   return res;
 298
 299 invalid_name:
 300   {
 301     GST_ERROR ("Invalid name for encoding target : '%s'", name);
 302     return NULL;
 303   }
 304
 305 invalid_category:
 306   {
 307     GST_ERROR ("Invalid name for encoding category : '%s'", category);
 308     return NULL;
 309   }
 310 }
 311
 312 /**
 313  * gst_encoding_target_add_profile:
 314  * @target: the #GstEncodingTarget to add a profile to
 315  * @profile: (transfer full): the #GstEncodingProfile to add
 316  *
 317  * Adds the given @profile to the @target. Each added profile must have
 318  * a unique name within the profile.
 319  *
 320  * The @target will steal a reference to the @profile. If you wish to use
 321  * the profile after calling this method, you should increase its reference
 322  * count.
 323  *
 324  * Since: 0.10.32
 325  *
 326  * Returns: %TRUE if the profile was added, else %FALSE.
 327  **/
 328
 329 gboolean
 330 gst_encoding_target_add_profile (GstEncodingTarget * target,
 331     GstEncodingProfile * profile)
 332 {
 333   GList *tmp;
 334
 335   g_return_val_if_fail (GST_IS_ENCODING_TARGET (target), FALSE);
 336   g_return_val_if_fail (GST_IS_ENCODING_PROFILE (profile), FALSE);
 337
 338   /* Make sure profile isn't already controlled by this target */
 339   for (tmp = target->profiles; tmp; tmp = tmp->next) {
 340     GstEncodingProfile *prof = (GstEncodingProfile *) tmp->data;
 341
 342     if (!g_strcmp0 (gst_encoding_profile_get_name (profile),
 343             gst_encoding_profile_get_name (prof))) {
 344       GST_WARNING ("Profile already present in target");
 345       return FALSE;
 346     }
 347   }
 348
 349   target->profiles = g_list_append (target->profiles, profile);
 350
 351   return TRUE;
 352 }
 353
 354 static gboolean
 355 serialize_stream_profiles (GKeyFile * out, GstEncodingProfile * sprof,
 356     const gchar * profilename, guint id)
 357 {
 358   gchar *sprofgroupname;
 359   gchar *tmpc;
 360   const GstCaps *format, *restriction;
 361   const gchar *preset, *name, *description;
 362
 363   sprofgroupname = g_strdup_printf ("streamprofile-%s-%d", profilename, id);
 364
 365   /* Write the parent profile */
 366   g_key_file_set_value (out, sprofgroupname, "parent", profilename);
 367
 368   g_key_file_set_value (out, sprofgroupname, "type",
 369       gst_encoding_profile_get_type_nick (sprof));
 370
 371   format = gst_encoding_profile_get_format (sprof);
 372   if (format) {
 373     tmpc = gst_caps_to_string (format);
 374     g_key_file_set_value (out, sprofgroupname, "format", tmpc);
 375     g_free (tmpc);
 376   }
 377
 378   name = gst_encoding_profile_get_name (sprof);
 379   if (name)
 380     g_key_file_set_string (out, sprofgroupname, "name", name);
 381
 382   description = gst_encoding_profile_get_description (sprof);
 383   if (description)
 384     g_key_file_set_string (out, sprofgroupname, "description", description);
 385
 386   preset = gst_encoding_profile_get_preset (sprof);
 387   if (preset)
 388     g_key_file_set_string (out, sprofgroupname, "preset", preset);
 389
 390   restriction = gst_encoding_profile_get_restriction (sprof);
 391   if (restriction) {
 392     tmpc = gst_caps_to_string (restriction);
 393     g_key_file_set_value (out, sprofgroupname, "restriction", tmpc);
 394     g_free (tmpc);
 395   }
 396   g_key_file_set_integer (out, sprofgroupname, "presence",
 397       gst_encoding_profile_get_presence (sprof));
 398
 399   if (GST_IS_ENCODING_VIDEO_PROFILE (sprof)) {
 400     GstEncodingVideoProfile *vp = (GstEncodingVideoProfile *) sprof;
 401
 402     g_key_file_set_integer (out, sprofgroupname, "pass",
 403         gst_encoding_video_profile_get_pass (vp));
 404     g_key_file_set_boolean (out, sprofgroupname, "variableframerate",
 405         gst_encoding_video_profile_get_variableframerate (vp));
 406   }
 407
 408   g_free (sprofgroupname);
 409   return TRUE;
 410 }
 411
 412 /* Serialize the top-level profiles
 413  * Note: They don't have to be containerprofiles */
 414 static gboolean
 415 serialize_encoding_profile (GKeyFile * out, GstEncodingProfile * prof)
 416 {
 417   gchar *profgroupname;
 418   const GList *tmp;
 419   guint i;
 420   const gchar *profname, *profdesc, *profpreset, *proftype;
 421   const GstCaps *profformat, *profrestriction;
 422
 423   profname = gst_encoding_profile_get_name (prof);
 424   profdesc = gst_encoding_profile_get_description (prof);
 425   profformat = gst_encoding_profile_get_format (prof);
 426   profpreset = gst_encoding_profile_get_preset (prof);
 427   proftype = gst_encoding_profile_get_type_nick (prof);
 428   profrestriction = gst_encoding_profile_get_restriction (prof);
 429
 430   profgroupname = g_strdup_printf ("profile-%s", profname);
 431
 432   g_key_file_set_string (out, profgroupname, "name", profname);
 433
 434   g_key_file_set_value (out, profgroupname, "type",
 435       gst_encoding_profile_get_type_nick (prof));
 436
 437   if (profdesc)
 438     g_key_file_set_locale_string (out, profgroupname, "description",
 439         setlocale (LC_ALL, NULL), profdesc);
 440   if (profformat) {
 441     gchar *tmpc = gst_caps_to_string (profformat);
 442     g_key_file_set_string (out, profgroupname, "format", tmpc);
 443     g_free (tmpc);
 444   }
 445   if (profpreset)
 446     g_key_file_set_string (out, profgroupname, "preset", profpreset);
 447
 448   /* stream profiles */
 449   if (GST_IS_ENCODING_CONTAINER_PROFILE (prof)) {
 450     for (tmp =
 451         gst_encoding_container_profile_get_profiles
 452         (GST_ENCODING_CONTAINER_PROFILE (prof)), i = 0; tmp;
 453         tmp = tmp->next, i++) {
 454       GstEncodingProfile *sprof = (GstEncodingProfile *) tmp->data;
 455
 456       if (!serialize_stream_profiles (out, sprof, profname, i))
 457         return FALSE;
 458     }
 459   }
 460   g_free (profgroupname);
 461   return TRUE;
 462 }
 463
 464 static gboolean
 465 serialize_target (GKeyFile * out, GstEncodingTarget * target)
 466 {
 467   GList *tmp;
 468
 469   g_key_file_set_string (out, GST_ENCODING_TARGET_HEADER, "name", target->name);
 470   g_key_file_set_string (out, GST_ENCODING_TARGET_HEADER, "category",
 471       target->category);
 472   g_key_file_set_string (out, GST_ENCODING_TARGET_HEADER, "description",
 473       target->description);
 474
 475   for (tmp = target->profiles; tmp; tmp = tmp->next) {
 476     GstEncodingProfile *prof = (GstEncodingProfile *) tmp->data;
 477     if (!serialize_encoding_profile (out, prof))
 478       return FALSE;
 479   }
 480
 481   return TRUE;
 482 }
 483
 484 /**
 485  * parse_encoding_profile:
 486  * @in: a #GKeyFile
 487  * @parentprofilename: the parent profile name (including 'profile-' or 'streamprofile-' header)
 488  * @profilename: the profile name group to parse
 489  * @nbgroups: the number of top-level groups
 490  * @groups: the top-level groups
 491  */
 492 static GstEncodingProfile *
 493 parse_encoding_profile (GKeyFile * in, gchar * parentprofilename,
 494     gchar * profilename, gsize nbgroups, gchar ** groups)
 495 {
 496   GstEncodingProfile *sprof = NULL;
 497   gchar **parent;
 498   gchar *proftype, *format, *preset, *restriction, *pname, *description;
 499   GstCaps *formatcaps = NULL;
 500   GstCaps *restrictioncaps = NULL;
 501   gboolean variableframerate;
 502   gint pass, presence;
 503   gsize i, nbencprofiles;
 504
 505   GST_DEBUG ("parentprofilename : %s , profilename : %s",
 506       parentprofilename, profilename);
 507
 508   if (parentprofilename) {
 509     gboolean found = FALSE;
 510
 511     parent =
 512         g_key_file_get_string_list (in, profilename, "parent",
 513         &nbencprofiles, NULL);
 514     if (!parent || !nbencprofiles) {
 515       return NULL;
 516     }
 517
 518     /* Check if this streamprofile is used in <profilename> */
 519     for (i = 0; i < nbencprofiles; i++) {
 520       if (!g_strcmp0 (parent[i], parentprofilename)) {
 521         found = TRUE;
 522         break;
 523       }
 524     }
 525     g_strfreev (parent);
 526
 527     if (!found) {
 528       GST_DEBUG ("Stream profile '%s' isn't used in profile '%s'",
 529           profilename, parentprofilename);
 530       return NULL;
 531     }
 532   }
 533
 534   pname = g_key_file_get_value (in, profilename, "name", NULL);
 535
 536   /* First try to get localized description */
 537   description =
 538       g_key_file_get_locale_string (in, profilename, "description",
 539       setlocale (LC_ALL, NULL), NULL);
 540   if (description == NULL)
 541     description = g_key_file_get_value (in, profilename, "description", NULL);
 542
 543   /* Parse the remaining fields */
 544   proftype = g_key_file_get_value (in, profilename, "type", NULL);
 545   if (!proftype) {
 546     GST_WARNING ("Missing 'type' field for streamprofile %s", profilename);
 547     return NULL;
 548   }
 549
 550   format = g_key_file_get_value (in, profilename, "format", NULL);
 551   if (format) {
 552     formatcaps = gst_caps_from_string (format);
 553     g_free (format);
 554   }
 555
 556   preset = g_key_file_get_value (in, profilename, "preset", NULL);
 557
 558   restriction = g_key_file_get_value (in, profilename, "restriction", NULL);
 559   if (restriction) {
 560     restrictioncaps = gst_caps_from_string (restriction);
 561     g_free (restriction);
 562   }
 563
 564   presence = g_key_file_get_integer (in, profilename, "presence", NULL);
 565   pass = g_key_file_get_integer (in, profilename, "pass", NULL);
 566   variableframerate =
 567       g_key_file_get_boolean (in, profilename, "variableframerate", NULL);
 568
 569   /* Build the streamprofile ! */
 570   if (!g_strcmp0 (proftype, "container")) {
 571     GstEncodingProfile *pprof;
 572
 573     sprof =
 574         (GstEncodingProfile *) gst_encoding_container_profile_new (pname,
 575         description, formatcaps, preset);
 576     /* Now look for the stream profiles */
 577     for (i = 0; i < nbgroups; i++) {
 578       if (!g_ascii_strncasecmp (groups[i], "streamprofile-", 13)) {
 579         pprof = parse_encoding_profile (in, pname, groups[i], nbgroups, groups);
 580         if (pprof) {
 581           gst_encoding_container_profile_add_profile (
 582               (GstEncodingContainerProfile *) sprof, pprof);
 583         }
 584       }
 585     }
 586   } else if (!g_strcmp0 (proftype, "video")) {
 587     sprof =
 588         (GstEncodingProfile *) gst_encoding_video_profile_new (formatcaps,
 589         preset, restrictioncaps, presence);
 590     gst_encoding_video_profile_set_variableframerate ((GstEncodingVideoProfile
 591             *) sprof, variableframerate);
 592     gst_encoding_video_profile_set_pass ((GstEncodingVideoProfile *) sprof,
 593         pass);
 594   } else if (!g_strcmp0 (proftype, "audio")) {
 595     sprof =
 596         (GstEncodingProfile *) gst_encoding_audio_profile_new (formatcaps,
 597         preset, restrictioncaps, presence);
 598   } else
 599     GST_ERROR ("Unknown profile format '%s'", proftype);
 600
 601   if (restrictioncaps)
 602     gst_caps_unref (restrictioncaps);
 603   if (formatcaps)
 604     gst_caps_unref (formatcaps);
 605
 606   if (pname)
 607     g_free (pname);
 608   if (description)
 609     g_free (description);
 610   if (preset)
 611     g_free (preset);
 612   if (proftype)
 613     g_free (proftype);
 614
 615   return sprof;
 616 }
 617
 618 static GstEncodingTarget *
 619 parse_keyfile (GKeyFile * in, gchar * targetname, gchar * categoryname,
 620     gchar * description)
 621 {
 622   GstEncodingTarget *res = NULL;
 623   GstEncodingProfile *prof;
 624   gchar **groups;
 625   gsize i, nbgroups;
 626
 627   res = gst_encoding_target_new (targetname, categoryname, description, NULL);
 628
 629   /* Figure out the various profiles */
 630   groups = g_key_file_get_groups (in, &nbgroups);
 631   for (i = 0; i < nbgroups; i++) {
 632     if (!g_ascii_strncasecmp (groups[i], "profile-", 8)) {
 633       prof = parse_encoding_profile (in, NULL, groups[i], nbgroups, groups);
 634       if (prof)
 635         gst_encoding_target_add_profile (res, prof);
 636     }
 637   }
 638
 639   g_strfreev (groups);
 640
 641   if (targetname)
 642     g_free (targetname);
 643   if (categoryname)
 644     g_free (categoryname);
 645   if (description)
 646     g_free (description);
 647
 648   return res;
 649 }
 650
 651 static GKeyFile *
 652 load_file_and_read_header (const gchar * path, gchar ** targetname,
 653     gchar ** categoryname, gchar ** description, GError ** error)
 654 {
 655   GKeyFile *in;
 656   gboolean res;
 657
 658   in = g_key_file_new ();
 659
 660   GST_DEBUG ("path:%s", path);
 661
 662   res =
 663       g_key_file_load_from_file (in, path,
 664       G_KEY_FILE_KEEP_COMMENTS | G_KEY_FILE_KEEP_TRANSLATIONS, error);
 665   if (!res || error != NULL)
 666     goto load_error;
 667
 668   *targetname =
 669       g_key_file_get_value (in, GST_ENCODING_TARGET_HEADER, "name", error);
 670   if (!*targetname)
 671     goto empty_name;
 672
 673   *categoryname =
 674       g_key_file_get_value (in, GST_ENCODING_TARGET_HEADER, "category", NULL);
 675   *description =
 676       g_key_file_get_value (in, GST_ENCODING_TARGET_HEADER, "description",
 677       NULL);
 678
 679   return in;
 680
 681 load_error:
 682   {
 683     GST_WARNING ("Unable to read GstEncodingTarget file %s: %s",
 684         path, (*error)->message);
 685     g_key_file_free (in);
 686     return NULL;
 687   }
 688
 689 empty_name:
 690   {
 691     GST_WARNING ("Wrong header in file %s: %s", path, (*error)->message);
 692     g_key_file_free (in);
 693     return NULL;
 694   }
 695 }
 696
 697 /**
 698  * gst_encoding_target_load_from_file:
 699  * @filepath: The file location to load the #GstEncodingTarget from
 700  * @error: If an error occured, this field will be filled in.
 701  *
 702  * Opens the provided file and returns the contained #GstEncodingTarget.
 703  *
 704  * Since: 0.10.32
 705  *
 706  * Returns: (transfer full): The #GstEncodingTarget contained in the file, else
 707  * %NULL
 708  */
 709
 710 GstEncodingTarget *
 711 gst_encoding_target_load_from_file (const gchar * filepath, GError ** error)
 712 {
 713   GKeyFile *in;
 714   gchar *targetname, *categoryname, *description;
 715   GstEncodingTarget *res = NULL;
 716
 717   in = load_file_and_read_header (filepath, &targetname, &categoryname,
 718       &description, error);
 719   if (!in)
 720     goto beach;
 721
 722   res = parse_keyfile (in, targetname, categoryname, description);
 723
 724   g_key_file_free (in);
 725
 726 beach:
 727   return res;
 728 }
 729
 730 /*
 731  * returned list contents must be freed
 732  */
 733 static GList *
 734 get_matching_filenames (gchar * path, gchar * filename)
 735 {
 736   GList *res = NULL;
 737   GDir *topdir;
 738   const gchar *subdirname;
 739
 740   topdir = g_dir_open (path, 0, NULL);
 741   if (G_UNLIKELY (topdir == NULL))
 742     return NULL;
 743
 744   while ((subdirname = g_dir_read_name (topdir))) {
 745     gchar *ltmp = g_build_filename (path, subdirname, NULL);
 746
 747     if (g_file_test (ltmp, G_FILE_TEST_IS_DIR)) {
 748       gchar *tmp = g_build_filename (path, subdirname, filename, NULL);
 749       /* Test to see if we have a file named like that in that directory */
 750       if (g_file_test (tmp, G_FILE_TEST_EXISTS))
 751         res = g_list_append (res, tmp);
 752       else
 753         g_free (tmp);
 754     }
 755     g_free (ltmp);
 756   }
 757
 758   g_dir_close (topdir);
 759
 760   return res;
 761 }
 762
 763 static GstEncodingTarget *
 764 gst_encoding_target_subload (gchar * path, const gchar * category,
 765     gchar * lfilename, GError ** error)
 766 {
 767   GstEncodingTarget *target = NULL;
 768
 769   if (category) {
 770     gchar *filename;
 771
 772     filename = g_build_filename (path, category, lfilename, NULL);
 773     target = gst_encoding_target_load_from_file (filename, error);
 774     g_free (filename);
 775   } else {
 776     GList *tmp, *tries = get_matching_filenames (path, lfilename);
 777
 778     /* Try to find a file named %s.gstprofile in any subdirectories */
 779     for (tmp = tries; tmp; tmp = tmp->next) {
 780       target = gst_encoding_target_load_from_file ((gchar *) tmp->data, NULL);
 781       if (target)
 782         break;
 783     }
 784     g_list_foreach (tries, (GFunc) g_free, NULL);
 785     if (tries)
 786       g_list_free (tries);
 787   }
 788
 789   return target;
 790 }
 791
 792 /**
 793  * gst_encoding_target_load:
 794  * @name: the name of the #GstEncodingTarget to load.
 795  * @category: (allow-none): the name of the target category, like
 796  * #GST_ENCODING_CATEGORY_DEVICE. Can be %NULL
 797  * @error: If an error occured, this field will be filled in.
 798  *
 799  * Searches for the #GstEncodingTarget with the given name, loads it
 800  * and returns it.
 801  *
 802  * If the category name is specified only targets from that category will be
 803  * searched for.
 804  *
 805  * Since: 0.10.32
 806  *
 807  * Returns: (transfer full): The #GstEncodingTarget if available, else %NULL.
 808  */
 809 GstEncodingTarget *
 810 gst_encoding_target_load (const gchar * name, const gchar * category,
 811     GError ** error)
 812 {
 813   gchar *lfilename, *tldir;
 814   GstEncodingTarget *target = NULL;
 815
 816   g_return_val_if_fail (name != NULL, NULL);
 817
 818   if (!validate_name (name))
 819     goto invalid_name;
 820
 821   if (category && !validate_name (category))
 822     goto invalid_category;
 823
 824   lfilename = g_strdup_printf ("%s" GST_ENCODING_TARGET_SUFFIX, name);
 825
 826   /* Try from local profiles */
 827   tldir =
 828       g_build_filename (g_get_home_dir (), ".gstreamer-" GST_MAJORMINOR,
 829       GST_ENCODING_TARGET_DIRECTORY, NULL);
 830   target = gst_encoding_target_subload (tldir, category, lfilename, error);
 831   g_free (tldir);
 832
 833   if (target == NULL) {
 834     /* Try from system-wide profiles */
 835     tldir =
 836         g_build_filename (GST_DATADIR, "gstreamer-" GST_MAJORMINOR,
 837         GST_ENCODING_TARGET_DIRECTORY, NULL);
 838     target = gst_encoding_target_subload (tldir, category, lfilename, error);
 839     g_free (tldir);
 840   }
 841
 842   g_free (lfilename);
 843
 844   return target;
 845
 846 invalid_name:
 847   {
 848     GST_ERROR ("Invalid name for encoding target : '%s'", name);
 849     return NULL;
 850   }
 851 invalid_category:
 852   {
 853     GST_ERROR ("Invalid name for encoding category : '%s'", category);
 854     return NULL;
 855   }
 856 }
 857
 858 /**
 859  * gst_encoding_target_save_to_file:
 860  * @target: a #GstEncodingTarget
 861  * @filepath: the location to store the @target at.
 862  * @error: If an error occured, this field will be filled in.
 863  *
 864  * Saves the @target to the provided file location.
 865  *
 866  * Since: 0.10.32
 867  *
 868  * Returns: %TRUE if the target was correctly saved, else %FALSE.
 869  **/
 870
 871 gboolean
 872 gst_encoding_target_save_to_file (GstEncodingTarget * target,
 873     const gchar * filepath, GError ** error)
 874 {
 875   GKeyFile *out;
 876   gchar *data;
 877   gsize data_size;
 878
 879   g_return_val_if_fail (GST_IS_ENCODING_TARGET (target), FALSE);
 880   g_return_val_if_fail (filepath != NULL, FALSE);
 881
 882   /* FIXME : Check filepath is valid and writable
 883    * FIXME : Strip out profiles already present in system target */
 884
 885   /* Get unique name... */
 886
 887   /* Create output GKeyFile */
 888   out = g_key_file_new ();
 889
 890   if (!serialize_target (out, target))
 891     goto serialize_failure;
 892
 893   if (!(data = g_key_file_to_data (out, &data_size, error)))
 894     goto convert_failed;
 895
 896   if (!g_file_set_contents (filepath, data, data_size, error))
 897     goto write_failed;
 898
 899   g_key_file_free (out);
 900   g_free (data);
 901
 902   return TRUE;
 903
 904 serialize_failure:
 905   {
 906     GST_ERROR ("Failure serializing target");
 907     g_key_file_free (out);
 908     return FALSE;
 909   }
 910
 911 convert_failed:
 912   {
 913     GST_ERROR ("Failure converting keyfile: %s", (*error)->message);
 914     g_key_file_free (out);
 915     g_free (data);
 916     return FALSE;
 917   }
 918
 919 write_failed:
 920   {
 921     GST_ERROR ("Unable to write file %s: %s", filepath, (*error)->message);
 922     g_key_file_free (out);
 923     g_free (data);
 924     return FALSE;
 925   }
 926 }
 927
 928 /**
 929  * gst_encoding_target_save:
 930  * @target: a #GstEncodingTarget
 931  * @error: If an error occured, this field will be filled in.
 932  *
 933  * Saves the @target to a default user-local directory.
 934  *
 935  * Since: 0.10.32
 936  *
 937  * Returns: %TRUE if the target was correctly saved, else %FALSE.
 938  **/
 939
 940 gboolean
 941 gst_encoding_target_save (GstEncodingTarget * target, GError ** error)
 942 {
 943   gchar *filename;
 944   gchar *lfilename;
 945   gboolean res;
 946
 947   g_return_val_if_fail (GST_IS_ENCODING_TARGET (target), FALSE);
 948   g_return_val_if_fail (target->category != NULL, FALSE);
 949
 950   lfilename = g_strdup_printf ("%s" GST_ENCODING_TARGET_SUFFIX, target->name);
 951   filename =
 952       g_build_filename (g_get_home_dir (), ".gstreamer-" GST_MAJORMINOR,
 953       GST_ENCODING_TARGET_DIRECTORY, target->category, lfilename, NULL);
 954   g_free (lfilename);
 955
 956   res = gst_encoding_target_save_to_file (target, filename, error);
 957   g_free (filename);
 958
 959   return TRUE;
 960 }
 961
 962 static GList *
 963 get_categories (gchar * path)
 964 {
 965   GList *res = NULL;
 966   GDir *topdir;
 967   const gchar *subdirname;
 968
 969   topdir = g_dir_open (path, 0, NULL);
 970   if (G_UNLIKELY (topdir == NULL))
 971     return NULL;
 972
 973   while ((subdirname = g_dir_read_name (topdir))) {
 974     gchar *ltmp = g_build_filename (path, subdirname, NULL);
 975
 976     if (g_file_test (ltmp, G_FILE_TEST_IS_DIR)) {
 977       res = g_list_append (res, (gpointer) g_strdup (subdirname));
 978     }
 979     g_free (ltmp);
 980   }
 981
 982   g_dir_close (topdir);
 983
 984   return res;
 985 }
 986
 987 /**
 988  * gst_encoding_list_available_categories:
 989  *
 990  * Lists all #GstEncodingTarget categories present on disk.
 991  *
 992  * Returns: (transfer full) (element-type gchar*): A list
 993  * of #GstEncodingTarget categories.
 994  *
 995  * Since: 0.10.32
 996  */
 997 GList *
 998 gst_encoding_list_available_categories (void)
 999 {
1000   GList *res = NULL;
1001   GList *tmp1, *tmp2;
1002   gchar *topdir;
1003
1004   /* First try user-local categories */
1005   topdir = g_build_filename (g_get_home_dir (), ".gstreamer-" GST_MAJORMINOR,
1006       GST_ENCODING_TARGET_DIRECTORY, NULL);
1007   res = get_categories (topdir);
1008   g_free (topdir);
1009
1010   /* Extend with system-wide categories */
1011   topdir = g_build_filename (GST_DATADIR, "gstreamer-" GST_MAJORMINOR,
1012       GST_ENCODING_TARGET_DIRECTORY, NULL);
1013   tmp1 = get_categories (topdir);
1014   g_free (topdir);
1015
1016   for (tmp2 = tmp1; tmp2; tmp2 = tmp2->next) {
1017     gchar *name = (gchar *) tmp2->data;
1018     if (!g_list_find_custom (res, name, (GCompareFunc) g_strcmp0))
1019       res = g_list_append (res, (gpointer) name);
1020     else
1021       g_free (name);
1022   }
1023   g_free (tmp1);
1024
1025   return res;
1026 }
1027
1028 static inline GList *
1029 sub_get_all_targets (gchar * subdir)
1030 {
1031   GList *res = NULL;
1032   const gchar *filename;
1033   GDir *dir;
1034   GstEncodingTarget *target;
1035
1036   dir = g_dir_open (subdir, 0, NULL);
1037   if (G_UNLIKELY (dir == NULL))
1038     return NULL;
1039
1040   while ((filename = g_dir_read_name (dir))) {
1041     gchar *fullname;
1042
1043     /* Only try files ending with .gstprofile */
1044     if (!g_str_has_suffix (filename, GST_ENCODING_TARGET_SUFFIX))
1045       continue;
1046
1047     fullname = g_build_filename (subdir, filename, NULL);
1048     target = gst_encoding_target_load_from_file (fullname, NULL);
1049     if (target) {
1050       res = g_list_append (res, target);
1051     } else
1052       GST_WARNING ("Failed to get a target from %s", fullname);
1053     g_free (fullname);
1054   }
1055   g_dir_close (dir);
1056
1057   return res;
1058 }
1059
1060 static inline GList *
1061 get_all_targets (gchar * topdir, const gchar * categoryname)
1062 {
1063   GList *res = NULL;
1064
1065   if (categoryname) {
1066     gchar *subdir = g_build_filename (topdir, categoryname, NULL);
1067     /* Try to open the directory */
1068     res = sub_get_all_targets (subdir);
1069     g_free (subdir);
1070   } else {
1071     const gchar *subdirname;
1072     GDir *dir = g_dir_open (topdir, 0, NULL);
1073
1074     if (G_UNLIKELY (dir == NULL))
1075       return NULL;
1076
1077     while ((subdirname = g_dir_read_name (dir))) {
1078       gchar *ltmp = g_build_filename (topdir, subdirname, NULL);
1079
1080       if (g_file_test (ltmp, G_FILE_TEST_IS_DIR)) {
1081         res = g_list_concat (res, sub_get_all_targets (ltmp));
1082       }
1083       g_free (ltmp);
1084     }
1085     g_dir_close (dir);
1086   }
1087
1088   return res;
1089 }
1090
1091 static guint
1092 compare_targets (const GstEncodingTarget * ta, const GstEncodingTarget * tb)
1093 {
1094   if (!g_strcmp0 (ta->name, tb->name)
1095       && !g_strcmp0 (ta->category, tb->category))
1096     return -1;
1097
1098   return 0;
1099 }
1100
1101 /**
1102  * gst_encoding_list_all_targets:
1103  * @categoryname: (allow-none): The category, for ex: #GST_ENCODING_CATEGORY_DEVICE.
1104  * Can be %NULL.
1105  *
1106  * List all available #GstEncodingTarget for the specified category, or all categories
1107  * if @categoryname is %NULL.
1108  *
1109  * Returns: (transfer full) (element-type GstEncodingTarget): The list of #GstEncodingTarget
1110  *
1111  * Since: 0.10.32
1112  */
1113 GList *
1114 gst_encoding_list_all_targets (const gchar * categoryname)
1115 {
1116   GList *res;
1117   GList *tmp1, *tmp2;
1118   gchar *topdir;
1119
1120   /* Get user-locals */
1121   topdir = g_build_filename (g_get_home_dir (), ".gstreamer-" GST_MAJORMINOR,
1122       GST_ENCODING_TARGET_DIRECTORY, NULL);
1123   res = get_all_targets (topdir, categoryname);
1124   g_free (topdir);
1125
1126   /* Get system-wide */
1127   topdir = g_build_filename (GST_DATADIR, "gstreamer-" GST_MAJORMINOR,
1128       GST_ENCODING_TARGET_DIRECTORY, NULL);
1129   tmp1 = get_all_targets (topdir, categoryname);
1130   g_free (topdir);
1131
1132   /* Merge system-wide targets */
1133   /* FIXME : We should merge the system-wide profiles into the user-locals
1134    * instead of stopping at identical target names */
1135   for (tmp2 = tmp1; tmp2; tmp2 = tmp2->next) {
1136     GstEncodingTarget *target = (GstEncodingTarget *) tmp2->data;
1137     if (g_list_find_custom (res, target, (GCompareFunc) compare_targets))
1138       gst_encoding_target_unref (target);
1139     else
1140       res = g_list_append (res, target);
1141   }
1142   g_list_free (tmp1);
1143
1144   return res;
1145 }