├── .gitignore ├── assets └── waiting.mp3 ├── requirements.txt ├── src ├── vad │ ├── __pycache__ │ │ └── listener.cpython-310.pyc │ ├── listener.py │ ├── base.py │ ├── webrtcvad.py │ └── silerovad.py ├── tts │ ├── groqPlayai.py │ └── base.py ├── stt │ ├── groqWhisper.py │ └── base.py ├── main.py ├── gen │ ├── groq.py │ ├── openai.py │ └── base.py ├── conversation.py └── player.py ├── README.md └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | .venv/ 2 | .env 3 | __pycache__/ -------------------------------------------------------------------------------- /assets/waiting.mp3: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/KernelOverseer/caLLMe/HEAD/assets/waiting.mp3 -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | pyaudio 2 | webrtcvad 3 | torch 4 | numpy 5 | groq 6 | simpleaudio 7 | pydub -------------------------------------------------------------------------------- /src/vad/__pycache__/listener.cpython-310.pyc: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/KernelOverseer/caLLMe/HEAD/src/vad/__pycache__/listener.cpython-310.pyc -------------------------------------------------------------------------------- /src/tts/groqPlayai.py: -------------------------------------------------------------------------------- 1 | from tts.base import TTS 2 | from groq import Groq 3 | import os 4 | 5 | class GroqPlayai(TTS): 6 | def __init__(self, model="playai-tts", voice="Quinn-PlayAI", api_key=os.getenv("GROQ_API_KEY")): 7 | self.client = Groq(api_key=api_key) 8 | self.model = model 9 | self.voice = voice 10 | 11 | async def generate_speech(self, text: str) -> bytes: 12 | try: 13 | response = self.client.audio.speech.create( 14 | model=self.model, 15 | voice=self.voice, 16 | input=text, 17 | response_format="wav") 18 | 19 | return response.read() 20 | except Exception as e: 21 | print(f"Error generating speech: {e}") 22 | return None 23 | 24 | def close(self): 25 | pass -------------------------------------------------------------------------------- /src/stt/groqWhisper.py: -------------------------------------------------------------------------------- 1 | import io 2 | from groq import Groq 3 | import os 4 | from stt.base import STT 5 | 6 | class GroqWhisper(STT): 7 | def __init__(self, model="whisper-large-v3-turbo", api_key=os.getenv("GROQ_API_KEY"), language="en"): 8 | self.groq = Groq(api_key=api_key) 9 | self.model = model 10 | self.language = language 11 | 12 | async def transcribe(self, audio: bytes) -> str: 13 | # Convert bytes to file-like object 14 | audio_file = io.BytesIO(audio) 15 | audio_file.name = "audio.wav" # Give it a name for the API 16 | 17 | response = self.groq.audio.transcriptions.create( 18 | file=audio_file, 19 | model=self.model, 20 | language=self.language 21 | ) 22 | return response.text 23 | 24 | def close(self): 25 | pass -------------------------------------------------------------------------------- /src/main.py: -------------------------------------------------------------------------------- 1 | import os 2 | import logging 3 | from conversation import Conversation 4 | 5 | # Configure logging globally 6 | log_level = os.getenv('LOG_LEVEL', 'INFO').upper() 7 | logging.basicConfig( 8 | level=getattr(logging, log_level), 9 | format='%(asctime)s │ %(name)-20s │ %(levelname)-8s │ %(message)s', 10 | datefmt='%H:%M:%S' 11 | ) 12 | 13 | # Suppress verbose httpx logs from API clients 14 | logging.getLogger('httpx').setLevel(logging.WARNING) 15 | 16 | convo = Conversation( 17 | initial_history=[ 18 | {"role": "system", "content": ( 19 | "You are talking on the phone as a friendly Arch Linux enthusiast. " 20 | "Speak in short, conversational sentences, explaining Linux in general, " 21 | "highlighting Arch Linux's philosophy (KISS, rolling-release, user control), " 22 | "and advocating for free and open-source software. " 23 | "Keep the tone casual and enthusiastic, like chatting with a friend over the phone." 24 | )}, 25 | {"role": "user", "content": "Hey, I keep hearing about Linux. What's the big deal?"}, 26 | ] 27 | ) 28 | 29 | async def main(): 30 | conversation = convo 31 | await conversation.listen() 32 | 33 | if __name__ == "__main__": 34 | import asyncio 35 | asyncio.run(main()) -------------------------------------------------------------------------------- /src/vad/listener.py: -------------------------------------------------------------------------------- 1 | import pyaudio 2 | import asyncio 3 | import concurrent.futures 4 | 5 | class Listener: 6 | def __init__(self, rate=16000, chunk_ms=32, format=pyaudio.paInt16, channels=1): 7 | self.pyaudio = pyaudio.PyAudio() 8 | self.rate = rate 9 | self.chunk_ms = chunk_ms 10 | self.format = format 11 | self.channels = channels 12 | self.chunk = int(self.rate * self.chunk_ms / 1000) 13 | self.stream = self.pyaudio.open( 14 | format=format, 15 | channels=channels, 16 | rate=rate, 17 | input=True, 18 | frames_per_buffer=self.chunk 19 | ) 20 | 21 | def listen(self): 22 | while True: 23 | data = self.stream.read(self.chunk) 24 | yield data 25 | 26 | async def listen_async(self): 27 | loop = asyncio.get_event_loop() 28 | with concurrent.futures.ThreadPoolExecutor() as executor: 29 | while True: 30 | # Run the blocking read in a thread 31 | data = await loop.run_in_executor(executor, self.stream.read, self.chunk) 32 | yield data 33 | 34 | def close(self): 35 | self.stream.stop_stream() 36 | self.stream.close() 37 | 38 | def __del__(self): 39 | self.close() 40 | self.pyaudio.terminate() -------------------------------------------------------------------------------- /src/gen/groq.py: -------------------------------------------------------------------------------- 1 | from typing import List, Dict 2 | from gen.base import Gen 3 | from groq import Groq 4 | import os 5 | 6 | class GroqGen(Gen): 7 | def __init__(self, 8 | model="llama-3.1-8b-instant", 9 | api_key=os.getenv("GROQ_API_KEY"), 10 | temperature=0.7, 11 | max_tokens=1024 12 | ): 13 | self.groq = Groq(api_key=api_key) 14 | self.model = model 15 | self.temperature = temperature 16 | self.max_tokens = max_tokens 17 | 18 | async def generate(self, messages: List[Dict[str, str]] = []): 19 | """ 20 | Generate text based on the given history. 21 | 22 | Args: 23 | 1. messages: List[Dict[str, str]] - The history of messages 24 | """ 25 | try: 26 | response = self.groq.chat.completions.create( 27 | model=self.model, 28 | messages=messages, 29 | temperature=self.temperature, 30 | max_tokens=self.max_tokens, 31 | stream=True 32 | ) 33 | for chunk in response: 34 | if chunk.choices[0].finish_reason == "stop": 35 | break 36 | if chunk.choices[0].delta.content: 37 | yield chunk.choices[0].delta.content 38 | except Exception as e: 39 | raise Exception(f"Error generating text: {str(e)}") 40 | 41 | def close(self): 42 | pass -------------------------------------------------------------------------------- /src/tts/base.py: -------------------------------------------------------------------------------- 1 | from abc import ABC, abstractmethod 2 | 3 | class TTS(ABC): 4 | """ 5 | Abstract base class for Text-to-Speech (TTS) implementations. 6 | 7 | All TTS classes should inherit from this base class and implement the abstract methods. 8 | """ 9 | 10 | @abstractmethod 11 | def __init__(self): 12 | """ 13 | Initialize the TTS instance. 14 | 15 | This method should set up any necessary configuration, models, or audio processing 16 | parameters specific to the TTS implementation. 17 | """ 18 | pass 19 | 20 | @abstractmethod 21 | async def generate_speech(self, text: str) -> bytes: 22 | """ 23 | Generate speech audio from text. 24 | 25 | Args: 26 | 1. text: str - The text to generate speech for 27 | 28 | Returns: 29 | bytes: The generated speech audio 30 | """ 31 | pass 32 | 33 | @abstractmethod 34 | def close(self): 35 | """ 36 | Clean up resources used by the TTS instance. 37 | 38 | This method should properly close audio streams, release models, 39 | and clean up any other resources to prevent memory leaks. 40 | """ 41 | pass 42 | 43 | def __del__(self): 44 | """ 45 | Destructor that ensures resources are cleaned up. 46 | 47 | This method should call the close method to ensure resources are properly released. 48 | """ 49 | self.close() 50 | -------------------------------------------------------------------------------- /src/stt/base.py: -------------------------------------------------------------------------------- 1 | from abc import ABC, abstractmethod 2 | 3 | class STT(ABC): 4 | """ 5 | Abstract base class for Speech-to-Text (STT) implementations. 6 | 7 | All STT classes should inherit from this base class and implement the abstract methods. 8 | """ 9 | 10 | @abstractmethod 11 | def __init__(self): 12 | """ 13 | Initialize the STT instance. 14 | 15 | This method should set up any necessary configuration, models, or audio processing 16 | parameters specific to the STT implementation. 17 | """ 18 | pass 19 | 20 | @abstractmethod 21 | async def transcribe(self, audio: bytes) -> str: 22 | """ 23 | Transcribe audio data and return the text result. 24 | 25 | Args: 26 | 1. audio: bytes - The audio data to transcribe 27 | 28 | Returns: 29 | str: The transcribed text result 30 | """ 31 | pass 32 | 33 | @abstractmethod 34 | def close(self): 35 | """ 36 | Clean up resources used by the STT instance. 37 | 38 | This method should properly close audio streams, release models, 39 | and clean up any other resources to prevent memory leaks. 40 | """ 41 | pass 42 | 43 | def __del__(self): 44 | """ 45 | Destructor that ensures resources are cleaned up. 46 | 47 | This method should call the close method to ensure resources are properly released. 48 | """ 49 | self.close() 50 | -------------------------------------------------------------------------------- /src/gen/openai.py: -------------------------------------------------------------------------------- 1 | from typing import List, Dict 2 | from gen.base import Gen 3 | from openai import OpenAI 4 | import os 5 | 6 | class OpenAIGen(Gen): 7 | def __init__(self, 8 | model="gpt-3.5-turbo", 9 | api_key=os.getenv("OPENAI_API_KEY"), 10 | temperature=0.7, 11 | max_tokens=1024 12 | ): 13 | self.openai = OpenAI(api_key=api_key) 14 | self.model = model 15 | self.temperature = temperature 16 | self.max_tokens = max_tokens 17 | 18 | async def generate(self, messages: List[Dict[str, str]] = []): 19 | """ 20 | Generate text based on the given history. 21 | 22 | Args: 23 | 1. messages: List[Dict[str, str]] - The history of messages 24 | """ 25 | try: 26 | response = self.openai.chat.completions.create( 27 | model=self.model, 28 | messages=messages, 29 | # temperature=self.temperature, 30 | # max_tokens=self.max_tokens, 31 | max_completion_tokens=self.max_tokens, 32 | stream=True 33 | ) 34 | for chunk in response: 35 | if chunk.choices[0].finish_reason == "stop": 36 | break 37 | if chunk.choices[0].delta.content: 38 | yield chunk.choices[0].delta.content 39 | except Exception as e: 40 | raise Exception(f"Error generating text: {str(e)}") 41 | 42 | def close(self): 43 | pass -------------------------------------------------------------------------------- /src/gen/base.py: -------------------------------------------------------------------------------- 1 | from abc import ABC, abstractmethod 2 | from typing import List, Dict 3 | 4 | class Gen(ABC): 5 | """ 6 | Abstract base class for Text Generation AI implementations. 7 | 8 | All Gen classes should inherit from this base class and implement the abstract methods. 9 | """ 10 | 11 | @abstractmethod 12 | def __init__(self): 13 | """ 14 | Initialize the Gen instance. 15 | 16 | This method should set up any necessary configuration, models, or audio processing 17 | parameters specific to the Gen implementation. 18 | """ 19 | pass 20 | 21 | @abstractmethod 22 | async def generate(self, messages: List[Dict[str, str]] = []): 23 | """ 24 | Generate text based on the given history. 25 | 26 | Args: 27 | 1. messages: List[Dict[str, str]] - The history of messages 28 | 29 | Returns: 30 | Generator of text chunks as they are generated 31 | """ 32 | pass 33 | 34 | @abstractmethod 35 | def close(self): 36 | """ 37 | Clean up resources used by the Gen instance. 38 | 39 | This method should properly close audio streams, release models, 40 | and clean up any other resources to prevent memory leaks. 41 | """ 42 | pass 43 | 44 | def __del__(self): 45 | """ 46 | Destructor that ensures resources are cleaned up. 47 | 48 | This method should call the close method to ensure resources are properly released. 49 | """ 50 | self.close() -------------------------------------------------------------------------------- /src/vad/base.py: -------------------------------------------------------------------------------- 1 | from abc import ABC, abstractmethod 2 | from typing import AsyncGenerator, Optional 3 | 4 | class VAD(ABC): 5 | """ 6 | Abstract base class for Voice Activity Detection (VAD) implementations. 7 | 8 | All VAD classes should inherit from this base class and implement the abstract methods. 9 | """ 10 | 11 | @abstractmethod 12 | def __init__(self): 13 | """ 14 | Initialize the VAD instance. 15 | 16 | This method should set up any necessary configuration, models, or audio processing 17 | parameters specific to the VAD implementation. 18 | """ 19 | pass 20 | 21 | @abstractmethod 22 | async def listen(self) -> AsyncGenerator[bytes, None]: 23 | """ 24 | Listen for speech activity and yield audio chunks when speech is detected. 25 | 26 | This method should: 27 | 1. Continuously monitor audio input 28 | 2. Detect when speech starts and ends 29 | 3. Yield audio data (as bytes) when speech segments are complete 30 | 31 | Yields: 32 | bytes: wav audio data containing detected speech segments 33 | """ 34 | pass 35 | 36 | @abstractmethod 37 | def close(self): 38 | """ 39 | Clean up resources used by the VAD instance. 40 | 41 | This method should properly close audio streams, release models, 42 | and clean up any other resources to prevent memory leaks. 43 | """ 44 | pass 45 | 46 | def __del__(self): 47 | """ 48 | Destructor that ensures resources are cleaned up. 49 | 50 | Default implementation calls close(). Subclasses can override 51 | if additional cleanup is needed. 52 | """ 53 | try: 54 | self.close() 55 | except: 56 | # Ignore errors during destruction 57 | pass 58 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # caLLMe 2 | caLLMe Banner 3 | 4 | A tiny, **voice-first** assistant that turns your microphone into a real-time conversation with an LLM. 5 | caLLMe listens, transcribes, generates a response, speaks it back, and lets you interrupt at any time – all in just a few hundred lines of Python. 6 | 7 | ## Features 8 | 9 | * **Silero Voice Activity Detection** – smartly starts/stops recording when you speak. 10 | * **Groq Whisper STT** – high-quality speech-to-text. 11 | * **Groq Llama 3 LLM** – streams replies token-by-token. 12 | * **Groq PlayAI TTS** – natural, low-latency speech synthesis. 13 | * **Async audio queue** – responses are played while the next ones are being generated; speak again to interrupt. 14 | * Simple, hackable architecture – every component lives in `src/` and follows small base interfaces (VAD, STT, TTS, Gen, Player). 15 | 16 | ## Quick Start 17 | 18 | ```bash 19 | # 1. Grab the code 20 | $ git clone https://github.com/yourname/caLLMe.git 21 | $ cd caLLMe 22 | 23 | # 2. Create & activate a virtual env (optional but recommended) 24 | $ python -m venv .venv 25 | $ source .venv/bin/activate 26 | 27 | # 3. Install Python dependencies 28 | $ pip install -r requirements.txt 29 | 30 | # 4. Set your Groq API key (required for STT, TTS & LLM) 31 | $ export GROQ_API_KEY="sk_..." 32 | 33 | # 5. Run the assistant 🎙️ 34 | $ python src/main.py 35 | ``` 36 | 37 | ## Customising 38 | 39 | * Change the **system prompt** & initial dialogue in `src/main.py`. 40 | * Swap out models by tweaking default parameters in: 41 | * `src/gen/groq.py` (LLM) 42 | * `src/stt/groqWhisper.py` (STT) 43 | * `src/tts/groqPlayai.py` (TTS) 44 | * Adjust VAD sensitivity in `src/vad/silerovad.py` (`on_threshold`, `off_threshold`, etc.). 45 | 46 | ## Troubleshooting 47 | 48 | * PyAudio may require system packages (e.g. `portaudio`, `alsa-utils`). On Ubuntu: 49 | `sudo apt install portaudio19-dev python3-pyaudio` 50 | * If audio is choppy, lower `max_audio_queue` in `Conversation` or tweak model temperatures. 51 | 52 | --- 53 | 54 | Built with ❤️ & open-source software. Enjoy hacking! 55 | -------------------------------------------------------------------------------- /src/vad/webrtcvad.py: -------------------------------------------------------------------------------- 1 | """ 2 | This class implements webrtcvad for voice activity detection (VAD). 3 | It uses the webrtcvad library to determine when speech starts and ends in an audio stream. 4 | 5 | The webrtcvad class provides a method to listen on the microphone, 6 | when the speech starts, it will start recording the audio, and once the speech ends, 7 | it will stop recording and return the audio. 8 | """ 9 | 10 | import asyncio 11 | from typing import List 12 | import webrtcvad 13 | import pyaudio 14 | import logging 15 | from vad.base import VAD 16 | logger = logging.getLogger(__name__) 17 | 18 | class WEBRTCVAD(VAD): 19 | def __init__(self): 20 | self.vad = webrtcvad.Vad() 21 | self.vad.set_mode(1) # Aggressive mode 22 | self.pa = pyaudio.PyAudio() 23 | 24 | # Fixed: Use frame size that gives valid duration 25 | self.rate = 16000 26 | self.channels = 1 27 | self.format = pyaudio.paInt16 28 | 29 | # For 20ms frames: 16000 * 0.02 = 320 samples 30 | self.frame_duration_ms = 20 # Valid: 10, 20, or 30 ms 31 | self.chunk = int(self.rate * self.frame_duration_ms / 1000) # 320 samples 32 | 33 | self.min_speech_duration = 500 #milliseconds 34 | self.min_silence_duration = 1000 #milliseconds 35 | self.max_recording_duration = 10000 #milliseconds 36 | 37 | self.pa_config = { 38 | "chunk": self.chunk, 39 | "rate": self.rate, 40 | "channels": self.channels, 41 | "format": self.format 42 | } 43 | 44 | logger.debug(f"Opening stream with chunk size {self.chunk}") 45 | self.stream = self.pa.open( 46 | rate=self.rate, 47 | channels=self.channels, 48 | format=self.format, 49 | frames_per_buffer=self.chunk, 50 | input=True, 51 | ) 52 | 53 | async def listen(self): 54 | """ 55 | Listen on the microphone and return the audio when speech starts and ends. 56 | """ 57 | logger.info("🎙️ Listening on microphone...") 58 | try: 59 | while True: 60 | data = self.stream.read(self.chunk) 61 | 62 | # Add error handling for frame processing 63 | try: 64 | is_speech = self.vad.is_speech(data, self.rate) 65 | 66 | if is_speech: 67 | logger.debug("Speech detected") 68 | # TODO: Add your speech handling logic here 69 | else: 70 | logger.debug("No speech detected") 71 | 72 | except Exception as e: 73 | logger.error(f"Error processing frame: {e}") 74 | continue 75 | 76 | # Add break condition for testing 77 | await asyncio.sleep(0.001) # Small delay for async cooperation 78 | 79 | except KeyboardInterrupt: 80 | logger.info("🛑 Stopping VAD...") 81 | finally: 82 | self.stream.stop_stream() 83 | self.stream.close() 84 | self.pa.terminate() 85 | 86 | 87 | if __name__ == "__main__": 88 | 89 | async def main(): 90 | vad = WEBRTCVAD() 91 | await vad.listen() 92 | 93 | asyncio.run(main()) -------------------------------------------------------------------------------- /src/conversation.py: -------------------------------------------------------------------------------- 1 | from vad.silerovad import SileroVAD 2 | from stt.groqWhisper import GroqWhisper 3 | from tts.groqPlayai import GroqPlayai 4 | from gen.groq import GroqGen 5 | from player import Player 6 | import logging 7 | import asyncio 8 | 9 | logger = logging.getLogger(__name__) 10 | 11 | class Conversation: 12 | def __init__(self, 13 | vad=SileroVAD(), 14 | stt=GroqWhisper(), 15 | tts=GroqPlayai(), 16 | gen=GroqGen(), 17 | player=Player(), 18 | max_audio_queue=2, 19 | initial_history=[] 20 | ): 21 | self.vad = vad 22 | self.stt = stt 23 | self.tts = tts 24 | self.gen = gen 25 | self.player = player 26 | self.history = initial_history 27 | self.max_audio_queue = max_audio_queue 28 | # Track the current response generation task 29 | self.current_response_task = None 30 | 31 | async def _yield_sentence(self, generator, min_length=50): 32 | sentence = "" 33 | separators = ['.', '?', '!', ',', '\n'] 34 | async for token in generator: 35 | # Check if task was cancelled 36 | if asyncio.current_task().cancelled(): 37 | logger.debug("Generation cancelled") 38 | return 39 | 40 | sentence += token 41 | if len(sentence.strip()) > min_length and sentence[-1] in separators: 42 | yield sentence 43 | sentence = "" 44 | if sentence: 45 | yield sentence 46 | 47 | async def generate_assistant_response(self, text: str): 48 | logger.debug("Generating assistant response") 49 | try: 50 | self.history.append({"role": "user", "content": text}) 51 | async for sentence in self._yield_sentence(self.gen.generate(self.history)): 52 | # Check if task was cancelled between sentences 53 | if asyncio.current_task().cancelled(): 54 | logger.debug("Response generation cancelled") 55 | return 56 | 57 | self.history.append({"role": "assistant", "content": sentence}) 58 | logger.debug(f"Assistant sentence: {sentence}") 59 | 60 | # Wait until queue has space before generating speech 61 | while self.player.queue.qsize() >= self.max_audio_queue: 62 | # Check if task was cancelled while waiting 63 | if asyncio.current_task().cancelled(): 64 | logger.debug("Response generation cancelled while waiting for queue space") 65 | return 66 | 67 | await asyncio.sleep(0.1) # Wait 100ms before checking again 68 | 69 | speech = await self.tts.generate_speech(sentence) 70 | logger.debug(f"Speech enqueued") 71 | self.player.enqueue(speech) 72 | except asyncio.CancelledError: 73 | logger.debug("Response generation was cancelled") 74 | # Don't re-raise, just exit gracefully 75 | except Exception as e: 76 | logger.error(f"Error in generate_assistant_response: {e}") 77 | 78 | async def listen(self): 79 | logger.info("🎙️ Listening for voice input...") 80 | def interrupt(): 81 | if self.current_response_task and not self.current_response_task.done(): 82 | self.current_response_task.cancel() 83 | # Stop and restart audio playback 84 | self.player.stop() 85 | 86 | self.player.stop() 87 | async for chunk in self.vad.listen(interrupt=interrupt): 88 | logger.debug("Audio received") 89 | 90 | # Cancel current response generation if running 91 | if self.current_response_task and not self.current_response_task.done(): 92 | logger.debug("Cancelling current response generation") 93 | self.current_response_task.cancel() 94 | 95 | # Stop and restart audio playback 96 | self.player.stop() 97 | self.player.play() 98 | 99 | # Transcribe the new audio 100 | transcription = await self.stt.transcribe(chunk) 101 | logger.info(f"📝 User said: {transcription}") 102 | 103 | # Start new response generation in background 104 | self.current_response_task = asyncio.create_task( 105 | self.generate_assistant_response(transcription), 106 | ) -------------------------------------------------------------------------------- /src/vad/silerovad.py: -------------------------------------------------------------------------------- 1 | import torch 2 | import numpy as np 3 | import asyncio 4 | import logging 5 | import wave 6 | import io 7 | from collections import deque 8 | 9 | from vad.listener import Listener 10 | from vad.base import VAD 11 | logger = logging.getLogger(__name__) 12 | 13 | class SileroVAD(VAD): 14 | def __init__(self, on_threshold=0.8, off_threshold=0.3, on_consecutive=5, off_consecutive=20, prebuffer_ms=500, min_recording_ms=1000): 15 | self.listener = Listener() 16 | self.vad_model, utils = torch.hub.load( 17 | 'snakers4/silero-vad', 18 | 'silero_vad', 19 | force_reload=False, 20 | onnx=False 21 | ) 22 | (self.get_speech_timestamps, _, _, _, _) = utils 23 | 24 | self.on_threshold = on_threshold 25 | self.off_threshold = off_threshold 26 | self.on_consecutive = on_consecutive 27 | self.off_consecutive = off_consecutive 28 | self.speech_active = False 29 | self.on_count = self.off_count = 0 30 | 31 | # Calculate prebuffer size based on chunk duration 32 | # Each chunk is listener.chunk_ms (32ms by default) 33 | self.prebuffer_chunks = max(1, int(prebuffer_ms / self.listener.chunk_ms)) 34 | logger.debug(f"Pre-buffer size: {self.prebuffer_chunks} chunks ({self.prebuffer_chunks * self.listener.chunk_ms}ms)") 35 | 36 | # Use deque with maxlen for efficient circular buffer 37 | self.prebuffer = deque(maxlen=self.prebuffer_chunks) 38 | self.speech_buffer = [] 39 | self.min_recording_ms = min_recording_ms 40 | def _pcm_to_wav(self, pcm_data): 41 | """Convert PCM audio data to WAV format""" 42 | wav_buffer = io.BytesIO() 43 | with wave.open(wav_buffer, 'wb') as wav_file: 44 | wav_file.setnchannels(self.listener.channels) # mono 45 | wav_file.setsampwidth(2) # 16-bit = 2 bytes 46 | wav_file.setframerate(self.listener.rate) # 16000 Hz 47 | wav_file.writeframes(pcm_data) 48 | 49 | wav_buffer.seek(0) 50 | return wav_buffer.getvalue() 51 | 52 | async def listen(self, interrupt: callable = None): 53 | for chunk in self.listener.listen(): 54 | pcm = np.frombuffer(chunk, dtype=np.int16).astype(np.float32) / 32768 55 | audio = torch.from_numpy(pcm) 56 | 57 | prob = self.vad_model(audio, self.listener.rate).max().item() 58 | 59 | # Always add chunk to prebuffer (circular buffer) 60 | self.prebuffer.append(chunk) 61 | 62 | speech_duration = (len(self.speech_buffer) - self.prebuffer_chunks) * self.listener.chunk_ms 63 | 64 | if not self.speech_active: 65 | if prob > self.on_threshold: 66 | self.on_count += 1 67 | if self.on_count >= self.on_consecutive: 68 | self.speech_active = True 69 | self.off_count = 0 70 | logger.info("🗣️ Speech start") 71 | # Add prebuffer chunks to speech_buffer when speech starts 72 | self.speech_buffer.extend(list(self.prebuffer)) 73 | else: 74 | self.on_count = 0 75 | else: 76 | if prob < self.off_threshold: 77 | self.off_count += 1 78 | if self.off_count >= self.off_consecutive: 79 | self.speech_active = False 80 | # Process the accumulated speech buffer 81 | if speech_duration >= self.min_recording_ms: 82 | logger.info(f"🔇 Speech end (duration: {speech_duration}ms)") 83 | pcm_audio = b''.join(self.speech_buffer) 84 | wav_audio = self._pcm_to_wav(pcm_audio) 85 | yield wav_audio 86 | self.speech_buffer = [] 87 | else: 88 | logger.info(f"🔇 Speech end (duration: {speech_duration}ms) not enough") 89 | self.speech_buffer = [] 90 | self.on_count = 0 91 | else: 92 | self.off_count = 0 93 | if interrupt and speech_duration >= self.min_recording_ms: 94 | interrupt() 95 | 96 | # Add current chunk to speech buffer if speech is active 97 | if self.speech_active: 98 | self.speech_buffer.append(chunk) 99 | 100 | # Yield control back to the event loop 101 | await asyncio.sleep(0) 102 | 103 | def close(self): 104 | self.listener.close() 105 | 106 | def __del__(self): 107 | self.close() 108 | 109 | if __name__ == "__main__": 110 | async def main(): 111 | vad = SileroVAD() 112 | async for chunk in vad.listen_async(): 113 | print(len(chunk)) 114 | 115 | asyncio.run(main()) -------------------------------------------------------------------------------- /src/player.py: -------------------------------------------------------------------------------- 1 | from abc import ABC, abstractmethod 2 | import threading 3 | import simpleaudio as sa 4 | import io 5 | import queue 6 | import wave 7 | import logging 8 | import time 9 | import os 10 | from pydub import AudioSegment 11 | logger = logging.getLogger(__name__) 12 | 13 | class BasePlayer(ABC): 14 | @abstractmethod 15 | def play(self, audio: bytes): 16 | """ 17 | Start playing the audio queue. 18 | """ 19 | pass 20 | 21 | @abstractmethod 22 | def stop(self): 23 | """ 24 | Stop the player. and clear the queue. 25 | """ 26 | pass 27 | 28 | @abstractmethod 29 | def enqueue(self, audio: bytes): 30 | """ 31 | Enqueue an audio to the player. 32 | """ 33 | pass 34 | 35 | @abstractmethod 36 | def close(self): 37 | """ 38 | Close the player. and clean up the resources. 39 | """ 40 | pass 41 | 42 | def __del__(self): 43 | self.close() 44 | 45 | class Player(BasePlayer): 46 | def __init__(self): 47 | self.queue = queue.Queue() 48 | self._stop_event = threading.Event() 49 | self.current_play_obj = None 50 | 51 | self.playing = False 52 | 53 | # Configuration 54 | self.wait_threshold = 3 # seconds to wait before starting hold music 55 | 56 | # Load hold / waiting music 57 | self.hold_wave_obj = None 58 | self.hold_play_obj = None 59 | self.hold_playing = False 60 | 61 | try: 62 | hold_path = os.path.join(os.path.dirname(__file__), '..', 'assets', 'waiting.mp3') 63 | hold_segment = AudioSegment.from_mp3(hold_path) 64 | 65 | # Apply a gentle 2-second fade-in so the music comes in smoothly 66 | hold_segment = hold_segment.fade_in(2000) 67 | 68 | # Convert AudioSegment to a WaveObject that simpleaudio can play 69 | self.hold_wave_obj = sa.WaveObject( 70 | hold_segment.raw_data, 71 | num_channels=hold_segment.channels, 72 | bytes_per_sample=hold_segment.sample_width, 73 | sample_rate=hold_segment.frame_rate, 74 | ) 75 | logger.debug("Hold music loaded successfully") 76 | except Exception as e: 77 | logger.error(f"Failed to load hold music: {e}") 78 | 79 | # Start worker thread after initialization is complete 80 | self.thread = threading.Thread(target=self._worker, daemon=True) 81 | self.thread.start() 82 | 83 | def enqueue(self, audio: bytes): 84 | self.queue.put(audio) 85 | 86 | def play(self): 87 | self._stop_event.clear() 88 | self.playing = True 89 | if not self.thread.is_alive(): 90 | self.thread.start() 91 | 92 | def stop(self): 93 | if self.current_play_obj: 94 | self.current_play_obj.stop() 95 | self.current_play_obj = None 96 | self._stop_event.set() 97 | self.playing = False 98 | with self.queue.mutex: 99 | self.queue.queue.clear() 100 | 101 | def close(self): 102 | self.stop() 103 | if self.thread.is_alive(): 104 | self.thread.join() 105 | 106 | def wait(self): 107 | self.thread.join() 108 | 109 | def _worker(self): 110 | while True: 111 | try: 112 | # If a stop was requested, clean up and continue 113 | if self._stop_event.is_set(): 114 | self._stop_event.clear() 115 | 116 | # Stop any ongoing playback (normal or hold) 117 | if self.current_play_obj and self.current_play_obj.is_playing(): 118 | self.current_play_obj.stop() 119 | if self.hold_play_obj and self.hold_play_obj.is_playing(): 120 | self.hold_play_obj.stop() 121 | 122 | self.current_play_obj = None 123 | self.hold_play_obj = None 124 | self.hold_playing = False 125 | continue 126 | 127 | # Try to get audio to play; timeout so we can decide on hold music 128 | try: 129 | audio = self.queue.get(timeout=self.wait_threshold) 130 | except queue.Empty: 131 | if not self.playing: 132 | continue 133 | # Queue has been empty for wait_threshold seconds 134 | if self.hold_wave_obj is not None: 135 | if not self.hold_playing: 136 | logger.debug("Starting hold music") 137 | self.hold_play_obj = self.hold_wave_obj.play() 138 | self.hold_playing = True 139 | # If hold music finished playing, loop it 140 | elif self.hold_play_obj and not self.hold_play_obj.is_playing(): 141 | self.hold_play_obj = self.hold_wave_obj.play() 142 | # No audio to play right now; loop back 143 | continue 144 | 145 | # We have real audio to play; ensure hold music stops 146 | if self.hold_playing and self.hold_play_obj: 147 | self.hold_play_obj.stop() 148 | self.hold_playing = False 149 | self.hold_play_obj = None 150 | 151 | logger.debug(f"Playing queued audio: {len(audio)} bytes") 152 | 153 | # Create a BytesIO object from the audio bytes 154 | wav_io = io.BytesIO(audio) 155 | 156 | # Use Python's wave module to read the WAV data 157 | with wave.open(wav_io, 'rb') as wave_read: 158 | # Create WaveObject from the wave_read object 159 | wave_obj = sa.WaveObject.from_wave_read(wave_read) 160 | 161 | # Play the queued audio 162 | self.current_play_obj = wave_obj.play() 163 | 164 | # Wait briefly to ensure loading 165 | time.sleep(0.05) 166 | 167 | # Wait for playback to complete or stop event 168 | while self.current_play_obj and self.current_play_obj.is_playing(): 169 | if self._stop_event.is_set(): 170 | self.current_play_obj.stop() 171 | self.current_play_obj = None 172 | self._stop_event.clear() 173 | break 174 | time.sleep(0.01) # Prevent busy waiting 175 | 176 | logger.debug("Queued audio playback completed") 177 | 178 | except Exception as e: 179 | logger.error(f"Error playing audio: {e}") 180 | continue -------------------------------------------------------------------------------- /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 | --------------------------------------------------------------------------------