Metadata-Version: 2.1
Name: speaking-clock-detection
Version: 1.0.0
Author: Anne Archibald
Author-email: David Doukhan <ddoukhan@ina.fr>, Cournapeau David <cournape@gmail.com>, Valentin Pelloin <vpelloin@ina.fr>
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Requires-Dist: soundfile
Requires-Dist: scipy
Requires-Dist: numpy

# Speaking Clock Detection

This tool can be used to detect on which channel a [speaking clock](https://en.wikipedia.org/wiki/Speaking_clock) is present. It only works on stereo audio files, where either the left or right channel contain only the speaking clock. This tool has only been tested with the French official Speaking Clock.

## Installation

```bash
pip3 install speaking-clock-detection
```

## Usage

The help is available with the following command:
```bash
speaking_clock_detection --help
```

The tool can be used like this:
```bash
speaking_clock_detection \
	--media /file/to/detect/speaking_clock.wav
```

It will output one of the three following values:
- `SPEAKING_CLOCK_TRACK` followed by the channel track id (typically 0 or 1)
- `SPEAKING_CLOCK_NONE` if no speaking clock has been detected
- `SPEAKING_CLOCK_MULTIPLE` if multiple speaking clocks have been detected (this is usally an error)

