Album artwork via Ueberzug

AUTHORS

@@ -17,6 +17,7 @@ Darby Payne <[email protected]>
 David Coppa <[email protected]>
 Dmitriy Kusterskiy <[email protected]>
 Eric Izoita <[email protected]>
+Evan Chang <[email protected]>
 Frank Blendinger <[email protected]>
 greenbagels <[email protected]>
 Hamuko <[email protected]>

configure.ac

@@ -14,6 +14,7 @@ AC_PROG_LIBTOOL
 AC_ARG_ENABLE(outputs, AS_HELP_STRING([--enable-outputs], [Enable outputs screen @<:@default=no@:>@]), [outputs=$enableval], [outputs=no])
 AC_ARG_ENABLE(visualizer, AS_HELP_STRING([--enable-visualizer], [Enable music visualizer screen @<:@default=no@:>@]), [visualizer=$enableval], [visualizer=no])
 AC_ARG_ENABLE(clock, AS_HELP_STRING([--enable-clock], [Enable clock screen @<:@default=no@:>@]), [clock=$enableval], [clock=no])
+AC_ARG_ENABLE(artwork, AS_HELP_STRING([--enable-artwork], [Enable artwork screen @<:@default=no@:>@]), [artwork=$enableval], [artwork=no])
 
 AC_ARG_WITH(fftw, AS_HELP_STRING([--with-fftw], [Enable fftw support (required for frequency spectrum vizualization) @<:@default=auto@:>@]), [fftw=$withval], [fftw=auto])
 AC_ARG_WITH(taglib, AS_HELP_STRING([--with-taglib], [Enable tag editor @<:@default=auto@:>@]), [taglib=$withval], [taglib=auto])
@@ -27,6 +28,10 @@ if test "$clock" = "yes"; then
  AC_DEFINE([ENABLE_CLOCK], [1], [enables clock screen])
 fi
 
+if test "$artwork" = "yes"; then
+ AC_DEFINE([ENABLE_ARTWORK], [1], [enables artwork screen])
+fi
+
 # -flto
 if test "$lto" != "no"; then
  AC_MSG_CHECKING([whether compiler supports -flto])
@@ -91,7 +96,7 @@ AC_COMPILE_IFELSE([AC_LANG_PROGRAM([], [[auto f = [](auto n) { return n*n; }; f(
 )
 
 # boost
-BOOST_REQUIRE([1.60])
+BOOST_REQUIRE([1.64])
 AC_SUBST(BOOST_CPPFLAGS)
 CPPFLAGS="$CPPFLAGS $BOOST_CPPFLAGS"
 
@@ -105,6 +110,8 @@ BOOST_RANGE
 BOOST_TOKENIZER
 BOOST_TUPLE
 BOOST_VARIANT
+BOOST_PROCESS
+BOOST_PROPERTY_TREE
 
 BOOST_DATE_TIME
 AC_SUBST(BOOST_DATE_TIME_LDFLAGS)

doc/bindings

@@ -297,6 +297,9 @@
 #def_key "8"
 # show_visualizer
 #
+#def_key "9"
+# show_artwork
+#
 #def_key "="
 # show_clock
 #

doc/config

@@ -139,6 +139,30 @@
 #
 #visualizer_spectrum_hz_max = 20000
 #
+##### in-terminal artwork #####
+##
+## ncmpcpp can display artwork in the terminal. The artwork is shown in the
+## "artwork" screen, which can be optionally be displayed side-by-side with
+## another screen via ncmpcpp's slave screen functionality.
+##
+## The "mpd_music_dir" config option should be set accordingly. ncmpcpp will
+## attempt to find and display an image named "cover.png", "cover.jpg",
+## "cover.tiff", or "cover.bmp" in the same directory as the current playing
+## song.
+##
+## Ueberzug must be installed and visible in PATH for artwork to be displayed.
+##
+#
+## Fallback to this image if no album cover art is found in the music library.
+#
+#albumart_default_path = ""
+#
+## Passed directly to Ueberzug to configure how artwork fills the screen. One of
+## "crop", "distort", "fit_contain", "contain", "forced_cover", "cover". See the
+## Ueberzug documentation for full descriptions or updated scalers.
+#
+#albumart_scaler = "fit_contain"
+#
 ##### system encoding #####
 ##
 ## ncmpcpp should detect your charset encoding but if it failed to do so, you

doc/ncmpcpp.1

@@ -123,6 +123,12 @@ For spectrum visualizer, left-most frequency of visualizer, must be less than HZ
 .B visualizer_spectrum_hz_max = Hz
 For spectrum visualizer, right-most frequency of visualizer, must be greater than HZ MIN.
 .TP
+.B albumart_default_path = PATH
+Fallback to this image if no album cover art is found in the music library.
+.TP
+.B albumart_scaler = STRING
+Passed directly to Ueberzug to configure how artwork fills the screen. One of "crop", "distort", "fit_contain", "contain", "forced_cover", "cover". See the Ueberzug documentation for full descriptions or updated scalers.
+.TP
 .B system_encoding = ENCODING
 If you use encoding other than utf8, set it in order to handle utf8 encoded strings properly.
 .TP

m4/boost.m4

@@ -856,6 +856,17 @@ BOOST_DEFUN([Hash],
 [BOOST_FIND_HEADER([boost/functional/hash.hpp])])
 
 
+# BOOST_JSON([PREFERRED-RT-OPT])
+# -----------------------------------
+# Look for Boost.JSON. For the documentation of PREFERRED-RT-OPT, see the
+# documentation of BOOST_FIND_LIB above.
+BOOST_DEFUN([JSON],
+[BOOST_FIND_LIB([json], [$1],
+ [boost/json.hpp],
+ [boost::json::value v;])
+])# BOOST_JSON
+
+
 # BOOST_LAMBDA()
 # --------------
 # Look for Boost.Lambda
@@ -996,6 +1007,20 @@ BOOST_DEFUN([Preprocessor],
 [BOOST_FIND_HEADER([boost/preprocessor/repeat.hpp])])
 
 
+# BOOST_PROCESS()
+# ------------
+# Look for Boost.Process
+BOOST_DEFUN([Process],
+[BOOST_FIND_HEADER([boost/process.hpp])])
+
+
+# BOOST_PROPERTY_TREE()
+# ------------
+# Look for Boost.PropertyTree
+BOOST_DEFUN([Property_Tree],
+[BOOST_FIND_HEADER([boost/property_tree/ptree.hpp])])
+
+
 # BOOST_RANGE()
 # --------------------
 # Look for Boost.Range

src/Makefile.am

@@ -22,6 +22,7 @@ ncmpcpp_SOURCES = \
  screens/tag_editor.cpp \
  screens/tiny_tag_editor.cpp \
  screens/visualizer.cpp \
+ screens/artwork.cpp \
  utility/comparators.cpp \
  utility/html.cpp \
  utility/option_parser.cpp \
@@ -84,6 +85,7 @@ noinst_HEADERS = \
  screens/tag_editor.h \
  screens/tiny_tag_editor.h \
  screens/visualizer.h \
+ screens/artwork.h \
  utility/comparators.h \
  utility/const.h \
  utility/conversion.h \

src/actions.cpp

@@ -62,6 +62,7 @@
 #include "screens/tag_editor.h"
 #include "screens/tiny_tag_editor.h"
 #include "screens/visualizer.h"
+#include "screens/artwork.h"
 #include "title.h"
 #include "tags.h"
 
@@ -159,6 +160,10 @@ void initializeScreens()
 # ifdef ENABLE_VISUALIZER
  myVisualizer = new Visualizer;
 # endif // ENABLE_VISUALIZER
+
+# ifdef ENABLE_ARTWORK
+ myArtwork = new Artwork;
+# endif // ENABLE_ARTWORK
 
 # ifdef ENABLE_OUTPUTS
  myOutputs = new Outputs;
@@ -194,6 +199,10 @@ void setResizeFlags()
  myVisualizer->hasToBeResized = 1;
 # endif // ENABLE_VISUALIZER
 
+# ifdef ENABLE_ARTWORK
+ myArtwork->hasToBeResized = 1;
+# endif // ENABLE_ARTWORK
+
 # ifdef ENABLE_OUTPUTS
  myOutputs->hasToBeResized = 1;
 # endif // ENABLE_OUTPUTS
@@ -2746,6 +2755,21 @@ void ShowServerInfo::run()
  myServerInfo->switchTo();
 }
 
+bool ShowArtwork::canBeRun()
+{
+#ifdef ENABLE_ARTWORK
+ return myScreen != myArtwork;
+#else
+ return false;
+#endif // ENABLE_ARTWORK
+}
+
+void ShowArtwork::run() {
+#ifdef ENABLE_ARTWORK
+ myArtwork->switchTo();
+#endif // ENABLE_ARTWORK
+}
+
 }
 
 namespace {
@@ -2884,6 +2908,7 @@ void populateActions()
  insert_action(new Actions::ShowVisualizer());
  insert_action(new Actions::ShowClock());
  insert_action(new Actions::ShowServerInfo());
+ insert_action(new Actions::ShowArtwork());
  for (size_t i = 0; i < AvailableActions.size(); ++i)
  {
  if (AvailableActions[i] == nullptr)

src/actions.h

@@ -164,6 +164,7 @@ enum class Type
  ShowVisualizer,
  ShowClock,
  ShowServerInfo,
+ ShowArtwork,
  _numberOfActions // needed to dynamically calculate size of action array
 };
 
@@ -1425,6 +1426,15 @@ struct ShowServerInfo: BaseAction
  virtual void run() override;
 };
 
+struct ShowArtwork: BaseAction
+{
+ ShowArtwork(): BaseAction(Type::ShowArtwork, "show_artwork") { }
+
+private:
+ virtual bool canBeRun() override;
+ virtual void run() override;
+};
+
 }
 
 #endif // NCMPCPP_ACTIONS_H

src/bindings.cpp

@@ -589,6 +589,8 @@ void BindingsConfiguration::generateDefaults()
  bind(k, Actions::Type::ShowOutputs);
  if (notBound(k = stringToKey("8")))
  bind(k, Actions::Type::ShowVisualizer);
+ if (notBound(k = stringToKey("9")))
+ bind(k, Actions::Type::ShowArtwork);
  if (notBound(k = stringToKey("=")))
  bind(k, Actions::Type::ShowClock);
  if (notBound(k = stringToKey("@")))

src/ncmpcpp.cpp

@@ -33,6 +33,7 @@
 
 #include "actions.h"
 #include "bindings.h"
+#include "screens/artwork.h"
 #include "screens/browser.h"
 #include "charset.h"
 #include "configuration.h"
@@ -47,6 +48,7 @@
 #include "screens/visualizer.h"
 #include "title.h"
 #include "utility/conversion.h"
+#include "screens/screen.h"
 
 namespace ph = std::placeholders;
 
@@ -57,7 +59,7 @@ std::streambuf *cerr_buffer;
 std::streambuf *clog_buffer;
 
 volatile bool run_resize_screen = false;
- 
+
 void sighandler(int sig)
 {
  if (sig == SIGWINCH)
@@ -235,6 +237,17 @@ int main(int argc, char **argv)
  Statusbar::printf("Action aborted");
  }
 
+# ifdef ENABLE_ARTWORK
+ if (!isVisible(myArtwork) && myArtwork->drawn)
+ {
+ myArtwork->removeArtwork();
+ }
+ else if (isVisible(myArtwork) && !myArtwork->drawn)
+ {
+ myArtwork->updateArtwork();
+ }
+# endif
+
  if (myScreen == myPlaylist)
  myPlaylist->enableHighlighting();
  }