1 /* ncmpc (Ncurses MPD Client)
2 * (c) 2004-2017 The Music Player Daemon Project
3 * Project homepage: http://musicpd.org
4 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
18 */
20 #include "screen.h"
21 #include "screen_interface.h"
22 #include "screen_list.h"
23 #include "screen_utils.h"
24 #include "screen_status.h"
25 #include "config.h"
26 #include "i18n.h"
27 #include "charset.h"
28 #include "mpdclient.h"
29 #include "utils.h"
30 #include "options.h"
31 #include "colors.h"
32 #include "player_command.h"
33 #include "screen_help.h"
34 #include "screen_queue.h"
35 #include "screen_file.h"
36 #include "screen_artist.h"
37 #include "screen_search.h"
38 #include "screen_song.h"
39 #include "screen_keydef.h"
40 #include "screen_lyrics.h"
41 #include "screen_outputs.h"
42 #include "screen_chat.h"
44 #include <mpd/client.h>
46 #include <stdlib.h>
47 #include <unistd.h>
48 #include <string.h>
49 #include <time.h>
50 #include <locale.h>
52 #ifndef NCMPC_MINI
53 /** welcome message time [s] */
54 static const GTime SCREEN_WELCOME_TIME = 10;
55 #endif
57 /* minimum window size */
58 static const int SCREEN_MIN_COLS = 14;
59 static const int SCREEN_MIN_ROWS = 5;
61 /* screens */
63 struct screen screen;
64 static const struct screen_functions *mode_fn = &screen_queue;
65 static const struct screen_functions *mode_fn_prev = &screen_queue;
67 gboolean
68 screen_is_visible(const struct screen_functions *sf)
69 {
70 return sf == mode_fn;
71 }
73 void
74 screen_switch(const struct screen_functions *sf, struct mpdclient *c)
75 {
76 assert(sf != NULL);
78 if (sf == mode_fn)
79 return;
81 mode_fn_prev = mode_fn;
83 /* close the old mode */
84 if (mode_fn->close != NULL)
85 mode_fn->close();
87 /* get functions for the new mode */
88 mode_fn = sf;
90 /* open the new mode */
91 if (mode_fn->open != NULL)
92 mode_fn->open(c);
94 screen_paint(c);
95 }
97 void
98 screen_swap(struct mpdclient *c, const struct mpd_song *song)
99 {
100 if (song != NULL)
101 {
102 if (false)
103 { /* just a hack to make the ifdefs less ugly */ }
104 #ifdef ENABLE_SONG_SCREEN
105 if (mode_fn_prev == &screen_song)
106 screen_song_switch(c, song);
107 #endif
108 #ifdef ENABLE_LYRICS_SCREEN
109 else if (mode_fn_prev == &screen_lyrics)
110 screen_lyrics_switch(c, song, true);
111 #endif
112 else
113 screen_switch(mode_fn_prev, c);
114 }
115 else
116 screen_switch(mode_fn_prev, c);
117 }
119 static int
120 find_configured_screen(const char *name)
121 {
122 unsigned i;
124 for (i = 0; options.screen_list[i] != NULL; ++i)
125 if (strcmp(options.screen_list[i], name) == 0)
126 return i;
128 return -1;
129 }
131 static void
132 screen_next_mode(struct mpdclient *c, int offset)
133 {
134 int max = g_strv_length(options.screen_list);
136 /* find current screen */
137 int current = find_configured_screen(screen_get_name(mode_fn));
138 int next = current + offset;
139 if (next<0)
140 next = max-1;
141 else if (next>=max)
142 next = 0;
144 const struct screen_functions *sf =
145 screen_lookup_name(options.screen_list[next]);
146 if (sf != NULL)
147 screen_switch(sf, c);
148 }
150 static void
151 paint_top_window(const char *header, const struct mpdclient *c)
152 {
153 title_bar_paint(&screen.title_bar, header, c->status);
154 }
156 static void
157 update_progress_window(struct mpdclient *c, bool repaint)
158 {
159 unsigned elapsed;
160 if (c->status == NULL)
161 elapsed = 0;
162 else if (seek_id >= 0 && seek_id == mpd_status_get_song_id(c->status))
163 elapsed = seek_target_time;
164 else
165 elapsed = mpd_status_get_elapsed_time(c->status);
167 unsigned duration = mpdclient_is_playing(c)
168 ? mpd_status_get_total_time(c->status)
169 : 0;
171 if (progress_bar_set(&screen.progress_bar, elapsed, duration) ||
172 repaint)
173 progress_bar_paint(&screen.progress_bar);
174 }
176 void
177 screen_exit(void)
178 {
179 if (mode_fn->close != NULL)
180 mode_fn->close();
182 screen_list_exit();
184 string_list_free(screen.find_history);
185 g_free(screen.buf);
186 g_free(screen.findbuf);
188 title_bar_deinit(&screen.title_bar);
189 delwin(screen.main_window.w);
190 progress_bar_deinit(&screen.progress_bar);
191 status_bar_deinit(&screen.status_bar);
193 #ifndef NCMPC_MINI
194 if (screen.welcome_source_id != 0)
195 g_source_remove(screen.welcome_source_id);
196 #endif
197 }
199 void
200 screen_resize(struct mpdclient *c)
201 {
202 if (COLS<SCREEN_MIN_COLS || LINES<SCREEN_MIN_ROWS) {
203 screen_exit();
204 fprintf(stderr, "%s\n", _("Error: Screen too small"));
205 exit(EXIT_FAILURE);
206 }
207 #ifdef PDCURSES
208 resize_term(LINES, COLS);
209 #else
210 resizeterm(LINES, COLS);
211 #endif
213 screen.cols = COLS;
214 screen.rows = LINES;
216 title_bar_resize(&screen.title_bar, screen.cols);
218 /* main window */
219 screen.main_window.cols = screen.cols;
220 screen.main_window.rows = screen.rows-4;
221 wresize(screen.main_window.w, screen.main_window.rows, screen.cols);
222 wclear(screen.main_window.w);
224 /* progress window */
225 progress_bar_resize(&screen.progress_bar, screen.cols,
226 screen.rows - 2, 0);
227 progress_bar_paint(&screen.progress_bar);
229 /* status window */
230 status_bar_resize(&screen.status_bar, screen.cols, screen.rows - 1, 0);
231 status_bar_paint(&screen.status_bar, c->status, c->song);
233 screen.buf_size = screen.cols;
234 g_free(screen.buf);
235 screen.buf = g_malloc(screen.cols);
237 /* resize all screens */
238 screen_list_resize(screen.main_window.cols, screen.main_window.rows);
240 /* ? - without this the cursor becomes visible with aterm & Eterm */
241 curs_set(1);
242 curs_set(0);
244 screen_paint(c);
245 }
247 #ifndef NCMPC_MINI
248 static gboolean
249 welcome_timer_callback(gpointer data)
250 {
251 struct mpdclient *c = data;
253 #ifndef NCMPC_MINI
254 screen.welcome_source_id = 0;
255 #endif
257 paint_top_window(mode_fn->get_title != NULL
258 ? mode_fn->get_title(screen.buf, screen.buf_size)
259 : "",
260 c);
261 doupdate();
263 return false;
264 }
265 #endif
267 void
268 screen_init(struct mpdclient *c)
269 {
270 if (COLS < SCREEN_MIN_COLS || LINES < SCREEN_MIN_ROWS) {
271 fprintf(stderr, "%s\n", _("Error: Screen too small"));
272 exit(EXIT_FAILURE);
273 }
275 screen.cols = COLS;
276 screen.rows = LINES;
278 screen.buf = g_malloc(screen.cols);
279 screen.buf_size = screen.cols;
280 screen.findbuf = NULL;
282 #ifndef NCMPC_MINI
283 if (options.welcome_screen_list)
284 screen.welcome_source_id =
285 g_timeout_add(SCREEN_WELCOME_TIME * 1000,
286 welcome_timer_callback, c);
287 #endif
289 /* create top window */
290 title_bar_init(&screen.title_bar, screen.cols, 0, 0);
292 /* create main window */
293 window_init(&screen.main_window, screen.rows - 4, screen.cols, 2, 0);
295 if (!options.hardware_cursor)
296 leaveok(screen.main_window.w, TRUE);
298 keypad(screen.main_window.w, TRUE);
300 /* create progress window */
301 progress_bar_init(&screen.progress_bar, screen.cols,
302 screen.rows - 2, 0);
303 progress_bar_paint(&screen.progress_bar);
305 /* create status window */
306 status_bar_init(&screen.status_bar, screen.cols, screen.rows - 1, 0);
307 status_bar_paint(&screen.status_bar, c->status, c->song);
309 #ifdef ENABLE_COLORS
310 if (options.enable_colors) {
311 /* set background attributes */
312 wbkgd(stdscr, COLOR_PAIR(COLOR_LIST));
313 wbkgd(screen.main_window.w, COLOR_PAIR(COLOR_LIST));
314 wbkgd(screen.title_bar.window.w, COLOR_PAIR(COLOR_TITLE));
315 wbkgd(screen.progress_bar.window.w,
316 COLOR_PAIR(COLOR_PROGRESSBAR));
317 wbkgd(screen.status_bar.window.w, COLOR_PAIR(COLOR_STATUS));
318 colors_use(screen.progress_bar.window.w, COLOR_PROGRESSBAR);
319 }
320 #endif
322 /* initialize screens */
323 screen_list_init(screen.main_window.w,
324 screen.main_window.cols, screen.main_window.rows);
326 if (mode_fn->open != NULL)
327 mode_fn->open(c);
328 }
330 static void
331 screen_refresh(struct mpdclient *c, bool main_dirty)
332 {
333 /* update title/header window */
334 const char *title =
335 #ifndef NCMPC_MINI
336 screen.welcome_source_id == 0 &&
337 #endif
338 mode_fn->get_title != NULL
339 ? mode_fn->get_title(screen.buf, screen.buf_size)
340 : "";
341 assert(title != NULL);
342 paint_top_window(title, c);
344 /* paint the bottom window */
346 update_progress_window(c, true);
347 status_bar_paint(&screen.status_bar, c->status, c->song);
349 /* paint the main window */
351 if (main_dirty) {
352 wclear(screen.main_window.w);
353 if (mode_fn->paint != NULL)
354 mode_fn->paint();
355 }
357 /* move the cursor to the origin */
359 if (!options.hardware_cursor)
360 wmove(screen.main_window.w, 0, 0);
362 wnoutrefresh(screen.main_window.w);
364 /* tell curses to update */
365 doupdate();
366 }
368 void
369 screen_paint(struct mpdclient *c)
370 {
371 screen_refresh(c, true);
372 }
374 void
375 screen_update(struct mpdclient *c)
376 {
377 #ifndef NCMPC_MINI
378 static bool was_connected;
379 static bool initialized = false;
380 static bool repeat;
381 static bool random_enabled;
382 static bool single;
383 static bool consume;
384 static unsigned crossfade;
386 /* print a message if mpd status has changed */
387 if ((c->events & MPD_IDLE_OPTIONS) && c->status != NULL) {
388 if (!initialized) {
389 repeat = mpd_status_get_repeat(c->status);
390 random_enabled = mpd_status_get_random(c->status);
391 single = mpd_status_get_single(c->status);
392 consume = mpd_status_get_consume(c->status);
393 crossfade = mpd_status_get_crossfade(c->status);
394 initialized = true;
395 }
397 if (repeat != mpd_status_get_repeat(c->status))
398 screen_status_printf(mpd_status_get_repeat(c->status) ?
399 _("Repeat mode is on") :
400 _("Repeat mode is off"));
402 if (random_enabled != mpd_status_get_random(c->status))
403 screen_status_printf(mpd_status_get_random(c->status) ?
404 _("Random mode is on") :
405 _("Random mode is off"));
407 if (single != mpd_status_get_single(c->status))
408 screen_status_printf(mpd_status_get_single(c->status) ?
409 /* "single" mode means
410 that MPD will
411 automatically stop
412 after playing one
413 single song */
414 _("Single mode is on") :
415 _("Single mode is off"));
417 if (consume != mpd_status_get_consume(c->status))
418 screen_status_printf(mpd_status_get_consume(c->status) ?
419 /* "consume" mode means
420 that MPD removes each
421 song which has
422 finished playing */
423 _("Consume mode is on") :
424 _("Consume mode is off"));
426 if (crossfade != mpd_status_get_crossfade(c->status))
427 screen_status_printf(_("Crossfade %d seconds"),
428 mpd_status_get_crossfade(c->status));
430 repeat = mpd_status_get_repeat(c->status);
431 random_enabled = mpd_status_get_random(c->status);
432 single = mpd_status_get_single(c->status);
433 consume = mpd_status_get_consume(c->status);
434 crossfade = mpd_status_get_crossfade(c->status);
435 }
437 if ((c->events & MPD_IDLE_DATABASE) != 0 && was_connected &&
438 mpdclient_is_connected(c))
439 screen_status_printf(_("Database updated"));
440 was_connected = mpdclient_is_connected(c);
441 #endif
443 /* update the main window */
444 if (mode_fn->update != NULL)
445 mode_fn->update(c);
447 screen_refresh(c, false);
448 }
450 #ifdef HAVE_GETMOUSE
451 int
452 screen_get_mouse_event(struct mpdclient *c, unsigned long *bstate, int *row)
453 {
454 MEVENT event;
456 /* retrieve the mouse event from curses */
457 #ifdef PDCURSES
458 nc_getmouse(&event);
459 #else
460 getmouse(&event);
461 #endif
462 /* calculate the selected row in the list window */
463 *row = event.y - screen.title_bar.window.rows;
464 /* copy button state bits */
465 *bstate = event.bstate;
466 /* if button 2 was pressed switch screen */
467 if (event.bstate & BUTTON2_CLICKED) {
468 screen_cmd(c, CMD_SCREEN_NEXT);
469 return 1;
470 }
472 return 0;
473 }
474 #endif
476 void
477 screen_cmd(struct mpdclient *c, command_t cmd)
478 {
479 #ifndef NCMPC_MINI
480 if (screen.welcome_source_id != 0) {
481 g_source_remove(screen.welcome_source_id);
482 screen.welcome_source_id = 0;
483 }
484 #endif
486 if (mode_fn->cmd != NULL && mode_fn->cmd(c, cmd))
487 return;
489 if (handle_player_command(c, cmd))
490 return;
492 switch(cmd) {
493 case CMD_TOGGLE_FIND_WRAP:
494 options.find_wrap = !options.find_wrap;
495 screen_status_printf(options.find_wrap ?
496 _("Find mode: Wrapped") :
497 _("Find mode: Normal"));
498 break;
499 case CMD_TOGGLE_AUTOCENTER:
500 options.auto_center = !options.auto_center;
501 screen_status_printf(options.auto_center ?
502 _("Auto center mode: On") :
503 _("Auto center mode: Off"));
504 break;
505 case CMD_SCREEN_UPDATE:
506 screen_paint(c);
507 break;
508 case CMD_SCREEN_PREVIOUS:
509 screen_next_mode(c, -1);
510 break;
511 case CMD_SCREEN_NEXT:
512 screen_next_mode(c, 1);
513 break;
514 case CMD_SCREEN_PLAY:
515 screen_switch(&screen_queue, c);
516 break;
517 case CMD_SCREEN_FILE:
518 screen_switch(&screen_browse, c);
519 break;
520 #ifdef ENABLE_HELP_SCREEN
521 case CMD_SCREEN_HELP:
522 screen_switch(&screen_help, c);
523 break;
524 #endif
525 #ifdef ENABLE_SEARCH_SCREEN
526 case CMD_SCREEN_SEARCH:
527 screen_switch(&screen_search, c);
528 break;
529 #endif
530 #ifdef ENABLE_ARTIST_SCREEN
531 case CMD_SCREEN_ARTIST:
532 screen_switch(&screen_artist, c);
533 break;
534 #endif
535 #ifdef ENABLE_SONG_SCREEN
536 case CMD_SCREEN_SONG:
537 screen_switch(&screen_song, c);
538 break;
539 #endif
540 #ifdef ENABLE_KEYDEF_SCREEN
541 case CMD_SCREEN_KEYDEF:
542 screen_switch(&screen_keydef, c);
543 break;
544 #endif
545 #ifdef ENABLE_LYRICS_SCREEN
546 case CMD_SCREEN_LYRICS:
547 screen_switch(&screen_lyrics, c);
548 break;
549 #endif
550 #ifdef ENABLE_OUTPUTS_SCREEN
551 case CMD_SCREEN_OUTPUTS:
552 screen_switch(&screen_outputs, c);
553 break;
554 #endif
555 #ifdef ENABLE_CHAT_SCREEN
556 case CMD_SCREEN_CHAT:
557 screen_switch(&screen_chat, c);
558 break;
559 #endif
560 case CMD_SCREEN_SWAP:
561 screen_swap(c, NULL);
562 break;
564 default:
565 break;
566 }
567 }