play.c

   1 /*
   2  * Copyright (C) 2012 Andre Noll <maan@tuebingen.mpg.de>
   3  *
   4  * Licensed under the GPL v2. For licencing details see COPYING.
   5  */
   6
   7 /** \file play.c Paraslash's standalone player. */
   8
   9 #include <regex.h>
  10 #include <fnmatch.h>
  11 #include <signal.h>
  12
  13 #include "para.h"
  14 #include "list.h"
  15 #include "play.cmdline.h"
  16 #include "filter.cmdline.h"
  17 #include "error.h"
  18 #include "ggo.h"
  19 #include "buffer_tree.h"
  20 #include "version.h"
  21 #include "string.h"
  22 #include "sched.h"
  23 #include "filter.h"
  24 #include "afh.h"
  25 #include "recv.h"
  26 #include "write.h"
  27 #include "write_common.h"
  28 #include "fd.h"
  29
  30 /**
  31  * Besides playback tasks which correspond to the receiver/filter/writer nodes,
  32  * para_play creates two further tasks: The play task and the i9e task. It is
  33  * important whether a function can be called in the context of para_play or
  34  * i9e or both. As a rule, all command handlers are called only in i9e context via
  35  * the line handler (input mode) or the key handler (command mode) below.
  36  *
  37  * Playlist handling is done exclusively in play context.
  38  */
  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_select()
  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 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 /** Initialize the array of errors for para_play. */
 100 INIT_PLAY_ERRLISTS;
 101
 102 /* Activate the afh receiver. */
 103 extern void afh_recv_init(struct receiver *r);
 104 #undef AFH_RECEIVER
 105 /** Initialization code for a receiver struct. */
 106 #define AFH_RECEIVER {.name = "afh", .init = afh_recv_init},
 107 /** This expands to the array of all receivers. */
 108 DEFINE_RECEIVER_ARRAY;
 109
 110 static int loglevel = LL_WARNING;
 111
 112 /** The log function which writes log messages to stderr. */
 113 INIT_STDERR_LOGGING(loglevel);
 114
 115 char *stat_item_values[NUM_STAT_ITEMS] = {NULL};
 116
 117 /** Iterate over all files in the playlist. */
 118 #define FOR_EACH_PLAYLIST_FILE(i) for (i = 0; i < conf.inputs_num; i++)
 119 static struct play_args_info conf;
 120
 121 static struct sched sched = {.max_fileno = 0};
 122 static struct play_task play_task;
 123 static struct receiver *afh_recv;
 124
 125 static void check_afh_receiver_or_die(void)
 126 {
 127         int i;
 128
 129         FOR_EACH_RECEIVER(i) {
 130                 struct receiver *r = receivers + i;
 131                 if (strcmp(r->name, "afh"))
 132                         continue;
 133                 afh_recv = r;
 134                 return;
 135         }
 136         PARA_EMERG_LOG("fatal: afh receiver not found\n");
 137         exit(EXIT_FAILURE);
 138 }
 139
 140 __noreturn static void print_help_and_die(void)
 141 {
 142         struct ggo_help help = DEFINE_GGO_HELP(play);
 143         unsigned flags = conf.detailed_help_given?
 144                 GPH_STANDARD_FLAGS_DETAILED : GPH_STANDARD_FLAGS;
 145
 146         ggo_print_help(&help, flags);
 147         printf("supported audio formats: %s\n", AUDIO_FORMAT_HANDLERS);
 148         exit(0);
 149 }
 150
 151 static void parse_config_or_die(int argc, char *argv[])
 152 {
 153         int i, ret;
 154         char *config_file;
 155         struct play_cmdline_parser_params params = {
 156                 .override = 0,
 157                 .initialize = 1,
 158                 .check_required = 0,
 159                 .check_ambiguity = 0,
 160                 .print_errors = 1
 161         };
 162
 163         play_cmdline_parser_ext(argc, argv, &conf, &params);
 164         loglevel = get_loglevel_by_name(conf.loglevel_arg);
 165         version_handle_flag("play", conf.version_given);
 166         if (conf.help_given || conf.detailed_help_given)
 167                 print_help_and_die();
 168         if (conf.config_file_given)
 169                 config_file = para_strdup(conf.config_file_arg);
 170         else {
 171                 char *home = para_homedir();
 172                 config_file = make_message("%s/.paraslash/play.conf", home);
 173                 free(home);
 174         }
 175         ret = file_exists(config_file);
 176         if (conf.config_file_given && !ret) {
 177                 PARA_EMERG_LOG("can not read config file %s\n", config_file);
 178                 goto err;
 179         }
 180         if (ret) {
 181                 params.initialize = 0;
 182                 params.check_required = 1;
 183                 play_cmdline_parser_config_file(config_file, &conf, &params);
 184                 loglevel = get_loglevel_by_name(conf.loglevel_arg);
 185         }
 186         for (i = 0; i < conf.key_map_given; i++) {
 187                 char *kma = conf.key_map_arg[i];
 188                 if (*kma && strchr(kma + 1, ':'))
 189                         continue;
 190                 PARA_EMERG_LOG("invalid key map arg: %s\n", kma);
 191                 goto err;
 192         }
 193         free(config_file);
 194         return;
 195 err:
 196         free(config_file);
 197         exit(EXIT_FAILURE);
 198 }
 199
 200 static char get_playback_state(struct play_task *pt)
 201 {
 202         switch (pt->rq) {
 203         case CRT_NONE: return pt->playing? 'P' : 'U';
 204         case CRT_REPOS: return 'R';
 205         case CRT_FILE_CHANGE: return 'F';
 206         case CRT_TERM_RQ: return 'X';
 207         }
 208         assert(false);
 209 };
 210
 211 static long unsigned get_play_time(struct play_task *pt)
 212 {
 213         char state = get_playback_state(pt);
 214         long unsigned result;
 215
 216         if (state != 'P' && state != 'U')
 217                 return 0;
 218         if (pt->num_chunks == 0 || pt->seconds == 0)
 219                 return 0;
 220         /* where the stream started (in seconds) */
 221         result = pt->start_chunk * pt->seconds / pt->num_chunks;
 222         if (pt->wn.btrn) { /* Add the uptime of the writer node */
 223                 struct timeval diff = {.tv_sec = 0}, wstime;
 224                 btr_get_node_start(pt->wn.btrn, &wstime);
 225                 if (wstime.tv_sec > 0)
 226                         tv_diff(now, &wstime, &diff);
 227                 result += diff.tv_sec;
 228         }
 229         result = PARA_MIN(result, pt->seconds);
 230         result = PARA_MAX(result, 0UL);
 231         return result;
 232 }
 233
 234 static void wipe_receiver_node(struct play_task *pt)
 235 {
 236         PARA_NOTICE_LOG("cleaning up receiver node\n");
 237         btr_remove_node(&pt->rn.btrn);
 238         afh_recv->close(&pt->rn);
 239         afh_recv->free_config(pt->rn.conf);
 240         memset(&pt->rn, 0, sizeof(struct receiver_node));
 241 }
 242
 243 /* returns: 0 not eof, 1: eof, < 0: fatal error.  */
 244 static int get_playback_error(struct play_task *pt)
 245 {
 246         int err;
 247
 248         if (!pt->wn.task)
 249                 return 0;
 250         err = task_status(pt->wn.task);
 251         if (err >= 0)
 252                 return 0;
 253         if (task_status(pt->fn.task) >= 0)
 254                 return 0;
 255         if (task_status(pt->rn.task) >= 0)
 256                 return 0;
 257         if (err == -E_BTR_EOF || err == -E_RECV_EOF || err == -E_EOF
 258                         || err == -E_WRITE_COMMON_EOF)
 259                 return 1;
 260         return err;
 261 }
 262
 263 static int eof_cleanup(struct play_task *pt)
 264 {
 265         struct writer *w = writers + DEFAULT_WRITER;
 266         const struct filter *decoder = filter_get(pt->fn.filter_num);
 267         int ret;
 268
 269         ret = get_playback_error(pt);
 270         if (ret == 0)
 271                 return ret;
 272         PARA_NOTICE_LOG("cleaning up wn/fn nodes\n");
 273         task_reap(&pt->wn.task);
 274         w->close(&pt->wn);
 275         btr_remove_node(&pt->wn.btrn);
 276         w->free_config(pt->wn.conf);
 277         memset(&pt->wn, 0, sizeof(struct writer_node));
 278
 279         task_reap(&pt->fn.task);
 280         if (decoder->close)
 281                 decoder->close(&pt->fn);
 282         btr_remove_node(&pt->fn.btrn);
 283         free(pt->fn.conf);
 284         memset(&pt->fn, 0, sizeof(struct filter_node));
 285
 286         task_reap(&pt->rn.task);
 287         btr_remove_node(&pt->rn.btrn);
 288         /*
 289          * On eof (ret > 0), we do not wipe the receiver node struct until a
 290          * new file is loaded because we still need it for jumping around when
 291          * paused.
 292          */
 293         if (ret < 0)
 294                 wipe_receiver_node(pt);
 295         return ret;
 296 }
 297
 298 static int shuffle_compare(__a_unused const void *a, __a_unused const void *b)
 299 {
 300         return para_random(100) - 50;
 301 }
 302
 303 static void shuffle(char **base, size_t num)
 304 {
 305         srandom(time(NULL));
 306         qsort(base, num, sizeof(char *), shuffle_compare);
 307 }
 308
 309 static struct btr_node *new_recv_btrn(struct receiver_node *rn)
 310 {
 311         return btr_new_node(&(struct btr_node_description)
 312                 EMBRACE(.name = afh_recv->name, .context = rn,
 313                         .handler = afh_recv->execute));
 314 }
 315
 316 static int open_new_file(struct play_task *pt)
 317 {
 318         int ret;
 319         char *tmp, *path = conf.inputs[pt->next_file], *afh_recv_conf[] =
 320                 {"play", "-f", path, "-b", "0", NULL};
 321
 322         PARA_NOTICE_LOG("next file: %s\n", path);
 323         wipe_receiver_node(pt);
 324         pt->start_chunk = 0;
 325         pt->rn.btrn = new_recv_btrn(&pt->rn);
 326         pt->rn.conf = afh_recv->parse_config(ARRAY_SIZE(afh_recv_conf) - 1,
 327                 afh_recv_conf);
 328         assert(pt->rn.conf);
 329         pt->rn.receiver = afh_recv;
 330         ret = afh_recv->open(&pt->rn);
 331         if (ret < 0) {
 332                 PARA_ERROR_LOG("could not open %s: %s\n", path,
 333                         para_strerror(-ret));
 334                 goto fail;
 335         }
 336         pt->audio_format_num = ret;
 337         free(pt->afhi_txt);
 338         ret = btr_exec_up(pt->rn.btrn, "afhi", &pt->afhi_txt);
 339         if (ret < 0)
 340                 pt->afhi_txt = make_message("[afhi command failed]\n");
 341         ret = btr_exec_up(pt->rn.btrn, "seconds_total", &tmp);
 342         if (ret < 0)
 343                 pt->seconds = 1;
 344         else {
 345                 int32_t x;
 346                 ret = para_atoi32(tmp, &x);
 347                 pt->seconds = ret < 0? 1 : x;
 348                 free(tmp);
 349                 tmp = NULL;
 350         }
 351         ret = btr_exec_up(pt->rn.btrn, "chunks_total", &tmp);
 352         if (ret < 0)
 353                 pt->num_chunks = 1;
 354         else {
 355                 int32_t x;
 356                 ret = para_atoi32(tmp, &x);
 357                 pt->num_chunks = ret < 0? 1 : x;
 358                 free(tmp);
 359                 tmp = NULL;
 360         }
 361         return 1;
 362 fail:
 363         wipe_receiver_node(pt);
 364         return ret;
 365 }
 366
 367 static int load_file(struct play_task *pt)
 368 {
 369         const char *af;
 370         char *tmp, buf[20];
 371         int ret;
 372         const struct filter *decoder;
 373
 374         btr_remove_node(&pt->rn.btrn);
 375         if (!pt->rn.receiver || pt->next_file != pt->current_file) {
 376                 ret = open_new_file(pt);
 377                 if (ret < 0)
 378                         return ret;
 379         } else {
 380                 pt->rn.btrn = new_recv_btrn(&pt->rn);
 381                 sprintf(buf, "repos %lu", pt->start_chunk);
 382                 ret = btr_exec_up(pt->rn.btrn, buf, &tmp);
 383                 if (ret < 0)
 384                         PARA_CRIT_LOG("repos failed: %s\n", para_strerror(-ret));
 385                 freep(&tmp);
 386         }
 387         if (!pt->playing)
 388                 return 0;
 389         /* set up decoding filter */
 390         af = audio_format_name(pt->audio_format_num);
 391         tmp = make_message("%sdec", af);
 392         ret = check_filter_arg(tmp, &pt->fn.conf);
 393         freep(&tmp);
 394         if (ret < 0)
 395                 goto fail;
 396         pt->fn.filter_num = ret;
 397         decoder = filter_get(ret);
 398         pt->fn.btrn = btr_new_node(&(struct btr_node_description)
 399                 EMBRACE(.name = decoder->name, .parent = pt->rn.btrn,
 400                         .handler = decoder->execute, .context = &pt->fn));
 401         decoder->open(&pt->fn);
 402
 403         /* setup default writer */
 404         pt->wn.conf = check_writer_arg_or_die(NULL, &pt->wn.writer_num);
 405
 406         /* success, register tasks */
 407         pt->rn.task = task_register(
 408                 &(struct task_info) {
 409                         .name = afh_recv->name,
 410                         .pre_select = afh_recv->pre_select,
 411                         .post_select = afh_recv->post_select,
 412                         .context = &pt->rn
 413                 }, &sched);
 414         sprintf(buf, "%s decoder", af);
 415         pt->fn.task = task_register(
 416                 &(struct task_info) {
 417                         .name = buf,
 418                         .pre_select = decoder->pre_select,
 419                         .post_select = decoder->post_select,
 420                         .context = &pt->fn
 421                 }, &sched);
 422         register_writer_node(&pt->wn, pt->fn.btrn, &sched);
 423         return 1;
 424 fail:
 425         wipe_receiver_node(pt);
 426         return ret;
 427 }
 428
 429 static int next_valid_file(struct play_task *pt)
 430 {
 431         int i, j = pt->current_file;
 432
 433         FOR_EACH_PLAYLIST_FILE(i) {
 434                 j = (j + 1) % conf.inputs_num;
 435                 if (!pt->invalid[j])
 436                         return j;
 437         }
 438         return -E_NO_VALID_FILES;
 439 }
 440
 441 static int load_next_file(struct play_task *pt)
 442 {
 443         int ret;
 444
 445 again:
 446         if (pt->rq == CRT_NONE) {
 447                 pt->start_chunk = 0;
 448                 ret = next_valid_file(pt);
 449                 if (ret < 0)
 450                         return ret;
 451                 pt->next_file = ret;
 452         } else if (pt->rq == CRT_REPOS)
 453                 pt->next_file = pt->current_file;
 454         ret = load_file(pt);
 455         if (ret < 0) {
 456                 pt->invalid[pt->next_file] = true;
 457                 pt->rq = CRT_NONE;
 458                 goto again;
 459         }
 460         pt->current_file = pt->next_file;
 461         pt->rq = CRT_NONE;
 462         return ret;
 463 }
 464
 465 static void kill_stream(struct play_task *pt)
 466 {
 467         if (pt->wn.task)
 468                 task_notify(pt->wn.task, E_EOF);
 469 }
 470
 471 #ifdef HAVE_READLINE
 472
 473 /* only called from com_prev(), nec. only if we have readline */
 474 static int previous_valid_file(struct play_task *pt)
 475 {
 476         int i, j = pt->current_file;
 477
 478         FOR_EACH_PLAYLIST_FILE(i) {
 479                 j--;
 480                 if (j < 0)
 481                         j = conf.inputs_num - 1;
 482                 if (!pt->invalid[j])
 483                         return j;
 484         }
 485         return -E_NO_VALID_FILES;
 486 }
 487
 488 #include "interactive.h"
 489
 490 /*
 491  * Define the default (internal) key mappings and helper functions to get the
 492  * key sequence or the command from a key id, which is what we obtain from
 493  * i9e/readline when the key is pressed.
 494  *
 495  * In some of these helper functions we could return pointers to the constant
 496  * arrays defined below. However, for others we can not, so let's better be
 497  * consistent and allocate all returned strings on the heap.
 498  */
 499
 500 #define INTERNAL_KEYMAP_ENTRIES \
 501         KEYMAP_ENTRY("^", "jmp 0"), \
 502         KEYMAP_ENTRY("1", "jmp 10"), \
 503         KEYMAP_ENTRY("2", "jmp 21"), \
 504         KEYMAP_ENTRY("3", "jmp 32"), \
 505         KEYMAP_ENTRY("4", "jmp 43"), \
 506         KEYMAP_ENTRY("5", "jmp 54"), \
 507         KEYMAP_ENTRY("6", "jmp 65"), \
 508         KEYMAP_ENTRY("7", "jmp 76"), \
 509         KEYMAP_ENTRY("8", "jmp 87"), \
 510         KEYMAP_ENTRY("9", "jmp 98"), \
 511         KEYMAP_ENTRY("+", "next"), \
 512         KEYMAP_ENTRY("-", "prev"), \
 513         KEYMAP_ENTRY(":", "bg"), \
 514         KEYMAP_ENTRY("i", "info"), \
 515         KEYMAP_ENTRY("l", "ls"), \
 516         KEYMAP_ENTRY("s", "play"), \
 517         KEYMAP_ENTRY("p", "pause"), \
 518         KEYMAP_ENTRY("q", "quit"), \
 519         KEYMAP_ENTRY("?", "help"), \
 520         KEYMAP_ENTRY("\033[D", "ff -10"), \
 521         KEYMAP_ENTRY("\033[C", "ff 10"), \
 522         KEYMAP_ENTRY("\033[A", "ff 60"), \
 523         KEYMAP_ENTRY("\033[B", "ff -60"), \
 524
 525 #define KEYMAP_ENTRY(a, b) a
 526 static const char *default_keyseqs[] = {INTERNAL_KEYMAP_ENTRIES};
 527 #undef KEYMAP_ENTRY
 528 #define KEYMAP_ENTRY(a, b) b
 529 static const char *default_commands[] = {INTERNAL_KEYMAP_ENTRIES};
 530 #undef KEYMAP_ENTRY
 531 #define NUM_INTERNALLY_MAPPED_KEYS ARRAY_SIZE(default_commands)
 532 #define NUM_MAPPED_KEYS (NUM_INTERNALLY_MAPPED_KEYS + conf.key_map_given)
 533 #define FOR_EACH_MAPPED_KEY(i) for (i = 0; i < NUM_MAPPED_KEYS; i++)
 534
 535 static inline bool is_internal_key(int key)
 536 {
 537         return key < NUM_INTERNALLY_MAPPED_KEYS;
 538 }
 539
 540 /* for internal keys, the key id is just the array index. */
 541 static inline int get_internal_key_map_idx(int key)
 542 {
 543         assert(is_internal_key(key));
 544         return key;
 545 }
 546
 547 /*
 548  * For user-defined keys, we have to subtract NUM_INTERNALLY_MAPPED_KEYS. The
 549  * difference is the index to the array of user defined key maps.
 550  */
 551 static inline int get_user_key_map_idx(int key)
 552 {
 553         assert(!is_internal_key(key));
 554         return key - NUM_INTERNALLY_MAPPED_KEYS;
 555 }
 556
 557 static inline int get_key_map_idx(int key)
 558 {
 559         return is_internal_key(key)?
 560                 get_internal_key_map_idx(key) : get_user_key_map_idx(key);
 561 }
 562
 563 static inline char *get_user_key_map_arg(int key)
 564 {
 565         return conf.key_map_arg[get_user_key_map_idx(key)];
 566 }
 567
 568 static inline char *get_internal_key_map_seq(int key)
 569 {
 570         return para_strdup(default_keyseqs[get_internal_key_map_idx(key)]);
 571 }
 572
 573 static char *get_user_key_map_seq(int key)
 574 {
 575         const char *kma = get_user_key_map_arg(key);
 576         const char *p = strchr(kma + 1, ':');
 577         char *result;
 578         int len;
 579
 580         if (!p)
 581                 return NULL;
 582         len = p - kma;
 583         result = para_malloc(len + 1);
 584         memcpy(result, kma, len);
 585         result[len] = '\0';
 586         return result;
 587 }
 588
 589 static char *get_key_map_seq(int key)
 590 {
 591         return is_internal_key(key)?
 592                 get_internal_key_map_seq(key) : get_user_key_map_seq(key);
 593 }
 594
 595 static inline char *get_internal_key_map_cmd(int key)
 596 {
 597         return para_strdup(default_commands[get_internal_key_map_idx(key)]);
 598 }
 599
 600 static char *get_user_key_map_cmd(int key)
 601 {
 602         const char *kma = get_user_key_map_arg(key);
 603         const char *p = strchr(kma + 1, ':');
 604
 605         if (!p)
 606                 return NULL;
 607         return para_strdup(p + 1);
 608 }
 609
 610 static char *get_key_map_cmd(int key)
 611 {
 612         return is_internal_key(key)?
 613                 get_internal_key_map_cmd(key) : get_user_key_map_cmd(key);
 614 }
 615
 616 static char **get_mapped_keyseqs(void)
 617 {
 618         char **result;
 619         int i;
 620
 621         result = para_malloc((NUM_MAPPED_KEYS + 1) * sizeof(char *));
 622         FOR_EACH_MAPPED_KEY(i) {
 623                 char *seq = get_key_map_seq(i);
 624                 result[i] = seq;
 625         }
 626         result[i] = NULL;
 627         return result;
 628 }
 629
 630 #include "play.command_list.h"
 631
 632 typedef int play_command_handler_t(struct play_task *, int, char**);
 633 static play_command_handler_t PLAY_COMMAND_HANDLERS;
 634
 635 /* defines one command of para_play */
 636 struct pp_command {
 637         const char *name;
 638         play_command_handler_t *handler;
 639         const char *description;
 640         const char *usage;
 641         const char *help;
 642 };
 643
 644 static struct pp_command pp_cmds[] = {DEFINE_PLAY_CMD_ARRAY};
 645 #define FOR_EACH_COMMAND(c) for (c = 0; pp_cmds[c].name; c++)
 646
 647 #include "play.completion.h"
 648 static struct i9e_completer pp_completers[];
 649
 650 I9E_DUMMY_COMPLETER(jmp);
 651 I9E_DUMMY_COMPLETER(next);
 652 I9E_DUMMY_COMPLETER(prev);
 653 I9E_DUMMY_COMPLETER(fg);
 654 I9E_DUMMY_COMPLETER(bg);
 655 I9E_DUMMY_COMPLETER(ls);
 656 I9E_DUMMY_COMPLETER(info);
 657 I9E_DUMMY_COMPLETER(play);
 658 I9E_DUMMY_COMPLETER(pause);
 659 I9E_DUMMY_COMPLETER(stop);
 660 I9E_DUMMY_COMPLETER(tasks);
 661 I9E_DUMMY_COMPLETER(quit);
 662 I9E_DUMMY_COMPLETER(ff);
 663
 664 static void help_completer(struct i9e_completion_info *ci,
 665                 struct i9e_completion_result *result)
 666 {
 667         result->matches = i9e_complete_commands(ci->word, pp_completers);
 668 }
 669
 670 static struct i9e_completer pp_completers[] = {PLAY_COMPLETERS {.name = NULL}};
 671
 672 static void attach_stdout(struct play_task *pt, const char *name)
 673 {
 674         if (pt->btrn)
 675                 return;
 676         pt->btrn = btr_new_node(&(struct btr_node_description)
 677                 EMBRACE(.name = name));
 678         i9e_attach_to_stdout(pt->btrn);
 679 }
 680
 681 static void detach_stdout(struct play_task *pt)
 682 {
 683         btr_remove_node(&pt->btrn);
 684 }
 685
 686 static int com_quit(struct play_task *pt, int argc, __a_unused char **argv)
 687 {
 688         if (argc != 1)
 689                 return -E_PLAY_SYNTAX;
 690         pt->rq = CRT_TERM_RQ;
 691         return 0;
 692 }
 693
 694 static int com_help(struct play_task *pt, int argc, char **argv)
 695 {
 696         int i;
 697         char *buf;
 698         size_t sz;
 699
 700         if (argc > 2)
 701                 return -E_PLAY_SYNTAX;
 702         if (argc < 2) {
 703                 if (pt->background)
 704                         FOR_EACH_COMMAND(i) {
 705                                 sz = xasprintf(&buf, "%s\t%s\n", pp_cmds[i].name,
 706                                         pp_cmds[i].description);
 707                                 btr_add_output(buf, sz, pt->btrn);
 708                         }
 709                 else {
 710                         FOR_EACH_MAPPED_KEY(i) {
 711                                 bool internal = is_internal_key(i);
 712                                 int idx = get_key_map_idx(i);
 713                                 char *seq = get_key_map_seq(i);
 714                                 char *cmd = get_key_map_cmd(i);
 715                                 sz = xasprintf(&buf,
 716                                         "%s key #%d: %s -> %s\n",
 717                                         internal? "internal" : "user-defined",
 718                                         idx, seq, cmd);
 719                                 btr_add_output(buf, sz, pt->btrn);
 720                                 free(seq);
 721                                 free(cmd);
 722                         }
 723                 }
 724                 return 0;
 725         }
 726         FOR_EACH_COMMAND(i) {
 727                 if (strcmp(pp_cmds[i].name, argv[1]))
 728                         continue;
 729                 sz = xasprintf(&buf,
 730                         "NAME\n\t%s -- %s\n"
 731                         "SYNOPSIS\n\t%s\n"
 732                         "DESCRIPTION\n%s\n",
 733                         argv[1],
 734                         pp_cmds[i].description,
 735                         pp_cmds[i].usage,
 736                         pp_cmds[i].help
 737                 );
 738                 btr_add_output(buf, sz, pt->btrn);
 739                 return 0;
 740         }
 741         return -E_BAD_PLAY_CMD;
 742 }
 743
 744 static int com_info(struct play_task *pt, int argc, __a_unused char **argv)
 745 {
 746         char *buf;
 747         size_t sz;
 748         static char dflt[] = "[no information available]";
 749
 750         if (argc != 1)
 751                 return -E_PLAY_SYNTAX;
 752         sz = xasprintf(&buf, "playlist_pos: %u\npath: %s\n",
 753                 pt->current_file, conf.inputs[pt->current_file]);
 754         btr_add_output(buf, sz, pt->btrn);
 755         buf = pt->afhi_txt? pt->afhi_txt : dflt;
 756         btr_add_output_dont_free(buf, strlen(buf), pt->btrn);
 757         return 0;
 758 }
 759
 760 static void list_file(struct play_task *pt, int num)
 761 {
 762         char *buf;
 763         size_t sz;
 764
 765         sz = xasprintf(&buf, "%s %4u %s\n", num == pt->current_file?
 766                 "*" : " ", num, conf.inputs[num]);
 767         btr_add_output(buf, sz, pt->btrn);
 768 }
 769
 770 static int com_tasks(struct play_task *pt, int argc, __a_unused char **argv)
 771 {
 772         static char state;
 773         char *buf;
 774         size_t sz;
 775
 776         if (argc != 1)
 777                 return -E_PLAY_SYNTAX;
 778
 779         buf = get_task_list(&sched);
 780         btr_add_output(buf, strlen(buf), pt->btrn);
 781         state = get_playback_state(pt);
 782         sz = xasprintf(&buf, "state: %c\n", state);
 783         btr_add_output(buf, sz, pt->btrn);
 784         return 0;
 785 }
 786
 787 static int com_ls(struct play_task *pt, int argc, char **argv)
 788 {
 789         int i, j, ret;
 790
 791         if (argc == 1) {
 792                 FOR_EACH_PLAYLIST_FILE(i)
 793                         list_file(pt, i);
 794                 return 0;
 795         }
 796         for (j = 1; j < argc; j++) {
 797                 FOR_EACH_PLAYLIST_FILE(i) {
 798                         ret = fnmatch(argv[j], conf.inputs[i], 0);
 799                         if (ret == 0) /* match */
 800                                 list_file(pt, i);
 801                 }
 802         }
 803         return 0;
 804 }
 805
 806 static int com_play(struct play_task *pt, int argc, char **argv)
 807 {
 808         int32_t x;
 809         int ret;
 810         char state;
 811
 812         if (argc > 2)
 813                 return -E_PLAY_SYNTAX;
 814         state = get_playback_state(pt);
 815         if (argc == 1) {
 816                 if (state == 'P')
 817                         return 0;
 818                 pt->next_file = pt->current_file;
 819                 pt->rq = CRT_REPOS;
 820                 pt->playing = true;
 821                 return 0;
 822         }
 823         ret = para_atoi32(argv[1], &x);
 824         if (ret < 0)
 825                 return ret;
 826         if (x < 0 || x >= conf.inputs_num)
 827                 return -ERRNO_TO_PARA_ERROR(EINVAL);
 828         kill_stream(pt);
 829         pt->next_file = x;
 830         pt->rq = CRT_FILE_CHANGE;
 831         return 0;
 832 }
 833
 834 static int com_pause(struct play_task *pt, int argc, __a_unused char **argv)
 835 {
 836         char state;
 837         long unsigned seconds, ss;
 838
 839         if (argc != 1)
 840                 return -E_PLAY_SYNTAX;
 841         state = get_playback_state(pt);
 842         pt->playing = false;
 843         if (state != 'P')
 844                 return 0;
 845         seconds = get_play_time(pt);
 846         pt->playing = false;
 847         ss = 0;
 848         if (pt->seconds > 0)
 849                 ss = seconds * pt->num_chunks / pt->seconds + 1;
 850         ss = PARA_MAX(ss, 0UL);
 851         ss = PARA_MIN(ss, pt->num_chunks);
 852         pt->start_chunk = ss;
 853         kill_stream(pt);
 854         return 0;
 855 }
 856
 857 static int com_prev(struct play_task *pt, int argc, __a_unused char **argv)
 858
 859 {
 860         int ret;
 861
 862         if (argc != 1)
 863                 return -E_PLAY_SYNTAX;
 864         ret = previous_valid_file(pt);
 865         if (ret < 0)
 866                 return ret;
 867         kill_stream(pt);
 868         pt->next_file = ret;
 869         pt->rq = CRT_FILE_CHANGE;
 870         pt->start_chunk = 0;
 871         return 0;
 872 }
 873
 874 static int com_next(struct play_task *pt, int argc, __a_unused char **argv)
 875 {
 876         int ret;
 877
 878         if (argc != 1)
 879                 return -E_PLAY_SYNTAX;
 880         ret = next_valid_file(pt);
 881         if (ret < 0)
 882                 return ret;
 883         kill_stream(pt);
 884         pt->next_file = ret;
 885         pt->rq = CRT_FILE_CHANGE;
 886         pt->start_chunk = 0;
 887         return 0;
 888 }
 889
 890 static int com_fg(struct play_task *pt, int argc, __a_unused char **argv)
 891 {
 892         if (argc != 1)
 893                 return -E_PLAY_SYNTAX;
 894         pt->background = false;
 895         return 0;
 896 }
 897
 898 static int com_bg(struct play_task *pt, int argc, __a_unused char **argv)
 899 {
 900         if (argc != 1)
 901                 return -E_PLAY_SYNTAX;
 902         pt->background = true;
 903         return 0;
 904 }
 905
 906 static int com_jmp(struct play_task *pt, int argc, char **argv)
 907 {
 908         int32_t percent;
 909         int ret;
 910
 911         if (argc != 2)
 912                 return -E_PLAY_SYNTAX;
 913         ret = para_atoi32(argv[1], &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(pt, 1, (char *[]){"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(pt);
 927         return 0;
 928 }
 929
 930 static int com_ff(struct play_task *pt, int argc, char **argv)
 931 {
 932         int32_t seconds;
 933         int ret;
 934
 935         if (argc != 2)
 936                 return -E_PLAY_SYNTAX;
 937         ret = para_atoi32(argv[1], &seconds);
 938         if (ret < 0)
 939                 return ret;
 940         if (pt->playing && !pt->fn.btrn)
 941                 return 0;
 942         seconds += get_play_time(pt);
 943         seconds = PARA_MIN(seconds, (typeof(seconds))pt->seconds - 4);
 944         seconds = PARA_MAX(seconds, 0);
 945         pt->start_chunk = pt->num_chunks * seconds / pt->seconds;
 946         pt->start_chunk = PARA_MIN(pt->start_chunk, pt->num_chunks - 1);
 947         pt->start_chunk = PARA_MAX(pt->start_chunk, 0UL);
 948         if (!pt->playing)
 949                 return 0;
 950         pt->rq = CRT_REPOS;
 951         kill_stream(pt);
 952         return 0;
 953 }
 954
 955 static int run_command(char *line, struct play_task *pt)
 956 {
 957         int i, ret, argc;
 958         char **argv = NULL;
 959
 960         attach_stdout(pt, __FUNCTION__);
 961         ret = create_argv(line, " ", &argv);
 962         if (ret < 0) {
 963                 PARA_ERROR_LOG("parse error: %s\n", para_strerror(-ret));
 964                 return 0;
 965         }
 966         if (ret == 0)
 967                 goto out;
 968         argc = ret;
 969         FOR_EACH_COMMAND(i) {
 970                 if (strcmp(pp_cmds[i].name, argv[0]))
 971                         continue;
 972                 ret = pp_cmds[i].handler(pt, argc, argv);
 973                 if (ret < 0)
 974                         PARA_WARNING_LOG("%s: %s\n", pt->background?
 975                                 "" : argv[0], para_strerror(-ret));
 976                 ret = 1;
 977                 goto out;
 978         }
 979         PARA_WARNING_LOG("invalid command: %s\n", argv[0]);
 980         ret = 0;
 981 out:
 982         free_argv(argv);
 983         return ret;
 984 }
 985
 986 static int play_i9e_line_handler(char *line)
 987 {
 988         return run_command(line, &play_task);
 989 }
 990
 991 static int play_i9e_key_handler(int key)
 992 {
 993         struct play_task *pt = &play_task;
 994         int idx = get_key_map_idx(key);
 995         char *seq = get_key_map_seq(key);
 996         char *cmd = get_key_map_cmd(key);
 997         bool internal = is_internal_key(key);
 998
 999         PARA_NOTICE_LOG("pressed %d: %s key #%d (%s -> %s)\n",
1000                 key, internal? "internal" : "user-defined",
1001                 idx, seq, cmd);
1002         run_command(cmd, pt);
1003         free(seq);
1004         free(cmd);
1005         pt->next_update = *now;
1006         return 0;
1007 }
1008
1009 static struct i9e_client_info ici = {
1010         .fds = {0, 1, 2},
1011         .prompt = "para_play> ",
1012         .line_handler = play_i9e_line_handler,
1013         .key_handler = play_i9e_key_handler,
1014         .completers = pp_completers,
1015 };
1016
1017 static void sigint_handler(int sig)
1018 {
1019         play_task.background = true;
1020         i9e_signal_dispatch(sig);
1021 }
1022
1023 /*
1024  * We start with para_log() set to the standard log function which writes to
1025  * stderr. Once the i9e subsystem has been initialized, we switch to the i9e
1026  * log facility.
1027  */
1028 static void session_open(struct play_task *pt)
1029 {
1030         int ret;
1031         char *history_file;
1032         struct sigaction act;
1033
1034         PARA_NOTICE_LOG("\n%s\n", version_text("play"));
1035         if (conf.history_file_given)
1036                 history_file = para_strdup(conf.history_file_arg);
1037         else {
1038                 char *home = para_homedir();
1039                 history_file = make_message("%s/.paraslash/play.history",
1040                         home);
1041                 free(home);
1042         }
1043         ici.history_file = history_file;
1044         ici.loglevel = loglevel;
1045
1046         act.sa_handler = sigint_handler;
1047         sigemptyset(&act.sa_mask);
1048         act.sa_flags = 0;
1049         sigaction(SIGINT, &act, NULL);
1050         act.sa_handler = i9e_signal_dispatch;
1051         sigemptyset(&act.sa_mask);
1052         act.sa_flags = 0;
1053         sigaction(SIGWINCH, &act, NULL);
1054         sched.select_function = i9e_select;
1055
1056         ici.bound_keyseqs = get_mapped_keyseqs();
1057         pt->btrn = ici.producer = btr_new_node(&(struct btr_node_description)
1058                 EMBRACE(.name = __FUNCTION__));
1059         ret = i9e_open(&ici, &sched);
1060         if (ret < 0)
1061                 goto out;
1062         para_log = i9e_log;
1063         return;
1064 out:
1065         free(history_file);
1066         if (ret >= 0)
1067                 return;
1068         PARA_EMERG_LOG("fatal: %s\n", para_strerror(-ret));
1069         exit(EXIT_FAILURE);
1070 }
1071
1072 static void session_update_time_string(struct play_task *pt, char *str, unsigned len)
1073 {
1074         if (pt->background)
1075                 return;
1076         if (pt->btrn) {
1077                 if (btr_get_output_queue_size(pt->btrn) > 0)
1078                         return;
1079                 if (btr_get_input_queue_size(pt->btrn) > 0)
1080                         return;
1081         }
1082         ie9_print_status_bar(str, len);
1083 }
1084
1085 /*
1086  * If we are about to die we must call i9e_close() to reset the terminal.
1087  * However, i9e_close() must be called in *this* context, i.e. from
1088  * play_task.post_select() rather than from i9e_post_select(), because
1089  * otherwise i9e would access freed memory upon return. So the play task must
1090  * stay alive until the i9e task terminates.
1091  *
1092  * We achieve this by sending a fake SIGTERM signal via i9e_signal_dispatch()
1093  * and reschedule. In the next iteration, i9e->post_select returns an error and
1094  * terminates. Subsequent calls to i9e_get_error() then return negative and we
1095  * are allowed to call i9e_close() and terminate as well.
1096  */
1097 static int session_post_select(__a_unused struct sched *s, struct play_task *pt)
1098 {
1099         int ret;
1100
1101         if (pt->background)
1102                 detach_stdout(pt);
1103         else
1104                 attach_stdout(pt, __FUNCTION__);
1105         ret = i9e_get_error();
1106         if (ret < 0) {
1107                 kill_stream(pt);
1108                 i9e_close();
1109                 para_log = stderr_log;
1110                 free(ici.history_file);
1111                 return ret;
1112         }
1113         if (get_playback_state(pt) == 'X')
1114                 i9e_signal_dispatch(SIGTERM);
1115         return 0;
1116 }
1117
1118 #else /* HAVE_READLINE */
1119
1120 static int session_post_select(struct sched *s, struct play_task *pt)
1121 {
1122         char c;
1123
1124         if (!FD_ISSET(STDIN_FILENO, &s->rfds))
1125                 return 0;
1126         if (read(STDIN_FILENO, &c, 1))
1127                 do_nothing;
1128         kill_stream(pt);
1129         return 1;
1130 }
1131
1132 static void session_open(__a_unused struct play_task *pt)
1133 {
1134 }
1135
1136 static void session_update_time_string(__a_unused struct play_task *pt,
1137                 char *str, __a_unused unsigned len)
1138 {
1139         printf("\r%s     ", str);
1140         fflush(stdout);
1141 }
1142 #endif /* HAVE_READLINE */
1143
1144 static void play_pre_select(struct sched *s, void *context)
1145 {
1146         struct play_task *pt = context;
1147         char state;
1148
1149         para_fd_set(STDIN_FILENO, &s->rfds, &s->max_fileno);
1150         state = get_playback_state(pt);
1151         if (state == 'R' || state == 'F' || state == 'X')
1152                 return sched_min_delay(s);
1153         sched_request_barrier_or_min_delay(&pt->next_update, s);
1154 }
1155
1156 static unsigned get_time_string(struct play_task *pt, char **result)
1157 {
1158         int seconds, length;
1159         char state = get_playback_state(pt);
1160
1161         /* do not return anything if things are about to change */
1162         if (state != 'P' && state != 'U') {
1163                 *result = NULL;
1164                 return 0;
1165         }
1166         length = pt->seconds;
1167         if (length == 0)
1168                 return xasprintf(result, "0:00 [0:00] (0%%/0:00)");
1169         seconds = get_play_time(pt);
1170         return xasprintf(result, "#%u: %d:%02d [%d:%02d] (%d%%/%d:%02d) %s",
1171                 pt->current_file,
1172                 seconds / 60,
1173                 seconds % 60,
1174                 (length - seconds) / 60,
1175                 (length - seconds) % 60,
1176                 length? (seconds * 100 + length / 2) / length : 0,
1177                 length / 60,
1178                 length % 60,
1179                 conf.inputs[pt->current_file]
1180         );
1181 }
1182
1183 static int play_post_select(struct sched *s, void *context)
1184 {
1185         struct play_task *pt = context;
1186         int ret;
1187
1188         ret = eof_cleanup(pt);
1189         if (ret < 0) {
1190                 pt->rq = CRT_TERM_RQ;
1191                 return 0;
1192         }
1193         ret = session_post_select(s, pt);
1194         if (ret < 0)
1195                 goto out;
1196         if (!pt->wn.btrn && !pt->fn.btrn) {
1197                 char state = get_playback_state(pt);
1198                 if (state == 'P' || state == 'R' || state == 'F') {
1199                         PARA_NOTICE_LOG("state: %c\n", state);
1200                         ret = load_next_file(pt);
1201                         if (ret < 0) {
1202                                 PARA_ERROR_LOG("%s\n", para_strerror(-ret));
1203                                 pt->rq = CRT_TERM_RQ;
1204                                 ret = 1;
1205                                 goto out;
1206                         }
1207                         pt->next_update = *now;
1208                 }
1209         }
1210         if (tv_diff(now, &pt->next_update, NULL) >= 0) {
1211                 char *str;
1212                 unsigned len = get_time_string(pt, &str);
1213                 struct timeval delay = {.tv_sec = 0, .tv_usec = 100 * 1000};
1214                 if (str && len > 0)
1215                         session_update_time_string(pt, str, len);
1216                 free(str);
1217                 tv_add(now, &delay, &pt->next_update);
1218         }
1219         ret = 1;
1220 out:
1221         return ret;
1222 }
1223
1224 /**
1225  * The main function of para_play.
1226  *
1227  * \param argc Standard.
1228  * \param argv Standard.
1229  *
1230  * \return \p EXIT_FAILURE or \p EXIT_SUCCESS.
1231  */
1232 int main(int argc, char *argv[])
1233 {
1234         int ret;
1235         struct play_task *pt = &play_task;
1236
1237         /* needed this early to make help work */
1238         recv_init();
1239         filter_init();
1240         writer_init();
1241
1242         sched.default_timeout.tv_sec = 5;
1243
1244         parse_config_or_die(argc, argv);
1245         if (conf.inputs_num == 0)
1246                 print_help_and_die();
1247         check_afh_receiver_or_die();
1248
1249         session_open(pt);
1250         if (conf.randomize_given)
1251                 shuffle(conf.inputs, conf.inputs_num);
1252         pt->invalid = para_calloc(sizeof(*pt->invalid) * conf.inputs_num);
1253         pt->rq = CRT_FILE_CHANGE;
1254         pt->current_file = conf.inputs_num - 1;
1255         pt->playing = true;
1256         pt->task = task_register(&(struct task_info){
1257                 .name = "play",
1258                 .pre_select = play_pre_select,
1259                 .post_select = play_post_select,
1260                 .context = pt,
1261         }, &sched);
1262         ret = schedule(&sched);
1263         sched_shutdown(&sched);
1264         if (ret < 0)
1265                 PARA_ERROR_LOG("%s\n", para_strerror(-ret));
1266         return ret < 0? EXIT_FAILURE : EXIT_SUCCESS;
1267 }