tools/capture_client.c

   1 /*
   2     Copyright (C) 2001 Paul Davis
   3     Copyright (C) 2003 Jack O'Quin
   4
   5     This program is free software; you can redistribute it and/or modify
   6     it under the terms of the GNU General Public License as published by
   7     the Free Software Foundation; either version 2 of the License, or
   8     (at your option) any later version.
   9
  10     This program is distributed in the hope that it will be useful,
  11     but WITHOUT ANY WARRANTY; without even the implied warranty of
  12     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13     GNU General Public License for more details.
  14
  15     You should have received a copy of the GNU General Public License
  16     along with this program; if not, write to the Free Software
  17     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  18
  19     * 2002/08/23 - modify for libsndfile 1.0.0 <andy@alsaplayer.org>
  20     * 2003/05/26 - use ringbuffers - joq
  21
  22 */
  23
  24 #include <stdio.h>
  25 #include <stdlib.h>
  26 #include <string.h>
  27 #include <errno.h>
  28 #include <unistd.h>
  29 #include <sndfile.h>
  30 #include <pthread.h>
  31 #include <getopt.h>
  32 #include <jack/jack.h>
  33 #include <jack/ringbuffer.h>
  34
  35 typedef struct _thread_info {
  36     pthread_t thread_id;
  37     SNDFILE *sf;
  38     jack_nframes_t duration;
  39     jack_nframes_t rb_size;
  40     jack_client_t *client;
  41     unsigned int channels;
  42     int bitdepth;
  43     char *path;
  44     volatile int can_capture;
  45     volatile int can_process;
  46     volatile int status;
  47 } jack_thread_info_t;
  48
  49 /* JACK data */
  50 unsigned int nports;
  51 jack_port_t **ports;
  52 jack_default_audio_sample_t **in;
  53 jack_nframes_t nframes;
  54 const size_t sample_size = sizeof(jack_default_audio_sample_t);
  55
  56 /* Synchronization between process thread and disk thread. */
  57 #define DEFAULT_RB_SIZE 16384           /* ringbuffer size in frames */
  58 jack_ringbuffer_t *rb;
  59 pthread_mutex_t disk_thread_lock = PTHREAD_MUTEX_INITIALIZER;
  60 pthread_cond_t  data_ready = PTHREAD_COND_INITIALIZER;
  61 long overruns = 0;
  62
  63
  64 void *
  65 disk_thread (void *arg)
  66 {
  67         jack_thread_info_t *info = (jack_thread_info_t *) arg;
  68         static jack_nframes_t total_captured = 0;
  69         jack_nframes_t samples_per_frame = info->channels;
  70         size_t bytes_per_frame = samples_per_frame * sample_size;
  71         void *framebuf = malloc (bytes_per_frame);
  72
  73         pthread_setcanceltype (PTHREAD_CANCEL_ASYNCHRONOUS, NULL);
  74         pthread_mutex_lock (&disk_thread_lock);
  75
  76         info->status = 0;
  77
  78         while (1) {
  79
  80                 /* Write the data one frame at a time.  This is
  81                  * inefficient, but makes things simpler. */
  82                 while (info->can_capture &&
  83                        (jack_ringbuffer_read_space (rb) >= bytes_per_frame)) {
  84
  85                         jack_ringbuffer_read (rb, framebuf, bytes_per_frame);
  86
  87                         if (sf_writef_float (info->sf, framebuf, 1) != 1) {
  88                                 char errstr[256];
  89                                 sf_error_str (0, errstr, sizeof (errstr) - 1);
  90                                 fprintf (stderr,
  91                                          "cannot write sndfile (%s)\n",
  92                                          errstr);
  93                                 info->status = EIO; /* write failed */
  94                                 goto done;
  95                         }
  96
  97                         if (++total_captured >= info->duration) {
  98                                 printf ("disk thread finished\n");
  99                                 goto done;
 100                         }
 101                 }
 102
 103                 /* wait until process() signals more data */
 104                 pthread_cond_wait (&data_ready, &disk_thread_lock);
 105         }
 106
 107  done:
 108         pthread_mutex_unlock (&disk_thread_lock);
 109         free (framebuf);
 110         return 0;
 111 }
 112
 113 int
 114 process (jack_nframes_t nframes, void *arg)
 115 {
 116         int chn;
 117         size_t i;
 118         jack_thread_info_t *info = (jack_thread_info_t *) arg;
 119
 120         /* Do nothing until we're ready to begin. */
 121         if ((!info->can_process) || (!info->can_capture))
 122                 return 0;
 123
 124         for (chn = 0; chn < nports; chn++)
 125                 in[chn] = jack_port_get_buffer (ports[chn], nframes);
 126
 127         /* Sndfile requires interleaved data.  It is simpler here to
 128          * just queue interleaved samples to a single ringbuffer. */
 129         for (i = 0; i < nframes; i++) {
 130                 for (chn = 0; chn < nports; chn++) {
 131                         if (jack_ringbuffer_write (rb, (void *) (in[chn]+i),
 132                                               sample_size)
 133                             < sample_size)
 134                                 overruns++;
 135                 }
 136         }
 137
 138         /* Tell the disk thread there is work to do.  If it is already
 139          * running, the lock will not be available.  We can't wait
 140          * here in the process() thread, but we don't need to signal
 141          * in that case, because the disk thread will read all the
 142          * data queued before waiting again. */
 143         if (pthread_mutex_trylock (&disk_thread_lock) == 0) {
 144             pthread_cond_signal (&data_ready);
 145             pthread_mutex_unlock (&disk_thread_lock);
 146         }
 147
 148         return 0;
 149 }
 150
 151 void
 152 jack_shutdown (void *arg)
 153 {
 154         fprintf (stderr, "JACK shutdown\n");
 155         // exit (0);
 156         abort();
 157 }
 158
 159 void
 160 setup_disk_thread (jack_thread_info_t *info)
 161 {
 162         SF_INFO sf_info;
 163         int short_mask;
 164
 165         sf_info.samplerate = jack_get_sample_rate (info->client);
 166         sf_info.channels = info->channels;
 167
 168         switch (info->bitdepth) {
 169                 case 8: short_mask = SF_FORMAT_PCM_U8;
 170                         break;
 171                 case 16: short_mask = SF_FORMAT_PCM_16;
 172                          break;
 173                 case 24: short_mask = SF_FORMAT_PCM_24;
 174                          break;
 175                 case 32: short_mask = SF_FORMAT_PCM_32;
 176                          break;
 177                 default: short_mask = SF_FORMAT_PCM_16;
 178                          break;
 179         }
 180         sf_info.format = SF_FORMAT_WAV|short_mask;
 181
 182         if ((info->sf = sf_open (info->path, SFM_WRITE, &sf_info)) == NULL) {
 183                 char errstr[256];
 184                 sf_error_str (0, errstr, sizeof (errstr) - 1);
 185                 fprintf (stderr, "cannot open sndfile \"%s\" for output (%s)\n", info->path, errstr);
 186                 jack_client_close (info->client);
 187                 exit (1);
 188         }
 189
 190         if (info->duration == 0) {
 191                 info->duration = JACK_MAX_FRAMES;
 192         } else {
 193                 info->duration *= sf_info.samplerate;
 194         }
 195
 196         info->can_capture = 0;
 197
 198         pthread_create (&info->thread_id, NULL, disk_thread, info);
 199 }
 200
 201 void
 202 run_disk_thread (jack_thread_info_t *info)
 203 {
 204         info->can_capture = 1;
 205         pthread_join (info->thread_id, NULL);
 206         sf_close (info->sf);
 207         if (overruns > 0) {
 208                 fprintf (stderr,
 209                          "jackrec failed with %ld overruns.\n", overruns);
 210                 fprintf (stderr, " try a bigger buffer than -B %"
 211                          PRIu32 ".\n", info->rb_size);
 212                 info->status = EPIPE;
 213         }
 214 }
 215
 216 void
 217 setup_ports (int sources, char *source_names[], jack_thread_info_t *info)
 218 {
 219         unsigned int i;
 220         size_t in_size;
 221
 222         /* Allocate data structures that depend on the number of ports. */
 223         nports = sources;
 224         ports = (jack_port_t **) malloc (sizeof (jack_port_t *) * nports);
 225         in_size =  nports * sizeof (jack_default_audio_sample_t *);
 226         in = (jack_default_audio_sample_t **) malloc (in_size);
 227         rb = jack_ringbuffer_create (nports * sample_size * info->rb_size);
 228
 229         /* When JACK is running realtime, jack_activate() will have
 230          * called mlockall() to lock our pages into memory.  But, we
 231          * still need to touch any newly allocated pages before
 232          * process() starts using them.  Otherwise, a page fault could
 233          * create a delay that would force JACK to shut us down. */
 234         memset(in, 0, in_size);
 235         memset(rb->buf, 0, rb->size);
 236
 237         for (i = 0; i < nports; i++) {
 238                 char name[64];
 239
 240                 sprintf (name, "input%d", i+1);
 241
 242                 if ((ports[i] = jack_port_register (info->client, name, JACK_DEFAULT_AUDIO_TYPE, JackPortIsInput, 0)) == 0) {
 243                         fprintf (stderr, "cannot register input port \"%s\"!\n", name);
 244                         jack_client_close (info->client);
 245                         exit (1);
 246                 }
 247         }
 248
 249         for (i = 0; i < nports; i++) {
 250                 if (jack_connect (info->client, source_names[i], jack_port_name (ports[i]))) {
 251                         fprintf (stderr, "cannot connect input port %s to %s\n", jack_port_name (ports[i]), source_names[i]);
 252                         jack_client_close (info->client);
 253                         exit (1);
 254                 }
 255         }
 256
 257         info->can_process = 1;          /* process() can start, now */
 258 }
 259
 260 int
 261 main (int argc, char *argv[])
 262
 263 {
 264         jack_client_t *client;
 265         jack_thread_info_t thread_info;
 266         int c;
 267         int longopt_index = 0;
 268         extern int optind, opterr;
 269         int show_usage = 0;
 270         char *optstring = "d:f:b:B:h";
 271         struct option long_options[] = {
 272                 { "help", 0, 0, 'h' },
 273                 { "duration", 1, 0, 'd' },
 274                 { "file", 1, 0, 'f' },
 275                 { "bitdepth", 1, 0, 'b' },
 276                 { "bufsize", 1, 0, 'B' },
 277                 { 0, 0, 0, 0 }
 278         };
 279
 280         memset (&thread_info, 0, sizeof (thread_info));
 281         thread_info.rb_size = DEFAULT_RB_SIZE;
 282         opterr = 0;
 283
 284         while ((c = getopt_long (argc, argv, optstring, long_options, &longopt_index)) != -1) {
 285                 switch (c) {
 286                 case 1:
 287                         /* getopt signals end of '-' options */
 288                         break;
 289
 290                 case 'h':
 291                         show_usage++;
 292                         break;
 293                 case 'd':
 294                         thread_info.duration = atoi (optarg);
 295                         break;
 296                 case 'f':
 297                         thread_info.path = optarg;
 298                         break;
 299                 case 'b':
 300                         thread_info.bitdepth = atoi (optarg);
 301                         break;
 302                 case 'B':
 303                         thread_info.rb_size = atoi (optarg);
 304                         break;
 305                 default:
 306                         fprintf (stderr, "error\n");
 307                         show_usage++;
 308                         break;
 309                 }
 310         }
 311
 312         if (show_usage || thread_info.path == NULL || optind == argc) {
 313                 fprintf (stderr, "usage: jackrec -f filename [ -d second ] [ -b bitdepth ] [ -B bufsize ] port1 [ port2 ... ]\n");
 314                 exit (1);
 315         }
 316
 317         if ((client = jack_client_new ("jackrec")) == 0) {
 318                 fprintf (stderr, "jack server not running?\n");
 319                 exit (1);
 320         }
 321
 322         thread_info.client = client;
 323         thread_info.channels = argc - optind;
 324         thread_info.can_process = 0;
 325
 326         setup_disk_thread (&thread_info);
 327
 328         jack_set_process_callback (client, process, &thread_info);
 329         jack_on_shutdown (client, jack_shutdown, &thread_info);
 330
 331         if (jack_activate (client)) {
 332                 fprintf (stderr, "cannot activate client");
 333         }
 334
 335         setup_ports (argc - optind, &argv[optind], &thread_info);
 336
 337         run_disk_thread (&thread_info);
 338
 339         jack_client_close (client);
 340
 341         jack_ringbuffer_free (rb);
 342
 343         exit (0);
 344 }