Merge pull request #471 from kivy/thegrymek-plyer-speech-recognition

thegrymek: Android speech recognition

examples/speech/buildozer.spec

@@ -0,0 +1,193 @@
+[app]
+
+# (str) Title of your application
+title = Plyer Speech Recognition
+
+# (str) Package name
+package.name = plyer.speech.recognition
+
+# (str) Package domain (needed for android/ios packaging)
+package.domain = org.test
+
+# (str) Source code where the main.py live
+source.dir = .
+
+# (list) Source files to include (let empty to include all the files)
+source.include_exts = py,png,jpg,kv,atlas
+
+# (list) Source files to exclude (let empty to not exclude anything)
+#source.exclude_exts = spec
+
+# (list) List of directory to exclude (let empty to not exclude anything)
+#source.exclude_dirs = tests, bin
+
+# (list) List of exclusions using pattern matching
+#source.exclude_patterns = license,images/*/*.jpg
+
+# (str) Application versioning (method 1)
+# version.regex = __version__ = ['"](.*)['"]
+# version.filename = %(source.dir)s/main.py
+
+# (str) Application versioning (method 2)
+version = 1.0
+
+# (list) Application requirements
+# comma seperated e.g. requirements = sqlite3,kivy
+requirements = kivy,plyer
+
+# (str) Custom source folders for requirements
+# Sets custom source for any requirements with recipes
+# requirements.source.kivy = ../../kivy
+
+# (list) Garden requirements
+#garden_requirements =
+
+# (str) Presplash of the application
+#presplash.filename = %(source.dir)s/data/presplash.png
+
+# (str) Icon of the application
+#icon.filename = %(source.dir)s/data/icon.png
+
+# (str) Supported orientation (one of landscape, portrait or all)
+orientation = portrait
+
+# (bool) Indicate if the application should be fullscreen or not
+fullscreen = 1
+
+
+#
+# Android specific
+#
+
+# (list) Permissions
+android.permissions = INTERNET,RECORD_AUDIO
+
+# (int) Android API to use
+#android.api = 14
+
+# (int) Minimum API required (8 = Android 2.2 devices)
+#android.minapi = 8
+
+# (int) Android SDK version to use
+#android.sdk = 21
+
+# (str) Android NDK version to use
+#android.ndk = 9c
+
+# (bool) Use --private data storage (True) or --dir public storage (False)
+#android.private_storage = True
+
+# (str) Android NDK directory (if empty, it will be automatically downloaded.)
+#android.ndk_path =
+
+# (str) Android SDK directory (if empty, it will be automatically downloaded.)
+#android.sdk_path =
+
+# (str) python-for-android git clone directory (if empty, it will be automatically cloned from github)
+#android.p4a_dir =
+
+# (list) python-for-android whitelist
+#android.p4a_whitelist =
+
+# (str) Android entry point, default is ok for Kivy-based app
+#android.entrypoint = org.renpy.android.PythonActivity
+
+# (list) List of Java .jar files to add to the libs so that pyjnius can access
+# their classes. Don't add jars that you do not need, since extra jars can slow
+# down the build process. Allows wildcards matching, for example:
+# OUYA-ODK/libs/*.jar
+#android.add_jars = foo.jar,bar.jar,path/to/more/*.jar
+
+# (list) List of Java files to add to the android project (can be java or a
+# directory containing the files)
+#android.add_src =
+
+# (str) python-for-android branch to use, if not master, useful to try
+# not yet merged features.
+#android.branch = master
+
+# (str) OUYA Console category. Should be one of GAME or APP
+# If you leave this blank, OUYA support will not be enabled
+#android.ouya.category = GAME
+
+# (str) Filename of OUYA Console icon. It must be a 732x412 png image.
+#android.ouya.icon.filename = %(source.dir)s/data/ouya_icon.png
+
+# (str) XML file to include as an intent filters in <activity> tag
+#android.manifest.intent_filters =
+
+# (list) Android additionnal libraries to copy into libs/armeabi
+#android.add_libs_armeabi = libs/android/*.so
+#android.add_libs_armeabi_v7a = libs/android-v7/*.so
+#android.add_libs_x86 = libs/android-x86/*.so
+#android.add_libs_mips = libs/android-mips/*.so
+
+# (bool) Indicate whether the screen should stay on
+# Don't forget to add the WAKE_LOCK permission if you set this to True
+#android.wakelock = False
+
+# (list) Android application meta-data to set (key=value format)
+#android.meta_data =
+
+# (list) Android library project to add (will be added in the
+# project.properties automatically.)
+#android.library_references =
+
+#
+# iOS specific
+#
+
+# (str) Name of the certificate to use for signing the debug version
+# Get a list of available identities: buildozer ios list_identities
+#ios.codesign.debug = "iPhone Developer: <lastname> <firstname> (<hexstring>)"
+
+# (str) Name of the certificate to use for signing the release version
+#ios.codesign.release = %(ios.codesign.debug)s
+
+
+[buildozer]
+
+# (int) Log level (0 = error only, 1 = info, 2 = debug (with command output))
+log_level = 2
+
+# (int) Display warning if buildozer is run as root (0 = False, 1 = True)
+warn_on_root = 1
+
+
+#    -----------------------------------------------------------------------------
+#    List as sections
+#
+#    You can define all the "list" as [section:key].
+#    Each line will be considered as a option to the list.
+#    Let's take [app] / source.exclude_patterns.
+#    Instead of doing:
+#
+#[app]
+#source.exclude_patterns = license,data/audio/*.wav,data/images/original/*
+#
+#    This can be translated into:
+#
+#[app:source.exclude_patterns]
+#license
+#data/audio/*.wav
+#data/images/original/*
+#
+
+
+#    -----------------------------------------------------------------------------
+#    Profiles
+#
+#    You can extend section / key with a profile
+#    For example, you want to deploy a demo version of your application without
+#    HD content. You could first change the title to add "(demo)" in the name
+#    and extend the excluded directories to remove the HD content.
+#
+#[app@demo]
+#title = My Application (demo)
+#
+#[app:source.exclude_patterns@demo]
+#images/hd/*
+#
+#    Then, invoke the command line with the "demo" profile:
+#
+#buildozer --profile demo android debug

examples/speech/main.py

@@ -0,0 +1,90 @@
+from kivy.app import App
+from kivy.clock import Clock
+from kivy.lang import Builder
+from kivy.properties import StringProperty
+from kivy.uix.boxlayout import BoxLayout
+
+from plyer import speech
+
+Builder.load_string('''
+#:import speech plyer.speech
+
+<SpeechInterface>:
+    orientation: 'vertical'
+    Label:
+        size_hint_y: None
+        height: sp(40)
+        text: 'Is supported: %s' % speech.exist()
+    Label:
+        size_hint_y: None
+        height: sp(40)
+        text: 'Possible Matches'
+    TextInput:
+        id: results
+        hint_text: 'results (auto stop)'
+        size_hint_y: 0.3
+    TextInput:
+        id: partial
+        hint_text: 'partial results (manual stop)'
+        size_hint_y: 0.3
+    TextInput:
+        id: errors
+        size_hint_y: None
+        height: sp(20)
+    Button:
+        id: start_button
+        text: 'Start Listening'
+        on_release:
+            root.start_listening()
+
+''')
+
+
+class SpeechInterface(BoxLayout):
+    '''Root Widget.'''
+
+    def start_listening(self):
+        if speech.listening:
+            self.stop_listening()
+            return
+
+        start_button = self.ids.start_button
+        start_button.text = 'Stop'
+
+        self.ids.results.text = ''
+        self.ids.partial.text = ''
+
+        speech.start()
+
+        Clock.schedule_interval(self.check_state, 1 / 5)
+
+    def stop_listening(self):
+        start_button = self.ids.start_button
+        start_button.text = 'Start Listening'
+
+        speech.stop()
+        self.update()
+
+        Clock.unschedule(self.check_state)
+
+    def check_state(self, dt):
+        # if the recognizer service stops, change UI
+        if not speech.listening:
+            self.stop_listening()
+
+    def update(self):
+        self.ids.partial.text = '\n'.join(speech.partial_results)
+        self.ids.results.text = '\n'.join(speech.results)
+
+
+class SpeechApp(App):
+
+    def build(self):
+        return SpeechInterface()
+
+    def on_pause(self):
+        return True
+
+
+if __name__ == "__main__":
+    SpeechApp().run()

plyer/__init__.py

@@ -4,13 +4,14 @@
 
 '''
 
-
-__all__ = ('accelerometer', 'audio', 'barometer', 'battery', 'call', 'camera',
-           'compass', 'email', 'filechooser', 'flash', 'gps', 'gravity',
-           'gyroscope', 'irblaster', 'light', 'orientation', 'notification',
-           'proximity', 'sms', 'tts', 'uniqueid', 'vibrator', 'wifi',
-           'temperature', 'humidity', 'spatialorientation', 'brightness',
-           'storagepath', 'processors', 'cpu', 'bluetooth', 'screenshot')
+__all__ = (
+    'accelerometer', 'audio', 'barometer', 'battery', 'bluetooth',
+    'brightness', 'call', 'camera', 'compass', 'cpu', 'email', 'filechooser',
+    'flash', 'gps', 'gravity', 'gyroscope', 'humidity', 'irblaster',
+    'keystore', 'light', 'notification', 'orientation', 'processors',
+    'proximity', 'screenshot', 'sms', 'spatialorientation', 'speech',
+    'storagepath', 'temperature', 'tts', 'uniqueid', 'vibrator', 'wifi'
+)
 
 __version__ = '1.3.3.dev0'
 
@@ -76,6 +77,9 @@
 #: Sms proxy to :class:`plyer.facades.Sms`
 sms = Proxy('sms', facades.Sms)
 
+#: Speech proxy to :class:`plyer.facades.Speech`
+speech = Proxy('speech', facades.Speech)
+
 #: TTS proxy to :class:`plyer.facades.TTS`
 tts = Proxy('tts', facades.TTS)
 

plyer/facades/__init__.py

@@ -11,7 +11,8 @@
            'IrBlaster', 'Light', 'Orientation', 'Notification', 'Proximity',
            'Sms', 'TTS', 'UniqueID', 'Vibrator', 'Wifi', 'Flash', 'CPU',
            'Temperature', 'Humidity', 'SpatialOrientation', 'Brightness',
-           'Processors', 'StoragePath', 'keystore', 'Bluetooth', 'Screenshot')
+           'Processors', 'StoragePath', 'keystore', 'Bluetooth', 'Screenshot',
+           'Speech')
 
 from plyer.facades.accelerometer import Accelerometer
 from plyer.facades.audio import Audio
@@ -32,6 +33,7 @@
 from plyer.facades.orientation import Orientation
 from plyer.facades.notification import Notification
 from plyer.facades.sms import Sms
+from plyer.facades.speech import Speech
 from plyer.facades.tts import TTS
 from plyer.facades.uniqueid import UniqueID
 from plyer.facades.vibrator import Vibrator