status: store status fields seperately
[ncmpcpp.git] / src / mpdpp.cpp
blobdfaa765a2b6095401fea96c9c931019c3aa10b02
1 /***************************************************************************
2 * Copyright (C) 2008-2014 by Andrzej Rybczak *
3 * electricityispower@gmail.com *
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 *
16 * along with this program; if not, write to the *
17 * Free Software Foundation, Inc., *
18 * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA. *
19 ***************************************************************************/
21 #include <cassert>
22 #include <cstdlib>
23 #include <algorithm>
24 #include <map>
26 #include "charset.h"
27 #include "error.h"
28 #include "mpdpp.h"
30 MPD::Connection Mpd;
32 namespace MPD {//
34 Connection::Connection() : m_connection(nullptr),
35 m_command_list_active(false),
36 m_idle(false),
37 m_host("localhost"),
38 m_port(6600),
39 m_timeout(15)
43 Connection::~Connection()
45 if (m_connection)
46 mpd_connection_free(m_connection);
49 void Connection::Connect()
51 assert(!m_connection);
52 try
54 m_connection = mpd_connection_new(m_host.c_str(), m_port, m_timeout * 1000);
55 checkErrors();
56 if (!m_password.empty())
57 SendPassword();
58 m_fd = mpd_connection_get_fd(m_connection);
59 checkErrors();
61 catch (MPD::ClientError &e)
63 Disconnect();
64 throw e;
68 bool Connection::Connected() const
70 return m_connection;
73 void Connection::Disconnect()
75 if (m_connection)
76 mpd_connection_free(m_connection);
77 m_connection = nullptr;
78 m_command_list_active = false;
79 m_idle = false;
82 unsigned Connection::Version() const
84 return m_connection ? mpd_connection_get_server_version(m_connection)[1] : 0;
87 void Connection::SetHostname(const std::string &host)
89 size_t at = host.find("@");
90 if (at != std::string::npos)
92 m_password = host.substr(0, at);
93 m_host = host.substr(at+1);
95 else
96 m_host = host;
99 void Connection::SendPassword()
101 assert(m_connection);
102 noidle();
103 assert(!m_command_list_active);
104 mpd_run_password(m_connection, m_password.c_str());
105 checkErrors();
108 void Connection::idle()
110 checkConnection();
111 if (!m_idle)
113 mpd_send_idle(m_connection);
114 checkErrors();
116 m_idle = true;
119 int Connection::noidle()
121 checkConnection();
122 int flags = 0;
123 if (m_idle && mpd_send_noidle(m_connection))
125 m_idle = false;
126 flags = mpd_recv_idle(m_connection, true);
127 mpd_response_finish(m_connection);
128 checkErrors();
130 return flags;
133 Statistics Connection::getStatistics()
135 prechecks();
136 mpd_stats *stats = mpd_run_stats(m_connection);
137 checkErrors();
138 return Statistics(stats);
141 Status Connection::getStatus()
143 prechecks();
144 mpd_status *status = mpd_run_status(m_connection);
145 checkErrors();
146 return Status(status);
149 void Connection::UpdateDirectory(const std::string &path)
151 prechecksNoCommandsList();
152 mpd_run_update(m_connection, path.c_str());
153 checkErrors();
156 void Connection::Play()
158 prechecksNoCommandsList();
159 mpd_run_play(m_connection);
160 checkErrors();
163 void Connection::Play(int pos)
165 prechecksNoCommandsList();
166 mpd_run_play_pos(m_connection, pos);
167 checkErrors();
170 void Connection::PlayID(int id)
172 prechecksNoCommandsList();
173 mpd_run_play_id(m_connection, id);
174 checkErrors();
177 void Connection::Pause(bool state)
179 prechecksNoCommandsList();
180 mpd_run_pause(m_connection, state);
181 checkErrors();
184 void Connection::Toggle()
186 prechecksNoCommandsList();
187 mpd_run_toggle_pause(m_connection);
188 checkErrors();
191 void Connection::Stop()
193 prechecksNoCommandsList();
194 mpd_run_stop(m_connection);
195 checkErrors();
198 void Connection::Next()
200 prechecksNoCommandsList();
201 mpd_run_next(m_connection);
202 checkErrors();
205 void Connection::Prev()
207 prechecksNoCommandsList();
208 mpd_run_previous(m_connection);
209 checkErrors();
212 void Connection::Move(unsigned from, unsigned to)
214 prechecks();
215 if (m_command_list_active)
216 mpd_send_move(m_connection, from, to);
217 else
219 mpd_run_move(m_connection, from, to);
220 checkErrors();
224 void Connection::Swap(unsigned from, unsigned to)
226 prechecks();
227 if (m_command_list_active)
228 mpd_send_swap(m_connection, from, to);
229 else
231 mpd_run_swap(m_connection, from, to);
232 checkErrors();
236 void Connection::Seek(unsigned pos, unsigned where)
238 prechecksNoCommandsList();
239 mpd_run_seek_pos(m_connection, pos, where);
240 checkErrors();
243 void Connection::Shuffle()
245 prechecksNoCommandsList();
246 mpd_run_shuffle(m_connection);
247 checkErrors();
250 void Connection::ClearMainPlaylist()
252 prechecksNoCommandsList();
253 mpd_run_clear(m_connection);
254 checkErrors();
257 void Connection::ClearPlaylist(const std::string &playlist)
259 prechecksNoCommandsList();
260 mpd_run_playlist_clear(m_connection, playlist.c_str());
261 checkErrors();
264 void Connection::AddToPlaylist(const std::string &path, const Song &s)
266 AddToPlaylist(path, s.getURI());
269 void Connection::AddToPlaylist(const std::string &path, const std::string &file)
271 prechecks();
272 if (m_command_list_active)
273 mpd_send_playlist_add(m_connection, path.c_str(), file.c_str());
274 else
276 mpd_run_playlist_add(m_connection, path.c_str(), file.c_str());
277 checkErrors();
281 void Connection::PlaylistMove(const std::string &path, int from, int to)
283 prechecks();
284 if (m_command_list_active)
285 mpd_send_playlist_move(m_connection, path.c_str(), from, to);
286 else
288 mpd_send_playlist_move(m_connection, path.c_str(), from, to);
289 mpd_response_finish(m_connection);
290 checkErrors();
294 void Connection::Rename(const std::string &from, const std::string &to)
296 prechecksNoCommandsList();
297 mpd_run_rename(m_connection, from.c_str(), to.c_str());
298 checkErrors();
301 void Connection::GetPlaylistChanges(unsigned version, SongConsumer f)
303 prechecksNoCommandsList();
304 mpd_send_queue_changes_meta(m_connection, version);
305 while (mpd_song *s = mpd_recv_song(m_connection))
306 f(Song(s));
307 mpd_response_finish(m_connection);
308 checkErrors();
311 Song Connection::GetSong(const std::string &path)
313 prechecksNoCommandsList();
314 mpd_send_list_all_meta(m_connection, path.c_str());
315 mpd_song *s = mpd_recv_song(m_connection);
316 mpd_response_finish(m_connection);
317 checkErrors();
318 return Song(s);
321 void Connection::GetPlaylistContent(const std::string &path, SongConsumer f)
323 prechecksNoCommandsList();
324 mpd_send_list_playlist_meta(m_connection, path.c_str());
325 while (mpd_song *s = mpd_recv_song(m_connection))
326 f(Song(s));
327 mpd_response_finish(m_connection);
328 checkErrors();
331 void Connection::GetPlaylistContentNoInfo(const std::string &path, SongConsumer f)
333 prechecksNoCommandsList();
334 mpd_send_list_playlist(m_connection, path.c_str());
335 while (mpd_song *s = mpd_recv_song(m_connection))
336 f(Song(s));
337 mpd_response_finish(m_connection);
338 checkErrors();
341 void Connection::GetSupportedExtensions(std::set<std::string> &acc)
343 prechecksNoCommandsList();
344 mpd_send_command(m_connection, "decoders", NULL);
345 while (mpd_pair *pair = mpd_recv_pair_named(m_connection, "suffix"))
347 acc.insert(pair->value);
348 mpd_return_pair(m_connection, pair);
350 mpd_response_finish(m_connection);
351 checkErrors();
354 void Connection::SetRepeat(bool mode)
356 prechecksNoCommandsList();
357 mpd_run_repeat(m_connection, mode);
358 checkErrors();
361 void Connection::SetRandom(bool mode)
363 prechecksNoCommandsList();
364 mpd_run_random(m_connection, mode);
365 checkErrors();
368 void Connection::SetSingle(bool mode)
370 prechecksNoCommandsList();
371 mpd_run_single(m_connection, mode);
372 checkErrors();
375 void Connection::SetConsume(bool mode)
377 prechecksNoCommandsList();
378 mpd_run_consume(m_connection, mode);
379 checkErrors();
382 void Connection::SetVolume(unsigned vol)
384 prechecksNoCommandsList();
385 mpd_run_set_volume(m_connection, vol);
386 checkErrors();
389 std::string Connection::GetReplayGainMode()
391 prechecksNoCommandsList();
392 mpd_send_command(m_connection, "replay_gain_status", NULL);
393 std::string result;
394 if (mpd_pair *pair = mpd_recv_pair_named(m_connection, "replay_gain_mode"))
396 result = pair->value;
397 mpd_return_pair(m_connection, pair);
399 mpd_response_finish(m_connection);
400 checkErrors();
401 return result;
404 void Connection::SetReplayGainMode(ReplayGainMode mode)
406 prechecksNoCommandsList();
407 const char *rg_mode;
408 switch (mode)
410 case rgmOff:
411 rg_mode = "off";
412 break;
413 case rgmTrack:
414 rg_mode = "track";
415 break;
416 case rgmAlbum:
417 rg_mode = "album";
418 break;
419 default:
420 rg_mode = "";
421 break;
423 mpd_send_command(m_connection, "replay_gain_mode", rg_mode, NULL);
424 mpd_response_finish(m_connection);
425 checkErrors();
428 void Connection::SetCrossfade(unsigned crossfade)
430 prechecksNoCommandsList();
431 mpd_run_crossfade(m_connection, crossfade);
432 checkErrors();
435 void Connection::SetPriority(const Song &s, int prio)
437 prechecks();
438 if (m_command_list_active)
439 mpd_send_prio_id(m_connection, prio, s.getID());
440 else
442 mpd_run_prio_id(m_connection, prio, s.getID());
443 checkErrors();
447 int Connection::AddSong(const std::string &path, int pos)
449 prechecks();
450 int id;
451 if (pos < 0)
452 mpd_send_add_id(m_connection, path.c_str());
453 else
454 mpd_send_add_id_to(m_connection, path.c_str(), pos);
455 if (!m_command_list_active)
457 id = mpd_recv_song_id(m_connection);
458 mpd_response_finish(m_connection);
459 checkErrors();
461 else
462 id = 0;
463 return id;
466 int Connection::AddSong(const Song &s, int pos)
468 return AddSong((!s.isFromDatabase() ? "file://" : "") + s.getURI(), pos);
471 void Connection::Add(const std::string &path)
473 prechecks();
474 if (m_command_list_active)
475 mpd_send_add(m_connection, path.c_str());
476 else
478 mpd_run_add(m_connection, path.c_str());
479 checkErrors();
483 bool Connection::AddRandomTag(mpd_tag_type tag, size_t number)
485 StringList tags;
486 GetList(tag, [&tags](std::string tag_name) {
487 tags.push_back(tag_name);
489 if (number > tags.size())
491 //if (itsErrorHandler)
492 // itsErrorHandler(this, 0, "Requested number is out of range", itsErrorHandlerUserdata);
493 return false;
495 else
497 std::random_shuffle(tags.begin(), tags.end());
498 auto it = tags.begin()+rand()%(tags.size()-number);
499 for (size_t i = 0; i < number && it != tags.end(); ++i)
501 StartSearch(1);
502 AddSearch(tag, *it++);
503 SongList songs;
504 CommitSearchSongs([&songs](MPD::Song s) {
505 songs.push_back(s);
507 StartCommandsList();
508 for (auto s = songs.begin(); s != songs.end(); ++s)
509 AddSong(*s);
510 CommitCommandsList();
513 return true;
516 bool Connection::AddRandomSongs(size_t number)
518 prechecksNoCommandsList();
519 StringList files;
520 mpd_send_list_all(m_connection, "/");
521 while (mpd_pair *item = mpd_recv_pair_named(m_connection, "file"))
523 files.push_back(item->value);
524 mpd_return_pair(m_connection, item);
526 mpd_response_finish(m_connection);
527 checkErrors();
529 if (number > files.size())
531 //if (itsErrorHandler)
532 // itsErrorHandler(this, 0, "Requested number of random songs is bigger than size of your library", itsErrorHandlerUserdata);
533 return false;
535 else
537 std::random_shuffle(files.begin(), files.end());
538 StartCommandsList();
539 auto it = files.begin()+rand()%(std::max(size_t(1), files.size()-number));
540 for (size_t i = 0; i < number && it != files.end(); ++i, ++it)
541 AddSong(*it);
542 CommitCommandsList();
544 return true;
547 void Connection::Delete(unsigned pos)
549 prechecks();
550 mpd_send_delete(m_connection, pos);
551 if (!m_command_list_active)
553 mpd_response_finish(m_connection);
554 checkErrors();
558 void Connection::PlaylistDelete(const std::string &playlist, unsigned pos)
560 prechecks();
561 mpd_send_playlist_delete(m_connection, playlist.c_str(), pos);
562 if (!m_command_list_active)
564 mpd_response_finish(m_connection);
565 checkErrors();
569 void Connection::StartCommandsList()
571 prechecksNoCommandsList();
572 mpd_command_list_begin(m_connection, true);
573 m_command_list_active = true;
574 checkErrors();
577 void Connection::CommitCommandsList()
579 prechecks();
580 assert(m_command_list_active);
581 mpd_command_list_end(m_connection);
582 mpd_response_finish(m_connection);
583 m_command_list_active = false;
584 checkErrors();
587 void Connection::DeletePlaylist(const std::string &name)
589 prechecksNoCommandsList();
590 mpd_run_rm(m_connection, name.c_str());
591 checkErrors();
594 void Connection::LoadPlaylist(const std::string &name)
596 prechecksNoCommandsList();
597 mpd_run_load(m_connection, name.c_str());
598 checkErrors();
601 void Connection::SavePlaylist(const std::string &name)
603 prechecksNoCommandsList();
604 mpd_send_save(m_connection, name.c_str());
605 mpd_response_finish(m_connection);
606 checkErrors();
609 void Connection::GetPlaylists(StringConsumer f)
611 GetDirectory("/", [&f](Item &&item) {
612 if (item.type == itPlaylist)
613 f(std::move(item.name));
617 void Connection::GetList(mpd_tag_type type, StringConsumer f)
619 prechecksNoCommandsList();
620 mpd_search_db_tags(m_connection, type);
621 mpd_search_commit(m_connection);
622 while (mpd_pair *item = mpd_recv_pair_tag(m_connection, type))
624 f(std::string(item->value));
625 mpd_return_pair(m_connection, item);
627 mpd_response_finish(m_connection);
628 checkErrors();
631 void Connection::StartSearch(bool exact_match)
633 prechecksNoCommandsList();
634 mpd_search_db_songs(m_connection, exact_match);
637 void Connection::StartFieldSearch(mpd_tag_type item)
639 prechecksNoCommandsList();
640 mpd_search_db_tags(m_connection, item);
643 void Connection::AddSearch(mpd_tag_type item, const std::string &str) const
645 checkConnection();
646 mpd_search_add_tag_constraint(m_connection, MPD_OPERATOR_DEFAULT, item, str.c_str());
649 void Connection::AddSearchAny(const std::string &str) const
651 checkConnection();
652 mpd_search_add_any_tag_constraint(m_connection, MPD_OPERATOR_DEFAULT, str.c_str());
655 void Connection::AddSearchURI(const std::string &str) const
657 checkConnection();
658 mpd_search_add_uri_constraint(m_connection, MPD_OPERATOR_DEFAULT, str.c_str());
661 void Connection::CommitSearchSongs(SongConsumer f)
663 prechecksNoCommandsList();
664 mpd_search_commit(m_connection);
665 while (mpd_song *s = mpd_recv_song(m_connection))
666 f(Song(s));
667 mpd_response_finish(m_connection);
668 checkErrors();
671 void Connection::CommitSearchTags(StringConsumer f)
673 prechecksNoCommandsList();
674 mpd_search_commit(m_connection);
675 while (mpd_pair *tag = mpd_recv_pair_tag(m_connection, m_searched_field))
677 f(std::string(tag->value));
678 mpd_return_pair(m_connection, tag);
680 mpd_response_finish(m_connection);
681 checkErrors();
684 void Connection::GetDirectory(const std::string &directory, ItemConsumer f)
686 prechecksNoCommandsList();
687 mpd_send_list_meta(m_connection, directory.c_str());
688 while (mpd_entity *item = mpd_recv_entity(m_connection))
690 Item it;
691 switch (mpd_entity_get_type(item))
693 case MPD_ENTITY_TYPE_DIRECTORY:
694 it.name = mpd_directory_get_path(mpd_entity_get_directory(item));
695 it.type = itDirectory;
696 break;
697 case MPD_ENTITY_TYPE_SONG:
698 it.song = std::make_shared<Song>(Song(mpd_song_dup(mpd_entity_get_song(item))));
699 it.type = itSong;
700 break;
701 case MPD_ENTITY_TYPE_PLAYLIST:
702 it.name = mpd_playlist_get_path(mpd_entity_get_playlist(item));
703 it.type = itPlaylist;
704 break;
705 default:
706 assert(false);
708 mpd_entity_free(item);
709 f(std::move(it));
711 mpd_response_finish(m_connection);
712 checkErrors();
715 void Connection::GetDirectoryRecursive(const std::string &directory, SongConsumer f)
717 prechecksNoCommandsList();
718 mpd_send_list_all_meta(m_connection, directory.c_str());
719 while (mpd_entity *e = mpd_recv_entity(m_connection)) {
720 if (mpd_entity_get_type(e) == MPD_ENTITY_TYPE_SONG)
721 f(Song(mpd_song_dup(mpd_entity_get_song(e))));
722 mpd_entity_free(e);
724 mpd_response_finish(m_connection);
725 checkErrors();
728 void Connection::GetDirectories(const std::string &directory, StringConsumer f)
730 prechecksNoCommandsList();
731 mpd_send_list_meta(m_connection, directory.c_str());
732 while (mpd_directory *dir = mpd_recv_directory(m_connection))
734 f(std::string(mpd_directory_get_path(dir)));
735 mpd_directory_free(dir);
737 mpd_response_finish(m_connection);
738 checkErrors();
741 void Connection::GetSongs(const std::string &directory, SongConsumer f)
743 prechecksNoCommandsList();
744 mpd_send_list_meta(m_connection, directory.c_str());
745 while (mpd_song *s = mpd_recv_song(m_connection))
746 f(Song(s));
747 mpd_response_finish(m_connection);
748 checkErrors();
751 void Connection::GetOutputs(OutputConsumer f)
753 prechecksNoCommandsList();
754 mpd_send_outputs(m_connection);
755 while (mpd_output *output = mpd_recv_output(m_connection))
757 f(Output(mpd_output_get_name(output), mpd_output_get_enabled(output)));
758 mpd_output_free(output);
760 mpd_response_finish(m_connection);
761 checkErrors();
764 void Connection::EnableOutput(int id)
766 prechecksNoCommandsList();
767 mpd_run_enable_output(m_connection, id);
768 checkErrors();
771 void Connection::DisableOutput(int id)
773 prechecksNoCommandsList();
774 mpd_run_disable_output(m_connection, id);
775 checkErrors();
778 void Connection::GetURLHandlers(StringConsumer f)
780 prechecksNoCommandsList();
781 mpd_send_list_url_schemes(m_connection);
782 while (mpd_pair *handler = mpd_recv_pair_named(m_connection, "handler"))
784 f(std::string(handler->value));
785 mpd_return_pair(m_connection, handler);
787 mpd_response_finish(m_connection);
788 checkErrors();
791 void Connection::GetTagTypes(StringConsumer f)
794 prechecksNoCommandsList();
795 mpd_send_list_tag_types(m_connection);
796 while (mpd_pair *tag_type = mpd_recv_pair_named(m_connection, "tagtype"))
798 f(std::string(tag_type->value));
799 mpd_return_pair(m_connection, tag_type);
801 mpd_response_finish(m_connection);
802 checkErrors();
805 void Connection::checkConnection() const
807 if (!m_connection)
808 throw ClientError(MPD_ERROR_STATE, "No active MPD connection", false);
811 void Connection::prechecks()
813 checkConnection();
814 noidle();
817 void Connection::prechecksNoCommandsList()
819 assert(!m_command_list_active);
820 prechecks();
823 void Connection::checkErrors() const
825 mpd_error code = mpd_connection_get_error(m_connection);
826 if (code != MPD_ERROR_SUCCESS)
828 std::string msg = mpd_connection_get_error_message(m_connection);
829 if (code == MPD_ERROR_SERVER)
831 mpd_server_error server_code = mpd_connection_get_server_error(m_connection);
832 bool clearable = mpd_connection_clear_error(m_connection);
833 throw ServerError(server_code, msg, clearable);
835 else
837 bool clearable = mpd_connection_clear_error(m_connection);
838 throw ClientError(code, msg, clearable);