2 * Copyright (C) <1999> Erik Walthinsen <omega@cse.ogi.edu>
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., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
23 #include "gstshout2.h"
27 GST_DEBUG_CATEGORY (shout2_debug);
28 #define GST_CAT_DEFAULT shout2_debug
30 /* elementfactory information */
31 static GstElementDetails shout2send_details = {
34 "Sends data to an icecast server",
35 "Wim Taymans <wim.taymans@chello.be>\n" "Pedro Corte-Real <typo@netcabo.pt>\n"
36 "Zaheer Abbas Merali <zaheerabbas at merali dot org>"
40 /* Shout2send signals and args */
44 SIGNAL_CONNECTION_PROBLEM,
51 ARG_IP, /* the ip of the server */
52 ARG_PORT, /* the encoder port number on the server */
53 ARG_PASSWORD, /* the encoder password on the server */
54 ARG_PUBLIC, /* is this stream public? */
55 ARG_STREAMNAME, /* Name of the stream */
56 ARG_DESCRIPTION, /* Description of the stream */
57 ARG_GENRE, /* Genre of the stream */
59 ARG_PROTOCOL, /* Protocol to connect with */
61 ARG_MOUNT, /* mountpoint of stream (icecast only) */
62 ARG_URL, /* Url of stream (I'm guessing) */
63 ARG_SYNC /* Sync with clock */
66 static GstElementClass *parent_class = NULL;
68 static GstStaticPadTemplate sink_template = GST_STATIC_PAD_TEMPLATE ("sink",
71 GST_STATIC_CAPS ("application/ogg; "
72 "audio/mpeg, mpegversion = (int) 1, layer = (int) [ 1, 3 ]")
74 static void gst_shout2send_class_init (GstShout2sendClass * klass);
75 static void gst_shout2send_base_init (GstShout2sendClass * klass);
76 static void gst_shout2send_init (GstShout2send * shout2send);
78 static gboolean gst_shout2send_event (GstBaseSink * sink, GstEvent * event);
79 static GstFlowReturn gst_shout2send_render (GstBaseSink * sink,
82 static void gst_shout2send_set_property (GObject * object, guint prop_id,
83 const GValue * value, GParamSpec * pspec);
84 static void gst_shout2send_get_property (GObject * object, guint prop_id,
85 GValue * value, GParamSpec * pspec);
87 static GstStateChangeReturn gst_shout2send_change_state (GstElement * element,
88 GstStateChange transition);
89 static gboolean gst_shout2send_setcaps (GstPad * pad, GstCaps * caps);
91 static guint gst_shout2send_signals[LAST_SIGNAL] = { 0 };
93 #define GST_TYPE_SHOUT_PROTOCOL (gst_shout2send_protocol_get_type())
95 gst_shout2send_protocol_get_type (void)
97 static GType shout2send_protocol_type = 0;
98 static GEnumValue shout2send_protocol[] = {
99 {SHOUT2SEND_PROTOCOL_XAUDIOCAST, "1",
100 "Xaudiocast Protocol (icecast 1.3.x)"},
101 {SHOUT2SEND_PROTOCOL_ICY, "2", "Icy Protocol (ShoutCast)"},
102 {SHOUT2SEND_PROTOCOL_HTTP, "3", "Http Protocol (icecast 2.x)"},
106 if (!shout2send_protocol_type) {
107 shout2send_protocol_type =
108 g_enum_register_static ("GstShout2SendProtocol", shout2send_protocol);
112 return shout2send_protocol_type;
116 gst_shout2send_get_type (void)
118 static GType shout2send_type = 0;
120 if (!shout2send_type) {
121 static const GTypeInfo shout2send_info = {
122 sizeof (GstShout2sendClass),
123 (GBaseInitFunc) gst_shout2send_base_init,
125 (GClassInitFunc) gst_shout2send_class_init,
128 sizeof (GstShout2send),
130 (GInstanceInitFunc) gst_shout2send_init,
133 static const GInterfaceInfo tag_setter_info = {
140 g_type_register_static (GST_TYPE_BASE_SINK, "GstShout2send",
141 &shout2send_info, 0);
143 g_type_add_interface_static (shout2send_type, GST_TYPE_TAG_SETTER,
147 return shout2send_type;
151 gst_shout2send_base_init (GstShout2sendClass * klass)
153 GstElementClass *element_class = GST_ELEMENT_CLASS (klass);
155 element_class->change_state = gst_shout2send_change_state;
156 gst_element_class_add_pad_template (element_class,
157 gst_static_pad_template_get (&sink_template));
158 gst_element_class_set_details (element_class, &shout2send_details);
162 gst_shout2send_class_init (GstShout2sendClass * klass)
164 GObjectClass *gobject_class;
165 GstBaseSinkClass *gstbasesink_class;
167 gobject_class = (GObjectClass *) klass;
168 gstbasesink_class = (GstBaseSinkClass *) klass;
170 parent_class = g_type_class_ref (GST_TYPE_BASE_SINK);
172 gobject_class->set_property = gst_shout2send_set_property;
173 gobject_class->get_property = gst_shout2send_get_property;
175 g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_IP, g_param_spec_string ("ip", "ip", "ip", NULL, G_PARAM_READWRITE)); /* CHECKME */
176 g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_PORT, g_param_spec_int ("port", "port", "port", 1, G_MAXUSHORT, 8000, G_PARAM_READWRITE)); /* CHECKME */
178 g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_PASSWORD, g_param_spec_string ("password", "password", "password", NULL, G_PARAM_READWRITE)); /* CHECKME */
181 g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_STREAMNAME, g_param_spec_string ("streamname", "streamname", "name of the stream", NULL, G_PARAM_READWRITE)); /* CHECKME */
183 g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_DESCRIPTION, g_param_spec_string ("description", "description", "description", NULL, G_PARAM_READWRITE)); /* CHECKME */
185 g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_GENRE, g_param_spec_string ("genre", "genre", "genre", NULL, G_PARAM_READWRITE)); /* CHECKME */
187 g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_PROTOCOL,
188 g_param_spec_enum ("protocol", "protocol", "Connection Protocol to use",
189 GST_TYPE_SHOUT_PROTOCOL, SHOUT2SEND_PROTOCOL_HTTP,
194 g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_MOUNT, g_param_spec_string ("mount", "mount", "mount", NULL, G_PARAM_READWRITE)); /* CHECKME */
196 g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_URL, g_param_spec_string ("url", "url", "url", NULL, G_PARAM_READWRITE)); /* CHECKME */
199 g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_SYNC,
200 g_param_spec_boolean ("sync", "Sync", "Sync on the clock", FALSE,
204 gst_shout2send_signals[SIGNAL_CONNECTION_PROBLEM] =
205 g_signal_new ("connection-problem", G_TYPE_FROM_CLASS (klass),
206 G_SIGNAL_RUN_CLEANUP, G_STRUCT_OFFSET (GstShout2sendClass,
207 connection_problem), NULL, NULL, g_cclosure_marshal_VOID__INT,
208 G_TYPE_NONE, 1, G_TYPE_INT);
210 gstbasesink_class->render = GST_DEBUG_FUNCPTR (gst_shout2send_render);
211 gstbasesink_class->event = GST_DEBUG_FUNCPTR (gst_shout2send_event);
212 GST_DEBUG_CATEGORY_INIT (shout2_debug, "shout2", 0, "shout2send element");
216 gst_shout2send_init (GstShout2send * shout2send)
220 pad = GST_BASE_SINK_PAD (shout2send);
222 gst_pad_set_setcaps_function (pad, gst_shout2send_setcaps);
223 shout2send->clock = NULL;
224 shout2send->ip = g_strdup ("127.0.0.1");
225 shout2send->port = 8000;
226 shout2send->password = g_strdup ("hackme");
227 shout2send->streamname = g_strdup ("");
228 shout2send->description = g_strdup ("");
229 shout2send->genre = g_strdup ("");
230 shout2send->mount = g_strdup ("");
231 shout2send->url = g_strdup ("");
232 shout2send->tags = gst_tag_list_new ();
233 shout2send->protocol = SHOUT2SEND_PROTOCOL_HTTP;
234 shout2send->conn = NULL;
235 shout2send->audio_format = SHOUT_FORMAT_VORBIS;
236 shout2send->sync = FALSE;
237 shout2send->started = FALSE;
242 set_shout_metadata (const GstTagList * list, const gchar * tag,
245 char **shout_metadata = (char **) user_data;
248 GST_DEBUG ("tag: %s being added", tag);
249 if (strcmp (tag, GST_TAG_ARTIST) == 0) {
250 if (gst_tag_get_type (tag) == G_TYPE_STRING) {
251 if (!gst_tag_list_get_string (list, tag, &value)) {
252 GST_DEBUG ("Error reading \"%s\" tag value\n", tag);
255 /* shout_metadata should be NULL if title is after artist in list */
256 if (*shout_metadata == NULL) {
257 *shout_metadata = g_strdup (value);
259 temp = g_strdup_printf ("%s - %s", value, *shout_metadata);
260 g_free (*shout_metadata);
261 *shout_metadata = temp;
265 } else if (strcmp (tag, GST_TAG_TITLE) == 0) {
266 if (gst_tag_get_type (tag) == G_TYPE_STRING) {
267 if (!gst_tag_list_get_string (list, tag, &value)) {
268 GST_DEBUG ("Error reading \"%s\" tag value\n", tag);
271 /* shout_metadata should be NULL if title is before artist in list */
272 if (*shout_metadata == NULL) {
273 *shout_metadata = g_strdup (value);
275 temp = g_strdup_printf ("%s - %s", *shout_metadata, value);
276 g_free (*shout_metadata);
277 *shout_metadata = temp;
281 GST_DEBUG ("shout metadata is now: %s", *shout_metadata);
285 gst_shout2send_set_metadata (GstShout2send * shout2send)
288 const GstTagList *user_tags;
291 shout_metadata_t *pmetadata;
293 g_return_if_fail (shout2send != NULL);
294 user_tags = gst_tag_setter_get_list (GST_TAG_SETTER (shout2send));
296 if ((shout2send->tags == NULL) && (user_tags == NULL)) {
299 copy = gst_tag_list_merge (user_tags, shout2send->tags,
300 gst_tag_setter_get_merge_mode (GST_TAG_SETTER (shout2send)));
302 /* lets get the artist and song tags */
304 gst_tag_list_foreach ((GstTagList *) copy, set_shout_metadata,
305 (gpointer) & tempmetadata);
307 pmetadata = shout_metadata_new ();
308 shout_metadata_add (pmetadata, "song", tempmetadata);
309 shout_set_metadata (shout2send->conn, pmetadata);
310 shout_metadata_free (pmetadata);
313 gst_tag_list_free (copy);
319 gst_shout2send_event (GstBaseSink * sink, GstEvent * event)
321 GstShout2send *shout2send;
322 shout_metadata_t *pmetadata;
325 shout2send = GST_SHOUT2SEND (sink);
327 switch (GST_EVENT_TYPE (event)) {
329 GST_DEBUG ("tag event received");
330 /* vorbis audio doesnt need metadata setting on the icecast level, only mp3 */
331 if (shout2send->tags && shout2send->audio_format == SHOUT_FORMAT_MP3) {
334 gst_event_parse_tag (event, &list);
336 gst_tag_list_insert (shout2send->tags,
337 list, gst_tag_setter_get_merge_mode (GST_TAG_SETTER (shout2send)));
338 /* lets get the artist and song tags */
340 gst_tag_list_foreach ((GstTagList *) shout2send->tags,
341 set_shout_metadata, (gpointer) & tempmetadata);
343 GST_DEBUG ("shout metadata now: %s", tempmetadata);
344 pmetadata = shout_metadata_new ();
345 shout_metadata_add (pmetadata, "song", tempmetadata);
346 shout_set_metadata (shout2send->conn, pmetadata);
347 shout_metadata_free (pmetadata);
352 GST_DEBUG ("some other event received");
360 gst_shout2send_render (GstBaseSink * sink, GstBuffer * buf)
362 GstShout2send *shout2send;
366 shout2send = GST_SHOUT2SEND (sink);
368 if (shout2send->clock && shout2send->sync) {
369 //GST_DEBUG("using GStreamer clock to sync");
370 //gst_element_wait (GST_ELEMENT (shout2send), GST_BUFFER_TIMESTAMP (buf));
372 //GST_DEBUG("using libshout to sync");
373 shout_sync (shout2send->conn);
375 ret = shout_send (shout2send->conn, GST_BUFFER_DATA (buf),
376 GST_BUFFER_SIZE (buf));
377 if (ret != SHOUTERR_SUCCESS) {
378 GST_WARNING ("send error: %s...\n", shout_get_error (shout2send->conn));
379 g_signal_emit (G_OBJECT (shout2send),
380 gst_shout2send_signals[SIGNAL_CONNECTION_PROBLEM], 0,
381 shout_get_errno (shout2send->conn));
388 gst_shout2send_set_property (GObject * object, guint prop_id,
389 const GValue * value, GParamSpec * pspec)
391 GstShout2send *shout2send;
393 g_return_if_fail (GST_IS_SHOUT2SEND (object));
394 shout2send = GST_SHOUT2SEND (object);
400 g_free (shout2send->ip);
401 shout2send->ip = g_strdup (g_value_get_string (value));
405 shout2send->port = g_value_get_int (value);
409 if (shout2send->password)
410 g_free (shout2send->password);
411 shout2send->password = g_strdup (g_value_get_string (value));
414 case ARG_STREAMNAME: /* Name of the stream */
415 if (shout2send->streamname)
416 g_free (shout2send->streamname);
417 shout2send->streamname = g_strdup (g_value_get_string (value));
420 case ARG_DESCRIPTION: /* Description of the stream */
421 if (shout2send->description)
422 g_free (shout2send->description);
423 shout2send->description = g_strdup (g_value_get_string (value));
426 case ARG_GENRE: /* Genre of the stream */
427 if (shout2send->genre)
428 g_free (shout2send->genre);
429 shout2send->genre = g_strdup (g_value_get_string (value));
432 case ARG_PROTOCOL: /* protocol to connect with */
433 shout2send->protocol = g_value_get_enum (value);
436 case ARG_MOUNT: /* mountpoint of stream (icecast only) */
437 if (shout2send->mount)
438 g_free (shout2send->mount);
439 shout2send->mount = g_strdup (g_value_get_string (value));
442 case ARG_URL: /* Url of the stream (I'm guessing) */
444 g_free (shout2send->url);
445 shout2send->url = g_strdup (g_value_get_string (value));
448 shout2send->sync = g_value_get_boolean (value);
456 gst_shout2send_get_property (GObject * object, guint prop_id, GValue * value,
459 GstShout2send *shout2send;
461 g_return_if_fail (GST_IS_SHOUT2SEND (object));
462 shout2send = GST_SHOUT2SEND (object);
467 g_value_set_string (value, shout2send->ip);
470 g_value_set_int (value, shout2send->port);
473 g_value_set_string (value, shout2send->password);
476 case ARG_STREAMNAME: /* Name of the stream */
477 g_value_set_string (value, shout2send->streamname);
480 case ARG_DESCRIPTION: /* Description of the stream */
481 g_value_set_string (value, shout2send->description);
484 case ARG_GENRE: /* Genre of the stream */
485 g_value_set_string (value, shout2send->genre);
488 case ARG_PROTOCOL: /* protocol to connect with */
489 g_value_set_enum (value, shout2send->protocol);
492 case ARG_MOUNT: /* mountpoint of stream (icecast only) */
493 g_value_set_string (value, shout2send->mount);
496 case ARG_URL: /* Url of stream (I'm guessing) */
497 g_value_set_string (value, shout2send->url);
499 case ARG_SYNC: /* Sync to clock */
500 g_value_set_boolean (value, shout2send->sync);
503 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
509 gst_shout2send_setcaps (GstPad * pad, GstCaps * caps)
511 const gchar *mimetype;
512 GstShout2send *shout2send;
515 shout2send = GST_SHOUT2SEND (GST_OBJECT_PARENT (pad));
516 mimetype = gst_structure_get_name (gst_caps_get_structure (caps, 0));
517 GST_DEBUG ("in setcaps function, mimetype of caps given is: %s", mimetype);
518 if (!strcmp (mimetype, "audio/mpeg")) {
519 shout2send->audio_format = SHOUT_FORMAT_MP3;
522 if (!strcmp (mimetype, "application/ogg")) {
523 shout2send->audio_format = SHOUT_FORMAT_VORBIS;
527 gst_caps_unref (caps);
533 static GstStateChangeReturn
534 gst_shout2send_change_state (GstElement * element, GstStateChange transition)
536 GstShout2send *shout2send;
537 GstStateChangeReturn ret;
539 guint major, minor, micro;
542 gchar *version_string;
544 g_return_val_if_fail (GST_IS_SHOUT2SEND (element), GST_STATE_CHANGE_FAILURE);
546 shout2send = GST_SHOUT2SEND (element);
548 GST_DEBUG ("state pending %d", GST_STATE_PENDING (element));
550 /* if going down into NULL state, close the file if it's open */
551 switch (transition) {
552 case GST_STATE_CHANGE_NULL_TO_READY:
553 shout2send->conn = shout_new ();
555 switch (shout2send->protocol) {
556 case SHOUT2SEND_PROTOCOL_XAUDIOCAST:
557 proto = SHOUT_PROTOCOL_XAUDIOCAST;
559 case SHOUT2SEND_PROTOCOL_ICY:
560 proto = SHOUT_PROTOCOL_ICY;
562 case SHOUT2SEND_PROTOCOL_HTTP:
563 proto = SHOUT_PROTOCOL_HTTP;
567 if (shout_set_protocol (shout2send->conn, proto) != SHOUTERR_SUCCESS) {
568 GST_DEBUG ("shout2send configured with protocol: %d",
569 shout2send->protocol);
570 g_error ("Error setting protocol: %s\n",
571 shout_get_error (shout2send->conn));
574 /* --- FIXME: shout requires an ip, and fails if it is given a host. */
575 /* may want to put convert_to_ip(shout2send->ip) here */
578 if (shout_set_host (shout2send->conn, shout2send->ip) != SHOUTERR_SUCCESS) {
579 g_error ("Error setting host: %s\n",
580 shout_get_error (shout2send->conn));
584 if (shout_set_port (shout2send->conn,
585 shout2send->port) != SHOUTERR_SUCCESS) {
586 g_error ("Error setting port: %s\n",
587 shout_get_error (shout2send->conn));
590 if (shout_set_password (shout2send->conn,
591 shout2send->password) != SHOUTERR_SUCCESS) {
592 g_error ("Error setting password: %s\n",
593 shout_get_error (shout2send->conn));
596 if (shout_set_name (shout2send->conn,
597 shout2send->streamname) != SHOUTERR_SUCCESS) {
598 g_error ("Error setting stream name: %s\n",
599 shout_get_error (shout2send->conn));
602 if (shout_set_description (shout2send->conn,
603 shout2send->description) != SHOUTERR_SUCCESS) {
604 g_error ("Error setting name: %s\n",
605 shout_get_error (shout2send->conn));
608 if (shout_set_genre (shout2send->conn,
609 shout2send->genre) != SHOUTERR_SUCCESS) {
610 g_error ("Error setting name: %s\n",
611 shout_get_error (shout2send->conn));
614 if (shout_set_mount (shout2send->conn,
615 shout2send->mount) != SHOUTERR_SUCCESS) {
616 g_error ("Error setting mount point: %s\n",
617 shout_get_error (shout2send->conn));
620 if (shout_set_user (shout2send->conn, "source") != SHOUTERR_SUCCESS) {
621 g_error ("Error setting user: %s\n",
622 shout_get_error (shout2send->conn));
625 gst_version (&major, &minor, µ);
628 g_strdup_printf ("GStreamer %d.%d.%d", major, minor, micro);
630 if (shout_set_agent (shout2send->conn,
631 version_string) != SHOUTERR_SUCCESS) {
632 g_error ("Error setting agent: %s\n",
633 shout_get_error (shout2send->conn));
636 g_free (version_string);
641 case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
643 case GST_STATE_CHANGE_READY_TO_PAUSED:
646 GST_DEBUG ("Connection format is: %s",
647 shout2send->audio_format == SHOUT_FORMAT_VORBIS ? "vorbis" :
648 (shout2send->audio_format == SHOUT_FORMAT_MP3 ? "mp3" : "unknown"));
649 if (shout_set_format (shout2send->conn,
650 shout2send->audio_format) != SHOUTERR_SUCCESS) {
651 GST_ERROR ("Error setting connection format: %s\n",
652 shout_get_error (shout2send->conn));
655 if (shout_open (shout2send->conn) == SHOUTERR_SUCCESS) {
656 g_print ("connected to server...\n");
657 /* lets set metadata */
658 gst_shout2send_set_metadata (shout2send);
661 GST_ERROR ("Couldn't connect to server: %s",
662 shout_get_error (shout2send->conn));
663 shout2send->conn = FALSE;
664 return GST_STATE_CHANGE_FAILURE;
673 ret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
675 switch (transition) {
676 case GST_STATE_CHANGE_PLAYING_TO_PAUSED:
678 case GST_STATE_CHANGE_PAUSED_TO_READY:
679 shout_close (shout2send->conn);
680 shout_free (shout2send->conn);
681 shout2send->started = FALSE;
683 case GST_STATE_CHANGE_READY_TO_NULL:
693 plugin_init (GstPlugin * plugin)
695 return gst_element_register (plugin, "shout2send", GST_RANK_NONE,
696 GST_TYPE_SHOUT2SEND);
699 GST_PLUGIN_DEFINE (GST_VERSION_MAJOR,
702 "Sends data to an icecast server using libshout2",
704 VERSION, "LGPL", "libshout2", "http://www.icecast.org/download.html")