Activity Team/gst-plugins-espeak: Difference between revisions

← Older edit

@@ Line 1: / Line 1: @@
-=== gst-plugins-espeak ===
+<noinclude>{{ GoogleTrans-en | es =show | bg =show | zh-CN =show | zh-TW =show | hr =show | cs =show | da =show | nl =show | fi =show | fr =show | de =show | el =show | hi =show | it =show | ja =show | ko =show | no =show | pl =show | pt =show | ro =show | ru =show | sv =show }}{{TOCright}}
+== gst-plugins-espeak ==
 eSpeak library as a sound source for GStreamer.<br>
 Plugin uses given text to produce audio output.
-=== Interface ===
+== Interface ==
 gst-plugins-espeak is a valid gstreamer plugin thus it is a GObject
@@ Line 14: / Line 16: @@
 * '''voice''' use voice file of this name from espeak-data/voices
 * '''gap''' Word gap. Pause between words, units of 10mS at the default speed, default is 0
-* '''trac''' track events
+* '''track''' track events
 ** '''0''' do not track any events (default)
 ** '''1''' track word events (see [[#Track words example]])
@@ Line 22: / Line 24: @@
 ==== Events ====
-Gstreamer uses separate threads and user should use gst.Bus messages(are processed in main gtk thread) instead of native GObject events. To use messages you need to setup '''tract''' property. These are supported gst.Bus messages (see):
+Gstreamer uses separate threads and user should use gst.Bus messages(are processed in main gtk thread) instead of native GObject events. To use messages you need to setup '''track''' property. These are supported gst.Bus messages (see):
 * '''espeak-word''' before speeching a word, message properties:
@@ Line 31: / Line 33: @@
 ** '''mark''' name of mark
-=== Usage ===
+== Usage ==
+gst-plugins-espeak generates raw ''audio/x-raw-int'' data.
+==== Pipeline format ====
 Plugin adds new URI scheme
   gst-launch espeak://Hi ! autoaudiosink
@@ Line 38: / Line 43: @@
   gst-launch espeak text="Hello world" pitch=-50 rate=-50 voice=default ! autoaudiosink
-==== Simple Python example ====
+==== Python examples ====
+To use gst-plugins-espeak in Python:
+* setup regular gstreamer environment
+* plugin's name is ''espeak''
+* all writable properties(including '''text''') make sense only at start playing; to apply new values you need to stop ''pipe.set_state(gst.STATE_NULL)'' pipe and start it again with new properties ''pipe.set_state(gst.STATE_PLAYING)''.
+Note: the examples below are for GTK+ 2 and GStreamer 0.10, and are yet to be ported to GTK+ 3 and GStreamer 1.0, there are more recent examples in the GTK+ 3 toolkit for Sugar, and in activities.
+===== Simple example =====
    import gtk
@@ Line 53: / Line 66: @@
    gtk.main()
-==== Choir example ====
+===== Choir example =====
    import gtk
@@ Line 70: / Line 83: @@
        src.props.rate = random.randint(-100, 100)<br>
        voices = src.props.voices
-       voice = voices[random.randint(0, len(voices)-1)]
+       voice = random.choice(voices)
        src.props.voice = voice[0]<br>
        bus = pipe.get_bus()
@@ Line 80: / Line 93: @@
    gtk.main()
-==== Track words example ====
+===== Track words example =====
    import gtk
@@ Line 107: / Line 120: @@
    gtk.main()
-==== Track marks example ====
+===== Track marks example =====
    import gtk
@@ Line 134: / Line 147: @@
    pipe.set_state(gst.STATE_PLAYING)<br>
    gtk.main()
+===== Simple TTS example =====
+ import gtk
+ import gst
+ import pango
+ window = gtk.Window()
+ window.connect('destroy',
+         lambda sender: gtk.main_quit())
+ workspace = gtk.VBox()
+ window.add(workspace)
+ # text widget
+ scrolled = gtk.ScrolledWindow()
+ workspace.pack_start(scrolled)
+ text = gtk.TextView()
+ scrolled.add(text)
+ buffer = text.props.buffer
+ buffer.props.text = file(__file__).read()
+ tag = buffer.create_tag()
+ tag.props.weight = pango.WEIGHT_BOLD
+ # play controls
+ toolbar = gtk.HBox()
+ workspace.pack_end(toolbar, False)
+ play = gtk.Button('Play/Resume')
+ play.connect('clicked',
+         lambda sender: pipe.set_state(gst.STATE_PLAYING))
+ toolbar.add(play)
+ pause = gtk.Button('Pause')
+ pause.connect('clicked',
+         lambda sender: pipe.set_state(gst.STATE_PAUSED))
+ toolbar.add(pause)
+ stop = gtk.Button('Stop')
+ stop.connect('clicked',
+         lambda sender: pipe.set_state(gst.STATE_NULL))
+ toolbar.add(stop)
+ # gst code
+ pipe = gst.parse_launch('espeak name=src ! autoaudiosink')
+ src = pipe.get_by_name('src')
+ src.props.text = buffer.props.text
+ src.props.track = 1 # track for words
+ def tts_cb(bus, message):
+     if message.structure.get_name() != 'espeak-word':
+         return
+     offset = message.structure['offset']
+     len = message.structure['len']
+     buffer.remove_tag(tag, buffer.get_start_iter(), buffer.get_end_iter())
+     start = buffer.get_iter_at_offset(offset)
+     end = buffer.get_iter_at_offset(offset + len)
+     buffer.apply_tag(tag, start, end)
+ bus = pipe.get_bus()
+ bus.add_signal_watch()
+ bus.connect('message::element', tts_cb)
+ # gtk start
+ window.show_all()
+ gtk.main()
+== Known issues ==
+* espeak-ng requires v0.5.0, or on Debian and Ubuntu use package version 0.4.0-3 or later, which has Debian Bug #877750 fix.
+* '''espeak-word''' with espeak < 1.40.09 doesn't track words with numbers(at least full-numered words) in proper way
+* if you are tracking '''espeak-word''' with espeak < 1.40.10 you should use gst-plugins-espeak-0.3x(or 0.3 branch in git repository)
+== Install ==
+gstreamer-plugins-espeak is a part of SugarPlatform-0.84, so just install meta package(depends on your distro) with SP.
+==== XO ====
+* attach [http://people.sugarlabs.org/~alsroot/xo/] repo(or just download proper .rpm)
+* install gstreamer-plugins-espeak package
+== Contacts ==
+* [[User:Alsroot|Aleksey Lim]]
+* [[User:Quozl|James Cameron]]
+* be involved and add yourself here
 === Resources ===
-* [http://git.sugarlabs.org/projects/gst-plugins-espeak Sources]
+* [https://github.com/sugarlabs/gst-plugins-espeak Sources]
+* [http://git.sugarlabs.org/projects/gst-plugins-espeak Previous Sources]
 * [http://download.sugarlabs.org/sources/honey/gst-plugins-espeak/ Tarballs]
+[[Category:Activity Team]]