Updating Readme and stop button

README.md

@@ -1,12 +1,66 @@
----
-title: VAD BTP
-emoji: 🐨
-colorFrom: purple
-colorTo: green
-sdk: streamlit
-sdk_version: 1.28.2
-app_file: app.py
-pinned: false
----
-
-Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
+# Human Voice Activity Detector
+
+This project is a Human Voice Activity Detector built using Streamlit, PyAudio, Matplotlib, Librosa, and PyTorch. It allows users to upload audio files, and detect speech segments in the provided audio.
+
+## Setup
+
+Open the folder in your preferred IDE and before running the project, make sure to install the required dependencies. You can use the following commands:
+
+```bash
+pip install -r requirements.txt
+```
+Additionally, if you are running the project in a virtual environment, activate it before installing the dependencies.
+
+## Running the App
+
+To run the Streamlit app, use the following command:
+
+```bash
+streamlit run app.py
+```
+This will start the app and open it in your default web browser. You can then interact with the Human Voice Activity Detector.
+
+## Usage
+
+### Recording Audio
+
+```bash
+1.Enter a filename and set the duration for recording in the provided form.
+2.Click the "Record" button to start recording from the microphone.
+3.Click the "Stop Recording" button to stop the recording.
+4.Download the recorded audio using the provided download button.
+```
+
+### Upload the Recorded Audio File
+```bash
+1.Use the "Upload Audio" button to upload a WAV file.
+2.The app will display the waveform and play the raw audio.
+```
+
+### Speech Detection
+
+```bash
+1.The app processes the audio file using a pre-trained speech detection model.
+2.Detected speech segments are highlighted in the waveform plot.
+3.If no speech is detected, an error message is displayed.
+```
+### Resetting the App
+
+```bash
+Click the "Reset" button to clear the current recording or uploaded audio and start over
+```
+
+## Important Notes
+
+```bash
+• Ensure that the required system dependencies for PyAudio are installed. If not, uncomment the # RUN apt-get update && apt-get install -y portaudio19-dev line in the requirements.txt file.
+• The app uses a pre-trained speech detection model from the "snakers4/silero-vad" repository. It will automatically download the model during the first run.
+```
+
+## Contributors
+ 
+#### • Mridul kant Kaushik
+#### • Shubham Shandilya
+
+## 
+# Happy voice detecting!

helper.py

@@ -19,6 +19,7 @@ def record_Audio(filename, duration):
     
     recording_state = st.session_state.get("recording_state", False)
     recording_info_placeholder = st.empty()
+    stop_button_placeholder = st.empty()
     if recording_state:
         
         recording_info_placeholder.info("Recording... ")
@@ -42,15 +43,21 @@ def record_Audio(filename, duration):
                             output_device_index=default_output_device_index)
             
             
-            stop_button = st.button("Stop Recording")
-                
+            if recording_state:
+                stop_button = st.button("Stop Recording")
+            else:
+                stop_button_placeholder.empty()
+                        
             for _ in range(0, RATE // CHUNK * RECORD_TIME):
                 
                 f.writeframes(stream.read(CHUNK))
                 
                 if stop_button:
-                    break
-                    
+                    stop_button = st.empty()
+                    st.session_state["recording_done"] = True
+                    recording_info_placeholder.info("Recording Stopped")
+                    stream.close()
+                    p.terminate()                    
             
             recording_info_placeholder.success("Recording Completed\nThese are the results:")