[jA_cOp]

Description
gSpeak is a module for gmod that lets you use Microsoft Speech from Lua. You can use it both on the server and the client, but it makes more sense on the client. If you use it on the server, gSpeak will not broadcast voice output to clients.

gspeak.Say(string message [, ushort volume, long rate])
gspeak.IsSpeaking()
gspeak.QueueSize()
gspeak.Pause()
gspeak.Resume()

gspeak.Say makes your system default voice (XP: Sam, Vista: Anna) speak the provided message, optionally also at the provided volume and rate of speech. The volume is a value between 0 and 100, where 100 is the default. The rate is a value between -10 and 10, where 0 is typically the default. You can also use the SAPI's XML markup within the message to mutate the pitch, volume and rate of speech.

gspeak.IsSpeaking returns a boolean value whether or not gspeak is currently saying anything.

gspeak.QueueSize returns the amount of messages currently waiting to be spoken, including the one currently being spoken.

gspeak.Pause pauses the voice temporarily before the next word. IsSpeaking returns false while the voice is paused; even if the voice is currently finishing up on a word before pausing.

gspeak.Resume resumes a paused voice. You can use Pause and Resume even if the voice is already paused or is already speaking; they'll just return immediately, so there's no need to use IsSpeaking/QueueSize to check if pausing/resuming is viable.

More on XML markup
The XML markup can be used to modify the pronounciation of entire text or just portions of it. You can change attributes such as pitch, volume and rate using the embedded XML. You can also insert pockets of silence, or tell the voice how to pronounce something.

More advanced features include making the current voice be chosen based on gender, age and language!

I have not tested all of these features, but there's a detailed tutorial on the XML markup here.

Example: Spoken chat
Clientside script for speaking out chat (and notifications, leave messages):

require("speak")

local function speak(index, nick, msg, msgtype)
		gspeak.Say(msg)
end
hook.Add("ChatText", "gspeak_saychat", speak)

Example: Console command

concommand.Add("tts", function(ply, cmd, args)
    if #args == 0 then print("Usage: speak <message>") return end
    gspeak.Say(table.concat(args, " "))
end)

Usage (in console):

tts SamuraiMushroom is a faggot!

Todo
Add a mechanism for choosing/getting the default voice and language.

Temporary method of changing voice
You have to select your system default voice in Control Panel->(Text To) Speech, the default voice is the one used by gspeak.

Download v1.6.2
Put gm_speak.dll in your lua/includes/modules/ folder to use.
#luahelp download mirror
filesmelt download mirror

Credits
Foss - came up with the idea

[MajorVictory]

Some SAPI Documentation for ya. Not sure if it works though...

http://www.w3.org/TR/speech-synthesis/#S3

[Kill coDer]

If only you could stream this to clients...

[jA_cOp]

New version put up, now lets you supply the rate and volume.

Kill coDer posted:

If only you could stream this to clients...

I can only see this possible by sending the sound data to the client, generate a sound file in the data folder then play that file. This is extremely slow compared to regular techniques like VOIP.

[Foss]

Idea stealer.

[Deco Da Man]

Foss posted:

Idea stealer.

I'm pretty sure that many people had thought of the idea much earlier than you first even considered it.

And having an idea doesn't give you credit to it. You actually need to create it.

...unless you take out a patent... but I doubt you could do that in this situation.


Anyway: Awesomely Awesome module!

[Nevec]

jA_cOp posted:

I can only see this possible by sending the sound data to the client, generate a sound file in the data folder then play that file. This is extremely slow compared to regular techniques like VOIP.

Doesn't source already have something like voip? You'd just need to bend the mic system to your way.

Anyways.. Good work!

[maurits150]

Very nice module. I only have a problem.
When I use it, the game freezes until the voice has been finished saying its line.
Am I the only person with this problem?

[CapsAdmin]

maurits150 posted:

Very nice module. I only have a problem.
When I use it, the game freezes until the voice has been finished saying its line.
Am I the only person with this problem?

Yeah it freezes gmod on my computer too.

[Deco Da Man]

Threading would help with that problem, jA_cOp...

I wonder if using the Lua Lanes module would work...

[ahref]

anyone not have the freezing problem?

[ahref]

WARNING: This file has been reported! It may be dangerous! Download at your own risk!
If this is your file, don't waste your time editing the description to say the file is safe, if you do your file will be automatically deleted when it gets checked.

:O who did that.

EDIT: SORRY FOR DOUBLE POST!

[YYZ]

ahref posted:

:O who did that.

Pretty sure files with DLLs in them are auto-reported or some shit.

[jA_cOp]

i figured since calling the speak function (which is done on module initialization) doesn't block, it would have no effect on the loading. So I assumed the freeze was because of the other loading stuff. I'll try taking that out and see what happens.

[jA_cOp]

Alright when I take that out, the freeze happens the first time gspeak.Say is called instead.

I could move the initialization into another thread though. I'll do that now.

edit:

Here we go:


I could thread the whole initialization, but then the first script to require the module would get nil errors for global "gspeak", so I think it's best to leave the actual initialization blocking. The "gSpeak loaded" line has been moved into a seperate thread though, and I felt that it helped loading a little bit. Try it and see how it acts for you.

[CapsAdmin]

Still freezes for me on gspeak.Say, but not when it loads.

[jA_cOp]

CapsAdmin posted:

Still freezes for me on gspeak.Say, but not when it loads.

Weird. Perhaps 'require' manages to return and call gspeak.Say in your script before my thread gets any time. Could you try doing require and gspeak.Say in seperate lua_run_cl commands? See if it freezes anywhere, and where.

[maurits150]

jA_cOp posted:

Weird. Perhaps 'require' manages to return and call gspeak.Say in your script before my thread gets any time. Could you try doing require and gspeak.Say in seperate lua_run_cl commands? See if it freezes anywhere, and where.

I just did this, and it still freezes.

[jA_cOp]

maurits150 posted:

I just did this, and it still freezes.

With the newest version? And using "require" or "gspeak.Say"?

Thanks for any help. I'm currently at a laptop where I get like 3 FPS in gmod under most conditions, so it's fairly difficult to get any decisive results from testing.

[CapsAdmin]

jA_cOp posted:

With the newest version? And using "require" or "gspeak.Say"?

Thanks any help. I'm currently at a laptop where I get like 3 FPS in gmod under most conditions, so it's fairly difficult to get any decisive results from testing.

I tried this, too.

And yeah with the latest version.

[mbainrot]

Links dead

Fucking 12yr paranoid c****....

[jA_cOp]

New link up. It's a legit module and the source is included, why would anyone take it down? :S

[HubmaN]

Anyone try this on Wine yet?

[Kogitsune]

jA_cOp posted:

New link up. It's a legit module and the source is included, why would anyone take it down? :S

Aren't DLLs auto-reported?

[mbainrot]

who knows, (I host my dll shit on my website)

[mbainrot]

Its brilliant, only prob is that its a halting call, the game locks up for 1/2 of a second while the call runs, have you tried calling it in its own "thread"?

[leach139]

HubmaN posted:

Anyone try this on Wine yet?

As far as I'm aware, the WinE codebase doesn't have any binaries for TextToSpeech. Either try Crossover (I'll do this soon) or submit a Feature Request.

[FPtje]

Deco Da Man posted:

I'm pretty sure that many people had thought of the idea much earlier than you first even considered it.

And having an idea doesn't give you credit to it. You actually need to create it.

...unless you take out a patent... but I doubt you could do that in this situation.


Anyway: Awesomely Awesome module!

Haha I remember requesting this once too but that was years ago.

Can't you send the module to the client and just send the text to a clientside lua file to let the client pay it? (I have no experience with modules so I don't know...)

[jA_cOp]

HubmaN posted:

Anyone try this on Wine yet?

Wine does not support any replacement for Windows' SAPI.

Kogitsune posted:

Aren't DLLs auto-reported?

Yeah, but it takes a moderator to look at it and take it down instead of mark it as checked and legit.

mbainrot posted:

Its brilliant, only prob is that its a halting call, the game locks up for 1/2 of a second while the call runs, have you tried calling it in its own "thread"?

It only freezes the first time it speaks.

I am using a thread for the first time, but there's a way for Lua to grab that first call before the thread I am starting. I'll make a fix for it eventually. (by yielding the thread that calls the module's Init function, after launching the thread.)

FPtje posted:

Can't you send the module to the client and just send the text to a clientside lua file to let the client pay it? (I have no experience with modules so I don't know...)

You cannot send modules to the client. Well, you can, but not to the directory where you can load them in Lua. This is a good thing, else any server could do anything they wanted to on their clients.

[mbainrot]

jA_cOp posted:

Wine does not support any replacement for Windows' SAPI.



Yeah, but it takes a moderator to look at it and take it down instead of mark it as checked and legit.



It only freezes the first time it speaks.

I am using a thread for the first time, but there's a way for Lua to grab that first call before the thread I am starting. I'll make a fix for it eventually. (by yielding the thread that calls the module's Init function, after launching the thread.)



You cannot send modules to the client. Well, you can, but not to the directory where you can load them in Lua. This is a good thing, else any server could do anything they wanted to on their clients.

for me it locks up everytime, Damn I miss vista :( (right now i am on Win XP Pro SP3)

[jA_cOp]

New version that doesn't freeze.



It doesn't say anything on startup either.

edit:

There is a better way to thread this than what I am doing, I'll probably do that later if I work more on this.

[ahref]

Not entirely sure if its just me but im not getting any output with this. is anyone else having the problem?

[Mr Affinity]

1.3 is working perfectly for me.

[Prefan]

Too bad this can't be streamed from the server to the clients, so much use could come out of this.

[mbainrot]

load 'n' her up now, i'll post with results :D

[Grocel]

There is no download link. :(

[jA_cOp]

Put up a working download that isn't from garrysmod.org.

What dumb garrysmod.org moderator would seriously keep removing this?

[Nerdboy]

Are you putting them in zip files?

[jA_cOp]

Yes, they've all been in zip files.

VERSION 1.4
http://upl.luahelp.com/uploads/z9PsX...peak%201.4.zip

No new features, just fixed some issues before people would start noticing them. It now only uses a max of one thread for speaking, instead of one thread per gspeak.Say call (which remains until the message has been spoken).

This means that you could now do:

for counter = 1, 9001 do
    gspeak.Say(tostring(counter))
end

Without creating 9001 threads. It now queues messages instead and keeps one thread alive when the queue is not empty.

[Grocel]

When you use this module and leave the game then comes to a crash. :(

Can you fix this please? :)