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: #GstAudioBaseSrc, #GstAudioRingBuffer
  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_AUDIO_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   GstAudioRingBufferClass *gstringbuffer_class;
 180
 181   gstringbuffer_class = (GstAudioRingBufferClass *) 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   GstAudioRingBuffer *buf;
 209   gint len;
 210   guint8 *writeptr;
 211   gint writeseg;
 212   gint channels, i, j, flen;
 213   sample_t *data;
 214
 215   buf = GST_AUDIO_RING_BUFFER_CAST (arg);
 216   src = GST_JACK_AUDIO_SRC (GST_OBJECT_PARENT (buf));
 217
 218   channels = GST_AUDIO_INFO_CHANNELS (&buf->spec.info);
 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_audio_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_audio_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 (GstAudioRingBuffer * 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   if (src->client_name) {
 340     name = src->client_name;
 341   } else {
 342     name = g_get_application_name ();
 343   }
 344   if (!name)
 345     name = "GStreamer";
 346
 347   src->client = gst_jack_audio_client_new (name, src->server,
 348       src->jclient,
 349       GST_JACK_CLIENT_SOURCE,
 350       jack_shutdown_cb,
 351       jack_process_cb, jack_buffer_size_cb, jack_sample_rate_cb, buf, &status);
 352   if (src->client == NULL)
 353     goto could_not_open;
 354
 355   GST_DEBUG_OBJECT (src, "opened");
 356
 357   return TRUE;
 358
 359   /* ERRORS */
 360 could_not_open:
 361   {
 362     if (status & (JackServerFailed | JackFailure)) {
 363       GST_ELEMENT_ERROR (src, RESOURCE, NOT_FOUND,
 364           (_("Jack server not found")),
 365           ("Cannot connect to the Jack server (status %d)", status));
 366     } else {
 367       GST_ELEMENT_ERROR (src, RESOURCE, OPEN_READ,
 368           (NULL), ("Jack client open error (status %d)", status));
 369     }
 370     return FALSE;
 371   }
 372 }
 373
 374 /* close the connection with the server
 375 */
 376 static gboolean
 377 gst_jack_ring_buffer_close_device (GstAudioRingBuffer * buf)
 378 {
 379   GstJackAudioSrc *src;
 380
 381   src = GST_JACK_AUDIO_SRC (GST_OBJECT_PARENT (buf));
 382
 383   GST_DEBUG_OBJECT (src, "close");
 384
 385   gst_jack_audio_src_free_channels (src);
 386   gst_jack_audio_client_free (src->client);
 387   src->client = NULL;
 388
 389   return TRUE;
 390 }
 391
 392
 393 /* allocate a buffer and setup resources to process the audio samples of
 394  * the format as specified in @spec.
 395  *
 396  * We allocate N jack ports, one for each channel. If we are asked to
 397  * automatically make a connection with physical ports, we connect as many
 398  * ports as there are physical ports, leaving leftover ports unconnected.
 399  *
 400  * It is assumed that samplerate and number of channels are acceptable since our
 401  * getcaps method will always provide correct values. If unacceptable caps are
 402  * received for some reason, we fail here.
 403  */
 404 static gboolean
 405 gst_jack_ring_buffer_acquire (GstAudioRingBuffer * buf,
 406     GstAudioRingBufferSpec * spec)
 407 {
 408   GstJackAudioSrc *src;
 409   GstJackRingBuffer *abuf;
 410   const char **ports;
 411   gint sample_rate, buffer_size;
 412   gint i, bpf, rate, channels, res;
 413   jack_client_t *client;
 414
 415   src = GST_JACK_AUDIO_SRC (GST_OBJECT_PARENT (buf));
 416   abuf = GST_JACK_RING_BUFFER_CAST (buf);
 417
 418   GST_DEBUG_OBJECT (src, "acquire");
 419
 420   client = gst_jack_audio_client_get_client (src->client);
 421
 422   rate = GST_AUDIO_INFO_RATE (&spec->info);
 423
 424   /* sample rate must be that of the server */
 425   sample_rate = jack_get_sample_rate (client);
 426   if (sample_rate != rate)
 427     goto wrong_samplerate;
 428
 429   bpf = GST_AUDIO_INFO_BPF (&spec->info);
 430   channels = GST_AUDIO_INFO_CHANNELS (&spec->info);
 431
 432   if (!gst_jack_audio_src_allocate_channels (src, channels))
 433     goto out_of_ports;
 434
 435   gst_jack_set_layout (buf, spec);
 436
 437   buffer_size = jack_get_buffer_size (client);
 438
 439   /* the segment size in bytes, this is large enough to hold a buffer of 32bit floats
 440    * for all channels  */
 441   spec->segsize = buffer_size * sizeof (gfloat) * channels;
 442   spec->latency_time = gst_util_uint64_scale (spec->segsize,
 443       (GST_SECOND / GST_USECOND), rate * bpf);
 444   /* segtotal based on buffer-time latency */
 445   spec->segtotal = spec->buffer_time / spec->latency_time;
 446   if (spec->segtotal < 2) {
 447     spec->segtotal = 2;
 448     spec->buffer_time = spec->latency_time * spec->segtotal;
 449   }
 450
 451   GST_DEBUG_OBJECT (src, "buffer time: %" G_GINT64_FORMAT " usec",
 452       spec->buffer_time);
 453   GST_DEBUG_OBJECT (src, "latency time: %" G_GINT64_FORMAT " usec",
 454       spec->latency_time);
 455   GST_DEBUG_OBJECT (src, "buffer_size %d, segsize %d, segtotal %d",
 456       buffer_size, spec->segsize, spec->segtotal);
 457
 458   /* allocate the ringbuffer memory now */
 459   buf->size = spec->segtotal * spec->segsize;
 460   buf->memory = g_malloc0 (buf->size);
 461
 462   if ((res = gst_jack_audio_client_set_active (src->client, TRUE)))
 463     goto could_not_activate;
 464
 465   /* if we need to automatically connect the ports, do so now. We must do this
 466    * after activating the client. */
 467   if (src->connect == GST_JACK_CONNECT_AUTO
 468       || src->connect == GST_JACK_CONNECT_AUTO_FORCED) {
 469     /* find all the physical output ports. A physical output port is a port
 470      * associated with a hardware device. Someone needs connect to a physical
 471      * port in order to capture something. */
 472     ports =
 473         jack_get_ports (client, NULL, NULL,
 474         JackPortIsPhysical | JackPortIsOutput);
 475     if (ports == NULL) {
 476       /* no ports? fine then we don't do anything except for posting a warning
 477        * message. */
 478       GST_ELEMENT_WARNING (src, RESOURCE, NOT_FOUND, (NULL),
 479           ("No physical output ports found, leaving ports unconnected"));
 480       goto done;
 481     }
 482
 483     for (i = 0; i < channels; i++) {
 484       /* stop when all output ports are exhausted */
 485       if (ports[i] == NULL) {
 486         /* post a warning that we could not connect all ports */
 487         GST_ELEMENT_WARNING (src, RESOURCE, NOT_FOUND, (NULL),
 488             ("No more physical ports, leaving some ports unconnected"));
 489         break;
 490       }
 491       GST_DEBUG_OBJECT (src, "try connecting to %s",
 492           jack_port_name (src->ports[i]));
 493
 494       /* connect the physical port to a port */
 495       res = jack_connect (client, ports[i], jack_port_name (src->ports[i]));
 496       if (res != 0 && res != EEXIST)
 497         goto cannot_connect;
 498     }
 499     free (ports);
 500   }
 501 done:
 502
 503   abuf->sample_rate = sample_rate;
 504   abuf->buffer_size = buffer_size;
 505   abuf->channels = channels;
 506
 507   return TRUE;
 508
 509   /* ERRORS */
 510 wrong_samplerate:
 511   {
 512     GST_ELEMENT_ERROR (src, RESOURCE, SETTINGS, (NULL),
 513         ("Wrong samplerate, server is running at %d and we received %d",
 514             sample_rate, rate));
 515     return FALSE;
 516   }
 517 out_of_ports:
 518   {
 519     GST_ELEMENT_ERROR (src, RESOURCE, SETTINGS, (NULL),
 520         ("Cannot allocate more Jack ports"));
 521     return FALSE;
 522   }
 523 could_not_activate:
 524   {
 525     GST_ELEMENT_ERROR (src, RESOURCE, SETTINGS, (NULL),
 526         ("Could not activate client (%d:%s)", res, g_strerror (res)));
 527     return FALSE;
 528   }
 529 cannot_connect:
 530   {
 531     GST_ELEMENT_ERROR (src, RESOURCE, SETTINGS, (NULL),
 532         ("Could not connect input ports to physical ports (%d:%s)",
 533             res, g_strerror (res)));
 534     free (ports);
 535     return FALSE;
 536   }
 537 }
 538
 539 /* function is called with LOCK */
 540 static gboolean
 541 gst_jack_ring_buffer_release (GstAudioRingBuffer * buf)
 542 {
 543   GstJackAudioSrc *src;
 544   GstJackRingBuffer *abuf;
 545   gint res;
 546
 547   abuf = GST_JACK_RING_BUFFER_CAST (buf);
 548   src = GST_JACK_AUDIO_SRC (GST_OBJECT_PARENT (buf));
 549
 550   GST_DEBUG_OBJECT (src, "release");
 551
 552   if ((res = gst_jack_audio_client_set_active (src->client, FALSE))) {
 553     /* we only warn, this means the server is probably shut down and the client
 554      * is gone anyway. */
 555     GST_ELEMENT_WARNING (src, RESOURCE, CLOSE, (NULL),
 556         ("Could not deactivate Jack client (%d)", res));
 557   }
 558
 559   abuf->channels = -1;
 560   abuf->buffer_size = -1;
 561   abuf->sample_rate = -1;
 562
 563   /* free the buffer */
 564   g_free (buf->memory);
 565   buf->memory = NULL;
 566
 567   return TRUE;
 568 }
 569
 570 static gboolean
 571 gst_jack_ring_buffer_start (GstAudioRingBuffer * buf)
 572 {
 573   GstJackAudioSrc *src;
 574
 575   src = GST_JACK_AUDIO_SRC (GST_OBJECT_PARENT (buf));
 576
 577   GST_DEBUG_OBJECT (src, "start");
 578
 579   if (src->transport & GST_JACK_TRANSPORT_MASTER) {
 580     jack_client_t *client;
 581
 582     client = gst_jack_audio_client_get_client (src->client);
 583     jack_transport_start (client);
 584   }
 585
 586   return TRUE;
 587 }
 588
 589 static gboolean
 590 gst_jack_ring_buffer_pause (GstAudioRingBuffer * buf)
 591 {
 592   GstJackAudioSrc *src;
 593
 594   src = GST_JACK_AUDIO_SRC (GST_OBJECT_PARENT (buf));
 595
 596   GST_DEBUG_OBJECT (src, "pause");
 597
 598   if (src->transport & GST_JACK_TRANSPORT_MASTER) {
 599     jack_client_t *client;
 600
 601     client = gst_jack_audio_client_get_client (src->client);
 602     jack_transport_stop (client);
 603   }
 604
 605   return TRUE;
 606 }
 607
 608 static gboolean
 609 gst_jack_ring_buffer_stop (GstAudioRingBuffer * buf)
 610 {
 611   GstJackAudioSrc *src;
 612
 613   src = GST_JACK_AUDIO_SRC (GST_OBJECT_PARENT (buf));
 614
 615   GST_DEBUG_OBJECT (src, "stop");
 616
 617   if (src->transport & GST_JACK_TRANSPORT_MASTER) {
 618     jack_client_t *client;
 619
 620     client = gst_jack_audio_client_get_client (src->client);
 621     jack_transport_stop (client);
 622   }
 623
 624   return TRUE;
 625 }
 626
 627 #if defined (HAVE_JACK_0_120_1) || defined(HAVE_JACK_1_9_7)
 628 static guint
 629 gst_jack_ring_buffer_delay (GstAudioRingBuffer * buf)
 630 {
 631   GstJackAudioSrc *src;
 632   guint i, res = 0;
 633   jack_latency_range_t range;
 634
 635   src = GST_JACK_AUDIO_SRC (GST_OBJECT_PARENT (buf));
 636
 637   for (i = 0; i < src->port_count; i++) {
 638     jack_port_get_latency_range (src->ports[i], JackCaptureLatency, &range);
 639     if (range.max > res)
 640       res = range.max;
 641   }
 642
 643   GST_DEBUG_OBJECT (src, "delay %u", res);
 644
 645   return res;
 646 }
 647 #else /* !(defined (HAVE_JACK_0_120_1) || defined(HAVE_JACK_1_9_7)) */
 648 static guint
 649 gst_jack_ring_buffer_delay (GstAudioRingBuffer * buf)
 650 {
 651   GstJackAudioSrc *src;
 652   guint i, res = 0;
 653   guint latency;
 654   jack_client_t *client;
 655
 656   src = GST_JACK_AUDIO_SRC (GST_OBJECT_PARENT (buf));
 657
 658   client = gst_jack_audio_client_get_client (src->client);
 659
 660   for (i = 0; i < src->port_count; i++) {
 661     latency = jack_port_get_total_latency (client, src->ports[i]);
 662     if (latency > res)
 663       res = latency;
 664   }
 665
 666   GST_DEBUG_OBJECT (src, "delay %u", res);
 667
 668   return res;
 669 }
 670 #endif
 671
 672 /* Audiosrc signals and args */
 673 enum
 674 {
 675   /* FILL ME */
 676   LAST_SIGNAL
 677 };
 678
 679 #define DEFAULT_PROP_CONNECT            GST_JACK_CONNECT_AUTO
 680 #define DEFAULT_PROP_SERVER             NULL
 681 #define DEFAULT_PROP_CLIENT_NAME        NULL
 682 #define DEFAULT_PROP_TRANSPORT  GST_JACK_TRANSPORT_AUTONOMOUS
 683
 684 enum
 685 {
 686   PROP_0,
 687   PROP_CONNECT,
 688   PROP_SERVER,
 689   PROP_CLIENT,
 690   PROP_CLIENT_NAME,
 691   PROP_TRANSPORT,
 692   PROP_LAST
 693 };
 694
 695
 696 /* the capabilities of the inputs and outputs.
 697  *
 698  * describe the real formats here.
 699  */
 700
 701 static GstStaticPadTemplate src_factory = GST_STATIC_PAD_TEMPLATE ("src",
 702     GST_PAD_SRC,
 703     GST_PAD_ALWAYS,
 704     GST_STATIC_CAPS ("audio/x-raw, "
 705         "format = (string) " GST_JACK_FORMAT_STR ", "
 706         "layout = (string) interleaved, "
 707         "rate = (int) [ 1, MAX ], " "channels = (int) [ 1, MAX ]")
 708     );
 709
 710 #define gst_jack_audio_src_parent_class parent_class
 711 G_DEFINE_TYPE (GstJackAudioSrc, gst_jack_audio_src, GST_TYPE_AUDIO_BASE_SRC);
 712
 713 static void gst_jack_audio_src_dispose (GObject * object);
 714 static void gst_jack_audio_src_set_property (GObject * object, guint prop_id,
 715     const GValue * value, GParamSpec * pspec);
 716 static void gst_jack_audio_src_get_property (GObject * object, guint prop_id,
 717     GValue * value, GParamSpec * pspec);
 718
 719 static GstCaps *gst_jack_audio_src_getcaps (GstBaseSrc * bsrc,
 720     GstCaps * filter);
 721 static GstAudioRingBuffer *gst_jack_audio_src_create_ringbuffer (GstAudioBaseSrc
 722     * src);
 723
 724 /* GObject vmethod implementations */
 725
 726 /* initialize the jack_audio_src's class */
 727 static void
 728 gst_jack_audio_src_class_init (GstJackAudioSrcClass * klass)
 729 {
 730   GObjectClass *gobject_class;
 731   GstElementClass *gstelement_class;
 732   GstBaseSrcClass *gstbasesrc_class;
 733   GstAudioBaseSrcClass *gstaudiobasesrc_class;
 734
 735   GST_DEBUG_CATEGORY_INIT (gst_jack_audio_src_debug, "jacksrc", 0,
 736       "jacksrc element");
 737
 738   gobject_class = (GObjectClass *) klass;
 739   gstelement_class = (GstElementClass *) klass;
 740   gstbasesrc_class = (GstBaseSrcClass *) klass;
 741   gstaudiobasesrc_class = (GstAudioBaseSrcClass *) klass;
 742
 743   gobject_class->dispose = gst_jack_audio_src_dispose;
 744   gobject_class->set_property = gst_jack_audio_src_set_property;
 745   gobject_class->get_property = gst_jack_audio_src_get_property;
 746
 747   g_object_class_install_property (gobject_class, PROP_CONNECT,
 748       g_param_spec_enum ("connect", "Connect",
 749           "Specify how the input ports will be connected",
 750           GST_TYPE_JACK_CONNECT, DEFAULT_PROP_CONNECT,
 751           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 752
 753   g_object_class_install_property (gobject_class, PROP_SERVER,
 754       g_param_spec_string ("server", "Server",
 755           "The Jack server to connect to (NULL = default)",
 756           DEFAULT_PROP_SERVER, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 757
 758   /**
 759    * GstJackAudioSrc:client-name
 760    *
 761    * The client name to use.
 762    *
 763    * Since: 0.10.31
 764    */
 765   g_object_class_install_property (gobject_class, PROP_CLIENT_NAME,
 766       g_param_spec_string ("client-name", "Client name",
 767           "The client name of the Jack instance (NULL = default)",
 768           DEFAULT_PROP_CLIENT_NAME,
 769           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 770
 771   g_object_class_install_property (gobject_class, PROP_CLIENT,
 772       g_param_spec_boxed ("client", "JackClient", "Handle for jack client",
 773           GST_TYPE_JACK_CLIENT,
 774           GST_PARAM_MUTABLE_READY | G_PARAM_READWRITE |
 775           G_PARAM_STATIC_STRINGS));
 776
 777   /**
 778    * GstJackAudioSink:transport
 779    *
 780    * The jack transport behaviour for the client.
 781    *
 782    * Since: 0.10.31
 783    */
 784   g_object_class_install_property (gobject_class, PROP_TRANSPORT,
 785       g_param_spec_flags ("transport", "Transport mode",
 786           "Jack transport behaviour of the client",
 787           GST_TYPE_JACK_TRANSPORT, DEFAULT_PROP_TRANSPORT,
 788           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 789
 790   gst_element_class_add_pad_template (gstelement_class,
 791       gst_static_pad_template_get (&src_factory));
 792
 793   gst_element_class_set_static_metadata (gstelement_class,
 794       "Audio Source (Jack)", "Source/Audio",
 795       "Captures audio from a JACK server",
 796       "Tristan Matthews <tristan@sat.qc.ca>");
 797
 798   gstbasesrc_class->get_caps = GST_DEBUG_FUNCPTR (gst_jack_audio_src_getcaps);
 799   gstaudiobasesrc_class->create_ringbuffer =
 800       GST_DEBUG_FUNCPTR (gst_jack_audio_src_create_ringbuffer);
 801
 802   /* ref class from a thread-safe context to work around missing bit of
 803    * thread-safety in GObject */
 804   g_type_class_ref (GST_TYPE_JACK_RING_BUFFER);
 805
 806   gst_jack_audio_client_init ();
 807 }
 808
 809 static void
 810 gst_jack_audio_src_init (GstJackAudioSrc * src)
 811 {
 812   //gst_base_src_set_live(GST_BASE_SRC (src), TRUE);
 813   src->connect = DEFAULT_PROP_CONNECT;
 814   src->server = g_strdup (DEFAULT_PROP_SERVER);
 815   src->jclient = NULL;
 816   src->ports = NULL;
 817   src->port_count = 0;
 818   src->buffers = NULL;
 819   src->client_name = g_strdup (DEFAULT_PROP_CLIENT_NAME);
 820   src->transport = DEFAULT_PROP_TRANSPORT;
 821 }
 822
 823 static void
 824 gst_jack_audio_src_dispose (GObject * object)
 825 {
 826   GstJackAudioSrc *src = GST_JACK_AUDIO_SRC (object);
 827
 828   gst_caps_replace (&src->caps, NULL);
 829
 830   if (src->client_name != NULL) {
 831     g_free (src->client_name);
 832     src->client_name = NULL;
 833   }
 834
 835   G_OBJECT_CLASS (parent_class)->dispose (object);
 836 }
 837
 838 static void
 839 gst_jack_audio_src_set_property (GObject * object, guint prop_id,
 840     const GValue * value, GParamSpec * pspec)
 841 {
 842   GstJackAudioSrc *src = GST_JACK_AUDIO_SRC (object);
 843
 844   switch (prop_id) {
 845     case PROP_CLIENT_NAME:
 846       g_free (src->client_name);
 847       src->client_name = g_value_dup_string (value);
 848       break;
 849     case PROP_CONNECT:
 850       src->connect = g_value_get_enum (value);
 851       break;
 852     case PROP_SERVER:
 853       g_free (src->server);
 854       src->server = g_value_dup_string (value);
 855       break;
 856     case PROP_CLIENT:
 857       if (GST_STATE (src) == GST_STATE_NULL ||
 858           GST_STATE (src) == GST_STATE_READY) {
 859         src->jclient = g_value_get_boxed (value);
 860       }
 861       break;
 862     case PROP_TRANSPORT:
 863       src->transport = g_value_get_flags (value);
 864       break;
 865     default:
 866       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 867       break;
 868   }
 869 }
 870
 871 static void
 872 gst_jack_audio_src_get_property (GObject * object, guint prop_id,
 873     GValue * value, GParamSpec * pspec)
 874 {
 875   GstJackAudioSrc *src = GST_JACK_AUDIO_SRC (object);
 876
 877   switch (prop_id) {
 878     case PROP_CLIENT_NAME:
 879       g_value_set_string (value, src->client_name);
 880       break;
 881     case PROP_CONNECT:
 882       g_value_set_enum (value, src->connect);
 883       break;
 884     case PROP_SERVER:
 885       g_value_set_string (value, src->server);
 886       break;
 887     case PROP_CLIENT:
 888       g_value_set_boxed (value, src->jclient);
 889       break;
 890     case PROP_TRANSPORT:
 891       g_value_set_flags (value, src->transport);
 892       break;
 893     default:
 894       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 895       break;
 896   }
 897 }
 898
 899 static GstCaps *
 900 gst_jack_audio_src_getcaps (GstBaseSrc * bsrc, GstCaps * filter)
 901 {
 902   GstJackAudioSrc *src = GST_JACK_AUDIO_SRC (bsrc);
 903   const char **ports;
 904   gint min, max;
 905   gint rate;
 906   jack_client_t *client;
 907
 908   if (src->client == NULL)
 909     goto no_client;
 910
 911   client = gst_jack_audio_client_get_client (src->client);
 912
 913   if (src->connect == GST_JACK_CONNECT_AUTO) {
 914     /* get a port count, this is the number of channels we can automatically
 915      * connect. */
 916     ports = jack_get_ports (client, NULL, NULL,
 917         JackPortIsPhysical | JackPortIsOutput);
 918     max = 0;
 919     if (ports != NULL) {
 920       for (; ports[max]; max++);
 921
 922       free (ports);
 923     } else
 924       max = 0;
 925   } else {
 926     /* we allow any number of pads, something else is going to connect the
 927      * pads. */
 928     max = G_MAXINT;
 929   }
 930   min = MIN (1, max);
 931
 932   rate = jack_get_sample_rate (client);
 933
 934   GST_DEBUG_OBJECT (src, "got %d-%d ports, samplerate: %d", min, max, rate);
 935
 936   if (!src->caps) {
 937     src->caps = gst_caps_new_simple ("audio/x-raw",
 938         "format", G_TYPE_STRING, GST_JACK_FORMAT_STR,
 939         "layout", G_TYPE_STRING, "interleaved",
 940         "rate", G_TYPE_INT, rate,
 941         "channels", GST_TYPE_INT_RANGE, min, max, NULL);
 942   }
 943   GST_INFO_OBJECT (src, "returning caps %" GST_PTR_FORMAT, src->caps);
 944
 945   return gst_caps_ref (src->caps);
 946
 947   /* ERRORS */
 948 no_client:
 949   {
 950     GST_DEBUG_OBJECT (src, "device not open, using template caps");
 951     /* base class will get template caps for us when we return NULL */
 952     return NULL;
 953   }
 954 }
 955
 956 static GstAudioRingBuffer *
 957 gst_jack_audio_src_create_ringbuffer (GstAudioBaseSrc * src)
 958 {
 959   GstAudioRingBuffer *buffer;
 960
 961   buffer = g_object_new (GST_TYPE_JACK_RING_BUFFER, NULL);
 962   GST_DEBUG_OBJECT (src, "created ringbuffer @%p", buffer);
 963
 964   return buffer;
 965 }