Merge branch 'master' into master

Author: rev3rend

.gitignore

@@ -0,0 +1,2 @@
+
+.DS_Store

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Integrated Digital Media, NYU
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,22 +1,32 @@
-# p5.js-speech
+# [p5.speech](https://idmnyu.github.io/p5.js-speech/)
 Web Audio Speech Synthesis and Speech Recognition Implementation for p5.js (http://p5js.org)
 
 R. Luke DuBois ([email protected])   
-[ABILITY Lab](http://abilitylab.nyu.edu) / [Brooklyn Experimental Media Center](http://bxmc.poly.edu)   
+[ABILITY Project](http://ability.nyu.edu) / [Integrated Design & Media](http://idm.engineering.nyu.edu)   
 NYU
 
-This is a simple p5 extension to provide Web Speech (Synthesis and Recognition) API functionality.  It consists of two object classes (p5.Speech and p5.SpeechRec) along with accessor functions to speak and listen for text, change parameters (synthesis voices, recognition models, etc.), and retrieve callbacks from the system.
+**p5.speech** is a simple p5 extension to provide Web Speech (Synthesis and Recognition) API functionality.  It consists of two object classes (p5.Speech and p5.SpeechRec) along with accessor functions to speak and listen for text, change parameters (synthesis voices, recognition models, etc.), and retrieve callbacks from the system.
 
-Speech recognition requires launching from a server (e.g. a python simpleserver on a local machine).
+Speech recognition requires launching from a server using HTTPS (e.g. using a python server on a local machine... a 'file' URI won't work).
 
-## Simple Example (Synthesis)
+## Download
+* [Library only](https://raw.githubusercontent.com/IDMNYU/p5.js-speech/master/lib/p5.speech.js)
+
+## Include from a CDN
+```
+<script src="https://cdn.jsdelivr.net/gh/IDMNYU/[email protected]/lib/p5.speech.js"></script>
+```
+
+## Examples
+
+### Simple Example (Synthesis)
 ```
-var foo = new P5.Speech(); // speech synthesis object
+var foo = new p5.Speech(); // speech synthesis object
 foo.speak('hi there'); // say something
 ```
-## Simple Example (Recognition)
+### Simple Example (Recognition)
 ```
-var foo = new P5.SpeechRec(); // speech recognition object (will prompt for mic access)
+var foo = new p5.SpeechRec(); // speech recognition object (will prompt for mic access)
 foo.onResult = showResult; // bind callback function to trigger when speech is recognized
 foo.start(); // start listening
 
@@ -25,3 +35,62 @@ function showResult()
   console.log(foo.resultString); // log the result
 }
 ```
+### More Examples
+
+* [p5.Speech() Simple](https://idmnyu.github.io/p5.js-speech/examples/01simple.html) [(source)](https://github.com/IDMNYU/p5.js-speech/blob/master/examples/01simple.html)
+* [p5.Speech() Speech Box](https://idmnyu.github.io/p5.js-speech/examples/02speechbox.html) [(source)](https://github.com/IDMNYU/p5.js-speech/blob/master/examples/02speechbox.html)
+* [p5.Speech() Callbacks](https://idmnyu.github.io/p5.js-speech/examples/03callbacks.html) [(source)](https://github.com/IDMNYU/p5.js-speech/blob/master/examples/03callbacks.html)
+* [p5.SpeechRec() Simple](https://idmnyu.github.io/p5.js-speech/examples/04simplerecognition.html) [(source)](https://github.com/IDMNYU/p5.js-speech/blob/master/examples/04simplerecognition.html)
+* [p5.SpeechRec() Continuous](https://idmnyu.github.io/p5.js-speech/examples/05continuousrecognition.html) [(source)](https://github.com/IDMNYU/p5.js-speech/blob/master/examples/05continuousrecognition.html)
+
+## Reference
+
+### p5.Speech
+
+*constructor*
+* **default_voice**: optional argument to set the default synthesizer voice by number (see *listVoices()*) or by name.
+
+*methods*
+* **cancel()**: silently cancels the current utterance and clears any queued utterances.
+* **listVoices()**: debugging statement. Lists available synthesis voices to the JavaScript console.
+* **pause()**: pause the current utterance. The *onPause()* callback will fire.
+* **resume()**: resumes the current utterance. The *onResume()* callback will fire.
+* **setLang(language)**: sets the language interpreter for the synthesizer voice. Argument is BCP-47; Default is 'en-US'.
+* **setPitch(pitch)**: sets playback pitch of synthesized speech from 0.01 (very low) to 2.0 (very high). Default is 1.0; not supported by all browser / OS combinations.
+* **setRate(rate)**: sets rate of speech production from 0.1 (very slow) to 2.0 (very fast). Default is 1.0; not supported by all browser / OS combinations.
+* **setVoice(voice)**: sets synthesizer voice by number (see listVoices()) or by name; equivalent to the default_voice parameter passed with the constructor.
+* **setVolume(volume)**: sets synthesizer volume in the range of 0.0 (silent) to 1.0 (default=max volume).
+* **speak(utterance)**: instructs the synthesizer to speak the string encoded in utterance. Depending on the interrupt property, additional calls to *speak()* will queue after or interrupt speech actively being synthesized. When synthesis begins, the *onStart()* callback will fire; when synthesis ends, the *onEnd()* callback will fire.
+* **stop()**: stops the current utterance. The *onEnd()* callback will fire.
+
+*properties*
+* **interrupt**: boolean to set whether the *speak()* method will interrupt (true) or queue after (false = default) existing speech currently being synthesized.
+* **onEnd**: function sets callback to fire when an utterance is finished.
+* **onLoad**: function sets callback to fire when synthesis voices are loaded.
+* **onPause**: function sets callback to fire when an utterance is paused.
+* **onResume**: function sets callback to fire when an utterance is resumed.
+* **onStart**: function sets callback to fire when synthesis is begun.
+
+### p5.SpeechRec
+
+*constructor*
+* **default_language**: optional argument to set the default BCP-47 language / region to for the speech recognition system.
+  * n.b. p5.SpeechRec() won't work unless using a secure (HTTPS) server. if you never get a prompt from the browser to allow access to your microphone, that should be the first thing you troubleshoot.
+
+*methods*
+* **start()**: instructs the speech recognition system to begin listening. use continuous mode rather than multiple calls to *start()* for multiple recognition tokens within the same site.
+
+*properties*
+* **continuous**: boolean to set whether the speech recognition engine will give results continuously (true) or just once (false = default). 
+  * **p.s. *continuous* is set to 'false' by default to protect your users' privacy: setting continuous to 'true' creates a persistent open mic between your users' browsing device and the cloud-based speech recognition engine for their browser (i.e. Google).**
+  * p.p.s. as an aside, besides being potentially a bad call from an ethical standpoint, *continous* mode is unreliable - the audio pipe between the browser and the recognition server breaks pretty easily, especially with non-Chrome browsers. if you really want something that will continuously recognize speech, set a meta-refresh on your page to reload every couple of minutes.
+* **interimResults**: boolean to set whether the speech recognition engine will give faster, partial results (true) or wait for the speaker to pause (false = default).
+* **onEnd**: function sets callback to fire when speech recognition ends.
+* **onError**: function sets callback to fire when an error occurs on the client side in recording and transmitting the speech.
+* **onResult**: function sets callback to fire when synthesis engine has reported a result.
+* **onStart**: function sets callback to fire when speech recognition has begun.
+* **resultConfidence**: float value (0.0-1.0) representing the confidence level of the speech synthesizer that resultString is what was actually spoken by the user.
+* **resultJSON**: JSON object containing a full set of data returned by the speech recognition system.
+* **resultString**: String containing the most recently detected speech.
+* **resultValue**: boolean value containing a status flag reported by the server (true = speech successfully recognized).
+

_config.yml

@@ -0,0 +1,4 @@
+theme: jekyll-theme-minimal
+title: p5.speech
+description: Speech synthesis and recognition for p5.js
+show_downloads: "true"

_layouts/default.html

@@ -0,0 +1,71 @@
+<!doctype html>
+<html lang="{{ site.lang | default: "en-US" }}">
+  <head>
+    <meta charset="utf-8">
+    <meta http-equiv="X-UA-Compatible" content="chrome=1">
+
+{% seo %}
+
+    <link rel="stylesheet" href="{{ '/assets/css/style.css?v=' | append: site.github.build_revision | relative_url }}">
+    <meta name="viewport" content="width=device-width">
+    <!--[if lt IE 9]>
+    <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
+    <![endif]-->
+  </head>
+  <body> 
+    <style>
+      a {color:darkred;}
+    </style>
+    <div class="wrapper">
+      <header>
+        <a href="{{ site.github.url }}"> <h1>{{ site.title | default: site.github.repository_name }}</h1> </a>
+        <p>{{ site.description | default: site.github.project_tagline }}</p>
+
+        {% if site.github.is_project_page %}
+          <p class="view"><a href="{{ site.github.repository_url }}">View the Project on GitHub <small>{{ github_name }}</small></a></p>
+        {% endif %}
+
+        {% if site.github.is_user_page %}
+          <p class="view"><a href="{{ site.github.owner_url }}">View My GitHub Profile</a></p>
+        {% endif %}
+
+        {% if site.show_downloads %}
+          <ul>
+            <li><a href="{{ site.github.zip_url }}">Download <strong>ZIP File</strong></a></li>
+            <li><a href="{{ site.github.tar_url }}">Download <strong>TAR Ball</strong></a></li>
+            <li><a href="{{ site.github.repository_url }}">View On <strong>GitHub</strong></a></li>
+          </ul>
+        {% endif %}
+        <a href="#download">Download</a><br>
+        <a href="#examples">Examples</a><br>
+        <a href="#reference">Reference</a><br>
+      </header>
+      <section>
+
+      {{ content }}
+
+      </section>
+      <footer>
+        {% if site.github.is_project_page %}
+        <p>This project is maintained by <a href="https://idmnyu.github.io">{{ site.github.owner_name }}</a>
+        <a href="http://idm.engineering.nyu.edu" target="_new"><img src="https://github.com/IDMNYU/assets/raw/master/IDM.png" width=250 alt="IDM logo"></a></p>
+        {% endif %}
+        <p><small>Hosted on GitHub Pages &mdash; Theme by <a href="https://github.com/orderedlist">orderedlist</a></small></p>
+      </footer>
+    </div>
+    <script src="{{ '/assets/js/scale.fix.js' | relative_url }}"></script>
+
+
+  {% if site.google_analytics %}
+    <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', '{{ site.google_analytics }}', 'auto');
+        ga('send', 'pageview');
+    </script>
+  {% endif %}
+  </body>
+</html>

examples/01simple.html

@@ -28,7 +28,7 @@
   		listbutton.mousePressed(doList);
 
   		// say hello:
-		myVoice.speak('yeah, baby!!!');
+		myVoice.speak('testing one two three!!!');
 
 	}
 

examples/02speechbox.html

@@ -13,7 +13,7 @@
 	function setup()
 	{
 		// input dialog:
-		input = createInput("yeah, baby!!!");
+		input = createInput("testing one two three!!!");
 		input.style("width", 400);
   		input.position(20, 65);
 		// checkbox:

examples/03callbacks.html

@@ -44,7 +44,7 @@
 	function speechLoaded()
 	{
   		// say cheers:
-		myVoice.speak("yeah, baby!!!");
+		myVoice.speak("testing one two three!!!");
 	}
 
 	function speechStarted()

examples/socketexample/index.html

@@ -0,0 +1,55 @@
+<html>
+<head>
+	<meta http-equiv="refresh" content="300">
+	<script src="https://cdnjs.cloudflare.com/ajax/libs/p5.js/0.4.5/p5.min.js"></script>
+	<script src="https://cdnjs.cloudflare.com/ajax/libs/p5.js/0.4.5/addons/p5.dom.js"></script>
+	<script src="p5.speech.js"></script>
+	<script src="https://cdnjs.cloudflare.com/ajax/libs/socket.io/2.0.4/socket.io.js"></script>
+	<script>
+
+	var myRec = new p5.SpeechRec('en-US', parseResult); // new P5.SpeechRec object
+	myRec.continuous = true; // do continuous recognition
+	myRec.interimResults = true; // allow partial recognition (faster, less accurate)
+
+	var x, y;
+	var dx, dy;
+
+	var socket;
+
+	function setup()
+	{
+		// graphics stuff:
+		createCanvas(800, 600);
+		background(255, 255, 255);
+
+		// instructions:
+		textSize(48);
+		textAlign(CENTER);
+
+		myRec.start(); // start engine
+
+		// client-side socket.io:
+		socket = io();
+
+		noLoop();
+	}
+
+	function draw()
+	{
+
+	}
+
+	function parseResult()
+	{
+		// recognition system will often append words into phrases.
+		var res = myRec.resultString;
+		background(255);
+		text(res, width/2, height/2);
+		socket.emit('result', { 'word': res });
+	}
+
+</script>
+</head>
+<body>
+</body>
+</html>