generated from doctorfree/website-starter
-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.html
1242 lines (1239 loc) · 45.3 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
---
layout: post
toc: true
post_style: page
---
<div data-align="center">
<img
src="https://raw.githubusercontent.com/wiki/doctorfree/MusicPlayerPlus/img/mpplus.png"
style="width: 882px; height: 330px"
alt="MusicPlayerPlus"
/>
</div>
<p>
MusicPlayerPlus is a character-based console and terminal window music player
</p>
<ul>
<li>
<strong><em>plus</em></strong> Beets media library management with
preconfigured plugins
</li>
<li>
<strong><em>plus</em></strong> Character-based spectrum visualizer
<code>mppcava</code>
</li>
<li>
<strong><em>plus</em></strong> Music Player Daemon and ALSA configuration
management
</li>
<li>
<strong><em>plus</em></strong> Mopidy Music Server with preconfigured
extensions
</li>
<li>
<strong><em>plus</em></strong> Navidrome Music Server/Streamer automated
install/config/service
</li>
<li>
<strong><em>plus</em></strong> Bliss acoustic analysis and song similarity
database
</li>
<li>
<strong><em>plus</em></strong> Essentia acoustic analysis and metadata
extraction
</li>
<li>
<strong><em>plus</em></strong> YAMS MPD Last.fm scrobbler running as a
service
</li>
<li>
<strong><em>plus</em></strong> Media fuzzy finder using <code>fzf</code>
</li>
<li>
<strong><em>plus</em></strong> Album cover art download
</li>
<li>
<strong><em>plus</em></strong> Bandcamp collections download
</li>
<li>
<strong><em>plus</em></strong> Soundcloud favorites download
</li>
<li>
<strong><em>plus</em></strong> Discogs user collection to markdown generator
</li>
<li>
<strong><em>plus</em></strong> Automated setup, import and organization,
metadata, playlists, …
</li>
</ul>
<p>
MusicPlayerPlus is one of the <a href="https://neoman.dev" target="_blank" rel="noopener">Neoman</a> managed
projects:
</p>
<table>
<colgroup>
<col style="width: 30%" />
<col style="width: 33%" />
<col style="width: 36%" />
</colgroup>
<thead>
<tr class="header">
<th><strong>Neoman</strong></th>
<th><strong>Managed</strong></th>
<th><strong>Projects</strong></th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td><a href="https://asciiville.dev">Asciiville</a></td>
<td><a href="https://lazyman.dev">Lazyman</a></td>
<td><a href="https://mirrorcommand.dev">MirrorCommand</a></td>
</tr>
<tr class="even">
<td><a href="https://musicplayerplus.dev">MusicPlayerPlus</a></td>
<td><a href="https://neoman.dev">Neoman</a></td>
<td><a href="https://rooncommand.dev">RoonCommandLine</a></td>
</tr>
</tbody>
</table>
<h2 id="table-of-contents">Table of contents</h2>
<details>
<summary>
<strong>Click here to expand/collapse</strong>
</summary>
<ol type="1">
<li>
<a href="#overview">Overview</a>
<ol type="1">
<li><a href="#requirements">Requirements</a></li>
</ol>
</li>
<li><a href="#screenshots">Screenshots</a></li>
<li><a href="#videos">Videos</a></li>
<li>
<a href="#quickstart">Quickstart</a>
<ol type="1">
<li>
<a href="https://musicplayerplus.dev/quickstart#quickstart-summary"
>Quickstart summary</a
>
</li>
<li>
<a href="https://musicplayerplus.dev/quickstart#full-tilt-boogie"
>Full Tilt Boogie</a
>
</li>
</ol>
</li>
<li>
<a href="#installation">Installation</a>
<ol type="1">
<li>
<a href="https://musicplayerplus.dev/install#supported-platforms"
>Supported platforms</a
>
</li>
<li>
<a
href="https://musicplayerplus.dev/install#debian-package-installation"
>Debian package installation</a
>
</li>
<li>
<a href="https://musicplayerplus.dev/install#rpm-package-installation"
>RPM Package installation</a
>
</li>
<li>
<a
href="https://musicplayerplus.dev/install#arch-package-installation"
>Arch Package installation</a
>
</li>
</ol>
</li>
<li>
<a href="#post-installation-configuration"
>Post Installation Configuration</a
>
<ol type="1">
<li>
<a
href="https://musicplayerplus.dev/configuration#client-configuration-required"
>Client Configuration (required)</a
>
</li>
<li>
<a
href="https://musicplayerplus.dev/configuration#musicplayerplus-configuration-file"
>MusicPlayerPlus Configuration File</a
>
</li>
<li>
<a
href="https://musicplayerplus.dev/configuration#mpd-music-directory-configuration"
>MPD Music Directory Configuration</a
>
</li>
<li>
<a
href="https://musicplayerplus.dev/configuration#initializing-the-beets-media-library-management-system"
>Initializing the Beets media library management system</a
>
</li>
<li>
<a
href="https://musicplayerplus.dev/configuration#additional-metadata-analysis-and-retrieval"
>Additional metadata analysis and retrieval</a
>
<ol type="1">
<li>
<a
href="https://musicplayerplus.dev/configuration#acoustic-analysis-with-blissify"
>Acoustic analysis with Blissify</a
>
</li>
<li>
<a
href="https://musicplayerplus.dev/configuration#acoustic-analysis-with-essentia"
>Acoustic analysis with Essentia</a
>
</li>
<li>
<a
href="https://musicplayerplus.dev/configuration#acoustic-retrieval-with-acousticbrainz"
>Acoustic retrieval with AcousticBrainz</a
>
</li>
</ol>
</li>
<li>
<a
href="https://musicplayerplus.dev/configuration#activating-the-yams-scrobbler-for-lastfm"
>Activating the YAMS scrobbler for Last.fm</a
>
</li>
<li>
<a
href="https://musicplayerplus.dev/configuration#mpd-audio-output-configuration"
>MPD Audio Output Configuration</a
>
</li>
<li>
<a
href="https://musicplayerplus.dev/configuration#fuzzy-finder-configuration"
>Fuzzy Finder Configuration</a
>
</li>
<li>
<a href="https://musicplayerplus.dev/configuration#start-mpd"
>Start MPD</a
>
</li>
<li>
<a
href="https://musicplayerplus.dev/configuration#system-verification-checks"
>System verification checks</a
>
</li>
<li>
<a
href="https://musicplayerplus.dev/configuration#initialize-music-database"
>Initialize Music Database</a
>
</li>
<li>
<a href="https://musicplayerplus.dev/configuration#installing-mopidy"
>Installing Mopidy</a
>
</li>
<li>
<a
href="https://musicplayerplus.dev/configuration#installing-navidrome"
>Installing Navidrome</a
>
<ol type="1">
<li>
<a
href="https://musicplayerplus.dev/configuration#navidrome-clients"
>Navidrome clients</a
>
</li>
</ol>
</li>
<li>
<a
href="https://musicplayerplus.dev/configuration#terminal-emulator-support"
>Terminal Emulator Support</a
>
</li>
<li>
<a
href="https://musicplayerplus.dev/configuration#discogs-user-collection"
>Discogs User Collection</a
>
</li>
</ol>
</li>
<li>
<a href="#musicplayerplus-services-and-clients"
>MusicPlayerPlus Services and Clients</a
>
<ol type="1">
<li>
<a href="https://musicplayerplus.dev/services#services">Services</a>
</li>
<li>
<a
href="https://musicplayerplus.dev/services#which-services-should-be-installed-and-activated"
>Which services should be installed and activated</a
>
</li>
<li>
<a href="https://musicplayerplus.dev/services#clients">Clients</a>
</li>
</ol>
</li>
<li>
<a href="#documentation">Documentation</a>
<ol type="1">
<li>
<a
href="https://musicplayerplus.dev/documentation#readme-for-musicplayerplus-configuration"
>README for MusicPlayerPlus configuration</a
>
</li>
<li>
<a
href="https://musicplayerplus.dev/documentation#readme-for-mpcplus-mpd-client"
>README for mpcplus MPD client</a
>
</li>
<li>
<a
href="https://musicplayerplus.dev/documentation#readme-for-tmuxp-configs"
>README for tmuxp configs</a
>
</li>
<li>
<a href="https://musicplayerplus.dev/documentation#man-pages"
>Man Pages</a
>
</li>
<li>
<a href="https://musicplayerplus.dev/documentation#usage">Usage</a>
</li>
<li>
<a
href="https://musicplayerplus.dev/documentation#example-client-invocations"
>Example client invocations</a
>
</li>
<li>
<a
href="https://musicplayerplus.dev/documentation#adding-album-cover-art"
>Adding Album Cover Art</a
>
</li>
<li>
<a
href="https://musicplayerplus.dev/documentation#custom-key-bindings"
>Custom key bindings</a
>
</li>
<li>
<a
href="https://musicplayerplus.dev/documentation#tmux-session-exit-issues"
>Tmux session exit issues</a
>
</li>
</ol>
</li>
<li><a href="#musicplayerplus-commands">MusicPlayerPlus Commands</a></li>
<li><a href="#removal">Removal</a></li>
<li>
<a href="#troubleshooting">Troubleshooting</a>
<ol type="1">
<li><a href="#known-issues">Known issues</a></li>
</ol>
</li>
<li>
<a href="#infrared-remote-control-of-mpd"
>Infrared remote control of MPD</a
>
</li>
<li>
<a href="#building-musicplayerplus-from-source"
>Building MusicPlayerPlus from source</a
>
</li>
<li>
<a href="#contributing">Contributing</a>
<ol type="1">
<li>
<a href="#testing-and-issue-reporting">Testing and Issue Reporting</a>
</li>
<li><a href="#sponsor-musicplayerplus">Sponsor MusicPlayerPlus</a></li>
<li>
<a href="#contribute-to-development">Contribute to Development</a>
</li>
</ol>
</li>
</ol>
</details>
<h2 id="overview">Overview</h2>
<p>
<a href="https://opensource.org/licenses/MIT" target="_blank" rel="noopener"
><img
src="https://img.shields.io/badge/License-MIT-yellow.svg"
alt="License: MIT"
/></a>
</p>
<p>
The MusicPlayerPlus project provides integration and extension of several
audio packages designed to stream and play music. MusicPlayerPlus interacts
with the Music Player Daemon (MPD). Outputs from the MPD streaming audio
server are used as MusicPlayerPlus inputs for playback and visualization.
MusicPlayerPlus components are used to manage and control MPD and ALSA
configuration.
</p>
<p>
MusicPlayerPlus integrations and extensions are primarily aimed at the
character-based terminal user. They enable an easy to use seamlessly
integrated control of audio streaming, playing, music library management, and
visualization in a lightweight character-based environment.
</p>
<p>
Audio streaming is provided by the Music Player Daemon (MPD). At the core of
MusicPlayerPlus is the <code>mpplus</code> command which acts as a front-end
for a variety of terminal and/or <code>tmux</code> sessions.
</p>
<p>The <code>mpplus</code> command can be used to invoke:</p>
<ul>
<li>
The lightweight character-based MPD client,
<code>mpcplus</code>
</li>
<li>One or more terminal emulators running an MPD client and visualizer</li>
<li>
A tmux session using the tmux session manager
<code>tmuxp</code>
</li>
<li>A spectrum visualizer</li>
<li>A download of album cover art for every album in a music library</li>
<li>
Conversion of all WAV/M4A format media in a music library to MP3 format
media
</li>
<li>An import of a music library to the Beets media library manager</li>
<li>
A download of lyrics for all songs in the music library without lyrics
</li>
<li>
Analysis and retrieval of audio-based information for media matching a query
</li>
<li>YAMS MPD Last.fm scrobbler activation</li>
<li>Any MPD client the user wishes to run</li>
<li>One of several asciimatics animations optionally accompanied by audio</li>
<li>
A fuzzy listing and searching of the audio library using
<code>fzf</code>
</li>
</ul>
<p>
<strong>[Note:]</strong> Typical use of <code>mpplus</code> as a music player
and spectrum visualizer will invoke a <code>tmux</code>
session to display the MPD client, spectrum visualizer, and album cover art
all in a single terminal window. MusicPlayerPlus configures
<code>tmux</code> with a custom key binding to exit tmux sessions. To exit an
<code>mpplus</code> tmux session, the <code>Alt-x</code> key binding can be
used.
</p>
<p>Integration is provided for:</p>
<ul>
<li><a href="https://www.musicpd.org/" target="_blank" rel="noopener">mpd</a>, the Music Player Daemon</li>
<li>
<a href="https://github.com/doctorfree/mpcplus/README.md" target="_blank" rel="noopener">mpcplus</a>,
character-based MPD client
</li>
<li>
<a href="https://beets.io/" target="_blank" rel="noopener">beets</a>, media library management system
</li>
<li>
<a href="https://github.com/doctorfree/mpplus-essentia/README.md" target="_blank" rel="noopener"
>essentia</a
>, acoustic metadata analysis and extraction
</li>
<li>
<a href="https://mopidy.com/" target="_blank" rel="noopener">mopidy</a>, music server with cool extensions
</li>
<li>
<a href="https://www.navidrome.org/" target="_blank" rel="noopener">navidrome</a>, self-hosted music server
and streamer
</li>
<li>
<a href="https://github.com/Berulacks/yams/" target="_blank" rel="noopener">yams</a>, MPD scrobbler for
Last.fm
</li>
<li>
<a href="https://github.com/karlstav/cava" target="_blank" rel="noopener">cava</a>, an audio spectrum
visualizer
</li>
<li>
<a href="http://mplayerhq.hu/design7/info.html" target="_blank" rel="noopener">mplayer</a>, a media player
</li>
<li>
<a href="https://github.com/junegunn/fzf" target="_blank" rel="noopener">fzf</a>, interactive fuzzy finder
</li>
<li>
<a href="https://github.com/peterbrittain/asciimatics" target="_blank" rel="noopener">asciimatics</a> -
automatically display a variety of character-based animation effects
</li>
<li>
<a href="https://asciinema.org/" target="_blank" rel="noopener">asciinema</a> - automatically create ascii
character-based video clips
</li>
<li>
<a href="https://github.com/tmux/tmux/wiki" target="_blank" rel="noopener">tmux</a>, a terminal multiplexer
</li>
<li>
<a href="https://github.com/tmux-python/tmuxp" target="_blank" rel="noopener">tmuxp</a>, a tmux session
manager
</li>
<li>
Enhanced key bindings for extended control of terminal windows and tmux
sessions
</li>
<li>
Several terminal emulators
<ul>
<li>kitty (the default MusicPlayerPlus terminal emulator)</li>
<li>cool-retro-term</li>
<li>gnome-terminal</li>
<li>tilix</li>
</ul>
</li>
</ul>
<p>
The goal of MusicPlayerPlus is to provide the user with a sophisticated set of
complex music library tools that can be integrated and managed in a fairly
simple to understand fashion. Also, to make some cool looking powerful stuff
happen from the command-line in a character-based environment.
</p>
<h3 id="requirements">Requirements</h3>
<p>
MusicPlayerPlus is compiled and packaged for installation on any Linux
platform. It has been tested on the following platforms:
</p>
<ul>
<li>Arch Linux</li>
<li>CentOS Linux</li>
<li>Fedora Linux</li>
<li>Raspberry Pi OS</li>
<li>Ubuntu Linux</li>
</ul>
<p>
Installation and initialization require admistrative privilege. The
<code>mppinit</code> command, executed after installing MusicPlayerPlus,
installs several packages and therefore requires access to the Internet along
with administrative privilege (e.g. <code>sudo</code>
privilege).
</p>
<p>
Memory and storage requirements depend upon the size of the music library.
</p>
<p>
With a moderate sized music library, the Music Player Daemon can exceed a 2GB
memory capacity. Therefore, 4GB or more of memory is recommended.
</p>
<p>
Storage should be sized to adequately host what will likely be a growing music
library. Plan ahead and leave your library room to grow. A few hundred
Gigabytes of storage might suffice for some music libraries but a Terabyte or
more will provide room to grow. Testing is performed on systems with 4GB RAM
and 2TB storage using a 600GB music library.
</p>
<p>
Essentia metadata extraction, Blissify similarity analysis, and transcoding
all consume significant CPU resources. Testing has been performed on systems
with the following CPU resources:
</p>
<ul>
<li>8 x Intel(R) Core(TM) i7-7700K CPU @ 4.20GHz</li>
<li>2 x Intel(R) Celeron(R) CPU G1840 @ 2.80GHz</li>
<li>4 x ARMv7 Processor rev 3 (v7l)</li>
</ul>
<p>
All of these processors were able to handle significant loads. However,
import, metadata extraction, and transcoding are all much quicker on the 8 x
Intel(R) Core(TM) i7-7700K CPU @ 4.20GHz system. Although not necessary, these
infrequent operations consume much less time on a more powerful CPU.
</p>
<h2 id="screenshots">Screenshots</h2>
<div align="center">
<img
src="https://raw.githubusercontent.com/doctorfree/MusicPlayerPlus/master/screenshots/mpplus-tilix.png"
style="width: 800px; height: 600px"
alt="mpplustilix"
/>
</div>
<div align="center">
<img
src="https://raw.githubusercontent.com/doctorfree/MusicPlayerPlus/master/screenshots/mpplus-lyrics.png"
style="width: 800px; height: 600px"
alt="mppluslyrics"
/>
</div>
<h2 id="videos">Videos</h2>
<ul>
<li>
<a
href="https://www.youtube.com/watch?v=r7XLA9tO45Q" target="_blank" rel="noopener"
title="MusicPlayerPlus ASCIImatics Intro"
><img src="https://i.imgur.com/UH2A21h.png" alt="MusicPlayerPlus Intro"
/></a>
</li>
<li>
<a
href="https://www.youtube.com/watch?v=y2yaHm04ELM" target="_blank" rel="noopener"
title="MusicPlayerPlus Demo"
><img src="https://i.imgur.com/ZntE1sH.jpg" alt="MusicPlayerPlus Demo"
/></a>
</li>
</ul>
<h2 id="quickstart">Quickstart</h2>
See the
<a href="https://musicplayerplus.dev/quickstart"
>MusicPlayerPlus Quickstart section</a
>
for details on getting started quickly.
<h2 id="installation">Installation</h2>
See the
<a href="https://musicplayerplus.dev/install"
>MusicPlayerPlus Install section</a
>
for details on MusicPlayerPlus installation.
<h2 id="post-installation-configuration">Post Installation Configuration</h2>
See the
<a href="https://musicplayerplus.dev/configuration"
>MusicPlayerPlus Configuration section</a
>
for details on MusicPlayerPlus post-installation configuration.
<h2 id="musicplayerplus-services-and-clients">
MusicPlayerPlus Services and Clients
</h2>
See the
<a href="https://musicplayerplus.dev/services"
>MusicPlayerPlus Services section</a
>
for details on MusicPlayerPlus services and clients.
<h2 id="documentation">Documentation</h2>
See the
<a href="https://musicplayerplus.dev/documentation"
>MusicPlayerPlus Documentation section</a
>
for MusicPlayerPlus documentation and usage.
<h2 id="musicplayerplus-commands">MusicPlayerPlus Commands</h2>
See the
<a href="https://musicplayerplus.dev/documentation#commands"
>MusicPlayerPlus Commands section</a
>
for details on MusicPlayerPlus commands.
<h2 id="removal">Removal</h2>
<p>
On Debian based Linux systems where the MusicPlayerPlus package was installed
using the MusicPlayerPlus Debian format package, remove the MusicPlayerPlus
package by executing the command:
</p>
<pre class="console"><code> sudo apt remove musicplayerplus</code></pre>
<p>or</p>
<pre class="console"><code> sudo dpkg -r musicplayerplus</code></pre>
<p>
On RPM based Linux systems where the MusicPlayerPlus package was installed
using the MusicPlayerPlus RPM format package, remove the MusicPlayerPlus
package by executing the command:
</p>
<pre class="console"><code> sudo dnf remove MusicPlayerPlus</code></pre>
<p>or</p>
<pre class="console"><code> sudo rpm -e MusicPlayerPlus</code></pre>
<p>
On Arch based Linux systems where the MusicPlayerPlus package was installed
using the MusicPlayerPlus Pacman format package, remove the MusicPlayerPlus
package by executing the command:
</p>
<pre class="console"><code> sudo pacman -Rs musicplayerplus</code></pre>
<p>
The MusicPlayerPlus package can be removed by executing the “Uninstall” script
in the MusicPlayerPlus source directory:
</p>
<pre
class="console"
><code> git clone https://github.com/doctorfree/MusicPlayerPlus.git
cd MusicPlayerPlus
./Uninstall</code></pre>
<h2 id="troubleshooting">Troubleshooting</h2>
<p>
Many problems encountered with MusicPlayerPlus often resolve to problems with
the underlying Linux audio configuration. As a first step in troubleshooting,
verify the audio subsystem is functioning properly. Most systems use either
ALSA or PulseAudio and there are numerous audio test guides available.
</p>
<p>
MusicPlayerPlus includes a convenience script to test the ALSA audio
subsystem. The command <code>alsa_audio_test</code> can be run to test your
ALSA audio setup. If successful you will hear the test output of the
<code>aplay</code> command. To view a <code>alsa_audio_test</code>
usage message and current ALSA configuration settings, run the command
<code>alsa_audio_test -u</code>
</p>
<p>
Another source of problems to investigate is the Music Player Daemon (MPD).
This is the music streaming server that MusicPlayerPlus connects to. MPD is
run as a system service that runs automatically. You can check the status of
the MPD service by running the command
<code>systemctl --user status mpd</code>. You can restart the MPD service with
<code>systemctl --user restart mpd.service</code>. If the issue is not
resolved by a restart or reboot, check the MPD log file at
<code>$HOME/.config/mpd/log</code> looking for recent failures and exceptions.
</p>
<p>
It may be the case that the root of a problem is a missing dependency.
MusicPlayerPlus should have installed any missing dependencies but one may
have been overlooked, improperly installed, or subsequently removed. If the
system logs or error output indicates something was “not found” then check for
its existence. On Debian based systems there is a nice repository package
index maintained. If a command was not found, it is often possible to simply
type that command at a shell prompt and the Debian packaging system will be
searched for any packages that contain a command with that name. If a likely
looking package is returned, the problem may be solved by installing that
package.
</p>
<p>
Finally, see the Troubleshooting section of the
<a href="https://github.com/doctorfree/MusicPlayerPlus/wiki" target="_blank" rel="noopener"
>MusicPlayerPlus Wiki</a
>. for additional troubleshooting techniques and commonly resolved issues.
</p>
<p>
If an issue cannot be resolved and all troubleshooting efforts have failed,
open an issue at
<a href="https://github.com/doctorfree/MusicPlayerPlus/issues" target="_blank" rel="noopener"
>MusicPlayerPlus issues</a
>. Even if you do manage to resolve an issue, it may still be helpful to
report the issue at https://github.com/doctorfree/MusicPlayerPlus/issues so
that a fix may be incorporated in the next release.
</p>
<h3 id="known-issues">Known issues</h3>
<h4 id="tmux-key-bindings-in-iterm2-terminal-emulator">
Tmux key bindings in iTerm2 terminal emulator
</h4>
<p>
The <code>iTerm2</code> terminal emulator has built-in support for tmux.
Several of the iTerm2 built-in tmux key bindings conflict with and override
the default tmux key bindings and the MusicPlayerPlus custom tmux key
bindings.
</p>
<p>
Unless you are quite familiar with iTerm2 and its tmux implementation, we do
not recommend using iTerm2 with MusicPlayerPlus when running tmux sessions.
</p>
<p>
MusicPlayerPlus support for iTerm2 may be forthcoming in future releases but
at this time iTerm2 is not a supported MusicPlayerPlus terminal emulator.
</p>
<h4 id="tmux-sessions-over-ssh-to-fedora-systems">
Tmux sessions over SSH to Fedora systems
</h4>
<p>
A tmux session initiated over SSH to a Fedora Linux system may size the tmux
panes incorrectly. This issue is not yet understood but will hopefully be
addressed in a future release of MusicPlayerPlus. If, for example, a
<code>mpplus</code> or <code>mpcplus-tmux</code> tmux session displays the
<code>mpcplus</code> pane with a small height while the spectrum visualizer
pane consumes most of the session window, then the <code>mpcplus</code> pane
will need to be resized manually.
</p>
<p>
Tmux panes can be resized either using keyboard shortcuts or with the mouse.
</p>
<p>
To resize the <code>mpcplus</code> tmux pane using the mouse, click and drag
the bottom of the upper pane in the session window. Drag the pane border down
until the <code>mpcplus</code> display of music media appears.
</p>
<p>
To resize the <code>mpcplus</code> tmux pane using keyboard shortcuts, use one
of the default tmux key bindings:
</p>
<pre><code> bind-key -r -T prefix M-Up resize-pane -U 5
bind-key -r -T prefix M-Down resize-pane -D 5
bind-key -r -T prefix M-Left resize-pane -L 5
bind-key -r -T prefix M-Right resize-pane -R 5
bind-key -r -T prefix C-Up resize-pane -U
bind-key -r -T prefix C-Down resize-pane -D
bind-key -r -T prefix C-Left resize-pane -L
bind-key -r -T prefix C-Right resize-pane -R</code></pre>
<p>
This means you can resize a pane by <code><prefix></code>
<code>Alt ↓</code> (tmux prefix followed by “Alt-DownArrow”). The default
MusicPlayerPlus tmux prefix is <code>Ctrl-a</code> so in order to resize the
<code>mpcplus</code> pane using the keyboard, type <code>Ctrl-a</code> then
type <code>Alt ↓</code>. You can repeat <code>Alt ↓</code> several times
without needing to re-type the <code>Ctrl-a</code> prefix if you type it fast
enough (about a second). If the display of <code>Ctrl</code> on the tmux
status line disappears and you still need to resize the
<code>mpcplus</code> pane, then you will need to re-type the prefix key
<code>Ctrl-a</code>.
</p>
<p>
This issue has only been detected on Fedora Linux over SSH. However, it may
occur with other systems and may not be exclusive to either SSH or Fedora.
</p>
<h2 id="infrared-remote-control-of-mpd">Infrared remote control of MPD</h2>
<p>
Advanced users may wish to add remote control capabilities to MusicPlayerPlus.
Getting IR remote control of MPD working is pretty geeky and fun. Also cool.
</p>
<p>
This can be accomplished on most Linux systems using LIRC (Linux Infrared
Remote Control). LIRC setup and usage is described at
https://wiki.archlinux.org/title/LIRC
</p>
<p>
To get started, see the
<a href="https://wiki.archlinux.org/title/LIRC/Quick_start_guide" target="_blank" rel="noopener"
>ArchLinux Step-by-step LIRC setup guide</a
>
for USB IR receiver with universal remote control.
</p>
<p>
The only prerequisites are a USB IR receiver, preferably an MCE model, and an
old universal remote control you have lying around the house.
</p>
<p>
A long list of LIRC supported remotes with corresponding LIRC configurations
can be found at the
<a href="http://lirc-remotes.sourceforge.net/remotes-table.html" target="_blank" rel="noopener"
>LIRC Remotes Databass</a
>.
</p>
<p>
The hard part is getting the remote control device talking to the IR receiver
since there are a number of different protocols and devices supported. The
LIRC setup guide linked above has pretty good step-by-step procedures for
establishing communication between the remote and the receiver.
</p>
<p>
Once the hardware is successfully communicating, you can control MPD with
<code>lirc</code> and <code>mpc</code> by configuring lirc. For example, add
the following to <code>~/.lircrc</code>:
</p>
<pre><code>## irexec
begin
prog = irexec
button = play_pause
config = mpc toggle
repeat = 0
end
begin
prog = irexec
button = stop
config = mpc stop
repeat = 0
end
begin
prog = irexec
button = previous
config = mpc prev
repeat = 0
end
begin
prog = irexec
button = next
config = mpc next
repeat = 0
end
begin
prog = irexec
button = volup
config = mpc volume +2
repeat = 1
end
begin
prog = irexec
button = voldown
config = mpc volume -2
repeat = 1
end
begin
prog = irexec
button = pbc
config = mpc random
repeat = 0
end
begin
prog = irexec
button = pdvd
config = mpc update
repeat = 0
end
begin
prog = irexec
button = right
config = mpc seek +00:00:05
repeat = 0
end
begin
prog = irexec
button = left
config = mpc seek -00:00:05
repeat = 0
end
begin
prog = irexec
button = up
config = mpc seek +1%
repeat = 0
end
begin
prog = irexec
button = down
config = mpc seek -1%
repeat = 0
end</code></pre>
<p>
A guide for configuring <code>lirc</code> to control MPD using
<code>mpc</code> can be found at
https://wiki.archlinux.org/title/Music_Player_Daemon/Tips_and_tricks#Control_MPD_with_lirc
</p>
<h2 id="building-musicplayerplus-from-source">
Building MusicPlayerPlus from source
</h2>
<p>
MusicPlayerPlus can be compiled, packaged, and installed from the source code
repository. This should be done as a normal user with
<code>sudo</code> privileges:
</p>
<pre><code># Retrieve the source code from the repository
git clone https://github.com/doctorfree/MusicPlayerPlus.git
# Enter the MusicPlayerPlus source directory
cd MusicPlayerPlus
# Install the necessary build environment (not necessary on Arch Linux)
scripts/install-dev-env.sh
# Compile the MusicPlayerPlus components and create an installation package
./mkpkg
# Install MusicPlayerPlus and its dependencies
./Install</code></pre>
<p>These steps are detailed below.</p>
<h3 id="clone-musicplayerplus-repository">Clone MusicPlayerPlus repository</h3>
<pre><code> git clone https://github.com/doctorfree/MusicPlayerPlus.git
cd MusicPlayerPlus</code></pre>
<p>
<strong>[Note:]</strong> The <code>mkpkg</code> script in the top level of the
MusicPlayerPlus repository can be used to build an installation package on all
supported platforms. After cloning, <code>cd MusicPlayerPlus</code> and
<code>./mkpkg</code>. The resulting installation package(s) will be found in
<code>./releases/<version>/</code>.
</p>
<h3 id="install-build-dependencies">Install build dependencies</h3>
<p>MusicPlayerPlus components have build dependencies on the following:</p>
<ul>
<li>libtool</li>
<li>automake</li>
<li>build-essentials</li>
<li><a href="https://www.boost.org/" target="_blank" rel="noopener">Boost library</a></li>
<li>
<a href="http://www.gnu.org/software/ncurses/ncurses.html" target="_blank" rel="noopener"
>NCurses library</a
>
</li>
<li>
<a href="https://tiswww.case.edu/php/chet/readline/rltop.html" target="_blank" rel="noopener"
>Readline library</a
>
</li>
<li><a href="https://curl.haxx.se/" target="_blank" rel="noopener">Curl library</a></li>
<li><a href="http://www.fftw.org/" target="_blank" rel="noopener">fftw library</a></li>
<li><a href="https://taglib.org/" target="_blank" rel="noopener">tag library</a></li>
<li><a href="https://github.com/ndevilla/iniparser" target="_blank" rel="noopener">iniparser</a></li>
<li><a href="http://alsa-project.org/" target="_blank" rel="noopener">ALSA dev files</a></li>
<li>
<a href="http://freedesktop.org/software/pulseaudio/doxygen/" target="_blank" rel="noopener"
>Pulseaudio dev files</a
>
</li>
<li><a href="http://eigen.tuxfamily.org/" target="_blank" rel="noopener">Eigen</a></li>
<li><a href="https://github.com/MTG/gaia" target="_blank" rel="noopener">Gaia</a></li>
<li>
<a href="http://ffmpeg.org/" target="_blank" rel="noopener"
>libavcodec/libavformat/libavutil/libswresample</a
>
</li>
<li><a href="http://www.mega-nerd.com/SRC/" target="_blank" rel="noopener">libsamplerate</a></li>
<li><a href="http://pyyaml.org/wiki/LibYAML" target="_blank" rel="noopener">LibYAML</a></li>
<li><a href="https://github.com/acoustid/chromaprint" target="_blank" rel="noopener">Chromaprint</a></li>
<li><a href="https://tensorflow.org/" target="_blank" rel="noopener">TensorFlow</a></li>
</ul>
<p>Install build dependencies via:</p>
<pre><code>scripts/install-dev-env.sh</code></pre>
<p>or manually with:</p>
<pre><code> sudo apt-get install \
build-essential libeigen3-dev libfftw3-dev clang \
libavcodec-dev libavformat-dev libavutil-dev libswresample-dev \
libsamplerate0-dev libtag1-dev libchromaprint-dev libmpdclient-dev \
autotools-dev autoconf libtool libboost-all-dev fftw-dev \
libiniparser-dev libyaml-dev swig python3-dev pkg-config \
libncurses-dev libasound2-dev libreadline-dev libpulse-dev \
libcurl4-openssl-dev qtbase5-dev qtchooser qt5-qmake qtbase5-dev-tools \
libavfilter-dev libavdevice-dev libsqlite3-dev</code></pre>
<p>
On RPM based systems like Fedora Linux, manually install build dependencies
via:
</p>
<pre><code> sudo dnf install alsa-lib-devel ncurses-devel fftw3-devel \
pulseaudio-libs-devel libtool automake iniparser-devel \
SDL2-devel eigen3-devel libyaml-devel clang-devel \
ffmpeg-devel libchromaprint-devel python-devel \
python3-devel python3-yaml python3-six sqlite-devel</code></pre>
<p>