play.c

   1 /* Copyright (C) 2012 Andre Noll <maan@tuebingen.mpg.de>, see file COPYING. */
   2
   3 /** \file play.c Paraslash's standalone player. */
   4
   5 #include <regex.h>
   6 #include <signal.h>
   7 #include <lopsub.h>
   8
   9 #include "recv_cmd.lsg.h"
  10 #include "filter_cmd.lsg.h"
  11 #include "play_cmd.lsg.h"
  12 #include "write_cmd.lsg.h"
  13 #include "play.lsg.h"
  14 #include "para.h"
  15 #include "lsu.h"
  16 #include "list.h"
  17 #include "error.h"
  18 #include "buffer_tree.h"
  19 #include "version.h"
  20 #include "string.h"
  21 #include "sched.h"
  22 #include "filter.h"
  23 #include "afh.h"
  24 #include "recv.h"
  25 #include "write.h"
  26 #include "fd.h"
  27
  28 /** Array of error strings. */
  29 DEFINE_PARA_ERRLIST;
  30
  31 static struct lls_parse_result *play_lpr;
  32
  33 #define CMD_PTR (lls_cmd(0, play_suite))
  34 #define OPT_RESULT(_name) \
  35         (lls_opt_result(LSG_PLAY_PARA_PLAY_OPT_ ## _name, play_lpr))
  36 #define OPT_GIVEN(_name) (lls_opt_given(OPT_RESULT(_name)))
  37 #define OPT_UINT32_VAL(_name) (lls_uint32_val(0, OPT_RESULT(_name)))
  38 #define OPT_STRING_VAL(_name) (lls_string_val(0, OPT_RESULT(_name)))
  39
  40 /**
  41  * Describes a request to change the state of para_play.
  42  *
  43  * There is only one variable of this type: \a rq of the global play task
  44  * structure. Command handlers only set this variable and the post_monitor()
  45  * function of the play task investigates its value during each iteration of
  46  * the scheduler run and performs the actual work.
  47  */
  48 enum state_change_request_type {
  49         /** Everybody is happy. */
  50         CRT_NONE,
  51         /** Stream must be repositioned (com_jmp(), com_ff()). */
  52         CRT_REPOS,
  53         /** New file should be loaded (com_next()). */
  54         CRT_FILE_CHANGE,
  55         /** Someone wants us for dead (com_quit()). */
  56         CRT_TERM_RQ
  57 };
  58
  59 struct play_task {
  60         struct task *task;
  61         /* A bit array of invalid files (those will be skipped). */
  62         bool *invalid;
  63         /* The file which is currently open. */
  64         unsigned current_file;
  65         /* When to update the status again. */
  66         struct timeval next_update;
  67
  68         /* Root of the buffer tree for command and status output. */
  69         struct btr_node *btrn;
  70
  71         /* The decoding machinery.  */
  72         struct receiver_node rn;
  73         struct filter_node fn;
  74         struct writer_node wn;
  75
  76         /* See comment to enum \ref state_change_request_type above. */
  77         enum state_change_request_type rq;
  78         /* only relevant if rq == CRT_FILE_CHANGE */
  79         unsigned next_file;
  80         /*
  81                 bg: read lines at prompt, fg: display status and wait
  82                 for keystroke.
  83         */
  84         bool background;
  85
  86         /* We have the *intention* to play. Set by com_play(). */
  87         bool playing;
  88
  89         /* as returned by afh_recv->open() */
  90         int audio_format_num;
  91
  92         /* retrieved via the btr exec mechanism */
  93         long unsigned start_chunk;
  94         long unsigned seconds;
  95         long unsigned num_chunks;
  96         char *afhi_txt;
  97 };
  98
  99 typedef int (*play_cmd_handler_t)(struct lls_parse_result *lpr);
 100 struct play_command_info {
 101         play_cmd_handler_t handler;
 102 };
 103
 104 static int loglevel = LL_WARNING;
 105
 106 /** The log function which writes log messages to stderr. */
 107 INIT_STDERR_LOGGING(loglevel);
 108
 109 char *stat_item_values[NUM_STAT_ITEMS] = {NULL};
 110
 111 static struct sched sched;
 112 static struct play_task play_task, *pt = &play_task;
 113
 114 #define AFH_RECV_CMD (lls_cmd(LSG_RECV_CMD_CMD_AFH, recv_cmd_suite))
 115 #define AFH_RECV ((struct receiver *)lls_user_data(AFH_RECV_CMD))
 116
 117 static unsigned *shuffle_map;
 118
 119 static const char *get_playlist_file(unsigned idx)
 120 {
 121         return lls_input(shuffle_map[idx], play_lpr);
 122 }
 123
 124 static void handle_help_flags(void)
 125 {
 126         char *help;
 127
 128         if (OPT_GIVEN(DETAILED_HELP))
 129                 help = lls_long_help(CMD_PTR);
 130         else if (OPT_GIVEN(HELP) || lls_num_inputs(play_lpr) == 0)
 131                 help = lls_short_help(CMD_PTR);
 132         else
 133                 return;
 134         printf("%s\n", help);
 135         free(help);
 136         exit(EXIT_SUCCESS);
 137 }
 138
 139 static void parse_config_or_die(int argc, char *argv[])
 140 {
 141         int i, ret;
 142         unsigned num_kmas;
 143         char *errctx;
 144
 145         ret = lls(lls_parse(argc, argv, CMD_PTR, &play_lpr, &errctx));
 146         if (ret < 0) {
 147                 if (errctx)
 148                         PARA_EMERG_LOG("%s\n", errctx);
 149                 free(errctx);
 150                 PARA_EMERG_LOG("failed to parse command line options: %s\n",
 151                         para_strerror(-ret));
 152                 exit(EXIT_FAILURE);
 153         }
 154         loglevel = OPT_UINT32_VAL(LOGLEVEL);
 155         version_handle_flag("play", OPT_GIVEN(VERSION));
 156         handle_help_flags(); /* also handles the zero-arg case */
 157         ret = lsu_merge_config_file_options(OPT_STRING_VAL(CONFIG_FILE),
 158                 "play.conf", &play_lpr, CMD_PTR, play_suite, 0 /* flags */);
 159         if (ret < 0) {
 160                 PARA_EMERG_LOG("failed to parse config file: %s\n",
 161                         para_strerror(-ret));
 162                 exit(EXIT_FAILURE);
 163         }
 164         loglevel = OPT_UINT32_VAL(LOGLEVEL);
 165         num_kmas = OPT_GIVEN(KEY_MAP);
 166         for (i = 0; i < num_kmas; i++) {
 167                 const char *kma = lls_string_val(i, OPT_RESULT(KEY_MAP));
 168                 if (*kma && strchr(kma + 1, ':'))
 169                         continue;
 170                 PARA_EMERG_LOG("invalid key map arg: %s\n", kma);
 171                 exit(EXIT_FAILURE);
 172         }
 173 }
 174
 175 static char get_playback_state(void)
 176 {
 177         switch (pt->rq) {
 178         case CRT_NONE: return pt->playing? 'P' : 'U';
 179         case CRT_REPOS: return 'R';
 180         case CRT_FILE_CHANGE: return 'F';
 181         case CRT_TERM_RQ: return 'X';
 182         }
 183         assert(false);
 184 };
 185
 186 /* returns number of milliseconds */
 187 static long unsigned get_play_time(void)
 188 {
 189         char state = get_playback_state();
 190         long unsigned result;
 191
 192         if (state != 'P' && state != 'U')
 193                 return 0;
 194         if (pt->num_chunks == 0 || pt->seconds == 0)
 195                 return 0;
 196         /* where the stream started (in milliseconds) */
 197         result = 1000ULL * pt->start_chunk * pt->seconds / pt->num_chunks;
 198         if (pt->wn.btrn) { /* Add the uptime of the writer node */
 199                 struct timeval diff = {.tv_sec = 0}, wstime;
 200                 btr_get_node_start(pt->wn.btrn, &wstime);
 201                 if (wstime.tv_sec > 0)
 202                         tv_diff(now, &wstime, &diff);
 203                 result += tv2ms(&diff);
 204         }
 205         result = PARA_MIN(result, pt->seconds * 1000);
 206         result = PARA_MAX(result, 0UL);
 207         return result;
 208 }
 209
 210 static void wipe_receiver_node(void)
 211 {
 212         PARA_NOTICE_LOG("cleaning up receiver node\n");
 213         btr_remove_node(&pt->rn.btrn);
 214         AFH_RECV->close(&pt->rn);
 215         lls_free_parse_result(pt->rn.lpr, AFH_RECV_CMD);
 216         memset(&pt->rn, 0, sizeof(struct receiver_node));
 217 }
 218
 219 /* returns: 0 not eof, 1: eof, < 0: fatal error.  */
 220 static int get_playback_error(void)
 221 {
 222         int err;
 223
 224         if (!pt->wn.task)
 225                 return 0;
 226         err = task_status(pt->wn.task);
 227         if (err >= 0)
 228                 return 0;
 229         if (task_status(pt->fn.task) >= 0)
 230                 return 0;
 231         if (task_status(pt->rn.task) >= 0)
 232                 return 0;
 233         if (err == -E_BTR_EOF || err == -E_RECV_EOF || err == -E_EOF
 234                         || err == -E_WRITE_COMMON_EOF)
 235                 return 1;
 236         return err;
 237 }
 238
 239 static int eof_cleanup(void)
 240 {
 241         const struct filter *decoder;
 242         const struct writer *w = writer_get(-1); /* default writer */
 243         int ret;
 244
 245         ret = get_playback_error();
 246         if (ret == 0)
 247                 return ret;
 248         PARA_NOTICE_LOG("cleaning up wn/fn nodes\n");
 249         task_reap(&pt->wn.task);
 250         w->close(&pt->wn);
 251         btr_remove_node(&pt->wn.btrn);
 252         lls_free_parse_result(pt->wn.lpr, WRITE_CMD(pt->wn.wid));
 253         memset(&pt->wn, 0, sizeof(struct writer_node));
 254
 255         decoder = filter_get(pt->fn.filter_num);
 256         task_reap(&pt->fn.task);
 257         if (decoder->close)
 258                 decoder->close(&pt->fn);
 259         btr_remove_node(&pt->fn.btrn);
 260         lls_free_parse_result(pt->fn.lpr, FILTER_CMD(pt->fn.filter_num));
 261         free(pt->fn.conf);
 262         memset(&pt->fn, 0, sizeof(struct filter_node));
 263
 264         task_reap(&pt->rn.task);
 265         btr_remove_node(&pt->rn.btrn);
 266         /*
 267          * On eof (ret > 0), we do not wipe the receiver node struct until a
 268          * new file is loaded because we still need it for jumping around when
 269          * paused.
 270          */
 271         if (ret < 0)
 272                 wipe_receiver_node();
 273         return ret;
 274 }
 275
 276 static int shuffle_compare(__a_unused const void *a, __a_unused const void *b)
 277 {
 278         return para_random(100) - 50;
 279 }
 280
 281 static void init_shuffle_map(void)
 282 {
 283         unsigned n, num_inputs = lls_num_inputs(play_lpr);
 284         shuffle_map = arr_alloc(num_inputs, sizeof(unsigned));
 285         for (n = 0; n < num_inputs; n++)
 286                 shuffle_map[n] = n;
 287         if (!OPT_GIVEN(RANDOMIZE))
 288                 return;
 289         srandom(time(NULL));
 290         qsort(shuffle_map, num_inputs, sizeof(unsigned), shuffle_compare);
 291 }
 292
 293 static struct btr_node *new_recv_btrn(struct receiver_node *rn)
 294 {
 295         return btr_new_node(&(struct btr_node_description)
 296                 EMBRACE(.name = lls_command_name(AFH_RECV_CMD), .context = rn,
 297                         .handler = AFH_RECV->execute));
 298 }
 299
 300 static int open_new_file(void)
 301 {
 302         int ret;
 303         const char *path = get_playlist_file(pt->next_file);
 304         char *tmp = para_strdup(path), *errctx;
 305         char *argv[] = {"play", "-f", tmp, "-b", "0", NULL};
 306
 307         PARA_NOTICE_LOG("next file: %s\n", path);
 308         wipe_receiver_node();
 309         pt->start_chunk = 0;
 310         pt->rn.btrn = new_recv_btrn(&pt->rn);
 311         ret = lls(lls_parse(ARRAY_SIZE(argv) - 1, argv, AFH_RECV_CMD,
 312                 &pt->rn.lpr, &errctx));
 313         free(tmp);
 314         assert(ret >= 0);
 315         pt->rn.receiver = AFH_RECV;
 316         ret = AFH_RECV->open(&pt->rn);
 317         if (ret < 0) {
 318                 PARA_ERROR_LOG("could not open %s\n", path);
 319                 goto fail;
 320         }
 321         pt->audio_format_num = ret;
 322         free(pt->afhi_txt);
 323         ret = btr_exec_up(pt->rn.btrn, "afhi", &pt->afhi_txt);
 324         if (ret < 0)
 325                 pt->afhi_txt = make_message("[afhi command failed]\n");
 326         ret = btr_exec_up(pt->rn.btrn, "seconds_total", &tmp);
 327         if (ret < 0)
 328                 pt->seconds = 1;
 329         else {
 330                 int32_t x;
 331                 ret = para_atoi32(tmp, &x);
 332                 pt->seconds = ret < 0? 1 : x;
 333                 free(tmp);
 334                 tmp = NULL;
 335         }
 336         ret = btr_exec_up(pt->rn.btrn, "chunks_total", &tmp);
 337         if (ret < 0)
 338                 pt->num_chunks = 1;
 339         else {
 340                 int32_t x;
 341                 ret = para_atoi32(tmp, &x);
 342                 pt->num_chunks = ret < 0? 1 : x;
 343                 free(tmp);
 344                 tmp = NULL;
 345         }
 346         return 1;
 347 fail:
 348         wipe_receiver_node();
 349         return ret;
 350 }
 351
 352 static int load_file(void)
 353 {
 354         const char *af;
 355         char *tmp, buf[20];
 356         int ret;
 357         const struct filter *decoder;
 358         static struct lls_parse_result *filter_lpr, *writer_lpr;
 359
 360         btr_remove_node(&pt->rn.btrn);
 361         if (!pt->rn.receiver || pt->next_file != pt->current_file) {
 362                 ret = open_new_file();
 363                 if (ret < 0)
 364                         return ret;
 365         } else {
 366                 pt->rn.btrn = new_recv_btrn(&pt->rn);
 367                 sprintf(buf, "repos %lu", pt->start_chunk);
 368                 ret = btr_exec_up(pt->rn.btrn, buf, &tmp);
 369                 if (ret < 0)
 370                         PARA_CRIT_LOG("repos failed: %s\n", para_strerror(-ret));
 371                 freep(&tmp);
 372         }
 373         if (!pt->playing)
 374                 return 0;
 375         /* set up decoding filter */
 376         af = audio_format_name(pt->audio_format_num);
 377         tmp = make_message("%sdec", af);
 378         ret = filter_setup(tmp, &pt->fn.conf, &filter_lpr);
 379         freep(&tmp);
 380         if (ret < 0)
 381                 goto fail;
 382         pt->fn.filter_num = ret;
 383         pt->fn.lpr = filter_lpr;
 384         decoder = filter_get(ret);
 385         pt->fn.btrn = btr_new_node(&(struct btr_node_description)
 386                 EMBRACE(.name = filter_name(pt->fn.filter_num),
 387                         .parent = pt->rn.btrn, .handler = decoder->execute,
 388                         .context = &pt->fn));
 389         if (decoder->open)
 390                 decoder->open(&pt->fn);
 391         PARA_INFO_LOG("buffer tree:\n");
 392         btr_log_tree(pt->rn.btrn, LL_INFO);
 393
 394         /* setup default writer */
 395         pt->wn.wid = check_writer_arg_or_die(NULL, &writer_lpr);
 396         pt->wn.lpr = writer_lpr;
 397         /* success, register tasks */
 398         pt->rn.task = task_register(
 399                 &(struct task_info) {
 400                         .name = lls_command_name(AFH_RECV_CMD),
 401                         .pre_monitor = AFH_RECV->pre_monitor,
 402                         .post_monitor = AFH_RECV->post_monitor,
 403                         .context = &pt->rn
 404                 }, &sched);
 405         sprintf(buf, "%s decoder", af);
 406         pt->fn.task = task_register(
 407                 &(struct task_info) {
 408                         .name = buf,
 409                         .pre_monitor = decoder->pre_monitor,
 410                         .post_monitor = decoder->post_monitor,
 411                         .context = &pt->fn
 412                 }, &sched);
 413         register_writer_node(&pt->wn, pt->fn.btrn, &sched);
 414         return 1;
 415 fail:
 416         wipe_receiver_node();
 417         return ret;
 418 }
 419
 420 static int next_valid_file(void)
 421 {
 422         int i, j = pt->current_file;
 423         unsigned num_inputs = lls_num_inputs(play_lpr);
 424
 425         if (j == num_inputs - 1) {
 426                 switch (OPT_UINT32_VAL(END_OF_PLAYLIST)) {
 427                 case EOP_LOOP: break;
 428                 case EOP_STOP:
 429                         pt->playing = false;
 430                         return 0;
 431                 case EOP_QUIT: return -E_EOP;
 432                 }
 433         }
 434         for (i = 0; i < num_inputs; i++) {
 435                 j = (j + 1) % num_inputs;
 436                 if (!pt->invalid[j])
 437                         return j;
 438         }
 439         return -E_NO_VALID_FILES;
 440 }
 441
 442 static int load_next_file(void)
 443 {
 444         int ret;
 445
 446 again:
 447         if (pt->rq == CRT_NONE) {
 448                 pt->start_chunk = 0;
 449                 ret = next_valid_file();
 450                 if (ret < 0)
 451                         return ret;
 452                 pt->next_file = ret;
 453         } else if (pt->rq == CRT_REPOS)
 454                 pt->next_file = pt->current_file;
 455         ret = load_file();
 456         if (ret < 0) {
 457                 PARA_ERROR_LOG("%s: marking file as invalid\n",
 458                         para_strerror(-ret));
 459                 pt->invalid[pt->next_file] = true;
 460                 pt->rq = CRT_NONE;
 461                 goto again;
 462         }
 463         pt->current_file = pt->next_file;
 464         pt->rq = CRT_NONE;
 465         return ret;
 466 }
 467
 468 static void kill_stream(void)
 469 {
 470         if (pt->wn.task)
 471                 task_notify(pt->wn.task, E_EOF);
 472 }
 473
 474 #ifdef HAVE_READLINE
 475
 476 /* only called from com_prev(), nec. only if we have readline */
 477 static int previous_valid_file(void)
 478 {
 479         int i, j = pt->current_file;
 480         unsigned num_inputs = lls_num_inputs(play_lpr);
 481
 482         for (i = 0; i < num_inputs; i++) {
 483                 j--;
 484                 if (j < 0)
 485                         j = num_inputs - 1;
 486                 if (!pt->invalid[j])
 487                         return j;
 488         }
 489         return -E_NO_VALID_FILES;
 490 }
 491
 492 #include "interactive.h"
 493
 494 /*
 495  * Define the default (internal) key mappings and helper functions to get the
 496  * key sequence or the command from a key id, which is what we obtain from
 497  * i9e/readline when the key is pressed.
 498  *
 499  * In some of these helper functions we could return pointers to the constant
 500  * arrays defined below. However, for others we can not, so let's better be
 501  * consistent and allocate all returned strings on the heap.
 502  */
 503
 504 #define INTERNAL_KEYMAP_ENTRIES \
 505         KEYMAP_ENTRY("^", "jmp 0"), \
 506         KEYMAP_ENTRY("1", "jmp 10"), \
 507         KEYMAP_ENTRY("2", "jmp 21"), \
 508         KEYMAP_ENTRY("3", "jmp 32"), \
 509         KEYMAP_ENTRY("4", "jmp 43"), \
 510         KEYMAP_ENTRY("5", "jmp 54"), \
 511         KEYMAP_ENTRY("6", "jmp 65"), \
 512         KEYMAP_ENTRY("7", "jmp 76"), \
 513         KEYMAP_ENTRY("8", "jmp 87"), \
 514         KEYMAP_ENTRY("9", "jmp 98"), \
 515         KEYMAP_ENTRY("+", "next"), \
 516         KEYMAP_ENTRY("-", "prev"), \
 517         KEYMAP_ENTRY(":", "bg"), \
 518         KEYMAP_ENTRY("i", "info"), \
 519         KEYMAP_ENTRY("l", "ls"), \
 520         KEYMAP_ENTRY("s", "play"), \
 521         KEYMAP_ENTRY("p", "pause"), \
 522         KEYMAP_ENTRY("q", "quit"), \
 523         KEYMAP_ENTRY("?", "help"), \
 524         KEYMAP_ENTRY("\033[D", "ff -10"), \
 525         KEYMAP_ENTRY("\033[C", "ff 10"), \
 526         KEYMAP_ENTRY("\033[A", "ff 60"), \
 527         KEYMAP_ENTRY("\033[B", "ff -60"), \
 528
 529 #define KEYMAP_ENTRY(a, b) a
 530 static const char *default_keyseqs[] = {INTERNAL_KEYMAP_ENTRIES};
 531 #undef KEYMAP_ENTRY
 532 #define KEYMAP_ENTRY(a, b) b
 533 static const char *default_commands[] = {INTERNAL_KEYMAP_ENTRIES};
 534 #undef KEYMAP_ENTRY
 535 #define NUM_INTERNALLY_MAPPED_KEYS ARRAY_SIZE(default_commands)
 536 #define NUM_MAPPED_KEYS (NUM_INTERNALLY_MAPPED_KEYS + OPT_GIVEN(KEY_MAP))
 537 #define FOR_EACH_MAPPED_KEY(i) for (i = 0; i < NUM_MAPPED_KEYS; i++)
 538
 539 static inline bool is_internal_key(int key)
 540 {
 541         return key < NUM_INTERNALLY_MAPPED_KEYS;
 542 }
 543
 544 /* for internal keys, the key id is just the array index. */
 545 static inline int get_internal_key_map_idx(int key)
 546 {
 547         assert(is_internal_key(key));
 548         return key;
 549 }
 550
 551 /*
 552  * For user-defined keys, we have to subtract NUM_INTERNALLY_MAPPED_KEYS. The
 553  * difference is the index to the array of user defined key maps.
 554  */
 555 static inline int get_user_key_map_idx(int key)
 556 {
 557         assert(!is_internal_key(key));
 558         return key - NUM_INTERNALLY_MAPPED_KEYS;
 559 }
 560
 561 static inline int get_key_map_idx(int key)
 562 {
 563         return is_internal_key(key)?
 564                 get_internal_key_map_idx(key) : get_user_key_map_idx(key);
 565 }
 566
 567 static inline const char *get_user_key_map_arg(int key)
 568 {
 569         return lls_string_val(get_user_key_map_idx(key), OPT_RESULT(KEY_MAP));
 570 }
 571
 572 static inline char *get_internal_key_map_seq(int key)
 573 {
 574         return para_strdup(default_keyseqs[get_internal_key_map_idx(key)]);
 575 }
 576
 577 static char *get_user_key_map_seq(int key)
 578 {
 579         const char *kma = get_user_key_map_arg(key);
 580         const char *p = strchr(kma + 1, ':');
 581         char *result;
 582         int len;
 583
 584         if (!p)
 585                 return NULL;
 586         len = p - kma;
 587         result = alloc(len + 1);
 588         memcpy(result, kma, len);
 589         result[len] = '\0';
 590         return result;
 591 }
 592
 593 static char *get_key_map_seq(int key)
 594 {
 595         return is_internal_key(key)?
 596                 get_internal_key_map_seq(key) : get_user_key_map_seq(key);
 597 }
 598
 599 static char *get_key_map_seq_safe(int key)
 600 {
 601         const char hex[] = "0123456789abcdef";
 602         char *seq = get_key_map_seq(key), *sseq;
 603         size_t n, len = strlen(seq);
 604
 605         if (len == 1 && isprint(*seq))
 606                 return seq;
 607         sseq = alloc(2 + 2 * len + 1);
 608         sseq[0] = '0';
 609         sseq[1] = 'x';
 610         for (n = 0; n < len; n++) {
 611                 uint8_t val = (seq[n] & 0xf0) >> 4;
 612                 sseq[2 + 2 * n] = hex[val];
 613                 val = seq[n] & 0xf;
 614                 sseq[2 + 2 * n + 1] = hex[val];
 615         }
 616         free(seq);
 617         sseq[2 + 2 * n] = '\0';
 618         return sseq;
 619 }
 620
 621 static inline char *get_internal_key_map_cmd(int key)
 622 {
 623         return para_strdup(default_commands[get_internal_key_map_idx(key)]);
 624 }
 625
 626 static char *get_user_key_map_cmd(int key)
 627 {
 628         const char *kma = get_user_key_map_arg(key);
 629         const char *p = strchr(kma + 1, ':');
 630
 631         if (!p)
 632                 return NULL;
 633         return para_strdup(p + 1);
 634 }
 635
 636 static char *get_key_map_cmd(int key)
 637 {
 638         return is_internal_key(key)?
 639                 get_internal_key_map_cmd(key) : get_user_key_map_cmd(key);
 640 }
 641
 642 static char **get_mapped_keyseqs(void)
 643 {
 644         char **result;
 645         int i;
 646
 647         result = arr_alloc(NUM_MAPPED_KEYS + 1, sizeof(char *));
 648         FOR_EACH_MAPPED_KEY(i) {
 649                 char *seq = get_key_map_seq(i);
 650                 result[i] = seq;
 651         }
 652         result[i] = NULL;
 653         return result;
 654 }
 655
 656 static struct i9e_completer pp_completers[];
 657
 658 I9E_DUMMY_COMPLETER(jmp);
 659 I9E_DUMMY_COMPLETER(next);
 660 I9E_DUMMY_COMPLETER(prev);
 661 I9E_DUMMY_COMPLETER(fg);
 662 I9E_DUMMY_COMPLETER(bg);
 663 I9E_DUMMY_COMPLETER(ls);
 664 I9E_DUMMY_COMPLETER(info);
 665 I9E_DUMMY_COMPLETER(play);
 666 I9E_DUMMY_COMPLETER(pause);
 667 I9E_DUMMY_COMPLETER(tasks);
 668 I9E_DUMMY_COMPLETER(quit);
 669 I9E_DUMMY_COMPLETER(ff);
 670
 671 static void help_completer(struct i9e_completion_info *ci,
 672                 struct i9e_completion_result *cr)
 673 {
 674         char *opts[] = {LSG_PLAY_CMD_HELP_OPTS, NULL};
 675
 676         if (ci->word[0] == '-') {
 677                 i9e_complete_option(opts, ci, cr);
 678                 return;
 679         }
 680         cr->matches = i9e_complete_commands(ci->word, pp_completers);
 681 }
 682
 683 static struct i9e_completer pp_completers[] = {
 684 #define LSG_PLAY_CMD_CMD(_name) {.name = #_name, \
 685         .completer = _name ## _completer}
 686         LSG_PLAY_CMD_SUBCOMMANDS
 687 #undef LSG_PLAY_CMD_CMD
 688         {.name = NULL}
 689 };
 690
 691 static void attach_stdout(const char *name)
 692 {
 693         if (pt->btrn)
 694                 return;
 695         pt->btrn = btr_new_node(&(struct btr_node_description)
 696                 EMBRACE(.name = name));
 697         i9e_attach_to_stdout(pt->btrn);
 698 }
 699
 700 static void detach_stdout(void)
 701 {
 702         btr_remove_node(&pt->btrn);
 703 }
 704
 705 #define EXPORT_PLAY_CMD_HANDLER(_cmd) \
 706         const struct play_command_info lsg_play_cmd_com_ ## _cmd ## _user_data = { \
 707                 .handler = com_ ## _cmd \
 708         };
 709
 710 static int com_quit(__a_unused struct lls_parse_result *lpr)
 711 {
 712         pt->rq = CRT_TERM_RQ;
 713         return 0;
 714 }
 715 EXPORT_PLAY_CMD_HANDLER(quit);
 716
 717 static int com_help(struct lls_parse_result *lpr)
 718 {
 719         int i;
 720         char *buf;
 721         size_t sz;
 722         unsigned n;
 723         const struct lls_opt_result *r =
 724                 lls_opt_result(LSG_PLAY_CMD_HELP_OPT_LONG, lpr);
 725         bool long_help = lls_opt_given(r);
 726
 727         if (!pt->background) {
 728                 FOR_EACH_MAPPED_KEY(i) {
 729                         bool internal = is_internal_key(i);
 730                         int idx = get_key_map_idx(i);
 731                         char *seq = get_key_map_seq_safe(i);
 732                         char *kmc = get_key_map_cmd(i);
 733                         sz = xasprintf(&buf, "%s key #%d: %s -> %s\n",
 734                                 internal? "internal" : "user-defined",
 735                                 idx, seq, kmc);
 736                         btr_add_output(buf, sz, pt->btrn);
 737                         free(seq);
 738                         free(kmc);
 739                 }
 740                 return 0;
 741         }
 742         lsu_com_help(long_help, lpr, play_cmd_suite, NULL, &buf, &n);
 743         btr_add_output(buf, n, pt->btrn);
 744         return 0;
 745 }
 746 EXPORT_PLAY_CMD_HANDLER(help);
 747
 748 static int com_info(__a_unused struct lls_parse_result *lpr)
 749 {
 750         char *buf;
 751         size_t sz;
 752         static char dflt[] = "[no information available]";
 753
 754         sz = xasprintf(&buf, "playlist_pos: %u\npath: %s\n",
 755                 pt->current_file, get_playlist_file(pt->current_file));
 756         btr_add_output(buf, sz, pt->btrn);
 757         buf = pt->afhi_txt? pt->afhi_txt : dflt;
 758         btr_add_output_dont_free(buf, strlen(buf), pt->btrn);
 759         return 0;
 760 }
 761 EXPORT_PLAY_CMD_HANDLER(info);
 762
 763 static void list_file(int num)
 764 {
 765         char *buf;
 766         size_t sz;
 767
 768         sz = xasprintf(&buf, "%s %4d %s\n", num == pt->current_file?
 769                 "*" : " ", num, get_playlist_file(num));
 770         btr_add_output(buf, sz, pt->btrn);
 771 }
 772
 773 static int com_tasks(__a_unused struct lls_parse_result *lpr)
 774 {
 775         static char state;
 776         char *buf;
 777         size_t sz;
 778
 779         buf = get_task_list(&sched);
 780         btr_add_output(buf, strlen(buf), pt->btrn);
 781         state = get_playback_state();
 782         sz = xasprintf(&buf, "state: %c\n", state);
 783         btr_add_output(buf, sz, pt->btrn);
 784         return 0;
 785 }
 786 EXPORT_PLAY_CMD_HANDLER(tasks);
 787
 788 static int com_ls(__a_unused struct lls_parse_result *lpr)
 789 {
 790         int i;
 791         unsigned num_inputs = lls_num_inputs(play_lpr);
 792
 793         for (i = 0; i < num_inputs; i++)
 794                 list_file(i);
 795         return 0;
 796 }
 797 EXPORT_PLAY_CMD_HANDLER(ls);
 798
 799 static int com_play(struct lls_parse_result *lpr)
 800 {
 801         int32_t x;
 802         int ret;
 803         char state, *errctx;
 804
 805         ret = lls(lls_check_arg_count(lpr, 0, 1, &errctx));
 806         if (ret < 0) {
 807                 if (errctx)
 808                         PARA_ERROR_LOG("%s\n", errctx);
 809                 free(errctx);
 810                 return ret;
 811         }
 812         state = get_playback_state();
 813         if (lls_num_inputs(lpr) == 0) {
 814                 if (state == 'P')
 815                         return 0;
 816                 pt->next_file = pt->current_file;
 817                 pt->rq = CRT_REPOS;
 818                 pt->playing = true;
 819                 return 0;
 820         }
 821         ret = para_atoi32(lls_input(0, lpr), &x);
 822         if (ret < 0)
 823                 return ret;
 824         if (x < 0 || x >= lls_num_inputs(play_lpr))
 825                 return -ERRNO_TO_PARA_ERROR(EINVAL);
 826         kill_stream();
 827         pt->next_file = x;
 828         pt->rq = CRT_FILE_CHANGE;
 829         return 0;
 830 }
 831 EXPORT_PLAY_CMD_HANDLER(play);
 832
 833 static int com_pause(__a_unused struct lls_parse_result *lpr)
 834 {
 835         char state;
 836         uint64_t ms;
 837         unsigned long cn; /* chunk num */
 838
 839         state = get_playback_state();
 840         pt->playing = false;
 841         if (state != 'P')
 842                 return 0;
 843         ms = get_play_time();
 844         pt->playing = false;
 845         cn = 0;
 846         if (pt->seconds > 0)
 847                 cn = ms * pt->num_chunks / pt->seconds / 1000 + 1;
 848         cn = PARA_MIN(cn, pt->num_chunks);
 849         pt->start_chunk = cn;
 850         pt->rq = CRT_REPOS;
 851         kill_stream();
 852         return 0;
 853 }
 854 EXPORT_PLAY_CMD_HANDLER(pause);
 855
 856 static int com_prev(__a_unused struct lls_parse_result *lpr)
 857 {
 858         int ret;
 859
 860         ret = previous_valid_file();
 861         if (ret < 0)
 862                 return ret;
 863         kill_stream();
 864         pt->next_file = ret;
 865         pt->rq = CRT_FILE_CHANGE;
 866         pt->start_chunk = 0;
 867         return 0;
 868 }
 869 EXPORT_PLAY_CMD_HANDLER(prev);
 870
 871 static int com_next(__a_unused struct lls_parse_result *lpr)
 872 {
 873         int ret;
 874
 875         ret = next_valid_file();
 876         if (ret < 0)
 877                 return ret;
 878         kill_stream();
 879         pt->next_file = ret;
 880         pt->rq = CRT_FILE_CHANGE;
 881         pt->start_chunk = 0;
 882         return 0;
 883 }
 884 EXPORT_PLAY_CMD_HANDLER(next);
 885
 886 static int com_fg(__a_unused struct lls_parse_result *lpr)
 887 {
 888         pt->background = false;
 889         return 0;
 890 }
 891 EXPORT_PLAY_CMD_HANDLER(fg);
 892
 893 static int com_bg(__a_unused struct lls_parse_result *lpr)
 894 {
 895         pt->background = true;
 896         return 0;
 897 }
 898 EXPORT_PLAY_CMD_HANDLER(bg);
 899
 900 static int com_jmp(struct lls_parse_result *lpr)
 901 {
 902         int32_t percent;
 903         int ret;
 904         char *errctx;
 905
 906         ret = lls(lls_check_arg_count(lpr, 1, 1, &errctx));
 907         if (ret < 0) {
 908                 if (errctx)
 909                         PARA_ERROR_LOG("%s\n", errctx);
 910                 free(errctx);
 911                 return ret;
 912         }
 913         ret = para_atoi32(lls_input(0, lpr), &percent);
 914         if (ret < 0)
 915                 return ret;
 916         if (percent < 0 || percent > 100)
 917                 return -ERRNO_TO_PARA_ERROR(EINVAL);
 918         if (percent == 100)
 919                 return com_next(NULL);
 920         if (pt->playing && !pt->fn.btrn)
 921                 return 0;
 922         pt->start_chunk = percent * pt->num_chunks / 100;
 923         if (!pt->playing)
 924                 return 0;
 925         pt->rq = CRT_REPOS;
 926         kill_stream();
 927         return 0;
 928 }
 929 EXPORT_PLAY_CMD_HANDLER(jmp);
 930
 931 static int com_ff(struct lls_parse_result *lpr)
 932 {
 933         int32_t seconds;
 934         char *errctx;
 935         int ret;
 936
 937         ret = lls(lls_check_arg_count(lpr, 1, 1, &errctx));
 938         if (ret < 0) {
 939                 if (errctx)
 940                         PARA_ERROR_LOG("%s\n", errctx);
 941                 free(errctx);
 942                 return ret;
 943         }
 944         ret = para_atoi32(lls_input(0, lpr), &seconds);
 945         if (ret < 0)
 946                 return ret;
 947         if (pt->playing && !pt->fn.btrn)
 948                 return 0;
 949         seconds += (get_play_time() + 500) / 1000;
 950         seconds = PARA_MIN(seconds, (typeof(seconds))pt->seconds - 4);
 951         seconds = PARA_MAX(seconds, 0);
 952         pt->start_chunk = pt->num_chunks * seconds / pt->seconds;
 953         pt->start_chunk = PARA_MIN(pt->start_chunk, pt->num_chunks - 1);
 954         pt->start_chunk = PARA_MAX(pt->start_chunk, 0UL);
 955         if (!pt->playing)
 956                 return 0;
 957         pt->rq = CRT_REPOS;
 958         kill_stream();
 959         return 0;
 960 }
 961 EXPORT_PLAY_CMD_HANDLER(ff);
 962
 963 static int run_command(char *line)
 964 {
 965         int ret, argc;
 966         char **argv = NULL;
 967         char *errctx = NULL;
 968         const struct play_command_info *pci;
 969         struct lls_parse_result *lpr;
 970         const struct lls_command *cmd;
 971
 972         attach_stdout(__FUNCTION__);
 973         ret = create_argv(line, " ", &argv);
 974         if (ret < 0)
 975                 goto out;
 976         if (ret == 0)
 977                 goto out;
 978         argc = ret;
 979         ret = lls(lls_lookup_subcmd(argv[0], play_cmd_suite, &errctx));
 980         if (ret < 0)
 981                 goto out;
 982         cmd = lls_cmd(ret, play_cmd_suite);
 983         ret = lls(lls_parse(argc, argv, cmd, &lpr, &errctx));
 984         if (ret < 0)
 985                 goto out;
 986         pci = lls_user_data(cmd);
 987         ret = pci->handler(lpr);
 988         lls_free_parse_result(lpr, cmd);
 989 out:
 990         if (errctx)
 991                 PARA_ERROR_LOG("%s\n", errctx);
 992         free(errctx);
 993         free_argv(argv);
 994         return ret;
 995 }
 996
 997 static int play_i9e_line_handler(char *line)
 998 {
 999         return run_command(line);
1000 }
1001
1002 static int play_i9e_key_handler(int key)
1003 {
1004         int idx = get_key_map_idx(key);
1005         char *seq = get_key_map_seq(key);
1006         char *cmd = get_key_map_cmd(key);
1007         bool internal = is_internal_key(key);
1008
1009         PARA_NOTICE_LOG("pressed %d: %s key #%d (%s -> %s)\n",
1010                 key, internal? "internal" : "user-defined",
1011                 idx, seq, cmd);
1012         run_command(cmd);
1013         free(seq);
1014         free(cmd);
1015         pt->next_update = *now;
1016         return 0;
1017 }
1018
1019 static struct i9e_client_info ici = {
1020         .fds = {0, 1, 2},
1021         .prompt = "para_play> ",
1022         .line_handler = play_i9e_line_handler,
1023         .key_handler = play_i9e_key_handler,
1024         .completers = pp_completers,
1025 };
1026
1027 static void sigint_handler(int sig)
1028 {
1029         pt->background = true;
1030         i9e_signal_dispatch(sig);
1031 }
1032
1033 /*
1034  * We start with para_log() set to the standard log function which writes to
1035  * stderr. Once the i9e subsystem has been initialized, we switch to the i9e
1036  * log facility.
1037  */
1038 static void session_open(void)
1039 {
1040         int ret;
1041         char *history_file;
1042         struct sigaction act;
1043
1044         PARA_NOTICE_LOG("\n%s\n", version_text("play"));
1045         if (OPT_GIVEN(HISTORY_FILE))
1046                 history_file = para_strdup(OPT_STRING_VAL(HISTORY_FILE));
1047         else {
1048                 char *home = para_homedir();
1049                 char *dot_para = make_message("%s/.paraslash", home);
1050
1051                 free(home);
1052                 ret = para_mkdir(dot_para, 0777);
1053                 /* warn, but otherwise ignore mkdir error */
1054                 if (ret < 0 && ret != -ERRNO_TO_PARA_ERROR(EEXIST))
1055                         PARA_WARNING_LOG("Can not create %s: %s\n", dot_para,
1056                                 para_strerror(-ret));
1057                 history_file = make_message("%s/play.history", dot_para);
1058                 free(dot_para);
1059         }
1060         ici.history_file = history_file;
1061         ici.loglevel = loglevel;
1062
1063         act.sa_handler = sigint_handler;
1064         sigemptyset(&act.sa_mask);
1065         act.sa_flags = 0;
1066         sigaction(SIGINT, &act, NULL);
1067         act.sa_handler = i9e_signal_dispatch;
1068         sigemptyset(&act.sa_mask);
1069         act.sa_flags = 0;
1070         sigaction(SIGWINCH, &act, NULL);
1071         sched.poll_function = i9e_poll;
1072
1073         ici.bound_keyseqs = get_mapped_keyseqs();
1074         pt->btrn = ici.producer = btr_new_node(&(struct btr_node_description)
1075                 EMBRACE(.name = __FUNCTION__));
1076         ret = i9e_open(&ici, &sched);
1077         if (ret < 0)
1078                 goto out;
1079         para_log = i9e_log;
1080         return;
1081 out:
1082         free(history_file);
1083         if (ret >= 0)
1084                 return;
1085         PARA_EMERG_LOG("fatal: %s\n", para_strerror(-ret));
1086         exit(EXIT_FAILURE);
1087 }
1088
1089 static void session_update_time_string(char *str, unsigned len)
1090 {
1091         if (pt->background)
1092                 return;
1093         if (pt->btrn) {
1094                 if (btr_get_output_queue_size(pt->btrn) > 0)
1095                         return;
1096                 if (btr_get_input_queue_size(pt->btrn) > 0)
1097                         return;
1098         }
1099         i9e_print_status_bar(str, len);
1100 }
1101
1102 /*
1103  * If we are about to die we must call i9e_close() to reset the terminal.
1104  * However, i9e_close() must be called in *this* context, i.e. from
1105  * play_task.post_monitor() rather than from i9e_post_monitor(), because
1106  * otherwise i9e would access freed memory upon return. So the play task must
1107  * stay alive until the i9e task terminates.
1108  *
1109  * We achieve this by sending a fake SIGTERM signal via i9e_signal_dispatch()
1110  * and reschedule. In the next iteration, i9e->post_monitor returns an error and
1111  * terminates. Subsequent calls to i9e_get_error() then return negative and we
1112  * are allowed to call i9e_close() and terminate as well.
1113  */
1114 static int session_post_monitor(__a_unused struct sched *s)
1115 {
1116         int ret;
1117
1118         if (pt->background)
1119                 detach_stdout();
1120         else
1121                 attach_stdout(__FUNCTION__);
1122         ret = i9e_get_error();
1123         if (ret < 0) {
1124                 kill_stream();
1125                 i9e_close();
1126                 para_log = stderr_log;
1127                 free(ici.history_file);
1128                 return ret;
1129         }
1130         if (get_playback_state() == 'X')
1131                 i9e_signal_dispatch(SIGTERM);
1132         return 0;
1133 }
1134
1135 #else /* HAVE_READLINE */
1136
1137 static int session_post_monitor(struct sched *s)
1138 {
1139         char c;
1140
1141         if (!sched_read_ok(STDIN_FILENO, s))
1142                 return 0;
1143         if (read(STDIN_FILENO, &c, 1))
1144                 do_nothing;
1145         kill_stream();
1146         return 1;
1147 }
1148
1149 static void session_open(void)
1150 {
1151 }
1152
1153 static void session_update_time_string(char *str, __a_unused unsigned len)
1154 {
1155         printf("\r%s     ", str);
1156         fflush(stdout);
1157 }
1158 #endif /* HAVE_READLINE */
1159
1160 static void play_pre_monitor(struct sched *s, __a_unused void *context)
1161 {
1162         char state;
1163
1164         sched_monitor_readfd(STDIN_FILENO, s);
1165         state = get_playback_state();
1166         if (state == 'R' || state == 'F' || state == 'X')
1167                 return sched_min_delay(s);
1168         sched_request_barrier_or_min_delay(&pt->next_update, s);
1169 }
1170
1171 static unsigned get_time_string(char **result)
1172 {
1173         int seconds, length;
1174         char state = get_playback_state();
1175
1176         /* do not return anything if things are about to change */
1177         if (state != 'P' && state != 'U') {
1178                 *result = NULL;
1179                 return 0;
1180         }
1181         length = pt->seconds;
1182         if (length == 0)
1183                 return xasprintf(result, "0:00 [0:00] (0%%/0:00)");
1184         seconds = (get_play_time() + 500) / 1000;
1185         return xasprintf(result, "#%u: %d:%02d [%d:%02d] (%d%%/%d:%02d) %s",
1186                 pt->current_file,
1187                 seconds / 60,
1188                 seconds % 60,
1189                 (length - seconds) / 60,
1190                 (length - seconds) % 60,
1191                 length? (seconds * 100 + length / 2) / length : 0,
1192                 length / 60,
1193                 length % 60,
1194                 get_playlist_file(pt->current_file)
1195         );
1196 }
1197
1198 static int play_post_monitor(struct sched *s, __a_unused void *context)
1199 {
1200         int ret;
1201
1202         ret = eof_cleanup();
1203         if (ret < 0) {
1204                 pt->rq = CRT_TERM_RQ;
1205                 return 0;
1206         }
1207         ret = session_post_monitor(s);
1208         if (ret < 0)
1209                 goto out;
1210         if (!pt->wn.btrn && !pt->fn.btrn) {
1211                 char state = get_playback_state();
1212                 if (state == 'P' || state == 'R' || state == 'F') {
1213                         PARA_NOTICE_LOG("state: %c\n", state);
1214                         ret = load_next_file();
1215                         if (ret < 0) {
1216                                 PARA_ERROR_LOG("%s\n", para_strerror(-ret));
1217                                 pt->rq = CRT_TERM_RQ;
1218                                 ret = 1;
1219                                 goto out;
1220                         }
1221                         pt->next_update = *now;
1222                 }
1223         }
1224         if (tv_diff(now, &pt->next_update, NULL) >= 0) {
1225                 char *str;
1226                 unsigned len = get_time_string(&str);
1227                 struct timeval delay = {.tv_sec = 0, .tv_usec = 100 * 1000};
1228                 if (str && len > 0)
1229                         session_update_time_string(str, len);
1230                 free(str);
1231                 tv_add(now, &delay, &pt->next_update);
1232         }
1233         ret = 1;
1234 out:
1235         return ret;
1236 }
1237
1238 /**
1239  * The main function of para_play.
1240  *
1241  * \param argc See man page.
1242  * \param argv See man page.
1243  *
1244  * para_play distributes its work by submitting various tasks to the paraslash
1245  * scheduler. The receiver, filter and writer tasks, which are used to play an
1246  * audio file, require one task each to maintain their underlying buffer tree
1247  * node. These tasks only exist when an audio file is playing.
1248  *
1249  * The i9 task, which is submitted and maintained by the i9e subsystem, reads
1250  * an input line and calls the corresponding command handler such as com_stop()
1251  * which is implemented in this file. The command handlers typically write a
1252  * request to the global play_task structure, whose contents are read and acted
1253  * upon by another task, the play task.
1254  *
1255  * As a rule, playlist handling is performed exclusively in play context, i.e.
1256  * in the post-monitor step of the play task, while command handlers are only
1257  * called in i9e context.
1258  *
1259  * \return EXIT_FAILURE or EXIT_SUCCESS.
1260  */
1261 int main(int argc, char *argv[])
1262 {
1263         int ret;
1264         unsigned num_inputs;
1265
1266         sched.default_timeout = 5000;
1267         parse_config_or_die(argc, argv);
1268         session_open();
1269         num_inputs = lls_num_inputs(play_lpr);
1270         init_shuffle_map();
1271         pt->invalid = arr_zalloc(num_inputs, sizeof(*pt->invalid));
1272         pt->rq = CRT_FILE_CHANGE;
1273         pt->playing = true;
1274         pt->task = task_register(&(struct task_info){
1275                 .name = "play",
1276                 .pre_monitor = play_pre_monitor,
1277                 .post_monitor = play_post_monitor,
1278                 .context = pt,
1279         }, &sched);
1280         ret = schedule(&sched);
1281         sched_shutdown(&sched);
1282         if (ret < 0)
1283                 PARA_ERROR_LOG("%s\n", para_strerror(-ret));
1284         return ret < 0? EXIT_FAILURE : EXIT_SUCCESS;
1285 }