ncmpcpp · evanc577 · Jan 3, 2021 · Jan 4, 2021 · Jan 5, 2021 · Jan 5, 2021
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -32,6 +32,7 @@ jobs:
             libboost-thread-dev
             libcurl4-gnutls-dev
             libfftw3-dev
+            libmagick++-dev
             libmpdclient-dev
             libncurses-dev
             libreadline-dev
@@ -60,6 +61,7 @@ jobs:
             --disable-outputs \
             --disable-visualizer \
             --disable-clock \
+            --disable-artwork \
             --without-fftw \
             --without-taglib \
             --with-lto=$(nproc)
@@ -73,6 +75,7 @@ jobs:
             --enable-outputs \
             --enable-visualizer \
             --enable-clock \
+            --enable-artwork \
             --with-fftw \
             --with-taglib \
             --with-lto=$(nproc)

diff --git a/AUTHORS b/AUTHORS
@@ -17,6 +17,7 @@ Darby Payne <darby.payne@gmail.com>
 David Coppa <dcoppa@gmail.com>
 Dmitriy Kusterskiy <dimykus@gmail.com>
 Eric Izoita <ericizoita@gmail.com>
+Evan Chang <evanc577@gmail.com>
 Frank Blendinger <fb@intoxicatedmind.net>
 greenbagels <greenbagels@teknik.io>
 Hamuko <hamuko@burakku.com>

diff --git a/README.md b/README.md
@@ -32,6 +32,7 @@ new, incompatible versions of dependencies, it will be fixed.
 #### Optional libraries
 * [fftw](http://www.fftw.org), for frequency spectrum music visualization mode
 * [taglib](https://taglib.org/), for tag editing
+* [magick++](https://www.imagemagick.org/Magick++/), for album artwork display
 
 ### Known issues:
 * No full support for handling encodings other than UTF-8.
@@ -58,7 +59,7 @@ The simplest way to compile this package is:
   6. You can remove the program binaries and object files from the
      source code directory by typing `make clean`.
 
-Detailed intallation instructions can be found in the `INSTALL` file. 
+Detailed installation instructions can be found in the `INSTALL` file. 
 
 ### Optional features:
 Optional features can be enable by specifying them during configure. For

diff --git a/configure.ac b/configure.ac
@@ -14,6 +14,7 @@ LT_INIT
 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])
@@ -94,7 +95,7 @@ AC_COMPILE_IFELSE([AC_LANG_PROGRAM([], [[auto f = [](auto n) { return n*n; }; f(
 CXXFLAGS="$CXXFLAGS -Wall -Wextra -Wshadow -Wimplicit-fallthrough"
 
 # boost
-BOOST_REQUIRE([1.60])
+BOOST_REQUIRE([1.64])
 AC_SUBST(BOOST_CPPFLAGS)
 CPPFLAGS="$CPPFLAGS $BOOST_CPPFLAGS"
 
@@ -108,6 +109,8 @@ BOOST_RANGE
 BOOST_TOKENIZER
 BOOST_TUPLE
 BOOST_VARIANT
+BOOST_PROCESS
+BOOST_PROPERTY_TREE
 
 BOOST_DATE_TIME
 AC_SUBST(BOOST_DATE_TIME_LDFLAGS)
@@ -287,5 +290,21 @@ if test "$taglib" != "no" ; then
 	fi
 fi
 
+if test "$artwork" = "yes" ; then
+	PKG_CHECK_MODULES([magick], [Magick++ >= 6], [
+			AC_SUBST(magick_CFLAGS)
+			AC_SUBST(magick_LIBS)
+			CPPFLAGS="$CPPFLAGS $magick_CFLAGS"
+			AC_CHECK_HEADERS([Magick++.h],
+        LIBS="$LIBS $magick_LIBS",
+        AC_MSG_ERROR([missing Magick++.h header])
+      )
+			AC_DEFINE([ENABLE_ARTWORK], [1], [enables album artwork screen])
+		],
+		AC_MSG_ERROR([ImageMagick is required!])
+	)
+fi
+
+
 AC_CONFIG_FILES([Makefile src/Makefile doc/Makefile])
 AC_OUTPUT
diff --git a/doc/bindings b/doc/bindings
@@ -297,6 +297,9 @@
 #def_key "8"
 #  show_visualizer
 #
+#def_key "9"
+#  show_artwork
+#
 #def_key "="
 #  show_clock
 #

diff --git a/doc/config b/doc/config
@@ -154,6 +154,51 @@
 #visualizer_spectrum_log_scale_x = yes
 #visualizer_spectrum_log_scale_y = yes
 #
+##### 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.
+## Ueberzug must be installed and visible in PATH for artwork to be displayed.
+##
+#
+## Enable album art display
+#
+#albumart = no
+#
+## List of sources of album art, highest priority sources first. "local" scans
+## mpd_music_dir on the local machine and attempt to display an image named
+## "cover.png", "cover.jpg", "cover.tiff", or "cover.bmp". "mpd_albumart" and
+## "mpd_readpicture" query MPD with the albumart and readpicture commands
+## respectively. May be empty, in which case the albumart_default_path fallback
+## will be used.
+#
+#albumart_sources = local, mpd_dir, mpd_embed
+#
+## Method to draw album artwork to terminal. One of "ueberzug", "kitty".
+#
+#albumart_backend = "ueberzug"
+#
+## Fallback to this image if no album cover art is found in the music library.
+#
+#albumart_default_path = ""
+#
+## Alignment of album artwork within window. One of "N", "NE", "E", "SE", "S",
+## "SW", "W", "NW", "center".
+#
+#albumart_align = "center"
+#
+## Manually set font width/height in pixels. Set to 0 to try auto detection,
+## support depends on terminal emulator. Check error log if no image appears.
+#
+#font_width = 0
+#font_height = 0
+#
+## Move album artwork horizontally/vertically by specified number of characters.
+#
+#albumart_xoffset = 0
+#albumart_yoffset = 0
+#
 ##### system encoding #####
 ##
 ## ncmpcpp should detect your charset encoding but if it failed to do so, you

diff --git a/doc/ncmpcpp.1 b/doc/ncmpcpp.1
@@ -133,6 +133,36 @@ 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 = yes/no
+Enable album art display
+.TP
+.B albumart_sources = SOURCES
+List of sources of album art, highest priority sources first. "local" scans mpd_music_dir on the local machine and attempt to display an image named "cover.png", "cover.jpg", "cover.tiff", or "cover.bmp". "mpd_albumart" and "mpd_readpicture" query MPD with the albumart and readpicture commands respectively. May be empty, in which case the albumart_default_path fallback will be used.
+.TP
+.B albumart_backend = BACKEND
+Method to display artwork image. One of "ueberzug", "kitty".
+.TP
+.B albumart_filenames = PATHS
+List of file names of artwork to display when using "local" source in order of priority. Globs are allowed.
+.TP
+.B albumart_default_path = PATH
+Fallback to this image if no album cover art is found in the music library.
+.TP
+.B albumart_align = ALIGN
+Alignment of album artwork within window. One of "N", "NE", "E", "SE", "S", "SW", "W", "NW", "center".
+.TP
+.B font_width = pixels
+Manually set font width in pixels. Set to 0 to try auto detection, support depends on terminal emulator. Check error log if no image appears.
+.TP
+.B font_height = pixels
+Same as font_width, but for height.
+.TP
+.B albumart_xoffset = chars
+Move album artwork horizontally by specified number of characters.
+.TP
+.B albumart_yoffset = chars
+Same as albumart_xoffset, but move vertically.
+.TP
 .B system_encoding = ENCODING
 If you use encoding other than utf8, set it in order to handle utf8 encoded strings properly.
 .TP
@@ -519,6 +549,22 @@ Available values for colors:
 
 \fBNote\fR: colors can be nested, so if you write $2some$5text$9, it'll disable only usage of blue color and make red the current one.
 
+.SH "ALBUM ARTWORK"
+
+ncmpcpp can display album artwork, either from a local file or from the MPD protocol.
+The supported terminal image protocols are ueberzug(pp) and kitty terminal graphics protocol.
+
+Album artwork in ncmppcpp is implemented as a screen; to have artwork shown side-by-side with the regular ncmpcpp UI, use ncmpcpp's slave screen functionality.
+
+\fBExample side-by-side artwork configuration\fR:
+
+ albumart = yes
+ albumart_backend = kitty
+ startup_screen = artwork
+ startup_slave_screen = playlist
+ startup_slave_screen_focus = yes
+ locked_screen_width_part = 25
+
 .SH "BUGS"
 Report bugs on https://github.com/arybczak/ncmpcpp/issues
 .SH "NOTE"

diff --git a/m4/boost.m4 b/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

diff --git a/src/Makefile.am b/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 \

diff --git a/src/actions.cpp b/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"
 
@@ -147,6 +148,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;
@@ -182,6 +187,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
@@ -228,7 +237,7 @@ void resizeScreen(bool reload_main_window)
 	applyToVisibleWindows(&BaseScreen::refresh);
 
 	Status::Changes::elapsedTime(false);
-	Status::Changes::playerState();
+	Status::Changes::playerState(false);
 	// Note: routines for drawing separator if alternative user
 	// interface is active and header is hidden are placed in
 	// NcmpcppStatusChanges.StatusFlags
@@ -346,6 +355,10 @@ void UpdateEnvironment::run(bool update_timer, bool refresh_window, bool mpd_syn
 		if (flags)
 			Status::update(flags);
 	}
+
+#	ifdef ENABLE_ARTWORK
+	myArtwork->updatedVisibility();
+#	endif
 }
 
 void UpdateEnvironment::run()
@@ -2745,6 +2758,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 {
@@ -2883,6 +2911,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)

diff --git a/src/actions.h b/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
diff --git a/src/bindings.cpp b/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("@")))

diff --git a/src/curses/menu_impl.h b/src/curses/menu_impl.h
@@ -22,6 +22,7 @@
 #define NCMPCPP_MENU_IMPL_H
 
 #include "menu.h"
+#include "screens/artwork.h"
 
 namespace NC {