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 *, struct mixer_handle *);
  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 com_fade(const struct mixer *m, struct mixer_handle *h)
 157 {
 158         uint32_t new_vol = OPT_UINT32_VAL(FADE, FADE_VOL);
 159         uint32_t fade_time = OPT_UINT32_VAL(FADE, FADE_TIME);
 160         return fade(m, h, new_vol, fade_time);
 161 }
 162 EXPORT_CMD(fade);
 163
 164 static void client_cmd(const char *cmd)
 165 {
 166         int ret, status, fds[3] = {0, 0, 0};
 167         pid_t pid;
 168         char *cmdline = make_message(BINDIR "/para_client %s", cmd);
 169
 170         PARA_NOTICE_LOG("%s\n", cmdline);
 171         ret = para_exec_cmdline_pid(&pid, cmdline, fds);
 172         free(cmdline);
 173         if (ret < 0) {
 174                 PARA_ERROR_LOG("%s\n", para_strerror(-ret));
 175                 goto fail;
 176         }
 177         do
 178                 pid = waitpid(pid, &status, 0);
 179         while (pid == -1 && errno == EINTR);
 180         if (pid < 0) {
 181                 PARA_ERROR_LOG("%s\n", strerror(errno));
 182                 goto fail;
 183         }
 184         if (!WIFEXITED(status) || WEXITSTATUS(status) != 0)
 185                 goto fail;
 186         return;
 187 fail:
 188         PARA_EMERG_LOG("command \"%s\" failed\n", cmd);
 189         exit(EXIT_FAILURE);
 190 }
 191
 192 static void change_afs_mode(const char *afs_mode)
 193 {
 194         char *cmd;
 195
 196         cmd = make_message("select %s", afs_mode);
 197         client_cmd(cmd);
 198         free(cmd);
 199 }
 200
 201 static int set_initial_volume(const struct mixer *m, struct mixer_handle *h)
 202 {
 203         int i, ret;
 204
 205         for (i = 0; i < OPT_GIVEN(SLEEP, IVOL); i++) {
 206                 const char *val = lls_string_val(i, OPT_RESULT(SLEEP, IVOL));
 207                 char *p, *ch, *arg = para_strdup(val);
 208                 int32_t iv;
 209                 p = strchr(arg, ':');
 210                 if (p) {
 211                         *p = '\0';
 212                         p++;
 213                         ch = arg;
 214                 } else {
 215                         p = arg;
 216                         ch = NULL;
 217                 }
 218                 ret = para_atoi32(p, &iv);
 219                 if (ret < 0) {
 220                         free(arg);
 221                         return ret;
 222                 }
 223                 ret = set_channel(m, h, ch);
 224                 if (!ch)
 225                         ch = "default";
 226                 if (ret < 0) {
 227                         PARA_WARNING_LOG("ignoring channel %s\n", ch);
 228                         ret = 0;
 229                 } else {
 230                         PARA_INFO_LOG("initial volume %s: %d\n", ch, iv);
 231                         ret = m->set(h, iv);
 232                 }
 233                 free(arg);
 234                 if (ret < 0)
 235                         return ret;
 236         }
 237         return 1;
 238 }
 239
 240 static int com_sleep(const struct mixer *m, struct mixer_handle *h)
 241 {
 242         time_t t1, wake_time_epoch;
 243         unsigned int delay;
 244         struct tm *tm;
 245         int ret;
 246         const char *wake_time = OPT_STRING_VAL(SLEEP, WAKE_TIME);
 247         const char *fo_mood = OPT_STRING_VAL(SLEEP, FO_MOOD);
 248         const char *fi_mood = OPT_STRING_VAL(SLEEP, FI_MOOD);
 249         const char *sleep_mood = OPT_STRING_VAL(SLEEP, SLEEP_MOOD);
 250         int fit = OPT_UINT32_VAL(SLEEP, FI_TIME);
 251         int fot = OPT_UINT32_VAL(SLEEP, FO_TIME);
 252         int fiv = OPT_UINT32_VAL(SLEEP, FI_VOL);
 253         int fov = OPT_UINT32_VAL(SLEEP, FO_VOL);
 254         int32_t hour, min = 0;
 255         char *tmp;
 256         char *wt = para_strdup(wake_time + (wake_time[0] == '+'));
 257
 258         /* calculate wake time */
 259         time(&t1);
 260         tmp = strchr(wt, ':');
 261         if (tmp) {
 262                 *tmp = '\0';
 263                 tmp++;
 264                 ret = para_atoi32(tmp, &min);
 265                 if (ret < 0) {
 266                         free(wt);
 267                         return ret;
 268                 }
 269         }
 270         ret = para_atoi32(wt, &hour);
 271         free(wt);
 272         if (ret < 0)
 273                 return ret;
 274         if (wake_time[0] == '+') { /* relative */
 275                 t1 += hour * 60 * 60 + min * 60;
 276                 tm = localtime(&t1);
 277         } else {
 278                 tm = localtime(&t1);
 279                 if (tm->tm_hour > hour || (tm->tm_hour == hour && tm->tm_min> min)) {
 280                         t1 += 86400; /* wake time is tomorrow */
 281                         tm = localtime(&t1);
 282                 }
 283                 tm->tm_hour = hour;
 284                 tm->tm_min = min;
 285                 tm->tm_sec = 0;
 286         }
 287         wake_time_epoch = mktime(tm);
 288         PARA_INFO_LOG("waketime: %d:%02d\n", tm->tm_hour, tm->tm_min);
 289         client_cmd("stop");
 290         sleep(1);
 291         if (fot && fo_mood) {
 292                 ret = set_initial_volume(m, h);
 293                 if (ret < 0)
 294                         return ret;
 295                 change_afs_mode(fo_mood);
 296                 client_cmd("play");
 297                 ret = set_channel(m, h, OPT_STRING_VAL(PARA_MIXER, MIXER_CHANNEL));
 298                 if (ret < 0)
 299                         return ret;
 300                 ret = fade(m, h, fov, fot);
 301                 if (ret < 0)
 302                         return ret;
 303         } else {
 304                 ret = m->set(h, fov);
 305                 if (ret < 0)
 306                         return ret;
 307         }
 308         if (sleep_mood) {
 309                 change_afs_mode(sleep_mood);
 310                 if (!fot || !fo_mood) /* currently stopped */
 311                         client_cmd("play");
 312         } else if (fot && fo_mood) /* currently playing */
 313                 client_cmd("stop");
 314         if (!fit || !fi_mood) /* nothing to do */
 315                 return 1;
 316         for (;;) {
 317                 time(&t1);
 318                 if (wake_time_epoch <= t1 + fit)
 319                         break;
 320                 delay = wake_time_epoch - t1 - fit;
 321                 PARA_INFO_LOG("sleeping %u seconds (%u:%02u)\n",
 322                         delay, delay / 3600,
 323                         (delay % 3600) / 60);
 324                 sleep(delay);
 325         }
 326         change_afs_mode(fi_mood);
 327         if (sleep_mood) /* currently playing */
 328                 client_cmd("next");
 329         else /* currently stopped */
 330                 client_cmd("play");
 331         ret = fade(m, h, fiv, fit);
 332         PARA_INFO_LOG("fade complete, returning\n");
 333         return ret;
 334 }
 335 EXPORT_CMD(sleep);
 336
 337 static int com_snooze(const struct mixer *m, struct mixer_handle *h)
 338 {
 339         int ret, val;
 340
 341         if (OPT_UINT32_VAL(SNOOZE, SO_TIME) == 0)
 342                 return 1;
 343         ret = m->get(h);
 344         if (ret < 0)
 345                 return ret;
 346         val = ret;
 347         if (val < OPT_UINT32_VAL(SNOOZE, SO_VOL))
 348                 ret = m->set(h, OPT_UINT32_VAL(SNOOZE, SO_VOL));
 349         else
 350                 ret = fade(m, h, OPT_UINT32_VAL(SNOOZE, SO_VOL),
 351                         OPT_UINT32_VAL(SNOOZE, SO_TIME));
 352         if (ret < 0)
 353                 return ret;
 354         client_cmd("pause");
 355         PARA_NOTICE_LOG("%" PRIu32 " seconds snooze time...\n",
 356                 OPT_UINT32_VAL(SNOOZE, SNOOZE_TIME));
 357         sleep(OPT_UINT32_VAL(SNOOZE, SNOOZE_TIME));
 358         client_cmd("play");
 359         return fade(m, h, OPT_UINT32_VAL(SNOOZE, SI_VOL),
 360                 OPT_UINT32_VAL(SNOOZE, SI_TIME));
 361 }
 362 EXPORT_CMD(snooze);
 363
 364 static int com_set(const struct mixer *m, struct mixer_handle *h)
 365 {
 366         return m->set(h, OPT_UINT32_VAL(SET, VAL));
 367 }
 368 EXPORT_CMD(set);
 369
 370 static const struct mixer *get_mixer_or_die(void)
 371 {
 372         int i;
 373
 374         if (!OPT_GIVEN(PARA_MIXER, MIXER_API))
 375                 i = 0; /* default: use first mixer */
 376         else
 377                 FOR_EACH_MIXER(i)
 378                         if (!strcmp(mixers[i]->name,
 379                                         OPT_STRING_VAL(PARA_MIXER, MIXER_API)))
 380                                 break;
 381         if (i < NUM_SUPPORTED_MIXERS) {
 382                 PARA_NOTICE_LOG("using %s mixer API\n", mixers[i]->name);
 383                 return mixers[i];
 384         }
 385         printf("available mixer APIs: ");
 386         FOR_EACH_MIXER(i)
 387                 printf("%s%s%s ", i == 0? "[" : "", mixers[i]->name,
 388                         i == 0? "]" : "");
 389         printf("\n");
 390         exit(EXIT_FAILURE);
 391 }
 392
 393 static void show_subcommands(void)
 394 {
 395         const struct lls_command *cmd;
 396         int i;
 397         printf("Subcommands:\n");
 398         for (i = 1; (cmd = lls_cmd(i, mixer_suite)); i++) {
 399                 const char *name = lls_command_name(cmd);
 400                 const char *purpose = lls_purpose(cmd);
 401                 printf("%-20s%s\n", name, purpose);
 402         }
 403 }
 404
 405
 406 static int com_help(__a_unused const struct mixer *m,
 407                 __a_unused struct mixer_handle *h)
 408 {
 409         const struct lls_command *cmd;
 410         const struct lls_opt_result *r_l = OPT_RESULT(HELP, LONG);
 411         char *txt, *errctx;
 412         const char *name;
 413         int ret;
 414
 415         ret = lls_check_arg_count(sub_lpr, 0, 1, NULL);
 416         if (ret < 0)
 417                 return ret;
 418         if (lls_num_inputs(sub_lpr) == 0) {
 419                 show_subcommands();
 420                 return 0;
 421         }
 422         name = lls_input(0, sub_lpr);
 423         ret = lls(lls_lookup_subcmd(name, mixer_suite, &errctx));
 424         if (ret < 0) {
 425                 if (errctx)
 426                         PARA_ERROR_LOG("%s\n", errctx);
 427                 free(errctx);
 428                 return ret;
 429         }
 430         cmd = lls_cmd(ret, mixer_suite);
 431         if (lls_opt_given(r_l))
 432                 txt = lls_long_help(cmd);
 433         else
 434                 txt = lls_short_help(cmd);
 435         printf("%s", txt);
 436         free(txt);
 437         return 0;
 438 }
 439 EXPORT_CMD(help);
 440
 441 static void handle_help_flags(void)
 442 {
 443         char *help;
 444
 445         if (OPT_GIVEN(PARA_MIXER, DETAILED_HELP))
 446                 help = lls_long_help(CMD_PTR(PARA_MIXER));
 447         else if (OPT_GIVEN(PARA_MIXER, HELP))
 448                 help = lls_short_help(CMD_PTR(PARA_MIXER));
 449         else
 450                 return;
 451         printf("%s", help);
 452         free(help);
 453         show_subcommands();
 454         exit(EXIT_SUCCESS);
 455 }
 456
 457 static int parse_and_merge_config_file(const struct lls_command *cmd)
 458 {
 459         int ret;
 460         struct lls_parse_result **lprp = (cmd == lls_cmd(0, mixer_suite))?
 461                 &lpr : &sub_lpr;
 462
 463         ret = lsu_merge_config_file_options(OPT_STRING_VAL(PARA_MIXER,
 464                 CONFIG_FILE), "mixer.conf", lprp, cmd, mixer_suite,
 465                 0 /* flags */);
 466         if (ret < 0)
 467                 return ret;
 468         loglevel = OPT_UINT32_VAL(PARA_MIXER, LOGLEVEL);
 469         return 1;
 470 }
 471
 472 /**
 473  * The main function of para_mixer.
 474  *
 475  * The executable is linked with the alsa or the oss mixer API, or both. It has
 476  * a custom log function which prefixes log messages with the current date.
 477  *
 478  * \param argc Argument counter.
 479  * \param argv Argument vector.
 480  *
 481  * \return EXIT_SUCCESS or EXIT_FAILURE.
 482  */
 483 int main(int argc, char *argv[])
 484 {
 485         const struct lls_command *cmd = CMD_PTR(PARA_MIXER);
 486         int ret;
 487         char *errctx;
 488         const char *subcmd;
 489         const struct mixer *m;
 490         struct mixer_handle *h;
 491         unsigned n;
 492
 493         ret = lls(lls_parse(argc, argv, cmd, &lpr, &errctx));
 494         if (ret < 0)
 495                 goto fail;
 496         loglevel = OPT_UINT32_VAL(PARA_MIXER, LOGLEVEL);
 497         version_handle_flag("mixer", OPT_GIVEN(PARA_MIXER, VERSION));
 498         handle_help_flags();
 499
 500         n = lls_num_inputs(lpr);
 501         if (n == 0) {
 502                 show_subcommands();
 503                 ret = 0;
 504                 goto free_lpr;
 505         }
 506         ret = parse_and_merge_config_file(cmd);
 507         if (ret < 0)
 508                 goto free_lpr;
 509         subcmd = lls_input(0, lpr);
 510         ret = lls(lls_lookup_subcmd(subcmd, mixer_suite, &errctx));
 511         if (ret < 0)
 512                 goto fail;
 513         cmd = lls_cmd(ret, mixer_suite);
 514         ret = lls(lls_parse(n, argv + argc - n, cmd, &sub_lpr, &errctx));
 515         if (ret < 0)
 516                 goto free_lpr;
 517         ret = parse_and_merge_config_file(cmd);
 518         if (ret < 0)
 519                 goto free_lpr;
 520         m = get_mixer_or_die();
 521         ret = m->open(OPT_STRING_VAL(PARA_MIXER, MIXER_DEVICE), &h);
 522         if (ret < 0)
 523                 goto free_sub_lpr;
 524         ret = set_channel(m, h, OPT_STRING_VAL(PARA_MIXER, MIXER_CHANNEL));
 525         if (ret == -E_BAD_CHANNEL) {
 526                 char *channels = m->get_channels(h);
 527                 printf("Available channels: %s\n", channels);
 528                 free(channels);
 529         }
 530         if (ret < 0)
 531                 goto close_mixer;
 532         ret = (*(mixer_subcommand_handler_t *)(lls_user_data(cmd)))(m, h);
 533 close_mixer:
 534         m->close(&h);
 535 free_sub_lpr:
 536         lls_free_parse_result(sub_lpr, cmd);
 537 free_lpr:
 538         lls_free_parse_result(lpr, CMD_PTR(PARA_MIXER));
 539         if (ret >= 0)
 540                 return EXIT_SUCCESS;
 541 fail:
 542         if (errctx)
 543                 PARA_ERROR_LOG("%s\n", errctx);
 544         free(errctx);
 545         PARA_EMERG_LOG("%s\n", para_strerror(-ret));
 546         return EXIT_FAILURE;
 547 }