gst/apetag/gstapedemux.c

   1 /* GStreamer APEv1/2 tag reader
   2  * Copyright (C) 2004 Ronald Bultje <rbultje@ronald.bitfreak.net>
   3  * Copyright (C) 2006 Tim-Philipp Müller <tim centricular net>
   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 /**
  22  * SECTION:element-apedemux
  23  *
  24  * apedemux accepts data streams with APE tags at the start or at the end
  25  * (or both). The mime type of the data between the tag blocks is detected
  26  * using typefind functions, and the appropriate output mime type set on
  27  * outgoing buffers.
  28  *
  29  * The element is only able to read APE tags at the end of a stream from
  30  * a seekable stream, ie. when get_range mode is supported by the upstream
  31  * elements. If get_range operation is available, apedemux makes it available
  32  * downstream. This means that elements which require get_range mode, such as
  33  * wavparse or musepackdec, can operate on files containing APE tag
  34  * information.
  35  *
  36  * <refsect2>
  37  * <title>Example launch line</title>
  38  * |[
  39  * gst-launch -t filesrc location=file.mpc ! apedemux ! fakesink
  40  * ]| This pipeline should read any available APE tag information and output it.
  41  * The contents of the file inside the APE tag regions should be detected, and
  42  * the appropriate mime type set on buffers produced from apedemux.
  43  * </refsect2>
  44  */
  45 #ifdef HAVE_CONFIG_H
  46 #include "config.h"
  47 #endif
  48
  49 #include <gst/gst.h>
  50 #include <gst/gst-i18n-plugin.h>
  51 #include <gst/pbutils/pbutils.h>
  52
  53 #include "gstapedemux.h"
  54
  55 #include <stdio.h>
  56 #include <string.h>
  57
  58 #define APE_VERSION_MAJOR(ver)  ((ver)/1000)
  59
  60 GST_DEBUG_CATEGORY_STATIC (apedemux_debug);
  61 #define GST_CAT_DEFAULT (apedemux_debug)
  62
  63 static GstStaticPadTemplate sink_factory = GST_STATIC_PAD_TEMPLATE ("sink",
  64     GST_PAD_SINK,
  65     GST_PAD_ALWAYS,
  66     GST_STATIC_CAPS ("application/x-apetag")
  67     );
  68
  69 static gboolean gst_ape_demux_identify_tag (GstTagDemux * demux,
  70     GstBuffer * buffer, gboolean start_tag, guint * tag_size);
  71 static GstTagDemuxResult gst_ape_demux_parse_tag (GstTagDemux * demux,
  72     GstBuffer * buffer, gboolean start_tag, guint * tag_size,
  73     GstTagList ** tags);
  74
  75 G_DEFINE_TYPE (GstApeDemux, gst_ape_demux, GST_TYPE_TAG_DEMUX);
  76
  77 static void
  78 gst_ape_demux_class_init (GstApeDemuxClass * klass)
  79 {
  80   GstElementClass *element_class;
  81   GstTagDemuxClass *tagdemux_class;
  82
  83   GST_DEBUG_CATEGORY_INIT (apedemux_debug, "apedemux", 0,
  84       "GStreamer APE tag demuxer");
  85
  86   tagdemux_class = GST_TAG_DEMUX_CLASS (klass);
  87   element_class = GST_ELEMENT_CLASS (klass);
  88
  89   gst_element_class_set_static_metadata (element_class, "APE tag demuxer",
  90       "Codec/Demuxer/Metadata",
  91       "Read and output APE tags while demuxing the contents",
  92       "Tim-Philipp Müller <tim centricular net>");
  93
  94   gst_element_class_add_pad_template (element_class,
  95       gst_static_pad_template_get (&sink_factory));
  96
  97   tagdemux_class->identify_tag = GST_DEBUG_FUNCPTR (gst_ape_demux_identify_tag);
  98   tagdemux_class->parse_tag = GST_DEBUG_FUNCPTR (gst_ape_demux_parse_tag);
  99
 100   /* no need for a merge function, the default behaviour to prefer start
 101    * tags (APEv2) over end tags (usually APEv1, but could theoretically also
 102    * be APEv2) is fine */
 103
 104   tagdemux_class->min_start_size = 32;
 105   tagdemux_class->min_end_size = 32;
 106 }
 107
 108 static void
 109 gst_ape_demux_init (GstApeDemux * apedemux)
 110 {
 111   /* nothing to do here */
 112 }
 113
 114 static const struct _GstApeDemuxTagTableEntry
 115 {
 116   const gchar *ape_tag;
 117   const gchar *gst_tag;
 118 } tag_table[] = {
 119   {
 120   "replaygain_track_gain", GST_TAG_TRACK_GAIN}, {
 121   "replaygain_track_peak", GST_TAG_TRACK_PEAK}, {
 122   "replaygain_album_gain", GST_TAG_ALBUM_GAIN}, {
 123   "replaygain_album_peak", GST_TAG_ALBUM_PEAK}, {
 124   "title", GST_TAG_TITLE}, {
 125   "artist", GST_TAG_ARTIST}, {
 126   "album", GST_TAG_ALBUM}, {
 127   "composer", GST_TAG_COMPOSER}, {
 128   "comment", GST_TAG_COMMENT}, {
 129   "comments", GST_TAG_COMMENT}, {
 130   "copyright", GST_TAG_COPYRIGHT}, {
 131   "genre", GST_TAG_GENRE}, {
 132   "isrc", GST_TAG_ISRC}, {
 133   "disc", GST_TAG_ALBUM_VOLUME_NUMBER}, {
 134   "disk", GST_TAG_ALBUM_VOLUME_NUMBER}, {
 135   "discnumber", GST_TAG_ALBUM_VOLUME_NUMBER}, {
 136   "disknumber", GST_TAG_ALBUM_VOLUME_NUMBER}, {
 137   "track", GST_TAG_TRACK_NUMBER}, {
 138   "tracknumber", GST_TAG_TRACK_NUMBER}, {
 139   "year", GST_TAG_DATE}, {
 140   "file", GST_TAG_LOCATION}
 141 };
 142
 143 static gboolean
 144 ape_demux_get_gst_tag_from_tag (const gchar * ape_tag,
 145     const gchar ** gst_tag, GType * gst_tag_type)
 146 {
 147   gint i;
 148
 149   for (i = 0; i < G_N_ELEMENTS (tag_table); ++i) {
 150     if (g_ascii_strcasecmp (tag_table[i].ape_tag, ape_tag) == 0) {
 151       *gst_tag = tag_table[i].gst_tag;
 152       *gst_tag_type = gst_tag_get_type (tag_table[i].gst_tag);
 153       GST_LOG ("Mapped APE tag '%s' to GStreamer tag '%s'", ape_tag, *gst_tag);
 154       return TRUE;
 155     }
 156   }
 157
 158   GST_WARNING ("Could not map APE tag '%s' to a GStreamer tag", ape_tag);
 159   return FALSE;
 160 }
 161
 162 static GstTagList *
 163 ape_demux_parse_tags (const guint8 * data, gint size)
 164 {
 165   GstTagList *taglist = gst_tag_list_new_empty ();
 166
 167   GST_LOG ("Reading tags from chunk of size %u bytes", size);
 168
 169   /* get rid of header/footer */
 170   if (size >= 32 && memcmp (data, "APETAGEX", 8) == 0) {
 171     data += 32;
 172     size -= 32;
 173   }
 174   if (size > 32 && memcmp (data + size - 32, "APETAGEX", 8) == 0) {
 175     size -= 32;
 176   }
 177
 178   /* read actual tags - at least 10 bytes for tag header */
 179   while (size >= 10) {
 180     guint len, n = 8;
 181     gchar *tag, *val;
 182     const gchar *gst_tag;
 183     GType gst_tag_type;
 184
 185     /* find tag type and size */
 186     len = GST_READ_UINT32_LE (data);
 187     while (n < size && data[n] != 0x0)
 188       n++;
 189     if (n == size)
 190       break;
 191     g_assert (data[n] == 0x0);
 192     n++;
 193     if (size - n < len)
 194       break;
 195
 196     /* If the tag is empty, skip to the next one */
 197     if (len == 0)
 198       goto next_tag;
 199
 200     /* read */
 201     tag = g_strndup ((gchar *) data + 8, n - 9);
 202     val = g_strndup ((gchar *) data + n, len);
 203
 204     GST_LOG ("tag [%s], val[%s]", tag, val);
 205
 206     /* special-case 'media' tag, could be e.g. "CD 1/2" */
 207     if (g_ascii_strcasecmp (tag, "media") == 0) {
 208       gchar *sp, *sp2;
 209
 210       g_free (tag);
 211       tag = g_strdup ("discnumber");
 212       /* get rid of the medium in front */
 213       sp = strchr (val, ' ');
 214       while (sp != NULL && (sp2 = strchr (sp + 1, ' ')) != NULL)
 215         sp = sp2;
 216       if (sp) {
 217         g_memmove (val, sp + 1, strlen (sp + 1) + 1);
 218       }
 219     }
 220
 221     if (ape_demux_get_gst_tag_from_tag (tag, &gst_tag, &gst_tag_type)) {
 222       GValue v = { 0, };
 223
 224       switch (gst_tag_type) {
 225         case G_TYPE_INT:{
 226           gint v_int;
 227
 228           if (sscanf (val, "%d", &v_int) == 1) {
 229             g_value_init (&v, G_TYPE_INT);
 230             g_value_set_int (&v, v_int);
 231           }
 232           break;
 233         }
 234         case G_TYPE_UINT:{
 235           guint v_uint, count;
 236
 237           if (strcmp (gst_tag, GST_TAG_TRACK_NUMBER) == 0) {
 238             gint dummy;
 239
 240             if (sscanf (val, "%u", &v_uint) == 1 && v_uint > 0) {
 241               g_value_init (&v, G_TYPE_UINT);
 242               g_value_set_uint (&v, v_uint);
 243             }
 244             GST_LOG ("checking for track count: %s", val);
 245             /* might be 0/N or -1/N to specify that there is only a count */
 246             if (sscanf (val, "%d/%u", &dummy, &count) == 2 && count > 0) {
 247               gst_tag_list_add (taglist, GST_TAG_MERGE_APPEND,
 248                   GST_TAG_TRACK_COUNT, count, NULL);
 249             }
 250           } else if (strcmp (gst_tag, GST_TAG_ALBUM_VOLUME_NUMBER) == 0) {
 251             gint dummy;
 252
 253             if (sscanf (val, "%u", &v_uint) == 1 && v_uint > 0) {
 254               g_value_init (&v, G_TYPE_UINT);
 255               g_value_set_uint (&v, v_uint);
 256             }
 257             GST_LOG ("checking for volume count: %s", val);
 258             /* might be 0/N or -1/N to specify that there is only a count */
 259             if (sscanf (val, "%d/%u", &dummy, &count) == 2 && count > 0) {
 260               gst_tag_list_add (taglist, GST_TAG_MERGE_APPEND,
 261                   GST_TAG_ALBUM_VOLUME_COUNT, count, NULL);
 262             }
 263           } else if (sscanf (val, "%u", &v_uint) == 1) {
 264             g_value_init (&v, G_TYPE_UINT);
 265             g_value_set_uint (&v, v_uint);
 266           }
 267           break;
 268         }
 269         case G_TYPE_STRING:{
 270           g_value_init (&v, G_TYPE_STRING);
 271           g_value_set_string (&v, val);
 272           break;
 273         }
 274         case G_TYPE_DOUBLE:{
 275           gdouble v_double;
 276           gchar *endptr;
 277
 278           /* floating point strings can be "4,123" or "4.123" depending on
 279            * the locale. We need to be able to parse and read either version
 280            * no matter what our current locale is */
 281           g_strdelimit (val, ",", '.');
 282           v_double = g_ascii_strtod (val, &endptr);
 283           if (endptr != val) {
 284             g_value_init (&v, G_TYPE_DOUBLE);
 285             g_value_set_double (&v, v_double);
 286           }
 287
 288           break;
 289         }
 290         default:{
 291           if (gst_tag_type == G_TYPE_DATE) {
 292             gint v_int;
 293
 294             if (sscanf (val, "%d", &v_int) == 1) {
 295               GDate *date = g_date_new_dmy (1, 1, v_int);
 296
 297               g_value_init (&v, G_TYPE_DATE);
 298               g_value_take_boxed (&v, date);
 299             }
 300           } else {
 301             GST_WARNING ("Unhandled tag type '%s' for tag '%s'",
 302                 g_type_name (gst_tag_type), gst_tag);
 303           }
 304           break;
 305         }
 306       }
 307       if (G_VALUE_TYPE (&v) != 0) {
 308         gst_tag_list_add_values (taglist, GST_TAG_MERGE_APPEND,
 309             gst_tag, &v, NULL);
 310         g_value_unset (&v);
 311       }
 312     }
 313     GST_DEBUG ("Read tag %s: %s", tag, val);
 314     g_free (tag);
 315     g_free (val);
 316
 317     /* move data pointer */
 318   next_tag:
 319     size -= len + n;
 320     data += len + n;
 321   }
 322
 323   GST_DEBUG ("Taglist: %" GST_PTR_FORMAT, taglist);
 324   return taglist;
 325 }
 326
 327 static gboolean
 328 gst_ape_demux_identify_tag (GstTagDemux * demux, GstBuffer * buffer,
 329     gboolean start_tag, guint * tag_size)
 330 {
 331   GstMapInfo map;
 332
 333   gst_buffer_map (buffer, &map, GST_MAP_READ);
 334
 335   if (memcmp (map.data, "APETAGEX", 8) != 0) {
 336     GST_DEBUG_OBJECT (demux, "No APETAGEX marker at %s - not an APE file",
 337         (start_tag) ? "start" : "end");
 338     gst_buffer_unmap (buffer, &map);
 339     return FALSE;
 340   }
 341
 342   *tag_size = GST_READ_UINT32_LE (map.data + 12);
 343
 344   /* size is without header, so add 32 to account for that */
 345   *tag_size += 32;
 346
 347   gst_buffer_unmap (buffer, &map);
 348
 349   return TRUE;
 350 }
 351
 352 static GstTagDemuxResult
 353 gst_ape_demux_parse_tag (GstTagDemux * demux, GstBuffer * buffer,
 354     gboolean start_tag, guint * tag_size, GstTagList ** tags)
 355 {
 356   guint8 *data;
 357   guint8 *footer;
 358   gboolean have_header;
 359   gboolean end_tag = !start_tag;
 360   GstCaps *sink_caps;
 361   guint version, footer_size;
 362   GstMapInfo map;
 363   gsize size;
 364
 365   gst_buffer_map (buffer, &map, GST_MAP_READ);
 366   data = map.data;
 367   size = map.size;
 368
 369   GST_LOG_OBJECT (demux, "Parsing buffer of size %" G_GSIZE_FORMAT, size);
 370
 371   footer = data + size - 32;
 372
 373   GST_LOG_OBJECT (demux, "Checking for footer at offset 0x%04x",
 374       (guint) (footer - data));
 375   if (footer > data && memcmp (footer, "APETAGEX", 8) == 0) {
 376     GST_DEBUG_OBJECT (demux, "Found footer");
 377     footer_size = 32;
 378   } else {
 379     GST_DEBUG_OBJECT (demux, "No footer");
 380     footer_size = 0;
 381   }
 382
 383   /* APE tags at the end must have a footer */
 384   if (end_tag && footer_size == 0) {
 385     GST_WARNING_OBJECT (demux, "Tag at end of file without footer!");
 386     return GST_TAG_DEMUX_RESULT_BROKEN_TAG;
 387   }
 388
 389   /* don't trust the header/footer flags, better detect them ourselves */
 390   have_header = (memcmp (data, "APETAGEX", 8) == 0);
 391
 392   if (start_tag && !have_header) {
 393     GST_DEBUG_OBJECT (demux, "Tag at beginning of file without header!");
 394     return GST_TAG_DEMUX_RESULT_BROKEN_TAG;
 395   }
 396
 397   if (end_tag && !have_header) {
 398     GST_DEBUG_OBJECT (demux, "Tag at end of file has no header (APEv1)");
 399     *tag_size -= 32;            /* adjust tag size */
 400   }
 401
 402   if (have_header) {
 403     version = GST_READ_UINT32_LE (data + 8);
 404   } else {
 405     version = GST_READ_UINT32_LE (footer + 8);
 406   }
 407
 408   /* skip header */
 409   if (have_header) {
 410     data += 32;
 411   }
 412
 413   GST_DEBUG_OBJECT (demux, "APE tag with version %u, size %u at offset 0x%08"
 414       G_GINT64_MODIFIER "x", version, *tag_size,
 415       GST_BUFFER_OFFSET (buffer) + ((have_header) ? 0 : 32));
 416
 417   if (APE_VERSION_MAJOR (version) != 1 && APE_VERSION_MAJOR (version) != 2) {
 418     GST_WARNING ("APE tag is version %u.%03u, but decoder only supports "
 419         "v1 or v2. Ignoring.", APE_VERSION_MAJOR (version), version % 1000);
 420     return GST_TAG_DEMUX_RESULT_OK;
 421   }
 422
 423   *tags = ape_demux_parse_tags (data, *tag_size - footer_size);
 424
 425   sink_caps = gst_static_pad_template_get_caps (&sink_factory);
 426   gst_pb_utils_add_codec_description_to_tag_list (*tags,
 427       GST_TAG_CONTAINER_FORMAT, sink_caps);
 428   gst_caps_unref (sink_caps);
 429
 430   gst_buffer_unmap (buffer, &map);
 431
 432   return GST_TAG_DEMUX_RESULT_OK;
 433 }
 434
 435 static gboolean
 436 plugin_init (GstPlugin * plugin)
 437 {
 438   return gst_element_register (plugin, "apedemux",
 439       GST_RANK_PRIMARY, GST_TYPE_APE_DEMUX);
 440 }
 441
 442 GST_PLUGIN_DEFINE (GST_VERSION_MAJOR,
 443     GST_VERSION_MINOR,
 444     apetag,
 445     "APEv1/2 tag reader",
 446     plugin_init, VERSION, "LGPL", GST_PACKAGE_NAME, GST_PACKAGE_ORIGIN)