From 4912fcc57b05018cdb4578a18e63ca24ac5e2d13 Mon Sep 17 00:00:00 2001
From: Smitajit Biswal <smitajit@hotmail.com>
Date: Wed, 3 Jun 2020 21:39:27 +0200
Subject: [PATCH] [module] playerctl to displays information about the current
 song in vlc, audacious, bmp, xmms2, spotify and others

---
 bumblebee_status/modules/contrib/playerctl.py |  61 ++++++++++++++++++
 docs/modules.rst                              |  12 ++++
 screenshots/playerctl.png                     | Bin 0 -> 5686 bytes
 themes/icons/awesome-fonts.json               |   7 ++
 themes/icons/ionicons.json                    |   7 ++
 5 files changed, 87 insertions(+)
 create mode 100755 bumblebee_status/modules/contrib/playerctl.py
 create mode 100644 screenshots/playerctl.png

diff --git a/bumblebee_status/modules/contrib/playerctl.py b/bumblebee_status/modules/contrib/playerctl.py
new file mode 100755
index 0000000..e3a964a
--- /dev/null
+++ b/bumblebee_status/modules/contrib/playerctl.py
@@ -0,0 +1,61 @@
+# pylint: disable=C0111,R0903
+
+"""Displays information about the current song in vlc, audacious, bmp, xmms2, spotify and others
+
+Requires the following executable:
+    * playerctl
+
+contributed by `smitajit <https://github.com/smitajit>`_ - many thanks!
+
+"""
+
+import bumblebee.util
+import bumblebee.input
+import bumblebee.output
+import bumblebee.engine
+
+class Module(bumblebee.engine.Module):
+    def __init__(self, engine, config):
+        widgets = [
+            bumblebee.output.Widget(name="playerctl.prev"),
+            bumblebee.output.Widget(name="playerctl.main", full_text=self.description),
+            bumblebee.output.Widget(name="playerctl.next"),
+        ]
+        super(Module, self).__init__(engine, config, widgets)
+
+        engine.input.register_callback(widgets[0], button=bumblebee.input.LEFT_MOUSE,
+            cmd="playerctl previous")
+        engine.input.register_callback(widgets[1], button=bumblebee.input.LEFT_MOUSE,
+             cmd="playerctl play-pause")
+        engine.input.register_callback(widgets[2], button=bumblebee.input.LEFT_MOUSE,
+             cmd="playerctl next")
+
+        self._status = None
+        self._tags = None
+
+    def description(self, widget):
+        return self._tags if self._tags else "..."
+
+    def update(self, widgets):
+        self._load_song()
+
+    def state(self, widget):
+        if widget.name == "playerctl.prev":
+            return "prev"
+        if widget.name == "playerctl.next":
+            return "next"
+        return self._status
+
+    def _load_song(self):
+        info = ""
+        try:
+            status = bumblebee.util.execute("playerctl status")
+            info = bumblebee.util.execute("playerctl metadata xesam:title")
+        except :
+            self._status = None
+            self._tags = None
+            return
+        self._status = status.split("\n")[0].lower()
+        self._tags = info.split("\n")[0][:20]
+
+# vim: tabstop=8 expandtab shiftwidth=4 softtabstop=4
diff --git a/docs/modules.rst b/docs/modules.rst
index a99c452..3afc95d 100644
--- a/docs/modules.rst
+++ b/docs/modules.rst
@@ -149,6 +149,18 @@ Parameters:
 
 .. image:: ../screenshots/ping.png
 
+playerctl
+~~~~~~~~~~
+Displays information about the current song in vlc, audacious, bmp, xmms2, spotify and others
+
+Requires the following executable:
+    * playerctl
+
+contributed by `smitajit <https://github.com/smitajit>`_ - many thanks!
+
+.. image:: ../screenshots/playerctl.png
+
+
 pulseaudio
 ~~~~~~~~~~
 
diff --git a/screenshots/playerctl.png b/screenshots/playerctl.png
new file mode 100644
index 0000000000000000000000000000000000000000..588e74556adb98c0365d86e057eef7216312b3ba
GIT binary patch
literal 5686
zcmV-67Rl*}P)<h;3K|Lk000e1NJLTq00CzJ0018d1^@s6JH8B+000RZdQ@0+Qek%>
zaB^>EX>4U6ba`-PAZ2)IW&i+q+O3#tlH52Bg#Ystdjx_HfIJStN5tM>kG~&P)ji#|
zXFZPClB=YqBoaU-5}?EW&%aOj7oSwRhElC*SB-p1FFg$|T6}%_^DD7Dzt2bQeI?(=
zgPiwEiJ{Cnzy7rGI?G_Z{`JDg8sgu_Lwnyz?LCovPW*iGUHM+GuSPPSUgJ{U6ZQQz
zxi|Z2s=p_i?*|`K-rw?R*6Vct4&MfhD6PsuIi;N?$LF`bEXc3#;H%GXzRz)g@GapP
zYVXMi$T#;s&M|%s(6=CeT!kN_FZ%1?r}2Iw{}9Xf^MQ+B-jMpkc>Y{JeO)+zT9m%u
zXyX&%pMreOYUk{iccUl~)i<M_V9UoeJm`cxKd&i=@vU6jb99atN1Q;u;*8EQrAq>p
z6QszJAxHLeo-#49q@9d&N)uS_Sj(1rng9br_mGn;_q=igxtVsznc?(li#+T0XT2$n
zm6z~n5+)N~`P(D>ubY2zgmdN%k=$U4KC!~Cba{;#7rFb(QvmYL%bR2J<#@v%zYq(m
zf?$2Z+;DJ2e@)?4{^C}CaLzneIlod!g01%igow2(#z+Q%sFJIwL`%s;h+_kwf#oTe
z<RBomriGEI<g6)JYU!@cJ0{PwsU}T#7;OTGN@f|@^gIBolnQ^WG&nSBuBFzh)oKg1
z*P&U9R#i2<A~!5sv1)2&&AN@2TWPgvv({Q~qo<zHz}mH2Z@u?1QWz{Wm}~I-V8oMW
zFJ4{Uym|LAq0cO{PMtQ}>~pNN@<Jw-E?aH&HMWF}QtYzp)@{4(zQ=)UC!cca(PO8b
ze#R$iZ&ZIe{s1+3qm~||?sN8u8l%DNV+y%)QZHs8mWqJ5T?8O>x|qc#rKF48#Vqzj
zQq+Wz^<op2T*QE|Y)SRVCw6}!_m6N3wf!U9((jN97rOrkaslXm#_boVty|~jgV-wz
zZ%kt*`?$Z`2nk7yT^Gx*HPdP}H{+|7*G^tjc5Fv;U8cPf#qD{FBE#0eh@Q92y}X8O
zyD#0*%0#NBA04}-g`(!I=oB?~+R0<%leisSL#?@&?bBx`^m>HI2lpP!j=EBITS~-Q
znWcBfs$3lFr0dLO71s`Ga>G;>Q})@m<9HtCtA=#;vVK?Iwys%RP0<At&(*0)g12Fl
zsGgmO$<$6Hb{SL56kMXUB^F`><xR;vc%8hh3tG$-6VKS2cx&|1z^3@gYF#v!xx4d{
z)<#TD#3Fb!{Qe=?b)=&yEl1d)Y^t5wGms`GpS8tnVON5lhC+%Z#A+<7dlA7DR96?8
zq%7`EO;1hflg6Q`IMZyyaw^JY6JSl-2vna{njH{{wdDy>;Y?`7ww2nW><pQc56Ltp
zd-g%1MWPz>jqUahdRVjTiK{Y}Vx6mN+t=O^bQVaQjf7vst0pF9(WJEi1I+XcE&6iL
zd-aJc83uu1HyNjpLdS^L3A%3pDP!sxZGa&y6X?AM8lrLMJhu%3f^6hVaI@-dP`shi
znt8Odr@IC4-VG(_sX9C@v+qOxoYGDLg<87A-2u<1<i*63$IiaAD5T~Dth(ljfl=1%
zL_-lWuaolNe#^<+8~9|cmV^u^;&C2XIpf_bI@KU4fl-K<BuLuBB0K|V*d+xWl4)aG
z%PaMZLUTNFgZW0HpR$%S-B}Qmls>n;Of8VEX;%}Zf=8t9-d6@$$UZIIFy?wZ_cOCc
z2o*K8huXQ-EnrqOdoL}_n=Y;>AVEb)P|!u7t=(*MQmm)dckXMe)6wi}<=VHT6Y5y2
zB~)Ry96BB3M)A^YajtjbeWcwx>ChZ%Et&80$-ulF383RbdY-!t9*qU=h0Yk^sSdNQ
zpBJ&3Ce$*{5e=e><emym?p|fH=o-DAiuwu(ys`(>l0OyOiJQU^%7*W({divo80H?*
zNZoU#RFjinsLDp!tHyDGAY?lSgB|%a9!R7vx#Ekvq~3(&Y*t8k@_paw77@-cff|Ht
zQ%3ztDXET}JE&n>?S%v)dUa(e)~>MjRtrr8K9Q=sX~Dd>3zS4JpNI-XN+)G%zi4nM
zM*hO3YQPNeB*Fj=>J|=>o4c+;3$|pE^+-S-H^9)*_o>O~J1JNzAgHihVIa+b;{eci
zH+T!&tEoI%yiU5iu+$z+Y(kTCCzyl6h1XR*u>Bagbd&7nhTX7GMmu?ddLMytmtjsZ
zKwWWYKNOjeq@8*hjw)e$cr==_OHtqnB}NIBFD6@UqCv4D?$z<lq)+w(y;ovyQW0G<
z!F%7-(E#jnW@oe@5l^GNfunCMfGGl&D1#z*c^avosL5sOZg3PWMb@>_6`Vl9BsL3D
zUYbGAo>AeQDm9Dxl%$S}`fY))np`<7k(wPT$0R0uG8Tamp-7tZDn2@f+Ct1s%oJA9
zmE7*W4kU0;gq9)lvD0cSM8Yp7&t|x7V;2!nX-8;^3p}95z<DBn`oKfV6^WamAbl57
z%g#_b(NFXo9y9OV9Sa5`p&?Pl(yeNwPbxYJsmXKP-LQtt#vP*EFp{046{<?5!g<|x
z(3%h2VD|aIZTMU&+-DB@ON%~eeA?YiO{Z=nZ1~qbueNifWvK0)zo$tKwUV4fnjI;@
zr1X($y<LOytHM)FNia%$lX;%>VFh0hgo}3RiD)Meb2s`v5}sSSZ~-knYoSMMyl6Bi
zv!|I)B4tX{Vjue+<ewus5R0JHb^?VZ!8-^;dqf)UqziToYFHsRsE=eUWu7fHJNxsZ
z_ttZnNgJ~J?HTbgP^Qthe6NWnZ6LcO+w6s%nBGc8bN%X7{PvwRBWMl(?tdM;&bbQ{
zgyGa&I<T!Y1V`I#tj{eR^=WJ91?VlyV)oa~7(Z{z$j3{4EfXklw?(AIDddoWP5aF&
zU*8~~*oM;BY522OgbJ5l1z^$`;=@#G_HDGDt_Of=H?C6PHkB}bnnf}G%gy&1pDVB#
z|6C({EJ9I1LB1^lbGQ863fGJH#fwm?-zCZ~omej?zRj;MAAVdR{LYE;lM}!8A^bBZ
zeh)=>;QM31>8F(a@@y5J<LHEtmAx2*F6D!%*hlpY{{=ip7`*a-XF~u00fcEoLr_UW
zLm+T+Z)Rz1WdHzpoPCi!NW(xJ#a~mkA{B>r5OD}noh*ooIBFG&P$AR`tvZ-o`XMxF
zNK#xJ1=oUuAB$B77iV1^Tm?b!1H{SENzp}0{9jUN5#zyeKi=JY+`R*YdYNff#~7gL
zwwX>Q#B6Rw485WYK|~P7kjyM&R+3Wi9bfkd@bxavv;5EfIeOK+#ejfFJi`prCSE6=
z+O!SM`@~UJl2zh!;!%?>Nc_lk#p5^5MVAGh88tKMIpQd>SZrgZjakXmh$o3-s-{!E
zko8#Qyv127S6TC({DtAXzP!YBnuADU0gI3zLO~T9D8ojaR-F_JY1&Wt_y=6SL@tF~
z8(`#^M+F*W*AM;&zq_>x6XRY|I01CNIL^l~5ZVPAHOKircAUlu5PSx%^p?L;2c|zs
zueG$;5zw~{TwJ#_We>RA0s5Z|*_2%=NK+^jfcG={rW_Et1$tJ!-kSS3eE>4lRq6&f
zI0QzDl)dKj?(X*9{yo#|?*}61a)*0JiroMJ00v@9M??Vs0RI60puMM)00009a7bBm
z000XU000XU0RWnu7ytkO2XskIMF->t0}~DjCCeds000XONkl<Zc-rlqdr(x@9mhX+
zS&%4?T|otsh>K~b8lw@Rc9>3!C~5!+f{Kl32sS>VH~}+_O(snOv56fu(Sd{}Qk^E4
z)PR8q)C!tn>`WzMNXG{n42U920KxDGvh3de0W2)6x|o%h=QG31-h0m7^Si(EyWc(M
zch9|mKp+qZ1OkCTAh<KqP%z^B*^{#93V}c{P)vDrwlvgj91;fpV(KsD>(^^U#0Ug}
z0pWXX*^n1!h3F=MKp+s}ED#6;0wK-<fj}@kQ4S|#p9~FUl)XLa>FF2@29q);CnwZu
zHJ2}69xz*+RnEq3y<SgdW+u(eEzAp?hljhnvCLqA!-xM#ZEdZHIDw#_I5|0?Qmd%A
zT+yd&{`>{Fy1H=i;6YkjTZK3e7SF`Q0FalLM}2+0N#`XdCX$_<Jz(P8WlK-KKK(W4
z&Yvf8StR4ejWa2`a;1WTf`TFE)0C7H+}zv%$j!~={rBG&YH%O;xj*)}y11|>HI)}$
zc!AQ=Qu9-Ag@SeK*5c>qhl7J7`FZ&yB_~<MRu>l+5)xkLl~?{md3m`>*;7yb4wXtp
zVPWAdZ4=@=h`*|diHUf6dXAV*S-*Zg3l=Qsv;TZa34h$O#j0(sTel8?gx3>BjQ?zG
z6l7!^BsKMK96I#5asS2*8=3alG~+q<hYvseJ85bAIehr=p!?ZntP4>qqwx0jX7uO>
zsIIOiGb@Yyy!?A&PiyN<jvYJ34?p~H%Q`+jJ_O7OV9S;*RB5&7bULf{siUJ4iHQkj
z1zMyvgfI^%wY9Zu-MY2cMbe7k{>IVKiEZ27qN%x=<m6;(YHH9-(%|9YanIUpYHnip
z?%lVo<Kf{!U0ofemoDAYbHASidf1BdNET**_V#wl%F1q8K6T0zmPJP5<u#enqaWZ}
z<ux)gGAKA+U^0SyCT2Br{O2Icda|+(F?VhNd3i_3$T-+9d;I<Vi3pFt-QA6v+FFhr
zIYL%emPzhEG&Gc;pdegbTxe`;<jk3~?AW<u$og24BqAchS-9{CR4O&v>M9N#IKc6O
z;{c2qGlsOZG?US0*N8JYIhnk?yngw|8bm~d<LKl>T>NGl8#_j_z2n4^*sz3&o)g)<
zt6P-Kr8PEg*vP!VdB*L`%uE2QrZw(YfgYCP?BwJ`e0=<f6=q8q>*7LjaWNl#^bw6s
zP0aH4=J~kisj2y%bLY<kuy}C<bNv0;wR;y;*RHWLDvELA#`n9ez`#IaVq!>nFNKl|
zB|PZyAhEF<(dl$#XJ-R2W5x`kqodireLELQE}&AWnB_BTNc(W^+yItGF6Z5M-=pNh
zdHno-O?+HD+A1v<FJ7d%xtXxAusfzTEb))E@b&ejsHn&&%y%0bmQZoIg0QeKW6s$e
zNy$khB_|OP5l&#>{JTmS{S<)~;ylE7`Q?`xKYsj(?ie>WH{&Rzi>$0H_U_#az=;zl
zOv-X|bD2ADE<V0K#tSecB$z{o4pDgWBmnRIHHB1P-+tQ?xqLaFewuC^c~w_ellA%M
z1O^5g#mCLfjkdNnPM<zaYilcY*Xy|S-K9bG;p){ftX^$;<5sKH8b1dIhw$%$;~e|q
z7y#+%pYp5Ovk3_fVdur2R`rjym@s}kr;3VhTgQ^v7zyc}#KZ(_ZS90O4<!nY7qE26
z(h)7r=5o$AZrm__c5rYcJbW?JXUssYR$-&C!NI|Six<D`oRW`5rBYE=);;yBzg~aa
zn>yxjc6P?q#f4R?R<df<N|UmlIq<^5Lc+ttNl8iJoBw^ox8IiXpA#ocR@GR_lcAwJ
z9UX1lPDn_gxVX6A-;<e{X|h5lGBT1$lO`Fr-QC?ens0g&?Ypu|czI2>x__*SeEV0?
z+$lCj3WbGV;p5|jy}i8<=b=JwPA)g<8~FXR&yHAezEjS5^X7OQ9Ua-XcQ4wiD)a^e
zFTL~<3hDN*43MP$y;7j7{+n;U#mSTZy=A@n`g%5O*ub=D)0jGSD#1ZPEL*yaO`BqA
zXlUqHn@5j*K~d4^?jNeUyIUV#S9jgShfR%5eRa;<`O4P!kF}_-sp+#!(^|1HoH%;)
zC`n04#+l?uWY|6-n4Ocuo)13Yeng>AFn#(AGSbsIbLI@Sb#*j0HZoy?o3T!Fa|;a(
z4S0EJjQiATHI9ysX1}ww^+)XNM)ld>(9l5L^*W|cf6SsEl;YxI_V3@%=FRaqIE-P+
zlqvl_zow=}u2x<({@tq)XjN4e8jY99KFuUAs;a8`)Ya+QQQFx2B>&vb&z4ej>J;AI
z-Z(fo-gRtP)1JW;W?3HDFS8uhk8h7;fmSM&Xfzs=zlR@w7yyI8K$Z3y(;t5vg+hT+
zX+v~$G!719O#PFcLr6#nzP`SAczCd8%^D1Pz1j9IT)e<6@0m>Ynv7bl#?G!gm-mlP
z4zO_H6D(O0!9x!|ghrzwWYHp`Rzw-=`1$z}6cofn&xyFYx)K;TA6bTqii)8-1Ix|D
z|F^#(U`_xY9_}nzvXn=D_6XUzIeqG0tE^;}j}Oky&e+=8p-?FL<sVD@YzY||8ML&t
zkeHZ&udgo}jfQ|Z0mim0jSXwrBZOI`HEt`=z=%t6xVpOX_S<ipPSdZ~u{vfo06Vtt
zVC|Z<q^73Q*4D<C$G_y<*|R3~GcymOR;!4Mi^m}AIhgSoUS3}4bnSiG%gM=QlBb5P
zf8L6{y*()@DaMrvM~?i9n>Skt3kzd;<Z@bXwo+bxnVg(%5o>8_A!N}aR;*ZoQmN!>
z<yE%*WgC^1l|$CY`T6;%RBE1zT7g=nMq90A*REY$C@JYvci+B!tXsdHJ$pXD*4EBs
zDV-($vBb}oaO1`e{_x_9tXvsIZ0sgRKVXlxTFYmjb>BR;BsMIu=hatVW#-J8#=6_L
zZwKH?#T8;V#R_4*#|*3YIj5!VXVfS=o_=~2&CM+)Wg)@Aw6y$ayz_pqNlV+$m@%V`
z+p;VZ7Z*o)c{%UA^Nz`lCxAD$zQL)lP7SJ`ZEO^L{P8F3*s*g!@}mNQHSqNGWYMBf
zl9T%ib8>Pr?(Xiy#>Vz*ATS)>=RB;$S*cV467B7}LAP0{RCd~faXQ)7)@BsJo=bdW
zS?1==n*(m+gb5RPbn2rNe^ZQ3*UsX_Vfg#|^W1aKiKh((BV+2Xv_X<=(COOxb=+_e
z=V6uBXm4*HQnuX69=+axUO)Kar%)&e3Jzk;+BN9)dP+-6dF}PrgfI(64DIcDKrhl7
zgFSK<2m}IaApT92Kp+qZgg6TX0>MaO$mE>IjvXg@Lm&_g2;XbVgg9Hm&(F;^yI-RF
z@mNWckYyP~=Smt`0z<E5HIgJ5%K;2`NU1A&Jf~}rFtdJA0!c!WyW8(M-RS)?NV)fO
zzn#ZOfP~b2F0zb5p}>F*vaCmv0NG%CY`Dwn_RjV@+Uz(tsfTY265Wp)_x#+6{!TYa
zx{i@L{Hj3ew6()#y@~&%yO?Zsdq|dg@0C!<cTW46Ij!#Cm1K}R{Q&4YHjQoBqBJ?U
zcmK$k`cpze?u-Mu)8{?y@9O`q@0VnQG43Q;(Gh=ujlvdZXJ;B38_>1uI^tGRn8ud`
zdRc*t+{2??5o_qQPhpHrlem?8`&ZFvhmDEn43eSatj(?qmXNx7LYBI(HMyrXvPqxG
zy{;#@SNQdOHGpKMNpt?E$8lz_zdp75`o}U%W4VMv@e3so2m}IwKp+qZ1OkCTAP@)y
cg8PR51BG=3&?#g<0{{R307*qoM6N<$f(-y2-T(jq

literal 0
HcmV?d00001

diff --git a/themes/icons/awesome-fonts.json b/themes/icons/awesome-fonts.json
index e660c1d..5a5269c 100644
--- a/themes/icons/awesome-fonts.json
+++ b/themes/icons/awesome-fonts.json
@@ -65,6 +65,13 @@
     "prev": { "prefix": "" },
     "next": { "prefix": "" }
   },
+  "playerctl": {
+    "playing": { "prefix": "" },
+    "paused": { "prefix": "" },
+    "stopped": { "prefix": "" },
+    "prev": { "prefix": "" },
+    "next": { "prefix": "" }
+  },
   "pasink": {
     "muted": { "prefix": "" },
     "unmuted": { "prefix": "" }
diff --git a/themes/icons/ionicons.json b/themes/icons/ionicons.json
index 4b90133..3e577bf 100644
--- a/themes/icons/ionicons.json
+++ b/themes/icons/ionicons.json
@@ -47,6 +47,13 @@
     "prev": { "prefix": "\uf4ab" },
     "next": { "prefix": "\uf4ad" }
   },
+  "playerctl": {
+    "playing": { "prefix": "\uf488" },
+    "paused": { "prefix": "\uf210" },
+    "stopped": { "prefix": "\uf24f" },
+    "prev": { "prefix": "\uf4ab" },
+    "next": { "prefix": "\uf4ad" }
+  },
   "pasink": {
     "muted": { "prefix": "\uf3b9" },
     "unmuted": { "prefix": "\uf3ba" }