We will create an extension that allows us to talk to the IPython notebook and the text will be written in a cell in the notebook. It was tested with IPython 2.3.0 and 3.0.0.dev on chrome/chromium v40 (you need the web speech API working in your browser).
To make it work just create a folder called 'talk' in in the IPYTHONDIR/nbextensions folder and copy the files here in the recently created 'talk' folder.
Now, to load the extension:
%%javascript
IPython.load_extensions('talk/talk');
You have to see a new button in the toolbar:
If you click the button the browser will ask you to allow the use of the microphone (accept) and a dialog will appear. Just talk and when you are ready click 'OK' in the dialog window. Your speech will be written in the cell that was active when you clicked the extension button so take care to do not overwrite some interesting text!!!!.
I left the next cell blank so you can use it
In the next cell you can see the code of the javascript file (talk.js)
/*
* ----------------------------------------------------------------------------
* Copyright (c) 2014 - Kiko Correoso
*
* Distributed under the terms of the MIT License.
*
* A little extension to talk with the IPython notebook and write the
* conversation in a cell.
*
* Ths extension is based on previous work by Damián Ávila and Min Ragan Kelley
* see https://github.com/damianavila/mIPyex/tree/master/custom/spellchecker
* see https://github.com/minrk/ipython_extensions
* ----------------------------------------------------------------------------
*/
/*
* ----------------------------------------------------------------------------
* INSTALLATION
*
* Add this file and neighboring talk.css to $(ipython locate)/nbextensions/talk
*
* And load it with:
*
* %%javascript
* IPython.load_extensions('talk/talk');
* ----------------------------------------------------------------------------
*/
define(["require"], function (require) {
"use strict";
// Test browser support
window.SpeechRecognition = window.SpeechRecognition ||
window.webkitSpeechRecognition ||
null;
if (window.SpeechRecognition){
var recognizer = new window.SpeechRecognition();
recognizer.continuous = true;
recognizer.interimResults = true;
recognizer.lang = "es-ES"
var talk_func = function(){
var textarea = $('<textarea/>')
.attr('rows','15')
.attr('cols','80')
.attr('name','source')
.attr('id', 'talkarea')
/*.attr('readonly', 'readonly')*/
.text('Text will be written here...');
var dialogform = $('<div/>')
.append(
$('<form/>').append(
$('<fieldset/>').append(
$('<label/>')
.attr('for','source')
.text("Please, talk to a microphone and the words " +
"will appear in the textarea below. " +
"This extension shall work on Chrome and maybe in the " +
"nightly builds of Firefox." +
"When the content is ready, press OK or Cancel if you " +
"want to discard the text. ")
)
.append($('<br/>'))
.append(
textarea
)
)
);
IPython.dialog.modal({
title: "Please, talk and when ready click the button",
body: dialogform,
buttons: {
"OK": { class : "btn-primary",
click: function() {
talkstop();
var corr_input = $.trim($(textarea).val());
console.log(corr_input);
IPython.notebook.get_selected_cell().set_text(corr_input);
}
},
Cancel: { click: function() {
talkstop();
}
}
}
});
var talkstart = function (){
console.log('entrostart');
// Start recognising
recognizer.onresult = function(event) {
console.log('onresult');
var transcription = $('#talkarea');
transcription.val('');
for (var i = event.resultIndex; i < event.results.length; i++) {
if (event.results[i].isFinal) {
transcription.val(
transcription.val() + event.results[i][0].transcript + '\n(Confidence: ' + event.results[i][0].confidence + ')'
);
} else {
transcription.val(
transcription.val() + event.results[i][0].transcript
);
};
};
};
// Error on recognising
recognizer.onerror = function(event) {
console.log('onerror')
transcription.val('Recognition error: ' + event.message);
};
// Start listening
recognizer.start();
};
var talkstop = function () {
// Stop listening
console.log('entrostop')
recognizer.stop();
};
talkstart();
};
} else {
var talk_func = function(){
var dialogupdate = $('<div/>')
.append(
$('<p/>')
.text("Sorry, it seems that your browser doesn't support this functionality")
);
IPython.dialog.modal({
title: "Not recognised",
body: dialogupdate,
});
};
};
var talk_button = function () {
if (!IPython.toolbar) {
$([IPython.events]).on("app_initialized.NotebookApp", talk_button);
return;
}
if ($("#talk_button").length === 0) {
IPython.toolbar.add_buttons_group([
{
'label' : 'Talk to IPython',
'icon' : 'fa-pencil-square-o',
'callback': toggle_talk,
'id' : 'talk_button'
},
]);
};
};
var toggle_talk = function(){
talk_func()
};
var load_css = function () {
var link = document.createElement("link");
link.type = "text/css";
link.rel = "stylesheet";
link.href = require.toUrl("./talk.css");
console.log(link);
document.getElementsByTagName("head")[0].appendChild(link);
};
var load_ipython_extension = function () {
load_css();
talk_button();
};
return {
load_ipython_extension : load_ipython_extension,
toggle_talk : toggle_talk,
talk_func : talk_func,
};
});
If you want that the extension is always available when you open a new notebook you have to include some code in the custom.js file of the profile you want to use. For example, in previous notebooks we created the pycones14 profile so to include it in the custom.js of that profile we shall include the following text in the file:
// we want strict javascript that fails
// on ambiguous syntax
"using strict";
$([IPython.events]).on('app_initialized.NotebookApp', function(){
require(['custom/talk/main'],function(talk){
talk.parameters('dummy');
console.log('Talk extension loaded correctly');
});
});https://github.com/ipython/ipython/wiki/Extensions-Index
https://github.com/ipython-contrib/IPython-notebook-extensions
http://www.damian.oquanta.info/posts/a-poor-man-spell-checker-for-the-ipython-notebook.html
http://www.damian.oquanta.info/posts/tweet-me-said-an-ipython-notebook-cell-and-i-did-it.html
https://github.com/minrk/ipython_extensions
https://www.pfenninger.org/posts/ipython-notebook-extensions-to-ease-day-to-day-work/