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>
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.
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.
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.
23 * SECTION:element-apev2mux
24 * @see_also: #GstTagSetter
26 * This element adds APEv2 tags to the beginning of a stream using the taglib
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).
34 * <title>Example pipelines</title>
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.
41 * gst-launch -m filesrc location=foo.mp3 ! apedemux ! fakesink silent=TRUE 2> /dev/null | grep taglist
42 * ]| Verify that tags have been written.
50 #include "gstapev2mux.h"
55 #include <gst/tag/tag.h>
57 using namespace TagLib;
59 GST_DEBUG_CATEGORY_STATIC (gst_apev2_mux_debug);
60 #define GST_CAT_DEFAULT gst_apev2_mux_debug
62 static GstStaticPadTemplate src_template = GST_STATIC_PAD_TEMPLATE ("src",
65 GST_STATIC_CAPS ("application/x-apetag"));
67 static GstStaticPadTemplate sink_template = GST_STATIC_PAD_TEMPLATE ("sink",
70 GST_STATIC_CAPS ("ANY"));
72 G_DEFINE_TYPE (GstApev2Mux, gst_apev2_mux, GST_TYPE_TAG_MUX);
74 static GstBuffer *gst_apev2_mux_render_tag (GstTagMux * mux,
75 const GstTagList * taglist);
76 static GstBuffer *gst_apev2_mux_render_end_tag (GstTagMux * mux,
77 const GstTagList * taglist);
80 gst_apev2_mux_class_init (GstApev2MuxClass * klass)
82 GstElementClass *element_class = GST_ELEMENT_CLASS (klass);
84 GST_TAG_MUX_CLASS (klass)->render_start_tag =
85 GST_DEBUG_FUNCPTR (gst_apev2_mux_render_tag);
86 GST_TAG_MUX_CLASS (klass)->render_end_tag =
87 GST_DEBUG_FUNCPTR (gst_apev2_mux_render_end_tag);
89 gst_element_class_add_pad_template (element_class,
90 gst_static_pad_template_get (&sink_template));
91 gst_element_class_add_pad_template (element_class,
92 gst_static_pad_template_get (&src_template));
94 gst_element_class_set_details_simple (element_class,
95 "TagLib-based APEv2 Muxer", "Formatter/Metadata",
96 "Adds an APEv2 header to the beginning of files using taglib",
97 "Sebastian Dröge <slomo@circular-chaos.org>");
99 GST_DEBUG_CATEGORY_INIT (gst_apev2_mux_debug, "apev2mux", 0,
100 "taglib-based APEv2 tag muxer");
104 gst_apev2_mux_init (GstApev2Mux * apev2mux)
110 add_one_tag (const GstTagList * list, const gchar * tag, gpointer user_data)
112 APE::Tag * apev2tag = (APE::Tag *) user_data;
115 /* FIXME: if there are several values set for the same tag, this won't
116 * work, only the first value will be taken into account
118 if (strcmp (tag, GST_TAG_TITLE) == 0) {
121 result = gst_tag_list_peek_string_index (list, tag, 0, &title);
122 if (result != FALSE) {
123 GST_DEBUG ("Setting title to %s", title);
124 apev2tag->setTitle (String (title, String::UTF8));
126 } else if (strcmp (tag, GST_TAG_ALBUM) == 0) {
129 result = gst_tag_list_peek_string_index (list, tag, 0, &album);
130 if (result != FALSE) {
131 GST_DEBUG ("Setting album to %s", album);
132 apev2tag->setAlbum (String (album, String::UTF8));
134 } else if (strcmp (tag, GST_TAG_ARTIST) == 0) {
137 result = gst_tag_list_peek_string_index (list, tag, 0, &artist);
138 if (result != FALSE) {
139 GST_DEBUG ("Setting artist to %s", artist);
140 apev2tag->setArtist (String (artist, String::UTF8));
142 } else if (strcmp (tag, GST_TAG_COMPOSER) == 0) {
143 const char *composer;
145 result = gst_tag_list_peek_string_index (list, tag, 0, &composer);
146 if (result != FALSE) {
147 GST_DEBUG ("Setting composer to %s", composer);
148 apev2tag->addValue (String ("COMPOSER", String::UTF8),
149 String (composer, String::UTF8));
151 } else if (strcmp (tag, GST_TAG_GENRE) == 0) {
154 result = gst_tag_list_peek_string_index (list, tag, 0, &genre);
155 if (result != FALSE) {
156 GST_DEBUG ("Setting genre to %s", genre);
157 apev2tag->setGenre (String (genre, String::UTF8));
159 } else if (strcmp (tag, GST_TAG_COMMENT) == 0) {
162 result = gst_tag_list_peek_string_index (list, tag, 0, &comment);
163 if (result != FALSE) {
164 GST_DEBUG ("Setting comment to %s", comment);
165 apev2tag->setComment (String (comment, String::UTF8));
167 } else if (strcmp (tag, GST_TAG_DATE) == 0) {
170 result = gst_tag_list_get_date_index (list, tag, 0, &date);
171 if (result != FALSE) {
174 year = g_date_get_year (date);
175 GST_DEBUG ("Setting track year to %d", year);
176 apev2tag->setYear (year);
179 } else if (strcmp (tag, GST_TAG_TRACK_NUMBER) == 0) {
182 result = gst_tag_list_get_uint_index (list, tag, 0, &track_number);
183 if (result != FALSE) {
186 result = gst_tag_list_get_uint_index (list, GST_TAG_TRACK_COUNT,
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 ("TRACK", String::UTF8),
194 String (tag_str, String::UTF8), true);
197 GST_DEBUG ("Setting track number to %d", track_number);
198 apev2tag->setTrack (track_number);
201 } else if (strcmp (tag, GST_TAG_TRACK_COUNT) == 0) {
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)) {
209 tag_str = g_strdup_printf ("0/%d", n);
210 GST_DEBUG ("Setting track number to %s", tag_str);
211 apev2tag->addValue (String ("TRACK", String::UTF8),
212 String (tag_str, String::UTF8), true);
216 } else if (strcmp (tag, GST_TAG_ALBUM_VOLUME_NUMBER) == 0) {
219 result = gst_tag_list_get_uint_index (list, tag, 0, &volume_number);
221 if (result != FALSE) {
225 result = gst_tag_list_get_uint_index (list, GST_TAG_ALBUM_VOLUME_COUNT,
229 tag_str = g_strdup_printf ("CD %d/%d", volume_number, volume_count);
231 tag_str = g_strdup_printf ("CD %d", volume_number);
234 GST_DEBUG ("Setting album number to %s", tag_str);
236 apev2tag->addValue (String ("MEDIA", String::UTF8),
237 String (tag_str, String::UTF8), true);
240 } else if (strcmp (tag, GST_TAG_ALBUM_VOLUME_COUNT) == 0) {
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,
249 tag_str = g_strdup_printf ("CD 0/%u", n);
250 GST_DEBUG ("Setting album volume number/count to %s", tag_str);
252 apev2tag->addValue (String ("MEDIA", String::UTF8),
253 String (tag_str, String::UTF8), true);
257 } else if (strcmp (tag, GST_TAG_COPYRIGHT) == 0) {
258 const gchar *copyright;
260 result = gst_tag_list_peek_string_index (list, tag, 0, ©right);
262 if (result != FALSE) {
263 GST_DEBUG ("Setting copyright to %s", copyright);
264 apev2tag->addValue (String ("COPYRIGHT", String::UTF8),
265 String (copyright, String::UTF8), true);
267 } else if (strcmp (tag, GST_TAG_LOCATION) == 0) {
268 const gchar *location;
270 result = gst_tag_list_peek_string_index (list, tag, 0, &location);
272 if (result != FALSE) {
273 GST_DEBUG ("Setting location to %s", location);
274 apev2tag->addValue (String ("FILE", String::UTF8),
275 String (location, String::UTF8), true);
277 } else if (strcmp (tag, GST_TAG_ISRC) == 0) {
280 result = gst_tag_list_peek_string_index (list, tag, 0, &isrc);
282 if (result != FALSE) {
283 GST_DEBUG ("Setting ISRC to %s", isrc);
284 apev2tag->addValue (String ("ISRC", String::UTF8),
285 String (isrc, String::UTF8), true);
287 } else if (strcmp (tag, GST_TAG_TRACK_GAIN) == 0) {
290 result = gst_tag_list_get_double_index (list, tag, 0, &value);
292 if (result != FALSE) {
293 gchar *track_gain = (gchar *) g_malloc0 (G_ASCII_DTOSTR_BUF_SIZE);
295 track_gain = g_ascii_dtostr (track_gain, G_ASCII_DTOSTR_BUF_SIZE, value);
296 GST_DEBUG ("Setting track gain to %s", track_gain);
297 apev2tag->addValue (String ("REPLAYGAIN_TRACK_GAIN",
298 String::UTF8), String (track_gain, String::UTF8), true);
301 } else if (strcmp (tag, GST_TAG_TRACK_PEAK) == 0) {
304 result = gst_tag_list_get_double_index (list, tag, 0, &value);
306 if (result != FALSE) {
307 gchar *track_peak = (gchar *) g_malloc0 (G_ASCII_DTOSTR_BUF_SIZE);
309 track_peak = g_ascii_dtostr (track_peak, G_ASCII_DTOSTR_BUF_SIZE, value);
310 GST_DEBUG ("Setting track peak to %s", track_peak);
311 apev2tag->addValue (String ("REPLAYGAIN_TRACK_PEAK",
312 String::UTF8), String (track_peak, String::UTF8), true);
315 } else if (strcmp (tag, GST_TAG_ALBUM_GAIN) == 0) {
318 result = gst_tag_list_get_double_index (list, tag, 0, &value);
320 if (result != FALSE) {
321 gchar *album_gain = (gchar *) g_malloc0 (G_ASCII_DTOSTR_BUF_SIZE);
323 album_gain = g_ascii_dtostr (album_gain, G_ASCII_DTOSTR_BUF_SIZE, value);
324 GST_DEBUG ("Setting album gain to %s", album_gain);
325 apev2tag->addValue (String ("REPLAYGAIN_ALBUM_GAIN",
326 String::UTF8), String (album_gain, String::UTF8), true);
329 } else if (strcmp (tag, GST_TAG_ALBUM_PEAK) == 0) {
332 result = gst_tag_list_get_double_index (list, tag, 0, &value);
334 if (result != FALSE) {
335 gchar *album_peak = (gchar *) g_malloc0 (G_ASCII_DTOSTR_BUF_SIZE);
337 album_peak = g_ascii_dtostr (album_peak, G_ASCII_DTOSTR_BUF_SIZE, value);
338 GST_DEBUG ("Setting album peak to %s", album_peak);
339 apev2tag->addValue (String ("REPLAYGAIN_ALBUM_PEAK",
340 String::UTF8), String (album_peak, String::UTF8), true);
344 GST_WARNING ("Unsupported tag: %s", tag);
349 gst_apev2_mux_render_tag (GstTagMux * mux, const GstTagList * taglist)
352 ByteVector rendered_tag;
357 gst_tag_list_foreach (taglist, add_one_tag, &apev2tag);
359 rendered_tag = apev2tag.render ();
360 tag_size = rendered_tag.size ();
362 GST_LOG_OBJECT (mux, "tag size = %d bytes", tag_size);
364 /* Create buffer with tag */
365 buf = gst_buffer_new_and_alloc (tag_size);
366 gst_buffer_fill (buf, 0, rendered_tag.data (), tag_size);
372 gst_apev2_mux_render_end_tag (GstTagMux * mux, const GstTagList * taglist)