Win say (#2866)
* Add a text-to-speech module for windows. * Fix documentation
This commit is contained in:
jhawkesworth
Matt Clay
parent
0d8ceefd48
commit
4a8fc74288
2 changed files with 216 additions and 0 deletions
106
lib/ansible/modules/extras/windows/win_say.ps1
Normal file
106
lib/ansible/modules/extras/windows/win_say.ps1
Normal file
|
|
@ -0,0 +1,106 @@
|
|||
#!powershell
|
||||
# This file is part of Ansible
|
||||
#
|
||||
# Copyright 2016, Jon Hawkesworth (@jhawkesworth) <figs@unity.demon.co.uk>
|
||||
#
|
||||
# Ansible is free software: you can redistribute it and/or modify
|
||||
# it under the terms of the GNU General Public License as published by
|
||||
# the Free Software Foundation, either version 3 of the License, or
|
||||
# (at your option) any later version.
|
||||
#
|
||||
# Ansible is distributed in the hope that it will be useful,
|
||||
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
# GNU General Public License for more details.
|
||||
#
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
# WANT_JSON
|
||||
# POWERSHELL_COMMON
|
||||
|
||||
$params = Parse-Args $args;
|
||||
$result = New-Object PSObject;
|
||||
$msg = Get-AnsibleParam -obj $params -name "msg"
|
||||
$msg_file = Get-AnsibleParam -obj $params -name "msg_file"
|
||||
$start_sound_path = Get-AnsibleParam -obj $params -name "start_sound_path"
|
||||
$end_sound_path = Get-AnsibleParam -obj $params -name "end_sound_path"
|
||||
$voice = Get-AnsibleParam -obj $params -name "voice"
|
||||
$speech_speed = Get-AnsibleParam -obj $params -name "speech_speed"
|
||||
$speed = 0
|
||||
$words = $null
|
||||
|
||||
if ($speech_speed -ne $null) {
|
||||
try {
|
||||
$speed = [convert]::ToInt32($speech_speed, 10)
|
||||
} catch {
|
||||
Fail-Json $result "speech_speed needs to a integer in the range -10 to 10. The value $speech_speed could not be converted to an integer."
|
||||
|
||||
}
|
||||
if ($speed -lt -10 -or $speed -gt 10) {
|
||||
Fail-Json $result "speech_speed needs to a integer in the range -10 to 10. The value $speech_speed is outside this range."
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
if ($msg_file -ne $null -and $msg -ne $null ) {
|
||||
Fail-Json $result "Please specify either msg_file or msg parameters, not both"
|
||||
}
|
||||
|
||||
if ($msg_file -eq $null -and $msg -eq $null -and $start_sound_path -eq $null -and $end_sound_path -eq $null) {
|
||||
Fail-Json $result "No msg_file, msg, start_sound_path, or end_sound_path parameters have been specified. Please specify at least one so the module has something to do"
|
||||
|
||||
}
|
||||
|
||||
|
||||
if ($msg_file -ne $null) {
|
||||
if (Test-Path $msg_file) {
|
||||
$words = Get-Content $msg_file | Out-String
|
||||
} else {
|
||||
Fail-Json $result "Message file $msg_file could not be found or opened. Ensure you have specified the full path to the file, and the ansible windows user has permission to read the file."
|
||||
}
|
||||
}
|
||||
|
||||
if ($start_sound_path -ne $null) {
|
||||
if (Test-Path $start_sound_path) {
|
||||
(new-object Media.SoundPlayer $start_sound_path).playSync();
|
||||
} else {
|
||||
Fail-Json $result "Start sound file $start_sound_path could not be found or opened. Ensure you have specified the full path to the file, and the ansible windows user has permission to read the file."
|
||||
}
|
||||
}
|
||||
|
||||
if ($msg -ne $null) {
|
||||
$words = $msg
|
||||
}
|
||||
|
||||
if ($words -ne $null) {
|
||||
Add-Type -AssemblyName System.speech
|
||||
$tts = New-Object System.Speech.Synthesis.SpeechSynthesizer
|
||||
if ($voice -ne $null) {
|
||||
try {
|
||||
$tts.SelectVoice($voice)
|
||||
} catch [System.Management.Automation.MethodInvocationException] {
|
||||
Set-Attr $result "voice_info" "Could not load voice $voice, using system default voice."
|
||||
}
|
||||
}
|
||||
|
||||
Set-Attr $result "voice" $tts.Voice.Name
|
||||
if ($speed -ne 0) {
|
||||
$tts.Rate = $speed
|
||||
}
|
||||
$tts.Speak($words)
|
||||
$tts.Dispose()
|
||||
}
|
||||
|
||||
if ($end_sound_path -ne $null) {
|
||||
if (Test-Path $end_sound_path) {
|
||||
(new-object Media.SoundPlayer $end_sound_path).playSync();
|
||||
} else {
|
||||
Fail-Json $result "End sound file $start_sound_path could not be found or opened. Ensure you have specified the full path to the file, and the ansible windows user has permission to read the file."
|
||||
}
|
||||
}
|
||||
|
||||
Set-Attr $result "changed" $false;
|
||||
Set-Attr $result "message_text" $words;
|
||||
|
||||
Exit-Json $result;
|
||||
110
lib/ansible/modules/extras/windows/win_say.py
Normal file
110
lib/ansible/modules/extras/windows/win_say.py
Normal file
|
|
@ -0,0 +1,110 @@
|
|||
#!/usr/bin/python
|
||||
# -*- coding: utf-8 -*-
|
||||
|
||||
# (c) 2016, Jon Hawkesworth (@jhawkesworth) <figs@unity.demon.co.uk>
|
||||
#
|
||||
# This file is part of Ansible
|
||||
#
|
||||
# Ansible is free software: you can redistribute it and/or modify
|
||||
# it under the terms of the GNU General Public License as published by
|
||||
# the Free Software Foundation, either version 3 of the License, or
|
||||
# (at your option) any later version.
|
||||
#
|
||||
# Ansible is distributed in the hope that it will be useful,
|
||||
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
# GNU General Public License for more details.
|
||||
#
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
# this is a windows documentation stub. actual code lives in the .ps1
|
||||
# file of the same name
|
||||
|
||||
DOCUMENTATION = '''
|
||||
---
|
||||
module: win_say
|
||||
version_added: "2.2"
|
||||
short_description: Text to speech module for Windows to speak messages and optionally play sounds
|
||||
description:
|
||||
- Uses .NET libraries to convert text to speech and optionally play .wav sounds. Audio Service needs to be running and some kind of speakers or headphones need to be attached to the windows target(s) for the speech to be audible.
|
||||
options:
|
||||
msg:
|
||||
description:
|
||||
- The text to be spoken. Use either msg or msg_file. Optional so that you can use this module just to play sounds.
|
||||
required: false
|
||||
default: none
|
||||
msg_file:
|
||||
description:
|
||||
- Full path to a windows format text file containing the text to be spokend. Use either msg or msg_file. Optional so that you can use this module just to play sounds.
|
||||
required: false
|
||||
default: none
|
||||
voice:
|
||||
description:
|
||||
- Which voice to use. See notes for how to discover installed voices. If the requested voice is not available the default voice will be used. Example voice names from Windows 10 are 'Microsoft Zira Desktop' and 'Microsoft Hazel Desktop'.
|
||||
required: false
|
||||
default: system default voice
|
||||
speech_speed:
|
||||
description:
|
||||
- How fast or slow to speak the text. Must be an integer value in the range -10 to 10. -10 is slowest, 10 is fastest.
|
||||
required: false
|
||||
default: 0
|
||||
start_sound_path:
|
||||
description:
|
||||
- Full path to a C(.wav) file containing a sound to play before the text is spoken. Useful on conference calls to alert other speakers that ansible has something to say.
|
||||
required: false
|
||||
default: null
|
||||
end_sound_path:
|
||||
description:
|
||||
- Full path to a C(.wav) file containing a sound to play after the text has been spoken. Useful on conference calls to alert other speakers that ansible has finished speaking.
|
||||
required: false
|
||||
default: null
|
||||
author: "Jon Hawkesworth (@jhawkesworth)"
|
||||
notes:
|
||||
- Needs speakers or headphones to do anything useful.
|
||||
- To find which voices are installed, run the following powershell
|
||||
Add-Type -AssemblyName System.Speech
|
||||
$speech = New-Object -TypeName System.Speech.Synthesis.SpeechSynthesizer
|
||||
$speech.GetInstalledVoices() | ForEach-Object { $_.VoiceInfo }
|
||||
$speech.Dispose()
|
||||
- Speech can be surprisingly slow, so its best to keep message text short.
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
# Warn of impending deployment
|
||||
- win_say:
|
||||
msg: Warning, deployment commencing in 5 minutes, please log out.
|
||||
# Using a different voice and a start sound
|
||||
- win_say:
|
||||
start_sound_path: 'C:\Windows\Media\ding.wav'
|
||||
msg: Warning, deployment commencing in 5 minutes, please log out.
|
||||
voice: Microsoft Hazel Desktop
|
||||
# example with start and end sound
|
||||
- win_say:
|
||||
start_sound_path: 'C:\Windows\Media\Windows Balloon.wav'
|
||||
msg: "New software installed"
|
||||
end_sound_path: 'C:\Windows\Media\chimes.wav'
|
||||
# text from file example
|
||||
- win_say:
|
||||
start_sound_path: 'C:\Windows\Media\Windows Balloon.wav'
|
||||
msg_text: AppData\Local\Temp\morning_report.txt
|
||||
end_sound_path: 'C:\Windows\Media\chimes.wav'
|
||||
'''
|
||||
RETURN = '''
|
||||
message_text:
|
||||
description: the text that the module attempted to speak
|
||||
returned: success
|
||||
type: string
|
||||
sample: "Warning, deployment commencing in 5 minutes."
|
||||
voice:
|
||||
description: the voice used to speak the text.
|
||||
returned: success
|
||||
type: string
|
||||
sample: Microsoft Hazel Desktop
|
||||
voice_info:
|
||||
description: the voice used to speak the text.
|
||||
returned: when requested voice could not be loaded
|
||||
type: string
|
||||
sample: Could not load voice TestVoice, using system default voice
|
||||
'''
|
||||
|
||||
Loading…
Reference in a new issue