ext/esd/esdmon.c

   1 /* GStreamer
   2  * Copyright (C) <2001,2002> Richard Boulton <richard-gst@tartarus.org>
   3  *
   4  * Based on example.c:
   5  * Copyright (C) <1999> Erik Walthinsen <omega@cse.ogi.edu>
   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., 59 Temple Place - Suite 330,
  20  * Boston, MA 02111-1307, USA.
  21  */
  22
  23 #ifdef HAVE_CONFIG_H
  24 #include "config.h"
  25 #endif
  26 #include "esdmon.h"
  27 #include <esd.h>
  28 #include <unistd.h>
  29
  30
  31 /* elementfactory information */
  32 static GstElementDetails esdmon_details = {
  33   "Esound audio monitor",
  34   "Source/Audio",
  35   "Monitors audio from an esound server",
  36   "Richard Boulton <richard-gst@tartarus.org>",
  37 };
  38
  39 /* Signals and args */
  40 enum
  41 {
  42   /* FILL ME */
  43   LAST_SIGNAL
  44 };
  45
  46 enum
  47 {
  48   ARG_0,
  49   ARG_DEPTH,
  50   ARG_BYTESPERREAD,
  51   ARG_CUROFFSET,
  52   ARG_CHANNELS,
  53   ARG_RATE,
  54   ARG_HOST
  55 };
  56
  57 static GstStaticPadTemplate src_factory = GST_STATIC_PAD_TEMPLATE ("src",
  58     GST_PAD_SRC,
  59     GST_PAD_ALWAYS,
  60     GST_STATIC_CAPS ("audio/x-raw-int, "
  61         "endianness = (int) " G_STRINGIFY (G_BYTE_ORDER) ", "
  62         "signed = (boolean) TRUE, "
  63         "width = (int) 16, "
  64         "depth = (int) 16, "
  65         "rate = [ 8000, 96000 ], "
  66         "channels = [ 1, 2 ]; "
  67         "audio/x-raw-int, "
  68         "signed = (boolean) FALSE, "
  69         "width = (int) 8, "
  70         "depth = (int) 8, " "rate = [ 8000, 96000 ], " "channels = [ 1, 2 ]")
  71     );
  72
  73 static void gst_esdmon_base_init (gpointer g_class);
  74 static void gst_esdmon_class_init (gpointer g_class, gpointer class_data);
  75 static void gst_esdmon_init (GTypeInstance * instance, gpointer g_class);
  76
  77 static gboolean gst_esdmon_open_audio (GstEsdmon * src);
  78 static void gst_esdmon_close_audio (GstEsdmon * src);
  79 static GstStateChangeReturn gst_esdmon_change_state (GstElement * element,
  80     GstStateChange transition);
  81 static gboolean gst_esdmon_sync_parms (GstEsdmon * esdmon);
  82
  83 static GstData *gst_esdmon_get (GstPad * pad);
  84
  85 static void gst_esdmon_set_property (GObject * object, guint prop_id,
  86     const GValue * value, GParamSpec * pspec);
  87 static void gst_esdmon_get_property (GObject * object, guint prop_id,
  88     GValue * value, GParamSpec * pspec);
  89
  90 #define GST_TYPE_ESDMON_DEPTHS (gst_esdmon_depths_get_type())
  91 static GType
  92 gst_esdmon_depths_get_type (void)
  93 {
  94   static GType esdmon_depths_type = 0;
  95   static GEnumValue esdmon_depths[] = {
  96     {8, "8", "8 Bits"},
  97     {16, "16", "16 Bits"},
  98     {0, NULL, NULL},
  99   };
 100
 101   if (!esdmon_depths_type) {
 102     esdmon_depths_type =
 103         g_enum_register_static ("GstEsdmonDepths", esdmon_depths);
 104   }
 105   return esdmon_depths_type;
 106 }
 107
 108 #define GST_TYPE_ESDMON_CHANNELS (gst_esdmon_channels_get_type())
 109 static GType
 110 gst_esdmon_channels_get_type (void)
 111 {
 112   static GType esdmon_channels_type = 0;
 113   static GEnumValue esdmon_channels[] = {
 114     {1, "1", "Mono"},
 115     {2, "2", "Stereo"},
 116     {0, NULL, NULL},
 117   };
 118
 119   if (!esdmon_channels_type) {
 120     esdmon_channels_type =
 121         g_enum_register_static ("GstEsdmonChannels", esdmon_channels);
 122   }
 123   return esdmon_channels_type;
 124 }
 125
 126
 127 static GstElementClass *parent_class = NULL;
 128
 129 /*static guint gst_esdmon_signals[LAST_SIGNAL] = { 0 }; */
 130
 131 GType
 132 gst_esdmon_get_type (void)
 133 {
 134   static GType esdmon_type = 0;
 135
 136   if (!esdmon_type) {
 137     static const GTypeInfo esdmon_info = {
 138       sizeof (GstEsdmonClass),
 139       gst_esdmon_base_init,
 140       NULL,
 141       gst_esdmon_class_init,
 142       NULL,
 143       NULL,
 144       sizeof (GstEsdmon),
 145       0,
 146       gst_esdmon_init,
 147     };
 148
 149     esdmon_type =
 150         g_type_register_static (GST_TYPE_ELEMENT, "GstEsdmon", &esdmon_info, 0);
 151   }
 152   return esdmon_type;
 153 }
 154
 155 static void
 156 gst_esdmon_base_init (gpointer g_class)
 157 {
 158   GstElementClass *element_class = GST_ELEMENT_CLASS (g_class);
 159
 160   gst_element_class_add_pad_template (element_class,
 161       gst_static_pad_template_get (&src_factory));
 162   gst_element_class_set_details (element_class, &esdmon_details);
 163 }
 164
 165 static void
 166 gst_esdmon_class_init (gpointer g_class, gpointer class_data)
 167 {
 168   GObjectClass *gobject_class = G_OBJECT_CLASS (g_class);
 169   GstElementClass *gstelement_class = GST_ELEMENT_CLASS (g_class);
 170
 171   parent_class = g_type_class_peek_parent (g_class);
 172
 173   g_object_class_install_property (gobject_class, ARG_BYTESPERREAD, g_param_spec_ulong ("bytes_per_read", "bytes_per_read", "bytes_per_read", 0, G_MAXULONG, 0, G_PARAM_READWRITE));    /* CHECKME */
 174   g_object_class_install_property (gobject_class, ARG_CUROFFSET, g_param_spec_ulong ("curoffset", "curoffset", "curoffset", 0, G_MAXULONG, 0, G_PARAM_READABLE));       /* CHECKME */
 175   g_object_class_install_property (gobject_class, ARG_DEPTH, g_param_spec_enum ("depth", "depth", "depth", GST_TYPE_ESDMON_DEPTHS, 16, G_PARAM_READWRITE));     /* CHECKME! */
 176   g_object_class_install_property (gobject_class, ARG_CHANNELS, g_param_spec_enum ("channels", "channels", "channels", GST_TYPE_ESDMON_CHANNELS, 2, G_PARAM_READWRITE));        /* CHECKME! */
 177   g_object_class_install_property (gobject_class, ARG_RATE, g_param_spec_int ("frequency", "frequency", "frequency", G_MININT, G_MAXINT, 0, G_PARAM_READWRITE));        /* CHECKME */
 178   g_object_class_install_property (gobject_class, ARG_HOST, g_param_spec_string ("host", "host", "host", NULL, G_PARAM_READWRITE));     /* CHECKME */
 179
 180   gobject_class->set_property = gst_esdmon_set_property;
 181   gobject_class->get_property = gst_esdmon_get_property;
 182
 183   gstelement_class->change_state = gst_esdmon_change_state;
 184 }
 185
 186 static void
 187 gst_esdmon_init (GTypeInstance * instance, gpointer g_class)
 188 {
 189   GstEsdmon *esdmon = GST_ESDMON (instance);
 190
 191   esdmon->srcpad =
 192       gst_pad_new_from_template (gst_element_class_get_pad_template
 193       (GST_ELEMENT_GET_CLASS (esdmon), "src"), "src");
 194   gst_pad_set_get_function (esdmon->srcpad, gst_esdmon_get);
 195   gst_pad_use_explicit_caps (esdmon->srcpad);
 196   gst_element_add_pad (GST_ELEMENT (esdmon), esdmon->srcpad);
 197
 198   esdmon->fd = -1;
 199   /* FIXME: get default from somewhere better than just putting them inline. */
 200   esdmon->depth = 16;
 201   esdmon->channels = 2;
 202   esdmon->frequency = 44100;
 203   esdmon->host = NULL;
 204   esdmon->bytes_per_read = 4096;
 205   esdmon->curoffset = 0;
 206   esdmon->basetime = 0;
 207   esdmon->samples_since_basetime = 0;
 208 }
 209
 210 static gboolean
 211 gst_esdmon_sync_parms (GstEsdmon * esdmon)
 212 {
 213   g_return_val_if_fail (esdmon != NULL, FALSE);
 214   g_return_val_if_fail (GST_IS_ESDMON (esdmon), FALSE);
 215
 216   if (esdmon->fd == -1)
 217     return TRUE;
 218
 219   /* Need to set fd to use new parameters: only way to do this is to reopen. */
 220   gst_esdmon_close_audio (esdmon);
 221   return gst_esdmon_open_audio (esdmon);
 222 }
 223
 224 static GstData *
 225 gst_esdmon_get (GstPad * pad)
 226 {
 227   GstEsdmon *esdmon;
 228   GstBuffer *buf;
 229   glong readbytes;
 230   glong readsamples;
 231
 232   g_return_val_if_fail (pad != NULL, NULL);
 233   esdmon = GST_ESDMON (gst_pad_get_parent (pad));
 234
 235   GST_DEBUG ("attempting to read something from esdmon");
 236
 237   buf = gst_buffer_new ();
 238   g_return_val_if_fail (buf, NULL);
 239
 240   GST_BUFFER_DATA (buf) = (gpointer) g_malloc (esdmon->bytes_per_read);
 241
 242   readbytes = read (esdmon->fd, GST_BUFFER_DATA (buf), esdmon->bytes_per_read);
 243
 244   if (readbytes == 0) {
 245     gst_element_set_eos (GST_ELEMENT (esdmon));
 246     return NULL;
 247   }
 248   if (!GST_PAD_CAPS (pad)) {
 249     GstCaps *caps = gst_caps_new_simple ("audio/x-raw-int",
 250         "endianness", G_TYPE_INT, G_BYTE_ORDER,
 251         "signed", G_TYPE_BOOLEAN, esdmon->depth == 8 ? FALSE : TRUE,
 252         "width", G_TYPE_INT, esdmon->depth,
 253         "depth", G_TYPE_INT, esdmon->depth,
 254         "rate", G_TYPE_INT, esdmon->frequency,
 255         "channels", G_TYPE_INT, esdmon->channels,
 256         NULL);
 257
 258     /* set caps on src pad */
 259     if (gst_pad_set_explicit_caps (esdmon->srcpad, caps) <= 0) {
 260       GST_ELEMENT_ERROR (esdmon, CORE, NEGOTIATION, (NULL), (NULL));
 261       gst_caps_free (caps);
 262       return NULL;
 263     }
 264     gst_caps_free (caps);
 265   }
 266
 267   GST_BUFFER_SIZE (buf) = readbytes;
 268   GST_BUFFER_OFFSET (buf) = esdmon->curoffset;
 269   GST_BUFFER_TIMESTAMP (buf) = esdmon->basetime +
 270       esdmon->samples_since_basetime * GST_SECOND / esdmon->frequency;
 271
 272   esdmon->curoffset += readbytes;
 273   readsamples = readbytes / esdmon->channels;
 274   if (esdmon->depth == 16)
 275     readsamples /= 2;
 276   esdmon->samples_since_basetime += readsamples;
 277
 278   GST_DEBUG ("pushed buffer from esdmon of %ld bytes, timestamp %"
 279       G_GINT64_FORMAT, readbytes, GST_BUFFER_TIMESTAMP (buf));
 280   return GST_DATA (buf);
 281 }
 282
 283 static void
 284 gst_esdmon_set_property (GObject * object, guint prop_id, const GValue * value,
 285     GParamSpec * pspec)
 286 {
 287   GstEsdmon *esdmon;
 288
 289   g_return_if_fail (GST_IS_ESDMON (object));
 290   esdmon = GST_ESDMON (object);
 291
 292   switch (prop_id) {
 293     case ARG_BYTESPERREAD:
 294       esdmon->bytes_per_read = g_value_get_ulong (value);
 295       /* No need to sync params - will just happen on next read. */
 296       break;
 297     case ARG_DEPTH:
 298       esdmon->depth = g_value_get_enum (value);
 299       gst_esdmon_sync_parms (esdmon);
 300       break;
 301     case ARG_CHANNELS:
 302       esdmon->channels = g_value_get_enum (value);
 303       gst_esdmon_sync_parms (esdmon);
 304       break;
 305     case ARG_RATE:
 306       /* Preserve the timestamps */
 307       esdmon->basetime =
 308           esdmon->samples_since_basetime * GST_SECOND / esdmon->frequency;
 309       esdmon->samples_since_basetime = 0;
 310
 311       /* Set the new frequency */
 312       esdmon->frequency = g_value_get_int (value);
 313       gst_esdmon_sync_parms (esdmon);
 314       break;
 315     case ARG_HOST:
 316       if (esdmon->host != NULL)
 317         g_free (esdmon->host);
 318       if (g_value_get_string (value) == NULL)
 319         esdmon->host = NULL;
 320       else
 321         esdmon->host = g_strdup (g_value_get_string (value));
 322       break;
 323     default:
 324       break;
 325   }
 326 }
 327
 328 static void
 329 gst_esdmon_get_property (GObject * object, guint prop_id, GValue * value,
 330     GParamSpec * pspec)
 331 {
 332   GstEsdmon *esdmon;
 333
 334   g_return_if_fail (GST_IS_ESDMON (object));
 335   esdmon = GST_ESDMON (object);
 336
 337   switch (prop_id) {
 338     case ARG_BYTESPERREAD:
 339       g_value_set_ulong (value, esdmon->bytes_per_read);
 340       break;
 341     case ARG_CUROFFSET:
 342       g_value_set_ulong (value, esdmon->curoffset);
 343       break;
 344     case ARG_DEPTH:
 345       g_value_set_enum (value, esdmon->depth);
 346       break;
 347     case ARG_CHANNELS:
 348       g_value_set_enum (value, esdmon->channels);
 349       break;
 350     case ARG_RATE:
 351       g_value_set_int (value, esdmon->frequency);
 352       break;
 353     case ARG_HOST:
 354       g_value_set_string (value, esdmon->host);
 355       break;
 356     default:
 357       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 358       break;
 359   }
 360 }
 361
 362 gboolean
 363 gst_esdmon_factory_init (GstPlugin * plugin)
 364 {
 365   if (!gst_element_register (plugin, "esdmon", GST_RANK_NONE, GST_TYPE_ESDMON))
 366     return FALSE;
 367
 368   return TRUE;
 369 }
 370
 371 static gboolean
 372 gst_esdmon_open_audio (GstEsdmon * src)
 373 {
 374   /* Name used by esound for this connection. */
 375   const char *connname = "GStreamer";
 376
 377   /* Bitmap describing audio format. */
 378   esd_format_t esdformat = ESD_STREAM | ESD_PLAY;
 379
 380   g_return_val_if_fail (src->fd == -1, FALSE);
 381
 382   if (src->depth == 16)
 383     esdformat |= ESD_BITS16;
 384   else if (src->depth == 8)
 385     esdformat |= ESD_BITS8;
 386   else {
 387     GST_DEBUG ("esdmon: invalid bit depth (%d)", src->depth);
 388     return FALSE;
 389   }
 390
 391   if (src->channels == 2)
 392     esdformat |= ESD_STEREO;
 393   else if (src->channels == 1)
 394     esdformat |= ESD_MONO;
 395   else {
 396     GST_DEBUG ("esdmon: invalid number of channels (%d)", src->channels);
 397     return FALSE;
 398   }
 399
 400   GST_DEBUG ("esdmon: attempting to open connection to esound server");
 401   src->fd = esd_monitor_stream (esdformat, src->frequency, src->host, connname);
 402   if (src->fd < 0) {
 403     GST_DEBUG ("esdmon: can't open connection to esound server");
 404     return FALSE;
 405   }
 406
 407   GST_OBJECT_FLAG_SET (src, GST_ESDMON_OPEN);
 408
 409   return TRUE;
 410 }
 411
 412 static void
 413 gst_esdmon_close_audio (GstEsdmon * src)
 414 {
 415   if (src->fd < 0)
 416     return;
 417
 418   close (src->fd);
 419   src->fd = -1;
 420
 421   GST_OBJECT_FLAG_UNSET (src, GST_ESDMON_OPEN);
 422
 423   GST_DEBUG ("esdmon: closed sound device");
 424 }
 425
 426 static GstStateChangeReturn
 427 gst_esdmon_change_state (GstElement * element, GstStateChange transition)
 428 {
 429   g_return_val_if_fail (GST_IS_ESDMON (element), FALSE);
 430
 431   /* if going down into NULL state, close the fd if it's open */
 432   if (GST_STATE_PENDING (element) == GST_STATE_NULL) {
 433     if (GST_OBJECT_FLAG_IS_SET (element, GST_ESDMON_OPEN))
 434       gst_esdmon_close_audio (GST_ESDMON (element));
 435     /* otherwise (READY or higher) we need to open the fd */
 436   } else {
 437     if (!GST_OBJECT_FLAG_IS_SET (element, GST_ESDMON_OPEN)) {
 438       if (!gst_esdmon_open_audio (GST_ESDMON (element)))
 439         return GST_STATE_CHANGE_FAILURE;
 440     }
 441   }
 442
 443   if (GST_ELEMENT_CLASS (parent_class)->change_state)
 444     return GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
 445   return GST_STATE_CHANGE_SUCCESS;
 446 }