Code

f3ca21a06e49a6c5a1ae2d73d0ac9483e3548df0
[ncmpc.git] / src / screen_queue.c
1 /* ncmpc (Ncurses MPD Client)
2  * (c) 2004-2009 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_queue.h"
21 #include "screen_interface.h"
22 #include "screen_file.h"
23 #include "screen_message.h"
24 #include "screen_find.h"
25 #include "config.h"
26 #include "i18n.h"
27 #include "charset.h"
28 #include "options.h"
29 #include "mpdclient.h"
30 #include "utils.h"
31 #include "strfsong.h"
32 #include "wreadln.h"
33 #include "song_paint.h"
34 #include "screen.h"
35 #include "screen_utils.h"
36 #include "screen_song.h"
37 #include "screen_lyrics.h"
39 #ifndef NCMPC_MINI
40 #include "hscroll.h"
41 #endif
43 #include <mpd/client.h>
45 #include <ctype.h>
46 #include <string.h>
47 #include <glib.h>
49 #define MAX_SONG_LENGTH 512
51 #ifndef NCMPC_MINI
52 typedef struct
53 {
54         GList **list;
55         GList **dir_list;
56         struct mpdclient *c;
57 } completion_callback_data_t;
59 static struct hscroll hscroll;
60 #endif
62 static struct mpdclient_playlist *playlist;
63 static int current_song_id = -1;
64 static int selected_song_id = -1;
65 static struct list_window *lw;
66 static guint timer_hide_cursor_id;
68 static void
69 screen_queue_paint(void);
71 static void
72 screen_queue_repaint(void)
73 {
74         screen_queue_paint();
75         wrefresh(lw->w);
76 }
78 static const struct mpd_song *
79 screen_queue_selected_song(void)
80 {
81         return !lw->range_selection &&
82                 lw->selected < playlist_length(playlist)
83                 ? playlist_get(playlist, lw->selected)
84                 : NULL;
85 }
87 static void
88 screen_queue_save_selection(void)
89 {
90         selected_song_id = screen_queue_selected_song() != NULL
91                 ? (int)mpd_song_get_id(screen_queue_selected_song())
92                 : -1;
93 }
95 static void
96 screen_queue_restore_selection(void)
97 {
98         const struct mpd_song *song;
99         int pos;
101         list_window_set_length(lw, playlist_length(playlist));
103         if (selected_song_id < 0)
104                 /* there was no selection */
105                 return;
107         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;
113         pos = playlist_get_index_from_id(playlist, selected_song_id);
114         if (pos >= 0)
115                 list_window_set_cursor(lw, pos);
117         screen_queue_save_selection();
120 static const char *
121 screen_queue_lw_callback(unsigned idx, G_GNUC_UNUSED void *data)
123         static char songname[MAX_SONG_LENGTH];
124         struct mpd_song *song;
126         assert(playlist != NULL);
127         assert(idx < playlist_length(playlist));
129         song = playlist_get(playlist, idx);
131         strfsong(songname, MAX_SONG_LENGTH, options.list_format, song);
133         return songname;
136 static void
137 center_playing_item(const struct mpd_status *status, bool center_cursor)
139         int idx;
141         if (status == NULL ||
142             (mpd_status_get_state(status) != MPD_STATE_PLAY &&
143              mpd_status_get_state(status) != MPD_STATE_PAUSE))
144                 return;
146         /* try to center the song that are playing */
147         idx = mpd_status_get_song_pos(status);
148         if (idx < 0)
149                 return;
151         list_window_center(lw, idx);
153         if (center_cursor) {
154                 list_window_set_cursor(lw, idx);
155                 return;
156         }
158         /* make sure the cursor is in the window */
159         list_window_fetch_cursor(lw);
162 G_GNUC_PURE
163 static int
164 get_current_song_id(const struct mpd_status *status)
166         return status != NULL &&
167                 (mpd_status_get_state(status) == MPD_STATE_PLAY ||
168                  mpd_status_get_state(status) == MPD_STATE_PAUSE)
169                 ? (int)mpd_status_get_song_id(status)
170                 : -1;
173 static bool
174 screen_queue_song_change(const struct mpd_status *status)
176         if (get_current_song_id(status) == current_song_id)
177                 return false;
179         current_song_id = get_current_song_id(status);
181         /* center the cursor */
182         if (options.auto_center && !lw->range_selection)
183                 center_playing_item(status, false);
185         return true;
188 #ifndef NCMPC_MINI
189 static void
190 save_pre_completion_cb(GCompletion *gcmp, G_GNUC_UNUSED gchar *line,
191                        void *data)
193         completion_callback_data_t *tmp = (completion_callback_data_t *)data;
194         GList **list = tmp->list;
195         struct mpdclient *c = tmp->c;
197         if( *list == NULL ) {
198                 /* create completion list */
199                 *list = gcmp_list_from_path(c, "", NULL, GCMP_TYPE_PLAYLIST);
200                 g_completion_add_items(gcmp, *list);
201         }
204 static void
205 save_post_completion_cb(G_GNUC_UNUSED GCompletion *gcmp,
206                         G_GNUC_UNUSED gchar *line, GList *items,
207                         G_GNUC_UNUSED void *data)
209         if (g_list_length(items) >= 1)
210                 screen_display_completion_list(items);
212 #endif
214 #ifndef NCMPC_MINI
215 /**
216  * Wrapper for strncmp().  We are not allowed to pass &strncmp to
217  * g_completion_set_compare(), because strncmp() takes size_t where
218  * g_completion_set_compare passes a gsize value.
219  */
220 static gint
221 completion_strncmp(const gchar *s1, const gchar *s2, gsize n)
223         return strncmp(s1, s2, n);
225 #endif
227 int
228 playlist_save(struct mpdclient *c, char *name, char *defaultname)
230         struct mpd_connection *connection;
231         gchar *filename, *filename_utf8;
232 #ifndef NCMPC_MINI
233         GCompletion *gcmp;
234         GList *list = NULL;
235         completion_callback_data_t data;
236 #endif
238 #ifdef NCMPC_MINI
239         (void)defaultname;
240 #endif
242 #ifndef NCMPC_MINI
243         if (name == NULL) {
244                 /* initialize completion support */
245                 gcmp = g_completion_new(NULL);
246                 g_completion_set_compare(gcmp, completion_strncmp);
247                 data.list = &list;
248                 data.dir_list = NULL;
249                 data.c = c;
250                 wrln_completion_callback_data = &data;
251                 wrln_pre_completion_callback = save_pre_completion_cb;
252                 wrln_post_completion_callback = save_post_completion_cb;
255                 /* query the user for a filename */
256                 filename = screen_readln(_("Save playlist as"),
257                                          defaultname,
258                                          NULL,
259                                          gcmp);
261                 /* destroy completion support */
262                 wrln_completion_callback_data = NULL;
263                 wrln_pre_completion_callback = NULL;
264                 wrln_post_completion_callback = NULL;
265                 g_completion_free(gcmp);
266                 list = string_list_free(list);
267                 if( filename )
268                         filename=g_strstrip(filename);
269         } else
270 #endif
271                         filename=g_strdup(name);
273         if (filename == NULL)
274                 return -1;
276         /* send save command to mpd */
278         connection = mpdclient_get_connection(c);
279         if (connection == NULL)
280                 return -1;
282         filename_utf8 = locale_to_utf8(filename);
283         if (!mpd_run_save(connection, filename_utf8)) {
284                 if (mpd_connection_get_error(connection) == MPD_ERROR_SERVER &&
285                     mpd_connection_get_server_error(connection) == MPD_SERVER_ERROR_EXIST &&
286                     mpd_connection_clear_error(connection)) {
287                         char *buf;
288                         int key;
290                         buf = g_strdup_printf(_("Replace %s [%s/%s] ? "),
291                                               filename, YES, NO);
292                         key = tolower(screen_getch(buf));
293                         g_free(buf);
295                         if (key != YES[0]) {
296                                 g_free(filename_utf8);
297                                 g_free(filename);
298                                 screen_status_printf(_("Aborted"));
299                                 return -1;
300                         }
302                         if (!mpd_run_rm(connection, filename_utf8) ||
303                             !mpd_run_save(connection, filename_utf8)) {
304                                 mpdclient_handle_error(c);
305                                 g_free(filename_utf8);
306                                 g_free(filename);
307                                 return -1;
308                         }
309                 } else {
310                         mpdclient_handle_error(c);
311                         g_free(filename_utf8);
312                         g_free(filename);
313                         return -1;
314                 }
315         }
317         c->events |= MPD_IDLE_STORED_PLAYLIST;
319         g_free(filename_utf8);
321         /* success */
322         screen_status_printf(_("Saved %s"), filename);
323         g_free(filename);
324         return 0;
327 #ifndef NCMPC_MINI
328 static void add_dir(GCompletion *gcmp, gchar *dir, GList **dir_list,
329                     GList **list, struct mpdclient *c)
331         g_completion_remove_items(gcmp, *list);
332         *list = string_list_remove(*list, dir);
333         *list = gcmp_list_from_path(c, dir, *list, GCMP_TYPE_RFILE);
334         g_completion_add_items(gcmp, *list);
335         *dir_list = g_list_append(*dir_list, g_strdup(dir));
338 static void add_pre_completion_cb(GCompletion *gcmp, gchar *line, void *data)
340         completion_callback_data_t *tmp = (completion_callback_data_t *)data;
341         GList **dir_list = tmp->dir_list;
342         GList **list = tmp->list;
343         struct mpdclient *c = tmp->c;
345         if (*list == NULL) {
346                 /* create initial list */
347                 *list = gcmp_list_from_path(c, "", NULL, GCMP_TYPE_RFILE);
348                 g_completion_add_items(gcmp, *list);
349         } else if (line && line[0] && line[strlen(line)-1]=='/' &&
350                    string_list_find(*dir_list, line) == NULL) {
351                 /* add directory content to list */
352                 add_dir(gcmp, line, dir_list, list, c);
353         }
356 static void add_post_completion_cb(GCompletion *gcmp, gchar *line,
357                                    GList *items, void *data)
359         completion_callback_data_t *tmp = (completion_callback_data_t *)data;
360         GList **dir_list = tmp->dir_list;
361         GList **list = tmp->list;
362         struct mpdclient *c = tmp->c;
364         if (g_list_length(items) >= 1)
365                 screen_display_completion_list(items);
367         if (line && line[0] && line[strlen(line) - 1] == '/' &&
368             string_list_find(*dir_list, line) == NULL) {
369                 /* add directory content to list */
370                 add_dir(gcmp, line, dir_list, list, c);
371         }
373 #endif
375 static int
376 handle_add_to_playlist(struct mpdclient *c)
378         gchar *path;
379 #ifndef NCMPC_MINI
380         GCompletion *gcmp;
381         GList *list = NULL;
382         GList *dir_list = NULL;
383         completion_callback_data_t data;
385         /* initialize completion support */
386         gcmp = g_completion_new(NULL);
387         g_completion_set_compare(gcmp, completion_strncmp);
388         data.list = &list;
389         data.dir_list = &dir_list;
390         data.c = c;
391         wrln_completion_callback_data = &data;
392         wrln_pre_completion_callback = add_pre_completion_cb;
393         wrln_post_completion_callback = add_post_completion_cb;
394 #endif
396         /* get path */
397         path = screen_readln(_("Add"),
398                              NULL,
399                              NULL,
400 #ifdef NCMPC_MINI
401                              NULL
402 #else
403                              gcmp
404 #endif
405                              );
407         /* destroy completion data */
408 #ifndef NCMPC_MINI
409         wrln_completion_callback_data = NULL;
410         wrln_pre_completion_callback = NULL;
411         wrln_post_completion_callback = NULL;
412         g_completion_free(gcmp);
413         string_list_free(list);
414         string_list_free(dir_list);
415 #endif
417         /* add the path to the playlist */
418         if (path != NULL) {
419                 char *path_utf8 = locale_to_utf8(path);
420                 mpdclient_cmd_add_path(c, path_utf8);
421                 g_free(path_utf8);
422         }
424         g_free(path);
425         return 0;
428 static void
429 screen_queue_init(WINDOW *w, int cols, int rows)
431         lw = list_window_init(w, cols, rows);
433 #ifndef NCMPC_MINI
434         if (options.scroll)
435                 hscroll_init(&hscroll, w, options.scroll_sep);
436 #endif
439 static gboolean
440 timer_hide_cursor(gpointer data)
442         struct mpdclient *c = data;
444         assert(options.hide_cursor > 0);
445         assert(timer_hide_cursor_id != 0);
447         timer_hide_cursor_id = 0;
449         /* hide the cursor when mpd is playing and the user is inactive */
451         if (c->status != NULL &&
452             mpd_status_get_state(c->status) == MPD_STATE_PLAY) {
453                 lw->hide_cursor = true;
454                 screen_queue_repaint();
455         } else
456                 timer_hide_cursor_id = g_timeout_add(options.hide_cursor * 1000,
457                                                      timer_hide_cursor, c);
459         return FALSE;
462 static void
463 screen_queue_open(struct mpdclient *c)
465         playlist = &c->playlist;
467         assert(timer_hide_cursor_id == 0);
468         if (options.hide_cursor > 0) {
469                 lw->hide_cursor = false;
470                 timer_hide_cursor_id = g_timeout_add(options.hide_cursor * 1000,
471                                                      timer_hide_cursor, c);
472         }
474         screen_queue_restore_selection();
475         screen_queue_song_change(c->status);
478 static void
479 screen_queue_close(void)
481         if (timer_hide_cursor_id != 0) {
482                 g_source_remove(timer_hide_cursor_id);
483                 timer_hide_cursor_id = 0;
484         }
486 #ifndef NCMPC_MINI
487         if (options.scroll)
488                 hscroll_clear(&hscroll);
489 #endif
492 static void
493 screen_queue_resize(int cols, int rows)
495         list_window_resize(lw, cols, rows);
499 static void
500 screen_queue_exit(void)
502         list_window_free(lw);
505 static const char *
506 screen_queue_title(char *str, size_t size)
508         if (options.host == NULL)
509                 return _("Playlist");
511         g_snprintf(str, size, _("Playlist on %s"), options.host);
512         return str;
515 static void
516 screen_queue_paint_callback(WINDOW *w, unsigned i,
517                             unsigned y, unsigned width,
518                             bool selected, G_GNUC_UNUSED void *data)
520         const struct mpd_song *song;
521         struct hscroll *row_hscroll;
523         assert(playlist != NULL);
524         assert(i < playlist_length(playlist));
526         song = playlist_get(playlist, i);
528 #ifdef NCMPC_MINI
529         row_hscroll = NULL;
530 #else
531         row_hscroll = selected && options.scroll && lw->selected == i
532                 ? &hscroll : NULL;
533 #endif
535         paint_song_row(w, y, width, selected,
536                        (int)mpd_song_get_id(song) == current_song_id,
537                        song, row_hscroll);
540 static void
541 screen_queue_paint(void)
543 #ifndef NCMPC_MINI
544         if (options.scroll)
545                 hscroll_clear(&hscroll);
546 #endif
548         list_window_paint2(lw, screen_queue_paint_callback, NULL);
551 static void
552 screen_queue_update(struct mpdclient *c)
554         if (c->events & MPD_IDLE_QUEUE)
555                 screen_queue_restore_selection();
557         if (((c->events & MPD_IDLE_PLAYER) != 0 &&
558              screen_queue_song_change(c->status)) ||
559             c->events & MPD_IDLE_QUEUE)
560                 /* the queue or the current song has changed, we must
561                    paint the new version */
562                 screen_queue_repaint();
565 #ifdef HAVE_GETMOUSE
566 static bool
567 handle_mouse_event(struct mpdclient *c)
569         int row;
570         unsigned long bstate;
571         unsigned old_selected;
573         if (screen_get_mouse_event(c, &bstate, &row) ||
574             list_window_mouse(lw, bstate, row)) {
575                 screen_queue_repaint();
576                 return true;
577         }
579         if (bstate & BUTTON1_DOUBLE_CLICKED) {
580                 /* stop */
581                 screen_cmd(c, CMD_STOP);
582                 return true;
583         }
585         old_selected = lw->selected;
586         list_window_set_cursor(lw, lw->start + row);
588         if (bstate & BUTTON1_CLICKED) {
589                 /* play */
590                 const struct mpd_song *song = screen_queue_selected_song();
591                 if (song != NULL) {
592                         struct mpd_connection *connection =
593                                 mpdclient_get_connection(c);
595                         if (connection != NULL &&
596                             !mpd_run_play_id(connection,
597                                              mpd_song_get_id(song)))
598                                 mpdclient_handle_error(c);
599                 }
600         } else if (bstate & BUTTON3_CLICKED) {
601                 /* delete */
602                 if (lw->selected == old_selected)
603                         mpdclient_cmd_delete(c, lw->selected);
605                 list_window_set_length(lw, playlist_length(playlist));
606         }
608         screen_queue_save_selection();
609         screen_queue_repaint();
611         return true;
613 #endif
615 static bool
616 screen_queue_cmd(struct mpdclient *c, command_t cmd)
618         struct mpd_connection *connection;
619         static command_t cached_cmd = CMD_NONE;
620         command_t prev_cmd = cached_cmd;
621         struct list_window_range range;
622         const struct mpd_song *song;
624         cached_cmd = cmd;
626         lw->hide_cursor = false;
628         if (options.hide_cursor > 0) {
629                 if (timer_hide_cursor_id != 0)
630                         g_source_remove(timer_hide_cursor_id);
631                 timer_hide_cursor_id = g_timeout_add(options.hide_cursor * 1000,
632                                                      timer_hide_cursor, c);
633         }
635         if (list_window_cmd(lw, cmd)) {
636                 screen_queue_save_selection();
637                 screen_queue_repaint();
638                 return true;
639         }
641         switch(cmd) {
642         case CMD_SCREEN_UPDATE:
643                 center_playing_item(c->status, prev_cmd == CMD_SCREEN_UPDATE);
644                 screen_queue_repaint();
645                 return false;
646         case CMD_SELECT_PLAYING:
647                 list_window_set_cursor(lw, playlist_get_index(&c->playlist,
648                                                               c->song));
649                 screen_queue_save_selection();
650                 screen_queue_repaint();
651                 return true;
653         case CMD_LIST_FIND:
654         case CMD_LIST_RFIND:
655         case CMD_LIST_FIND_NEXT:
656         case CMD_LIST_RFIND_NEXT:
657                 screen_find(lw, cmd, screen_queue_lw_callback, NULL);
658                 screen_queue_save_selection();
659                 screen_queue_repaint();
660                 return true;
661         case CMD_LIST_JUMP:
662                 screen_jump(lw, screen_queue_lw_callback, NULL, NULL);
663                 screen_queue_save_selection();
664                 screen_queue_repaint();
665                 return true;
667 #ifdef HAVE_GETMOUSE
668         case CMD_MOUSE_EVENT:
669                 return handle_mouse_event(c);
670 #endif
672 #ifdef ENABLE_SONG_SCREEN
673         case CMD_SCREEN_SONG:
674                 if (screen_queue_selected_song() != NULL) {
675                         screen_song_switch(c, screen_queue_selected_song());
676                         return true;
677                 }
679                 break;
680 #endif
682 #ifdef ENABLE_LYRICS_SCREEN
683         case CMD_SCREEN_LYRICS:
684                 if (lw->selected < playlist_length(&c->playlist)) {
685                         struct mpd_song *selected = playlist_get(&c->playlist, lw->selected);
686                         bool follow = false;
688                         if (c->song && selected &&
689                             !strcmp(mpd_song_get_uri(selected),
690                                     mpd_song_get_uri(c->song)))
691                                 follow = true;
693                         screen_lyrics_switch(c, selected, follow);
694                         return true;
695                 }
697                 break;
698 #endif
699         case CMD_SCREEN_SWAP:
700                 screen_swap(c, playlist_get(&c->playlist, lw->selected));
701                 return true;
703         default:
704                 break;
705         }
707         if (!mpdclient_is_connected(c))
708                 return false;
710         switch(cmd) {
711         case CMD_PLAY:
712                 song = screen_queue_selected_song();
713                 if (song == NULL)
714                         return false;
716                 connection = mpdclient_get_connection(c);
717                 if (connection != NULL &&
718                     !mpd_run_play_id(connection, mpd_song_get_id(song)))
719                         mpdclient_handle_error(c);
721                 return true;
723         case CMD_DELETE:
724                 list_window_get_range(lw, &range);
725                 mpdclient_cmd_delete_range(c, range.start, range.end);
727                 list_window_set_cursor(lw, range.start);
728                 return true;
730         case CMD_SAVE_PLAYLIST:
731                 playlist_save(c, NULL, NULL);
732                 return true;
734         case CMD_ADD:
735                 handle_add_to_playlist(c);
736                 return true;
738         case CMD_SHUFFLE:
739                 list_window_get_range(lw, &range);
740                 if (range.end < range.start + 1)
741                         /* No range selection, shuffle all list. */
742                         break;
744                 connection = mpdclient_get_connection(c);
745                 if (connection == NULL)
746                         return true;
748                 if (mpd_run_shuffle_range(connection, range.start, range.end))
749                         screen_status_message(_("Shuffled playlist"));
750                 else
751                         mpdclient_handle_error(c);
752                 return true;
754         case CMD_LIST_MOVE_UP:
755                 list_window_get_range(lw, &range);
756                 if (range.start == 0 || range.end <= range.start)
757                         return false;
759                 if (!mpdclient_cmd_move(c, range.end - 1, range.start - 1))
760                         return true;
762                 lw->selected--;
763                 lw->range_base--;
765                 screen_queue_save_selection();
766                 return true;
768         case CMD_LIST_MOVE_DOWN:
769                 list_window_get_range(lw, &range);
770                 if (range.end >= playlist_length(&c->playlist))
771                         return false;
773                 if (!mpdclient_cmd_move(c, range.start, range.end))
774                         return true;
776                 lw->selected++;
777                 lw->range_base++;
779                 screen_queue_save_selection();
780                 return true;
782         case CMD_LOCATE:
783                 if (screen_queue_selected_song() != NULL) {
784                         screen_file_goto_song(c, screen_queue_selected_song());
785                         return true;
786                 }
788                 break;
790         default:
791                 break;
792         }
794         return false;
797 const struct screen_functions screen_queue = {
798         .init = screen_queue_init,
799         .exit = screen_queue_exit,
800         .open = screen_queue_open,
801         .close = screen_queue_close,
802         .resize = screen_queue_resize,
803         .paint = screen_queue_paint,
804         .update = screen_queue_update,
805         .cmd = screen_queue_cmd,
806         .get_title = screen_queue_title,
807 };