1 /* ncmpc (Ncurses MPD Client)
2 * (c) 2004-2009 The Music Player Daemon Project
3 * Project homepage: http://musicpd.org
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.
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.
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 "mpdclient.h"
21 #include "filelist.h"
22 #include "screen_client.h"
23 #include "config.h"
24 #include "options.h"
25 #include "strfsong.h"
26 #include "utils.h"
27 #include "gidle.h"
29 #include <mpd/client.h>
31 #include <stdlib.h>
32 #include <unistd.h>
33 #include <time.h>
34 #include <string.h>
36 #define BUFSIZE 1024
38 /* sort by list-format */
39 gint
40 compare_filelistentry_format(gconstpointer filelist_entry1,
41 gconstpointer filelist_entry2)
42 {
43 const struct mpd_entity *e1, *e2;
44 char key1[BUFSIZE], key2[BUFSIZE];
45 int n = 0;
47 e1 = ((const struct filelist_entry *)filelist_entry1)->entity;
48 e2 = ((const struct filelist_entry *)filelist_entry2)->entity;
50 if (e1 && e2 &&
51 mpd_entity_get_type(e1) == MPD_ENTITY_TYPE_SONG &&
52 mpd_entity_get_type(e2) == MPD_ENTITY_TYPE_SONG) {
53 strfsong(key1, BUFSIZE, options.list_format, mpd_entity_get_song(e1));
54 strfsong(key2, BUFSIZE, options.list_format, mpd_entity_get_song(e2));
55 n = strcmp(key1,key2);
56 }
58 return n;
59 }
62 /****************************************************************************/
63 /*** mpdclient functions ****************************************************/
64 /****************************************************************************/
66 bool
67 mpdclient_handle_error(struct mpdclient *c)
68 {
69 enum mpd_error error = mpd_connection_get_error(c->connection);
71 assert(error != MPD_ERROR_SUCCESS);
73 if (error == MPD_ERROR_SERVER &&
74 mpd_connection_get_server_error(c->connection) == MPD_SERVER_ERROR_PERMISSION &&
75 screen_auth(c))
76 return true;
78 mpdclient_ui_error(mpd_connection_get_error_message(c->connection));
80 if (!mpd_connection_clear_error(c->connection))
81 mpdclient_disconnect(c);
83 return false;
84 }
86 static bool
87 mpdclient_finish_command(struct mpdclient *c)
88 {
89 return mpd_response_finish(c->connection)
90 ? true : mpdclient_handle_error(c);
91 }
93 struct mpdclient *
94 mpdclient_new(void)
95 {
96 struct mpdclient *c;
98 c = g_new0(struct mpdclient, 1);
99 playlist_init(&c->playlist);
100 c->volume = -1;
101 c->events = 0;
103 return c;
104 }
106 void
107 mpdclient_free(struct mpdclient *c)
108 {
109 mpdclient_disconnect(c);
111 mpdclient_playlist_free(&c->playlist);
113 g_free(c);
114 }
116 void
117 mpdclient_disconnect(struct mpdclient *c)
118 {
119 if (c->source != NULL) {
120 mpd_glib_free(c->source);
121 c->source = NULL;
122 c->idle = false;
123 }
125 if (c->connection)
126 mpd_connection_free(c->connection);
127 c->connection = NULL;
129 if (c->status)
130 mpd_status_free(c->status);
131 c->status = NULL;
133 playlist_clear(&c->playlist);
135 if (c->song)
136 c->song = NULL;
138 /* everything has changed after a disconnect */
139 c->events |= MPD_IDLE_DATABASE|MPD_IDLE_STORED_PLAYLIST|
140 MPD_IDLE_QUEUE|MPD_IDLE_PLAYER|MPD_IDLE_MIXER|MPD_IDLE_OUTPUT|
141 MPD_IDLE_OPTIONS|MPD_IDLE_UPDATE;
142 }
144 bool
145 mpdclient_connect(struct mpdclient *c,
146 const gchar *host,
147 gint port,
148 gfloat _timeout,
149 const gchar *password)
150 {
151 /* close any open connection */
152 if( c->connection )
153 mpdclient_disconnect(c);
155 /* connect to MPD */
156 c->connection = mpd_connection_new(host, port, _timeout * 1000);
157 if (c->connection == NULL)
158 g_error("Out of memory");
160 if (mpd_connection_get_error(c->connection) != MPD_ERROR_SUCCESS) {
161 mpdclient_handle_error(c);
162 mpdclient_disconnect(c);
163 return false;
164 }
166 /* send password */
167 if (password != NULL && !mpd_run_password(c->connection, password)) {
168 mpdclient_handle_error(c);
169 mpdclient_disconnect(c);
170 return false;
171 }
173 return true;
174 }
176 bool
177 mpdclient_update(struct mpdclient *c)
178 {
179 struct mpd_connection *connection = mpdclient_get_connection(c);
180 bool retval;
182 c->volume = -1;
184 if (connection == NULL)
185 return false;
187 /* always announce these options as long as we don't have
188 "idle" support */
189 if (c->source == NULL)
190 c->events |= MPD_IDLE_PLAYER|MPD_IDLE_OPTIONS;
192 /* free the old status */
193 if (c->status)
194 mpd_status_free(c->status);
196 /* retrieve new status */
197 c->status = mpd_run_status(connection);
198 if (c->status == NULL)
199 return mpdclient_handle_error(c);
201 if (c->source == NULL &&
202 c->update_id != mpd_status_get_update_id(c->status)) {
203 c->events |= MPD_IDLE_UPDATE;
205 if (c->update_id > 0)
206 c->events |= MPD_IDLE_DATABASE;
207 }
209 c->update_id = mpd_status_get_update_id(c->status);
211 if (c->source == NULL &&
212 c->volume != mpd_status_get_volume(c->status))
213 c->events |= MPD_IDLE_MIXER;
215 c->volume = mpd_status_get_volume(c->status);
217 /* check if the playlist needs an update */
218 if (c->playlist.version != mpd_status_get_queue_version(c->status)) {
219 if (c->source == NULL)
220 c->events |= MPD_IDLE_PLAYLIST;
222 if (!playlist_is_empty(&c->playlist))
223 retval = mpdclient_playlist_update_changes(c);
224 else
225 retval = mpdclient_playlist_update(c);
226 } else
227 retval = true;
229 /* update the current song */
230 if (!c->song || mpd_status_get_song_id(c->status)) {
231 c->song = playlist_get_song(&c->playlist,
232 mpd_status_get_song_pos(c->status));
233 }
235 return retval;
236 }
238 struct mpd_connection *
239 mpdclient_get_connection(struct mpdclient *c)
240 {
241 if (c->source != NULL && c->idle) {
242 c->idle = false;
243 mpd_glib_leave(c->source);
244 }
246 return c->connection;
247 }
249 void
250 mpdclient_put_connection(struct mpdclient *c)
251 {
252 assert(c->source == NULL || c->connection != NULL);
254 if (c->source != NULL && !c->idle) {
255 c->idle = mpd_glib_enter(c->source);
256 }
257 }
260 /****************************************************************************/
261 /*** MPD Commands **********************************************************/
262 /****************************************************************************/
264 bool
265 mpdclient_cmd_play(struct mpdclient *c, gint idx)
266 {
267 struct mpd_connection *connection = mpdclient_get_connection(c);
268 const struct mpd_song *song = playlist_get_song(&c->playlist, idx);
270 if (connection == NULL)
271 return false;
273 if (song)
274 mpd_send_play_id(connection, mpd_song_get_id(song));
275 else
276 mpd_send_play(connection);
278 return mpdclient_finish_command(c);
279 }
281 bool
282 mpdclient_cmd_crop(struct mpdclient *c)
283 {
284 struct mpd_connection *connection = mpdclient_get_connection(c);
285 struct mpd_status *status;
286 bool playing;
287 int length, current;
289 if (connection == NULL)
290 return false;
292 status = mpd_run_status(connection);
293 if (status == NULL)
294 return mpdclient_handle_error(c);
296 playing = mpd_status_get_state(status) == MPD_STATE_PLAY ||
297 mpd_status_get_state(status) == MPD_STATE_PAUSE;
298 length = mpd_status_get_queue_length(status);
299 current = mpd_status_get_song_pos(status);
301 mpd_status_free(status);
303 if (!playing || length < 2)
304 return true;
306 mpd_command_list_begin(connection, false);
308 while (--length >= 0)
309 if (length != current)
310 mpd_send_delete(connection, length);
312 mpd_command_list_end(connection);
314 return mpdclient_finish_command(c);
315 }
317 bool
318 mpdclient_cmd_clear(struct mpdclient *c)
319 {
320 struct mpd_connection *connection = mpdclient_get_connection(c);
321 bool retval;
323 if (connection == NULL)
324 return false;
326 mpd_send_clear(connection);
327 retval = mpdclient_finish_command(c);
329 if (retval)
330 c->events |= MPD_IDLE_PLAYLIST;
332 return retval;
333 }
335 bool
336 mpdclient_cmd_volume(struct mpdclient *c, gint value)
337 {
338 struct mpd_connection *connection = mpdclient_get_connection(c);
339 if (connection == NULL)
340 return false;
342 mpd_send_set_volume(connection, value);
343 return mpdclient_finish_command(c);
344 }
346 bool
347 mpdclient_cmd_volume_up(struct mpdclient *c)
348 {
349 struct mpd_connection *connection = mpdclient_get_connection(c);
350 if (connection == NULL)
351 return false;
353 if (c->status == NULL ||
354 mpd_status_get_volume(c->status) == -1)
355 return true;
357 if (c->volume < 0)
358 c->volume = mpd_status_get_volume(c->status);
360 if (c->volume >= 100)
361 return true;
363 return mpdclient_cmd_volume(c, ++c->volume);
364 }
366 bool
367 mpdclient_cmd_volume_down(struct mpdclient *c)
368 {
369 struct mpd_connection *connection = mpdclient_get_connection(c);
370 if (connection == NULL)
371 return false;
373 if (c->status == NULL || mpd_status_get_volume(c->status) < 0)
374 return true;
376 if (c->volume < 0)
377 c->volume = mpd_status_get_volume(c->status);
379 if (c->volume <= 0)
380 return true;
382 return mpdclient_cmd_volume(c, --c->volume);
383 }
385 bool
386 mpdclient_cmd_add_path(struct mpdclient *c, const gchar *path_utf8)
387 {
388 struct mpd_connection *connection = mpdclient_get_connection(c);
389 if (connection == NULL)
390 return false;
392 mpd_send_add(connection, path_utf8);
393 return mpdclient_finish_command(c);
394 }
396 bool
397 mpdclient_cmd_add(struct mpdclient *c, const struct mpd_song *song)
398 {
399 struct mpd_connection *connection = mpdclient_get_connection(c);
400 struct mpd_status *status;
401 struct mpd_song *new_song;
403 assert(c != NULL);
404 assert(song != NULL);
406 if (connection == NULL || c->status == NULL)
407 return false;
409 /* send the add command to mpd; at the same time, get the new
410 status (to verify the new playlist id) and the last song
411 (we hope that's the song we just added) */
413 if (!mpd_command_list_begin(connection, true) ||
414 !mpd_send_add(connection, mpd_song_get_uri(song)) ||
415 !mpd_send_status(connection) ||
416 !mpd_send_get_queue_song_pos(connection,
417 playlist_length(&c->playlist)) ||
418 !mpd_command_list_end(connection) ||
419 !mpd_response_next(connection))
420 return mpdclient_handle_error(c);
422 c->events |= MPD_IDLE_PLAYLIST;
424 status = mpd_recv_status(connection);
425 if (status != NULL) {
426 if (c->status != NULL)
427 mpd_status_free(c->status);
428 c->status = status;
429 }
431 if (!mpd_response_next(connection))
432 return mpdclient_handle_error(c);
434 new_song = mpd_recv_song(connection);
435 if (!mpd_response_finish(connection) || new_song == NULL) {
436 if (new_song != NULL)
437 mpd_song_free(new_song);
439 return mpd_connection_clear_error(connection) ||
440 mpdclient_handle_error(c);
441 }
443 if (mpd_status_get_queue_length(status) == playlist_length(&c->playlist) + 1 &&
444 mpd_status_get_queue_version(status) == c->playlist.version + 1) {
445 /* the cheap route: match on the new playlist length
446 and its version, we can keep our local playlist
447 copy in sync */
448 c->playlist.version = mpd_status_get_queue_version(status);
450 /* the song we just received has the correct id;
451 append it to the local playlist */
452 playlist_append(&c->playlist, new_song);
453 }
455 mpd_song_free(new_song);
457 return true;
458 }
460 bool
461 mpdclient_cmd_delete(struct mpdclient *c, gint idx)
462 {
463 struct mpd_connection *connection = mpdclient_get_connection(c);
464 const struct mpd_song *song;
465 struct mpd_status *status;
467 if (connection == NULL || c->status == NULL)
468 return false;
470 if (idx < 0 || (guint)idx >= playlist_length(&c->playlist))
471 return false;
473 song = playlist_get(&c->playlist, idx);
475 /* send the delete command to mpd; at the same time, get the
476 new status (to verify the playlist id) */
478 if (!mpd_command_list_begin(connection, false) ||
479 !mpd_send_delete_id(connection, mpd_song_get_id(song)) ||
480 !mpd_send_status(connection) ||
481 !mpd_command_list_end(connection))
482 return mpdclient_handle_error(c);
484 c->events |= MPD_IDLE_PLAYLIST;
486 status = mpd_recv_status(connection);
487 if (status != NULL) {
488 if (c->status != NULL)
489 mpd_status_free(c->status);
490 c->status = status;
491 }
493 if (!mpd_response_finish(connection))
494 return mpdclient_handle_error(c);
496 if (mpd_status_get_queue_length(status) == playlist_length(&c->playlist) - 1 &&
497 mpd_status_get_queue_version(status) == c->playlist.version + 1) {
498 /* the cheap route: match on the new playlist length
499 and its version, we can keep our local playlist
500 copy in sync */
501 c->playlist.version = mpd_status_get_queue_version(status);
503 /* remove the song from the local playlist */
504 playlist_remove(&c->playlist, idx);
506 /* remove references to the song */
507 if (c->song == song)
508 c->song = NULL;
509 }
511 return true;
512 }
514 /**
515 * Fallback for mpdclient_cmd_delete_range() on MPD older than 0.16.
516 * It emulates the "delete range" command with a list of simple
517 * "delete" commands.
518 */
519 static bool
520 mpdclient_cmd_delete_range_fallback(struct mpdclient *c,
521 unsigned start, unsigned end)
522 {
523 struct mpd_connection *connection = mpdclient_get_connection(c);
524 if (connection == NULL)
525 return false;
527 if (!mpd_command_list_begin(connection, false))
528 return mpdclient_handle_error(c);
530 for (; start < end; --end)
531 mpd_send_delete(connection, start);
533 if (!mpd_command_list_end(connection) ||
534 !mpd_response_finish(connection))
535 return mpdclient_handle_error(c);
537 return true;
538 }
540 bool
541 mpdclient_cmd_delete_range(struct mpdclient *c, unsigned start, unsigned end)
542 {
543 struct mpd_connection *connection;
544 struct mpd_status *status;
546 if (end == start + 1)
547 /* if that's not really a range, we choose to use the
548 safer "deleteid" version */
549 return mpdclient_cmd_delete(c, start);
551 connection = mpdclient_get_connection(c);
552 if (connection == NULL)
553 return false;
555 if (mpd_connection_cmp_server_version(connection, 0, 16, 0) < 0)
556 return mpdclient_cmd_delete_range_fallback(c, start, end);
558 /* MPD 0.16 supports "delete" with a range argument */
560 /* send the delete command to mpd; at the same time, get the
561 new status (to verify the playlist id) */
563 if (!mpd_command_list_begin(connection, false) ||
564 !mpd_send_delete_range(connection, start, end) ||
565 !mpd_send_status(connection) ||
566 !mpd_command_list_end(connection))
567 return mpdclient_handle_error(c);
569 c->events |= MPD_IDLE_PLAYLIST;
571 status = mpd_recv_status(connection);
572 if (status != NULL) {
573 if (c->status != NULL)
574 mpd_status_free(c->status);
575 c->status = status;
576 }
578 if (!mpd_response_finish(connection))
579 return mpdclient_handle_error(c);
581 if (mpd_status_get_queue_length(status) == playlist_length(&c->playlist) - (end - start) &&
582 mpd_status_get_queue_version(status) == c->playlist.version + 1) {
583 /* the cheap route: match on the new playlist length
584 and its version, we can keep our local playlist
585 copy in sync */
586 c->playlist.version = mpd_status_get_queue_version(status);
588 /* remove the song from the local playlist */
589 while (end > start) {
590 --end;
592 /* remove references to the song */
593 if (c->song == playlist_get(&c->playlist, end))
594 c->song = NULL;
596 playlist_remove(&c->playlist, end);
597 }
598 }
600 return true;
601 }
603 bool
604 mpdclient_cmd_move(struct mpdclient *c, gint old_index, gint new_index)
605 {
606 struct mpd_connection *connection = mpdclient_get_connection(c);
607 const struct mpd_song *song1, *song2;
608 struct mpd_status *status;
610 if (connection == NULL)
611 return false;
613 if (old_index == new_index || new_index < 0 ||
614 (guint)new_index >= c->playlist.list->len)
615 return false;
617 song1 = playlist_get(&c->playlist, old_index);
618 song2 = playlist_get(&c->playlist, new_index);
620 /* send the delete command to mpd; at the same time, get the
621 new status (to verify the playlist id) */
623 if (!mpd_command_list_begin(connection, false) ||
624 !mpd_send_swap_id(connection, mpd_song_get_id(song1),
625 mpd_song_get_id(song2)) ||
626 !mpd_send_status(connection) ||
627 !mpd_command_list_end(connection))
628 return mpdclient_handle_error(c);
630 c->events |= MPD_IDLE_PLAYLIST;
632 status = mpd_recv_status(connection);
633 if (status != NULL) {
634 if (c->status != NULL)
635 mpd_status_free(c->status);
636 c->status = status;
637 }
639 if (!mpd_response_finish(connection))
640 return mpdclient_handle_error(c);
642 if (mpd_status_get_queue_length(status) == playlist_length(&c->playlist) &&
643 mpd_status_get_queue_version(status) == c->playlist.version + 1) {
644 /* the cheap route: match on the new playlist length
645 and its version, we can keep our local playlist
646 copy in sync */
647 c->playlist.version = mpd_status_get_queue_version(status);
649 /* swap songs in the local playlist */
650 playlist_swap(&c->playlist, old_index, new_index);
651 }
653 return true;
654 }
657 /****************************************************************************/
658 /*** Playlist management functions ******************************************/
659 /****************************************************************************/
661 /* update playlist */
662 bool
663 mpdclient_playlist_update(struct mpdclient *c)
664 {
665 struct mpd_connection *connection = mpdclient_get_connection(c);
666 struct mpd_entity *entity;
668 if (connection == NULL)
669 return false;
671 playlist_clear(&c->playlist);
673 mpd_send_list_queue_meta(connection);
674 while ((entity = mpd_recv_entity(connection))) {
675 if (mpd_entity_get_type(entity) == MPD_ENTITY_TYPE_SONG)
676 playlist_append(&c->playlist, mpd_entity_get_song(entity));
678 mpd_entity_free(entity);
679 }
681 c->playlist.version = mpd_status_get_queue_version(c->status);
682 c->song = NULL;
684 return mpdclient_finish_command(c);
685 }
687 /* update playlist (plchanges) */
688 bool
689 mpdclient_playlist_update_changes(struct mpdclient *c)
690 {
691 struct mpd_connection *connection = mpdclient_get_connection(c);
692 struct mpd_song *song;
693 guint length;
695 if (connection == NULL)
696 return false;
698 mpd_send_queue_changes_meta(connection, c->playlist.version);
700 while ((song = mpd_recv_song(connection)) != NULL) {
701 int pos = mpd_song_get_pos(song);
703 if (pos >= 0 && (guint)pos < c->playlist.list->len) {
704 /* update song */
705 playlist_replace(&c->playlist, pos, song);
706 } else {
707 /* add a new song */
708 playlist_append(&c->playlist, song);
709 }
711 mpd_song_free(song);
712 }
714 /* remove trailing songs */
716 length = mpd_status_get_queue_length(c->status);
717 while (length < c->playlist.list->len) {
718 guint pos = c->playlist.list->len - 1;
720 /* Remove the last playlist entry */
721 playlist_remove(&c->playlist, pos);
722 }
724 c->song = NULL;
725 c->playlist.version = mpd_status_get_queue_version(c->status);
727 return mpdclient_finish_command(c);
728 }
731 /****************************************************************************/
732 /*** Filelist functions *****************************************************/
733 /****************************************************************************/
735 bool
736 mpdclient_filelist_add_all(struct mpdclient *c, struct filelist *fl)
737 {
738 struct mpd_connection *connection = mpdclient_get_connection(c);
739 guint i;
741 if (connection == NULL)
742 return false;
744 if (filelist_is_empty(fl))
745 return true;
747 mpd_command_list_begin(connection, false);
749 for (i = 0; i < filelist_length(fl); ++i) {
750 struct filelist_entry *entry = filelist_get(fl, i);
751 struct mpd_entity *entity = entry->entity;
753 if (entity != NULL &&
754 mpd_entity_get_type(entity) == MPD_ENTITY_TYPE_SONG) {
755 const struct mpd_song *song =
756 mpd_entity_get_song(entity);
758 mpd_send_add(connection, mpd_song_get_uri(song));
759 }
760 }
762 mpd_command_list_end(connection);
763 return mpdclient_finish_command(c);
764 }