├── requirements.txt ├── .env.example ├── app ├── config.py ├── utils.py ├── handle_text.py ├── tts_handler.py └── server.py ├── Dockerfile ├── docker-compose.yml ├── .gitignore ├── README.md └── LICENSE /requirements.txt: -------------------------------------------------------------------------------- 1 | flask 2 | gevent 3 | python-dotenv 4 | edge-tts 5 | emoji -------------------------------------------------------------------------------- /.env.example: -------------------------------------------------------------------------------- 1 | API_KEY=your_api_key_here 2 | PORT=5050 3 | 4 | DEFAULT_VOICE=en-US-AvaNeural 5 | DEFAULT_RESPONSE_FORMAT=mp3 6 | DEFAULT_SPEED=1.0 7 | 8 | DEFAULT_LANGUAGE=en-US 9 | 10 | REQUIRE_API_KEY=True 11 | 12 | REMOVE_FILTER=False 13 | 14 | EXPAND_API=True 15 | 16 | DETAILED_ERROR_LOGGING=True -------------------------------------------------------------------------------- /app/config.py: -------------------------------------------------------------------------------- 1 | # config.py 2 | 3 | DEFAULT_CONFIGS = { 4 | # Server settings 5 | "PORT": 5050, 6 | "API_KEY": 'your_api_key_here', # Fallback API key 7 | 8 | # TTS settings 9 | "DEFAULT_VOICE": 'en-US-AvaNeural', 10 | "DEFAULT_RESPONSE_FORMAT": 'mp3', 11 | "DEFAULT_SPEED": 1.0, 12 | "DEFAULT_LANGUAGE": 'en-US', 13 | 14 | # Feature flags 15 | "REQUIRE_API_KEY": True, 16 | "REMOVE_FILTER": False, 17 | "EXPAND_API": True, 18 | "DETAILED_ERROR_LOGGING": True, 19 | } -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | FROM python:3.12-slim 2 | 3 | ARG INSTALL_FFMPEG=false 4 | WORKDIR /app 5 | 6 | # Install ffmpeg conditionally 7 | RUN if [ "$INSTALL_FFMPEG" = "true" ]; then \ 8 | apt-get update && apt-get install -y ffmpeg && rm -rf /var/lib/apt/lists/*; \ 9 | fi 10 | 11 | # Copy requirements and install them 12 | COPY requirements.txt /app 13 | RUN pip install -r requirements.txt 14 | 15 | # Copy the app directory 16 | COPY app/ /app 17 | 18 | # Command to run the server 19 | CMD ["python", "/app/server.py"] 20 | -------------------------------------------------------------------------------- /docker-compose.yml: -------------------------------------------------------------------------------- 1 | services: 2 | app: 3 | container_name: openai-edge-tts 4 | restart: unless-stopped 5 | build: 6 | context: . 7 | args: 8 | INSTALL_FFMPEG: ${INSTALL_FFMPEG_ARG:-false} # Controlled by env var or defaults to false 9 | ports: 10 | - '${PORT:-5050}:5050' 11 | env_file: 12 | - .env 13 | environment: # optionally define in -e argument when running docker command 14 | API_KEY: ${API_KEY:-your_api_key_here} 15 | PORT: ${PORT:-5050} 16 | DEFAULT_VOICE: ${DEFAULT_VOICE:-en-US-AvaNeural} 17 | DEFAULT_RESPONSE_FORMAT: ${DEFAULT_RESPONSE_FORMAT:-mp3} 18 | DEFAULT_SPEED: ${DEFAULT_SPEED:-1.0} 19 | DEFAULT_LANGUAGE: ${DEFAULT_LANGUAGE:-en-US} 20 | REQUIRE_API_KEY: ${REQUIRE_API_KEY:-True} 21 | REMOVE_FILTER: ${REMOVE_FILTER:-False} 22 | EXPAND_API: ${EXPAND_API:-True} 23 | DETAILED_ERROR_LOGGING: ${DETAILED_ERROR_LOGGING:-True} 24 | -------------------------------------------------------------------------------- /app/utils.py: -------------------------------------------------------------------------------- 1 | # utils.py 2 | 3 | from flask import request, jsonify 4 | from functools import wraps 5 | import os 6 | from dotenv import load_dotenv 7 | 8 | from config import DEFAULT_CONFIGS 9 | 10 | load_dotenv() 11 | 12 | def getenv_bool(name: str, default: bool = False) -> bool: 13 | # The default parameter for getenv_bool is used if the config default itself needs a fallback, 14 | # or if the call site specifically wants to override the global default. 15 | # For typical usage, the config default (passed at call site) is preferred. 16 | return os.getenv(name, str(default)).lower() in ("yes", "y", "true", "1", "t") 17 | 18 | API_KEY = os.getenv('API_KEY', DEFAULT_CONFIGS["API_KEY"]) 19 | REQUIRE_API_KEY = getenv_bool('REQUIRE_API_KEY', DEFAULT_CONFIGS["REQUIRE_API_KEY"]) 20 | DETAILED_ERROR_LOGGING = getenv_bool('DETAILED_ERROR_LOGGING', DEFAULT_CONFIGS["DETAILED_ERROR_LOGGING"]) 21 | 22 | def require_api_key(f): 23 | @wraps(f) 24 | def decorated_function(*args, **kwargs): 25 | if not REQUIRE_API_KEY: 26 | return f(*args, **kwargs) 27 | auth_header = request.headers.get('Authorization') 28 | if not auth_header or not auth_header.startswith('Bearer '): 29 | return jsonify({"error": "Missing or invalid API key"}), 401 30 | token = auth_header.split('Bearer ')[1] 31 | if token != API_KEY: 32 | return jsonify({"error": "Invalid API key"}), 401 33 | return f(*args, **kwargs) 34 | return decorated_function 35 | 36 | # Mapping of audio format to MIME type 37 | AUDIO_FORMAT_MIME_TYPES = { 38 | "mp3": "audio/mpeg", 39 | "opus": "audio/ogg", 40 | "aac": "audio/aac", 41 | "flac": "audio/flac", 42 | "wav": "audio/wav", 43 | "pcm": "audio/L16" 44 | } 45 | -------------------------------------------------------------------------------- /app/handle_text.py: -------------------------------------------------------------------------------- 1 | # handle_text.py 2 | 3 | import re 4 | import emoji 5 | 6 | def prepare_tts_input_with_context(text: str) -> str: 7 | """ 8 | Prepares text for a TTS API by cleaning Markdown and adding minimal contextual hints 9 | for certain Markdown elements like headers. Preserves paragraph separation. 10 | 11 | Args: 12 | text (str): The raw text containing Markdown or other formatting. 13 | 14 | Returns: 15 | str: Cleaned text with contextual hints suitable for TTS input. 16 | """ 17 | 18 | # Remove emojis 19 | text = emoji.replace_emoji(text, replace='') 20 | 21 | # Add context for headers 22 | def header_replacer(match): 23 | level = len(match.group(1)) # Number of '#' symbols 24 | header_text = match.group(2).strip() 25 | if level == 1: 26 | return f"Title — {header_text}\n" 27 | elif level == 2: 28 | return f"Section — {header_text}\n" 29 | else: 30 | return f"Subsection — {header_text}\n" 31 | 32 | text = re.sub(r"^(#{1,6})\s+(.*)", header_replacer, text, flags=re.MULTILINE) 33 | 34 | # Announce links (currently commented out for potential future use) 35 | # text = re.sub(r"\[([^\]]+)\]\((https?:\/\/[^\)]+)\)", r"\1 (link: \2)", text) 36 | 37 | # Remove links while keeping the link text 38 | text = re.sub(r"\[([^\]]+)\]\([^\)]+\)", r"\1", text) 39 | 40 | # Describe inline code 41 | text = re.sub(r"`([^`]+)`", r"code snippet: \1", text) 42 | 43 | # Remove bold/italic symbols but keep the content 44 | text = re.sub(r"(\*\*|__|\*|_)", '', text) 45 | 46 | # Remove code blocks (multi-line) with a description 47 | text = re.sub(r"```([\s\S]+?)```", r"(code block omitted)", text) 48 | 49 | # Remove image syntax but add alt text if available 50 | text = re.sub(r"!\[([^\]]*)\]\([^\)]+\)", r"Image: \1", text) 51 | 52 | # Remove HTML tags 53 | text = re.sub(r"]+(>|$)", '', text) 54 | 55 | # Normalize line breaks 56 | text = re.sub(r"\n{2,}", '\n\n', text) # Ensure consistent paragraph separation 57 | 58 | # Replace multiple spaces within lines 59 | text = re.sub(r" {2,}", ' ', text) 60 | 61 | # Trim leading and trailing whitespace from the whole text 62 | text = text.strip() 63 | 64 | return text 65 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | build/ 12 | develop-eggs/ 13 | dist/ 14 | downloads/ 15 | eggs/ 16 | .eggs/ 17 | lib/ 18 | lib64/ 19 | parts/ 20 | sdist/ 21 | var/ 22 | wheels/ 23 | share/python-wheels/ 24 | *.egg-info/ 25 | .installed.cfg 26 | *.egg 27 | MANIFEST 28 | 29 | # PyInstaller 30 | # Usually these files are written by a python script from a template 31 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 32 | *.manifest 33 | *.spec 34 | 35 | # Installer logs 36 | pip-log.txt 37 | pip-delete-this-directory.txt 38 | 39 | # Unit test / coverage reports 40 | htmlcov/ 41 | .tox/ 42 | .nox/ 43 | .coverage 44 | .coverage.* 45 | .cache 46 | nosetests.xml 47 | coverage.xml 48 | *.cover 49 | *.py,cover 50 | .hypothesis/ 51 | .pytest_cache/ 52 | cover/ 53 | 54 | # Translations 55 | *.mo 56 | *.pot 57 | 58 | # Django stuff: 59 | *.log 60 | local_settings.py 61 | db.sqlite3 62 | db.sqlite3-journal 63 | 64 | # Flask stuff: 65 | instance/ 66 | .webassets-cache 67 | 68 | # Scrapy stuff: 69 | .scrapy 70 | 71 | # Sphinx documentation 72 | docs/_build/ 73 | 74 | # PyBuilder 75 | .pybuilder/ 76 | target/ 77 | 78 | # Jupyter Notebook 79 | .ipynb_checkpoints 80 | 81 | # IPython 82 | profile_default/ 83 | ipython_config.py 84 | 85 | # pyenv 86 | # For a library or package, you might want to ignore these files since the code is 87 | # intended to run in multiple environments; otherwise, check them in: 88 | # .python-version 89 | 90 | # pipenv 91 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. 92 | # However, in case of collaboration, if having platform-specific dependencies or dependencies 93 | # having no cross-platform support, pipenv may install dependencies that don't work, or not 94 | # install all needed dependencies. 95 | #Pipfile.lock 96 | 97 | # poetry 98 | # Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control. 99 | # This is especially recommended for binary packages to ensure reproducibility, and is more 100 | # commonly ignored for libraries. 101 | # https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control 102 | #poetry.lock 103 | 104 | # pdm 105 | # Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control. 106 | #pdm.lock 107 | # pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it 108 | # in version control. 109 | # https://pdm.fming.dev/latest/usage/project/#working-with-version-control 110 | .pdm.toml 111 | .pdm-python 112 | .pdm-build/ 113 | 114 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm 115 | __pypackages__/ 116 | 117 | # Celery stuff 118 | celerybeat-schedule 119 | celerybeat.pid 120 | 121 | # SageMath parsed files 122 | *.sage.py 123 | 124 | # Environments 125 | .env 126 | .venv 127 | env/ 128 | venv/ 129 | ENV/ 130 | env.bak/ 131 | venv.bak/ 132 | 133 | # Spyder project settings 134 | .spyderproject 135 | .spyproject 136 | 137 | # Rope project settings 138 | .ropeproject 139 | 140 | # mkdocs documentation 141 | /site 142 | 143 | # mypy 144 | .mypy_cache/ 145 | .dmypy.json 146 | dmypy.json 147 | 148 | # Pyre type checker 149 | .pyre/ 150 | 151 | # pytype static type analyzer 152 | .pytype/ 153 | 154 | # Cython debug symbols 155 | cython_debug/ 156 | 157 | # PyCharm 158 | # JetBrains specific template is maintained in a separate JetBrains.gitignore that can 159 | # be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore 160 | # and can be added to the global gitignore or merged into this file. For a more nuclear 161 | # option (not recommended) you can uncomment the following to ignore the entire idea folder. 162 | #.idea/ 163 | 164 | .DS_Store -------------------------------------------------------------------------------- /app/tts_handler.py: -------------------------------------------------------------------------------- 1 | # tts_handler.py 2 | 3 | import edge_tts 4 | import asyncio 5 | import tempfile 6 | import subprocess 7 | import os 8 | from pathlib import Path 9 | 10 | from utils import DETAILED_ERROR_LOGGING 11 | from config import DEFAULT_CONFIGS 12 | 13 | # Language default (environment variable) 14 | DEFAULT_LANGUAGE = os.getenv('DEFAULT_LANGUAGE', DEFAULT_CONFIGS["DEFAULT_LANGUAGE"]) 15 | 16 | # OpenAI voice names mapped to edge-tts equivalents 17 | voice_mapping = { 18 | 'alloy': 'en-US-JennyNeural', 19 | 'ash': 'en-US-AndrewNeural', 20 | 'ballad': 'en-GB-ThomasNeural', 21 | 'coral': 'en-AU-NatashaNeural', 22 | 'echo': 'en-US-GuyNeural', 23 | 'fable': 'en-GB-SoniaNeural', 24 | 'nova': 'en-US-AriaNeural', 25 | 'onyx': 'en-US-EricNeural', 26 | 'sage': 'en-US-JennyNeural', 27 | 'shimmer': 'en-US-EmmaNeural', 28 | 'verse': 'en-US-BrianNeural', 29 | } 30 | 31 | model_data = [ 32 | {"id": "tts-1", "name": "Text-to-speech v1"}, 33 | {"id": "tts-1-hd", "name": "Text-to-speech v1 HD"}, 34 | {"id": "gpt-4o-mini-tts", "name": "GPT-4o mini TTS"} 35 | ] 36 | 37 | def is_ffmpeg_installed(): 38 | """Check if FFmpeg is installed and accessible.""" 39 | try: 40 | subprocess.run(['ffmpeg', '-version'], check=True, stdout=subprocess.PIPE, stderr=subprocess.PIPE) 41 | return True 42 | except (subprocess.CalledProcessError, FileNotFoundError): 43 | return False 44 | 45 | async def _generate_audio_stream(text, voice, speed): 46 | """Generate streaming TTS audio using edge-tts.""" 47 | # Determine if the voice is an OpenAI-compatible voice or a direct edge-tts voice 48 | edge_tts_voice = voice_mapping.get(voice, voice) # Use mapping if in OpenAI names, otherwise use as-is 49 | 50 | # Convert speed to SSML rate format 51 | try: 52 | speed_rate = speed_to_rate(speed) # Convert speed value to "+X%" or "-X%" 53 | except Exception as e: 54 | print(f"Error converting speed: {e}. Defaulting to +0%.") 55 | speed_rate = "+0%" 56 | 57 | # Create the communicator for streaming 58 | communicator = edge_tts.Communicate(text=text, voice=edge_tts_voice, rate=speed_rate) 59 | 60 | # Stream the audio data 61 | async for chunk in communicator.stream(): 62 | if chunk["type"] == "audio": 63 | yield chunk["data"] 64 | 65 | def generate_speech_stream(text, voice, speed=1.0): 66 | """Generate streaming speech audio (synchronous wrapper).""" 67 | return asyncio.run(_generate_audio_stream(text, voice, speed)) 68 | 69 | async def _generate_audio(text, voice, response_format, speed): 70 | """Generate TTS audio and optionally convert to a different format.""" 71 | # Determine if the voice is an OpenAI-compatible voice or a direct edge-tts voice 72 | edge_tts_voice = voice_mapping.get(voice, voice) # Use mapping if in OpenAI names, otherwise use as-is 73 | 74 | # Generate the TTS output in mp3 format first 75 | temp_mp3_file_obj = tempfile.NamedTemporaryFile(delete=False, suffix=".mp3") 76 | temp_mp3_path = temp_mp3_file_obj.name 77 | 78 | # Convert speed to SSML rate format 79 | try: 80 | speed_rate = speed_to_rate(speed) # Convert speed value to "+X%" or "-X%" 81 | except Exception as e: 82 | print(f"Error converting speed: {e}. Defaulting to +0%.") 83 | speed_rate = "+0%" 84 | 85 | # Generate the MP3 file 86 | communicator = edge_tts.Communicate(text=text, voice=edge_tts_voice, rate=speed_rate) 87 | await communicator.save(temp_mp3_path) 88 | temp_mp3_file_obj.close() # Explicitly close our file object for the initial mp3 89 | 90 | # If the requested format is mp3, return the generated file directly 91 | if response_format == "mp3": 92 | return temp_mp3_path 93 | 94 | # Check if FFmpeg is installed 95 | if not is_ffmpeg_installed(): 96 | print("FFmpeg is not available. Returning unmodified mp3 file.") 97 | return temp_mp3_path # Return the original mp3 path, it won't be cleaned by this function 98 | 99 | # Create a new temporary file for the converted output 100 | converted_file_obj = tempfile.NamedTemporaryFile(delete=False, suffix=f".{response_format}") 101 | converted_path = converted_file_obj.name 102 | converted_file_obj.close() # Close file object, ffmpeg will write to the path 103 | 104 | # Build the FFmpeg command 105 | ffmpeg_command = [ 106 | "ffmpeg", 107 | "-i", temp_mp3_path, # Input file path 108 | "-c:a", { 109 | "aac": "aac", 110 | "mp3": "libmp3lame", 111 | "wav": "pcm_s16le", 112 | "opus": "libopus", 113 | "flac": "flac" 114 | }.get(response_format, "aac"), # Default to AAC if unknown 115 | ] 116 | 117 | if response_format != "wav": 118 | ffmpeg_command.extend(["-b:a", "192k"]) 119 | 120 | ffmpeg_command.extend([ 121 | "-f", { 122 | "aac": "mp4", # AAC in MP4 container 123 | "mp3": "mp3", 124 | "wav": "wav", 125 | "opus": "ogg", 126 | "flac": "flac" 127 | }.get(response_format, response_format), # Default to matching format 128 | "-y", # Overwrite without prompt 129 | converted_path # Output file path 130 | ]) 131 | 132 | try: 133 | # Run FFmpeg command and ensure no errors occur 134 | subprocess.run(ffmpeg_command, check=True, stdout=subprocess.PIPE, stderr=subprocess.PIPE) 135 | except subprocess.CalledProcessError as e: 136 | # Clean up potentially created (but incomplete) converted file 137 | Path(converted_path).unlink(missing_ok=True) 138 | # Clean up the original mp3 file as well, since conversion failed 139 | Path(temp_mp3_path).unlink(missing_ok=True) 140 | 141 | if DETAILED_ERROR_LOGGING: 142 | error_message = f"FFmpeg error during audio conversion. Command: '{' '.join(e.cmd)}'. Stderr: {e.stderr.decode('utf-8', 'ignore')}" 143 | print(error_message) # Log for server-side diagnosis 144 | else: 145 | error_message = f"FFmpeg error during audio conversion: {e}" 146 | print(error_message) # Log a simpler message 147 | raise RuntimeError(f"FFmpeg error during audio conversion: {e}") # The raised error will still have details via e 148 | 149 | # Clean up the original temporary file (original mp3) as it's now converted 150 | Path(temp_mp3_path).unlink(missing_ok=True) 151 | 152 | return converted_path 153 | 154 | def generate_speech(text, voice, response_format, speed=1.0): 155 | return asyncio.run(_generate_audio(text, voice, response_format, speed)) 156 | 157 | def get_models(): 158 | return model_data 159 | 160 | def get_models_formatted(): 161 | return [{ "id": x["id"] } for x in model_data] 162 | 163 | def get_voices_formatted(): 164 | return [{ "id": k, "name": v } for k, v in voice_mapping.items()] 165 | 166 | async def _get_voices(language=None): 167 | # List all voices, filter by language if specified 168 | all_voices = await edge_tts.list_voices() 169 | language = language or DEFAULT_LANGUAGE # Use default if no language specified 170 | filtered_voices = [ 171 | {"name": v['ShortName'], "gender": v['Gender'], "language": v['Locale']} 172 | for v in all_voices if language == 'all' or language is None or v['Locale'] == language 173 | ] 174 | return filtered_voices 175 | 176 | def get_voices(language=None): 177 | return asyncio.run(_get_voices(language)) 178 | 179 | def speed_to_rate(speed: float) -> str: 180 | """ 181 | Converts a multiplicative speed value to the edge-tts "rate" format. 182 | 183 | Args: 184 | speed (float): The multiplicative speed value (e.g., 1.5 for +50%, 0.5 for -50%). 185 | 186 | Returns: 187 | str: The formatted "rate" string (e.g., "+50%" or "-50%"). 188 | """ 189 | if speed < 0 or speed > 2: 190 | raise ValueError("Speed must be between 0 and 2 (inclusive).") 191 | 192 | # Convert speed to percentage change 193 | percentage_change = (speed - 1) * 100 194 | 195 | # Format with a leading "+" or "-" as required 196 | return f"{percentage_change:+.0f}%" 197 | -------------------------------------------------------------------------------- /app/server.py: -------------------------------------------------------------------------------- 1 | # server.py 2 | 3 | from flask import Flask, request, send_file, jsonify, Response 4 | from gevent.pywsgi import WSGIServer 5 | from dotenv import load_dotenv 6 | import os 7 | import traceback 8 | import json 9 | import base64 10 | 11 | from config import DEFAULT_CONFIGS 12 | from handle_text import prepare_tts_input_with_context 13 | from tts_handler import generate_speech, generate_speech_stream, get_models_formatted, get_voices, get_voices_formatted 14 | from utils import getenv_bool, require_api_key, AUDIO_FORMAT_MIME_TYPES, DETAILED_ERROR_LOGGING 15 | 16 | app = Flask(__name__) 17 | load_dotenv() 18 | 19 | API_KEY = os.getenv('API_KEY', DEFAULT_CONFIGS["API_KEY"]) 20 | PORT = int(os.getenv('PORT', str(DEFAULT_CONFIGS["PORT"]))) 21 | 22 | DEFAULT_VOICE = os.getenv('DEFAULT_VOICE', DEFAULT_CONFIGS["DEFAULT_VOICE"]) 23 | DEFAULT_RESPONSE_FORMAT = os.getenv('DEFAULT_RESPONSE_FORMAT', DEFAULT_CONFIGS["DEFAULT_RESPONSE_FORMAT"]) 24 | DEFAULT_SPEED = float(os.getenv('DEFAULT_SPEED', str(DEFAULT_CONFIGS["DEFAULT_SPEED"]))) 25 | 26 | REMOVE_FILTER = getenv_bool('REMOVE_FILTER', DEFAULT_CONFIGS["REMOVE_FILTER"]) 27 | EXPAND_API = getenv_bool('EXPAND_API', DEFAULT_CONFIGS["EXPAND_API"]) 28 | 29 | # DEFAULT_MODEL = os.getenv('DEFAULT_MODEL', 'tts-1') 30 | 31 | # Currently in "beta" — needs more extensive testing where drop-in replacement warranted 32 | def generate_sse_audio_stream(text, voice, speed): 33 | """Generator function for SSE streaming with JSON events.""" 34 | try: 35 | # Generate streaming audio chunks and convert to SSE format 36 | for chunk in generate_speech_stream(text, voice, speed): 37 | # Base64 encode the audio chunk 38 | encoded_audio = base64.b64encode(chunk).decode('utf-8') 39 | 40 | # Create SSE event for audio delta 41 | event_data = { 42 | "type": "speech.audio.delta", 43 | "audio": encoded_audio 44 | } 45 | 46 | # Format as SSE event 47 | yield f"data: {json.dumps(event_data)}\n\n" 48 | 49 | # Send completion event 50 | completion_event = { 51 | "type": "speech.audio.done", 52 | "usage": { 53 | "input_tokens": len(text.split()), # Rough estimate 54 | "output_tokens": 0, # Edge TTS doesn't provide this 55 | "total_tokens": len(text.split()) 56 | } 57 | } 58 | yield f"data: {json.dumps(completion_event)}\n\n" 59 | 60 | except Exception as e: 61 | print(f"Error during SSE streaming: {e}") 62 | # Send error event 63 | error_event = { 64 | "type": "error", 65 | "error": str(e) 66 | } 67 | yield f"data: {json.dumps(error_event)}\n\n" 68 | 69 | # OpenAI endpoint format 70 | @app.route('/v1/audio/speech', methods=['POST']) 71 | @app.route('/audio/speech', methods=['POST']) # Add this line for the alias 72 | @require_api_key 73 | def text_to_speech(): 74 | try: 75 | data = request.json 76 | if not data or 'input' not in data: 77 | return jsonify({"error": "Missing 'input' in request body"}), 400 78 | 79 | text = data.get('input') 80 | 81 | if not REMOVE_FILTER: 82 | text = prepare_tts_input_with_context(text) 83 | 84 | # model = data.get('model', DEFAULT_MODEL) 85 | voice = data.get('voice', DEFAULT_VOICE) 86 | response_format = data.get('response_format', DEFAULT_RESPONSE_FORMAT) 87 | speed = float(data.get('speed', DEFAULT_SPEED)) 88 | 89 | # Check stream format - only "sse" triggers streaming 90 | stream_format = data.get('stream_format', 'audio') # 'audio' (default) or 'sse' 91 | 92 | mime_type = AUDIO_FORMAT_MIME_TYPES.get(response_format, "audio/mpeg") 93 | 94 | if stream_format == 'sse': 95 | # Return SSE streaming response with JSON events 96 | def generate_sse(): 97 | for event in generate_sse_audio_stream(text, voice, speed): 98 | yield event 99 | 100 | return Response( 101 | generate_sse(), 102 | mimetype='text/event-stream', 103 | headers={ 104 | 'Content-Type': 'text/event-stream', 105 | 'Cache-Control': 'no-cache', 106 | 'Connection': 'keep-alive', 107 | 'X-Accel-Buffering': 'no' # Disable nginx buffering 108 | } 109 | ) 110 | else: 111 | # Return raw audio data (like OpenAI) - can be piped to ffplay 112 | output_file_path = generate_speech(text, voice, response_format, speed) 113 | 114 | # Read the file and return raw audio data 115 | with open(output_file_path, 'rb') as audio_file: 116 | audio_data = audio_file.read() 117 | 118 | # Clean up the temporary file 119 | try: 120 | os.unlink(output_file_path) 121 | except OSError: 122 | pass # File might already be cleaned up 123 | 124 | return Response( 125 | audio_data, 126 | mimetype=mime_type, 127 | headers={ 128 | 'Content-Type': mime_type, 129 | 'Content-Length': str(len(audio_data)) 130 | } 131 | ) 132 | 133 | except Exception as e: 134 | if DETAILED_ERROR_LOGGING: 135 | app.logger.error(f"Error in text_to_speech: {str(e)}\n{traceback.format_exc()}") 136 | else: 137 | app.logger.error(f"Error in text_to_speech: {str(e)}") 138 | # Return a 500 error for unhandled exceptions, which is more standard than 400 139 | return jsonify({"error": "An internal server error occurred", "details": str(e)}), 500 140 | 141 | # OpenAI endpoint format 142 | @app.route('/v1/models', methods=['GET', 'POST']) 143 | @app.route('/models', methods=['GET', 'POST']) 144 | @app.route('/v1/audio/models', methods=['GET', 'POST']) 145 | @app.route('/audio/models', methods=['GET', 'POST']) 146 | def list_models(): 147 | return jsonify({"models": get_models_formatted()}) 148 | 149 | # OpenAI endpoint format 150 | @app.route('/v1/audio/voices', methods=['GET', 'POST']) 151 | @app.route('/audio/voices', methods=['GET', 'POST']) 152 | def list_voices_formatted(): 153 | return jsonify({"voices": get_voices_formatted()}) 154 | 155 | @app.route('/v1/voices', methods=['GET', 'POST']) 156 | @app.route('/voices', methods=['GET', 'POST']) 157 | @require_api_key 158 | def list_voices(): 159 | specific_language = None 160 | 161 | data = request.args if request.method == 'GET' else request.json 162 | if data and ('language' in data or 'locale' in data): 163 | specific_language = data.get('language') if 'language' in data else data.get('locale') 164 | 165 | return jsonify({"voices": get_voices(specific_language)}) 166 | 167 | @app.route('/v1/voices/all', methods=['GET', 'POST']) 168 | @app.route('/voices/all', methods=['GET', 'POST']) 169 | @require_api_key 170 | def list_all_voices(): 171 | return jsonify({"voices": get_voices('all')}) 172 | 173 | """ 174 | Support for ElevenLabs and Azure AI Speech 175 | (currently in beta) 176 | """ 177 | 178 | # http://localhost:5050/elevenlabs/v1/text-to-speech 179 | # http://localhost:5050/elevenlabs/v1/text-to-speech/en-US-AndrewNeural 180 | @app.route('/elevenlabs/v1/text-to-speech/', methods=['POST']) 181 | @require_api_key 182 | def elevenlabs_tts(voice_id): 183 | if not EXPAND_API: 184 | return jsonify({"error": f"Endpoint not allowed"}), 500 185 | 186 | # Parse the incoming JSON payload 187 | try: 188 | payload = request.json 189 | if not payload or 'text' not in payload: 190 | return jsonify({"error": "Missing 'text' in request body"}), 400 191 | except Exception as e: 192 | return jsonify({"error": f"Invalid JSON payload: {str(e)}"}), 400 193 | 194 | text = payload['text'] 195 | 196 | if not REMOVE_FILTER: 197 | text = prepare_tts_input_with_context(text) 198 | 199 | voice = voice_id # ElevenLabs uses the voice_id in the URL 200 | 201 | # Use default settings for edge-tts 202 | response_format = 'mp3' 203 | speed = DEFAULT_SPEED # Optional customization via payload.get('speed', DEFAULT_SPEED) 204 | 205 | # Generate speech using edge-tts 206 | try: 207 | output_file_path = generate_speech(text, voice, response_format, speed) 208 | except Exception as e: 209 | return jsonify({"error": f"TTS generation failed: {str(e)}"}), 500 210 | 211 | # Return the generated audio file 212 | return send_file(output_file_path, mimetype="audio/mpeg", as_attachment=True, download_name="speech.mp3") 213 | 214 | # tts.speech.microsoft.com/cognitiveservices/v1 215 | # https://{region}.tts.speech.microsoft.com/cognitiveservices/v1 216 | # http://localhost:5050/azure/cognitiveservices/v1 217 | @app.route('/azure/cognitiveservices/v1', methods=['POST']) 218 | @require_api_key 219 | def azure_tts(): 220 | if not EXPAND_API: 221 | return jsonify({"error": f"Endpoint not allowed"}), 500 222 | 223 | # Parse the SSML payload 224 | try: 225 | ssml_data = request.data.decode('utf-8') 226 | if not ssml_data: 227 | return jsonify({"error": "Missing SSML payload"}), 400 228 | 229 | # Extract the text and voice from SSML 230 | from xml.etree import ElementTree as ET 231 | root = ET.fromstring(ssml_data) 232 | text = root.find('.//{http://www.w3.org/2001/10/synthesis}voice').text 233 | voice = root.find('.//{http://www.w3.org/2001/10/synthesis}voice').get('name') 234 | except Exception as e: 235 | return jsonify({"error": f"Invalid SSML payload: {str(e)}"}), 400 236 | 237 | # Use default settings for edge-tts 238 | response_format = 'mp3' 239 | speed = DEFAULT_SPEED 240 | 241 | if not REMOVE_FILTER: 242 | text = prepare_tts_input_with_context(text) 243 | 244 | # Generate speech using edge-tts 245 | try: 246 | output_file_path = generate_speech(text, voice, response_format, speed) 247 | except Exception as e: 248 | return jsonify({"error": f"TTS generation failed: {str(e)}"}), 500 249 | 250 | # Return the generated audio file 251 | return send_file(output_file_path, mimetype="audio/mpeg", as_attachment=True, download_name="speech.mp3") 252 | 253 | print(f" Edge TTS (Free Azure TTS) Replacement for OpenAI's TTS API") 254 | print(f" ") 255 | print(f" * Serving OpenAI Edge TTS") 256 | print(f" * Server running on http://localhost:{PORT}") 257 | print(f" * TTS Endpoint: http://localhost:{PORT}/v1/audio/speech") 258 | print(f" ") 259 | 260 | if __name__ == '__main__': 261 | http_server = WSGIServer(('0.0.0.0', PORT), app) 262 | http_server.serve_forever() 263 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # OpenAI-Compatible Edge-TTS API 🗣️ 2 | 3 | ![GitHub stars](https://img.shields.io/github/stars/travisvn/openai-edge-tts?style=social) 4 | ![GitHub forks](https://img.shields.io/github/forks/travisvn/openai-edge-tts?style=social) 5 | ![GitHub repo size](https://img.shields.io/github/repo-size/travisvn/openai-edge-tts) 6 | ![GitHub top language](https://img.shields.io/github/languages/top/travisvn/openai-edge-tts) 7 | ![GitHub last commit](https://img.shields.io/github/last-commit/travisvn/openai-edge-tts?color=red) 8 | [![Discord](https://img.shields.io/badge/Discord-Voice_AI_%26_TTS_Tools-blue?logo=discord&logoColor=white)](https://discord.gg/GkFbBCBqJ6) 9 | [![LinkedIn](https://img.shields.io/badge/Connect_on_LinkedIn-%230077B5.svg?logo=linkedin&logoColor=white)](https://linkedin.com/in/travisvannimwegen) 10 | 11 | This project provides a local, OpenAI-compatible text-to-speech (TTS) API using `edge-tts`. It emulates the OpenAI TTS endpoint (`/v1/audio/speech`), enabling users to generate speech from text with various voice options and playback speeds, just like the OpenAI API. 12 | 13 | `edge-tts` uses Microsoft Edge's online text-to-speech service, so it is completely free. 14 | 15 | [View this project on Docker Hub](https://hub.docker.com/r/travisvn/openai-edge-tts) 16 | 17 | # Please ⭐️ star this repo if you find it helpful 18 | 19 | ## Features 20 | 21 | - **OpenAI-Compatible Endpoint**: `/v1/audio/speech` with similar request structure and behavior. 22 | - **SSE Streaming Support**: Real-time audio streaming via Server-Sent Events when `stream_format: "sse"` is specified. 23 | - **Supported Voices**: Maps OpenAI voices (alloy, echo, fable, onyx, nova, shimmer) to `edge-tts` equivalents. 24 | - **Flexible Formats**: Supports multiple audio formats (mp3, opus, aac, flac, wav, pcm). 25 | - **Adjustable Speed**: Option to modify playback speed (0.25x to 4.0x). 26 | - **Optional Direct Edge-TTS Voice Selection**: Use either OpenAI voice mappings or specify [any edge-tts voice](https://tts.travisvn.com) directly. 27 | 28 | ## ⚡️ Quick start 29 | 30 | The simplest way to get started without having to configure anything is to run the command below 31 | 32 | ```bash 33 | docker run -d -p 5050:5050 travisvn/openai-edge-tts:latest 34 | ``` 35 | 36 | This will run the service at port 5050 with all the default configs 37 | 38 | _(Docker required, obviously)_ 39 | 40 | ## Setup 41 | 42 | ### Prerequisites 43 | 44 | - **Docker** (recommended): Docker and Docker Compose for containerized setup. 45 | - **Python** (optional): For local development, install dependencies in `requirements.txt`. 46 | - **ffmpeg** (optional): Required for audio format conversion. Optional if sticking to mp3. 47 | 48 | ### Installation 49 | 50 | 1. **Clone the Repository**: 51 | 52 | ```bash 53 | git clone https://github.com/travisvn/openai-edge-tts.git 54 | cd openai-edge-tts 55 | ``` 56 | 57 | 2. **Environment Variables**: Create a `.env` file in the root directory with the following variables: 58 | 59 | ``` 60 | API_KEY=your_api_key_here 61 | PORT=5050 62 | 63 | DEFAULT_VOICE=en-US-AvaNeural 64 | DEFAULT_RESPONSE_FORMAT=mp3 65 | DEFAULT_SPEED=1.0 66 | 67 | DEFAULT_LANGUAGE=en-US 68 | 69 | REQUIRE_API_KEY=True 70 | REMOVE_FILTER=False 71 | EXPAND_API=True 72 | DETAILED_ERROR_LOGGING=True 73 | ``` 74 | 75 | Or, copy the default `.env.example` with the following: 76 | 77 | ```bash 78 | cp .env.example .env 79 | ``` 80 | 81 | 3. **Run with Docker Compose** (recommended): 82 | 83 | ```bash 84 | docker compose up --build 85 | ``` 86 | 87 | Run with `-d` to run docker compose in "detached mode", meaning it will run in the background and free up your terminal. 88 | 89 | ```bash 90 | docker compose up -d 91 | ``` 92 | 93 |
94 | 95 | 96 | #### Building Locally with FFmpeg using Docker Compose 97 | 98 | 99 | 100 | By default, `docker compose up --build` creates a minimal image _without_ `ffmpeg`. If you're building locally (after cloning this repository) and need `ffmpeg` for audio format conversions (beyond MP3), you can include it in the build. 101 | 102 | This is controlled by the `INSTALL_FFMPEG_ARG` build argument. Set this environment variable to `true` in one of these ways: 103 | 104 | 1. **Prefixing the command:** 105 | ```bash 106 | INSTALL_FFMPEG_ARG=true docker compose up --build 107 | ``` 108 | 2. **Adding to your `.env` file:** 109 | Add this line to the `.env` file in the project root: 110 | ```env 111 | INSTALL_FFMPEG_ARG=true 112 | ``` 113 | Then, run `docker compose up --build`. 114 | 3. **Exporting in your shell environment:** 115 | Add `export INSTALL_FFMPEG_ARG=true` to your shell configuration (e.g., `~/.zshrc`, `~/.bashrc`) and reload your shell. Then `docker compose up --build` will use it. 116 | 117 | This is for local builds. For pre-built Docker Hub images, add the `latest-ffmpeg` tag to the version 118 | 119 | ```bash 120 | docker run -d -p 5050:5050 -e API_KEY=your_api_key_here -e PORT=5050 travisvn/openai-edge-tts:latest-ffmpeg 121 | ``` 122 | 123 | --- 124 | 125 |
126 | 127 | Alternatively, **run directly with Docker**: 128 | 129 | ```bash 130 | docker build -t openai-edge-tts . 131 | docker run -p 5050:5050 --env-file .env openai-edge-tts 132 | ``` 133 | 134 | To run the container in the background, add `-d` after the `docker run` command: 135 | 136 | ```bash 137 | docker run -d -p 5050:5050 --env-file .env openai-edge-tts 138 | ``` 139 | 140 | 4. **Access the API**: Your server will be accessible at `http://localhost:5050`. 141 | 142 |
143 | 144 | 145 | ## Running with Python 146 | 147 | 148 | 149 | If you prefer to run this project directly with Python, follow these steps to set up a virtual environment, install dependencies, and start the server. 150 | 151 | ### 1. Clone the Repository 152 | 153 | ```bash 154 | git clone https://github.com/travisvn/openai-edge-tts.git 155 | cd openai-edge-tts 156 | ``` 157 | 158 | ### 2. Set Up a Virtual Environment 159 | 160 | Create and activate a virtual environment to isolate dependencies: 161 | 162 | ```bash 163 | # For macOS/Linux 164 | python3 -m venv venv 165 | source venv/bin/activate 166 | 167 | # For Windows 168 | python -m venv venv 169 | venv\Scripts\activate 170 | ``` 171 | 172 | ### 3. Install Dependencies 173 | 174 | Use `pip` to install the required packages listed in `requirements.txt`: 175 | 176 | ```bash 177 | pip install -r requirements.txt 178 | ``` 179 | 180 | ### 4. Configure Environment Variables 181 | 182 | Create a `.env` file in the root directory and set the following variables: 183 | 184 | ```plaintext 185 | API_KEY=your_api_key_here 186 | PORT=5050 187 | 188 | DEFAULT_VOICE=en-US-AvaNeural 189 | DEFAULT_RESPONSE_FORMAT=mp3 190 | DEFAULT_SPEED=1.0 191 | 192 | DEFAULT_LANGUAGE=en-US 193 | 194 | REQUIRE_API_KEY=True 195 | REMOVE_FILTER=False 196 | EXPAND_API=True 197 | DETAILED_ERROR_LOGGING=True 198 | ``` 199 | 200 | ### 5. Run the Server 201 | 202 | Once configured, start the server with: 203 | 204 | ```bash 205 | python app/server.py 206 | ``` 207 | 208 | The server will start running at `http://localhost:5050`. 209 | 210 | ### 6. Test the API 211 | 212 | You can now interact with the API at `http://localhost:5050/v1/audio/speech` and other available endpoints. See the [Usage](#usage) section for request examples. 213 | 214 |
215 | 216 |
217 | 218 | 219 | ## Usage 220 | 221 | 222 | 223 | #### Endpoint: `/v1/audio/speech` 224 | 225 | Generates audio from the input text. Available parameters: 226 | 227 | **Required Parameter:** 228 | 229 | - **input** (string): The text to be converted to audio (up to 4096 characters). 230 | 231 | **Optional Parameters:** 232 | 233 | - **model** (string): Set to "tts-1" or "tts-1-hd" (default: `"tts-1"`). 234 | - **voice** (string): One of the OpenAI-compatible voices (alloy, echo, fable, onyx, nova, shimmer) or any valid `edge-tts` voice (default: `"en-US-AvaNeural"`). 235 | - **response_format** (string): Audio format. Options: `mp3`, `opus`, `aac`, `flac`, `wav`, `pcm` (default: `mp3`). 236 | - **speed** (number): Playback speed (0.25 to 4.0). Default is `1.0`. 237 | - **stream_format** (string): Response format. Options: `"audio"` (raw audio data, default) or `"sse"` (Server-Sent Events streaming with JSON events). 238 | 239 | **Note:** The API is fully compatible with OpenAI's TTS API specification. The `instructions` parameter (for fine-tuning voice characteristics) is not currently supported, but all other parameters work identically to OpenAI's implementation. 240 | 241 | #### Standard Audio Generation 242 | 243 | Example request with `curl` and saving the output to an mp3 file: 244 | 245 | ```bash 246 | curl -X POST http://localhost:5050/v1/audio/speech \ 247 | -H "Content-Type: application/json" \ 248 | -H "Authorization: Bearer your_api_key_here" \ 249 | -d '{ 250 | "input": "Hello, I am your AI assistant! Just let me know how I can help bring your ideas to life.", 251 | "voice": "echo", 252 | "response_format": "mp3", 253 | "speed": 1.1 254 | }' \ 255 | --output speech.mp3 256 | ``` 257 | 258 | #### Direct Audio Playback (like OpenAI) 259 | 260 | You can pipe the audio directly to `ffplay` for immediate playback, just like OpenAI's API: 261 | 262 | ```bash 263 | curl -X POST http://localhost:5050/v1/audio/speech \ 264 | -H "Authorization: Bearer your_api_key_here" \ 265 | -H "Content-Type: application/json" \ 266 | -d '{ 267 | "model": "tts-1", 268 | "input": "Today is a wonderful day to build something people love!", 269 | "voice": "alloy", 270 | "response_format": "mp3" 271 | }' | ffplay -i - 272 | ``` 273 | 274 | Or for immediate playback without saving to file: 275 | 276 | ```bash 277 | curl -X POST http://localhost:5050/v1/audio/speech \ 278 | -H "Authorization: Bearer your_api_key_here" \ 279 | -H "Content-Type: application/json" \ 280 | -d '{ 281 | "input": "This will play immediately without saving to disk!", 282 | "voice": "shimmer" 283 | }' | ffplay -autoexit -nodisp -i - 284 | ``` 285 | 286 | Or, to be in line with the OpenAI API endpoint parameters: 287 | 288 | ```bash 289 | curl -X POST http://localhost:5050/v1/audio/speech \ 290 | -H "Content-Type: application/json" \ 291 | -H "Authorization: Bearer your_api_key_here" \ 292 | -d '{ 293 | "model": "tts-1", 294 | "input": "Hello, I am your AI assistant! Just let me know how I can help bring your ideas to life.", 295 | "voice": "alloy" 296 | }' \ 297 | --output speech.mp3 298 | ``` 299 | 300 | #### Server-Sent Events (SSE) Streaming 301 | 302 | For applications that need structured streaming events (like web applications), use SSE format: 303 | 304 | ```bash 305 | curl -X POST http://localhost:5050/v1/audio/speech \ 306 | -H "Content-Type: application/json" \ 307 | -H "Authorization: Bearer your_api_key_here" \ 308 | -d '{ 309 | "model": "tts-1", 310 | "input": "This will stream as Server-Sent Events with JSON data containing base64-encoded audio chunks.", 311 | "voice": "alloy", 312 | "stream_format": "sse" 313 | }' 314 | ``` 315 | 316 | **SSE Response Format:** 317 | 318 | ``` 319 | data: {"type": "speech.audio.delta", "audio": "base64-encoded-audio-chunk"} 320 | 321 | data: {"type": "speech.audio.delta", "audio": "base64-encoded-audio-chunk"} 322 | 323 | data: {"type": "speech.audio.done", "usage": {"input_tokens": 12, "output_tokens": 0, "total_tokens": 12}} 324 | ``` 325 | 326 | #### JavaScript/Web Usage 327 | 328 | Example using fetch API for SSE streaming: 329 | 330 | ```javascript 331 | async function streamTTSWithSSE(text) { 332 | const response = await fetch('http://localhost:5050/v1/audio/speech', { 333 | method: 'POST', 334 | headers: { 335 | 'Content-Type': 'application/json', 336 | Authorization: 'Bearer your_api_key_here', 337 | }, 338 | body: JSON.stringify({ 339 | input: text, 340 | voice: 'alloy', 341 | stream_format: 'sse', 342 | }), 343 | }); 344 | 345 | const reader = response.body.getReader(); 346 | const decoder = new TextDecoder(); 347 | const audioChunks = []; 348 | 349 | while (true) { 350 | const { done, value } = await reader.read(); 351 | if (done) break; 352 | 353 | const chunk = decoder.decode(value); 354 | const lines = chunk.split('\n'); 355 | 356 | for (const line of lines) { 357 | if (line.startsWith('data: ')) { 358 | const data = JSON.parse(line.slice(6)); 359 | 360 | if (data.type === 'speech.audio.delta') { 361 | // Decode base64 audio chunk 362 | const audioData = atob(data.audio); 363 | const audioArray = new Uint8Array(audioData.length); 364 | for (let i = 0; i < audioData.length; i++) { 365 | audioArray[i] = audioData.charCodeAt(i); 366 | } 367 | audioChunks.push(audioArray); 368 | } else if (data.type === 'speech.audio.done') { 369 | console.log('Speech synthesis complete:', data.usage); 370 | 371 | // Combine all chunks and play 372 | const totalLength = audioChunks.reduce( 373 | (sum, chunk) => sum + chunk.length, 374 | 0 375 | ); 376 | const combinedArray = new Uint8Array(totalLength); 377 | let offset = 0; 378 | for (const chunk of audioChunks) { 379 | combinedArray.set(chunk, offset); 380 | offset += chunk.length; 381 | } 382 | 383 | const audioBlob = new Blob([combinedArray], { type: 'audio/mpeg' }); 384 | const audioUrl = URL.createObjectURL(audioBlob); 385 | const audio = new Audio(audioUrl); 386 | audio.play(); 387 | return; 388 | } 389 | } 390 | } 391 | } 392 | } 393 | 394 | // Usage 395 | streamTTSWithSSE('Hello from SSE streaming!'); 396 | ``` 397 | 398 | #### International Language Example 399 | 400 | And an example of a language other than English: 401 | 402 | ```bash 403 | curl -X POST http://localhost:5050/v1/audio/speech \ 404 | -H "Content-Type: application/json" \ 405 | -H "Authorization: Bearer your_api_key_here" \ 406 | -d '{ 407 | "model": "tts-1", 408 | "input": "じゃあ、行く。電車の時間、調べておくよ。", 409 | "voice": "ja-JP-KeitaNeural" 410 | }' \ 411 | --output speech.mp3 412 | ``` 413 | 414 | #### JavaScript/Web Usage 415 | 416 | Example using fetch API for SSE streaming: 417 | 418 | ```javascript 419 | async function streamTTSWithSSE(text) { 420 | const response = await fetch('http://localhost:5050/v1/audio/speech', { 421 | method: 'POST', 422 | headers: { 423 | 'Content-Type': 'application/json', 424 | Authorization: 'Bearer your_api_key_here', 425 | }, 426 | body: JSON.stringify({ 427 | input: text, 428 | voice: 'alloy', 429 | stream_format: 'sse', 430 | }), 431 | }); 432 | 433 | const reader = response.body.getReader(); 434 | const decoder = new TextDecoder(); 435 | const audioChunks = []; 436 | 437 | while (true) { 438 | const { done, value } = await reader.read(); 439 | if (done) break; 440 | 441 | const chunk = decoder.decode(value); 442 | const lines = chunk.split('\n'); 443 | 444 | for (const line of lines) { 445 | if (line.startsWith('data: ')) { 446 | const data = JSON.parse(line.slice(6)); 447 | 448 | if (data.type === 'speech.audio.delta') { 449 | // Decode base64 audio chunk 450 | const audioData = atob(data.audio); 451 | const audioArray = new Uint8Array(audioData.length); 452 | for (let i = 0; i < audioData.length; i++) { 453 | audioArray[i] = audioData.charCodeAt(i); 454 | } 455 | audioChunks.push(audioArray); 456 | } else if (data.type === 'speech.audio.done') { 457 | console.log('Speech synthesis complete:', data.usage); 458 | 459 | // Combine all chunks and play 460 | const totalLength = audioChunks.reduce( 461 | (sum, chunk) => sum + chunk.length, 462 | 0 463 | ); 464 | const combinedArray = new Uint8Array(totalLength); 465 | let offset = 0; 466 | for (const chunk of audioChunks) { 467 | combinedArray.set(chunk, offset); 468 | offset += chunk.length; 469 | } 470 | 471 | const audioBlob = new Blob([combinedArray], { type: 'audio/mpeg' }); 472 | const audioUrl = URL.createObjectURL(audioBlob); 473 | const audio = new Audio(audioUrl); 474 | audio.play(); 475 | return; 476 | } 477 | } 478 | } 479 | } 480 | } 481 | 482 | // Usage 483 | streamTTSWithSSE('Hello from SSE streaming!'); 484 | ``` 485 | 486 | #### Additional Endpoints 487 | 488 | - **POST/GET /v1/models**: Lists available TTS models. 489 | - **POST/GET /v1/voices**: Lists `edge-tts` voices for a given language / locale. 490 | - **POST/GET /v1/voices/all**: Lists all `edge-tts` voices, with language support information. 491 | 492 |
493 | 494 | ### Contributing 495 | 496 | Contributions are welcome! Please fork the repository and create a pull request for any improvements. 497 | 498 | ### License 499 | 500 | This project is licensed under GNU General Public License v3.0 (GPL-3.0), and the acceptable use-case is intended to be personal use. For enterprise or non-personal use of `openai-edge-tts`, contact me at tts@travisvn.com 501 | 502 | --- 503 | 504 | ## Example Use Case 505 | 506 | > [!TIP] 507 | > Swap `localhost` to your local IP (ex. `192.168.0.1`) if you have issues 508 | > 509 | > _It may be the case that, when accessing this endpoint on a different server / computer or when the call is made from another source (like Open WebUI), you need to change the URL from `localhost` to your local IP (something like `192.168.0.1` or similar)_ 510 | 511 | # Open WebUI 512 | 513 | Open up the Admin Panel and go to Settings -> Audio 514 | 515 | Below, you can see a screenshot of the correct configuration for using this project to substitute the OpenAI endpoint 516 | 517 | ![Screenshot of Open WebUI Admin Settings for Audio adding the correct endpoints for this project](https://utfs.io/f/MMMHiQ1TQaBo9GgL4WcUbjSRlqi86sV3TXh47KYBJCkdQ20M) 518 | 519 | If you're running both Open WebUI and this project in Docker, the API endpoint URL is probably `http://host.docker.internal:5050/v1` 520 | 521 | > [!NOTE] 522 | > View the official docs for [Open WebUI integration with OpenAI Edge TTS](https://docs.openwebui.com/tutorials/text-to-speech/openai-edge-tts-integration) 523 | 524 | # AnythingLLM 525 | 526 | In version 1.6.8, AnythingLLM added support for "generic OpenAI TTS providers" — meaning we can use this project as the TTS provider in AnythingLLM 527 | 528 | Open up settings and go to Voice & Speech (Under AI Providers) 529 | 530 | Below, you can see a screenshot of the correct configuration for using this project to substitute the OpenAI endpoint 531 | 532 | ![Screenshot of AnythingLLM settings for Voice adding the correct endpoints for this project](https://utfs.io/f/MMMHiQ1TQaBoGx6WUTRDJUWPLqoMsXiNkajAdVOwgcxH6uv7) 533 | 534 | --- 535 | 536 | ## Quick Info 537 | 538 | - `your_api_key_here` never needs to be replaced — No "real" API key is required. Use whichever string you'd like. 539 | - The quickest way to get this up and running is to install docker and run the command below: 540 | 541 | ```bash 542 | docker run -d -p 5050:5050 -e API_KEY=your_api_key_here -e PORT=5050 travisvn/openai-edge-tts:latest 543 | ``` 544 | 545 | --- 546 | 547 | # Voice Samples 🎙️ 548 | 549 | [Play voice samples and see all available Edge TTS voices](https://tts.travisvn.com/) 550 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------