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 struct mpdclient *c)
 152 {
 153         const char *title =
 154 #ifndef NCMPC_MINI
 155                 screen.welcome_source_id == 0 &&
 156 #endif
 157                 mode_fn->get_title != NULL
 158                 ? mode_fn->get_title(screen.buf, screen.buf_size)
 159                 : "";
 160         assert(title != NULL);
 161
 162         title_bar_paint(&screen.title_bar, title, c->status);
 163 }
 164
 165 static void
 166 update_progress_window(struct mpdclient *c, bool repaint)
 167 {
 168         unsigned elapsed;
 169         if (c->status == NULL)
 170                 elapsed = 0;
 171         else if (seek_id >= 0 && seek_id == mpd_status_get_song_id(c->status))
 172                 elapsed = seek_target_time;
 173         else
 174                 elapsed = mpd_status_get_elapsed_time(c->status);
 175
 176         unsigned duration = mpdclient_is_playing(c)
 177                 ? mpd_status_get_total_time(c->status)
 178                 : 0;
 179
 180         if (progress_bar_set(&screen.progress_bar, elapsed, duration) ||
 181             repaint)
 182                 progress_bar_paint(&screen.progress_bar);
 183 }
 184
 185 void
 186 screen_exit(void)
 187 {
 188         if (mode_fn->close != NULL)
 189                 mode_fn->close();
 190
 191         screen_list_exit();
 192
 193         string_list_free(screen.find_history);
 194         g_free(screen.buf);
 195         g_free(screen.findbuf);
 196
 197         title_bar_deinit(&screen.title_bar);
 198         delwin(screen.main_window.w);
 199         progress_bar_deinit(&screen.progress_bar);
 200         status_bar_deinit(&screen.status_bar);
 201
 202 #ifndef NCMPC_MINI
 203         if (screen.welcome_source_id != 0)
 204                 g_source_remove(screen.welcome_source_id);
 205 #endif
 206 }
 207
 208 void
 209 screen_resize(struct mpdclient *c)
 210 {
 211         if (COLS<SCREEN_MIN_COLS || LINES<SCREEN_MIN_ROWS) {
 212                 screen_exit();
 213                 fprintf(stderr, "%s\n", _("Error: Screen too small"));
 214                 exit(EXIT_FAILURE);
 215         }
 216 #ifdef PDCURSES
 217         resize_term(LINES, COLS);
 218 #else
 219         resizeterm(LINES, COLS);
 220 #endif
 221
 222         screen.cols = COLS;
 223         screen.rows = LINES;
 224
 225         title_bar_resize(&screen.title_bar, screen.cols);
 226
 227         /* main window */
 228         screen.main_window.cols = screen.cols;
 229         screen.main_window.rows = screen.rows-4;
 230         wresize(screen.main_window.w, screen.main_window.rows, screen.cols);
 231
 232         /* progress window */
 233         progress_bar_resize(&screen.progress_bar, screen.cols,
 234                             screen.rows - 2, 0);
 235
 236         /* status window */
 237         status_bar_resize(&screen.status_bar, screen.cols, screen.rows - 1, 0);
 238
 239         screen.buf_size = screen.cols;
 240         g_free(screen.buf);
 241         screen.buf = g_malloc(screen.cols);
 242
 243         /* resize all screens */
 244         screen_list_resize(screen.main_window.cols, screen.main_window.rows);
 245
 246         /* ? - without this the cursor becomes visible with aterm & Eterm */
 247         curs_set(1);
 248         curs_set(0);
 249
 250         screen_paint(c);
 251 }
 252
 253 #ifndef NCMPC_MINI
 254 static gboolean
 255 welcome_timer_callback(gpointer data)
 256 {
 257         struct mpdclient *c = data;
 258
 259         screen.welcome_source_id = 0;
 260
 261         paint_top_window(c);
 262         doupdate();
 263
 264         return false;
 265 }
 266 #endif
 267
 268 void
 269 screen_init(struct mpdclient *c)
 270 {
 271         if (COLS < SCREEN_MIN_COLS || LINES < SCREEN_MIN_ROWS) {
 272                 fprintf(stderr, "%s\n", _("Error: Screen too small"));
 273                 exit(EXIT_FAILURE);
 274         }
 275
 276         screen.cols = COLS;
 277         screen.rows = LINES;
 278
 279         screen.buf  = g_malloc(screen.cols);
 280         screen.buf_size = screen.cols;
 281         screen.findbuf = NULL;
 282
 283 #ifndef NCMPC_MINI
 284         if (options.welcome_screen_list)
 285                 screen.welcome_source_id =
 286                         g_timeout_add_seconds(SCREEN_WELCOME_TIME,
 287                                               welcome_timer_callback, c);
 288 #endif
 289
 290         /* create top window */
 291         title_bar_init(&screen.title_bar, screen.cols, 0, 0);
 292
 293         /* create main window */
 294         window_init(&screen.main_window, screen.rows - 4, screen.cols, 2, 0);
 295
 296         if (!options.hardware_cursor)
 297                 leaveok(screen.main_window.w, TRUE);
 298
 299         keypad(screen.main_window.w, TRUE);
 300
 301         /* create progress window */
 302         progress_bar_init(&screen.progress_bar, screen.cols,
 303                           screen.rows - 2, 0);
 304
 305         /* create status window */
 306         status_bar_init(&screen.status_bar, screen.cols, screen.rows - 1, 0);
 307
 308 #ifdef ENABLE_COLORS
 309         if (options.enable_colors) {
 310                 /* set background attributes */
 311                 wbkgd(stdscr, COLOR_PAIR(COLOR_LIST));
 312                 wbkgd(screen.main_window.w,     COLOR_PAIR(COLOR_LIST));
 313                 wbkgd(screen.title_bar.window.w, COLOR_PAIR(COLOR_TITLE));
 314                 wbkgd(screen.progress_bar.window.w,
 315                       COLOR_PAIR(COLOR_PROGRESSBAR));
 316                 wbkgd(screen.status_bar.window.w, COLOR_PAIR(COLOR_STATUS));
 317                 colors_use(screen.progress_bar.window.w, COLOR_PROGRESSBAR);
 318         }
 319 #endif
 320
 321         /* initialize screens */
 322         screen_list_init(screen.main_window.w,
 323                          screen.main_window.cols, screen.main_window.rows);
 324
 325         if (mode_fn->open != NULL)
 326                 mode_fn->open(c);
 327 }
 328
 329 static void
 330 screen_refresh(struct mpdclient *c, bool main_dirty)
 331 {
 332         /* update title/header window */
 333         paint_top_window(c);
 334
 335         /* paint the bottom window */
 336
 337         update_progress_window(c, true);
 338         status_bar_paint(&screen.status_bar, c->status, c->song);
 339
 340         /* paint the main window */
 341
 342         if (main_dirty) {
 343                 wclear(screen.main_window.w);
 344                 if (mode_fn->paint != NULL)
 345                         mode_fn->paint();
 346         }
 347
 348         /* move the cursor to the origin */
 349
 350         if (!options.hardware_cursor)
 351                 wmove(screen.main_window.w, 0, 0);
 352
 353         wnoutrefresh(screen.main_window.w);
 354
 355         /* tell curses to update */
 356         doupdate();
 357 }
 358
 359 void
 360 screen_paint(struct mpdclient *c)
 361 {
 362         screen_refresh(c, true);
 363 }
 364
 365 void
 366 screen_update(struct mpdclient *c)
 367 {
 368 #ifndef NCMPC_MINI
 369         static bool was_connected;
 370         static bool initialized = false;
 371         static bool repeat;
 372         static bool random_enabled;
 373         static bool single;
 374         static bool consume;
 375         static unsigned crossfade;
 376
 377         /* print a message if mpd status has changed */
 378         if ((c->events & MPD_IDLE_OPTIONS) && c->status != NULL) {
 379                 if (!initialized) {
 380                         repeat = mpd_status_get_repeat(c->status);
 381                         random_enabled = mpd_status_get_random(c->status);
 382                         single = mpd_status_get_single(c->status);
 383                         consume = mpd_status_get_consume(c->status);
 384                         crossfade = mpd_status_get_crossfade(c->status);
 385                         initialized = true;
 386                 }
 387
 388                 if (repeat != mpd_status_get_repeat(c->status))
 389                         screen_status_printf(mpd_status_get_repeat(c->status) ?
 390                                              _("Repeat mode is on") :
 391                                              _("Repeat mode is off"));
 392
 393                 if (random_enabled != mpd_status_get_random(c->status))
 394                         screen_status_printf(mpd_status_get_random(c->status) ?
 395                                              _("Random mode is on") :
 396                                              _("Random mode is off"));
 397
 398                 if (single != mpd_status_get_single(c->status))
 399                         screen_status_printf(mpd_status_get_single(c->status) ?
 400                                              /* "single" mode means
 401                                                 that MPD will
 402                                                 automatically stop
 403                                                 after playing one
 404                                                 single song */
 405                                              _("Single mode is on") :
 406                                              _("Single mode is off"));
 407
 408                 if (consume != mpd_status_get_consume(c->status))
 409                         screen_status_printf(mpd_status_get_consume(c->status) ?
 410                                              /* "consume" mode means
 411                                                 that MPD removes each
 412                                                 song which has
 413                                                 finished playing */
 414                                              _("Consume mode is on") :
 415                                              _("Consume mode is off"));
 416
 417                 if (crossfade != mpd_status_get_crossfade(c->status))
 418                         screen_status_printf(_("Crossfade %d seconds"),
 419                                              mpd_status_get_crossfade(c->status));
 420
 421                 repeat = mpd_status_get_repeat(c->status);
 422                 random_enabled = mpd_status_get_random(c->status);
 423                 single = mpd_status_get_single(c->status);
 424                 consume = mpd_status_get_consume(c->status);
 425                 crossfade = mpd_status_get_crossfade(c->status);
 426         }
 427
 428         if ((c->events & MPD_IDLE_DATABASE) != 0 && was_connected &&
 429             mpdclient_is_connected(c))
 430                 screen_status_printf(_("Database updated"));
 431         was_connected = mpdclient_is_connected(c);
 432 #endif
 433
 434         /* update the main window */
 435         if (mode_fn->update != NULL)
 436                 mode_fn->update(c);
 437
 438         screen_refresh(c, false);
 439 }
 440
 441 #ifdef HAVE_GETMOUSE
 442 int
 443 screen_get_mouse_event(struct mpdclient *c, unsigned long *bstate, int *row)
 444 {
 445         MEVENT event;
 446
 447         /* retrieve the mouse event from curses */
 448 #ifdef PDCURSES
 449         nc_getmouse(&event);
 450 #else
 451         getmouse(&event);
 452 #endif
 453         /* calculate the selected row in the list window */
 454         *row = event.y - screen.title_bar.window.rows;
 455         /* copy button state bits */
 456         *bstate = event.bstate;
 457         /* if button 2 was pressed switch screen */
 458         if (event.bstate & BUTTON2_CLICKED) {
 459                 screen_cmd(c, CMD_SCREEN_NEXT);
 460                 return 1;
 461         }
 462
 463         return 0;
 464 }
 465 #endif
 466
 467 void
 468 screen_cmd(struct mpdclient *c, command_t cmd)
 469 {
 470 #ifndef NCMPC_MINI
 471         if (screen.welcome_source_id != 0) {
 472                 g_source_remove(screen.welcome_source_id);
 473                 screen.welcome_source_id = 0;
 474         }
 475 #endif
 476
 477         if (mode_fn->cmd != NULL && mode_fn->cmd(c, cmd))
 478                 return;
 479
 480         if (handle_player_command(c, cmd))
 481                 return;
 482
 483         switch(cmd) {
 484         case CMD_TOGGLE_FIND_WRAP:
 485                 options.find_wrap = !options.find_wrap;
 486                 screen_status_printf(options.find_wrap ?
 487                                      _("Find mode: Wrapped") :
 488                                      _("Find mode: Normal"));
 489                 break;
 490         case CMD_TOGGLE_AUTOCENTER:
 491                 options.auto_center = !options.auto_center;
 492                 screen_status_printf(options.auto_center ?
 493                                      _("Auto center mode: On") :
 494                                      _("Auto center mode: Off"));
 495                 break;
 496         case CMD_SCREEN_UPDATE:
 497                 screen_paint(c);
 498                 break;
 499         case CMD_SCREEN_PREVIOUS:
 500                 screen_next_mode(c, -1);
 501                 break;
 502         case CMD_SCREEN_NEXT:
 503                 screen_next_mode(c, 1);
 504                 break;
 505         case CMD_SCREEN_PLAY:
 506                 screen_switch(&screen_queue, c);
 507                 break;
 508         case CMD_SCREEN_FILE:
 509                 screen_switch(&screen_browse, c);
 510                 break;
 511 #ifdef ENABLE_HELP_SCREEN
 512         case CMD_SCREEN_HELP:
 513                 screen_switch(&screen_help, c);
 514                 break;
 515 #endif
 516 #ifdef ENABLE_SEARCH_SCREEN
 517         case CMD_SCREEN_SEARCH:
 518                 screen_switch(&screen_search, c);
 519                 break;
 520 #endif
 521 #ifdef ENABLE_ARTIST_SCREEN
 522         case CMD_SCREEN_ARTIST:
 523                 screen_switch(&screen_artist, c);
 524                 break;
 525 #endif
 526 #ifdef ENABLE_SONG_SCREEN
 527         case CMD_SCREEN_SONG:
 528                 screen_switch(&screen_song, c);
 529                 break;
 530 #endif
 531 #ifdef ENABLE_KEYDEF_SCREEN
 532         case CMD_SCREEN_KEYDEF:
 533                 screen_switch(&screen_keydef, c);
 534                 break;
 535 #endif
 536 #ifdef ENABLE_LYRICS_SCREEN
 537         case CMD_SCREEN_LYRICS:
 538                 screen_switch(&screen_lyrics, c);
 539                 break;
 540 #endif
 541 #ifdef ENABLE_OUTPUTS_SCREEN
 542         case CMD_SCREEN_OUTPUTS:
 543                 screen_switch(&screen_outputs, c);
 544                 break;
 545 #endif
 546 #ifdef ENABLE_CHAT_SCREEN
 547         case CMD_SCREEN_CHAT:
 548                 screen_switch(&screen_chat, c);
 549                 break;
 550 #endif
 551         case CMD_SCREEN_SWAP:
 552                 screen_swap(c, NULL);
 553                 break;
 554
 555         default:
 556                 break;
 557         }
 558 }