maui.io.get_audio_info¶

maui.io.get_audio_info(audio_path, format_name, date_time_func=None, format_file_path=None, store_duration=False, perc_sample=1)[source]¶

Extract audio file information from a file or directory.

This function processes audio files specified by the ‘audio_path’ argument, extracting information such as filename structure, timestamps, and duration. It can handle both single audio files and entire directories of audio files.

Parameters:

audio_path: str: The path to an audio file or directory containing audio files.
store_duration: int, optional: Whether to calculate and store audio duration (default is 0).
perc_sample float, optional: Percentage of audio files to include when processing a directory (default is 1).

Returns:

df: pandas.DataFrame: A DataFrame containing information about the audio files.

Raises:

Exception:: If the input is neither a file nor a directory.

Examples

>>> from maui import io
>>> audio_file = "forest_channelA_20210911_153000_jungle.wav"
>>> io.get_audio_info(audio_file, store_duration=1, perc_sample=0.8)

>>> audio_dir = "/path/to/audio/directory"
>>> df = io.get_audio_info(audio_dir, "LEEC_FILE_FORMAT",
                           store_duration=True, perc_sample=1)
>>> df["dt"] = pd.to_datetime(df["timestamp_init"]).dt.date