src/screen_queue.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_queue.h"
  21 #include "screen_interface.h"
  22 #include "screen_file.h"
  23 #include "screen_status.h"
  24 #include "screen_find.h"
  25 #include "save_playlist.h"
  26 #include "config.h"
  27 #include "i18n.h"
  28 #include "charset.h"
  29 #include "options.h"
  30 #include "mpdclient.h"
  31 #include "utils.h"
  32 #include "strfsong.h"
  33 #include "wreadln.h"
  34 #include "song_paint.h"
  35 #include "screen.h"
  36 #include "screen_utils.h"
  37 #include "screen_song.h"
  38 #include "screen_lyrics.h"
  39 #include "db_completion.h"
  40 #include "Compiler.h"
  41
  42 #ifndef NCMPC_MINI
  43 #include "hscroll.h"
  44 #endif
  45
  46 #include <mpd/client.h>
  47
  48 #include <ctype.h>
  49 #include <string.h>
  50 #include <glib.h>
  51
  52 #define MAX_SONG_LENGTH 512
  53
  54 #ifndef NCMPC_MINI
  55 typedef struct
  56 {
  57         GList **list;
  58         GList **dir_list;
  59         struct mpdclient *c;
  60 } completion_callback_data_t;
  61
  62 static struct hscroll hscroll;
  63 #endif
  64
  65 static struct mpdclient_playlist *playlist;
  66 static int current_song_id = -1;
  67 static int selected_song_id = -1;
  68 static struct list_window *lw;
  69 static guint timer_hide_cursor_id;
  70
  71 static void
  72 screen_queue_paint(void);
  73
  74 static void
  75 screen_queue_repaint(void)
  76 {
  77         screen_queue_paint();
  78         wrefresh(lw->w);
  79 }
  80
  81 static const struct mpd_song *
  82 screen_queue_selected_song(void)
  83 {
  84         return !lw->range_selection &&
  85                 lw->selected < playlist_length(playlist)
  86                 ? playlist_get(playlist, lw->selected)
  87                 : NULL;
  88 }
  89
  90 static void
  91 screen_queue_save_selection(void)
  92 {
  93         selected_song_id = screen_queue_selected_song() != NULL
  94                 ? (int)mpd_song_get_id(screen_queue_selected_song())
  95                 : -1;
  96 }
  97
  98 static void
  99 screen_queue_restore_selection(void)
 100 {
 101         list_window_set_length(lw, playlist_length(playlist));
 102
 103         if (selected_song_id < 0)
 104                 /* there was no selection */
 105                 return;
 106
 107         const struct mpd_song *song = screen_queue_selected_song();
 108         if (song != NULL &&
 109             mpd_song_get_id(song) == (unsigned)selected_song_id)
 110                 /* selection is still valid */
 111                 return;
 112
 113         int pos = playlist_get_index_from_id(playlist, selected_song_id);
 114         if (pos >= 0)
 115                 list_window_set_cursor(lw, pos);
 116
 117         screen_queue_save_selection();
 118 }
 119
 120 static const char *
 121 screen_queue_lw_callback(unsigned idx, gcc_unused void *data)
 122 {
 123         static char songname[MAX_SONG_LENGTH];
 124
 125         assert(playlist != NULL);
 126         assert(idx < playlist_length(playlist));
 127
 128         struct mpd_song *song = playlist_get(playlist, idx);
 129
 130         strfsong(songname, MAX_SONG_LENGTH, options.list_format, song);
 131
 132         return songname;
 133 }
 134
 135 static void
 136 center_playing_item(const struct mpd_status *status, bool center_cursor)
 137 {
 138         if (status == NULL ||
 139             (mpd_status_get_state(status) != MPD_STATE_PLAY &&
 140              mpd_status_get_state(status) != MPD_STATE_PAUSE))
 141                 return;
 142
 143         /* try to center the song that are playing */
 144         int idx = mpd_status_get_song_pos(status);
 145         if (idx < 0)
 146                 return;
 147
 148         list_window_center(lw, idx);
 149
 150         if (center_cursor) {
 151                 list_window_set_cursor(lw, idx);
 152                 return;
 153         }
 154
 155         /* make sure the cursor is in the window */
 156         list_window_fetch_cursor(lw);
 157 }
 158
 159 gcc_pure
 160 static int
 161 get_current_song_id(const struct mpd_status *status)
 162 {
 163         return status != NULL &&
 164                 (mpd_status_get_state(status) == MPD_STATE_PLAY ||
 165                  mpd_status_get_state(status) == MPD_STATE_PAUSE)
 166                 ? (int)mpd_status_get_song_id(status)
 167                 : -1;
 168 }
 169
 170 static bool
 171 screen_queue_song_change(const struct mpd_status *status)
 172 {
 173         if (get_current_song_id(status) == current_song_id)
 174                 return false;
 175
 176         current_song_id = get_current_song_id(status);
 177
 178         /* center the cursor */
 179         if (options.auto_center && !lw->range_selection)
 180                 center_playing_item(status, false);
 181
 182         return true;
 183 }
 184
 185 #ifndef NCMPC_MINI
 186 /**
 187  * Wrapper for strncmp().  We are not allowed to pass &strncmp to
 188  * g_completion_set_compare(), because strncmp() takes size_t where
 189  * g_completion_set_compare passes a gsize value.
 190  */
 191 static gint
 192 completion_strncmp(const gchar *s1, const gchar *s2, gsize n)
 193 {
 194         return strncmp(s1, s2, n);
 195 }
 196 #endif
 197
 198 #ifndef NCMPC_MINI
 199 static void add_dir(GCompletion *gcmp, gchar *dir, GList **dir_list,
 200                     GList **list, struct mpdclient *c)
 201 {
 202         g_completion_remove_items(gcmp, *list);
 203         *list = string_list_remove(*list, dir);
 204         *list = gcmp_list_from_path(c, dir, *list, GCMP_TYPE_RFILE);
 205         g_completion_add_items(gcmp, *list);
 206         *dir_list = g_list_append(*dir_list, g_strdup(dir));
 207 }
 208
 209 static void add_pre_completion_cb(GCompletion *gcmp, gchar *line, void *data)
 210 {
 211         completion_callback_data_t *tmp = (completion_callback_data_t *)data;
 212         GList **dir_list = tmp->dir_list;
 213         GList **list = tmp->list;
 214         struct mpdclient *c = tmp->c;
 215
 216         if (*list == NULL) {
 217                 /* create initial list */
 218                 *list = gcmp_list_from_path(c, "", NULL, GCMP_TYPE_RFILE);
 219                 g_completion_add_items(gcmp, *list);
 220         } else if (line && line[0] && line[strlen(line)-1]=='/' &&
 221                    string_list_find(*dir_list, line) == NULL) {
 222                 /* add directory content to list */
 223                 add_dir(gcmp, line, dir_list, list, c);
 224         }
 225 }
 226
 227 static void add_post_completion_cb(GCompletion *gcmp, gchar *line,
 228                                    GList *items, void *data)
 229 {
 230         completion_callback_data_t *tmp = (completion_callback_data_t *)data;
 231         GList **dir_list = tmp->dir_list;
 232         GList **list = tmp->list;
 233         struct mpdclient *c = tmp->c;
 234
 235         if (g_list_length(items) >= 1)
 236                 screen_display_completion_list(items);
 237
 238         if (line && line[0] && line[strlen(line) - 1] == '/' &&
 239             string_list_find(*dir_list, line) == NULL) {
 240                 /* add directory content to list */
 241                 add_dir(gcmp, line, dir_list, list, c);
 242         }
 243 }
 244 #endif
 245
 246 static int
 247 handle_add_to_playlist(struct mpdclient *c)
 248 {
 249 #ifndef NCMPC_MINI
 250         /* initialize completion support */
 251         GCompletion *gcmp = g_completion_new(NULL);
 252         g_completion_set_compare(gcmp, completion_strncmp);
 253
 254         GList *list = NULL;
 255         GList *dir_list = NULL;
 256         completion_callback_data_t data = {
 257                 .list = &list,
 258                 .dir_list = &dir_list,
 259                 .c = c,
 260         };
 261
 262         wrln_completion_callback_data = &data;
 263         wrln_pre_completion_callback = add_pre_completion_cb;
 264         wrln_post_completion_callback = add_post_completion_cb;
 265 #else
 266         GCompletion *gcmp = NULL;
 267 #endif
 268
 269         /* get path */
 270         char *path = screen_readln(_("Add"),
 271                                    NULL,
 272                                    NULL,
 273                                    gcmp);
 274
 275         /* destroy completion data */
 276 #ifndef NCMPC_MINI
 277         wrln_completion_callback_data = NULL;
 278         wrln_pre_completion_callback = NULL;
 279         wrln_post_completion_callback = NULL;
 280         g_completion_free(gcmp);
 281         string_list_free(list);
 282         string_list_free(dir_list);
 283 #endif
 284
 285         /* add the path to the playlist */
 286         if (path != NULL) {
 287                 char *path_utf8 = locale_to_utf8(path);
 288                 mpdclient_cmd_add_path(c, path_utf8);
 289                 g_free(path_utf8);
 290         }
 291
 292         g_free(path);
 293         return 0;
 294 }
 295
 296 static void
 297 screen_queue_init(WINDOW *w, unsigned cols, unsigned rows)
 298 {
 299         lw = list_window_init(w, cols, rows);
 300
 301 #ifndef NCMPC_MINI
 302         if (options.scroll)
 303                 hscroll_init(&hscroll, w, options.scroll_sep);
 304 #endif
 305 }
 306
 307 static gboolean
 308 timer_hide_cursor(gpointer data)
 309 {
 310         struct mpdclient *c = data;
 311
 312         assert(options.hide_cursor > 0);
 313         assert(timer_hide_cursor_id != 0);
 314
 315         timer_hide_cursor_id = 0;
 316
 317         /* hide the cursor when mpd is playing and the user is inactive */
 318
 319         if (c->status != NULL &&
 320             mpd_status_get_state(c->status) == MPD_STATE_PLAY) {
 321                 lw->hide_cursor = true;
 322                 screen_queue_repaint();
 323         } else
 324                 timer_hide_cursor_id = g_timeout_add_seconds(options.hide_cursor,
 325                                                              timer_hide_cursor, c);
 326
 327         return FALSE;
 328 }
 329
 330 static void
 331 screen_queue_open(struct mpdclient *c)
 332 {
 333         playlist = &c->playlist;
 334
 335         assert(timer_hide_cursor_id == 0);
 336         if (options.hide_cursor > 0) {
 337                 lw->hide_cursor = false;
 338                 timer_hide_cursor_id = g_timeout_add_seconds(options.hide_cursor,
 339                                                              timer_hide_cursor, c);
 340         }
 341
 342         screen_queue_restore_selection();
 343         screen_queue_song_change(c->status);
 344 }
 345
 346 static void
 347 screen_queue_close(void)
 348 {
 349         if (timer_hide_cursor_id != 0) {
 350                 g_source_remove(timer_hide_cursor_id);
 351                 timer_hide_cursor_id = 0;
 352         }
 353
 354 #ifndef NCMPC_MINI
 355         if (options.scroll)
 356                 hscroll_clear(&hscroll);
 357 #endif
 358 }
 359
 360 static void
 361 screen_queue_resize(unsigned cols, unsigned rows)
 362 {
 363         list_window_resize(lw, cols, rows);
 364 }
 365
 366
 367 static void
 368 screen_queue_exit(void)
 369 {
 370         list_window_free(lw);
 371 }
 372
 373 static const char *
 374 screen_queue_title(char *str, size_t size)
 375 {
 376         if (options.host == NULL)
 377                 return _("Queue");
 378
 379         g_snprintf(str, size, _("Queue on %s"), options.host);
 380         return str;
 381 }
 382
 383 static void
 384 screen_queue_paint_callback(WINDOW *w, unsigned i,
 385                             unsigned y, unsigned width,
 386                             bool selected, gcc_unused const void *data)
 387 {
 388         assert(playlist != NULL);
 389         assert(i < playlist_length(playlist));
 390
 391         const struct mpd_song *song = playlist_get(playlist, i);
 392
 393         struct hscroll *row_hscroll = NULL;
 394 #ifndef NCMPC_MINI
 395         row_hscroll = selected && options.scroll && lw->selected == i
 396                 ? &hscroll : NULL;
 397 #endif
 398
 399         paint_song_row(w, y, width, selected,
 400                        (int)mpd_song_get_id(song) == current_song_id,
 401                        song, row_hscroll, options.list_format);
 402 }
 403
 404 static void
 405 screen_queue_paint(void)
 406 {
 407 #ifndef NCMPC_MINI
 408         if (options.scroll)
 409                 hscroll_clear(&hscroll);
 410 #endif
 411
 412         list_window_paint2(lw, screen_queue_paint_callback, NULL);
 413 }
 414
 415 static void
 416 screen_queue_update(struct mpdclient *c)
 417 {
 418         if (c->events & MPD_IDLE_QUEUE)
 419                 screen_queue_restore_selection();
 420         else
 421                 /* the queue size may have changed, even if we havn't
 422                    received the QUEUE idle event yet */
 423                 list_window_set_length(lw, playlist_length(playlist));
 424
 425         if (((c->events & MPD_IDLE_PLAYER) != 0 &&
 426              screen_queue_song_change(c->status)) ||
 427             c->events & MPD_IDLE_QUEUE)
 428                 /* the queue or the current song has changed, we must
 429                    paint the new version */
 430                 screen_queue_paint();
 431 }
 432
 433 #ifdef HAVE_GETMOUSE
 434 static bool
 435 handle_mouse_event(struct mpdclient *c)
 436 {
 437         unsigned long bstate;
 438         int row;
 439         if (screen_get_mouse_event(c, &bstate, &row) ||
 440             list_window_mouse(lw, bstate, row)) {
 441                 screen_queue_paint();
 442                 return true;
 443         }
 444
 445         if (bstate & BUTTON1_DOUBLE_CLICKED) {
 446                 /* stop */
 447                 screen_cmd(c, CMD_STOP);
 448                 return true;
 449         }
 450
 451         const unsigned old_selected = lw->selected;
 452         list_window_set_cursor(lw, lw->start + row);
 453
 454         if (bstate & BUTTON1_CLICKED) {
 455                 /* play */
 456                 const struct mpd_song *song = screen_queue_selected_song();
 457                 if (song != NULL) {
 458                         struct mpd_connection *connection =
 459                                 mpdclient_get_connection(c);
 460
 461                         if (connection != NULL &&
 462                             !mpd_run_play_id(connection,
 463                                              mpd_song_get_id(song)))
 464                                 mpdclient_handle_error(c);
 465                 }
 466         } else if (bstate & BUTTON3_CLICKED) {
 467                 /* delete */
 468                 if (lw->selected == old_selected)
 469                         mpdclient_cmd_delete(c, lw->selected);
 470
 471                 list_window_set_length(lw, playlist_length(playlist));
 472         }
 473
 474         screen_queue_save_selection();
 475         screen_queue_paint();
 476
 477         return true;
 478 }
 479 #endif
 480
 481 static bool
 482 screen_queue_cmd(struct mpdclient *c, command_t cmd)
 483 {
 484         struct mpd_connection *connection;
 485         static command_t cached_cmd = CMD_NONE;
 486
 487         const command_t prev_cmd = cached_cmd;
 488         cached_cmd = cmd;
 489
 490         lw->hide_cursor = false;
 491
 492         if (options.hide_cursor > 0) {
 493                 if (timer_hide_cursor_id != 0)
 494                         g_source_remove(timer_hide_cursor_id);
 495                 timer_hide_cursor_id = g_timeout_add_seconds(options.hide_cursor,
 496                                                              timer_hide_cursor, c);
 497         }
 498
 499         if (list_window_cmd(lw, cmd)) {
 500                 screen_queue_save_selection();
 501                 screen_queue_paint();
 502                 return true;
 503         }
 504
 505         switch(cmd) {
 506         case CMD_SCREEN_UPDATE:
 507                 center_playing_item(c->status, prev_cmd == CMD_SCREEN_UPDATE);
 508                 screen_queue_paint();
 509                 return false;
 510         case CMD_SELECT_PLAYING:
 511                 list_window_set_cursor(lw, playlist_get_index(&c->playlist,
 512                                                               c->song));
 513                 screen_queue_save_selection();
 514                 screen_queue_paint();
 515                 return true;
 516
 517         case CMD_LIST_FIND:
 518         case CMD_LIST_RFIND:
 519         case CMD_LIST_FIND_NEXT:
 520         case CMD_LIST_RFIND_NEXT:
 521                 screen_find(lw, cmd, screen_queue_lw_callback, NULL);
 522                 screen_queue_save_selection();
 523                 screen_queue_paint();
 524                 return true;
 525         case CMD_LIST_JUMP:
 526                 screen_jump(lw, screen_queue_lw_callback, NULL, NULL, NULL);
 527                 screen_queue_save_selection();
 528                 screen_queue_paint();
 529                 return true;
 530
 531 #ifdef HAVE_GETMOUSE
 532         case CMD_MOUSE_EVENT:
 533                 return handle_mouse_event(c);
 534 #endif
 535
 536 #ifdef ENABLE_SONG_SCREEN
 537         case CMD_SCREEN_SONG:
 538                 if (screen_queue_selected_song() != NULL) {
 539                         screen_song_switch(c, screen_queue_selected_song());
 540                         return true;
 541                 }
 542
 543                 break;
 544 #endif
 545
 546 #ifdef ENABLE_LYRICS_SCREEN
 547         case CMD_SCREEN_LYRICS:
 548                 if (lw->selected < playlist_length(&c->playlist)) {
 549                         struct mpd_song *selected = playlist_get(&c->playlist, lw->selected);
 550                         bool follow = false;
 551
 552                         if (c->song && selected &&
 553                             !strcmp(mpd_song_get_uri(selected),
 554                                     mpd_song_get_uri(c->song)))
 555                                 follow = true;
 556
 557                         screen_lyrics_switch(c, selected, follow);
 558                         return true;
 559                 }
 560
 561                 break;
 562 #endif
 563         case CMD_SCREEN_SWAP:
 564                 if (playlist_length(&c->playlist) > 0)
 565                         screen_swap(c, playlist_get(&c->playlist, lw->selected));
 566                 else
 567                         screen_swap(c, NULL);
 568                 return true;
 569
 570         default:
 571                 break;
 572         }
 573
 574         if (!mpdclient_is_connected(c))
 575                 return false;
 576
 577         switch(cmd) {
 578                 const struct mpd_song *song;
 579                 struct list_window_range range;
 580
 581         case CMD_PLAY:
 582                 song = screen_queue_selected_song();
 583                 if (song == NULL)
 584                         return false;
 585
 586                 connection = mpdclient_get_connection(c);
 587                 if (connection != NULL &&
 588                     !mpd_run_play_id(connection, mpd_song_get_id(song)))
 589                         mpdclient_handle_error(c);
 590
 591                 return true;
 592
 593         case CMD_DELETE:
 594                 list_window_get_range(lw, &range);
 595                 mpdclient_cmd_delete_range(c, range.start, range.end);
 596
 597                 list_window_set_cursor(lw, range.start);
 598                 return true;
 599
 600         case CMD_SAVE_PLAYLIST:
 601                 playlist_save(c, NULL, NULL);
 602                 return true;
 603
 604         case CMD_ADD:
 605                 handle_add_to_playlist(c);
 606                 return true;
 607
 608         case CMD_SHUFFLE:
 609                 list_window_get_range(lw, &range);
 610                 if (range.end <= range.start + 1)
 611                         /* No range selection, shuffle all list. */
 612                         break;
 613
 614                 connection = mpdclient_get_connection(c);
 615                 if (connection == NULL)
 616                         return true;
 617
 618                 if (mpd_run_shuffle_range(connection, range.start, range.end))
 619                         screen_status_message(_("Shuffled queue"));
 620                 else
 621                         mpdclient_handle_error(c);
 622                 return true;
 623
 624         case CMD_LIST_MOVE_UP:
 625                 list_window_get_range(lw, &range);
 626                 if (range.start == 0 || range.end <= range.start)
 627                         return false;
 628
 629                 if (!mpdclient_cmd_move(c, range.end - 1, range.start - 1))
 630                         return true;
 631
 632                 lw->selected--;
 633                 lw->range_base--;
 634
 635                 if (lw->range_selection)
 636                         list_window_scroll_to(lw, lw->range_base);
 637                 list_window_scroll_to(lw, lw->selected);
 638
 639                 screen_queue_save_selection();
 640                 return true;
 641
 642         case CMD_LIST_MOVE_DOWN:
 643                 list_window_get_range(lw, &range);
 644                 if (range.end >= playlist_length(&c->playlist))
 645                         return false;
 646
 647                 if (!mpdclient_cmd_move(c, range.start, range.end))
 648                         return true;
 649
 650                 lw->selected++;
 651                 lw->range_base++;
 652
 653                 if (lw->range_selection)
 654                         list_window_scroll_to(lw, lw->range_base);
 655                 list_window_scroll_to(lw, lw->selected);
 656
 657                 screen_queue_save_selection();
 658                 return true;
 659
 660         case CMD_LOCATE:
 661                 if (screen_queue_selected_song() != NULL) {
 662                         screen_file_goto_song(c, screen_queue_selected_song());
 663                         return true;
 664                 }
 665
 666                 break;
 667
 668         default:
 669                 break;
 670         }
 671
 672         return false;
 673 }
 674
 675 const struct screen_functions screen_queue = {
 676         .init = screen_queue_init,
 677         .exit = screen_queue_exit,
 678         .open = screen_queue_open,
 679         .close = screen_queue_close,
 680         .resize = screen_queue_resize,
 681         .paint = screen_queue_paint,
 682         .update = screen_queue_update,
 683         .cmd = screen_queue_cmd,
 684         .get_title = screen_queue_title,
 685 };