Skip to content

Latest commit

 

History

History
158 lines (106 loc) · 4.52 KB

README.md

File metadata and controls

158 lines (106 loc) · 4.52 KB

Timestamped Audio Recorder

A Python script for continuous audio recording in timestamped chunks. This tool allows you to record audio continuously, splitting the recordings into manageable chunks with precise timestamps in the filenames.

Features

  • Continuous Recording: Record audio indefinitely or for a specified total duration.
  • Chunked Recording: Split recordings into chunks of a specified duration.
  • Timestamped Filenames: Save recordings with precise UTC timestamps, including microseconds.
  • Device Selection: Choose the audio input device for recording.
  • Customizable Parameters: Adjust sampling rate, number of channels, and more via command-line arguments.

Table of Contents

Installation

  1. Clone the Repository

    git clone https://github.com/yourusername/timestamped-audio-recorder.git
cd timestamped-audio-recorder

  2. Install Required Libraries

    pip install sounddevice scipy numpy

Note: in case you get issues with PortAudio when trying the audio_recorder, try installing sounddevice via conda-forge instread

conda install -c conda-forge python-sounddevice

Usage

Basic Usage

Run the script with default settings:

python audio_recorder.py

This command will:

  • Record audio indefinitely until you stop the script (Ctrl+C).
  • Record in chunks of 60 seconds (this is the default, it can be changed).
  • Use the default audio input device.
  • Save recordings in the current directory with timestamped filenames.

Listing Audio Devices

To list all available audio input devices:

python audio_recorder.py --print-devices

Example Output:

Available audio devices:
   0 BlackHole 2ch, Core Audio (2 in, 2 out)
   1 MacBook Pro Microphone, Core Audio (1 in, 0 out)
   2 MacBook Pro Speakers, Core Audio (0 in, 2 out)
>  3 External Microphone, Core Audio (1 in, 0 out)
<  4 External Microphone, Core Audio (0 in, 2 out)
  • Use the device index (e.g., 1) to specify the recording device.

Specifying Recording Parameters

You can customize the recording using various command-line arguments:

  • Chunk Duration (-d or --duration): Duration of each recording chunk in seconds. Default is 60 seconds.
  • Total Duration (-t or --total-duration): Total duration of recording in seconds. If not specified, the script runs indefinitely.
  • Sampling Rate (-r or --samplerate): Sampling rate in Hertz. Default is 44100 Hz.
  • Channels (-c or --channels): Number of audio channels. 1 for mono, 2 for stereo. Default is 2.
  • Device (--device): Device index for recording. Use --print-devices to find the index.
  • Help (-h or --help): Show help message and exit.

Examples

Record in 30-Second Chunks Indefinitely

python audio_recorder.py -d 30

Record in 10-Second Chunks for a Total of 5 Minutes

python audio_recorder.py -d 10 -t 300

Record Using a Specific Device

python audio_recorder.py --device 1

Record Mono Audio at 48 kHz

python audio_recorder.py -c 1 -r 48000

Combine Multiple Parameters

python audio_recorder.py -d 15 -t 120 --device 3 -c 1 -r 48000

This command records mono audio at 48 kHz using device index 3, in 15-second chunks, for a total of 2 minutes.

Filename Format

Recordings are saved with filenames in the following format:

audio_recording_YYYY-MM-DDTHH_MM_SS.microsecondsZ.wav
  • Example: audio_recording_2023-10-01T14_30_45.123456Z.wav
  • Components:
    • YYYY-MM-DD: Year, month, and day.
    • T: Separator indicating the start of the time component.
    • HH_MM_SS: Hour, minute, and second.
    • .microseconds: Microseconds (if not zero).
    • Z: Indicates that the time is in UTC.

Note: The timestamps are in Coordinated Universal Time (UTC) with microsecond precision.

License

This project is licensed under the MIT License. You are free to use, modify, and distribute this software in accordance with the license terms.

Disclaimer: Use this software responsibly and ensure compliance with local laws and regulations regarding audio recording and privacy.