gunthercox/Salvius

View on GitHub
docs/_modules/salvius/speech.html

Summary

Maintainability
Test Coverage

<!DOCTYPE html>

<html>
  <head>
    <meta charset="utf-8" />
    <title>salvius.speech &#8212; Salvius 0.0.1 documentation</title>
    <link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
    <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
    <script id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
    <script src="../../_static/jquery.js"></script>
    <script src="../../_static/underscore.js"></script>
    <script src="../../_static/doctools.js"></script>
    <script src="../../_static/language_data.js"></script>
    <link rel="index" title="Index" href="../../genindex.html" />
    <link rel="search" title="Search" href="../../search.html" />
   
  <link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
  
  
  <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />

  </head><body>
  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          

          <div class="body" role="main">
            
  <h1>Source code for salvius.speech</h1><div class="highlight"><pre>
<span></span><span class="kn">from</span> <span class="nn">zorg.adaptor</span> <span class="k">import</span> <span class="n">Adaptor</span>
<span class="kn">from</span> <span class="nn">zorg.driver</span> <span class="k">import</span> <span class="n">Driver</span>
<span class="kn">from</span> <span class="nn">multiprocessing</span> <span class="k">import</span> <span class="n">Queue</span>
<span class="kn">import</span> <span class="nn">speech_recognition</span>
<span class="kn">import</span> <span class="nn">subprocess</span>


<div class="viewcode-block" id="SpeechRecognition"><a class="viewcode-back" href="../../salvius.html#salvius.speech.SpeechRecognition">[docs]</a><span class="k">class</span> <span class="nc">SpeechRecognition</span><span class="p">(</span><span class="n">Adaptor</span><span class="p">):</span>

    <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">options</span><span class="p">):</span>
        <span class="nb">super</span><span class="p">(</span><span class="n">SpeechRecognition</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">options</span><span class="p">)</span>

        <span class="bp">self</span><span class="o">.</span><span class="n">recognizer</span> <span class="o">=</span> <span class="n">speech_recognition</span><span class="o">.</span><span class="n">Recognizer</span><span class="p">()</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">microphone</span> <span class="o">=</span> <span class="n">speech_recognition</span><span class="o">.</span><span class="n">Microphone</span><span class="p">()</span>

        <span class="c1"># Allow different speech recognition methods to be selected</span>
        <span class="c1"># See https://pypi.python.org/pypi/SpeechRecognition/</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">recognizer_function</span> <span class="o">=</span> <span class="n">options</span><span class="o">.</span><span class="n">get</span><span class="p">(</span>
            <span class="s2">&quot;recognizer_function&quot;</span><span class="p">,</span> <span class="s2">&quot;recognize_sphinx&quot;</span>
        <span class="p">)</span>

        <span class="bp">self</span><span class="o">.</span><span class="n">queue</span> <span class="o">=</span> <span class="n">Queue</span><span class="p">(</span><span class="n">maxsize</span><span class="o">=</span><span class="mi">7</span><span class="p">)</span>

        <span class="bp">self</span><span class="o">.</span><span class="n">stop_listening</span> <span class="o">=</span> <span class="kc">None</span>

<div class="viewcode-block" id="SpeechRecognition.start_listening"><a class="viewcode-back" href="../../salvius.html#salvius.speech.SpeechRecognition.start_listening">[docs]</a>    <span class="k">def</span> <span class="nf">start_listening</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;</span>
<span class="sd">        Start the listening process.</span>
<span class="sd">        &quot;&quot;&quot;</span>
        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">recognizer</span><span class="o">.</span><span class="n">listen_in_background</span><span class="p">(</span>
            <span class="bp">self</span><span class="o">.</span><span class="n">microphone</span><span class="p">,</span>
            <span class="bp">self</span><span class="o">.</span><span class="n">callback</span>
        <span class="p">)</span></div>

<div class="viewcode-block" id="SpeechRecognition.connect"><a class="viewcode-back" href="../../salvius.html#salvius.speech.SpeechRecognition.connect">[docs]</a>    <span class="k">def</span> <span class="nf">connect</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
        <span class="n">subprocess</span><span class="o">.</span><span class="n">call</span><span class="p">([</span><span class="s2">&quot;jack_control&quot;</span><span class="p">,</span> <span class="s2">&quot;start&quot;</span><span class="p">])</span>

        <span class="c1"># we only need to calibrate once, before we start listening</span>
        <span class="k">with</span> <span class="bp">self</span><span class="o">.</span><span class="n">microphone</span> <span class="k">as</span> <span class="n">source</span><span class="p">:</span>
            <span class="bp">self</span><span class="o">.</span><span class="n">recognizer</span><span class="o">.</span><span class="n">adjust_for_ambient_noise</span><span class="p">(</span><span class="n">source</span><span class="p">)</span>

        <span class="c1"># Start listening in the background</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">stop_listening</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">start_listening</span><span class="p">()</span></div>
        <span class="c1"># `stop_listening` is now a function that stops background listening</span>

<div class="viewcode-block" id="SpeechRecognition.disconnect"><a class="viewcode-back" href="../../salvius.html#salvius.speech.SpeechRecognition.disconnect">[docs]</a>    <span class="k">def</span> <span class="nf">disconnect</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
        <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">stop_listening</span><span class="p">:</span>
            <span class="bp">self</span><span class="o">.</span><span class="n">stop_listening</span><span class="p">()</span>

        <span class="n">subprocess</span><span class="o">.</span><span class="n">call</span><span class="p">([</span><span class="s2">&quot;jack_control&quot;</span><span class="p">,</span> <span class="s2">&quot;stop&quot;</span><span class="p">])</span></div>

<div class="viewcode-block" id="SpeechRecognition.callback"><a class="viewcode-back" href="../../salvius.html#salvius.speech.SpeechRecognition.callback">[docs]</a>    <span class="k">def</span> <span class="nf">callback</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">recognizer</span><span class="p">,</span> <span class="n">audio</span><span class="p">):</span>

        <span class="n">recognizer_function</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">recognizer</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">recognizer_function</span><span class="p">)</span>

        <span class="c1"># this is called from the background thread</span>
        <span class="c1"># received audio data, now we&#39;ll recognize it using speech recognition</span>
        <span class="k">try</span><span class="p">:</span>
            <span class="n">result</span> <span class="o">=</span> <span class="n">recognizer_function</span><span class="p">(</span><span class="n">audio</span><span class="p">)</span>
            <span class="bp">self</span><span class="o">.</span><span class="n">queue</span><span class="o">.</span><span class="n">put</span><span class="p">(</span><span class="n">result</span><span class="p">)</span>
        <span class="k">except</span> <span class="n">speech_recognition</span><span class="o">.</span><span class="n">UnknownValueError</span><span class="p">:</span>
            <span class="bp">self</span><span class="o">.</span><span class="n">queue</span><span class="o">.</span><span class="n">put</span><span class="p">(</span><span class="s2">&quot;I am sorry, I could not understand that.&quot;</span><span class="p">)</span>
        <span class="k">except</span> <span class="n">speech_recognition</span><span class="o">.</span><span class="n">RequestError</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
            <span class="n">m</span> <span class="o">=</span> <span class="s2">&quot;My speech recognition service has failed. </span><span class="si">{0}</span><span class="s2">&quot;</span>
            <span class="bp">self</span><span class="o">.</span><span class="n">queue</span><span class="o">.</span><span class="n">put</span><span class="p">(</span><span class="n">m</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">e</span><span class="p">))</span></div></div>


<div class="viewcode-block" id="ApiDriver"><a class="viewcode-back" href="../../salvius.html#salvius.speech.ApiDriver">[docs]</a><span class="k">class</span> <span class="nc">ApiDriver</span><span class="p">(</span><span class="n">Driver</span><span class="p">):</span>

    <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">options</span><span class="p">,</span> <span class="n">connection</span><span class="p">):</span>
        <span class="nb">super</span><span class="p">(</span><span class="n">ApiDriver</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">options</span><span class="p">,</span> <span class="n">connection</span><span class="p">)</span>

        <span class="bp">self</span><span class="o">.</span><span class="n">commands</span> <span class="o">+=</span> <span class="p">[</span><span class="s2">&quot;get_words&quot;</span><span class="p">]</span>

<div class="viewcode-block" id="ApiDriver.start"><a class="viewcode-back" href="../../salvius.html#salvius.speech.ApiDriver.start">[docs]</a>    <span class="k">def</span> <span class="nf">start</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">connection</span><span class="o">.</span><span class="n">connect</span><span class="p">()</span></div>

<div class="viewcode-block" id="ApiDriver.stop"><a class="viewcode-back" href="../../salvius.html#salvius.speech.ApiDriver.stop">[docs]</a>    <span class="k">def</span> <span class="nf">stop</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">connection</span><span class="o">.</span><span class="n">disconnect</span><span class="p">()</span></div>

<div class="viewcode-block" id="ApiDriver.get_words"><a class="viewcode-back" href="../../salvius.html#salvius.speech.ApiDriver.get_words">[docs]</a>    <span class="k">def</span> <span class="nf">get_words</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
        <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">connection</span><span class="o">.</span><span class="n">queue</span><span class="o">.</span><span class="n">empty</span><span class="p">():</span>
            <span class="k">return</span> <span class="kc">None</span>
        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">connection</span><span class="o">.</span><span class="n">queue</span><span class="o">.</span><span class="n">get</span><span class="p">()</span></div></div>


<div class="viewcode-block" id="SpeechSynthesis"><a class="viewcode-back" href="../../salvius.html#salvius.speech.SpeechSynthesis">[docs]</a><span class="k">class</span> <span class="nc">SpeechSynthesis</span><span class="p">(</span><span class="n">Driver</span><span class="p">):</span>

    <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">options</span><span class="p">,</span> <span class="n">connection</span><span class="p">):</span>
        <span class="nb">super</span><span class="p">(</span><span class="n">SpeechSynthesis</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">options</span><span class="p">,</span> <span class="n">connection</span><span class="p">)</span>

        <span class="bp">self</span><span class="o">.</span><span class="n">commands</span> <span class="o">+=</span> <span class="p">[</span><span class="s2">&quot;reply&quot;</span><span class="p">,</span> <span class="s2">&quot;start&quot;</span><span class="p">,</span> <span class="s2">&quot;stop&quot;</span><span class="p">]</span>

<div class="viewcode-block" id="SpeechSynthesis.reply"><a class="viewcode-back" href="../../salvius.html#salvius.speech.SpeechSynthesis.reply">[docs]</a>    <span class="k">def</span> <span class="nf">reply</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">text</span><span class="p">):</span>
        <span class="kn">import</span> <span class="nn">time</span>
        <span class="kn">from</span> <span class="nn">espeak</span> <span class="k">import</span> <span class="n">espeak</span>
        <span class="kn">from</span> <span class="nn">espeak</span> <span class="k">import</span> <span class="n">core</span> <span class="k">as</span> <span class="n">espeak_core</span>

        <span class="c1"># Get the robot&#39;s response to the input text</span>
        <span class="n">response</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">connection</span><span class="o">.</span><span class="n">respond</span><span class="p">(</span><span class="n">text</span><span class="p">)</span>

        <span class="n">done_synth</span> <span class="o">=</span> <span class="p">[</span><span class="kc">False</span><span class="p">]</span>

        <span class="k">def</span> <span class="nf">synth_callback</span><span class="p">(</span><span class="n">event</span><span class="p">,</span> <span class="n">pos</span><span class="p">,</span> <span class="n">length</span><span class="p">):</span>
            <span class="k">if</span> <span class="n">event</span> <span class="o">==</span> <span class="n">espeak_core</span><span class="o">.</span><span class="n">event_MSG_TERMINATED</span><span class="p">:</span>
                <span class="n">done_synth</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">=</span> <span class="kc">True</span>

        <span class="n">espeak</span><span class="o">.</span><span class="n">set_SynthCallback</span><span class="p">(</span><span class="n">synth_callback</span><span class="p">)</span>
        <span class="n">call_result</span> <span class="o">=</span> <span class="n">espeak</span><span class="o">.</span><span class="n">synth</span><span class="p">(</span><span class="n">response</span><span class="o">.</span><span class="n">text</span><span class="p">)</span>

        <span class="c1"># Wait for the speech to stop</span>
        <span class="k">while</span> <span class="n">call_result</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">done_synth</span><span class="p">[</span><span class="mi">0</span><span class="p">]:</span>
            <span class="n">time</span><span class="o">.</span><span class="n">sleep</span><span class="p">(</span><span class="mf">0.05</span><span class="p">)</span>

        <span class="k">return</span> <span class="n">call_result</span></div>

<div class="viewcode-block" id="SpeechSynthesis.start"><a class="viewcode-back" href="../../salvius.html#salvius.speech.SpeechSynthesis.start">[docs]</a>    <span class="k">def</span> <span class="nf">start</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">connection</span><span class="o">.</span><span class="n">start_listening</span><span class="p">()</span></div>

<div class="viewcode-block" id="SpeechSynthesis.stop"><a class="viewcode-back" href="../../salvius.html#salvius.speech.SpeechSynthesis.stop">[docs]</a>    <span class="k">def</span> <span class="nf">stop</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">connection</span><span class="o">.</span><span class="n">stop_listening</span><span class="p">()</span></div></div>
</pre></div>

          </div>
          
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
        <div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="../../index.html">Salvius</a></h1>








<h3>Navigation</h3>
<p class="caption"><span class="caption-text">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../salvius.html">salvius package</a></li>
</ul>

<div class="relations">
<h3>Related Topics</h3>
<ul>
  <li><a href="../../index.html">Documentation overview</a><ul>
  <li><a href="../index.html">Module code</a><ul>
  </ul></li>
  </ul></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
  <h3 id="searchlabel">Quick search</h3>
    <div class="searchformwrapper">
    <form class="search" action="../../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" />
      <input type="submit" value="Go" />
    </form>
    </div>
</div>
<script>$('#searchbox').show(0);</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    
    <div class="footer">
      &copy;2020, Gunther Cox.
      
      |
      Powered by <a href="http://sphinx-doc.org/">Sphinx 3.0.3</a>
      &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.11</a>
      
    </div>

    

    
    <script>
        (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
        (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
        m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
        })(window,document,'script','https://www.google-analytics.com/analytics.js','ga');

        ga('create', 'UA-12573345-13', 'auto');
        ga('send', 'pageview');
        </script>

  </body>
</html>