Metadata-Version: 2.4
Name: cued-speech-fr
Version: 0.5.0
Summary: Cued Speech Processing Tools - Decode and Generate cued speech videos
Project-URL: Homepage, https://github.com/bouba-sow/cuedspeech
Project-URL: Documentation, https://github.com/bouba-sow/cuedspeech/blob/main/README.md
Project-URL: Repository, https://github.com/bouba-sow/cuedspeech
Project-URL: Bug Tracker, https://github.com/bouba-sow/cuedspeech/issues
Author-email: Boubacar Sow <boubasow.pro@gmail.com>
Maintainer-email: Boubacar Sow <boubasow.pro@gmail.com>
License-Expression: MIT
License-File: LICENSE
Keywords: accessibility,cued-speech,mediapipe,speech-recognition,video-processing,whisper
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Topic :: Multimedia :: Video
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: <3.12,>=3.11
Requires-Dist: absl-py>=2.3.1
Requires-Dist: click
Requires-Dist: flashlight-text>=0.0.7
Requires-Dist: imageio-ffmpeg>=0.4.9
Requires-Dist: kenlm>=0.3.0
Requires-Dist: mediapipe>=0.10.14
Requires-Dist: montreal-forced-aligner>=3.2.1
Requires-Dist: numpy<2.0,>=1.24
Requires-Dist: openai-whisper>=20250625
Requires-Dist: opencv-python<4.13,>=4.8.0
Requires-Dist: pandas<2.1,>=1.5.0
Requires-Dist: praatio<7,>=6.2.0
Requires-Dist: requests
Requires-Dist: tflite-runtime<3,>=2.14.0
Requires-Dist: torch==2.2.2
Requires-Dist: torchaudio==2.2.2
Requires-Dist: torchvision>=0.17.2
Provides-Extra: dev
Requires-Dist: black>=25.1.0; extra == 'dev'
Requires-Dist: flake8>=7.3.0; extra == 'dev'
Requires-Dist: isort>=6.0.1; extra == 'dev'
Requires-Dist: mypy>=1.17.1; extra == 'dev'
Requires-Dist: pytest>=8.4.1; extra == 'dev'
Provides-Extra: docs
Requires-Dist: sphinx; extra == 'docs'
Requires-Dist: sphinx-rtd-theme; extra == 'docs'
Description-Content-Type: text/markdown

# Cued Speech

Generate French cued speech videos (a hand is added next to the speaker's
face) and decode cued speech videos into subtitles.

## Install

Requires Python 3.11 and [pixi](https://pixi.sh) (used to install the
Montreal Forced Aligner).

```bash
mkdir cued-speech-env && cd cued-speech-env
pixi init
pixi add "python==3.11" montreal-forced-aligner=3.3.4
pixi run python -m pip install cued-speech-fr
pixi shell
```

## Generate a cued speech video

```bash
# Text transcribed automatically with Whisper
cued-speech generate video.mp4 --output_path out.mp4

# Or give the text yourself
cued-speech generate video.mp4 --skip-whisper --text "Bonjour tout le monde" --output_path out.mp4
```

Nothing else to download: the hand images ship with the package and the
French MFA models are downloaded automatically on first use.

Useful options: `--timing-model [rules|revised|attina|base]`,
`--no-morphing`, `--no-transparency`, `--debug-landmarks`
(see `cued-speech generate --help`).

From Python:

```python
from cued_speech import generate_cue

generate_cue(
    text="Bonjour tout le monde",  # or None to transcribe with Whisper
    video_path="video.mp4",
    output_path="out.mp4",
    config={"skip_whisper": True},
)
```

## Decode a cued speech video

```bash
cued-speech download-data   # models and test videos, into ./download
cued-speech decode --video_path video.mp4
```

## Credits

Hand positions, angles and transition timing follow the models published
by [Auto-CS](https://auto-cuedspeech.org) (B. Bigi, CNRS-LPL) and
V. Attina (2005), reimplemented independently.

## License

MIT. Contact: boubasow.pro@gmail.com
