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