mixer.c

   1 /* Copyright (C) 1998 Andre Noll <maan@tuebingen.mpg.de>, see file COPYING. */
   2
   3 /** \file mixer.c A volume fader and alarm clock. */
   4
   5 #include <regex.h>
   6 #include <lopsub.h>
   7 #include <math.h>
   8
   9 #include "mixer.lsg.h"
  10 #include "para.h"
  11 #include "lsu.h"
  12 #include "fd.h"
  13 #include "string.h"
  14 #include "mix.h"
  15 #include "error.h"
  16 #include "version.h"
  17
  18 /** Array of error strings. */
  19 DEFINE_PARA_ERRLIST;
  20
  21 /* At least one of the two is defined if this file gets compiled. */
  22 static const struct mixer *mixers[] = {
  23 #ifdef HAVE_ALSA
  24         &alsa_mixer,
  25 #endif
  26 #ifdef HAVE_OSS
  27         &oss_mixer,
  28 #endif
  29 };
  30
  31 #define NUM_SUPPORTED_MIXERS (ARRAY_SIZE(mixers))
  32 #define FOR_EACH_MIXER(i) for ((i) = 0; (i) < NUM_SUPPORTED_MIXERS; (i)++)
  33
  34 static struct lls_parse_result *lpr, *sub_lpr;
  35
  36 #define CMD_PTR(_cmd) (lls_cmd(LSG_MIXER_CMD_ ## _cmd, mixer_suite))
  37 #define OPT_RESULT(_cmd, _opt) (lls_opt_result( \
  38         LSG_MIXER_ ## _cmd ## _OPT_ ## _opt, (LSG_MIXER_CMD_ ## _cmd == 0)? lpr : sub_lpr))
  39 #define OPT_GIVEN(_cmd, _opt) (lls_opt_given(OPT_RESULT(_cmd, _opt)))
  40 #define OPT_STRING_VAL(_cmd, _opt) (lls_string_val(0, OPT_RESULT(_cmd, _opt)))
  41 #define OPT_UINT32_VAL(_cmd, _opt) (lls_uint32_val(0, OPT_RESULT(_cmd, _opt)))
  42
  43 typedef int (*mixer_subcommand_handler_t)(const struct mixer *);
  44
  45 #define EXPORT_CMD(_cmd) const mixer_subcommand_handler_t \
  46         lsg_mixer_com_ ## _cmd ## _user_data = &com_ ## _cmd;
  47
  48 static int loglevel;
  49 static __printf_2_3 void date_log(int ll, const char *fmt, ...)
  50 {
  51         va_list argp;
  52         time_t t1;
  53         struct tm *tm;
  54
  55         if (ll < loglevel)
  56                 return;
  57         time(&t1);
  58         tm = localtime(&t1);
  59         fprintf(stderr, "%d:%02d:%02d ", tm->tm_hour, tm->tm_min, tm->tm_sec);
  60         va_start(argp, fmt);
  61         vprintf(fmt, argp);
  62         va_end(argp);
  63 }
  64 __printf_2_3 void (*para_log)(int, const char*, ...) = date_log;
  65
  66 static int set_channel(const struct mixer *m, struct mixer_handle *h,
  67                 const char *channel)
  68 {
  69
  70         PARA_NOTICE_LOG("using %s mixer channel\n", channel?
  71                 channel : "default");
  72         return m->set_channel(h, channel);
  73 }
  74
  75 static void millisleep(int ms)
  76 {
  77         struct timespec ts;
  78
  79         PARA_INFO_LOG("sleeping %dms\n", ms);
  80         if (ms < 0)
  81                 return;
  82         ts.tv_sec = ms / 1000,
  83         ts.tv_nsec = (ms % 1000) * 1000 * 1000;
  84         nanosleep(&ts, NULL);
  85 }
  86
  87 /*
  88  * This implements the inverse function of t -> t^alpha, scaled to the time
  89  * interval [0,T] and the range given by old_vol and new_vol. It returns the
  90  * amount of milliseconds until the given volume is reached.
  91  */
  92 static unsigned volume_time(double vol, double old_vol, double new_vol,
  93                 double T, double alpha)
  94 {
  95         double c, d, x;
  96
  97         if (old_vol < new_vol) {
  98                 c = old_vol;
  99                 d = new_vol;
 100         } else {
 101                 c = new_vol;
 102                 d = old_vol;
 103         }
 104
 105         x = T * exp(log(((vol - c) / (d - c))) / alpha);
 106         assert(x <= T);
 107         if (old_vol < new_vol)
 108                 return x;
 109         else
 110                 return T - x;
 111 }
 112
 113 /* Fade to new volume in fade_time seconds. */
 114 static int fade(const struct mixer *m, struct mixer_handle *h, uint32_t new_vol,
 115                 uint32_t fade_time)
 116 {
 117         int i, T, old_vol, ret, slept, incr;
 118         double ms, alpha;
 119         uint32_t fe = OPT_UINT32_VAL(PARA_MIXER, FADE_EXPONENT);
 120
 121         if (fade_time <= 0 || fe >= 100) {
 122                 ret = m->set(h, new_vol);
 123                 if (ret < 0)
 124                         return ret;
 125                 goto sleep;
 126         }
 127         alpha = (100 - fe) / 100.0;
 128         ret = m->get(h);
 129         if (ret < 0)
 130                 return ret;
 131         old_vol = ret;
 132         if (old_vol == new_vol)
 133                 goto sleep;
 134         PARA_NOTICE_LOG("fading %s from %d to %u in %u seconds\n",
 135                 OPT_STRING_VAL(PARA_MIXER, MIXER_CHANNEL), old_vol,
 136                 new_vol, fade_time);
 137         incr = old_vol < new_vol? 1 : -1;
 138         T = fade_time * 1000;
 139         i = old_vol;
 140         slept = 0;
 141         do {
 142                 ms = volume_time(i + incr, old_vol, new_vol, T, alpha);
 143                 millisleep(ms - slept);
 144                 slept = ms;
 145                 i += incr;
 146                 ret = m->set(h, i);
 147                 if (ret < 0)
 148                         return ret;
 149         } while (i != new_vol);
 150         return 1;
 151 sleep:
 152         sleep(fade_time);
 153         return ret;
 154 }
 155
 156 static int open_mixer_and_set_channel(const struct mixer *m, struct mixer_handle **h)
 157 {
 158         int ret;
 159
 160         ret = m->open(OPT_STRING_VAL(PARA_MIXER, MIXER_DEVICE), h);
 161         if (ret < 0)
 162                 return ret;
 163         ret = set_channel(m, *h, OPT_STRING_VAL(PARA_MIXER, MIXER_CHANNEL));
 164         if (ret == -E_BAD_CHANNEL) {
 165                 char *channels = m->get_channels(*h);
 166                 printf("Available channels: %s\n", channels);
 167                 free(channels);
 168         }
 169         if (ret < 0)
 170                 m->close(h);
 171         return ret;
 172 }
 173
 174 static int com_fade(const struct mixer *m)
 175 {
 176         uint32_t new_vol = OPT_UINT32_VAL(FADE, FADE_VOL);
 177         uint32_t fade_time = OPT_UINT32_VAL(FADE, FADE_TIME);
 178         struct mixer_handle *h;
 179         int ret;
 180
 181         ret = open_mixer_and_set_channel(m, &h);
 182         if (ret < 0)
 183                 return ret;
 184         ret = fade(m, h, new_vol, fade_time);
 185         m->close(&h);
 186         return ret;
 187 }
 188 EXPORT_CMD(fade);
 189
 190 static void run(const char *exe, const char *cmd)
 191 {
 192         int ret, status, fds[3] = {0, 0, 0};
 193         pid_t pid;
 194         char *cmdline = make_message("%s %s", exe, cmd);
 195
 196         PARA_NOTICE_LOG("%s\n", cmdline);
 197         ret = para_exec_cmdline_pid(&pid, cmdline, fds);
 198         free(cmdline);
 199         if (ret < 0) {
 200                 PARA_ERROR_LOG("%s\n", para_strerror(-ret));
 201                 goto fail;
 202         }
 203         do
 204                 pid = waitpid(pid, &status, 0);
 205         while (pid == -1 && errno == EINTR);
 206         if (pid < 0) {
 207                 PARA_ERROR_LOG("%s\n", strerror(errno));
 208                 goto fail;
 209         }
 210         if (!WIFEXITED(status) || WEXITSTATUS(status) != 0)
 211                 goto fail;
 212         return;
 213 fail:
 214         PARA_EMERG_LOG("command \"%s\" failed\n", cmd);
 215         exit(EXIT_FAILURE);
 216 }
 217
 218 static void client_cmd(const char *cmd)
 219 {
 220         run(BINDIR "/para_client", cmd);
 221 }
 222
 223 static void audioc_cmd(const char *cmd)
 224 {
 225         run(BINDIR "/para_audioc", cmd);
 226 }
 227
 228 static void change_afs_mode(const char *afs_mode)
 229 {
 230         char *cmd;
 231
 232         cmd = make_message("select %s", afs_mode);
 233         client_cmd(cmd);
 234         free(cmd);
 235 }
 236
 237 static int set_initial_volume(const struct mixer *m, struct mixer_handle *h)
 238 {
 239         int i, ret;
 240
 241         for (i = 0; i < OPT_GIVEN(SLEEP, IVOL); i++) {
 242                 const char *val = lls_string_val(i, OPT_RESULT(SLEEP, IVOL));
 243                 char *p, *ch, *arg = para_strdup(val);
 244                 int32_t iv;
 245                 p = strchr(arg, ':');
 246                 if (p) {
 247                         *p = '\0';
 248                         p++;
 249                         ch = arg;
 250                 } else {
 251                         p = arg;
 252                         ch = NULL;
 253                 }
 254                 ret = para_atoi32(p, &iv);
 255                 if (ret < 0) {
 256                         free(arg);
 257                         return ret;
 258                 }
 259                 ret = set_channel(m, h, ch);
 260                 if (!ch)
 261                         ch = "default";
 262                 if (ret < 0) {
 263                         PARA_WARNING_LOG("ignoring channel %s\n", ch);
 264                         ret = 0;
 265                 } else {
 266                         PARA_INFO_LOG("initial volume %s: %d\n", ch, iv);
 267                         ret = m->set(h, iv);
 268                 }
 269                 free(arg);
 270                 if (ret < 0)
 271                         return ret;
 272         }
 273         return 1;
 274 }
 275
 276 static void stop(const struct mixer *m, struct mixer_handle *h)
 277 {
 278         int ret, old_vol = 0;
 279
 280         ret = m->get(h);
 281         if (ret > 0)
 282                 old_vol = ret;
 283         fade(m, h, 0, 3);
 284         audioc_cmd("off");
 285         client_cmd("stop");
 286         audioc_cmd("on");
 287         m->set(h, old_vol);
 288 }
 289
 290 static int com_sleep(const struct mixer *m)
 291 {
 292         time_t t1, wake_time_epoch;
 293         unsigned int delay;
 294         struct tm *tm;
 295         int ret;
 296         const char *wake_time = OPT_STRING_VAL(SLEEP, WAKE_TIME);
 297         const char *initial_mood = OPT_STRING_VAL(SLEEP, INITIAL_MOOD);
 298         const char *fo_mood = OPT_STRING_VAL(SLEEP, FO_MOOD);
 299         const char *fi_mood = OPT_STRING_VAL(SLEEP, FI_MOOD);
 300         const char *sleep_mood = OPT_STRING_VAL(SLEEP, SLEEP_MOOD);
 301         int fit = OPT_UINT32_VAL(SLEEP, FI_TIME);
 302         int fot = OPT_UINT32_VAL(SLEEP, FO_TIME);
 303         int fiv = OPT_UINT32_VAL(SLEEP, FI_VOL);
 304         int fov = OPT_UINT32_VAL(SLEEP, FO_VOL);
 305         int32_t hour, min = 0;
 306         char *tmp, *wt;
 307         struct mixer_handle *h;
 308
 309         ret = open_mixer_and_set_channel(m, &h);
 310         if (ret < 0)
 311                 return ret;
 312         wt = para_strdup(wake_time + (wake_time[0] == '+'));
 313         /* calculate wake time */
 314         time(&t1);
 315         tmp = strchr(wt, ':');
 316         if (tmp) {
 317                 *tmp = '\0';
 318                 tmp++;
 319                 ret = para_atoi32(tmp, &min);
 320                 if (ret < 0) {
 321                         free(wt);
 322                         goto close_mixer;
 323                 }
 324         }
 325         ret = para_atoi32(wt, &hour);
 326         free(wt);
 327         if (ret < 0)
 328                 goto close_mixer;
 329         if (wake_time[0] == '+') { /* relative */
 330                 t1 += hour * 60 * 60 + min * 60;
 331                 tm = localtime(&t1);
 332         } else {
 333                 tm = localtime(&t1);
 334                 if (tm->tm_hour > hour || (tm->tm_hour == hour && tm->tm_min> min)) {
 335                         t1 += 86400; /* wake time is tomorrow */
 336                         tm = localtime(&t1);
 337                 }
 338                 tm->tm_hour = hour;
 339                 tm->tm_min = min;
 340                 tm->tm_sec = 0;
 341         }
 342         wake_time_epoch = mktime(tm);
 343         PARA_INFO_LOG("waketime: %d:%02d\n", tm->tm_hour, tm->tm_min);
 344         stop(m, h);
 345         ret = set_initial_volume(m, h);
 346         if (ret < 0)
 347                 goto close_mixer;
 348         /*
 349          * Setting the volume invalidates the current channel setting, so we
 350          * have to set it again.
 351          */
 352         ret = set_channel(m, h, OPT_STRING_VAL(PARA_MIXER, MIXER_CHANNEL));
 353         if (ret < 0)
 354                 goto close_mixer;
 355         delay = OPT_UINT32_VAL(SLEEP, INITIAL_DELAY);
 356         if (delay > 0 && initial_mood && *initial_mood) {
 357                 change_afs_mode(initial_mood);
 358                 client_cmd("play");
 359                 sleep(delay);
 360                 stop(m, h);
 361         }
 362         if (fot && fo_mood && *fo_mood) {
 363                 change_afs_mode(fo_mood);
 364                 client_cmd("play");
 365                 ret = fade(m, h, fov, fot);
 366                 if (ret < 0)
 367                         goto close_mixer;
 368         } else {
 369                 ret = m->set(h, fov);
 370                 if (ret < 0)
 371                         goto close_mixer;
 372         }
 373         if (sleep_mood && *sleep_mood) {
 374                 change_afs_mode(sleep_mood);
 375                 if (!fot || !fo_mood) /* currently stopped */
 376                         client_cmd("play");
 377         } else if (fot && fo_mood && *fo_mood) /* currently playing */
 378                 stop(m, h);
 379         m->close(&h);
 380         if (!fit || !fi_mood || !*fi_mood) /* nothing to do */
 381                 return 1;
 382         for (;;) {
 383                 time(&t1);
 384                 if (wake_time_epoch <= t1 + fit)
 385                         break;
 386                 delay = wake_time_epoch - t1 - fit;
 387                 PARA_INFO_LOG("sleeping %u seconds (%u:%02u)\n",
 388                         delay, delay / 3600,
 389                         (delay % 3600) / 60);
 390                 sleep(delay);
 391         }
 392         change_afs_mode(fi_mood);
 393         ret = open_mixer_and_set_channel(m, &h);
 394         if (ret < 0)
 395                 return ret;
 396         if (sleep_mood && *sleep_mood) /* currently playing */
 397                 stop(m, h);
 398         client_cmd("play");
 399         ret = fade(m, h, fiv, fit);
 400 close_mixer:
 401         m->close(&h);
 402         return ret;
 403 }
 404 EXPORT_CMD(sleep);
 405
 406 static int com_snooze(const struct mixer *m)
 407 {
 408         int ret, val;
 409         struct mixer_handle *h;
 410
 411         ret = open_mixer_and_set_channel(m, &h);
 412         if (ret < 0)
 413                 return ret;
 414         ret = 1;
 415         if (OPT_UINT32_VAL(SNOOZE, SO_TIME) == 0)
 416                 goto close_mixer;
 417         ret = m->get(h);
 418         if (ret < 0)
 419                 goto close_mixer;
 420         val = ret;
 421         if (val < OPT_UINT32_VAL(SNOOZE, SO_VOL))
 422                 ret = m->set(h, OPT_UINT32_VAL(SNOOZE, SO_VOL));
 423         else
 424                 ret = fade(m, h, OPT_UINT32_VAL(SNOOZE, SO_VOL),
 425                         OPT_UINT32_VAL(SNOOZE, SO_TIME));
 426         if (ret < 0)
 427                 goto close_mixer;
 428         client_cmd("pause");
 429         PARA_NOTICE_LOG("%" PRIu32 " seconds snooze time...\n",
 430                 OPT_UINT32_VAL(SNOOZE, SNOOZE_TIME));
 431         m->close(&h);
 432         sleep(OPT_UINT32_VAL(SNOOZE, SNOOZE_TIME));
 433         client_cmd("play");
 434         ret = open_mixer_and_set_channel(m, &h);
 435         if (ret < 0)
 436                 goto close_mixer;
 437         ret = fade(m, h, OPT_UINT32_VAL(SNOOZE, SI_VOL),
 438                 OPT_UINT32_VAL(SNOOZE, SI_TIME));
 439 close_mixer:
 440         m->close(&h);
 441         return ret;
 442 }
 443 EXPORT_CMD(snooze);
 444
 445 static int com_set(const struct mixer *m)
 446 {
 447         struct mixer_handle *h;
 448         int ret;
 449
 450         ret = open_mixer_and_set_channel(m, &h);
 451         if (ret < 0)
 452                 return ret;
 453         ret = m->set(h, OPT_UINT32_VAL(SET, VAL));
 454         m->close(&h);
 455         return ret;
 456 }
 457 EXPORT_CMD(set);
 458
 459 static const struct mixer *get_mixer_or_die(void)
 460 {
 461         int i;
 462
 463         if (!OPT_GIVEN(PARA_MIXER, MIXER_API))
 464                 i = 0; /* default: use first mixer */
 465         else
 466                 FOR_EACH_MIXER(i)
 467                         if (!strcmp(mixers[i]->name,
 468                                         OPT_STRING_VAL(PARA_MIXER, MIXER_API)))
 469                                 break;
 470         if (i < NUM_SUPPORTED_MIXERS) {
 471                 PARA_NOTICE_LOG("using %s mixer API\n", mixers[i]->name);
 472                 return mixers[i];
 473         }
 474         printf("available mixer APIs: ");
 475         FOR_EACH_MIXER(i)
 476                 printf("%s%s%s ", i == 0? "[" : "", mixers[i]->name,
 477                         i == 0? "]" : "");
 478         printf("\n");
 479         exit(EXIT_FAILURE);
 480 }
 481
 482 static void show_subcommands(void)
 483 {
 484         const struct lls_command *cmd;
 485         int i;
 486         printf("Subcommands:\n");
 487         for (i = 1; (cmd = lls_cmd(i, mixer_suite)); i++) {
 488                 const char *name = lls_command_name(cmd);
 489                 const char *purpose = lls_purpose(cmd);
 490                 printf("%-20s%s\n", name, purpose);
 491         }
 492 }
 493
 494 static int com_help(__a_unused const struct mixer *m)
 495 {
 496         const struct lls_command *cmd;
 497         const struct lls_opt_result *r_l = OPT_RESULT(HELP, LONG);
 498         char *txt, *errctx;
 499         const char *name;
 500         int ret;
 501
 502         ret = lls_check_arg_count(sub_lpr, 0, 1, NULL);
 503         if (ret < 0)
 504                 return ret;
 505         if (lls_num_inputs(sub_lpr) == 0) {
 506                 show_subcommands();
 507                 return 0;
 508         }
 509         name = lls_input(0, sub_lpr);
 510         ret = lls(lls_lookup_subcmd(name, mixer_suite, &errctx));
 511         if (ret < 0) {
 512                 if (errctx)
 513                         PARA_ERROR_LOG("%s\n", errctx);
 514                 free(errctx);
 515                 return ret;
 516         }
 517         cmd = lls_cmd(ret, mixer_suite);
 518         if (lls_opt_given(r_l))
 519                 txt = lls_long_help(cmd);
 520         else
 521                 txt = lls_short_help(cmd);
 522         printf("%s", txt);
 523         free(txt);
 524         return 0;
 525 }
 526 EXPORT_CMD(help);
 527
 528 static void handle_help_flags(void)
 529 {
 530         char *help;
 531
 532         if (OPT_GIVEN(PARA_MIXER, DETAILED_HELP))
 533                 help = lls_long_help(CMD_PTR(PARA_MIXER));
 534         else if (OPT_GIVEN(PARA_MIXER, HELP))
 535                 help = lls_short_help(CMD_PTR(PARA_MIXER));
 536         else
 537                 return;
 538         printf("%s", help);
 539         free(help);
 540         show_subcommands();
 541         exit(EXIT_SUCCESS);
 542 }
 543
 544 static int parse_and_merge_config_file(const struct lls_command *cmd)
 545 {
 546         int ret;
 547         struct lls_parse_result **lprp = (cmd == lls_cmd(0, mixer_suite))?
 548                 &lpr : &sub_lpr;
 549
 550         ret = lsu_merge_config_file_options(OPT_STRING_VAL(PARA_MIXER,
 551                 CONFIG_FILE), "mixer.conf", lprp, cmd, mixer_suite,
 552                 0 /* flags */);
 553         if (ret < 0)
 554                 return ret;
 555         loglevel = OPT_UINT32_VAL(PARA_MIXER, LOGLEVEL);
 556         return 1;
 557 }
 558
 559 /**
 560  * The main function of para_mixer.
 561  *
 562  * The executable is linked with the alsa or the oss mixer API, or both. It has
 563  * a custom log function which prefixes log messages with the current date.
 564  *
 565  * \param argc Argument counter.
 566  * \param argv Argument vector.
 567  *
 568  * \return EXIT_SUCCESS or EXIT_FAILURE.
 569  */
 570 int main(int argc, char *argv[])
 571 {
 572         const struct lls_command *cmd = CMD_PTR(PARA_MIXER);
 573         int ret;
 574         char *errctx;
 575         const char *subcmd;
 576         const struct mixer *m;
 577         unsigned n;
 578
 579         ret = lls(lls_parse(argc, argv, cmd, &lpr, &errctx));
 580         if (ret < 0)
 581                 goto fail;
 582         loglevel = OPT_UINT32_VAL(PARA_MIXER, LOGLEVEL);
 583         version_handle_flag("mixer", OPT_GIVEN(PARA_MIXER, VERSION));
 584         handle_help_flags();
 585
 586         n = lls_num_inputs(lpr);
 587         if (n == 0) {
 588                 show_subcommands();
 589                 ret = 0;
 590                 goto free_lpr;
 591         }
 592         ret = parse_and_merge_config_file(cmd);
 593         if (ret < 0)
 594                 goto free_lpr;
 595         subcmd = lls_input(0, lpr);
 596         ret = lls(lls_lookup_subcmd(subcmd, mixer_suite, &errctx));
 597         if (ret < 0)
 598                 goto fail;
 599         cmd = lls_cmd(ret, mixer_suite);
 600         ret = lls(lls_parse(n, argv + argc - n, cmd, &sub_lpr, &errctx));
 601         if (ret < 0)
 602                 goto free_lpr;
 603         ret = parse_and_merge_config_file(cmd);
 604         if (ret < 0)
 605                 goto free_sub_lpr;
 606         m = get_mixer_or_die();
 607         ret = (*(mixer_subcommand_handler_t *)(lls_user_data(cmd)))(m);
 608 free_sub_lpr:
 609         lls_free_parse_result(sub_lpr, cmd);
 610 free_lpr:
 611         lls_free_parse_result(lpr, CMD_PTR(PARA_MIXER));
 612         if (ret >= 0)
 613                 return EXIT_SUCCESS;
 614 fail:
 615         if (errctx)
 616                 PARA_ERROR_LOG("%s\n", errctx);
 617         free(errctx);
 618         PARA_EMERG_LOG("%s\n", para_strerror(-ret));
 619         return EXIT_FAILURE;
 620 }