gstreamer/ext/shout2/gstshout2.c
Zaheer Abbas Merali 1987170ab6 Port shout2 plugin
Original commit message from CVS:
2005-05-09  Zaheer Abbas Merali  <zaheerabbas at merali dot org>

* PORTED_09:
* configure.ac:
* ext/Makefile.am:
* ext/shout2/Makefile.am:
* ext/shout2/gstshout2.c: (gst_shout2send_get_type),
(gst_shout2send_base_init), (gst_shout2send_class_init),
(gst_shout2send_init), (gst_shout2send_event),
(gst_shout2send_render), (gst_shout2send_set_property),
(gst_shout2send_get_property), (gst_shout2send_setcaps),
(gst_shout2send_change_state):
* ext/shout2/gstshout2.h:

Port shout2 plugin
2005-05-09 20:09:44 +00:00

703 lines
22 KiB
C

/* GStreamer
* Copyright (C) <1999> Erik Walthinsen <omega@cse.ogi.edu>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public
* License along with this library; if not, write to the
* Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA.
*/
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
#include "gstshout2.h"
#include <stdlib.h>
#include <string.h>
GST_DEBUG_CATEGORY (shout2_debug);
#define GST_CAT_DEFAULT shout2_debug
/* elementfactory information */
static GstElementDetails shout2send_details = {
"An Icecast plugin",
"Sink/Network",
"Sends data to an icecast server",
"Wim Taymans <wim.taymans@chello.be>\n" "Pedro Corte-Real <typo@netcabo.pt>\n"
"Zaheer Abbas Merali <zaheerabbas at merali dot org>"
};
/* Shout2send signals and args */
enum
{
/* FILL ME */
SIGNAL_CONNECTION_PROBLEM,
LAST_SIGNAL
};
enum
{
ARG_0,
ARG_IP, /* the ip of the server */
ARG_PORT, /* the encoder port number on the server */
ARG_PASSWORD, /* the encoder password on the server */
ARG_PUBLIC, /* is this stream public? */
ARG_STREAMNAME, /* Name of the stream */
ARG_DESCRIPTION, /* Description of the stream */
ARG_GENRE, /* Genre of the stream */
ARG_PROTOCOL, /* Protocol to connect with */
ARG_MOUNT, /* mountpoint of stream (icecast only) */
ARG_URL, /* Url of stream (I'm guessing) */
ARG_SYNC /* Sync with clock */
};
static GstElementClass *parent_class = NULL;
static GstStaticPadTemplate sink_template = GST_STATIC_PAD_TEMPLATE ("sink",
GST_PAD_SINK,
GST_PAD_ALWAYS,
GST_STATIC_CAPS ("application/ogg; "
"audio/mpeg, mpegversion = (int) 1, layer = (int) [ 1, 3 ]")
);
static void gst_shout2send_class_init (GstShout2sendClass * klass);
static void gst_shout2send_base_init (GstShout2sendClass * klass);
static void gst_shout2send_init (GstShout2send * shout2send);
static gboolean gst_shout2send_event (GstBaseSink * sink, GstEvent * event);
static GstFlowReturn gst_shout2send_render (GstBaseSink * sink,
GstBuffer * buffer);
static void gst_shout2send_set_property (GObject * object, guint prop_id,
const GValue * value, GParamSpec * pspec);
static void gst_shout2send_get_property (GObject * object, guint prop_id,
GValue * value, GParamSpec * pspec);
static GstElementStateReturn gst_shout2send_change_state (GstElement * element);
static gboolean gst_shout2send_setcaps (GstPad * pad, GstCaps * caps);
static guint gst_shout2send_signals[LAST_SIGNAL] = { 0 };
#define GST_TYPE_SHOUT_PROTOCOL (gst_shout2send_protocol_get_type())
static GType
gst_shout2send_protocol_get_type (void)
{
static GType shout2send_protocol_type = 0;
static GEnumValue shout2send_protocol[] = {
{SHOUT2SEND_PROTOCOL_XAUDIOCAST, "1",
"Xaudiocast Protocol (icecast 1.3.x)"},
{SHOUT2SEND_PROTOCOL_ICY, "2", "Icy Protocol (ShoutCast)"},
{SHOUT2SEND_PROTOCOL_HTTP, "3", "Http Protocol (icecast 2.x)"},
{0, NULL, NULL},
};
if (!shout2send_protocol_type) {
shout2send_protocol_type =
g_enum_register_static ("GstShout2SendProtocol", shout2send_protocol);
}
return shout2send_protocol_type;
}
GType
gst_shout2send_get_type (void)
{
static GType shout2send_type = 0;
if (!shout2send_type) {
static const GTypeInfo shout2send_info = {
sizeof (GstShout2sendClass),
(GBaseInitFunc) gst_shout2send_base_init,
NULL,
(GClassInitFunc) gst_shout2send_class_init,
NULL,
NULL,
sizeof (GstShout2send),
0,
(GInstanceInitFunc) gst_shout2send_init,
};
static const GInterfaceInfo tag_setter_info = {
NULL,
NULL,
NULL
};
shout2send_type =
g_type_register_static (GST_TYPE_BASESINK, "GstShout2send",
&shout2send_info, 0);
g_type_add_interface_static (shout2send_type, GST_TYPE_TAG_SETTER,
&tag_setter_info);
}
return shout2send_type;
}
static void
gst_shout2send_base_init (GstShout2sendClass * klass)
{
GstElementClass *element_class = GST_ELEMENT_CLASS (klass);
element_class->change_state = gst_shout2send_change_state;
gst_element_class_add_pad_template (element_class,
gst_static_pad_template_get (&sink_template));
gst_element_class_set_details (element_class, &shout2send_details);
}
static void
gst_shout2send_class_init (GstShout2sendClass * klass)
{
GObjectClass *gobject_class;
GstBaseSinkClass *gstbasesink_class;
gobject_class = (GObjectClass *) klass;
gstbasesink_class = (GstBaseSinkClass *) klass;
parent_class = g_type_class_ref (GST_TYPE_BASESINK);
gobject_class->set_property = gst_shout2send_set_property;
gobject_class->get_property = gst_shout2send_get_property;
g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_IP, g_param_spec_string ("ip", "ip", "ip", NULL, G_PARAM_READWRITE)); /* CHECKME */
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 */
g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_PASSWORD, g_param_spec_string ("password", "password", "password", NULL, G_PARAM_READWRITE)); /* CHECKME */
/* metadata */
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 */
g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_DESCRIPTION, g_param_spec_string ("description", "description", "description", NULL, G_PARAM_READWRITE)); /* CHECKME */
g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_GENRE, g_param_spec_string ("genre", "genre", "genre", NULL, G_PARAM_READWRITE)); /* CHECKME */
g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_PROTOCOL,
g_param_spec_enum ("protocol", "protocol", "Connection Protocol to use",
GST_TYPE_SHOUT_PROTOCOL, SHOUT2SEND_PROTOCOL_HTTP,
G_PARAM_READWRITE));
/* icecast only */
g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_MOUNT, g_param_spec_string ("mount", "mount", "mount", NULL, G_PARAM_READWRITE)); /* CHECKME */
g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_URL, g_param_spec_string ("url", "url", "url", NULL, G_PARAM_READWRITE)); /* CHECKME */
/* sync to clock */
g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_SYNC,
g_param_spec_boolean ("sync", "Sync", "Sync on the clock", FALSE,
G_PARAM_READWRITE));
/* signals */
gst_shout2send_signals[SIGNAL_CONNECTION_PROBLEM] =
g_signal_new ("connection-problem", G_TYPE_FROM_CLASS (klass),
G_SIGNAL_RUN_CLEANUP, G_STRUCT_OFFSET (GstShout2sendClass,
connection_problem), NULL, NULL, g_cclosure_marshal_VOID__INT,
G_TYPE_NONE, 1, G_TYPE_INT);
gstbasesink_class->render = GST_DEBUG_FUNCPTR (gst_shout2send_render);
gstbasesink_class->event = GST_DEBUG_FUNCPTR (gst_shout2send_event);
GST_DEBUG_CATEGORY_INIT (shout2_debug, "shout2", 0, "shout2send element");
}
static void
gst_shout2send_init (GstShout2send * shout2send)
{
GstPad *pad;
pad = GST_BASESINK_PAD (shout2send);
gst_pad_set_setcaps_function (pad, gst_shout2send_setcaps);
shout2send->clock = NULL;
shout2send->ip = g_strdup ("127.0.0.1");
shout2send->port = 8000;
shout2send->password = g_strdup ("hackme");
shout2send->streamname = g_strdup ("");
shout2send->description = g_strdup ("");
shout2send->genre = g_strdup ("");
shout2send->mount = g_strdup ("");
shout2send->url = g_strdup ("");
shout2send->tags = gst_tag_list_new ();
shout2send->protocol = SHOUT2SEND_PROTOCOL_HTTP;
shout2send->conn = NULL;
shout2send->audio_format = SHOUT_FORMAT_VORBIS;
shout2send->sync = FALSE;
shout2send->started = FALSE;
}
static void
set_shout_metadata (const GstTagList * list, const gchar * tag,
gpointer user_data)
{
char **shout_metadata = (char **) user_data;
gchar *value, *temp;
GST_DEBUG ("tag: %s being added", tag);
if (strcmp (tag, GST_TAG_ARTIST) == 0) {
if (gst_tag_get_type (tag) == G_TYPE_STRING) {
if (!gst_tag_list_get_string (list, tag, &value)) {
GST_DEBUG ("Error reading \"%s\" tag value\n", tag);
return;
}
/* shout_metadata should be NULL if title is after artist in list */
if (*shout_metadata == NULL) {
*shout_metadata = g_strdup (value);
} else {
temp = g_strdup_printf ("%s - %s", value, *shout_metadata);
g_free (*shout_metadata);
*shout_metadata = temp;
}
}
} else if (strcmp (tag, GST_TAG_TITLE) == 0) {
if (gst_tag_get_type (tag) == G_TYPE_STRING) {
if (!gst_tag_list_get_string (list, tag, &value)) {
GST_DEBUG ("Error reading \"%s\" tag value\n", tag);
return;
}
/* shout_metadata should be NULL if title is before artist in list */
if (*shout_metadata == NULL) {
*shout_metadata = g_strdup (value);
} else {
temp = g_strdup_printf ("%s - %s", *shout_metadata, value);
g_free (*shout_metadata);
*shout_metadata = temp;
}
}
}
GST_DEBUG ("shout metadata is now: %s", *shout_metadata);
}
static void
gst_shout2send_set_metadata (GstShout2send * shout2send)
{
#if 0
const GstTagList *user_tags;
GstTagList *copy;
char *tempmetadata;
shout_metadata_t *pmetadata;
g_return_if_fail (shout2send != NULL);
user_tags = gst_tag_setter_get_list (GST_TAG_SETTER (shout2send));
if ((shout2send->tags == NULL) && (user_tags == NULL)) {
return;
}
copy = gst_tag_list_merge (user_tags, shout2send->tags,
gst_tag_setter_get_merge_mode (GST_TAG_SETTER (shout2send)));
/* lets get the artist and song tags */
tempmetadata = NULL;
gst_tag_list_foreach ((GstTagList *) copy, set_shout_metadata,
(gpointer) & tempmetadata);
if (tempmetadata) {
pmetadata = shout_metadata_new ();
shout_metadata_add (pmetadata, "song", tempmetadata);
shout_set_metadata (shout2send->conn, pmetadata);
shout_metadata_free (pmetadata);
}
gst_tag_list_free (copy);
#endif
}
static gboolean
gst_shout2send_event (GstBaseSink * sink, GstEvent * event)
{
GstShout2send *shout2send;
shout_metadata_t *pmetadata;
char *tempmetadata;
shout2send = GST_SHOUT2SEND (sink);
switch (GST_EVENT_TYPE (event)) {
case GST_EVENT_TAG:
GST_DEBUG ("tag event received");
/* vorbis audio doesnt need metadata setting on the icecast level, only mp3 */
if (shout2send->tags && shout2send->audio_format == SHOUT_FORMAT_MP3) {
gst_tag_list_insert (shout2send->tags,
gst_event_tag_get_list (event),
gst_tag_setter_get_merge_mode (GST_TAG_SETTER (shout2send)));
/* lets get the artist and song tags */
tempmetadata = NULL;
gst_tag_list_foreach ((GstTagList *) shout2send->tags,
set_shout_metadata, (gpointer) & tempmetadata);
if (tempmetadata) {
GST_DEBUG ("shout metadata now: %s", tempmetadata);
pmetadata = shout_metadata_new ();
shout_metadata_add (pmetadata, "song", tempmetadata);
shout_set_metadata (shout2send->conn, pmetadata);
shout_metadata_free (pmetadata);
}
}
break;
default:
GST_DEBUG ("some other event received");
break;
}
return TRUE;
}
static GstFlowReturn
gst_shout2send_render (GstBaseSink * sink, GstBuffer * buf)
{
GstShout2send *shout2send;
glong ret;
shout2send = GST_SHOUT2SEND (sink);
if (shout2send->clock && shout2send->sync) {
//GST_DEBUG("using GStreamer clock to sync");
gst_element_wait (GST_ELEMENT (shout2send), GST_BUFFER_TIMESTAMP (buf));
} else {
//GST_DEBUG("using libshout to sync");
shout_sync (shout2send->conn);
}
ret = shout_send (shout2send->conn, GST_BUFFER_DATA (buf),
GST_BUFFER_SIZE (buf));
if (ret != SHOUTERR_SUCCESS) {
GST_WARNING ("send error: %s...\n", shout_get_error (shout2send->conn));
g_signal_emit (G_OBJECT (shout2send),
gst_shout2send_signals[SIGNAL_CONNECTION_PROBLEM], 0,
shout_get_errno (shout2send->conn));
}
return GST_FLOW_OK;
}
static void
gst_shout2send_set_property (GObject * object, guint prop_id,
const GValue * value, GParamSpec * pspec)
{
GstShout2send *shout2send;
/* it's not null if we got it, but it might not be ours */
g_return_if_fail (GST_IS_SHOUT2SEND (object));
shout2send = GST_SHOUT2SEND (object);
switch (prop_id) {
case ARG_IP:
if (shout2send->ip)
g_free (shout2send->ip);
shout2send->ip = g_strdup (g_value_get_string (value));
break;
case ARG_PORT:
shout2send->port = g_value_get_int (value);
break;
case ARG_PASSWORD:
if (shout2send->password)
g_free (shout2send->password);
shout2send->password = g_strdup (g_value_get_string (value));
break;
case ARG_STREAMNAME: /* Name of the stream */
if (shout2send->streamname)
g_free (shout2send->streamname);
shout2send->streamname = g_strdup (g_value_get_string (value));
break;
case ARG_DESCRIPTION: /* Description of the stream */
if (shout2send->description)
g_free (shout2send->description);
shout2send->description = g_strdup (g_value_get_string (value));
break;
case ARG_GENRE: /* Genre of the stream */
if (shout2send->genre)
g_free (shout2send->genre);
shout2send->genre = g_strdup (g_value_get_string (value));
break;
case ARG_PROTOCOL: /* protocol to connect with */
shout2send->protocol = g_value_get_enum (value);
break;
case ARG_MOUNT: /* mountpoint of stream (icecast only) */
if (shout2send->mount)
g_free (shout2send->mount);
shout2send->mount = g_strdup (g_value_get_string (value));
break;
case ARG_URL: /* Url of the stream (I'm guessing) */
if (shout2send->url)
g_free (shout2send->url);
shout2send->url = g_strdup (g_value_get_string (value));
break;
case ARG_SYNC:
shout2send->sync = g_value_get_boolean (value);
break;
default:
break;
}
}
static void
gst_shout2send_get_property (GObject * object, guint prop_id, GValue * value,
GParamSpec * pspec)
{
GstShout2send *shout2send;
/* it's not null if we got it, but it might not be ours */
g_return_if_fail (GST_IS_SHOUT2SEND (object));
shout2send = GST_SHOUT2SEND (object);
switch (prop_id) {
case ARG_IP:
g_value_set_string (value, shout2send->ip);
break;
case ARG_PORT:
g_value_set_int (value, shout2send->port);
break;
case ARG_PASSWORD:
g_value_set_string (value, shout2send->password);
break;
case ARG_STREAMNAME: /* Name of the stream */
g_value_set_string (value, shout2send->streamname);
break;
case ARG_DESCRIPTION: /* Description of the stream */
g_value_set_string (value, shout2send->description);
break;
case ARG_GENRE: /* Genre of the stream */
g_value_set_string (value, shout2send->genre);
break;
case ARG_PROTOCOL: /* protocol to connect with */
g_value_set_enum (value, shout2send->protocol);
break;
case ARG_MOUNT: /* mountpoint of stream (icecast only) */
g_value_set_string (value, shout2send->mount);
break;
case ARG_URL: /* Url of stream (I'm guessing) */
g_value_set_string (value, shout2send->url);
break;
case ARG_SYNC: /* Sync to clock */
g_value_set_boolean (value, shout2send->sync);
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
break;
}
}
static gboolean
gst_shout2send_setcaps (GstPad * pad, GstCaps * caps)
{
const gchar *mimetype;
GstShout2send *shout2send;
gboolean ret = TRUE;
shout2send = GST_SHOUT2SEND (GST_OBJECT_PARENT (pad));
mimetype = gst_structure_get_name (gst_caps_get_structure (caps, 0));
GST_DEBUG ("in setcaps function, mimetype of caps given is: %s", mimetype);
if (!strcmp (mimetype, "audio/mpeg")) {
shout2send->audio_format = SHOUT_FORMAT_MP3;
}
if (!strcmp (mimetype, "application/ogg")) {
shout2send->audio_format = SHOUT_FORMAT_VORBIS;
} else {
ret = FALSE;
}
gst_caps_unref (caps);
return ret;
}
static GstElementStateReturn
gst_shout2send_change_state (GstElement * element)
{
GstShout2send *shout2send;
GstElementStateReturn ret;
guint major, minor, micro;
gshort proto = 3;
gchar *version_string;
g_return_val_if_fail (GST_IS_SHOUT2SEND (element), GST_STATE_FAILURE);
shout2send = GST_SHOUT2SEND (element);
GST_DEBUG ("state pending %d", GST_STATE_PENDING (element));
/* if going down into NULL state, close the file if it's open */
switch (GST_STATE_TRANSITION (element)) {
case GST_STATE_NULL_TO_READY:
shout2send->conn = shout_new ();
switch (shout2send->protocol) {
case SHOUT2SEND_PROTOCOL_XAUDIOCAST:
proto = SHOUT_PROTOCOL_XAUDIOCAST;
break;
case SHOUT2SEND_PROTOCOL_ICY:
proto = SHOUT_PROTOCOL_ICY;
break;
case SHOUT2SEND_PROTOCOL_HTTP:
proto = SHOUT_PROTOCOL_HTTP;
break;
}
if (shout_set_protocol (shout2send->conn, proto) != SHOUTERR_SUCCESS) {
GST_DEBUG ("shout2send configured with protocol: %d",
shout2send->protocol);
g_error ("Error setting protocol: %s\n",
shout_get_error (shout2send->conn));
}
/* --- FIXME: shout requires an ip, and fails if it is given a host. */
/* may want to put convert_to_ip(shout2send->ip) here */
if (shout_set_host (shout2send->conn, shout2send->ip) != SHOUTERR_SUCCESS) {
g_error ("Error setting host: %s\n",
shout_get_error (shout2send->conn));
}
/* --- */
if (shout_set_port (shout2send->conn,
shout2send->port) != SHOUTERR_SUCCESS) {
g_error ("Error setting port: %s\n",
shout_get_error (shout2send->conn));
}
if (shout_set_password (shout2send->conn,
shout2send->password) != SHOUTERR_SUCCESS) {
g_error ("Error setting password: %s\n",
shout_get_error (shout2send->conn));
}
if (shout_set_name (shout2send->conn,
shout2send->streamname) != SHOUTERR_SUCCESS) {
g_error ("Error setting stream name: %s\n",
shout_get_error (shout2send->conn));
}
if (shout_set_description (shout2send->conn,
shout2send->description) != SHOUTERR_SUCCESS) {
g_error ("Error setting name: %s\n",
shout_get_error (shout2send->conn));
}
if (shout_set_genre (shout2send->conn,
shout2send->genre) != SHOUTERR_SUCCESS) {
g_error ("Error setting name: %s\n",
shout_get_error (shout2send->conn));
}
if (shout_set_mount (shout2send->conn,
shout2send->mount) != SHOUTERR_SUCCESS) {
g_error ("Error setting mount point: %s\n",
shout_get_error (shout2send->conn));
}
if (shout_set_user (shout2send->conn, "source") != SHOUTERR_SUCCESS) {
g_error ("Error setting user: %s\n",
shout_get_error (shout2send->conn));
}
gst_version (&major, &minor, &micro);
version_string =
g_strdup_printf ("GStreamer %d.%d.%d", major, minor, micro);
if (shout_set_agent (shout2send->conn,
version_string) != SHOUTERR_SUCCESS) {
g_error ("Error setting agent: %s\n",
shout_get_error (shout2send->conn));
}
g_free (version_string);
break;
case GST_STATE_PAUSED_TO_PLAYING:
break;
case GST_STATE_READY_TO_PAUSED:
/* connect */
GST_DEBUG ("Connection format is: %s",
shout2send->audio_format == SHOUT_FORMAT_VORBIS ? "vorbis" :
(shout2send->audio_format == SHOUT_FORMAT_MP3 ? "mp3" : "unknown"));
if (shout_set_format (shout2send->conn,
shout2send->audio_format) != SHOUTERR_SUCCESS) {
GST_ERROR ("Error setting connection format: %s\n",
shout_get_error (shout2send->conn));
}
if (shout_open (shout2send->conn) == SHOUTERR_SUCCESS) {
g_print ("connected to server...\n");
/* lets set metadata */
gst_shout2send_set_metadata (shout2send);
} else {
GST_ERROR ("Couldn't connect to server: %s",
shout_get_error (shout2send->conn));
shout2send->conn = FALSE;
return GST_STATE_FAILURE;
}
break;
default:
break;
}
ret = GST_ELEMENT_CLASS (parent_class)->change_state (element);
switch (GST_STATE_TRANSITION (element)) {
case GST_STATE_PLAYING_TO_PAUSED:
break;
case GST_STATE_PAUSED_TO_READY:
shout_close (shout2send->conn);
shout_free (shout2send->conn);
shout2send->started = FALSE;
break;
case GST_STATE_READY_TO_NULL:
break;
default:
break;
}
return ret;
}
static gboolean
plugin_init (GstPlugin * plugin)
{
return gst_element_register (plugin, "shout2send", GST_RANK_NONE,
GST_TYPE_SHOUT2SEND);
}
GST_PLUGIN_DEFINE (GST_VERSION_MAJOR,
GST_VERSION_MINOR,
"shout2send",
"Sends data to an icecast server using libshout2",
plugin_init,
VERSION, "LGPL", "libshout2", "http://www.icecast.org/download.html")