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(void)
 277 {
 278         audioc_cmd("off");
 279         client_cmd("stop");
 280         audioc_cmd("on");
 281 }
 282
 283 static int com_sleep(const struct mixer *m)
 284 {
 285         time_t t1, wake_time_epoch;
 286         unsigned int delay;
 287         struct tm *tm;
 288         int ret;
 289         const char *wake_time = OPT_STRING_VAL(SLEEP, WAKE_TIME);
 290         const char *initial_mood = OPT_STRING_VAL(SLEEP, INITIAL_MOOD);
 291         const char *fo_mood = OPT_STRING_VAL(SLEEP, FO_MOOD);
 292         const char *fi_mood = OPT_STRING_VAL(SLEEP, FI_MOOD);
 293         const char *sleep_mood = OPT_STRING_VAL(SLEEP, SLEEP_MOOD);
 294         int fit = OPT_UINT32_VAL(SLEEP, FI_TIME);
 295         int fot = OPT_UINT32_VAL(SLEEP, FO_TIME);
 296         int fiv = OPT_UINT32_VAL(SLEEP, FI_VOL);
 297         int fov = OPT_UINT32_VAL(SLEEP, FO_VOL);
 298         int32_t hour, min = 0;
 299         char *tmp, *wt;
 300         struct mixer_handle *h;
 301
 302         ret = open_mixer_and_set_channel(m, &h);
 303         if (ret < 0)
 304                 return ret;
 305         wt = para_strdup(wake_time + (wake_time[0] == '+'));
 306         /* calculate wake time */
 307         time(&t1);
 308         tmp = strchr(wt, ':');
 309         if (tmp) {
 310                 *tmp = '\0';
 311                 tmp++;
 312                 ret = para_atoi32(tmp, &min);
 313                 if (ret < 0) {
 314                         free(wt);
 315                         goto close_mixer;
 316                 }
 317         }
 318         ret = para_atoi32(wt, &hour);
 319         free(wt);
 320         if (ret < 0)
 321                 goto close_mixer;
 322         if (wake_time[0] == '+') { /* relative */
 323                 t1 += hour * 60 * 60 + min * 60;
 324                 tm = localtime(&t1);
 325         } else {
 326                 tm = localtime(&t1);
 327                 if (tm->tm_hour > hour || (tm->tm_hour == hour && tm->tm_min> min)) {
 328                         t1 += 86400; /* wake time is tomorrow */
 329                         tm = localtime(&t1);
 330                 }
 331                 tm->tm_hour = hour;
 332                 tm->tm_min = min;
 333                 tm->tm_sec = 0;
 334         }
 335         wake_time_epoch = mktime(tm);
 336         PARA_INFO_LOG("waketime: %d:%02d\n", tm->tm_hour, tm->tm_min);
 337         stop();
 338         ret = set_initial_volume(m, h);
 339         if (ret < 0)
 340                 goto close_mixer;
 341         /*
 342          * Setting the volume invalidates the current channel setting, so we
 343          * have to set it again.
 344          */
 345         ret = set_channel(m, h, OPT_STRING_VAL(PARA_MIXER, MIXER_CHANNEL));
 346         if (ret < 0)
 347                 goto close_mixer;
 348         delay = OPT_UINT32_VAL(SLEEP, INITIAL_DELAY);
 349         if (delay > 0 && initial_mood && *initial_mood) {
 350                 change_afs_mode(initial_mood);
 351                 client_cmd("play");
 352                 sleep(delay);
 353                 stop();
 354         }
 355         if (fot && fo_mood && *fo_mood) {
 356                 change_afs_mode(fo_mood);
 357                 client_cmd("play");
 358                 ret = fade(m, h, fov, fot);
 359                 if (ret < 0)
 360                         goto close_mixer;
 361         } else {
 362                 ret = m->set(h, fov);
 363                 if (ret < 0)
 364                         goto close_mixer;
 365         }
 366         if (sleep_mood && *sleep_mood) {
 367                 change_afs_mode(sleep_mood);
 368                 if (!fot || !fo_mood) /* currently stopped */
 369                         client_cmd("play");
 370         } else if (fot && fo_mood && *fo_mood) /* currently playing */
 371                 stop();
 372         m->close(&h);
 373         if (!fit || !fi_mood || !*fi_mood) /* nothing to do */
 374                 return 1;
 375         for (;;) {
 376                 time(&t1);
 377                 if (wake_time_epoch <= t1 + fit)
 378                         break;
 379                 delay = wake_time_epoch - t1 - fit;
 380                 PARA_INFO_LOG("sleeping %u seconds (%u:%02u)\n",
 381                         delay, delay / 3600,
 382                         (delay % 3600) / 60);
 383                 sleep(delay);
 384         }
 385         change_afs_mode(fi_mood);
 386         ret = open_mixer_and_set_channel(m, &h);
 387         if (ret < 0)
 388                 return ret;
 389         if (sleep_mood && *sleep_mood) /* currently playing */
 390                 stop();
 391         client_cmd("play");
 392         ret = fade(m, h, fiv, fit);
 393 close_mixer:
 394         m->close(&h);
 395         return ret;
 396 }
 397 EXPORT_CMD(sleep);
 398
 399 static int com_snooze(const struct mixer *m)
 400 {
 401         int ret, val;
 402         struct mixer_handle *h;
 403
 404         ret = open_mixer_and_set_channel(m, &h);
 405         if (ret < 0)
 406                 return ret;
 407         ret = 1;
 408         if (OPT_UINT32_VAL(SNOOZE, SO_TIME) == 0)
 409                 goto close_mixer;
 410         ret = m->get(h);
 411         if (ret < 0)
 412                 goto close_mixer;
 413         val = ret;
 414         if (val < OPT_UINT32_VAL(SNOOZE, SO_VOL))
 415                 ret = m->set(h, OPT_UINT32_VAL(SNOOZE, SO_VOL));
 416         else
 417                 ret = fade(m, h, OPT_UINT32_VAL(SNOOZE, SO_VOL),
 418                         OPT_UINT32_VAL(SNOOZE, SO_TIME));
 419         if (ret < 0)
 420                 goto close_mixer;
 421         client_cmd("pause");
 422         PARA_NOTICE_LOG("%" PRIu32 " seconds snooze time...\n",
 423                 OPT_UINT32_VAL(SNOOZE, SNOOZE_TIME));
 424         m->close(&h);
 425         sleep(OPT_UINT32_VAL(SNOOZE, SNOOZE_TIME));
 426         client_cmd("play");
 427         ret = open_mixer_and_set_channel(m, &h);
 428         if (ret < 0)
 429                 goto close_mixer;
 430         ret = fade(m, h, OPT_UINT32_VAL(SNOOZE, SI_VOL),
 431                 OPT_UINT32_VAL(SNOOZE, SI_TIME));
 432 close_mixer:
 433         m->close(&h);
 434         return ret;
 435 }
 436 EXPORT_CMD(snooze);
 437
 438 static int com_set(const struct mixer *m)
 439 {
 440         struct mixer_handle *h;
 441         int ret;
 442
 443         ret = open_mixer_and_set_channel(m, &h);
 444         if (ret < 0)
 445                 return ret;
 446         ret = m->set(h, OPT_UINT32_VAL(SET, VAL));
 447         m->close(&h);
 448         return ret;
 449 }
 450 EXPORT_CMD(set);
 451
 452 static const struct mixer *get_mixer_or_die(void)
 453 {
 454         int i;
 455
 456         if (!OPT_GIVEN(PARA_MIXER, MIXER_API))
 457                 i = 0; /* default: use first mixer */
 458         else
 459                 FOR_EACH_MIXER(i)
 460                         if (!strcmp(mixers[i]->name,
 461                                         OPT_STRING_VAL(PARA_MIXER, MIXER_API)))
 462                                 break;
 463         if (i < NUM_SUPPORTED_MIXERS) {
 464                 PARA_NOTICE_LOG("using %s mixer API\n", mixers[i]->name);
 465                 return mixers[i];
 466         }
 467         printf("available mixer APIs: ");
 468         FOR_EACH_MIXER(i)
 469                 printf("%s%s%s ", i == 0? "[" : "", mixers[i]->name,
 470                         i == 0? "]" : "");
 471         printf("\n");
 472         exit(EXIT_FAILURE);
 473 }
 474
 475 static void show_subcommands(void)
 476 {
 477         const struct lls_command *cmd;
 478         int i;
 479         printf("Subcommands:\n");
 480         for (i = 1; (cmd = lls_cmd(i, mixer_suite)); i++) {
 481                 const char *name = lls_command_name(cmd);
 482                 const char *purpose = lls_purpose(cmd);
 483                 printf("%-20s%s\n", name, purpose);
 484         }
 485 }
 486
 487 static int com_help(__a_unused const struct mixer *m)
 488 {
 489         const struct lls_command *cmd;
 490         const struct lls_opt_result *r_l = OPT_RESULT(HELP, LONG);
 491         char *txt, *errctx;
 492         const char *name;
 493         int ret;
 494
 495         ret = lls_check_arg_count(sub_lpr, 0, 1, NULL);
 496         if (ret < 0)
 497                 return ret;
 498         if (lls_num_inputs(sub_lpr) == 0) {
 499                 show_subcommands();
 500                 return 0;
 501         }
 502         name = lls_input(0, sub_lpr);
 503         ret = lls(lls_lookup_subcmd(name, mixer_suite, &errctx));
 504         if (ret < 0) {
 505                 if (errctx)
 506                         PARA_ERROR_LOG("%s\n", errctx);
 507                 free(errctx);
 508                 return ret;
 509         }
 510         cmd = lls_cmd(ret, mixer_suite);
 511         if (lls_opt_given(r_l))
 512                 txt = lls_long_help(cmd);
 513         else
 514                 txt = lls_short_help(cmd);
 515         printf("%s", txt);
 516         free(txt);
 517         return 0;
 518 }
 519 EXPORT_CMD(help);
 520
 521 static void handle_help_flags(void)
 522 {
 523         char *help;
 524
 525         if (OPT_GIVEN(PARA_MIXER, DETAILED_HELP))
 526                 help = lls_long_help(CMD_PTR(PARA_MIXER));
 527         else if (OPT_GIVEN(PARA_MIXER, HELP))
 528                 help = lls_short_help(CMD_PTR(PARA_MIXER));
 529         else
 530                 return;
 531         printf("%s", help);
 532         free(help);
 533         show_subcommands();
 534         exit(EXIT_SUCCESS);
 535 }
 536
 537 static int parse_and_merge_config_file(const struct lls_command *cmd)
 538 {
 539         int ret;
 540         struct lls_parse_result **lprp = (cmd == lls_cmd(0, mixer_suite))?
 541                 &lpr : &sub_lpr;
 542
 543         ret = lsu_merge_config_file_options(OPT_STRING_VAL(PARA_MIXER,
 544                 CONFIG_FILE), "mixer.conf", lprp, cmd, mixer_suite,
 545                 0 /* flags */);
 546         if (ret < 0)
 547                 return ret;
 548         loglevel = OPT_UINT32_VAL(PARA_MIXER, LOGLEVEL);
 549         return 1;
 550 }
 551
 552 /**
 553  * The main function of para_mixer.
 554  *
 555  * The executable is linked with the alsa or the oss mixer API, or both. It has
 556  * a custom log function which prefixes log messages with the current date.
 557  *
 558  * \param argc Argument counter.
 559  * \param argv Argument vector.
 560  *
 561  * \return EXIT_SUCCESS or EXIT_FAILURE.
 562  */
 563 int main(int argc, char *argv[])
 564 {
 565         const struct lls_command *cmd = CMD_PTR(PARA_MIXER);
 566         int ret;
 567         char *errctx;
 568         const char *subcmd;
 569         const struct mixer *m;
 570         unsigned n;
 571
 572         ret = lls(lls_parse(argc, argv, cmd, &lpr, &errctx));
 573         if (ret < 0)
 574                 goto fail;
 575         loglevel = OPT_UINT32_VAL(PARA_MIXER, LOGLEVEL);
 576         version_handle_flag("mixer", OPT_GIVEN(PARA_MIXER, VERSION));
 577         handle_help_flags();
 578
 579         n = lls_num_inputs(lpr);
 580         if (n == 0) {
 581                 show_subcommands();
 582                 ret = 0;
 583                 goto free_lpr;
 584         }
 585         ret = parse_and_merge_config_file(cmd);
 586         if (ret < 0)
 587                 goto free_lpr;
 588         subcmd = lls_input(0, lpr);
 589         ret = lls(lls_lookup_subcmd(subcmd, mixer_suite, &errctx));
 590         if (ret < 0)
 591                 goto fail;
 592         cmd = lls_cmd(ret, mixer_suite);
 593         ret = lls(lls_parse(n, argv + argc - n, cmd, &sub_lpr, &errctx));
 594         if (ret < 0)
 595                 goto free_lpr;
 596         ret = parse_and_merge_config_file(cmd);
 597         if (ret < 0)
 598                 goto free_sub_lpr;
 599         m = get_mixer_or_die();
 600         ret = (*(mixer_subcommand_handler_t *)(lls_user_data(cmd)))(m);
 601 free_sub_lpr:
 602         lls_free_parse_result(sub_lpr, cmd);
 603 free_lpr:
 604         lls_free_parse_result(lpr, CMD_PTR(PARA_MIXER));
 605         if (ret >= 0)
 606                 return EXIT_SUCCESS;
 607 fail:
 608         if (errctx)
 609                 PARA_ERROR_LOG("%s\n", errctx);
 610         free(errctx);
 611         PARA_EMERG_LOG("%s\n", para_strerror(-ret));
 612         return EXIT_FAILURE;
 613 }