auditok, an AUDIo TOKenization tool

auditok is an Audio Activity Detection tool that processes online data (from an audio device or standard input) and audio files. It can be used via the command line or through its API.

Full documentation is available on Read the Docs.

Getting started

• Installation
• Load audio data
  • From a file
  • From a bytes object
  • From the microphone
  • Skip part of audio data
  • Limit the amount of read audio
• Basic split example
• Split and plot
• Split an audio stream and re-join (glue) audio events with silence
• Read audio data from the microphone and perform real-time event detection
• Access recorded data after split
• Working with AudioRegions
  • Basic region information
  • Concatenate regions
  • Repeat a region
  • Split one region into N regions of equal size
  • Slice a region by samples, seconds or milliseconds
  • Export an AudioRegion as a numpy array

Command-line guide

• Command-line guide
  • Real-Time audio acquisition and event detection
  • Read audio data with an external program
  • Play back audio detections
  • Output detection details
  • Save detections
  • Save the full audio stream
  • Join detected audio events, inserting a silence between them
  • Plot detections

API Reference

• Core
• Util
• Low-level IO
  • auditok.io.AudioSource
    • AudioSource
  • auditok.io.Rewindable
    • Rewindable
  • auditok.io.BufferAudioSource
    • BufferAudioSource
  • auditok.io.WaveAudioSource
    • WaveAudioSource
  • auditok.io.PyAudioSource
    • PyAudioSource
  • auditok.io.StdinAudioSource
    • StdinAudioSource
  • auditok.io.PyAudioPlayer
    • PyAudioPlayer
  • auditok.io.from_file
    • from_file()
  • auditok.io.to_file
    • to_file()
  • auditok.io.player_for
    • player_for()
  • AudioSource
    • AudioSource.ch
    • AudioSource.channels
    • AudioSource.close()
    • AudioSource.is_open()
    • AudioSource.open()
    • AudioSource.read()
    • AudioSource.sample_width
    • AudioSource.sampling_rate
    • AudioSource.sr
    • AudioSource.sw
  • BufferAudioSource
    • BufferAudioSource.close()
    • BufferAudioSource.data
    • BufferAudioSource.is_open()
    • BufferAudioSource.open()
    • BufferAudioSource.position
    • BufferAudioSource.position_ms
    • BufferAudioSource.read()
    • BufferAudioSource.rewind()
  • PyAudioPlayer
  • PyAudioSource
    • PyAudioSource.close()
    • PyAudioSource.is_open()
    • PyAudioSource.open()
    • PyAudioSource.read()
  • RawAudioSource
    • RawAudioSource.open()
  • Rewindable
    • Rewindable.position
    • Rewindable.position_ms
    • Rewindable.position_s
    • Rewindable.rewind()
  • StdinAudioSource
    • StdinAudioSource.close()
    • StdinAudioSource.is_open()
    • StdinAudioSource.open()
  • WaveAudioSource
    • WaveAudioSource.open()
  • from_file()
  • player_for()
  • to_file()
• Signal processing

License

MIT.