Add text-to-speech beta samples [(#1421)](GoogleCloudPlatform/python-…

…docs-samples#1421)

samples/README.rst

@@ -0,0 +1,167 @@
+.. This file is automatically generated. Do not edit this file directly.
+
+Google Cloud Text-to-Speech API Python Samples
+===============================================================================
+
+.. image:: https://gstatic.com/cloudssh/images/open-btn.png
+   :target: https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/GoogleCloudPlatform/python-docs-samples&page=editor&open_in_editor=/README.rst
+
+
+This directory contains samples for Google Cloud Text-to-Speech API. The `Google Cloud Text To Speech API`_ enables you to generate and customize synthesized speech from text or SSML.
+
+
+
+
+.. _Google Cloud Text-to-Speech API: https://cloud.google.com/text-to-speech/docs/
+
+Setup
+-------------------------------------------------------------------------------
+
+
+Authentication
+++++++++++++++
+
+This sample requires you to have authentication setup. Refer to the
+`Authentication Getting Started Guide`_ for instructions on setting up
+credentials for applications.
+
+.. _Authentication Getting Started Guide:
+    https://cloud.google.com/docs/authentication/getting-started
+
+Install Dependencies
+++++++++++++++++++++
+
+#. Install `pip`_ and `virtualenv`_ if you do not already have them. You may want to refer to the `Python Development Environment Setup Guide`_ for Google Cloud Platform for instructions.
+
+ .. _Python Development Environment Setup Guide:
+     https://cloud.google.com/python/setup
+
+#. Create a virtualenv. Samples are compatible with Python 2.7 and 3.4+.
+
+    .. code-block:: bash
+
+        $ virtualenv env
+        $ source env/bin/activate
+
+#. Install the dependencies needed to run the samples.
+
+    .. code-block:: bash
+
+        $ pip install -r requirements.txt
+
+.. _pip: https://pip.pypa.io/
+.. _virtualenv: https://virtualenv.pypa.io/
+
+Samples
+-------------------------------------------------------------------------------
+
+Quickstart
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. image:: https://gstatic.com/cloudssh/images/open-btn.png
+   :target: https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/GoogleCloudPlatform/python-docs-samples&page=editor&open_in_editor=/quickstart.py;/README.rst
+
+
+
+
+To run this sample:
+
+.. code-block:: bash
+
+    $ python quickstart.py
+
+
+List voices
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. image:: https://gstatic.com/cloudssh/images/open-btn.png
+   :target: https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/GoogleCloudPlatform/python-docs-samples&page=editor&open_in_editor=/list_voices.py;/README.rst
+
+
+
+
+To run this sample:
+
+.. code-block:: bash
+
+    $ python list_voices.py
+
+
+Synthesize text
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. image:: https://gstatic.com/cloudssh/images/open-btn.png
+   :target: https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/GoogleCloudPlatform/python-docs-samples&page=editor&open_in_editor=/synthesize_text.py;/README.rst
+
+
+
+
+To run this sample:
+
+.. code-block:: bash
+
+    $ python synthesize_text.py
+
+    usage: synthesize_text.py [-h] (--text TEXT | --ssml SSML)
+
+    Google Cloud Text-To-Speech API sample application .
+
+    Example usage:
+        python synthesize_text.py --text "hello"
+        python synthesize_text.py --ssml "<speak>Hello there.</speak>"
+
+    optional arguments:
+      -h, --help   show this help message and exit
+      --text TEXT  The text from which to synthesize speech.
+      --ssml SSML  The ssml string from which to synthesize speech.
+
+
+
+Synthesize file
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. image:: https://gstatic.com/cloudssh/images/open-btn.png
+   :target: https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/GoogleCloudPlatform/python-docs-samples&page=editor&open_in_editor=/synthesize_file.py;/README.rst
+
+
+
+
+To run this sample:
+
+.. code-block:: bash
+
+    $ python synthesize_file.py
+
+    usage: synthesize_file.py [-h] (--text TEXT | --ssml SSML)
+
+    Google Cloud Text-To-Speech API sample application .
+
+    Example usage:
+        python synthesize_file.py --text resources/hello.txt
+        python synthesize_file.py --ssml resources/hello.ssml
+
+    optional arguments:
+      -h, --help   show this help message and exit
+      --text TEXT  The text file from which to synthesize speech.
+      --ssml SSML  The ssml file from which to synthesize speech.
+
+
+
+
+
+The client library
+-------------------------------------------------------------------------------
+
+This sample uses the `Google Cloud Client Library for Python`_.
+You can read the documentation for more details on API usage and use GitHub
+to `browse the source`_ and  `report issues`_.
+
+.. _Google Cloud Client Library for Python:
+    https://googlecloudplatform.github.io/google-cloud-python/
+.. _browse the source:
+    https://github.com/GoogleCloudPlatform/google-cloud-python
+.. _report issues:
+    https://github.com/GoogleCloudPlatform/google-cloud-python/issues
+
+
+.. _Google Cloud SDK: https://cloud.google.com/sdk/

samples/README.rst.in

@@ -0,0 +1,26 @@
+# This file is used to generate README.rst
+
+product:
+  name: Google Cloud Text-to-Speech API
+  short_name: Cloud TTS API
+  url: https://cloud.google.com/text-to-speech/docs/
+  description: >
+    The `Google Cloud Text To Speech API`_ enables you to generate and customize synthesized speech from text or SSML.
+
+setup:
+- auth
+- install_deps
+
+samples:
+- name: Quickstart
+  file: quickstart.py
+- name: List voices
+  file: list_voices.py
+- name: Synthesize text
+  file: synthesize_text.py
+  show_help: True
+- name: Synthesize file
+  file: synthesize_file.py
+  show_help: True
+
+cloud_client_library: true

samples/list_voices.py

@@ -0,0 +1,56 @@
+#!/usr/bin/env python
+
+# Copyright 2018 Google Inc. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""Google Cloud Text-To-Speech API sample application.
+
+Example usage:
+    python list_voices.py
+"""
+
+
+# [START tts_list_voices]
+def list_voices():
+    """Lists the available voices."""
+    from google.cloud import texttospeech
+    client = texttospeech.TextToSpeechClient()
+
+    # Performs the list voices request
+    voices = client.list_voices()
+
+    for voice in voices.voices:
+        # Display the voice's name. Example: tpc-vocoded
+        print('Name: {}'.format(voice.name))
+
+        # Display the supported language codes for this voice. Example: "en-US"
+        for language_code in voice.language_codes:
+            print('Supported language: {}'.format(language_code))
+
+        # SSML Voice Gender values from google.cloud.texttospeech.enums
+        ssml_voice_genders = ['SSML_VOICE_GENDER_UNSPECIFIED', 'MALE',
+                              'FEMALE', 'NEUTRAL']
+
+        # Display the SSML Voice Gender
+        print('SSML Voice Gender: {}'.format(
+            ssml_voice_genders[voice.ssml_gender]))
+
+        # Display the natural sample rate hertz for this voice. Example: 24000
+        print('Natural Sample Rate Hertz: {}\n'.format(
+            voice.natural_sample_rate_hertz))
+# [END tts_list_voices]
+
+
+if __name__ == '__main__':
+    list_voices()

samples/list_voices_test.py

@@ -0,0 +1,23 @@
+# Copyright 2018, Google, Inc.
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import list_voices
+
+
+def test_list_voices(capsys):
+    list_voices.list_voices()
+    out, err = capsys.readouterr()
+
+    assert 'en-US' in out
+    assert 'SSML Voice Gender: MALE' in out
+    assert 'SSML Voice Gender: FEMALE' in out

samples/quickstart.py

@@ -0,0 +1,62 @@
+#!/usr/bin/env python
+
+# Copyright 2018 Google Inc. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""Google Cloud Text-To-Speech API sample application .
+
+Example usage:
+    python quickstart.py
+"""
+
+
+def run_quickstart():
+    # [START tts_quickstart]
+    """Synthesizes speech from the input string of text or ssml.
+
+    Note: ssml must be well-formed according to:
+        https://www.w3.org/TR/speech-synthesis/
+    """
+    from google.cloud import texttospeech
+
+    # Instantiates a client
+    client = texttospeech.TextToSpeechClient()
+
+    # Set the text input to be synthesized
+    synthesis_input = texttospeech.types.SynthesisInput(text="Hello, World!")
+
+    # Build the voice request, select the language code ("en-US") and the ssml
+    # voice gender ("neutral")
+    voice = texttospeech.types.VoiceSelectionParams(
+        language_code='en-US',
+        ssml_gender=texttospeech.enums.SsmlVoiceGender.NEUTRAL)
+
+    # Select the type of audio file you want returned
+    audio_config = texttospeech.types.AudioConfig(
+        audio_encoding=texttospeech.enums.AudioEncoding.MP3)
+
+    # Perform the text-to-speech request on the text input with the selected
+    # voice parameters and audio file type
+    response = client.synthesize_speech(synthesis_input, voice, audio_config)
+
+    # The response's audio_content is binary.
+    with open('output.mp3', 'wb') as out:
+        # Write the response to the output file.
+        out.write(response.audio_content)
+        print('Audio content written to file "output.mp3"')
+    # [END tts_quickstart]
+
+
+if __name__ == '__main__':
+    run_quickstart()

samples/requirements.txt

@@ -0,0 +1 @@
+google-cloud-texttospeech==0.1.0

samples/resources/hello.ssml

@@ -0,0 +1 @@
+<speak>Hello there.</speak>

samples/resources/hello.txt

@@ -0,0 +1 @@
+Hello there!