chiark - git - mdw - disorder/blob - server/gstdecode.c

   1 /*
   2  * This file is part of DisOrder
   3  * Copyright (C) 2013 Mark Wooding
   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 3 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, see <http://www.gnu.org/licenses/>.
  17  */
  18 /** @file server/gstdecode.c
  19  * @brief Decode compressed audio files, and apply ReplayGain.
  20  */
  21
  22 #include "disorder-server.h"
  23
  24 #include "speaker-protocol.h"
  25
  26 /* Ugh.  It turns out that libxml tries to define a function called
  27  * `attribute', and it's included by GStreamer for some unimaginable reason.
  28  * So undefine it here.  We'll want GCC attributes for special effects, but
  29  * can take care of ourselves.
  30  */
  31 #undef attribute
  32
  33 #include <glib.h>
  34 #include <gst/gst.h>
  35 #include <gst/app/gstappsink.h>
  36 #include <gst/audio/audio.h>
  37
  38 /* The only application we have for `attribute' is declaring function
  39  * arguments as being unused, because we have a lot of callback functions
  40  * which are meant to comply with an externally defined interface.
  41  */
  42 #ifdef __GNUC__
  43 #  define UNUSED __attribute__((unused))
  44 #endif
  45
  46 #define END ((void *)0)
  47 #define N(v) (sizeof(v)/sizeof(*(v)))
  48
  49 static FILE *fp;
  50 static const char *file;
  51 static GstAppSink *appsink;
  52 static GstElement *pipeline;
  53 static GMainLoop *loop;
  54 static unsigned flags = 0;
  55 #define f_stream 1u
  56
  57 #define MODES(_) _("off", OFF) _("track", TRACK) _("album", ALBUM)
  58 enum {
  59 #define DEFENUM(name, tag) tag,
  60   MODES(DEFENUM)
  61 #undef DEFENUM
  62   NMODES
  63 };
  64 static const char *const modes[] = {
  65 #define DEFNAME(name, tag) name,
  66   MODES(DEFNAME)
  67 #undef DEFNAME
  68   0
  69 };
  70
  71 static const char *const dithers[] = {
  72   "none", "rpdf", "tpdf", "tpdf-hf", 0
  73 };
  74
  75 static const char *const shapes[] = {
  76   "none", "error-feedback", "simple", "medium", "high", 0
  77 };
  78
  79 static int dither = -1;
  80 static int mode = ALBUM;
  81 static int quality = -1;
  82 static int shape = -1;
  83 static gdouble fallback = 0.0;
  84
  85 static struct stream_header hdr;
  86
  87 /* Report the pads of an element ELT, as iterated by IT; WHAT is an adjective
  88  * phrase describing the pads for use in the output.
  89  */
  90 static void report_element_pads(const char *what, GstElement *elt,
  91                                 GstIterator *it)
  92 {
  93   gchar *cs;
  94 #ifdef HAVE_GSTREAMER_0_10
  95   gpointer pad;
  96 #else
  97   GValue gv;
  98   GstPad *pad;
  99   GstCaps *caps;
 100 #endif
 101
 102   for(;;) {
 103 #ifdef HAVE_GSTREAMER_0_10
 104     switch(gst_iterator_next(it, &pad)) {
 105 #else
 106     switch(gst_iterator_next(it, &gv)) {
 107 #endif
 108     case GST_ITERATOR_DONE:
 109       goto done;
 110     case GST_ITERATOR_OK:
 111 #ifdef HAVE_GSTREAMER_0_10
 112       cs = gst_caps_to_string(GST_PAD_CAPS(pad));
 113 #else
 114       assert(G_VALUE_HOLDS(&gv, GST_TYPE_PAD));
 115       pad = g_value_get_object(&gv);
 116       caps = gst_pad_query_caps(pad, 0);
 117       cs = gst_caps_to_string(caps);
 118       gst_caps_unref(caps);
 119 #endif
 120       disorder_error(0, "  `%s' %s pad: %s", GST_OBJECT_NAME(elt), what, cs);
 121       g_free(cs);
 122       gst_object_unref(pad);
 123       break;
 124     case GST_ITERATOR_RESYNC:
 125       gst_iterator_resync(it);
 126       break;
 127     case GST_ITERATOR_ERROR:
 128       disorder_error(0, "<failed to enumerate `%s' %s pads>",
 129                      GST_OBJECT_NAME(elt), what);
 130       goto done;
 131     }
 132   }
 133
 134 done:
 135   gst_iterator_free(it);
 136 }
 137
 138 /* Link together two elements; fail with an approximately useful error
 139  * message if it didn't work.
 140  */
 141 static void link_elements(GstElement *left, GstElement *right)
 142 {
 143   /* Try to link things together. */
 144   if(gst_element_link(left, right)) return;
 145
 146   /* If this didn't work, it's probably for some really hairy reason, so
 147    * provide a bunch of debugging information.
 148    */
 149   disorder_error(0, "failed to link GStreamer elements `%s' and `%s'",
 150                  GST_OBJECT_NAME(left), GST_OBJECT_NAME(right));
 151   report_element_pads("source", left, gst_element_iterate_src_pads(left));
 152   report_element_pads("source", right, gst_element_iterate_sink_pads(right));
 153   disorder_fatal(0, "can't decode `%s'", file);
 154 }
 155
 156 /* The `decoderbin' element (DECODE) has deigned to announce a new PAD.
 157  * Maybe we should attach the tag end of our pipeline (starting with the
 158  * element U) to it.
 159  */
 160 static void decoder_pad_arrived(GstElement *decode, GstPad *pad, gpointer u)
 161 {
 162   GstElement *tail = u;
 163 #ifdef HAVE_GSTREAMER_0_10
 164   GstCaps *caps = gst_pad_get_caps(pad);
 165 #else
 166   GstCaps *caps = gst_pad_get_current_caps(pad);
 167 #endif
 168   GstStructure *s;
 169   guint i, n;
 170   const gchar *name;
 171
 172   /* The input file could be more or less anything, so this could be any kind
 173    * of pad.  We're only interested if it's audio, so let's go check.
 174    */
 175   for(i = 0, n = gst_caps_get_size(caps); i < n; i++) {
 176     s = gst_caps_get_structure(caps, i);
 177     name = gst_structure_get_name(s);
 178 #ifdef HAVE_GSTREAMER_0_10
 179     if(strncmp(name, "audio/x-raw-", 12) == 0)
 180 #else
 181     if(strcmp(name, "audio/x-raw") == 0)
 182 #endif
 183       goto match;
 184   }
 185   goto end;
 186
 187 match:
 188   /* Yes, it's audio.  Link the two elements together. */
 189   link_elements(decode, tail);
 190
 191   /* If requested using the environemnt variable `GST_DEBUG_DUMP_DOT_DIR',
 192    * write a dump of the now-completed pipeline.
 193    */
 194   GST_DEBUG_BIN_TO_DOT_FILE(GST_BIN(pipeline),
 195                             GST_DEBUG_GRAPH_SHOW_ALL,
 196                             "disorder-gstdecode");
 197
 198 end:
 199   gst_caps_unref(caps);
 200 }
 201
 202 /* Prepare the GStreamer pipeline, ready to decode the given FILE.  This sets
 203  * up the variables `appsink' and `pipeline'.
 204  */
 205 static void prepare_pipeline(void)
 206 {
 207   GstElement *source = gst_element_factory_make("filesrc", "file");
 208   GstElement *decode = gst_element_factory_make("decodebin", "decode");
 209   GstElement *resample = gst_element_factory_make("audioresample",
 210                                                   "resample");
 211   GstElement *convert = gst_element_factory_make("audioconvert", "convert");
 212   GstElement *sink = gst_element_factory_make("appsink", "sink");
 213   GstElement *tail = sink;
 214   GstElement *gain;
 215   GstCaps *caps;
 216   const struct stream_header *fmt = &config->sample_format;
 217
 218 #ifndef HAVE_GSTREAMER_0_10
 219   static const struct fmttab {
 220     const char *fmt;
 221     unsigned bits;
 222     unsigned endian;
 223   } fmttab[] = {
 224     { "S8", 8, ENDIAN_BIG },
 225     { "S8", 8, ENDIAN_LITTLE },
 226     { "S16BE", 16, ENDIAN_BIG },
 227     { "S16LE", 16, ENDIAN_LITTLE },
 228     { 0 }
 229   };
 230   const struct fmttab *ft;
 231 #endif
 232
 233   /* Set up the global variables. */
 234   pipeline = gst_pipeline_new("pipe");
 235   appsink = GST_APP_SINK(sink);
 236
 237   /* Configure the various simple elements. */
 238   g_object_set(source, "location", file, END);
 239   g_object_set(sink, "sync", FALSE, END);
 240
 241   /* Configure the resampler and converter.  Leave things as their defaults
 242    * if the user hasn't made an explicit request.
 243    */
 244   if(quality >= 0) g_object_set(resample, "quality", quality, END);
 245   if(dither >= 0) g_object_set(convert, "dithering", dither, END);
 246   if(shape >= 0) g_object_set(convert, "noise-shaping", shape, END);
 247
 248   /* Set up the sink's capabilities from the configuration. */
 249 #ifdef HAVE_GSTREAMER_0_10
 250   caps = gst_caps_new_simple("audio/x-raw-int",
 251                              "width", G_TYPE_INT, fmt->bits,
 252                              "depth", G_TYPE_INT, fmt->bits,
 253                              "channels", G_TYPE_INT, fmt->channels,
 254                              "signed", G_TYPE_BOOLEAN, TRUE,
 255                              "rate", G_TYPE_INT, fmt->rate,
 256                              "endianness", G_TYPE_INT,
 257                                fmt->endian == ENDIAN_BIG ?
 258                                  G_BIG_ENDIAN : G_LITTLE_ENDIAN,
 259                              END);
 260 #else
 261   for (ft = fmttab; ft->fmt; ft++)
 262     if (ft->bits == fmt->bits && ft->endian == fmt->endian) break;
 263   if(!ft->fmt) {
 264     disorder_fatal(0, "unsupported sample format: bits=%"PRIu32", endian=%u",
 265                    fmt->bits, fmt->endian);
 266   }
 267   caps = gst_caps_new_simple("audio/x-raw",
 268                              "format", G_TYPE_STRING, ft->fmt,
 269                              "channels", G_TYPE_INT, fmt->channels,
 270                              "rate", G_TYPE_INT, fmt->rate,
 271                              END);
 272 #endif
 273   gst_app_sink_set_caps(appsink, caps);
 274   gst_caps_unref(caps);
 275
 276   /* Add the various elements into the pipeline.  We'll stitch them together
 277    * in pieces, because the pipeline is somewhat dynamic.
 278    */
 279   gst_bin_add_many(GST_BIN(pipeline),
 280                    source, decode,
 281                    resample, convert, sink, END);
 282
 283   /* Link audio conversion stages onto the front.  The rest of DisOrder
 284    * doesn't handle much of the full panoply of exciting audio formats.
 285    */
 286   link_elements(convert, tail); tail = convert;
 287   link_elements(resample, tail); tail = resample;
 288
 289   /* If we're meant to do ReplayGain then insert it into the pipeline before
 290    * the converter.
 291    */
 292   if(mode != OFF) {
 293     gain = gst_element_factory_make("rgvolume", "gain");
 294     g_object_set(gain,
 295                  "album-mode", mode == ALBUM,
 296                  "fallback-gain", fallback,
 297                  END);
 298     gst_bin_add(GST_BIN(pipeline), gain);
 299     link_elements(gain, tail); tail = gain;
 300   }
 301
 302   /* Link the source and the decoder together.  The `decodebin' is annoying
 303    * and doesn't have any source pads yet, so the best we can do is make two
 304    * halves of the chain, and add a hook to stitch them together later.
 305    */
 306   link_elements(source, decode);
 307   g_signal_connect(decode, "pad-added",
 308                    G_CALLBACK(decoder_pad_arrived), tail);
 309 }
 310
 311 /* Respond to a message from the BUS.  The only thing we need worry about
 312  * here is errors from the pipeline.
 313  */
 314 static void bus_message(GstBus UNUSED *bus, GstMessage *msg,
 315                         gpointer UNUSED u)
 316 {
 317   switch(GST_MESSAGE_TYPE(msg)) {
 318   case GST_MESSAGE_ERROR:
 319     disorder_fatal(0, "%s",
 320                    gst_structure_get_string(gst_message_get_structure(msg),
 321                                             "debug"));
 322   default:
 323     break;
 324   }
 325 }
 326
 327 /* End of stream.  Stop polling the main loop. */
 328 static void cb_eos(GstAppSink UNUSED *sink, gpointer UNUSED u)
 329   { g_main_loop_quit(loop); }
 330
 331 /* Preroll buffers are prepared when the pipeline moves to the `paused'
 332  * state, so that they're ready for immediate playback.  Conveniently, they
 333  * also carry format information, which is what we want here.  Stash the
 334  * sample format information in the `stream_header' structure ready for
 335  * actual buffers of interesting data.
 336  */
 337 static GstFlowReturn cb_preroll(GstAppSink *sink, gpointer UNUSED u)
 338 {
 339 #ifdef HAVE_GSTREAMER_0_10
 340   GstBuffer *buf = gst_app_sink_pull_preroll(sink);
 341   GstCaps *caps = GST_BUFFER_CAPS(buf);
 342 #else
 343   GstSample *samp = gst_app_sink_pull_preroll(sink);
 344   GstCaps *caps = gst_sample_get_caps(samp);
 345 #endif
 346
 347 #ifdef HAVE_GST_AUDIO_INFO_FROM_CAPS
 348
 349   /* Parse the audio format information out of the caps.  There's a handy
 350    * function to do this in later versions of gst-plugins-base, so use that
 351    * if it's available.  Once we no longer care about supporting such old
 352    * versions we can delete the version which does the job the hard way.
 353    */
 354
 355   GstAudioInfo ai;
 356
 357   if(!gst_audio_info_from_caps(&ai, caps))
 358     disorder_fatal(0, "can't decode `%s': failed to parse audio info", file);
 359   hdr.rate = ai.rate;
 360   hdr.channels = ai.channels;
 361   hdr.bits = ai.finfo->width;
 362   hdr.endian = ai.finfo->endianness == G_BIG_ENDIAN ?
 363     ENDIAN_BIG : ENDIAN_LITTLE;
 364
 365 #else
 366
 367   GstStructure *s;
 368   const char *ty;
 369   gint rate, channels, bits, endian;
 370   gboolean signedp;
 371
 372   /* Make sure that the caps is basically the right shape. */
 373   if(!GST_CAPS_IS_SIMPLE(caps)) disorder_fatal(0, "expected simple caps");
 374   s = gst_caps_get_structure(caps, 0);
 375   ty = gst_structure_get_name(s);
 376   if(strcmp(ty, "audio/x-raw-int") != 0)
 377     disorder_fatal(0, "unexpected content type `%s'", ty);
 378
 379   /* Extract fields from the structure. */
 380   if(!gst_structure_get(s,
 381                         "rate", G_TYPE_INT, &rate,
 382                         "channels", G_TYPE_INT, &channels,
 383                         "width", G_TYPE_INT, &bits,
 384                         "endianness", G_TYPE_INT, &endian,
 385                         "signed", G_TYPE_BOOLEAN, &signedp,
 386                         END))
 387     disorder_fatal(0, "can't decode `%s': failed to parse audio caps", file);
 388   hdr.rate = rate; hdr.channels = channels; hdr.bits = bits;
 389   hdr.endian = endian == G_BIG_ENDIAN ? ENDIAN_BIG : ENDIAN_LITTLE;
 390
 391 #endif
 392
 393 #ifdef HAVE_GSTREAMER_0_10
 394   gst_buffer_unref(buf);
 395 #else
 396   gst_sample_unref(samp);
 397 #endif
 398   return GST_FLOW_OK;
 399 }
 400
 401 /* A new buffer of sample data has arrived, so we should pass it on with
 402  * appropriate framing.
 403  */
 404 static GstFlowReturn cb_buffer(GstAppSink *sink, gpointer UNUSED u)
 405 {
 406 #ifdef HAVE_GSTREAMER_0_10
 407   GstBuffer *buf = gst_app_sink_pull_buffer(sink);
 408 #else
 409   GstSample *samp = gst_app_sink_pull_sample(sink);
 410   GstBuffer *buf = gst_sample_get_buffer(samp);
 411   GstMemory *mem;
 412   GstMapInfo map;
 413   gint i, n;
 414 #endif
 415
 416   /* Make sure we actually have a grip on the sample format here. */
 417   if(!hdr.rate) disorder_fatal(0, "format unset");
 418
 419   /* Write out a frame of audio data. */
 420 #ifdef HAVE_GSTREAMER_0_10
 421   hdr.nbytes = GST_BUFFER_SIZE(buf);
 422   if((!(flags&f_stream) && fwrite(&hdr, sizeof(hdr), 1, fp) != 1) ||
 423      fwrite(GST_BUFFER_DATA(buf), 1, hdr.nbytes, fp) != hdr.nbytes)
 424     disorder_fatal(errno, "output");
 425 #else
 426   for(i = 0, n = gst_buffer_n_memory(buf); i < n; i++) {
 427     mem = gst_buffer_peek_memory(buf, i);
 428     if(!gst_memory_map(mem, &map, GST_MAP_READ))
 429       disorder_fatal(0, "failed to map sample buffer");
 430     hdr.nbytes = map.size;
 431     if((!(flags&f_stream) && fwrite(&hdr, sizeof(hdr), 1, fp) != 1) ||
 432        fwrite(map.data, 1, map.size, fp) != map.size)
 433       disorder_fatal(errno, "output");
 434     gst_memory_unmap(mem, &map);
 435   }
 436 #endif
 437
 438   /* And we're done. */
 439 #ifdef HAVE_GSTREAMER_0_10
 440   gst_buffer_unref(buf);
 441 #else
 442   gst_sample_unref(samp);
 443 #endif
 444   return GST_FLOW_OK;
 445 }
 446
 447 static GstAppSinkCallbacks callbacks = {
 448   .eos = cb_eos,
 449   .new_preroll = cb_preroll,
 450 #ifdef HAVE_GSTREAMER_0_10
 451   .new_buffer = cb_buffer
 452 #else
 453   .new_sample = cb_buffer
 454 #endif
 455 };
 456
 457 /* Decode the audio file.  We're already set up for everything. */
 458 static void decode(void)
 459 {
 460   GstBus *bus = gst_pipeline_get_bus(GST_PIPELINE(pipeline));
 461
 462   /* Set up the message bus and main loop. */
 463   gst_bus_add_signal_watch(bus);
 464   loop = g_main_loop_new(0, FALSE);
 465   g_signal_connect(bus, "message", G_CALLBACK(bus_message), 0);
 466
 467   /* Tell the sink to call us when interesting things happen. */
 468   gst_app_sink_set_max_buffers(appsink, 16);
 469   gst_app_sink_set_drop(appsink, FALSE);
 470   gst_app_sink_set_callbacks(appsink, &callbacks, 0, 0);
 471
 472   /* Set the ball rolling. */
 473   gst_element_set_state(GST_ELEMENT(pipeline), GST_STATE_PLAYING);
 474
 475   /* And wait for the miracle to come. */
 476   g_main_loop_run(loop);
 477
 478   /* Shut down the pipeline.  This isn't strictly necessary, since we're
 479    * about to exit very soon, but it's kind of polite.
 480    */
 481   gst_element_set_state(GST_ELEMENT(pipeline), GST_STATE_NULL);
 482 }
 483
 484 static int getenum(const char *what, const char *s, const char *const *tags)
 485 {
 486   int i;
 487
 488   for(i = 0; tags[i]; i++)
 489     if(strcmp(s, tags[i]) == 0) return i;
 490   disorder_fatal(0, "unknown %s `%s'", what, s);
 491 }
 492
 493 static double getfloat(const char *what, const char *s)
 494 {
 495   double d;
 496   char *q;
 497
 498   errno = 0;
 499   d = strtod(s, &q);
 500   if(*q || errno) disorder_fatal(0, "invalid %s `%s'", what, s);
 501   return d;
 502 }
 503
 504 static int getint(const char *what, const char *s, int min, int max)
 505 {
 506   long i;
 507   char *q;
 508
 509   errno = 0;
 510   i = strtol(s, &q, 10);
 511   if(*q || errno || min > i || i > max)
 512     disorder_fatal(0, "invalid %s `%s'", what, s);
 513   return (int)i;
 514 }
 515
 516 static const struct option options[] = {
 517   { "help", no_argument, 0, 'h' },
 518   { "version", no_argument, 0, 'V' },
 519   { "config", required_argument, 0, 'c' },
 520   { "dither", required_argument, 0, 'd' },
 521   { "fallback-gain", required_argument, 0, 'f' },
 522   { "noise-shape", required_argument, 0, 'n' },
 523   { "quality", required_argument, 0, 'q' },
 524   { "replay-gain", required_argument, 0, 'r' },
 525   { "stream", no_argument, 0, 's' },
 526   { 0, 0, 0, 0 }
 527 };
 528
 529 static void help(void)
 530 {
 531   xprintf("Usage:\n"
 532           "  disorder-gstdecode [OPTIONS] PATH\n"
 533           "Options:\n"
 534           "  --help, -h                 Display usage message\n"
 535           "  --version, -V              Display version number\n"
 536           "  --config PATH, -c PATH     Set configuration file\n"
 537           "  --dither TYPE, -d TYPE     TYPE is `none', `rpdf', `tpdf', or "
 538                                                 "`tpdf-hf'\n"
 539           "  --fallback-gain DB, -f DB  For tracks without ReplayGain data\n"
 540           "  --noise-shape TYPE, -n TYPE  TYPE is `none', `error-feedback',\n"
 541           "                                     `simple', `medium' or `high'\n"
 542           "  --quality QUAL, -q QUAL    Resampling quality: 0 poor, 10 good\n"
 543           "  --replay-gain MODE, -r MODE  MODE is `off', `track' or `album'\n"
 544           "  --stream, -s               Output raw samples, without framing\n"
 545           "\n"
 546           "Alternative audio decoder for DisOrder.  Only intended to be\n"
 547           "used by speaker process, not for normal users.\n");
 548   xfclose(stdout);
 549   exit(0);
 550 }
 551
 552 /* Main program. */
 553 int main(int argc, char *argv[])
 554 {
 555   int n;
 556   const char *e;
 557
 558   /* Initial setup. */
 559   set_progname(argv);
 560   if(!setlocale(LC_CTYPE, "")) disorder_fatal(errno, "calling setlocale");
 561
 562   /* Parse command line. */
 563   while((n = getopt_long(argc, argv, "hVc:d:f:n:q:r:s", options, 0)) >= 0) {
 564     switch(n) {
 565     case 'h': help();
 566     case 'V': version("disorder-gstdecode");
 567     case 'c': configfile = optarg; break;
 568     case 'd': dither = getenum("dither type", optarg, dithers); break;
 569     case 'f': fallback = getfloat("fallback gain", optarg); break;
 570     case 'n': shape = getenum("noise-shaping type", optarg, shapes); break;
 571     case 'q': quality = getint("resample quality", optarg, 0, 10); break;
 572     case 'r': mode = getenum("ReplayGain mode", optarg, modes); break;
 573     case 's': flags |= f_stream; break;
 574     default: disorder_fatal(0, "invalid option");
 575     }
 576   }
 577   if(optind >= argc) disorder_fatal(0, "missing filename");
 578   file = argv[optind++];
 579   if(optind < argc) disorder_fatal(0, "excess arguments");
 580   if(config_read(1, 0)) disorder_fatal(0, "cannot read configuration");
 581
 582   /* Set up the GStreamer machinery. */
 583   gst_init(0, 0);
 584   prepare_pipeline();
 585
 586   /* Set up the output file. */
 587   if((e = getenv("DISORDER_RAW_FD")) != 0) {
 588     if((fp = fdopen(atoi(e), "wb")) == 0) disorder_fatal(errno, "fdopen");
 589   } else
 590     fp = stdout;
 591
 592   /* Let's go. */
 593   decode();
 594
 595   /* And now we're done. */
 596   xfclose(fp);
 597   return (0);
 598 }
 599
 600 /*
 601 Local Variables:
 602 c-basic-offset:2
 603 comment-column:40
 604 fill-column:77
 605 indent-tabs-mode:nil
 606 End:
 607 */