livekit-plugins-neuphonic 0.1.1__py3-none-any.whl → 1.0.0__py3-none-any.whl

livekit/plugins/neuphonic/tts.py

@@ -20,9 +20,9 @@ import json
 import os
 import weakref
 from dataclasses import dataclass
-from typing import Optional
 
 import aiohttp
+
 from livekit.agents import (
     APIConnectionError,
     APIConnectOptions,
@@ -31,6 +31,8 @@ from livekit.agents import (
     tts,
     utils,
 )
+from livekit.agents.types import DEFAULT_API_CONNECT_OPTIONS, NOT_GIVEN, NotGivenOr
+from livekit.agents.utils import is_given
 
 from .log import logger
 from .models import TTSEncodings, TTSLangCodes, TTSModels
@@ -49,26 +51,20 @@ class _TTSOptions:
     encoding: TTSEncodings | str
     sampling_rate: int
     speed: float
-    voice_id: str | None = None
+    voice_id: NotGivenOr[str] = NOT_GIVEN
 
     @property
     def model_params(self) -> dict:
-        """Returns a dict of all model parameters and their values."""
-        params = [
-            "voice_id",
-            "model",
-            "lang_code",
-            "encoding",
-            "sampling_rate",
-            "speed",
-        ]
-        values = {}
-
-        for param in params:
-            if hasattr(self, param) and getattr(self, param) is not None:
-                values[param] = getattr(self, param)
-
-        return values
+        """Returns a dictionary of model parameters for API requests."""
+        params = {
+            "voice_id": self.voice_id,
+            "model": self.model,
+            "lang_code": self.lang_code,
+            "encoding": self.encoding,
+            "sampling_rate": self.sampling_rate,
+            "speed": self.speed,
+        }
+        return {k: v for k, v in params.items() if is_given(v) and v is not None}
 
     def get_query_param_string(self):
         """Forms the query parameter string from all model parameters."""
@@ -97,9 +93,7 @@ def _parse_sse_message(message: str) -> dict:
     message = json.loads(value)
 
     if message.get("errors") is not None:
-        raise Exception(
-            f"Status {message.status_code} error received: {message.errors}."
-        )
+        raise Exception(f"Status {message.status_code} error received: {message.errors}.")
 
     return message
 
@@ -109,12 +103,12 @@ class TTS(tts.TTS):
         self,
         *,
         model: TTSModels | str = "neu_hq",
-        voice_id: str | None = None,
+        voice_id: NotGivenOr[str] = NOT_GIVEN,
         lang_code: TTSLangCodes | str = "en",
         encoding: TTSEncodings | str = "pcm_linear",
         speed: float = 1.0,
         sample_rate: int = 22050,
-        api_key: str | None = None,
+        api_key: NotGivenOr[str] = NOT_GIVEN,
         http_session: aiohttp.ClientSession | None = None,
         base_url: str = API_BASE_URL,
     ) -> None:
@@ -130,22 +124,19 @@ class TTS(tts.TTS):
             encoding (TTSEncodings | str, optional): The audio encoding format. Defaults to "pcm_mulaw".
             speed (float, optional): The audio playback speed. Defaults to 1.0.
             sample_rate (int, optional): The audio sample rate in Hz. Defaults to 22050.
-            api_key (str | None, optional): The Neuphonic API key. If not provided, it will be read from the NEUPHONIC_API_KEY environment variable.
+            api_key (str | None, optional): The Neuphonic API key. If not provided, it will be read from the NEUPHONIC_API_TOKEN environment variable.
             http_session (aiohttp.ClientSession | None, optional): An existing aiohttp ClientSession to use. If not provided, a new session will be created.
             base_url (str, optional): The base URL for the Neuphonic API. Defaults to "api.neuphonic.com".
-        """
+        """  # noqa: E501
         super().__init__(
             capabilities=tts.TTSCapabilities(streaming=True),
             sample_rate=sample_rate,
             num_channels=NUM_CHANNELS,
         )
 
-        api_key = api_key or os.environ.get("NEUPHONIC_API_KEY")
-
-        if not api_key:
-            raise ValueError(
-                "NEUPHONIC_API_KEY must be set using the argument or by setting the NEUPHONIC_API_KEY environment variable."
-            )
+        neuphonic_api_key = api_key if is_given(api_key) else os.environ.get("NEUPHONIC_API_TOKEN")
+        if not neuphonic_api_key:
+            raise ValueError("API key must be provided or set in NEUPHONIC_API_TOKEN")
 
         self._opts = _TTSOptions(
             model=model,
@@ -154,7 +145,7 @@ class TTS(tts.TTS):
             encoding=encoding,
             speed=speed,
             sampling_rate=sample_rate,
-            api_key=api_key,
+            api_key=neuphonic_api_key,
             base_url=base_url,
         )
 
@@ -191,12 +182,12 @@ class TTS(tts.TTS):
     def update_options(
         self,
         *,
-        model: TTSModels | str = None,
-        voice_id: str | None = None,
-        lang_code: TTSLangCodes | str | None = None,
-        encoding: TTSEncodings | str | None = None,
-        speed: float | None = None,
-        sample_rate: int | None = None,
+        model: NotGivenOr[TTSModels] = NOT_GIVEN,
+        voice_id: NotGivenOr[str] = NOT_GIVEN,
+        lang_code: NotGivenOr[TTSLangCodes] = NOT_GIVEN,
+        encoding: NotGivenOr[TTSEncodings] = NOT_GIVEN,
+        speed: NotGivenOr[float] = NOT_GIVEN,
+        sample_rate: NotGivenOr[int] = NOT_GIVEN,
     ) -> None:
         """
         Update the Text-to-Speech (TTS) configuration options.
@@ -212,20 +203,26 @@ class TTS(tts.TTS):
             encoding (TTSEncodings | str, optional): The audio encoding format.
             speed (float, optional): The audio playback speed.
             sample_rate (int, optional): The audio sample rate in Hz.
-        """
-        self._opts.model = model or self._opts.model
-        self._opts.voice_id = voice_id or self._opts.voice_id
-        self._opts.lang_code = lang_code or self._opts.lang_code
-        self._opts.encoding = encoding or self._opts.encoding
-        self._opts.speed = speed or self._opts.speed
-        self._opts.sampling_rate = sample_rate or self._opts.sampling_rate
+        """  # noqa: E501
+        if is_given(model):
+            self._opts.model = model
+        if is_given(voice_id):
+            self._opts.voice_id = voice_id
+        if is_given(lang_code):
+            self._opts.lang_code = lang_code
+        if is_given(encoding):
+            self._opts.encoding = encoding
+        if is_given(speed):
+            self._opts.speed = speed
+        if is_given(sample_rate):
+            self._opts.sampling_rate = sample_rate
         self._pool.invalidate()
 
     def synthesize(
         self,
         text: str,
         *,
-        conn_options: Optional[APIConnectOptions] = None,
+        conn_options: APIConnectOptions = DEFAULT_API_CONNECT_OPTIONS,
     ) -> ChunkedStream:
         return ChunkedStream(
             tts=self,
@@ -236,7 +233,7 @@ class TTS(tts.TTS):
         )
 
     def stream(
-        self, *, conn_options: Optional[APIConnectOptions] = None
+        self, *, conn_options: APIConnectOptions = DEFAULT_API_CONNECT_OPTIONS
     ) -> SynthesizeStream:
         stream = SynthesizeStream(
             tts=self,
@@ -264,7 +261,7 @@ class ChunkedStream(tts.ChunkedStream):
         input_text: str,
         opts: _TTSOptions,
         session: aiohttp.ClientSession,
-        conn_options: Optional[APIConnectOptions] = None,
+        conn_options: APIConnectOptions,
     ) -> None:
         super().__init__(tts=tts, input_text=input_text, conn_options=conn_options)
         self._opts, self._session = opts, session
@@ -312,9 +309,7 @@ class ChunkedStream(tts.ChunkedStream):
                             parsed_message is not None
                             and parsed_message.get("data", {}).get("audio") is not None
                         ):
-                            audio_bytes = base64.b64decode(
-                                parsed_message["data"]["audio"]
-                            )
+                            audio_bytes = base64.b64decode(parsed_message["data"]["audio"])
 
                             for frame in bstream.write(audio_bytes):
                                 emitter.push(frame)
@@ -348,26 +343,6 @@ class SynthesizeStream(tts.SynthesizeStream):
 
     async def _run(self) -> None:
         request_id = utils.shortuuid()
-        request_data = {request_id: {"sent": "", "recv": ""}}
-
-        def _is_all_audio_recv():
-            """Check whether all audio has been recieved."""
-            recv_text = (
-                request_data[request_id]["recv"]
-                .lower()
-                .replace(" ", "")
-                .replace("\n", "")
-                .replace("<stop>", "")
-            )
-            sent_text = (
-                request_data[request_id]["sent"]
-                .lower()
-                .replace(" ", "")
-                .replace("\n", "")
-                .replace("<stop>", "")
-            )
-
-            return sent_text == recv_text
 
         async def _send_task(ws: aiohttp.ClientWebSocketResponse):
             """Stream text to the websocket."""
@@ -378,7 +353,6 @@ class SynthesizeStream(tts.SynthesizeStream):
                     await ws.send_str(json.dumps({"text": "<STOP>"}))
                     continue
 
-                request_data[request_id]["sent"] += data
                 await ws.send_str(json.dumps({"text": data}))
 
         async def _recv_task(ws: aiohttp.ClientWebSocketResponse):
@@ -411,20 +385,17 @@ class SynthesizeStream(tts.SynthesizeStream):
 
                 if data.get("data"):
                     b64data = base64.b64decode(data["data"]["audio"])
-                    recv_text = data["data"]["text"]
                     for frame in audio_bstream.write(b64data):
                         emitter.push(frame)
 
-                    request_data[request_id]["recv"] += recv_text
+                    if data["data"].get("stop"):  # A bool flag, is True when audio reaches "<STOP>"
+                        for frame in audio_bstream.flush():
+                            emitter.push(frame)
+                        emitter.flush()
+                        break  # we are not going to receive any more audio
                 else:
                     logger.error("Unexpected Neuphonic message %s", data)
 
-                if _is_all_audio_recv():
-                    for frame in audio_bstream.flush():
-                        emitter.push(frame)
-                    emitter.flush()
-                    break  # we are not going to receive any more audio
-
         async with self._pool.connection() as ws:
             tasks = [
                 asyncio.create_task(_send_task(ws)),

livekit/plugins/neuphonic/version.py

@@ -12,4 +12,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-__version__ = "0.1.1"
+__version__ = "1.0.0"

{livekit_plugins_neuphonic-0.1.1.dist-info → livekit_plugins_neuphonic-1.0.0.dist-info}/METADATA

@@ -1,35 +1,23 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: livekit-plugins-neuphonic
-Version: 0.1.1
-Summary: LiveKit Agents Plugin for Neuphonic
-Home-page: https://github.com/livekit/agents
-License: Apache-2.0
+Version: 1.0.0
+Summary: Neuphonic inference plugin for LiveKit Agents
 Project-URL: Documentation, https://docs.livekit.io
 Project-URL: Website, https://livekit.io/
 Project-URL: Source, https://github.com/livekit/agents
-Keywords: webrtc,realtime,audio,video,livekit
+Author-email: LiveKit <hello@livekit.io>
+License-Expression: Apache-2.0
+Keywords: audio,livekit,neuphonic,realtime,webrtc
 Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: Apache Software License
-Classifier: Topic :: Multimedia :: Sound/Audio
-Classifier: Topic :: Multimedia :: Video
-Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Multimedia :: Sound/Audio
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
 Requires-Python: >=3.9.0
+Requires-Dist: livekit-agents>=1.0.0
 Description-Content-Type: text/markdown
-Requires-Dist: livekit-agents<1.0.0,>=0.12.16
-Dynamic: classifier
-Dynamic: description
-Dynamic: description-content-type
-Dynamic: home-page
-Dynamic: keywords
-Dynamic: license
-Dynamic: project-url
-Dynamic: requires-dist
-Dynamic: requires-python
-Dynamic: summary
 
 # LiveKit Plugins Neuphonic
 
@@ -43,4 +31,4 @@ pip install livekit-plugins-neuphonic
 
 ## Pre-requisites
 
-You'll need an API key from Neuphonic. It can be set as an environment variable: `NEUPHONIC_API_KEY`
+You'll need an API key from Neuphonic. It can be set as an environment variable: `NEUPHONIC_API_TOKEN`

livekit_plugins_neuphonic-1.0.0.dist-info/RECORD

@@ -0,0 +1,9 @@
+livekit/plugins/neuphonic/__init__.py,sha256=mJnPVLsKAdUkdWuHWd16A0n2vsVBi3GjgNmB8gv9jjI,1097
+livekit/plugins/neuphonic/log.py,sha256=rAHz71IcbvPkixndXBVffPQsmWUKTLqRaYRuPIxO29w,72
+livekit/plugins/neuphonic/models.py,sha256=Svfn_sWA3Q2ZXsPBXY-K5hslq5FE62hvyXBES2C3aSc,201
+livekit/plugins/neuphonic/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+livekit/plugins/neuphonic/tts.py,sha256=vRFkQl9sxI4lMeEWSvyQ8YWJcxX2N7eCG7e5fzTTgbM,14240
+livekit/plugins/neuphonic/version.py,sha256=nW89L_U9N4ukT3wAO3BeTqOaa87zLUOsEFz8TkiKIP8,600
+livekit_plugins_neuphonic-1.0.0.dist-info/METADATA,sha256=dGjs8X3smzMOK8XCp-lxBLg2aHQ5jIYg3-3I3F_9880,1174
+livekit_plugins_neuphonic-1.0.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+livekit_plugins_neuphonic-1.0.0.dist-info/RECORD,,

{livekit_plugins_neuphonic-0.1.1.dist-info → livekit_plugins_neuphonic-1.0.0.dist-info}/WHEEL

@@ -1,5 +1,4 @@
 Wheel-Version: 1.0
-Generator: setuptools (76.1.0)
+Generator: hatchling 1.27.0
 Root-Is-Purelib: true
 Tag: py3-none-any
-

livekit_plugins_neuphonic-0.1.1.dist-info/RECORD

@@ -1,10 +0,0 @@
-livekit/plugins/neuphonic/__init__.py,sha256=mJnPVLsKAdUkdWuHWd16A0n2vsVBi3GjgNmB8gv9jjI,1097
-livekit/plugins/neuphonic/log.py,sha256=rAHz71IcbvPkixndXBVffPQsmWUKTLqRaYRuPIxO29w,72
-livekit/plugins/neuphonic/models.py,sha256=Svfn_sWA3Q2ZXsPBXY-K5hslq5FE62hvyXBES2C3aSc,201
-livekit/plugins/neuphonic/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-livekit/plugins/neuphonic/tts.py,sha256=VvAQ7-fja3TzfM0POyk1LyPXSZbXnyiE7_-Bsd98qEk,14837
-livekit/plugins/neuphonic/version.py,sha256=3-nEcobvIJfZdV4yNIRuYpAGQ3svREnYIv2ivxoIZcQ,600
-livekit_plugins_neuphonic-0.1.1.dist-info/METADATA,sha256=0_fdr8DXqhh5HJ47byiBfuB3Qrjz3jJo-i8URkpeTtY,1478
-livekit_plugins_neuphonic-0.1.1.dist-info/WHEEL,sha256=beeZ86-EfXScwlR_HKu4SllMC9wUEj_8Z_4FJ3egI2w,91
-livekit_plugins_neuphonic-0.1.1.dist-info/top_level.txt,sha256=OoDok3xUmXbZRvOrfvvXB-Juu4DX79dlq188E19YHoo,8
-livekit_plugins_neuphonic-0.1.1.dist-info/RECORD,,

livekit_plugins_neuphonic-0.1.1.dist-info/top_level.txt

@@ -1 +0,0 @@
-livekit