1 /* GStreamer ID3 v1 and v2 muxer
2 *
3 * Copyright (C) 2006 Christophe Fergeau <teuf@gnome.org>
4 * Copyright (C) 2006-2012 Tim-Philipp Müller <tim centricular net>
5 * Copyright (C) 2009 Pioneers of the Inevitable <songbird@songbirdnest.com>
6 *
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Library General Public
9 * License as published by the Free Software Foundation; either
10 * version 2 of the License, or (at your option) any later version.
11 *
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Library General Public License for more details.
16 *
17 * You should have received a copy of the GNU Library General Public
18 * License along with this library; if not, write to the
19 * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
20 * Boston, MA 02110-1301, USA.
21 */
22
23 /**
24 * SECTION:element-id3mux
25 * @title: id3mux
26 * @see_also: #GstID3Demux, #GstTagSetter
27 *
28 * This element adds ID3v2 tags to the beginning of a stream, and ID3v1 tags
29 * to the end.
30 *
31 * It defaults to writing ID3 version 2.3.0 tags (since those are the most
32 * widely supported), but can optionally write version 2.4.0 tags.
33 *
34 * Applications can set the tags to write using the #GstTagSetter interface.
35 * Tags sent by upstream elements will be picked up automatically (and merged
36 * according to the merge mode set via the tag setter interface).
37 *
38 * ## Example pipelines
39 * |[
40 * gst-launch-1.0 -v filesrc location=foo.ogg ! decodebin ! audioconvert ! id3mux ! filesink location=foo.mp3
41 * ]| A pipeline that transcodes a file from Ogg/Vorbis to mp3 format with
42 * ID3 tags that contain the same metadata as the the Ogg/Vorbis file.
43 * Make sure the Ogg/Vorbis file actually has comments to preserve.
44 * |[
45 * gst-launch-1.0 -m filesrc location=foo.mp3 ! id3demux ! fakesink silent=TRUE
46 * ]| Verify that tags have been written.
47 *
48 */
49
50 #ifdef HAVE_CONFIG_H
51 #include <config.h>
52 #endif
53
54 #include "gstid3mux.h"
55 #include <gst/tag/tag.h>
56
57 #include <string.h>
58
59 GST_DEBUG_CATEGORY (gst_id3_mux_debug);
60 #define GST_CAT_DEFAULT gst_id3_mux_debug
61
62 enum
63 {
64 PROP_0,
65 PROP_WRITE_V1,
66 PROP_WRITE_V2,
67 PROP_V2_MAJOR_VERSION
68 };
69
70 #define DEFAULT_WRITE_V1 FALSE
71 #define DEFAULT_WRITE_V2 TRUE
72 #define DEFAULT_V2_MAJOR_VERSION 3
73
74 static GstStaticPadTemplate sink_template = GST_STATIC_PAD_TEMPLATE ("sink",
75 GST_PAD_SINK,
76 GST_PAD_ALWAYS,
77 GST_STATIC_CAPS ("ANY"));
78
79 static GstStaticPadTemplate src_template = GST_STATIC_PAD_TEMPLATE ("src",
80 GST_PAD_SRC,
81 GST_PAD_ALWAYS,
82 GST_STATIC_CAPS ("application/x-id3"));
83
84 G_DEFINE_TYPE (GstId3Mux, gst_id3_mux, GST_TYPE_TAG_MUX);
85
86 static GstBuffer *gst_id3_mux_render_v2_tag (GstTagMux * mux,
87 const GstTagList * taglist);
88 static GstBuffer *gst_id3_mux_render_v1_tag (GstTagMux * mux,
89 const GstTagList * taglist);
90
91 static void gst_id3_mux_set_property (GObject * object, guint prop_id,
92 const GValue * value, GParamSpec * pspec);
93 static void gst_id3_mux_get_property (GObject * object, guint prop_id,
94 GValue * value, GParamSpec * pspec);
95
96 static void
gst_id3_mux_class_init(GstId3MuxClass * klass)97 gst_id3_mux_class_init (GstId3MuxClass * klass)
98 {
99 GstElementClass *element_class = (GstElementClass *) klass;
100 GObjectClass *gobject_class = (GObjectClass *) klass;
101
102 gobject_class->set_property = gst_id3_mux_set_property;
103 gobject_class->get_property = gst_id3_mux_get_property;
104
105 g_object_class_install_property (gobject_class, PROP_WRITE_V1,
106 g_param_spec_boolean ("write-v1", "Write id3v1 tag",
107 "Write an id3v1 tag at the end of the file", DEFAULT_WRITE_V1,
108 G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_STATIC_STRINGS));
109
110 g_object_class_install_property (gobject_class, PROP_WRITE_V2,
111 g_param_spec_boolean ("write-v2", "Write id3v2 tag",
112 "Write an id3v2 tag at the start of the file", DEFAULT_WRITE_V2,
113 G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_STATIC_STRINGS));
114
115 g_object_class_install_property (gobject_class, PROP_V2_MAJOR_VERSION,
116 g_param_spec_int ("v2-version", "Version (3 or 4) of id3v2 tag",
117 "Set version (3 for id3v2.3, 4 for id3v2.4) of id3v2 tags",
118 3, 4, DEFAULT_V2_MAJOR_VERSION,
119 G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_STATIC_STRINGS));
120
121 GST_TAG_MUX_CLASS (klass)->render_start_tag =
122 GST_DEBUG_FUNCPTR (gst_id3_mux_render_v2_tag);
123 GST_TAG_MUX_CLASS (klass)->render_end_tag =
124 GST_DEBUG_FUNCPTR (gst_id3_mux_render_v1_tag);
125
126 gst_element_class_set_static_metadata (element_class,
127 "ID3 v1 and v2 Muxer", "Formatter/Metadata",
128 "Adds an ID3v2 header and ID3v1 footer to a file",
129 "Michael Smith <msmith@songbirdnest.com>, "
130 "Tim-Philipp Müller <tim centricular net>");
131
132 gst_element_class_add_static_pad_template (element_class, &sink_template);
133 gst_element_class_add_static_pad_template (element_class, &src_template);
134 }
135
136 static void
gst_id3_mux_init(GstId3Mux * id3mux)137 gst_id3_mux_init (GstId3Mux * id3mux)
138 {
139 id3mux->write_v1 = DEFAULT_WRITE_V1;
140 id3mux->write_v2 = DEFAULT_WRITE_V2;
141
142 id3mux->v2_major_version = DEFAULT_V2_MAJOR_VERSION;
143 }
144
145 static void
gst_id3_mux_set_property(GObject * object,guint prop_id,const GValue * value,GParamSpec * pspec)146 gst_id3_mux_set_property (GObject * object, guint prop_id,
147 const GValue * value, GParamSpec * pspec)
148 {
149 GstId3Mux *mux = GST_ID3_MUX (object);
150
151 switch (prop_id) {
152 case PROP_WRITE_V1:
153 mux->write_v1 = g_value_get_boolean (value);
154 break;
155 case PROP_WRITE_V2:
156 mux->write_v2 = g_value_get_boolean (value);
157 break;
158 case PROP_V2_MAJOR_VERSION:
159 mux->v2_major_version = g_value_get_int (value);
160 break;
161 default:
162 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
163 break;
164 }
165 }
166
167 static void
gst_id3_mux_get_property(GObject * object,guint prop_id,GValue * value,GParamSpec * pspec)168 gst_id3_mux_get_property (GObject * object, guint prop_id,
169 GValue * value, GParamSpec * pspec)
170 {
171 GstId3Mux *mux = GST_ID3_MUX (object);
172
173 switch (prop_id) {
174 case PROP_WRITE_V1:
175 g_value_set_boolean (value, mux->write_v1);
176 break;
177 case PROP_WRITE_V2:
178 g_value_set_boolean (value, mux->write_v2);
179 break;
180 case PROP_V2_MAJOR_VERSION:
181 g_value_set_int (value, mux->v2_major_version);
182 break;
183 default:
184 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
185 break;
186 }
187 }
188
189 static GstBuffer *
gst_id3_mux_render_v2_tag(GstTagMux * mux,const GstTagList * taglist)190 gst_id3_mux_render_v2_tag (GstTagMux * mux, const GstTagList * taglist)
191 {
192 GstId3Mux *id3mux = GST_ID3_MUX (mux);
193
194 if (id3mux->write_v2)
195 return id3_mux_render_v2_tag (mux, taglist, id3mux->v2_major_version);
196 else
197 return NULL;
198 }
199
200 static GstBuffer *
gst_id3_mux_render_v1_tag(GstTagMux * mux,const GstTagList * taglist)201 gst_id3_mux_render_v1_tag (GstTagMux * mux, const GstTagList * taglist)
202 {
203 GstId3Mux *id3mux = GST_ID3_MUX (mux);
204
205 if (id3mux->write_v1)
206 return id3_mux_render_v1_tag (mux, taglist);
207 else
208 return NULL;
209 }
210
211 static gboolean
plugin_init(GstPlugin * plugin)212 plugin_init (GstPlugin * plugin)
213 {
214 GST_DEBUG_CATEGORY_INIT (gst_id3_mux_debug, "id3mux", 0,
215 "ID3 v1 and v2 tag muxer");
216
217 if (!gst_element_register (plugin, "id3mux", GST_RANK_PRIMARY,
218 GST_TYPE_ID3_MUX))
219 return FALSE;
220
221 gst_tag_register_musicbrainz_tags ();
222
223 return TRUE;
224 }
225
226 GST_PLUGIN_DEFINE (GST_VERSION_MAJOR,
227 GST_VERSION_MINOR,
228 id3tag,
229 "ID3 v1 and v2 muxing plugin",
230 plugin_init, VERSION, "LGPL", GST_PACKAGE_NAME, GST_PACKAGE_ORIGIN);
231