Change default max queue size of answer to 1, and enable to change the value by user.

Organize constructor params of ChatAIStreamer.

Author: GeneralYadoc

README.md

@@ -72,13 +72,18 @@ Extention of [ChatAIStream](https://github.com/GeneralYadoc/ChatAIStream) for vo
     system_role = "You are a cheerful assistant who speek English and can get conversation exciting with user."
   )
 
+  # Set params of streamer
+  streamer_params=casr.streamerParams(
+    voice_generator=myVoiceGenerator(),
+    answer_with_voice_cb=answer_with_voice_cb
+  )
+
   # Create ChatAIStreamer instance.
   ai_streamer =casr.ChatAIStreamer(
     casr.params(
       stream_params=stream_params,
       ai_params=ai_params,
-      voice_generator=myVoiceGenerator(),
-      answer_with_voice_cb=answer_with_voice_cb
+      streamer_params=streamer_params
     )
   )
 
@@ -177,16 +182,18 @@ Extention of [ChatAIStream](https://github.com/GeneralYadoc/ChatAIStream) for vo
   # You can choose other language by its 'lang=' argument like 'ja'.
   # If you want to change language, Please change the assignment for system role of ai params also.
   # The instance isn't necessary for English generator.
-  voice_generator=gasr.GttsGenerator(lang='en')
+  streamer_params=gasr.streamerParams(
+    voice_generator=gasr.GttsGenerator(lang='en'),
+    answer_with_voice_cb=answer_with_voice_cb
+  )
 
   # Create GttsAIStreamer instance.
   # 'voice_generator=' is omittable for English generator.
   ai_streamer =gasr.GttsAIStreamer(
     gasr.params(
       stream_params=stream_params,
       ai_params=ai_params,
-      voice_generator=voice_generator,
-      answer_with_voice_cb=answer_with_voice_cb
+      streamer_params=streamer_params
     )
   )
 
@@ -257,16 +264,17 @@ Extention of [ChatAIStream](https://github.com/GeneralYadoc/ChatAIStream) for vo
     | ask_cb | user message given to ChatGPT is thrown to this callback | None |
     | max_messages_in_context | Max messages in context given to ChatGPT | 20 |
     | answer_cb | ChatGPT answer is thrown to this callback  | None |
-    | answer_with_voice_cb | ChatGPT answer is thrown to this callback with voice data created by your get method of voiceGenerator  | None |
     | max_queue_size | Max slots of internal queue (0 is no limit) | 10 |
     | model | Model of AI to be used. | None |
     | max_tokens_per_request | Max number of tokens which can be contained in a request | 256 |
     | interval_sec | Interval of ChatGPT API call | 20.0 \[sec\] |
 
-  ### voiceGenerator
+  ### streamerParams
     | name | description | default |
     |------|------------|---------|
-    | voice_generator | the instance of inherited class of voiceGenerater made by you | - |
+    | voice_generator | the instance of inherited class of voiceGenerater made by you | None |
+    | answer_with_voice_cb | ChatGPT answer is thrown to this callback with voice data created by your get method of voiceGenerator  | None |
+    | max_queue_size | max size of internal queue which stocks GPT answer which will be given to voice Generator | 1 |
 
 ### Notice
 - Please refer [pytchat README](https://github.com/taizan-hokuto/pytchat) to know the type of YouTube Chat item used by get_item_cb, pre_filter_cb and post filter_cb.

samples/sample.py

@@ -66,16 +66,18 @@ def answer_with_voice_cb(user_message, completion, voice):
 # You can choose other language by its 'lang=' argument like 'ja'.
 # If you want to change language, Please change the assignment for system role of ai params also.
 # The instance isn't necessary for English generator.
-voice_generator=gasr.GttsGenerator(lang='en')
+streamer_params=gasr.streamerParams(
+  voice_generator=gasr.GttsGenerator(lang='en'),
+  answer_with_voice_cb=answer_with_voice_cb
+)
 
 # Create GttsAIStreamer instance.
 # 'voice_generator=' is omittable for English generator.
 ai_streamer =gasr.GttsAIStreamer(
   gasr.params(
     stream_params=stream_params,
     ai_params=ai_params,
-    voice_generator=voice_generator,
-    answer_with_voice_cb=answer_with_voice_cb
+    streamer_params=streamer_params
   )
 )
 

setup.py

@@ -12,7 +12,7 @@ def _requires_from_file(filename):
 
 setup(
     name="chatai-streamer",
-    version="1.0.0",
+    version="2.0.0",
     license="MIT",
     description="ChatGPT answer aloud YouTube chat messages.",
     author="General Yadoc",

src/ChatAIStreamer.py

@@ -10,15 +10,22 @@
 userMessage = cas.userMessage
 aiParams = cas.aiParams
 
+
 class voiceGenerator(ABC):
   @abstractmethod
   def generate(self, text):
     pass
 
 @dataclass
-class params(cas.params):
+class streamerParams():
   voice_generator : voiceGenerator = None
   answer_with_voice_cb: Callable[[userMessage, any, any], None] = None
+  max_queue_size : int = 1
+
+
+@dataclass
+class params(cas.params):
+  streamer_params : streamerParams = streamerParams()
 
 @dataclass
 class answerSlot():
@@ -48,13 +55,13 @@ def my_answer_cb(self, user_message, completion):
 
   def __init__(self, params):
     self.__keeping_connection = False
-    self.voice_generator = params.voice_generator
+    self.voice_generator = params.streamer_params.voice_generator
     self.__answer_queue = None
     self.__answer_thread = None
     if (self.voice_generator):
-      self.__answer_queue = queue.Queue(5)
+      self.__answer_queue = queue.Queue(params.streamer_params.max_queue_size)
       self.__answer_thread = threading.Thread(target=self.__generateVoice, daemon=True)
-    self.answer_with_voice_cb = params.answer_with_voice_cb
+    self.answer_with_voice_cb = params.streamer_params.answer_with_voice_cb
 
     self.answer_cb = params.ai_params.answer_cb
     params.ai_params.answer_cb = self.my_answer_cb

src/GttsAIStreamer.py

@@ -61,11 +61,14 @@ def generate(self, text):
     # return voice with translated text.
     return text_en, voice
 
-# Extend params to hold voiceGenerator instance.
+# Extend streamerParams and params to hold voiceGenerator instance.
 # voice_generator is defaultly intialized with English voiceGenerator.
 @dataclass
-class params(casr.params):
+class streamerParams(casr.streamerParams):
   voice_generator : casr.voiceGenerator = GttsGenerator()
+@dataclass
+class params(casr.params):
+  streamer_params : streamerParams = streamerParams()
 
 # VoicePlayer class which plays the voice generated by GttsGenerator.
 class VoicePlayer(threading.Thread):

src/__init__.py

@@ -1,4 +1,4 @@
 from .ChatAIStreamer import *
 from .GttsAIStreamer import *
 
-__version__ = '1.0.0'
+__version__ = '2.0.0'