Update app.py

app.py

@@ -59,29 +59,75 @@ def record(audio):
 # -----------------Filter----------------- #
 
 def butter_bandpass(sr, order=5):
+    """
+    This function designs a Butterworth bandpass filter.
+
+    Parameters:
+    sr (int): The sample rate of the audio.
+    order (int): The order of the filter.
+
+    Returns:
+    tuple: The filter coefficients `b` and `a`.
+    """
+    # Calculate the Nyquist frequency
     nyquist = 0.5 * sr
-    low = (low_frequency-500)  / nyquist
-    high = (high_frequency+500) / nyquist
+
+    # Normalize the cutoff frequencies with a 500 Hz offset
+    low = (low_frequency - 500) / nyquist
+    high = (high_frequency + 500) / nyquist
+
+    # Design the Butterworth bandpass filter
     coef = butter(order, [low, high], btype='band')
+
+    # Extract the filter coefficients
     b = coef[0]
     a = coef[1]
+
     return b, a
 
 
 def butter_bandpass_filter(data, sr, order=5):
+    """
+    This function applies the Butterworth bandpass filter to a given data.
+
+    Parameters:
+    data (array): The audio data to be filtered.
+    sr (int): The sample rate of the audio.
+    order (int): The order of the filter.
+
+    Returns:
+    array: The filtered audio data.
+    """
+    # Get the filter coefficients
     b, a = butter_bandpass(sr, order=order)
+
+    # Apply the filter to the data
     y = lfilter(b, a, data)
+
     return y
 
 
 def filtered():
+    """
+    This function reads an audio file, applies the bandpass filter to the audio data,
+    and then writes the filtered data to an output file.
+
+    Returns:
+    str: A success message if the audio is filtered correctly, otherwise an error message.
+    """
+    # Define the input and output file paths
     input_file = 'recorded.wav'
     output_file = 'output_filtered_receiver.wav'
 
+    # Read the audio data from the input file
     sr, data = read(input_file)
 
+    # Apply the bandpass filter to the audio data
     filtered_data = butter_bandpass_filter(data, sr)
+
+    # Write the filtered data to the output file
     write(output_file, sr, np.int16(filtered_data))
+
     return "Filtered Audio Generated"
 
 # -----------------Frame----------------- #