1 /* GStreamer language codes and names utility functions
2 * Copyright (C) 2009 Tim-Philipp Müller <tim centricular net>
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Library General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Library General Public License for more details.
14 * You should have received a copy of the GNU Library General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
17 * Boston, MA 02110-1301, USA.
21 * SECTION:gsttaglanguagecodes
22 * @title: ISO-639 lang mappings
23 * @short_description: mappings for ISO-639 language codes and names
24 * @see_also: #GstTagList
26 * Provides helper functions to convert between the various ISO-639 language
27 * codes, and to map language codes to language names.
35 #undef GETTEXT_PACKAGE
36 #define GETTEXT_PACKAGE "iso_639"
38 #define ISO_639_XML_PATH ISO_CODES_PREFIX "/share/xml/iso-codes/iso_639.xml"
39 #define ISO_CODES_LOCALEDIR ISO_CODES_PREFIX "/share/locale"
41 #include <gst/gst-i18n-plugin.h>
48 #include "lang-tables.dat"
50 #ifndef GST_DISABLE_GST_DEBUG
52 #define GST_CAT_DEFAULT ensure_debug_category()
54 static GstDebugCategory *
55 ensure_debug_category (void)
57 static gsize cat_gonce = 0;
59 if (g_once_init_enter (&cat_gonce)) {
62 cat_done = (gsize) _gst_debug_category_new ("tag-langcodes", 0,
63 "GstTag language codes and names");
65 g_once_init_leave (&cat_gonce, cat_done);
68 return (GstDebugCategory *) cat_gonce;
73 #define ensure_debug_category() /* NOOP */
75 #endif /* GST_DISABLE_GST_DEBUG */
77 /* ------------------------------------------------------------------------- */
79 /* Loading and initing */
81 #if defined(HAVE_ISO_CODES)
83 get_val (const gchar ** names, const gchar ** vals, const gchar * name)
85 while (names != NULL && *names != NULL) {
86 if (strcmp (*names, name) == 0)
95 parse_start_element (GMarkupParseContext * ctx, const gchar * element_name,
96 const gchar ** attr_names, const gchar ** attr_vals,
97 gpointer user_data, GError ** error)
99 GHashTable *ht = (GHashTable *) user_data;
100 const gchar *c1, *c2t, *c2b, *name, *tname;
102 if (strcmp (element_name, "iso_639_entry") != 0)
105 c1 = get_val (attr_names, attr_vals, "iso_639_1_code");
107 /* only interested in languages with an ISO 639-1 code for now */
111 c2t = get_val (attr_names, attr_vals, "iso_639_2T_code");
112 c2b = get_val (attr_names, attr_vals, "iso_639_2B_code");
113 name = get_val (attr_names, attr_vals, "name");
115 if (c2t == NULL || c2b == NULL || name == NULL) {
116 GST_WARNING ("broken iso_639.xml entry: c2t=%p, c2b=%p, name=%p", c2t,
121 /* translate language name */
124 /* if no translation was found, it will return the input string, which we
125 * we don't want to put into the hash table because it will be freed again */
126 if (G_UNLIKELY (tname == name))
127 tname = g_intern_string (name);
129 /* now overwrite default/fallback mappings with names in locale language */
130 g_hash_table_replace (ht, (gpointer) g_intern_string (c1), (gpointer) tname);
131 g_hash_table_replace (ht, (gpointer) g_intern_string (c2b), (gpointer) tname);
132 if (strcmp (c2t, c2b) != 0) {
133 g_hash_table_replace (ht, (gpointer) g_intern_string (c2t),
137 GST_LOG ("%s %s %s : %s - %s", c1, c2t, c2b, name, tname);
141 gst_tag_load_iso_639_xml (GHashTable * ht)
149 GST_DEBUG ("binding text domain %s to locale dir %s", GETTEXT_PACKAGE,
150 ISO_CODES_LOCALEDIR);
151 bindtextdomain (GETTEXT_PACKAGE, ISO_CODES_LOCALEDIR);
152 bind_textdomain_codeset (GETTEXT_PACKAGE, "UTF-8");
155 f = g_mapped_file_new (ISO_639_XML_PATH, FALSE, NULL);
157 xml_data = (gchar *) g_mapped_file_get_contents (f);
158 xml_len = g_mapped_file_get_length (f);
160 if (!g_file_get_contents (ISO_639_XML_PATH, &xml_data, &xml_len, &err)) {
161 GST_WARNING ("Could not read %s: %s", ISO_639_XML_PATH, err->message);
167 if (g_utf8_validate (xml_data, xml_len, NULL)) {
168 GMarkupParser xml_parser = { parse_start_element, NULL, NULL, NULL, NULL };
169 GMarkupParseContext *ctx;
171 ctx = g_markup_parse_context_new (&xml_parser, 0, ht, NULL);
172 if (!g_markup_parse_context_parse (ctx, xml_data, xml_len, &err)) {
173 GST_WARNING ("Parsing iso_639.xml failed: %s", err->message);
176 g_markup_parse_context_free (ctx);
178 GST_WARNING ("iso_639.xml file is not valid UTF-8");
179 GST_MEMDUMP ("iso_639.xml file", (guint8 *) xml_data, xml_len);
182 /* ... and clean up */
184 g_mapped_file_unref (f);
188 #endif /* HAVE_ISO_CODES */
191 gst_tag_get_iso_639_ht (void)
193 static gsize once_val = 0;
196 if (g_once_init_enter (&once_val)) {
200 GST_MEMDUMP ("iso 639 language names (internal default/fallback)",
201 (guint8 *) iso_639_names, sizeof (iso_639_names));
203 /* maps code -> language name; all strings are either interned strings
204 * or const static strings from lang-table.c */
205 ht = g_hash_table_new (g_str_hash, g_str_equal);
207 /* set up default/fallback mappings */
208 for (i = 0; i < G_N_ELEMENTS (iso_639_codes); ++i) {
209 GST_LOG ("%3d %s %s %c%c 0x%04x %s", i, iso_639_codes[i].iso_639_1,
210 iso_639_codes[i].iso_639_2,
211 ((iso_639_codes[i].flags & ISO_639_FLAG_2B)) ? 'B' : '.',
212 ((iso_639_codes[i].flags & ISO_639_FLAG_2T)) ? 'T' : '.',
213 iso_639_codes[i].name_offset,
214 iso_639_names + iso_639_codes[i].name_offset);
216 #ifdef HAVE_ISO_CODES
217 /* intern these in order to minimise allocations when interning strings
218 * read from the xml file later */
219 g_intern_static_string (iso_639_codes[i].iso_639_1);
220 g_intern_static_string (iso_639_codes[i].iso_639_2);
221 g_intern_static_string (iso_639_names + iso_639_codes[i].name_offset);
224 /* and add default mapping (these strings are always valid) */
225 g_hash_table_insert (ht, (gpointer) iso_639_codes[i].iso_639_1,
226 (gpointer) (iso_639_names + iso_639_codes[i].name_offset));
227 g_hash_table_insert (ht, (gpointer) iso_639_codes[i].iso_639_2,
228 (gpointer) (iso_639_names + iso_639_codes[i].name_offset));
231 #ifdef HAVE_ISO_CODES
233 GstClockTime ts = gst_util_get_timestamp ();
235 gst_tag_load_iso_639_xml (ht);
237 ts = gst_util_get_timestamp () - ts;
238 GST_INFO ("iso_639.xml loading took %.2gms", (double) ts / GST_MSECOND);
241 GST_INFO ("iso-codes disabled or not available");
244 done_val = (gsize) ht;
245 g_once_init_leave (&once_val, done_val);
248 return (GHashTable *) once_val;
251 /* ------------------------------------------------------------------------- */
254 qsort_strcmp_func (const void *p1, const void *p2)
256 return strcmp (*(char *const *) p1, *(char *const *) p2);
260 * gst_tag_get_language_codes:
262 * Returns a list of known language codes (in form of two-letter ISO-639-1
263 * codes). This is useful for UIs to build a list of available languages for
264 * tagging purposes (e.g. to tag an audio track appropriately in a video or
267 * Returns: (transfer full): NULL-terminated string array with two-letter
268 * language codes. Free with g_strfreev() when no longer needed.
271 gst_tag_get_language_codes (void)
279 ensure_debug_category ();
281 ht = gst_tag_get_iso_639_ht ();
283 /* we have at least two keys for each language (-1 code and -2 code) */
284 codes = g_new (gchar *, (g_hash_table_size (ht) / 2) + 1);
287 g_hash_table_iter_init (&iter, ht);
288 while (g_hash_table_iter_next (&iter, &key, NULL)) {
289 const gchar *lang_code = key;
291 if (strlen (lang_code) == 2) {
292 codes[i] = g_strdup (lang_code);
298 /* be nice and sort the list */
299 qsort (&codes[0], i, sizeof (gchar *), qsort_strcmp_func);
305 * gst_tag_get_language_name:
306 * @language_code: two or three-letter ISO-639 language code
308 * Returns the name of the language given an ISO-639 language code as
309 * found in a GST_TAG_LANGUAGE_CODE tag. The name will be translated
310 * according to the current locale (if the library was built against the
311 * iso-codes package, otherwise the English name will be returned).
313 * Language codes are case-sensitive and expected to be lower case.
315 * Returns: language name in UTF-8 format, or NULL if @language_code could
316 * not be mapped to a language name. The returned string must not be
317 * modified and does not need to freed; it will stay valid until the
318 * application is terminated.
321 gst_tag_get_language_name (const gchar * language_code)
323 const gchar *lang_name;
326 g_return_val_if_fail (language_code != NULL, NULL);
328 ensure_debug_category ();
330 ht = gst_tag_get_iso_639_ht ();
332 lang_name = g_hash_table_lookup (ht, (gpointer) language_code);
333 GST_LOG ("%s -> %s", language_code, GST_STR_NULL (lang_name));
339 * gst_tag_get_language_code_iso_639_1:
340 * @lang_code: ISO-639 language code (e.g. "deu" or "ger" or "de")
342 * Returns two-letter ISO-639-1 language code given a three-letter ISO-639-2
343 * language code or two-letter ISO-639-1 language code (both are accepted for
346 * Language codes are case-sensitive and expected to be lower case.
348 * Returns: two-letter ISO-639-1 language code string that maps to @lang_code,
349 * or NULL if no mapping is known. The returned string must not be
353 gst_tag_get_language_code_iso_639_1 (const gchar * lang_code)
355 const gchar *c = NULL;
358 g_return_val_if_fail (lang_code != NULL, NULL);
360 ensure_debug_category ();
362 /* FIXME: we are being a bit inconsistent here in the sense that will only
363 * map the language codes from our static table. Theoretically the iso-codes
364 * XML file might have had additional codes that are now in the hash table.
365 * We keep it simple for now and don't waste memory on additional tables. */
366 for (i = 0; i < G_N_ELEMENTS (iso_639_codes); ++i) {
367 /* we check both codes here, so function can be used in a more versatile
368 * way, to convert a language tag to a two-letter language code and/or
369 * verify an existing code */
370 if (strcmp (lang_code, iso_639_codes[i].iso_639_1) == 0 ||
371 strcmp (lang_code, iso_639_codes[i].iso_639_2) == 0) {
372 c = iso_639_codes[i].iso_639_1;
374 /* If the language code does not have a 2-letter representation, the table
375 * holds an empty string. We want to return NULL in that case. */
376 c = c[0] != '\0' ? c : NULL;
381 GST_LOG ("%s -> %s", lang_code, GST_STR_NULL (c));
387 gst_tag_get_language_code_iso_639_2X (const gchar * lang_code, guint8 flags)
391 /* FIXME: we are being a bit inconsistent here in the sense that we will only
392 * map the language codes from our static table. Theoretically the iso-codes
393 * XML file might have had additional codes that are now in the hash table.
394 * We keep it simple for now and don't waste memory on additional tables.
395 * Also, we currently only parse the iso_639.xml file if language names or
396 * a list of all codes is requested, and it'd be nice to keep it like that. */
397 for (i = 0; i < G_N_ELEMENTS (iso_639_codes); ++i) {
398 /* we check both codes here, so function can be used in a more versatile
399 * way, to convert a language tag to a three-letter language code and/or
400 * verify an existing code */
401 if (strcmp (lang_code, iso_639_codes[i].iso_639_1) == 0 ||
402 strcmp (lang_code, iso_639_codes[i].iso_639_2) == 0) {
403 if ((iso_639_codes[i].flags & flags) == flags) {
404 return iso_639_codes[i].iso_639_2;
405 } else if (i > 0 && (iso_639_codes[i - 1].flags & flags) == flags &&
406 iso_639_codes[i].name_offset == iso_639_codes[i - 1].name_offset) {
407 return iso_639_codes[i - 1].iso_639_2;
408 } else if ((i + 1) < G_N_ELEMENTS (iso_639_codes) &&
409 (iso_639_codes[i + 1].flags & flags) == flags &&
410 iso_639_codes[i].name_offset == iso_639_codes[i + 1].name_offset) {
411 return iso_639_codes[i + 1].iso_639_2;
419 * gst_tag_get_language_code_iso_639_2T:
420 * @lang_code: ISO-639 language code (e.g. "deu" or "ger" or "de")
422 * Returns three-letter ISO-639-2 "terminological" language code given a
423 * two-letter ISO-639-1 language code or a three-letter ISO-639-2 language
424 * code (both are accepted for convenience).
426 * The "terminological" code is derived from the local name of the language
427 * (e.g. "deu" for German instead of "ger"). In most scenarios, the
428 * "terminological" codes are preferred over the "bibliographic" ones.
430 * Language codes are case-sensitive and expected to be lower case.
432 * Returns: three-letter ISO-639-2 language code string that maps to @lang_code,
433 * or NULL if no mapping is known. The returned string must not be
437 gst_tag_get_language_code_iso_639_2T (const gchar * lang_code)
441 g_return_val_if_fail (lang_code != NULL, NULL);
443 ensure_debug_category ();
445 c = gst_tag_get_language_code_iso_639_2X (lang_code, ISO_639_FLAG_2T);
447 GST_LOG ("%s -> %s", lang_code, GST_STR_NULL (c));
453 * gst_tag_get_language_code_iso_639_2B:
454 * @lang_code: ISO-639 language code (e.g. "deu" or "ger" or "de")
456 * Returns three-letter ISO-639-2 "bibliographic" language code given a
457 * two-letter ISO-639-1 language code or a three-letter ISO-639-2 language
458 * code (both are accepted for convenience).
460 * The "bibliographic" code is derived from the English name of the language
461 * (e.g. "ger" for German instead of "de" or "deu"). In most scenarios, the
462 * "terminological" codes are preferred.
464 * Language codes are case-sensitive and expected to be lower case.
466 * Returns: three-letter ISO-639-2 language code string that maps to @lang_code,
467 * or NULL if no mapping is known. The returned string must not be
471 gst_tag_get_language_code_iso_639_2B (const gchar * lang_code)
475 g_return_val_if_fail (lang_code != NULL, NULL);
477 ensure_debug_category ();
479 c = gst_tag_get_language_code_iso_639_2X (lang_code, ISO_639_FLAG_2B);
481 GST_LOG ("%s -> %s", lang_code, GST_STR_NULL (c));
487 * gst_tag_check_language_code:
488 * @lang_code: ISO-639 language code (e.g. "deu" or "ger" or "de")
490 * Check if a given string contains a known ISO 639 language code.
492 * This is useful in situations where it's not clear whether a given
493 * string is a language code (which should be put into a #GST_TAG_LANGUAGE_CODE
494 * tag) or a free-form language name descriptor (which should be put into a
495 * #GST_TAG_LANGUAGE_NAME tag instead).
497 * Returns: TRUE if the two- or three-letter language code in @lang_code
498 * is a valid ISO-639 language code.
501 gst_tag_check_language_code (const gchar * lang_code)
503 return (gst_tag_get_language_code_iso_639_1 (lang_code) != NULL);