From 2a6f1131516cdeb9a8a57d2a8cf4d1f2b315f364 Mon Sep 17 00:00:00 2001
From: Chris Rogers <ChristopherRogers1991@gmail.com>
Date: Sun, 14 Apr 2019 10:11:52 -0400
Subject: [PATCH] Add function to acknowledge success non-verbally

---
 mycroft/configuration/mycroft.conf |   3 ++-
 mycroft/res/snd/acknowledge.mp3    | Bin 0 -> 6268 bytes
 mycroft/skills/core.py             |  24 +++++++++++++++++++++-
 mycroft/util/__init__.py           |  32 ++++++++++++++++++++++++++++-
 4 files changed, 56 insertions(+), 3 deletions(-)
 create mode 100644 mycroft/res/snd/acknowledge.mp3

diff --git a/mycroft/configuration/mycroft.conf b/mycroft/configuration/mycroft.conf
index 7c35091a48..d827bc1e65 100644
--- a/mycroft/configuration/mycroft.conf
+++ b/mycroft/configuration/mycroft.conf
@@ -44,7 +44,8 @@
   // File locations of sounds to play for system events
   "sounds": {
     "start_listening": "snd/start_listening.wav",
-    "end_listening": "snd/end_listening.wav"
+    "end_listening": "snd/end_listening.wav",
+    "acknowledge": "snd/acknowledge.mp3"
   },
 
   // Mechanism used to play WAV audio files
diff --git a/mycroft/res/snd/acknowledge.mp3 b/mycroft/res/snd/acknowledge.mp3
new file mode 100644
index 0000000000000000000000000000000000000000..efb06b4975178a91399f14329f6f5c40420e0706
GIT binary patch
literal 6268
zcmeI0S5TAByMU9>dq+A6y?0PRgwT5lp?4vG0Ys4^DkK!C5ePjXy*DX8Km{QR77$UC
zpmdbp6lnrM`HucQ|2dcE;#{1WGv}Gv*^Awo_x-+S-<{nBPO~UM{|#nW{X>6GVfo#d
zK_H$xAojnA{YB$1W`A+}OUPfaf64w&s{hjcm*Kz6{N?LkfWQ2XrD+MbGE!C0)C>bR
z{yRfXtQZx8F$jeHlZVZ|*3Q2N{?GQnA3+dEte}3q4=>0_q%f6I6hs$n$Is~t0=o<O
ziX>q{tRM(SA)J2WDdk{XI_q`{{OQx@P(4UgVj49ywc`7^d5%)}i?Rq4S%EM7&-VAQ
z=W}wJg(;!Ov159xEM*EFE6=_I33y6j&5y#st&(GJMi7XKTj0UB>*TfPCdH2{MSC9)
z)UKw0!e}9MP&`Gy$1XLG6s?wJ;+m}l3-KP!LOcxx_iIS3aKbMC@#kmeF?z{$7w8|F
z*6xRYQn*n|5Cr9zwpZcX5DO!yk?E*8cXpQc3hK1<;<k%ZCRVfpG+fRCj|QvVMY;17
z?!F8dR-y27SXHrKak@D*vqc8TSjRvRfiXpm@)ad51S*Drz&JOVlQhOFY?CA@j_hS_
z&iTwyGj1JQ_lGSVK2}gB?G8BJ&pW(x3a~k_os0Z=b2V<!o7X7Csx)R<B*$C?dXZ=7
zn?sR9n1xZ7jMc{t-+bEVuu^|vjwfSdswZtf=osKIoGDdj8d`)tPL3_gI`L6(TwMF3
zbuqaFE0gHhnw%79v2A!{{d>Nv9l&Wer3jXy>oVf1f;aVzW-Y51W1u&J7A}t-fxs!!
zjgrDjATpXvuZEERr$`W<>mGXQdUxvMe)t^a0zir%kDT^KDrOmv`HlZx`D15RIjgJQ
z(A)WLAt|JmUJF#VF^qASJ!i@1NSbxU6fBZs$Ed;}r=bf?QKGO^>^N6kSrkU=qG2R@
z-tJCM{A9Vct=18GbvoC{UIPA(&^N{Tt$zsWg|Kctyj0UQgX;1R1;))nt+rh0VTthH
z5m9|a^0?)rKwNBh7Bz?}F8HdLJHIytIEAIo=0MM%51Z1a7OWm{S2-yfoXO6f`rS?G
znxhKhoFAgGu7UG?G&$V1g-eUW@RT?aPMQ-2zItTC(U=e-`jszG$ixK@c!3RGZr6|)
z%&-Fl1a@$+Lehq^1z`-6as=zgoY`NCb&oLwwxzK#-c-vTNs`n%)>)zHuSWjRuXU5u
zy*07AN_&nwBm2s&hL&HLnbVlFyhtnafLL?3dgAm_jMtiJ4$%G2#X25lig8!-#u<yM
zmJ1Wza}S>SPb#tBLyBH(Z3X`^M304h_nN)RTTbc0$e{D09+W=J7W9)0VoR!MdRV3h
zvDucsHZC&EiWkAASS3x2YmrKeTP$3fu4tpB#U51dirj08ve4TbsWoiJr%7SX?pfHY
zC^~sPY_QU+1~5P?5FrbU835zwyQl1fvn)E?1hG!MN?csQ;cX67?0WombFFH0U$&K*
z+8lh<EuW0zqK2cBY7>uQnAH|y7?ry0$QYn>NI&%GUG<2f%)&lH<mjaqvUDnf)1<*^
z_e(1<%AN8c_hw-M(!fK$tCCi~bHrNut>I}HIbspjch58+m4H=CiM!-(1^bAGThhOz
zUc3$(#;SWiy1<NFXbC<9$fJi5iVhBT_S#wuu8k%(o4@6IUN$NmCVteD$Cm90C$-LW
zXW5x~Q_2d`xSI3(X-E}4muv|!Q)V$@s-*RT`-|T4Fw<~Wqvyn(6T?X|jE2@;=Tzgj
z_v#5!Y{-V23TTa(S0iqjN_cnTT`jk_1ODvfF3V+r0xT8c>+xB)p5bOnz5(2OrM(tD
z={f6=<nlC3(pStmBl(XZMiAuGWionQzS?a|W<j~8JblX7t`^#jkAk7qcGIRM$<{9%
zi7vr)-@1pA8iEI3^AHbs`;K0W&KWLrelPx#6=FVWsI98fggN`b53Cb`$sxf2;4I}8
zl*i5W&D%UOXP`WA){guBElJFjBYWWKvczN1Hyvi<IK&WrrZAxeh3<4YU*U0DtrU`|
zS4e!f*MKjvt3j5o*s%shS*T2<ttt!3-qPly)kXi)+~9}Y0#<-CoEdU_RAugdwQ<>^
z!RkUM!La)|R1?l!?Zc_Y{`d}RH=f?0YN@(+^bW<tx6h9hI3QZqr(VCNiSA;|U8X6?
ze0)up?zMLSK)JF@D?-N)p5%xF4urM<;D{{SsKbN|=Q9?0?jUsLECVS%<x7j7RR%XV
z<bJ8%U0+Syydj?|_jdL%8Zq}XSYhNwu|0$nW}I^kygqRp;&dj>9pN$i@byb-b<t4@
z$eoOA3{YMJyT8}o5;R{%?x&8}1h%5sXyaPXn$<~GuIVq8)v?tbtP$h*wI{RQx}3#a
z3^pX>(9p}=3e!J^SbiIFet(iI5AtesUC_Clh(q}rtuh{g<0=B5?52$=DhZz#49>R&
zffW_^h3-0PG;c~>M85YzWi*z|#lAfZP1R^wuHo%!J*=?21_l;@M*dwN8qMCvwaoZq
z=g-1>Eo`jyX_n&oj?*i{mvY0Oht?rd?_^U%i%loViIy~$>CLmITZxR*@dusiXvSp=
zuuJ8r64-1<gHVMH0mk9ohdW<VqdhcCrmV|=A;!&xBf!x@a3WW4?OMd#BwUwprMM18
z0hjN3%2}`O*ws}%zFsMme!Y}y=tcFDZ^s`*UZ`r^rPX&(m1w~@eOQwypC#+ti^Q-D
z2Ri!(zPUeYkyUwEd@|#4n{1`d944-38|?i<d+i}$jL9f+1B9YT1ulo`9!rIIX!jJz
z?fwBivf}=!pEfdif4$~K!=)$r{!xX&)H)COn2Kgnb7Su0<UDu@doPu>oViju0yDhg
zcB@x2zvts-()62<#@F}69uom2;804pS}ruukMPb`hAviS;@Zd%+@UIJ{^`;bezNdl
z$t`D^cunwS`>uc05EioM{NW_Q;i<<KpUp*7CxcZ0d=2LWj%=>KSdhl*jxz4iL+>xB
zx`veJ<f!_@dJdaDv!L@CMlp8&*ud=gR(Y9ec&&RLAb)JW1bSVcgAygI`~jdB@CTv;
zsxITwwazVjUfs2|{T$NWe4*%tYnjiY!<p?Ki=Y8Y?PfrZdbvVEyiDqAF=s)Rg`cJE
zvD?>-<IA#tsmU)P3_n?SJ=syf6=_fW(&5rQnauh!Y~uwKADTpX;+AG5c0?{dT%l1j
zGArbL)INlzdv)XEex=eU{`;G1;xCb~5-$4A+tB<wt#6FGL<3`9oc<J*kbB4==Gkm8
zy0;<xv*?GjrvqC0ps*V_-2zTczyUVEDV2doCq1G;SA{411eHucaEP%Fi-79Vgma6=
z^l7nMd0FKR@gnvFo%ojJ{wuq=e!!1{0Gaq}30ANIbP1u>yoSk~`^_c^-P;wabz;8u
zEfc^up=dd6)c~NQFmaCy=om9Qv)l&`WSolfm3^>ZJ3ztvu{)C?eH!`Wu+2u<rMZh%
zdCl5WT{Y-GhS)$9TrRfJOFB<4f2G^uUDIN`>ua!<NPZUf+tBy4$(q$t_e5==3MiE;
z#I?aqTM6;u?^<+3UPZXN^@Ymq<UK_BhUf-3wgUU{-#!6A>4I6~OHBFFDJYmFPp*Z|
zT=or?K22aYIMLsD04(Oy&||q7QMVaYZ!X`b%Ju|G;$|_z>&ezVex207ZQN_)<;t%W
zCXgq7f35{J9pr(t9$hB`HAE5v&)fO3v)dhBQYun@x*zs3&$gqtQ662GS4B01rZ5S#
z>s*V7X?yvdp@HU%9<=c^U!O|HW0L`I3<xu!-+999S|Jl1bNg93Zi%P)eNf}GzLTs@
z`U<RlAn)R&ku_x>ORcHR^cJQ^D3J6_i8_b(eu%_4pf-AoBf{pG0GK}^nX^OaLdNQ-
z0~eHi`de7O3^+FOi(d=$LXtzpleKntJX_0v&{Z(on`(iLtmPy|>N#=4c!T_O^MnA$
zK4FYD_pl_80G7o7<kFw40m-7@jC`rs4*5ej&@y5vaZm|(NC&I$hGAyc7RvXwle&cY
zIbPQPtf54N&4~}!m|dFL4%4C~{dESN<>t0H3s~I~eA;K-getf6`d4NJ$BEALZctH1
z&H;D^L^Cp50jzFl`175b;HP)3zwAiiza#6!exVUq%FI0IJ<AD538&;{pAv!OUH3*0
z3K&YcmHcBzq>T}JGMcu&otr-~91a|4H6Aa)2#j1zKm6?rj9RwTKE+}}<@?rd^``>|
z1o~b8*d|ii+w6HgF58d@jD#Zs{PMG6kt#;c1^f{G=U+5A+IXa<xkaQl``Yd^>C+r(
z2mU;|#q03(9+6lTeB`U?B+)d-jKf7B3-rT@XCoj=Dc~Pl)~(Jsg9R?w2}N?U8V4`S
zl?n@WFh(HeBz`5{;2r&BR>Zx1h!(%G7L79nKu!h-2^uRCs<;=CiV9ZRWkJ#g(ZM;S
z%&qZ>JR;B*01Q@CKA;}RsI3wX^d+P9N7zm1<Z<AKCu`9k+H!cp+jg%&+?1hNOLaHu
zzx*Idy~=hcziQ1v-Ak9+G~O(d{UlYAyWxm2Io$lZwq15AZE6Al>rNO|iM%bnSAPsi
zf*^S3(G6d&Hrqg#9jbUsdY1sBYTOZ<Wpk}kTY+<b)TuhF>|jHYU2hPt6E@yf0RrKR
zn?f_x5vH8!kF9Z^yC{5@Z>W^68M8)2=BA)bdfRcoge;mfb}C<wY<%)J**YsFc2TvR
z6#y@>+St((mJe~_En1D)7pA-hC8Hv!;=U(-wth5O!J`#)L6;OyoiWB#cAWPhOel-=
z_C2XT`aH0vUDD@LlxLuOaOCv^_^K1^oxy>VnFD~iv)0?OLwEZF8}-@S*piPZ1kMtQ
zPPo}Fzo@Q4TwnVnzEwqYFwMg2^~*kTfeEo$83yyuIe*|BB_(f%Up>Km!T_h>%uwLu
zwWw#Me&CH6ks5tDxxS8<Y)-meT;hSW@rZy2y{vUbzS;KU?jhhW1Ne$-$Bncr-qHPs
z_v`&9f4a-my_~WMudxv|qQ=~u^_@9Yw$qvY=X`-|U~kv&BZ4g_@at+o=B3gKRbumn
z74II7>rfg_xsK^|7gAZqOgPeH{Hg(Ib57ah!9`rpd{5QkV0(+N>O@H%8(|pnulo=j
z3rW&{d-B^5VnjNI?spBDp)6_=ovvF}pu)N7l&Zu7i+hU6n<XwAwObfqo$UYs4!<R-
z<{ceSgaU87u?ioj_p>!pbx)m=-^5cT@Pfpd%uLViLW|mO1u(QS^Pc%D_Y~Ts?3trY
z@gli$*ta4L%K<lBo~s&h$CB#+T53%~Pq@N@tSov&;O)^-7N#2F0TXvK%K|G5QfOb$
zQRzX%bv1vL;>$S=8&6xeH)2*DtKZJdi^sEh)~`$yw5Zk8-E!`2u-sm5$zIqbdd@|G
zqfi3uDm@g9jvdKvKjuO&v$DF>q-ly8CJ^CHN-X;RtJT;Kn&xjgv!WIKcd*px!z)cQ
zL${Yd`5TeYM;L#xix#(k4K(h|f1C@>hTRU1%pP%^{pzhh$kH7G`~q@qT&<HYbtV?$
zYPZb9Kn~irn`%@H=?Ir4g?=$@1E2gZGHEUGBz-<($Yb+}v}zB#N2=4QCukK8C0%{j
zKh+q~f0}~<7GDDZ**?}Eru)t==7Nl&#O!eX{d*$JJ!VxpdOWjKv`o^tKQ-hIf>a>h
zU#aJuwQ17yp!#jdG(@(xEeNiavZ}`U<a>$hN(GxDspdM~BQ}yv(Rpas^*$#njWs0`
zk5a@El_m5G_KNcRXtgIV<DZ3ZnxhO_xPiSi2Ya8oJA%KqA)1KfDY4XoFCs*HcO@SJ
zE4zeGgBOKD2!BlXuBUT3zD0n(8FGPI@&Wedd`L4SZiI!3b+s$AkSH|ADSgcu4-YBZ
zVl7!*<XA}4opJz4@|yQ`yjrau-!~k?1hPLe$-aFx#kxVg#XYk?YpGGt%szK3ns7B&
zx;t9>TN6<t#RKKJFmoEaGu@R%jXB#u23VCGOude|^$$*W4=%OhumG%{+%Kyklp;2o
zvYIcb>$_Yk<kexk`Z24(Bj_fs3Qr4ZNTCz(;}mq>9)J{C@G@T}7`@v*Zc5vop0{F#
zmI2CK;)_@%lSax*M><>cpev**aX%YC?S}Uj)^?WW<zRVE5X{6Rjw;yfAv4(bz0gEY
zaW`F+zBB!NmVoF&28wOBgO|t6n!af{fazRL-lY*;#U@OcR;8T8&cfgyLpQOI8!qPF
ziqhZhQ(WAYM0)7qDDk_AE^rH2b?5n1CH@^A1lpeS9(yVzisafcWtpUGm}f6a%^!MO
z>dHl)ao5Xc^up_llk0C@RaGV2E(soqK)i39H#X<YL?8=WrjLr|rydZ|qgD`s?&`C{
z7avBVWXJW{XS!xAM9sKLr0zW#Ue?lch|4y;+^+exVeuoR-7PLr8@wq0hGIN!0#;PP
zH!w~_J{x@A7*uEKKKS%xqaEr|-Qbp?B*+S#On+~HcR`*K-`7J@vbj2F@m$^P5MQ(L
z<mE%WDDsC|jH;`ZGi`47cK9mcYrT*)Qk0>P`c=!?WUY#k1((i6>p+(W=t4v2;`|}K
zg9qKU5H#Emq9^}G=sB=ONuB)EGn;A!3LQ*}7)bTRrqVO|=hN`fy=CS41haD?*iGXE
z@QIz0%oS)M+LUMdM(~ow0aTCi!Mi-;O7Dt|jS2O&sJsOAG*V#Lm89POu?OY0ZmwX^
z$=KX>kRj=Kl+~6Mn$UWeRYxGLjZt;d)X~BD+9YqHQOeq5RlUnRl*4}v<$@sjl6Ha8
ze8C8VQ~|04SNdylf?%v4Sd&n-tdwaxB)%m_|9Ojf_R2TJRrjfx>yGmIkB!{4^=C_n
zTaohre%@42b@-nGf>46|n|RH-)d}hw8oh2SUC=Q^4yqGvg)HLB;VZ9%DO8r@p;?@n
zPYv}=$6iSpvqSLOX0Y`S9CR#TIy0dgKV?$Bo1UY)`4mJ;3FaAOtMo})G2&bv@cRBS
zmARx-j7kKF=cuqHl-<=c6TAJLkbiP6L<lkh%On}DBfWX>{F>16BPu<85i=RR^gyvu
z^Z)v~#{V7u7)oQ=Lkd6B^A*IJEC#wziYkCW;OgH`#ZVAP4GRKM{_kY=|55+`f&TzY
C3#+XF

literal 0
HcmV?d00001

diff --git a/mycroft/skills/core.py b/mycroft/skills/core.py
index 06febb605a..7d630709b5 100644
--- a/mycroft/skills/core.py
+++ b/mycroft/skills/core.py
@@ -44,7 +44,9 @@ from mycroft.skills.settings import SkillSettings
 from mycroft.skills.skill_data import (load_vocabulary, load_regex, to_alnum,
                                        munge_regex, munge_intent_parser,
                                        read_vocab_file)
-from mycroft.util import camel_case_split, resolve_resource_file
+from mycroft.util import (camel_case_split,
+                          resolve_resource_file,
+                          play_audio_file)
 from mycroft.util.log import LOG
 
 MainModule = '__init__'
@@ -1648,6 +1650,26 @@ class MycroftSkill:
         for e in list(self.scheduled_repeats):
             self.cancel_scheduled_event(e)
 
+    def acknowledge(self):
+        """ Acknowledge a successful request.
+
+        This method plays a sound to acknowledge a request that does not
+        require a verbal response. This is intended to provide simple feedback
+        to the user that their request was handled successfully.
+        """
+        file = resolve_resource_file(
+            self.config_core.get('sounds').get('acknowledge'))
+
+        if not file:
+            LOG.warning("Could not find 'acknowledge' audio file!")
+            return
+
+        process = play_audio_file(file)
+        if process:
+            process.wait()
+        else:
+            LOG.warning("Unable to play 'acknowledge' audio file!")
+
 
 #######################################################################
 # FallbackSkill base class
diff --git a/mycroft/util/__init__.py b/mycroft/util/__init__.py
index 4db7e00fc3..1b19dae6d1 100644
--- a/mycroft/util/__init__.py
+++ b/mycroft/util/__init__.py
@@ -18,7 +18,7 @@ import socket
 import subprocess
 import pyaudio
 
-from os.path import join, expanduser
+from os.path import join, expanduser, splitext
 
 from threading import Thread
 from time import sleep
@@ -93,6 +93,36 @@ def resolve_resource_file(res_name):
     return None  # Resource cannot be resolved
 
 
+def play_audio_file(uri: str):
+    """ Play an audio file.
+
+    This wraps the other play_* functions, choosing the correct one based on
+    the file extension. The function will return directly and play the file
+    in the background.
+
+    Arguments:
+        uri:    uri to play
+
+    Returns: subprocess.Popen object. None if the format is not supported or
+             an error occurs playing the file.
+
+    """
+    extension_to_function = {
+        '.wav': play_wav,
+        '.mp3': play_mp3,
+        '.ogg': play_ogg
+    }
+    _, extension = splitext(uri)
+    play_function = extension_to_function.get(extension.lower())
+    if play_function:
+        return play_function(uri)
+    else:
+        LOG.error("Could not find a function capable of playing {uri}."
+                  " Supported formats are {keys}."
+                  .format(uri=uri, keys=list(extension_to_function.keys())))
+        return None
+
+
 def play_wav(uri):
     """ Play a wav-file.