src/screen.c

   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  */
  19
  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"
  43
  44 #include <mpd/client.h>
  45
  46 #include <stdlib.h>
  47 #include <unistd.h>
  48 #include <string.h>
  49 #include <time.h>
  50 #include <locale.h>
  51
  52 #ifndef NCMPC_MINI
  53 /** welcome message time [s] */
  54 static const GTime SCREEN_WELCOME_TIME = 10;
  55 #endif
  56
  57 /* minimum window size */
  58 static const int SCREEN_MIN_COLS = 14;
  59 static const int SCREEN_MIN_ROWS = 5;
  60
  61 /* screens */
  62
  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;
  66
  67 gboolean
  68 screen_is_visible(const struct screen_functions *sf)
  69 {
  70         return sf == mode_fn;
  71 }
  72
  73 void
  74 screen_switch(const struct screen_functions *sf, struct mpdclient *c)
  75 {
  76         assert(sf != NULL);
  77
  78         if (sf == mode_fn)
  79                 return;
  80
  81         mode_fn_prev = mode_fn;
  82
  83         /* close the old mode */
  84         if (mode_fn->close != NULL)
  85                 mode_fn->close();
  86
  87         /* get functions for the new mode */
  88         mode_fn = sf;
  89
  90         /* open the new mode */
  91         if (mode_fn->open != NULL)
  92                 mode_fn->open(c);
  93
  94         screen_paint(c);
  95 }
  96
  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 }
 118
 119 static int
 120 find_configured_screen(const char *name)
 121 {
 122         unsigned i;
 123
 124         for (i = 0; options.screen_list[i] != NULL; ++i)
 125                 if (strcmp(options.screen_list[i], name) == 0)
 126                         return i;
 127
 128         return -1;
 129 }
 130
 131 static void
 132 screen_next_mode(struct mpdclient *c, int offset)
 133 {
 134         int max = g_strv_length(options.screen_list);
 135
 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;
 143
 144         const struct screen_functions *sf =
 145                 screen_lookup_name(options.screen_list[next]);
 146         if (sf != NULL)
 147                 screen_switch(sf, c);
 148 }
 149
 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 }
 155
 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);
 166
 167         unsigned duration = mpdclient_is_playing(c)
 168                 ? mpd_status_get_total_time(c->status)
 169                 : 0;
 170
 171         if (progress_bar_set(&screen.progress_bar, elapsed, duration) ||
 172             repaint)
 173                 progress_bar_paint(&screen.progress_bar);
 174 }
 175
 176 void
 177 screen_exit(void)
 178 {
 179         if (mode_fn->close != NULL)
 180                 mode_fn->close();
 181
 182         screen_list_exit();
 183
 184         string_list_free(screen.find_history);
 185         g_free(screen.buf);
 186         g_free(screen.findbuf);
 187
 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);
 192
 193 #ifndef NCMPC_MINI
 194         if (screen.welcome_source_id != 0)
 195                 g_source_remove(screen.welcome_source_id);
 196 #endif
 197 }
 198
 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
 212
 213         screen.cols = COLS;
 214         screen.rows = LINES;
 215
 216         title_bar_resize(&screen.title_bar, screen.cols);
 217
 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
 223         /* progress window */
 224         progress_bar_resize(&screen.progress_bar, screen.cols,
 225                             screen.rows - 2, 0);
 226
 227         /* status window */
 228         status_bar_resize(&screen.status_bar, screen.cols, screen.rows - 1, 0);
 229
 230         screen.buf_size = screen.cols;
 231         g_free(screen.buf);
 232         screen.buf = g_malloc(screen.cols);
 233
 234         /* resize all screens */
 235         screen_list_resize(screen.main_window.cols, screen.main_window.rows);
 236
 237         /* ? - without this the cursor becomes visible with aterm & Eterm */
 238         curs_set(1);
 239         curs_set(0);
 240
 241         screen_paint(c);
 242 }
 243
 244 #ifndef NCMPC_MINI
 245 static gboolean
 246 welcome_timer_callback(gpointer data)
 247 {
 248         struct mpdclient *c = data;
 249
 250 #ifndef NCMPC_MINI
 251         screen.welcome_source_id = 0;
 252 #endif
 253
 254         paint_top_window(mode_fn->get_title != NULL
 255                          ? mode_fn->get_title(screen.buf, screen.buf_size)
 256                          : "",
 257                          c);
 258         doupdate();
 259
 260         return false;
 261 }
 262 #endif
 263
 264 void
 265 screen_init(struct mpdclient *c)
 266 {
 267         if (COLS < SCREEN_MIN_COLS || LINES < SCREEN_MIN_ROWS) {
 268                 fprintf(stderr, "%s\n", _("Error: Screen too small"));
 269                 exit(EXIT_FAILURE);
 270         }
 271
 272         screen.cols = COLS;
 273         screen.rows = LINES;
 274
 275         screen.buf  = g_malloc(screen.cols);
 276         screen.buf_size = screen.cols;
 277         screen.findbuf = NULL;
 278
 279 #ifndef NCMPC_MINI
 280         if (options.welcome_screen_list)
 281                 screen.welcome_source_id =
 282                         g_timeout_add(SCREEN_WELCOME_TIME * 1000,
 283                                       welcome_timer_callback, c);
 284 #endif
 285
 286         /* create top window */
 287         title_bar_init(&screen.title_bar, screen.cols, 0, 0);
 288
 289         /* create main window */
 290         window_init(&screen.main_window, screen.rows - 4, screen.cols, 2, 0);
 291
 292         if (!options.hardware_cursor)
 293                 leaveok(screen.main_window.w, TRUE);
 294
 295         keypad(screen.main_window.w, TRUE);
 296
 297         /* create progress window */
 298         progress_bar_init(&screen.progress_bar, screen.cols,
 299                           screen.rows - 2, 0);
 300
 301         /* create status window */
 302         status_bar_init(&screen.status_bar, screen.cols, screen.rows - 1, 0);
 303
 304 #ifdef ENABLE_COLORS
 305         if (options.enable_colors) {
 306                 /* set background attributes */
 307                 wbkgd(stdscr, COLOR_PAIR(COLOR_LIST));
 308                 wbkgd(screen.main_window.w,     COLOR_PAIR(COLOR_LIST));
 309                 wbkgd(screen.title_bar.window.w, COLOR_PAIR(COLOR_TITLE));
 310                 wbkgd(screen.progress_bar.window.w,
 311                       COLOR_PAIR(COLOR_PROGRESSBAR));
 312                 wbkgd(screen.status_bar.window.w, COLOR_PAIR(COLOR_STATUS));
 313                 colors_use(screen.progress_bar.window.w, COLOR_PROGRESSBAR);
 314         }
 315 #endif
 316
 317         /* initialize screens */
 318         screen_list_init(screen.main_window.w,
 319                          screen.main_window.cols, screen.main_window.rows);
 320
 321         if (mode_fn->open != NULL)
 322                 mode_fn->open(c);
 323 }
 324
 325 static void
 326 screen_refresh(struct mpdclient *c, bool main_dirty)
 327 {
 328         /* update title/header window */
 329         const char *title =
 330 #ifndef NCMPC_MINI
 331                 screen.welcome_source_id == 0 &&
 332 #endif
 333                 mode_fn->get_title != NULL
 334                 ? mode_fn->get_title(screen.buf, screen.buf_size)
 335                 : "";
 336         assert(title != NULL);
 337         paint_top_window(title, c);
 338
 339         /* paint the bottom window */
 340
 341         update_progress_window(c, true);
 342         status_bar_paint(&screen.status_bar, c->status, c->song);
 343
 344         /* paint the main window */
 345
 346         if (main_dirty) {
 347                 wclear(screen.main_window.w);
 348                 if (mode_fn->paint != NULL)
 349                         mode_fn->paint();
 350         }
 351
 352         /* move the cursor to the origin */
 353
 354         if (!options.hardware_cursor)
 355                 wmove(screen.main_window.w, 0, 0);
 356
 357         wnoutrefresh(screen.main_window.w);
 358
 359         /* tell curses to update */
 360         doupdate();
 361 }
 362
 363 void
 364 screen_paint(struct mpdclient *c)
 365 {
 366         screen_refresh(c, true);
 367 }
 368
 369 void
 370 screen_update(struct mpdclient *c)
 371 {
 372 #ifndef NCMPC_MINI
 373         static bool was_connected;
 374         static bool initialized = false;
 375         static bool repeat;
 376         static bool random_enabled;
 377         static bool single;
 378         static bool consume;
 379         static unsigned crossfade;
 380
 381         /* print a message if mpd status has changed */
 382         if ((c->events & MPD_IDLE_OPTIONS) && c->status != NULL) {
 383                 if (!initialized) {
 384                         repeat = mpd_status_get_repeat(c->status);
 385                         random_enabled = mpd_status_get_random(c->status);
 386                         single = mpd_status_get_single(c->status);
 387                         consume = mpd_status_get_consume(c->status);
 388                         crossfade = mpd_status_get_crossfade(c->status);
 389                         initialized = true;
 390                 }
 391
 392                 if (repeat != mpd_status_get_repeat(c->status))
 393                         screen_status_printf(mpd_status_get_repeat(c->status) ?
 394                                              _("Repeat mode is on") :
 395                                              _("Repeat mode is off"));
 396
 397                 if (random_enabled != mpd_status_get_random(c->status))
 398                         screen_status_printf(mpd_status_get_random(c->status) ?
 399                                              _("Random mode is on") :
 400                                              _("Random mode is off"));
 401
 402                 if (single != mpd_status_get_single(c->status))
 403                         screen_status_printf(mpd_status_get_single(c->status) ?
 404                                              /* "single" mode means
 405                                                 that MPD will
 406                                                 automatically stop
 407                                                 after playing one
 408                                                 single song */
 409                                              _("Single mode is on") :
 410                                              _("Single mode is off"));
 411
 412                 if (consume != mpd_status_get_consume(c->status))
 413                         screen_status_printf(mpd_status_get_consume(c->status) ?
 414                                              /* "consume" mode means
 415                                                 that MPD removes each
 416                                                 song which has
 417                                                 finished playing */
 418                                              _("Consume mode is on") :
 419                                              _("Consume mode is off"));
 420
 421                 if (crossfade != mpd_status_get_crossfade(c->status))
 422                         screen_status_printf(_("Crossfade %d seconds"),
 423                                              mpd_status_get_crossfade(c->status));
 424
 425                 repeat = mpd_status_get_repeat(c->status);
 426                 random_enabled = mpd_status_get_random(c->status);
 427                 single = mpd_status_get_single(c->status);
 428                 consume = mpd_status_get_consume(c->status);
 429                 crossfade = mpd_status_get_crossfade(c->status);
 430         }
 431
 432         if ((c->events & MPD_IDLE_DATABASE) != 0 && was_connected &&
 433             mpdclient_is_connected(c))
 434                 screen_status_printf(_("Database updated"));
 435         was_connected = mpdclient_is_connected(c);
 436 #endif
 437
 438         /* update the main window */
 439         if (mode_fn->update != NULL)
 440                 mode_fn->update(c);
 441
 442         screen_refresh(c, false);
 443 }
 444
 445 #ifdef HAVE_GETMOUSE
 446 int
 447 screen_get_mouse_event(struct mpdclient *c, unsigned long *bstate, int *row)
 448 {
 449         MEVENT event;
 450
 451         /* retrieve the mouse event from curses */
 452 #ifdef PDCURSES
 453         nc_getmouse(&event);
 454 #else
 455         getmouse(&event);
 456 #endif
 457         /* calculate the selected row in the list window */
 458         *row = event.y - screen.title_bar.window.rows;
 459         /* copy button state bits */
 460         *bstate = event.bstate;
 461         /* if button 2 was pressed switch screen */
 462         if (event.bstate & BUTTON2_CLICKED) {
 463                 screen_cmd(c, CMD_SCREEN_NEXT);
 464                 return 1;
 465         }
 466
 467         return 0;
 468 }
 469 #endif
 470
 471 void
 472 screen_cmd(struct mpdclient *c, command_t cmd)
 473 {
 474 #ifndef NCMPC_MINI
 475         if (screen.welcome_source_id != 0) {
 476                 g_source_remove(screen.welcome_source_id);
 477                 screen.welcome_source_id = 0;
 478         }
 479 #endif
 480
 481         if (mode_fn->cmd != NULL && mode_fn->cmd(c, cmd))
 482                 return;
 483
 484         if (handle_player_command(c, cmd))
 485                 return;
 486
 487         switch(cmd) {
 488         case CMD_TOGGLE_FIND_WRAP:
 489                 options.find_wrap = !options.find_wrap;
 490                 screen_status_printf(options.find_wrap ?
 491                                      _("Find mode: Wrapped") :
 492                                      _("Find mode: Normal"));
 493                 break;
 494         case CMD_TOGGLE_AUTOCENTER:
 495                 options.auto_center = !options.auto_center;
 496                 screen_status_printf(options.auto_center ?
 497                                      _("Auto center mode: On") :
 498                                      _("Auto center mode: Off"));
 499                 break;
 500         case CMD_SCREEN_UPDATE:
 501                 screen_paint(c);
 502                 break;
 503         case CMD_SCREEN_PREVIOUS:
 504                 screen_next_mode(c, -1);
 505                 break;
 506         case CMD_SCREEN_NEXT:
 507                 screen_next_mode(c, 1);
 508                 break;
 509         case CMD_SCREEN_PLAY:
 510                 screen_switch(&screen_queue, c);
 511                 break;
 512         case CMD_SCREEN_FILE:
 513                 screen_switch(&screen_browse, c);
 514                 break;
 515 #ifdef ENABLE_HELP_SCREEN
 516         case CMD_SCREEN_HELP:
 517                 screen_switch(&screen_help, c);
 518                 break;
 519 #endif
 520 #ifdef ENABLE_SEARCH_SCREEN
 521         case CMD_SCREEN_SEARCH:
 522                 screen_switch(&screen_search, c);
 523                 break;
 524 #endif
 525 #ifdef ENABLE_ARTIST_SCREEN
 526         case CMD_SCREEN_ARTIST:
 527                 screen_switch(&screen_artist, c);
 528                 break;
 529 #endif
 530 #ifdef ENABLE_SONG_SCREEN
 531         case CMD_SCREEN_SONG:
 532                 screen_switch(&screen_song, c);
 533                 break;
 534 #endif
 535 #ifdef ENABLE_KEYDEF_SCREEN
 536         case CMD_SCREEN_KEYDEF:
 537                 screen_switch(&screen_keydef, c);
 538                 break;
 539 #endif
 540 #ifdef ENABLE_LYRICS_SCREEN
 541         case CMD_SCREEN_LYRICS:
 542                 screen_switch(&screen_lyrics, c);
 543                 break;
 544 #endif
 545 #ifdef ENABLE_OUTPUTS_SCREEN
 546         case CMD_SCREEN_OUTPUTS:
 547                 screen_switch(&screen_outputs, c);
 548                 break;
 549 #endif
 550 #ifdef ENABLE_CHAT_SCREEN
 551         case CMD_SCREEN_CHAT:
 552                 screen_switch(&screen_chat, c);
 553                 break;
 554 #endif
 555         case CMD_SCREEN_SWAP:
 556                 screen_swap(c, NULL);
 557                 break;
 558
 559         default:
 560                 break;
 561         }
 562 }