# coding: utf-8 # (C) Copyright IBM Corp. 2018, 2020. # # 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. from ibm_watson.websocket import SynthesizeCallback, SynthesizeListener from .text_to_speech_v1 import TextToSpeechV1 from urllib.parse import urlencode BEARER = 'Bearer' class TextToSpeechV1Adapter(TextToSpeechV1): def synthesize_using_websocket(self, text, synthesize_callback, accept=None, voice=None, timings=None, customization_id=None, spell_out_mode=None, rate_percentage=None, pitch_percentage=None, http_proxy_host=None, http_proxy_port=None, **kwargs): """ Synthesizes text to spoken audio using web sockets. It supports the use of the SSML element to identify the location of user-specified markers in the audio. It can also return timing information for all strings of the input text. Note:The service processes one request per connection. :param str text: Provides the text that is to be synthesized. The client can pass plain text or text that is annotated with the Speech Synthesis Markup Language (SSML). For more information, see [Specifying input text](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-usingHTTP#input). SSML input can also include the element; see [Specifying an SSML mark](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-timing#mark). The client can pass a maximum of 5 KB of text with the request. :param SynthesizeCallback synthesize_callback: The callback method for the websocket. :param str accept: Specifies the requested format (MIME type) of the audio. For more information, see [Specifying an audio format](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-usingHTTP#format). In addition to the supported specifications, you can use */* to specify the default audio format, audio/ogg;codecs=opus. :param str voice: The voice to use for synthesis. :param list[str] timings: Specifies that the service is to return word timing information for all strings of the input text. The service returns the start and end time of each string of the input. Specify words as the lone element of the array to request word timings. Specify an empty array or omit the parameter to receive no word timings. For more information, see [Obtaining word timings](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-timing#timing). Not supported for Japanese input text. :param str customization_id: Specifies the globally unique identifier (GUID) for a custom voice model that is to be used for the synthesis. A custom voice model is guaranteed to work only if it matches the language of the voice that is used for the synthesis. If you include a customization ID, you must call the method with the service credentials of the custom model's owner. Omit the parameter to use the specified voice with no customization. For more information, see [Understanding customization] (https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-customIntro#customIntro). :param str spell_out_mode: (optional) *For German voices,* indicates how the service is to spell out strings of individual letters. To indicate the pace of the spelling, specify one of the following values: * `default` - The service reads the characters at the rate at which it synthesizes speech for the request. You can also omit the parameter entirely to achieve the default behavior. * `singles` - The service reads the characters one at a time, with a brief pause between each character. * `pairs` - The service reads the characters two at a time, with a brief pause between each pair. * `triples` - The service reads the characters three at a time, with a brief pause between each triplet. The parameter is available only for IBM Cloud. **See also:** [Specifying how strings are spelled out](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-synthesis-params#params-spell-out-mode). :param int rate_percentage: (optional) The percentage change from the default speaking rate of the voice that is used for speech synthesis. Each voice has a default speaking rate that is optimized to represent a normal rate of speech. The parameter accepts an integer that represents the percentage change from the voice's default rate: * Specify a signed negative integer to reduce the speaking rate by that percentage. For example, -10 reduces the rate by ten percent. * Specify an unsigned or signed positive integer to increase the speaking rate by that percentage. For example, 10 and +10 increase the rate by ten percent. * Specify 0 or omit the parameter to get the default speaking rate for the voice. The parameter affects the rate for an entire request. For more information, see [Modifying the speaking rate](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-synthesis-params#params-rate-percentage). :param int pitch_percentage: (optional) The percentage change from the default speaking pitch of the voice that is used for speech synthesis. Each voice has a default speaking pitch that is optimized to represent a normal tone of voice. The parameter accepts an integer that represents the percentage change from the voice's default tone: * Specify a signed negative integer to lower the voice's pitch by that percentage. For example, -5 reduces the tone by five percent. * Specify an unsigned or signed positive integer to increase the voice's pitch by that percentage. For example, 5 and +5 increase the tone by five percent. * Specify 0 or omit the parameter to get the default speaking pitch for the voice. The parameter affects the pitch for an entire request. For more information, see [Modifying the speaking pitch](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-synthesis-params#params-pitch-percentage). :param str http_proxy_host: http proxy host name. :param str http_proxy_port: http proxy port. If not set, set to 80. :param dict headers: A `dict` containing the request headers :return: A `dict` containing the `SpeechRecognitionResults` response. :rtype: dict """ if text is None: raise ValueError('text must be provided') if synthesize_callback is None: raise ValueError('synthesize_callback must be provided') if not isinstance(synthesize_callback, SynthesizeCallback): raise Exception( 'Callback is not a derived class of SynthesizeCallback') request = {} headers = {} if self.default_headers is not None: headers = self.default_headers.copy() if 'headers' in kwargs: headers.update(kwargs.get('headers')) request['headers'] = headers if self.authenticator: self.authenticator.authenticate(request) url = self.service_url.replace('https:', 'wss:') params = { 'voice': voice, 'customization_id': customization_id, 'spell_out_mode': spell_out_mode, 'rate_percentage': rate_percentage, 'pitch_percentage': pitch_percentage } params = {k: v for k, v in params.items() if v is not None} url += '/v1/synthesize?{0}'.format(urlencode(params)) request['url'] = url options = {'text': text, 'accept': accept, 'timings': timings} options = {k: v for k, v in options.items() if v is not None} request['options'] = options SynthesizeListener(request.get('options'), synthesize_callback, request.get('url'), request.get('headers'), http_proxy_host, http_proxy_port, self.disable_ssl_verification)