status: make idle events handling independent of the order of their arrival
[ncmpcpp.git] / src / status.cpp
blob1ceb3b76fbdd2dd336fd5e5311443c71dbd98b49
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 <boost/date_time/posix_time/posix_time.hpp>
23 #include "browser.h"
24 #include "charset.h"
25 #include "global.h"
26 #include "helpers.h"
27 #include "lyrics.h"
28 #include "media_library.h"
29 #include "outputs.h"
30 #include "playlist.h"
31 #include "playlist_editor.h"
32 #include "search_engine.h"
33 #include "sel_items_adder.h"
34 #include "settings.h"
35 #include "status.h"
36 #include "statusbar.h"
37 #include "tag_editor.h"
38 #include "visualizer.h"
39 #include "title.h"
40 #include "utility/string.h"
42 using Global::myScreen;
44 using Global::wFooter;
45 using Global::wHeader;
47 using Global::Timer;
48 using Global::VolumeState;
50 namespace {//
52 boost::posix_time::ptime past = boost::posix_time::from_time_t(0);
54 size_t playing_song_scroll_begin = 0;
55 size_t first_line_scroll_begin = 0;
56 size_t second_line_scroll_begin = 0;
58 MPD::Status m_status;
60 // local copies of these are needed to be independent
61 // of the order of idle events incoming from MPD.
62 char m_repeat = 0;
63 char m_random = 0;
64 char m_single = 0;
65 char m_consume = 0;
66 char m_crossfade = 0;
67 char m_db_updating = 0;
68 int m_current_song_id = 0;
69 unsigned m_playlist_version = 0;
71 void drawTitle(const MPD::Song &np)
73 assert(!np.empty());
74 windowTitle(np.toString(Config.song_window_title_format, Config.tags_separator));
77 std::string playerStateToString(MPD::PlayerState ps)
79 std::string result;
80 switch (ps)
82 case MPD::psUnknown:
83 result = "[unknown]";
84 break;
85 case MPD::psPlay:
86 if (Config.design == Design::Alternative)
87 result = "[playing]";
88 else
89 result = "Playing: ";
90 break;
91 case MPD::psPause:
92 if (Config.design == Design::Alternative)
93 result = "[paused] ";
94 else
95 result = "[Paused] ";
96 break;
97 case MPD::psStop:
98 if (Config.design == Design::Alternative)
99 result = "[stopped]";
100 break;
101 default:
102 break;
104 return result;
109 void Status::handleClientError(MPD::ClientError &e)
111 if (!e.clearable())
112 Mpd.Disconnect();
113 Statusbar::printf("ncmpcpp: %1%", e.what());
116 void Status::handleServerError(MPD::ServerError &e)
118 if (e.code() == MPD_SERVER_ERROR_PERMISSION)
120 wFooter->setGetStringHelper(nullptr);
121 Statusbar::put() << "Password: ";
122 Mpd.SetPassword(wFooter->getString(0, true));
123 Mpd.SendPassword();
124 Statusbar::print("Password accepted");
125 wFooter->setGetStringHelper(Statusbar::Helpers::getString);
127 else if (e.code() == MPD_SERVER_ERROR_NO_EXIST && myScreen == myBrowser)
129 myBrowser->GetDirectory(getParentDirectory(myBrowser->CurrentDir()));
130 myBrowser->refresh();
132 Statusbar::printf("MPD: %1%", e.what());
135 /*************************************************************************/
137 void Status::trace(bool update_timer, bool update_window_timeout)
139 if (update_timer)
140 Timer = boost::posix_time::microsec_clock::local_time();
141 if (Mpd.Connected())
143 if (m_status.playerState() == MPD::psPlay
144 && Global::Timer - past > boost::posix_time::seconds(1))
146 // update elapsed time/bitrate of the current song
147 Status::Changes::elapsedTime(true);
148 wFooter->refresh();
149 past = Timer;
152 applyToVisibleWindows(&BaseScreen::update);
153 Statusbar::tryRedraw();
155 if (update_window_timeout)
157 // set appropriate window timeout
158 int nc_wtimeout = std::numeric_limits<int>::max();
159 applyToVisibleWindows([&nc_wtimeout](BaseScreen *s) {
160 nc_wtimeout = std::min(nc_wtimeout, s->windowTimeout());
162 wFooter->setTimeout(nc_wtimeout);
165 Mpd.idle();
169 void Status::update(int event)
171 MPD::Status old_status = m_status;
172 m_status = Mpd.getStatus();
174 if (event & MPD_IDLE_DATABASE)
175 Changes::database();
176 if (event & MPD_IDLE_STORED_PLAYLIST)
177 Changes::storedPlaylists();
178 if (event & MPD_IDLE_PLAYLIST)
180 Changes::playlist(m_playlist_version);
181 m_playlist_version = m_status.playlistVersion();
183 if (event & MPD_IDLE_PLAYER)
185 Changes::playerState();
186 if (m_current_song_id != m_status.currentSongID())
188 Changes::songID();
189 m_current_song_id = m_status.currentSongID();
192 if (event & MPD_IDLE_MIXER)
193 Changes::mixer();
194 if (event & MPD_IDLE_OUTPUT)
195 Changes::outputs();
196 if (event & (MPD_IDLE_UPDATE | MPD_IDLE_OPTIONS))
198 bool show_msg = !old_status.empty();
199 if (event & MPD_IDLE_UPDATE)
200 Changes::dbUpdateState(show_msg);
201 if (event & MPD_IDLE_OPTIONS)
203 if (('r' == m_repeat) != m_status.repeat())
204 Changes::repeat(show_msg);
205 if (('z' == m_random) != m_status.random())
206 Changes::random(show_msg);
207 if (('s' == m_single) != m_status.single())
208 Changes::single(show_msg);
209 if (('c' == m_consume) != m_status.consume())
210 Changes::consume(show_msg);
211 if (('x' == m_crossfade) != m_status.crossfade())
212 Changes::crossfade(show_msg);
214 Changes::flags();
217 if (event & MPD_IDLE_PLAYER)
218 wFooter->refresh();
220 if (event & (MPD_IDLE_PLAYLIST | MPD_IDLE_DATABASE | MPD_IDLE_PLAYER))
221 applyToVisibleWindows(&BaseScreen::refreshWindow);
224 void Status::clear()
226 // reset local variables
227 m_status.clear();
228 m_repeat = 0;
229 m_random = 0;
230 m_single = 0;
231 m_consume = 0;
232 m_crossfade = 0;
233 m_db_updating = 0;
234 m_current_song_id = 0;
235 m_playlist_version = 0;
238 const MPD::Status &Status::get()
240 return m_status;
243 /*************************************************************************/
245 void Status::Changes::playlist(unsigned previous_version)
247 myPlaylist->main().clearSearchResults();
248 withUnfilteredMenuReapplyFilter(myPlaylist->main(), [previous_version]() {
249 size_t playlist_length = m_status.playlistLength();
250 if (playlist_length < myPlaylist->main().size())
252 auto it = myPlaylist->main().begin()+playlist_length;
253 auto end = myPlaylist->main().end();
254 for (; it != end; ++it)
255 myPlaylist->unregisterSong(it->value());
256 myPlaylist->main().resizeList(playlist_length);
259 Mpd.GetPlaylistChanges(previous_version, [](MPD::Song s) {
260 size_t pos = s.getPosition();
261 if (pos < myPlaylist->main().size())
263 // if song's already in playlist, replace it with a new one
264 MPD::Song &old_s = myPlaylist->main()[pos].value();
265 myPlaylist->unregisterSong(old_s);
266 old_s = s;
268 else // otherwise just add it to playlist
269 myPlaylist->main().addItem(s);
270 myPlaylist->registerSong(s);
274 if (m_status.playerState() != MPD::psStop)
275 drawTitle(myPlaylist->nowPlayingSong());
277 myPlaylist->reloadTotalLength();
278 myPlaylist->reloadRemaining();
280 if (isVisible(myBrowser))
281 markSongsInPlaylist(myBrowser->proxySongList());
282 if (isVisible(mySearcher))
283 markSongsInPlaylist(mySearcher->proxySongList());
284 if (isVisible(myLibrary))
286 markSongsInPlaylist(myLibrary->songsProxyList());
287 myLibrary->Songs.refresh();
289 if (isVisible(myPlaylistEditor))
291 markSongsInPlaylist(myPlaylistEditor->contentProxyList());
292 myPlaylistEditor->Content.refresh();
296 void Status::Changes::storedPlaylists()
298 myPlaylistEditor->requestPlaylistsUpdate();
299 myPlaylistEditor->requestContentsUpdate();
300 if (myBrowser->CurrentDir() == "/")
302 myBrowser->GetDirectory("/");
303 if (isVisible(myBrowser))
304 myBrowser->refresh();
308 void Status::Changes::database()
310 if (isVisible(myBrowser))
311 myBrowser->GetDirectory(myBrowser->CurrentDir());
312 else
313 myBrowser->main().clear();
314 # ifdef HAVE_TAGLIB_H
315 myTagEditor->Dirs->clear();
316 # endif // HAVE_TAGLIB_H
317 myLibrary->requestTagsUpdate();
318 myLibrary->requestAlbumsUpdate();
319 myLibrary->requestSongsUpdate();
322 void Status::Changes::playerState()
324 switch (m_status.playerState())
326 case MPD::psPlay:
327 drawTitle(myPlaylist->nowPlayingSong());
328 myPlaylist->reloadRemaining();
329 break;
330 case MPD::psStop:
331 windowTitle("ncmpcpp " VERSION);
332 if (Progressbar::isUnlocked())
333 Progressbar::draw(0, 0);
334 myPlaylist->reloadRemaining();
335 if (Config.design == Design::Alternative)
337 *wHeader << NC::XY(0, 0) << wclrtoeol << NC::XY(0, 1) << wclrtoeol;
338 mixer();
339 flags();
341 # ifdef ENABLE_VISUALIZER
342 if (isVisible(myVisualizer))
343 myVisualizer->main().clear();
344 # endif // ENABLE_VISUALIZER
345 break;
346 default:
347 break;
350 std::string state = playerStateToString(m_status.playerState());
351 if (Config.design == Design::Alternative)
353 *wHeader << NC::XY(0, 1) << NC::Format::Bold << state << NC::Format::NoBold;
354 wHeader->refresh();
356 else if (Statusbar::isUnlocked() && Config.statusbar_visibility)
358 *wFooter << NC::XY(0, 1);
359 if (state.empty())
360 *wFooter << wclrtoeol;
361 else
362 *wFooter << NC::Format::Bold << state << NC::Format::NoBold;
365 // needed for immediate display after starting
366 // player from stopped state or seeking
367 elapsedTime(false);
370 void Status::Changes::songID()
372 // update information about current song
373 myPlaylist->reloadRemaining();
374 playing_song_scroll_begin = 0;
375 first_line_scroll_begin = 0;
376 second_line_scroll_begin = 0;
377 if (m_status.playerState() != MPD::psStop)
379 GNUC_UNUSED int res;
380 if (!Config.execute_on_song_change.empty())
381 res = system(Config.execute_on_song_change.c_str());
383 # ifdef HAVE_CURL_CURL_H
384 if (Config.fetch_lyrics_in_background)
385 Lyrics::DownloadInBackground(myPlaylist->nowPlayingSong());
386 # endif // HAVE_CURL_CURL_H
388 drawTitle(myPlaylist->nowPlayingSong());
390 if (Config.autocenter_mode && !myPlaylist->main().isFiltered())
391 myPlaylist->main().highlight(Status::get().currentSongPosition());
393 if (Config.now_playing_lyrics && isVisible(myLyrics) && myLyrics->previousScreen() == myPlaylist)
394 myLyrics->ReloadNP = 1;
396 elapsedTime(false);
399 void Status::Changes::elapsedTime(bool update_elapsed)
401 if (update_elapsed)
402 m_status = Mpd.getStatus();
403 const auto &st = m_status;
405 if (st.playerState() == MPD::psStop)
407 if (Statusbar::isUnlocked() && Config.statusbar_visibility)
408 *wFooter << NC::XY(0, 1) << wclrtoeol;
409 return;
412 std::string ps = playerStateToString(st.playerState());
413 MPD::Song np = myPlaylist->nowPlayingSong();
414 drawTitle(np);
416 std::string tracklength;
417 switch (Config.design)
419 case Design::Classic:
420 if (Statusbar::isUnlocked() && Config.statusbar_visibility)
422 if (Config.display_bitrate && st.kbps())
424 tracklength += " [";
425 tracklength += boost::lexical_cast<std::string>(st.kbps());
426 tracklength += " kbps]";
428 tracklength += " [";
429 if (st.totalTime())
431 if (Config.display_remaining_time)
433 tracklength += "-";
434 tracklength += MPD::Song::ShowTime(st.totalTime()-st.elapsedTime());
436 else
437 tracklength += MPD::Song::ShowTime(st.elapsedTime());
438 tracklength += "/";
439 tracklength += MPD::Song::ShowTime(st.totalTime());
440 tracklength += "]";
442 else
444 tracklength += MPD::Song::ShowTime(st.elapsedTime());
445 tracklength += "]";
447 NC::WBuffer np_song;
448 stringToBuffer(ToWString(Charset::utf8ToLocale(np.toString(Config.song_status_format, Config.tags_separator, "$"))), np_song);
449 *wFooter << NC::XY(0, 1) << wclrtoeol << NC::Format::Bold << ps << NC::Format::NoBold;
450 writeCyclicBuffer(np_song, *wFooter, playing_song_scroll_begin, wFooter->getWidth()-ps.length()-tracklength.length(), L" ** ");
451 *wFooter << NC::Format::Bold << NC::XY(wFooter->getWidth()-tracklength.length(), 1) << tracklength << NC::Format::NoBold;
453 break;
454 case Design::Alternative:
455 if (Config.display_remaining_time)
457 tracklength = "-";
458 tracklength += MPD::Song::ShowTime(st.totalTime()-st.elapsedTime());
460 else
461 tracklength = MPD::Song::ShowTime(st.elapsedTime());
462 if (st.totalTime())
464 tracklength += "/";
465 tracklength += MPD::Song::ShowTime(st.totalTime());
467 // bitrate here doesn't look good, but it can be moved somewhere else later
468 if (Config.display_bitrate && st.kbps())
470 tracklength += " ";
471 tracklength += boost::lexical_cast<std::string>(st.kbps());
472 tracklength += " kbps";
475 NC::WBuffer first, second;
476 stringToBuffer(ToWString(Charset::utf8ToLocale(np.toString(Config.new_header_first_line, Config.tags_separator, "$"))), first);
477 stringToBuffer(ToWString(Charset::utf8ToLocale(np.toString(Config.new_header_second_line, Config.tags_separator, "$"))), second);
479 size_t first_len = wideLength(first.str());
480 size_t first_margin = (std::max(tracklength.length()+1, VolumeState.length()))*2;
481 size_t first_start = first_len < COLS-first_margin ? (COLS-first_len)/2 : tracklength.length()+1;
483 size_t second_len = wideLength(second.str());
484 size_t second_margin = (std::max(ps.length(), size_t(8))+1)*2;
485 size_t second_start = second_len < COLS-second_margin ? (COLS-second_len)/2 : ps.length()+1;
487 if (!Global::SeekingInProgress)
488 *wHeader << NC::XY(0, 0) << wclrtoeol << tracklength;
489 *wHeader << NC::XY(first_start, 0);
490 writeCyclicBuffer(first, *wHeader, first_line_scroll_begin, COLS-tracklength.length()-VolumeState.length()-1, L" ** ");
492 *wHeader << NC::XY(0, 1) << wclrtoeol << NC::Format::Bold << ps << NC::Format::NoBold;
493 *wHeader << NC::XY(second_start, 1);
494 writeCyclicBuffer(second, *wHeader, second_line_scroll_begin, COLS-ps.length()-8-2, L" ** ");
496 *wHeader << NC::XY(wHeader->getWidth()-VolumeState.length(), 0) << Config.volume_color << VolumeState << NC::Color::End;
498 flags();
500 if (Progressbar::isUnlocked())
501 Progressbar::draw(st.elapsedTime(), st.totalTime());
504 void Status::Changes::repeat(bool show_msg)
506 m_repeat = m_status.repeat() ? 'r' : 0;
507 if (show_msg)
508 Statusbar::printf("Repeat mode is %1%", !m_repeat ? "off" : "on");
511 void Status::Changes::random(bool show_msg)
513 m_random = m_status.random() ? 'z' : 0;
514 if (show_msg)
515 Statusbar::printf("Random mode is %1%", !m_random ? "off" : "on");
518 void Status::Changes::single(bool show_msg)
520 m_single = m_status.single() ? 's' : 0;
521 if (show_msg)
522 Statusbar::printf("Single mode is %1%", !m_single ? "off" : "on");
525 void Status::Changes::consume(bool show_msg)
527 m_consume = m_status.consume() ? 'c' : 0;
528 if (show_msg)
529 Statusbar::printf("Consume mode is %1%", !m_consume ? "off" : "on");
532 void Status::Changes::crossfade(bool show_msg)
534 int crossfade = m_status.crossfade();
535 m_crossfade = crossfade ? 'x' : 0;
536 if (show_msg)
537 Statusbar::printf("Crossfade set to %1% seconds", crossfade);
540 void Status::Changes::dbUpdateState(bool show_msg)
542 m_db_updating = m_status.updateID() ? 'U' : 0;
543 if (show_msg)
544 Statusbar::printf("Database update %1%", m_status.updateID() ? "started" : "finished");
547 void Status::Changes::flags()
549 if (!Config.header_visibility && Config.design == Design::Classic)
550 return;
552 std::string switch_state;
553 switch (Config.design)
555 case Design::Classic:
556 if (m_repeat)
557 switch_state += m_repeat;
558 if (m_random)
559 switch_state += m_random;
560 if (m_single)
561 switch_state += m_single;
562 if (m_consume)
563 switch_state += m_consume;
564 if (m_crossfade)
565 switch_state += m_crossfade;
566 if (m_db_updating)
567 switch_state += m_db_updating;
569 // this is done by raw ncurses because creating another
570 // window only for handling this is quite silly
571 attrset(A_BOLD|COLOR_PAIR(int(Config.state_line_color)));
572 mvhline(1, 0, 0, COLS);
573 if (!switch_state.empty())
575 mvprintw(1, COLS-switch_state.length()-3, "[");
576 attroff(COLOR_PAIR(int(Config.state_line_color)));
577 attron(COLOR_PAIR(int(Config.state_flags_color)));
578 mvprintw(1, COLS-switch_state.length()-2, "%s", switch_state.c_str());
579 attroff(COLOR_PAIR(int(Config.state_flags_color)));
580 attron(COLOR_PAIR(int(Config.state_line_color)));
581 mvprintw(1, COLS-2, "]");
583 attrset(0);
584 refresh();
585 break;
586 case Design::Alternative:
587 switch_state += '[';
588 switch_state += m_repeat ? m_repeat : '-';
589 switch_state += m_random ? m_random : '-';
590 switch_state += m_single ? m_single : '-';
591 switch_state += m_consume ? m_consume : '-';
592 switch_state += m_crossfade ? m_crossfade : '-';
593 switch_state += m_db_updating ? m_db_updating : '-';
594 switch_state += ']';
595 *wHeader << NC::XY(COLS-switch_state.length(), 1) << NC::Format::Bold << Config.state_flags_color << switch_state << NC::Color::End << NC::Format::NoBold;
596 if (!Config.header_visibility) // in this case also draw separator
598 *wHeader << NC::Format::Bold << NC::Color::Black;
599 mvwhline(wHeader->raw(), 2, 0, 0, COLS);
600 *wHeader << NC::Color::End << NC::Format::NoBold;
602 wHeader->refresh();
603 break;
607 void Status::Changes::mixer()
609 if (!Config.display_volume_level || (!Config.header_visibility && Config.design == Design::Classic))
610 return;
612 switch (Config.design)
614 case Design::Classic:
615 VolumeState = " " "Volume" ": ";
616 break;
617 case Design::Alternative:
618 VolumeState = " " "Vol" ": ";
619 break;
621 if (m_status.volume() < 0)
622 VolumeState += "n/a";
623 else
625 VolumeState += boost::lexical_cast<std::string>(m_status.volume());
626 VolumeState += "%";
628 *wHeader << Config.volume_color;
629 *wHeader << NC::XY(wHeader->getWidth()-VolumeState.length(), 0) << VolumeState;
630 *wHeader << NC::Color::End;
631 wHeader->refresh();
634 void Status::Changes::outputs()
636 # ifdef ENABLE_OUTPUTS
637 myOutputs->FetchList();
638 # endif // ENABLE_OUTPUTS