ext/jack/gstjackaudiosrc.c

   1 /* GStreamer
   2  * Copyright (C) 2008 Tristan Matthews <tristan@sat.qc.ca>
   3  *
   4  * Permission is hereby granted, free of charge, to any person obtaining a
   5  * copy of this software and associated documentation files (the "Software"),
   6  * to deal in the Software without restriction, including without limitation
   7  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
   8  * and/or sell copies of the Software, and to permit persons to whom the
   9  * Software is furnished to do so, subject to the following conditions:
  10  *
  11  * The above copyright notice and this permission notice shall be included in
  12  * all copies or substantial portions of the Software.
  13  *
  14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  15  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  16  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  17  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  18  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  19  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  20  * DEALINGS IN THE SOFTWARE.
  21  *
  22  * Alternatively, the contents of this file may be used under the
  23  * GNU Lesser General Public License Version 2.1 (the "LGPL"), in
  24  * which case the following provisions apply instead of the ones
  25  * mentioned above:
  26  *
  27  * This library is free software; you can redistribute it and/or
  28  * modify it under the terms of the GNU Library General Public
  29  * License as published by the Free Software Foundation; either
  30  * version 2 of the License, or (at your option) any later version.
  31  *
  32  * This library is distributed in the hope that it will be useful,
  33  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  34  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  35  * Library General Public License for more details.
  36  *
  37  * You should have received a copy of the GNU Library General Public
  38  * License along with this library; if not, write to the
  39  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  40  * Boston, MA 02111-1307, USA.
  41  */
  42
  43 /**
  44  * SECTION:element-jackaudiosrc
  45  * @see_also: #GstBaseAudioSrc, #GstRingBuffer
  46  *
  47  * A Src that inputs data from Jack ports.
  48  *
  49  * It will create N Jack ports named in_&lt;name&gt;_&lt;num&gt; where
  50  * &lt;name&gt; is the element name and &lt;num&gt; is starting from 1.
  51  * Each port corresponds to a gstreamer channel.
  52  *
  53  * The samplerate as exposed on the caps is always the same as the samplerate of
  54  * the jack server.
  55  *
  56  * When the #GstJackAudioSrc:connect property is set to auto, this element
  57  * will try to connect each input port to a random physical jack output pin.
  58  *
  59  * When the #GstJackAudioSrc:connect property is set to none, the element will
  60  * accept any number of output channels and will create (but not connect) an
  61  * input port for each channel.
  62  *
  63  * The element will generate an error when the Jack server is shut down when it
  64  * was PAUSED or PLAYING. This element does not support dynamic rate and buffer
  65  * size changes at runtime.
  66  *
  67  * <refsect2>
  68  * <title>Example launch line</title>
  69  * |[
  70  * gst-launch jackaudiosrc connect=0 ! jackaudiosink connect=0
  71  * ]| Get audio input into gstreamer from jack.
  72  * </refsect2>
  73  *
  74  * Last reviewed on 2008-07-22 (0.10.4)
  75  */
  76
  77 #ifdef HAVE_CONFIG_H
  78 #include "config.h"
  79 #endif
  80
  81 #include <gst/gst-i18n-plugin.h>
  82 #include <stdlib.h>
  83 #include <string.h>
  84
  85 #include "gstjackaudiosrc.h"
  86 #include "gstjackringbuffer.h"
  87 #include "gstjackutil.h"
  88
  89 GST_DEBUG_CATEGORY_STATIC (gst_jack_audio_src_debug);
  90 #define GST_CAT_DEFAULT gst_jack_audio_src_debug
  91
  92 static gboolean
  93 gst_jack_audio_src_allocate_channels (GstJackAudioSrc * src, gint channels)
  94 {
  95   jack_client_t *client;
  96
  97   client = gst_jack_audio_client_get_client (src->client);
  98
  99   /* remove ports we don't need */
 100   while (src->port_count > channels)
 101     jack_port_unregister (client, src->ports[--src->port_count]);
 102
 103   /* alloc enough input ports */
 104   src->ports = g_realloc (src->ports, sizeof (jack_port_t *) * channels);
 105   src->buffers = g_realloc (src->buffers, sizeof (sample_t *) * channels);
 106
 107   /* create an input port for each channel */
 108   while (src->port_count < channels) {
 109     gchar *name;
 110
 111     /* port names start from 1 and are local to the element */
 112     name =
 113         g_strdup_printf ("in_%s_%d", GST_ELEMENT_NAME (src),
 114         src->port_count + 1);
 115     src->ports[src->port_count] =
 116         jack_port_register (client, name, JACK_DEFAULT_AUDIO_TYPE,
 117         JackPortIsInput, 0);
 118     if (src->ports[src->port_count] == NULL)
 119       return FALSE;
 120
 121     src->port_count++;
 122
 123     g_free (name);
 124   }
 125   return TRUE;
 126 }
 127
 128 static void
 129 gst_jack_audio_src_free_channels (GstJackAudioSrc * src)
 130 {
 131   gint res, i = 0;
 132   jack_client_t *client;
 133
 134   client = gst_jack_audio_client_get_client (src->client);
 135
 136   /* get rid of all ports */
 137   while (src->port_count) {
 138     GST_LOG_OBJECT (src, "unregister port %d", i);
 139     if ((res = jack_port_unregister (client, src->ports[i++])))
 140       GST_DEBUG_OBJECT (src, "unregister of port failed (%d)", res);
 141
 142     src->port_count--;
 143   }
 144   g_free (src->ports);
 145   src->ports = NULL;
 146   g_free (src->buffers);
 147   src->buffers = NULL;
 148 }
 149
 150 /* ringbuffer abstract base class */
 151 static GType
 152 gst_jack_ring_buffer_get_type (void)
 153 {
 154   static volatile gsize ringbuffer_type = 0;
 155
 156   if (g_once_init_enter (&ringbuffer_type)) {
 157     static const GTypeInfo ringbuffer_info = { sizeof (GstJackRingBufferClass),
 158       NULL,
 159       NULL,
 160       (GClassInitFunc) gst_jack_ring_buffer_class_init,
 161       NULL,
 162       NULL,
 163       sizeof (GstJackRingBuffer),
 164       0,
 165       (GInstanceInitFunc) gst_jack_ring_buffer_init,
 166       NULL
 167     };
 168     GType tmp = g_type_register_static (GST_TYPE_RING_BUFFER,
 169         "GstJackAudioSrcRingBuffer", &ringbuffer_info, 0);
 170     g_once_init_leave (&ringbuffer_type, tmp);
 171   }
 172
 173   return (GType) ringbuffer_type;
 174 }
 175
 176 static void
 177 gst_jack_ring_buffer_class_init (GstJackRingBufferClass * klass)
 178 {
 179   GstRingBufferClass *gstringbuffer_class;
 180
 181   gstringbuffer_class = (GstRingBufferClass *) klass;
 182
 183   ring_parent_class = g_type_class_peek_parent (klass);
 184
 185   gstringbuffer_class->open_device =
 186       GST_DEBUG_FUNCPTR (gst_jack_ring_buffer_open_device);
 187   gstringbuffer_class->close_device =
 188       GST_DEBUG_FUNCPTR (gst_jack_ring_buffer_close_device);
 189   gstringbuffer_class->acquire =
 190       GST_DEBUG_FUNCPTR (gst_jack_ring_buffer_acquire);
 191   gstringbuffer_class->release =
 192       GST_DEBUG_FUNCPTR (gst_jack_ring_buffer_release);
 193   gstringbuffer_class->start = GST_DEBUG_FUNCPTR (gst_jack_ring_buffer_start);
 194   gstringbuffer_class->pause = GST_DEBUG_FUNCPTR (gst_jack_ring_buffer_pause);
 195   gstringbuffer_class->resume = GST_DEBUG_FUNCPTR (gst_jack_ring_buffer_start);
 196   gstringbuffer_class->stop = GST_DEBUG_FUNCPTR (gst_jack_ring_buffer_stop);
 197
 198   gstringbuffer_class->delay = GST_DEBUG_FUNCPTR (gst_jack_ring_buffer_delay);
 199 }
 200
 201 /* this is the callback of jack. This should be RT-safe.
 202  * Writes samples from the jack input port's buffer to the gst ring buffer.
 203  */
 204 static int
 205 jack_process_cb (jack_nframes_t nframes, void *arg)
 206 {
 207   GstJackAudioSrc *src;
 208   GstRingBuffer *buf;
 209   gint len;
 210   guint8 *writeptr;
 211   gint writeseg;
 212   gint channels, i, j, flen;
 213   sample_t *data;
 214
 215   buf = GST_RING_BUFFER_CAST (arg);
 216   src = GST_JACK_AUDIO_SRC (GST_OBJECT_PARENT (buf));
 217
 218   channels = buf->spec.channels;
 219
 220   /* get input buffers */
 221   for (i = 0; i < channels; i++)
 222     src->buffers[i] =
 223         (sample_t *) jack_port_get_buffer (src->ports[i], nframes);
 224
 225   if (gst_ring_buffer_prepare_read (buf, &writeseg, &writeptr, &len)) {
 226     flen = len / channels;
 227
 228     /* the number of samples must be exactly the segment size */
 229     if (nframes * sizeof (sample_t) != flen)
 230       goto wrong_size;
 231
 232     /* the samples in the jack input buffers have to be interleaved into the
 233      * ringbuffer */
 234     data = (sample_t *) writeptr;
 235     for (i = 0; i < nframes; ++i)
 236       for (j = 0; j < channels; ++j)
 237         *data++ = src->buffers[j][i];
 238
 239     GST_DEBUG ("copy %d frames: %p, %d bytes, %d channels", nframes, writeptr,
 240         len / channels, channels);
 241
 242     /* we wrote one segment */
 243     gst_ring_buffer_advance (buf, 1);
 244   }
 245   return 0;
 246
 247   /* ERRORS */
 248 wrong_size:
 249   {
 250     GST_ERROR_OBJECT (src, "nbytes (%d) != flen (%d)",
 251         (gint) (nframes * sizeof (sample_t)), flen);
 252     return 1;
 253   }
 254 }
 255
 256 /* we error out */
 257 static int
 258 jack_sample_rate_cb (jack_nframes_t nframes, void *arg)
 259 {
 260   GstJackAudioSrc *src;
 261   GstJackRingBuffer *abuf;
 262
 263   abuf = GST_JACK_RING_BUFFER_CAST (arg);
 264   src = GST_JACK_AUDIO_SRC (GST_OBJECT_PARENT (arg));
 265
 266   if (abuf->sample_rate != -1 && abuf->sample_rate != nframes)
 267     goto not_supported;
 268
 269   return 0;
 270
 271   /* ERRORS */
 272 not_supported:
 273   {
 274     GST_ELEMENT_ERROR (src, RESOURCE, SETTINGS,
 275         (NULL), ("Jack changed the sample rate, which is not supported"));
 276     return 1;
 277   }
 278 }
 279
 280 /* we error out */
 281 static int
 282 jack_buffer_size_cb (jack_nframes_t nframes, void *arg)
 283 {
 284   GstJackAudioSrc *src;
 285   GstJackRingBuffer *abuf;
 286
 287   abuf = GST_JACK_RING_BUFFER_CAST (arg);
 288   src = GST_JACK_AUDIO_SRC (GST_OBJECT_PARENT (arg));
 289
 290   if (abuf->buffer_size != -1 && abuf->buffer_size != nframes)
 291     goto not_supported;
 292
 293   return 0;
 294
 295   /* ERRORS */
 296 not_supported:
 297   {
 298     GST_ELEMENT_ERROR (src, RESOURCE, SETTINGS,
 299         (NULL), ("Jack changed the buffer size, which is not supported"));
 300     return 1;
 301   }
 302 }
 303
 304 static void
 305 jack_shutdown_cb (void *arg)
 306 {
 307   GstJackAudioSrc *src;
 308
 309   src = GST_JACK_AUDIO_SRC (GST_OBJECT_PARENT (arg));
 310
 311   GST_DEBUG_OBJECT (src, "shutdown");
 312
 313   GST_ELEMENT_ERROR (src, RESOURCE, NOT_FOUND,
 314       (NULL), ("Jack server shutdown"));
 315 }
 316
 317 static void
 318 gst_jack_ring_buffer_init (GstJackRingBuffer * buf,
 319     GstJackRingBufferClass * g_class)
 320 {
 321   buf->channels = -1;
 322   buf->buffer_size = -1;
 323   buf->sample_rate = -1;
 324 }
 325
 326 /* the _open_device method should make a connection with the server
 327 */
 328 static gboolean
 329 gst_jack_ring_buffer_open_device (GstRingBuffer * buf)
 330 {
 331   GstJackAudioSrc *src;
 332   jack_status_t status = 0;
 333   const gchar *name;
 334
 335   src = GST_JACK_AUDIO_SRC (GST_OBJECT_PARENT (buf));
 336
 337   GST_DEBUG_OBJECT (src, "open");
 338
 339   name = g_get_application_name ();
 340   if (!name)
 341     name = "GStreamer";
 342
 343   src->client = gst_jack_audio_client_new (name, src->server,
 344       src->jclient,
 345       GST_JACK_CLIENT_SOURCE,
 346       jack_shutdown_cb,
 347       jack_process_cb, jack_buffer_size_cb, jack_sample_rate_cb, buf, &status);
 348   if (src->client == NULL)
 349     goto could_not_open;
 350
 351   GST_DEBUG_OBJECT (src, "opened");
 352
 353   return TRUE;
 354
 355   /* ERRORS */
 356 could_not_open:
 357   {
 358     if (status & JackServerFailed) {
 359       GST_ELEMENT_ERROR (src, RESOURCE, NOT_FOUND,
 360           (_("Jack server not found")),
 361           ("Cannot connect to the Jack server (status %d)", status));
 362     } else {
 363       GST_ELEMENT_ERROR (src, RESOURCE, OPEN_WRITE,
 364           (NULL), ("Jack client open error (status %d)", status));
 365     }
 366     return FALSE;
 367   }
 368 }
 369
 370 /* close the connection with the server
 371 */
 372 static gboolean
 373 gst_jack_ring_buffer_close_device (GstRingBuffer * buf)
 374 {
 375   GstJackAudioSrc *src;
 376
 377   src = GST_JACK_AUDIO_SRC (GST_OBJECT_PARENT (buf));
 378
 379   GST_DEBUG_OBJECT (src, "close");
 380
 381   gst_jack_audio_src_free_channels (src);
 382   gst_jack_audio_client_free (src->client);
 383   src->client = NULL;
 384
 385   return TRUE;
 386 }
 387
 388
 389 /* allocate a buffer and setup resources to process the audio samples of
 390  * the format as specified in @spec.
 391  *
 392  * We allocate N jack ports, one for each channel. If we are asked to
 393  * automatically make a connection with physical ports, we connect as many
 394  * ports as there are physical ports, leaving leftover ports unconnected.
 395  *
 396  * It is assumed that samplerate and number of channels are acceptable since our
 397  * getcaps method will always provide correct values. If unacceptable caps are
 398  * received for some reason, we fail here.
 399  */
 400 static gboolean
 401 gst_jack_ring_buffer_acquire (GstRingBuffer * buf, GstRingBufferSpec * spec)
 402 {
 403   GstJackAudioSrc *src;
 404   GstJackRingBuffer *abuf;
 405   const char **ports;
 406   gint sample_rate, buffer_size;
 407   gint i, channels, res;
 408   jack_client_t *client;
 409
 410   src = GST_JACK_AUDIO_SRC (GST_OBJECT_PARENT (buf));
 411   abuf = GST_JACK_RING_BUFFER_CAST (buf);
 412
 413   GST_DEBUG_OBJECT (src, "acquire");
 414
 415   client = gst_jack_audio_client_get_client (src->client);
 416
 417   /* sample rate must be that of the server */
 418   sample_rate = jack_get_sample_rate (client);
 419   if (sample_rate != spec->rate)
 420     goto wrong_samplerate;
 421
 422   channels = spec->channels;
 423
 424   if (!gst_jack_audio_src_allocate_channels (src, channels))
 425     goto out_of_ports;
 426
 427   gst_jack_set_layout_on_caps (&spec->caps, channels);
 428
 429   buffer_size = jack_get_buffer_size (client);
 430
 431   /* the segment size in bytes, this is large enough to hold a buffer of 32bit floats
 432    * for all channels  */
 433   spec->segsize = buffer_size * sizeof (gfloat) * channels;
 434   spec->latency_time = gst_util_uint64_scale (spec->segsize,
 435       (GST_SECOND / GST_USECOND), spec->rate * spec->bytes_per_sample);
 436   /* segtotal based on buffer-time latency */
 437   spec->segtotal = spec->buffer_time / spec->latency_time;
 438   if (spec->segtotal < 2) {
 439     spec->segtotal = 2;
 440     spec->buffer_time = spec->latency_time * spec->segtotal;
 441   }
 442
 443   GST_DEBUG_OBJECT (src, "buffer time: %" G_GINT64_FORMAT " usec",
 444       spec->buffer_time);
 445   GST_DEBUG_OBJECT (src, "latency time: %" G_GINT64_FORMAT " usec",
 446       spec->latency_time);
 447   GST_DEBUG_OBJECT (src, "buffer_size %d, segsize %d, segtotal %d",
 448       buffer_size, spec->segsize, spec->segtotal);
 449
 450   /* allocate the ringbuffer memory now */
 451   buf->data = gst_buffer_new_and_alloc (spec->segtotal * spec->segsize);
 452   memset (GST_BUFFER_DATA (buf->data), 0, GST_BUFFER_SIZE (buf->data));
 453
 454   if ((res = gst_jack_audio_client_set_active (src->client, TRUE)))
 455     goto could_not_activate;
 456
 457   /* if we need to automatically connect the ports, do so now. We must do this
 458    * after activating the client. */
 459   if (src->connect == GST_JACK_CONNECT_AUTO
 460       || src->connect == GST_JACK_CONNECT_AUTO_FORCED) {
 461     /* find all the physical output ports. A physical output port is a port
 462      * associated with a hardware device. Someone needs connect to a physical
 463      * port in order to capture something. */
 464     ports =
 465         jack_get_ports (client, NULL, NULL,
 466         JackPortIsPhysical | JackPortIsOutput);
 467     if (ports == NULL) {
 468       /* no ports? fine then we don't do anything except for posting a warning
 469        * message. */
 470       GST_ELEMENT_WARNING (src, RESOURCE, NOT_FOUND, (NULL),
 471           ("No physical output ports found, leaving ports unconnected"));
 472       goto done;
 473     }
 474
 475     for (i = 0; i < channels; i++) {
 476       /* stop when all output ports are exhausted */
 477       if (ports[i] == NULL) {
 478         /* post a warning that we could not connect all ports */
 479         GST_ELEMENT_WARNING (src, RESOURCE, NOT_FOUND, (NULL),
 480             ("No more physical ports, leaving some ports unconnected"));
 481         break;
 482       }
 483       GST_DEBUG_OBJECT (src, "try connecting to %s",
 484           jack_port_name (src->ports[i]));
 485
 486       /* connect the physical port to a port */
 487       res = jack_connect (client, ports[i], jack_port_name (src->ports[i]));
 488       if (res != 0 && res != EEXIST)
 489         goto cannot_connect;
 490     }
 491     free (ports);
 492   }
 493 done:
 494
 495   abuf->sample_rate = sample_rate;
 496   abuf->buffer_size = buffer_size;
 497   abuf->channels = spec->channels;
 498
 499   return TRUE;
 500
 501   /* ERRORS */
 502 wrong_samplerate:
 503   {
 504     GST_ELEMENT_ERROR (src, RESOURCE, SETTINGS, (NULL),
 505         ("Wrong samplerate, server is running at %d and we received %d",
 506             sample_rate, spec->rate));
 507     return FALSE;
 508   }
 509 out_of_ports:
 510   {
 511     GST_ELEMENT_ERROR (src, RESOURCE, SETTINGS, (NULL),
 512         ("Cannot allocate more Jack ports"));
 513     return FALSE;
 514   }
 515 could_not_activate:
 516   {
 517     GST_ELEMENT_ERROR (src, RESOURCE, SETTINGS, (NULL),
 518         ("Could not activate client (%d:%s)", res, g_strerror (res)));
 519     return FALSE;
 520   }
 521 cannot_connect:
 522   {
 523     GST_ELEMENT_ERROR (src, RESOURCE, SETTINGS, (NULL),
 524         ("Could not connect input ports to physical ports (%d:%s)",
 525             res, g_strerror (res)));
 526     free (ports);
 527     return FALSE;
 528   }
 529 }
 530
 531 /* function is called with LOCK */
 532 static gboolean
 533 gst_jack_ring_buffer_release (GstRingBuffer * buf)
 534 {
 535   GstJackAudioSrc *src;
 536   GstJackRingBuffer *abuf;
 537   gint res;
 538
 539   abuf = GST_JACK_RING_BUFFER_CAST (buf);
 540   src = GST_JACK_AUDIO_SRC (GST_OBJECT_PARENT (buf));
 541
 542   GST_DEBUG_OBJECT (src, "release");
 543
 544   if ((res = gst_jack_audio_client_set_active (src->client, FALSE))) {
 545     /* we only warn, this means the server is probably shut down and the client
 546      * is gone anyway. */
 547     GST_ELEMENT_WARNING (src, RESOURCE, CLOSE, (NULL),
 548         ("Could not deactivate Jack client (%d)", res));
 549   }
 550
 551   abuf->channels = -1;
 552   abuf->buffer_size = -1;
 553   abuf->sample_rate = -1;
 554
 555   /* free the buffer */
 556   gst_buffer_unref (buf->data);
 557   buf->data = NULL;
 558
 559   return TRUE;
 560 }
 561
 562 static gboolean
 563 gst_jack_ring_buffer_start (GstRingBuffer * buf)
 564 {
 565   GstJackAudioSrc *src;
 566
 567   src = GST_JACK_AUDIO_SRC (GST_OBJECT_PARENT (buf));
 568
 569   GST_DEBUG_OBJECT (src, "start");
 570
 571   return TRUE;
 572 }
 573
 574 static gboolean
 575 gst_jack_ring_buffer_pause (GstRingBuffer * buf)
 576 {
 577   GstJackAudioSrc *src;
 578
 579   src = GST_JACK_AUDIO_SRC (GST_OBJECT_PARENT (buf));
 580
 581   GST_DEBUG_OBJECT (src, "pause");
 582
 583   return TRUE;
 584 }
 585
 586 static gboolean
 587 gst_jack_ring_buffer_stop (GstRingBuffer * buf)
 588 {
 589   GstJackAudioSrc *src;
 590
 591   src = GST_JACK_AUDIO_SRC (GST_OBJECT_PARENT (buf));
 592
 593   GST_DEBUG_OBJECT (src, "stop");
 594
 595   return TRUE;
 596 }
 597
 598 #if defined (HAVE_JACK_0_120_1) || defined(HAVE_JACK_1_9_7)
 599 static guint
 600 gst_jack_ring_buffer_delay (GstRingBuffer * buf)
 601 {
 602   GstJackAudioSrc *src;
 603   guint i, res = 0;
 604   jack_latency_range_t range;
 605
 606   src = GST_JACK_AUDIO_SRC (GST_OBJECT_PARENT (buf));
 607
 608   for (i = 0; i < src->port_count; i++) {
 609     jack_port_get_latency_range (src->ports[i], JackCaptureLatency, &range);
 610     if (range.max > res)
 611       res = range.max;
 612   }
 613
 614   GST_DEBUG_OBJECT (src, "delay %u", res);
 615
 616   return res;
 617 }
 618 #else /* !(defined (HAVE_JACK_0_120_1) || defined(HAVE_JACK_1_9_7)) */
 619 static guint
 620 gst_jack_ring_buffer_delay (GstRingBuffer * buf)
 621 {
 622   GstJackAudioSrc *src;
 623   guint i, res = 0;
 624   guint latency;
 625   jack_client_t *client;
 626
 627   src = GST_JACK_AUDIO_SRC (GST_OBJECT_PARENT (buf));
 628
 629   client = gst_jack_audio_client_get_client (src->client);
 630
 631   for (i = 0; i < src->port_count; i++) {
 632     latency = jack_port_get_total_latency (client, src->ports[i]);
 633     if (latency > res)
 634       res = latency;
 635   }
 636
 637   GST_DEBUG_OBJECT (src, "delay %u", res);
 638
 639   return res;
 640 }
 641 #endif
 642
 643 /* Audiosrc signals and args */
 644 enum
 645 {
 646   /* FILL ME */
 647   LAST_SIGNAL
 648 };
 649
 650 #define DEFAULT_PROP_CONNECT    GST_JACK_CONNECT_AUTO
 651 #define DEFAULT_PROP_SERVER     NULL
 652
 653 enum
 654 {
 655   PROP_0,
 656   PROP_CONNECT,
 657   PROP_SERVER,
 658   PROP_CLIENT,
 659   PROP_LAST
 660 };
 661
 662
 663 /* the capabilities of the inputs and outputs.
 664  *
 665  * describe the real formats here.
 666  */
 667
 668 static GstStaticPadTemplate src_factory = GST_STATIC_PAD_TEMPLATE ("src",
 669     GST_PAD_SRC,
 670     GST_PAD_ALWAYS,
 671     GST_STATIC_CAPS ("audio/x-raw-float, "
 672         "endianness = (int) BYTE_ORDER, "
 673         "width = (int) 32, "
 674         "rate = (int) [ 1, MAX ], " "channels = (int) [ 1, MAX ]")
 675     );
 676
 677 #define _do_init(bla) \
 678   GST_DEBUG_CATEGORY_INIT(gst_jack_audio_src_debug, "jacksrc", 0, "jacksrc element");
 679
 680 GST_BOILERPLATE_FULL (GstJackAudioSrc, gst_jack_audio_src, GstBaseAudioSrc,
 681     GST_TYPE_BASE_AUDIO_SRC, _do_init);
 682
 683 static void gst_jack_audio_src_dispose (GObject * object);
 684 static void gst_jack_audio_src_set_property (GObject * object, guint prop_id,
 685     const GValue * value, GParamSpec * pspec);
 686 static void gst_jack_audio_src_get_property (GObject * object, guint prop_id,
 687     GValue * value, GParamSpec * pspec);
 688
 689 static GstCaps *gst_jack_audio_src_getcaps (GstBaseSrc * bsrc);
 690 static GstRingBuffer *gst_jack_audio_src_create_ringbuffer (GstBaseAudioSrc *
 691     src);
 692
 693 /* GObject vmethod implementations */
 694
 695 static void
 696 gst_jack_audio_src_base_init (gpointer gclass)
 697 {
 698   GstElementClass *element_class = GST_ELEMENT_CLASS (gclass);
 699
 700   gst_element_class_add_pad_template (element_class,
 701       gst_static_pad_template_get (&src_factory));
 702   gst_element_class_set_details_simple (element_class, "Audio Source (Jack)",
 703       "Source/Audio", "Captures audio from a JACK server",
 704       "Tristan Matthews <tristan@sat.qc.ca>");
 705 }
 706
 707 /* initialize the jack_audio_src's class */
 708 static void
 709 gst_jack_audio_src_class_init (GstJackAudioSrcClass * klass)
 710 {
 711   GObjectClass *gobject_class;
 712   GstBaseSrcClass *gstbasesrc_class;
 713   GstBaseAudioSrcClass *gstbaseaudiosrc_class;
 714
 715   gobject_class = (GObjectClass *) klass;
 716
 717   gstbasesrc_class = (GstBaseSrcClass *) klass;
 718   gstbaseaudiosrc_class = (GstBaseAudioSrcClass *) klass;
 719
 720   gobject_class->dispose = gst_jack_audio_src_dispose;
 721   gobject_class->set_property = gst_jack_audio_src_set_property;
 722   gobject_class->get_property = gst_jack_audio_src_get_property;
 723
 724   g_object_class_install_property (gobject_class, PROP_CONNECT,
 725       g_param_spec_enum ("connect", "Connect",
 726           "Specify how the input ports will be connected",
 727           GST_TYPE_JACK_CONNECT, DEFAULT_PROP_CONNECT,
 728           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 729
 730   g_object_class_install_property (gobject_class, PROP_SERVER,
 731       g_param_spec_string ("server", "Server",
 732           "The Jack server to connect to (NULL = default)",
 733           DEFAULT_PROP_SERVER, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 734
 735   g_object_class_install_property (gobject_class, PROP_CLIENT,
 736       g_param_spec_boxed ("client", "JackClient", "Handle for jack client",
 737           GST_TYPE_JACK_CLIENT,
 738           GST_PARAM_MUTABLE_READY | G_PARAM_READWRITE |
 739           G_PARAM_STATIC_STRINGS));
 740
 741   gstbasesrc_class->get_caps = GST_DEBUG_FUNCPTR (gst_jack_audio_src_getcaps);
 742   gstbaseaudiosrc_class->create_ringbuffer =
 743       GST_DEBUG_FUNCPTR (gst_jack_audio_src_create_ringbuffer);
 744
 745   /* ref class from a thread-safe context to work around missing bit of
 746    * thread-safety in GObject */
 747   g_type_class_ref (GST_TYPE_JACK_RING_BUFFER);
 748
 749   gst_jack_audio_client_init ();
 750 }
 751
 752 /* initialize the new element
 753  * instantiate pads and add them to element
 754  * set pad calback functions
 755  * initialize instance structure
 756  */
 757 static void
 758 gst_jack_audio_src_init (GstJackAudioSrc * src, GstJackAudioSrcClass * gclass)
 759 {
 760   //gst_base_src_set_live(GST_BASE_SRC (src), TRUE);
 761   src->connect = DEFAULT_PROP_CONNECT;
 762   src->server = g_strdup (DEFAULT_PROP_SERVER);
 763   src->jclient = NULL;
 764   src->ports = NULL;
 765   src->port_count = 0;
 766   src->buffers = NULL;
 767 }
 768
 769 static void
 770 gst_jack_audio_src_dispose (GObject * object)
 771 {
 772   GstJackAudioSrc *src = GST_JACK_AUDIO_SRC (object);
 773
 774   gst_caps_replace (&src->caps, NULL);
 775   G_OBJECT_CLASS (parent_class)->dispose (object);
 776 }
 777
 778 static void
 779 gst_jack_audio_src_set_property (GObject * object, guint prop_id,
 780     const GValue * value, GParamSpec * pspec)
 781 {
 782   GstJackAudioSrc *src = GST_JACK_AUDIO_SRC (object);
 783
 784   switch (prop_id) {
 785     case PROP_CONNECT:
 786       src->connect = g_value_get_enum (value);
 787       break;
 788     case PROP_SERVER:
 789       g_free (src->server);
 790       src->server = g_value_dup_string (value);
 791       break;
 792     case PROP_CLIENT:
 793       if (GST_STATE (src) == GST_STATE_NULL ||
 794           GST_STATE (src) == GST_STATE_READY) {
 795         src->jclient = g_value_get_boxed (value);
 796       }
 797       break;
 798     default:
 799       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 800       break;
 801   }
 802 }
 803
 804 static void
 805 gst_jack_audio_src_get_property (GObject * object, guint prop_id,
 806     GValue * value, GParamSpec * pspec)
 807 {
 808   GstJackAudioSrc *src = GST_JACK_AUDIO_SRC (object);
 809
 810   switch (prop_id) {
 811     case PROP_CONNECT:
 812       g_value_set_enum (value, src->connect);
 813       break;
 814     case PROP_SERVER:
 815       g_value_set_string (value, src->server);
 816       break;
 817     case PROP_CLIENT:
 818       g_value_set_boxed (value, src->jclient);
 819       break;
 820     default:
 821       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 822       break;
 823   }
 824 }
 825
 826 static GstCaps *
 827 gst_jack_audio_src_getcaps (GstBaseSrc * bsrc)
 828 {
 829   GstJackAudioSrc *src = GST_JACK_AUDIO_SRC (bsrc);
 830   const char **ports;
 831   gint min, max;
 832   gint rate;
 833   jack_client_t *client;
 834
 835   if (src->client == NULL)
 836     goto no_client;
 837
 838   client = gst_jack_audio_client_get_client (src->client);
 839
 840   if (src->connect == GST_JACK_CONNECT_AUTO) {
 841     /* get a port count, this is the number of channels we can automatically
 842      * connect. */
 843     ports = jack_get_ports (client, NULL, NULL,
 844         JackPortIsPhysical | JackPortIsOutput);
 845     max = 0;
 846     if (ports != NULL) {
 847       for (; ports[max]; max++);
 848
 849       free (ports);
 850     } else
 851       max = 0;
 852   } else {
 853     /* we allow any number of pads, something else is going to connect the
 854      * pads. */
 855     max = G_MAXINT;
 856   }
 857   min = MIN (1, max);
 858
 859   rate = jack_get_sample_rate (client);
 860
 861   GST_DEBUG_OBJECT (src, "got %d-%d ports, samplerate: %d", min, max, rate);
 862
 863   if (!src->caps) {
 864     src->caps = gst_caps_new_simple ("audio/x-raw-float",
 865         "endianness", G_TYPE_INT, G_BYTE_ORDER,
 866         "width", G_TYPE_INT, 32,
 867         "rate", G_TYPE_INT, rate,
 868         "channels", GST_TYPE_INT_RANGE, min, max, NULL);
 869   }
 870   GST_INFO_OBJECT (src, "returning caps %" GST_PTR_FORMAT, src->caps);
 871
 872   return gst_caps_ref (src->caps);
 873
 874   /* ERRORS */
 875 no_client:
 876   {
 877     GST_DEBUG_OBJECT (src, "device not open, using template caps");
 878     /* base class will get template caps for us when we return NULL */
 879     return NULL;
 880   }
 881 }
 882
 883 static GstRingBuffer *
 884 gst_jack_audio_src_create_ringbuffer (GstBaseAudioSrc * src)
 885 {
 886   GstRingBuffer *buffer;
 887
 888   buffer = g_object_new (GST_TYPE_JACK_RING_BUFFER, NULL);
 889   GST_DEBUG_OBJECT (src, "created ringbuffer @%p", buffer);
 890
 891   return buffer;
 892 }