ext/taglib/gstapev2mux.cc

   1 /* GStreamer taglib-based APEv2 muxer
   2  * Copyright (C) 2006 Christophe Fergeau <teuf@gnome.org>
   3  * Copyright (C) 2006 Tim-Philipp Müller <tim centricular net>
   4  * Copyright (C) 2006 Sebastian Dröge <slomo@circular-chaos.org>
   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 /**
  23  * SECTION:element-apev2mux
  24  * @see_also: #GstTagSetter
  25  *
  26  * This element adds APEv2 tags to the beginning of a stream using the taglib
  27  * library.
  28  *
  29  * Applications can set the tags to write using the #GstTagSetter interface.
  30  * Tags sent by upstream elements will be picked up automatically (and merged
  31  * according to the merge mode set via the tag setter interface).
  32  *
  33  * <refsect2>
  34  * <title>Example pipelines</title>
  35  * |[
  36  * gst-launch -v filesrc location=foo.ogg ! decodebin ! audioconvert ! lame ! apev2mux ! filesink location=foo.mp3
  37  * ]| A pipeline that transcodes a file from Ogg/Vorbis to mp3 format with an
  38  * APEv2 that contains the same as the the Ogg/Vorbis file. Make sure the
  39  * Ogg/Vorbis file actually has comments to preserve.
  40  * |[
  41  * gst-launch -m filesrc location=foo.mp3 ! apedemux ! fakesink silent=TRUE 2&gt; /dev/null | grep taglist
  42  * ]| Verify that tags have been written.
  43  * </refsect2>
  44  */
  45
  46 #ifdef HAVE_CONFIG_H
  47 #include <config.h>
  48 #endif
  49
  50 #include "gstapev2mux.h"
  51
  52 #include <string.h>
  53
  54 #include <apetag.h>
  55 #include <gst/tag/tag.h>
  56
  57 using namespace TagLib;
  58
  59 GST_DEBUG_CATEGORY_STATIC (gst_apev2_mux_debug);
  60 #define GST_CAT_DEFAULT gst_apev2_mux_debug
  61
  62 static GstStaticPadTemplate src_template = GST_STATIC_PAD_TEMPLATE ("src",
  63     GST_PAD_SRC,
  64     GST_PAD_ALWAYS,
  65     GST_STATIC_CAPS ("application/x-apetag"));
  66
  67 GST_BOILERPLATE (GstApev2Mux, gst_apev2_mux, GstTagLibMux,
  68     GST_TYPE_TAG_LIB_MUX);
  69
  70 static GstBuffer *gst_apev2_mux_render_tag (GstTagLibMux * mux,
  71     GstTagList * taglist);
  72
  73 static void
  74 gst_apev2_mux_base_init (gpointer g_class)
  75 {
  76   GstElementClass *element_class = GST_ELEMENT_CLASS (g_class);
  77
  78   gst_element_class_add_pad_template (element_class,
  79       gst_static_pad_template_get (&src_template));
  80
  81   gst_element_class_set_details_simple (element_class,
  82       "TagLib-based APEv2 Muxer", "Formatter/Metadata",
  83       "Adds an APEv2 header to the beginning of files using taglib",
  84       "Sebastian Dröge <slomo@circular-chaos.org>");
  85
  86   GST_DEBUG_CATEGORY_INIT (gst_apev2_mux_debug, "apev2mux", 0,
  87       "taglib-based APEv2 tag muxer");
  88 }
  89
  90 static void
  91 gst_apev2_mux_class_init (GstApev2MuxClass * klass)
  92 {
  93   GST_TAG_LIB_MUX_CLASS (klass)->render_tag =
  94       GST_DEBUG_FUNCPTR (gst_apev2_mux_render_tag);
  95 }
  96
  97 static void
  98 gst_apev2_mux_init (GstApev2Mux * apev2mux, GstApev2MuxClass * apev2mux_class)
  99 {
 100   /* nothing to do */
 101 }
 102
 103 static void
 104 add_one_tag (const GstTagList * list, const gchar * tag, gpointer user_data)
 105 {
 106   APE::Tag * apev2tag = (APE::Tag *) user_data;
 107   gboolean result;
 108
 109   /* FIXME: if there are several values set for the same tag, this won't
 110    * work, only the first value will be taken into account
 111    */
 112   if (strcmp (tag, GST_TAG_TITLE) == 0) {
 113     char *title;
 114
 115     result = gst_tag_list_get_string_index (list, tag, 0, &title);
 116     if (result != FALSE) {
 117       GST_DEBUG ("Setting title to %s", title);
 118       apev2tag->setTitle (String::String (title, String::UTF8));
 119     }
 120     g_free (title);
 121   } else if (strcmp (tag, GST_TAG_ALBUM) == 0) {
 122     char *album;
 123
 124     result = gst_tag_list_get_string_index (list, tag, 0, &album);
 125     if (result != FALSE) {
 126       GST_DEBUG ("Setting album to %s", album);
 127       apev2tag->setAlbum (String::String (album, String::UTF8));
 128     }
 129     g_free (album);
 130   } else if (strcmp (tag, GST_TAG_ARTIST) == 0) {
 131     char *artist;
 132
 133     result = gst_tag_list_get_string_index (list, tag, 0, &artist);
 134     if (result != FALSE) {
 135       GST_DEBUG ("Setting artist to %s", artist);
 136       apev2tag->setArtist (String::String (artist, String::UTF8));
 137     }
 138     g_free (artist);
 139   } else if (strcmp (tag, GST_TAG_COMPOSER) == 0) {
 140     char *composer;
 141
 142     result = gst_tag_list_get_string_index (list, tag, 0, &composer);
 143     if (result != FALSE) {
 144       GST_DEBUG ("Setting composer to %s", composer);
 145       apev2tag->addValue (String::String ("COMPOSER", String::UTF8),
 146           String::String (composer, String::UTF8));
 147     }
 148     g_free (composer);
 149   } else if (strcmp (tag, GST_TAG_GENRE) == 0) {
 150     char *genre;
 151
 152     result = gst_tag_list_get_string_index (list, tag, 0, &genre);
 153     if (result != FALSE) {
 154       GST_DEBUG ("Setting genre to %s", genre);
 155       apev2tag->setGenre (String::String (genre, String::UTF8));
 156     }
 157     g_free (genre);
 158   } else if (strcmp (tag, GST_TAG_COMMENT) == 0) {
 159     char *comment;
 160
 161     result = gst_tag_list_get_string_index (list, tag, 0, &comment);
 162     if (result != FALSE) {
 163       GST_DEBUG ("Setting comment to %s", comment);
 164       apev2tag->setComment (String::String (comment, String::UTF8));
 165     }
 166     g_free (comment);
 167   } else if (strcmp (tag, GST_TAG_DATE) == 0) {
 168     GDate *date;
 169
 170     result = gst_tag_list_get_date_index (list, tag, 0, &date);
 171     if (result != FALSE) {
 172       GDateYear year;
 173
 174       year = g_date_get_year (date);
 175       GST_DEBUG ("Setting track year to %d", year);
 176       apev2tag->setYear (year);
 177       g_date_free (date);
 178     }
 179   } else if (strcmp (tag, GST_TAG_TRACK_NUMBER) == 0) {
 180     guint track_number;
 181
 182     result = gst_tag_list_get_uint_index (list, tag, 0, &track_number);
 183     if (result != FALSE) {
 184       guint total_tracks;
 185
 186       result = gst_tag_list_get_uint_index (list, GST_TAG_TRACK_COUNT,
 187           0, &total_tracks);
 188       if (result) {
 189         gchar *tag_str;
 190
 191         tag_str = g_strdup_printf ("%d/%d", track_number, total_tracks);
 192         GST_DEBUG ("Setting track number to %s", tag_str);
 193         apev2tag->addValue (String::String ("TRACK", String::UTF8),
 194             String::String (tag_str, String::UTF8), true);
 195         g_free (tag_str);
 196       } else {
 197         GST_DEBUG ("Setting track number to %d", track_number);
 198         apev2tag->setTrack (track_number);
 199       }
 200     }
 201   } else if (strcmp (tag, GST_TAG_TRACK_COUNT) == 0) {
 202     guint n;
 203
 204     if (gst_tag_list_get_uint_index (list, GST_TAG_TRACK_NUMBER, 0, &n)) {
 205       GST_DEBUG ("track-count handled with track-number, skipping");
 206     } else if (gst_tag_list_get_uint_index (list, GST_TAG_TRACK_COUNT, 0, &n)) {
 207       gchar *tag_str;
 208
 209       tag_str = g_strdup_printf ("0/%d", n);
 210       GST_DEBUG ("Setting track number to %s", tag_str);
 211       apev2tag->addValue (String::String ("TRACK", String::UTF8),
 212           String::String (tag_str, String::UTF8), true);
 213       g_free (tag_str);
 214     }
 215 #if 0
 216   } else if (strcmp (tag, GST_TAG_ALBUM_VOLUME_NUMBER) == 0) {
 217     guint volume_number;
 218
 219     result = gst_tag_list_get_uint_index (list, tag, 0, &volume_number);
 220
 221     if (result != FALSE) {
 222       guint volume_count;
 223       gchar *tag_str;
 224
 225       result = gst_tag_list_get_uint_index (list, GST_TAG_ALBUM_VOLUME_COUNT,
 226           0, &volume_count);
 227
 228       if (result) {
 229         tag_str = g_strdup_printf ("CD %d/%d", volume_number, volume_count);
 230       } else {
 231         tag_str = g_strdup_printf ("CD %d", volume_number);
 232       }
 233
 234       GST_DEBUG ("Setting album number to %s", tag_str);
 235
 236       apev2tag->addValue (String::String ("MEDIA", String::UTF8),
 237           String::String (tag_str, String::UTF8), true);
 238       g_free (tag_str);
 239     }
 240   } else if (strcmp (tag, GST_TAG_ALBUM_VOLUME_COUNT) == 0) {
 241     guint n;
 242
 243     if (gst_tag_list_get_uint_index (list, GST_TAG_ALBUM_VOLUME_NUMBER, 0, &n)) {
 244       GST_DEBUG ("volume-count handled with volume-number, skipping");
 245     } else if (gst_tag_list_get_uint_index (list, GST_TAG_ALBUM_VOLUME_COUNT,
 246             0, &n)) {
 247       gchar *tag_str;
 248
 249       tag_str = g_strdup_printf ("CD 0/%u", n);
 250       GST_DEBUG ("Setting album volume number/count to %s", tag_str);
 251
 252       apev2tag->addValue (String::String ("MEDIA", String::UTF8),
 253           String::String (tag_str, String::UTF8), true);
 254       g_free (tag_str);
 255     }
 256 #endif
 257   } else if (strcmp (tag, GST_TAG_COPYRIGHT) == 0) {
 258     gchar *copyright;
 259
 260     result = gst_tag_list_get_string_index (list, tag, 0, &copyright);
 261
 262     if (result != FALSE) {
 263       GST_DEBUG ("Setting copyright to %s", copyright);
 264       apev2tag->addValue (String::String ("COPYRIGHT", String::UTF8),
 265           String::String (copyright, String::UTF8), true);
 266       g_free (copyright);
 267     }
 268   } else if (strcmp (tag, GST_TAG_LOCATION) == 0) {
 269     gchar *location;
 270
 271     result = gst_tag_list_get_string_index (list, tag, 0, &location);
 272
 273     if (result != FALSE) {
 274       GST_DEBUG ("Setting location to %s", location);
 275       apev2tag->addValue (String::String ("FILE", String::UTF8),
 276           String::String (location, String::UTF8), true);
 277       g_free (location);
 278     }
 279   } else if (strcmp (tag, GST_TAG_ISRC) == 0) {
 280     gchar *isrc;
 281
 282     result = gst_tag_list_get_string_index (list, tag, 0, &isrc);
 283
 284     if (result != FALSE) {
 285       GST_DEBUG ("Setting ISRC to %s", isrc);
 286       apev2tag->addValue (String::String ("ISRC", String::UTF8),
 287           String::String (isrc, String::UTF8), true);
 288       g_free (isrc);
 289     }
 290   } else if (strcmp (tag, GST_TAG_TRACK_GAIN) == 0) {
 291     gdouble value;
 292
 293     result = gst_tag_list_get_double_index (list, tag, 0, &value);
 294
 295     if (result != FALSE) {
 296       gchar *track_gain = (gchar *) g_malloc0 (G_ASCII_DTOSTR_BUF_SIZE);
 297
 298       track_gain = g_ascii_dtostr (track_gain, G_ASCII_DTOSTR_BUF_SIZE, value);
 299       GST_DEBUG ("Setting track gain to %s", track_gain);
 300       apev2tag->addValue (String::String ("REPLAYGAIN_TRACK_GAIN",
 301               String::UTF8), String::String (track_gain, String::UTF8), true);
 302       g_free (track_gain);
 303     }
 304   } else if (strcmp (tag, GST_TAG_TRACK_PEAK) == 0) {
 305     gdouble value;
 306
 307     result = gst_tag_list_get_double_index (list, tag, 0, &value);
 308
 309     if (result != FALSE) {
 310       gchar *track_peak = (gchar *) g_malloc0 (G_ASCII_DTOSTR_BUF_SIZE);
 311
 312       track_peak = g_ascii_dtostr (track_peak, G_ASCII_DTOSTR_BUF_SIZE, value);
 313       GST_DEBUG ("Setting track peak to %s", track_peak);
 314       apev2tag->addValue (String::String ("REPLAYGAIN_TRACK_PEAK",
 315               String::UTF8), String::String (track_peak, String::UTF8), true);
 316       g_free (track_peak);
 317     }
 318   } else if (strcmp (tag, GST_TAG_ALBUM_GAIN) == 0) {
 319     gdouble value;
 320
 321     result = gst_tag_list_get_double_index (list, tag, 0, &value);
 322
 323     if (result != FALSE) {
 324       gchar *album_gain = (gchar *) g_malloc0 (G_ASCII_DTOSTR_BUF_SIZE);
 325
 326       album_gain = g_ascii_dtostr (album_gain, G_ASCII_DTOSTR_BUF_SIZE, value);
 327       GST_DEBUG ("Setting album gain to %s", album_gain);
 328       apev2tag->addValue (String::String ("REPLAYGAIN_ALBUM_GAIN",
 329               String::UTF8), String::String (album_gain, String::UTF8), true);
 330       g_free (album_gain);
 331     }
 332   } else if (strcmp (tag, GST_TAG_ALBUM_PEAK) == 0) {
 333     gdouble value;
 334
 335     result = gst_tag_list_get_double_index (list, tag, 0, &value);
 336
 337     if (result != FALSE) {
 338       gchar *album_peak = (gchar *) g_malloc0 (G_ASCII_DTOSTR_BUF_SIZE);
 339
 340       album_peak = g_ascii_dtostr (album_peak, G_ASCII_DTOSTR_BUF_SIZE, value);
 341       GST_DEBUG ("Setting album peak to %s", album_peak);
 342       apev2tag->addValue (String::String ("REPLAYGAIN_ALBUM_PEAK",
 343               String::UTF8), String::String (album_peak, String::UTF8), true);
 344       g_free (album_peak);
 345     }
 346   } else {
 347     GST_WARNING ("Unsupported tag: %s", tag);
 348   }
 349 }
 350
 351 static GstBuffer *
 352 gst_apev2_mux_render_tag (GstTagLibMux * mux, GstTagList * taglist)
 353 {
 354   APE::Tag apev2tag;
 355   ByteVector rendered_tag;
 356   GstBuffer *buf;
 357   guint tag_size;
 358
 359   /* Render the tag */
 360   gst_tag_list_foreach (taglist, add_one_tag, &apev2tag);
 361
 362   rendered_tag = apev2tag.render ();
 363   tag_size = rendered_tag.size ();
 364
 365   GST_LOG_OBJECT (mux, "tag size = %d bytes", tag_size);
 366
 367   /* Create buffer with tag */
 368   buf = gst_buffer_new_and_alloc (tag_size);
 369   memcpy (GST_BUFFER_DATA (buf), rendered_tag.data (), tag_size);
 370   gst_buffer_set_caps (buf, GST_PAD_CAPS (mux->srcpad));
 371
 372   return buf;
 373 }
 374
 375 gboolean
 376 gst_apev2_mux_plugin_init (GstPlugin * plugin)
 377 {
 378   if (!gst_element_register (plugin, "apev2mux", GST_RANK_NONE,
 379           GST_TYPE_APEV2_MUX))
 380     return FALSE;
 381
 382   return TRUE;
 383 }