
-------------------------------------------------------------------------
    
               ██████╗  ██████╗   ██████╗    █████╗    ██████╗
              ██╔════╝  ██╔══██╗  ██╔══██╗  ██╔══██╗  ██╔════╝
              ██████═╗  ██████╔╝  ██████╔╝  ███████║  ██████═╗
              ╚════██║  ██╔═══╝   ██╔═══╝   ██╔══██║  ╚════██║
              ██████ ║  ██║       ██║       ██║  ██║  ██████ ║
              ╚══════╝  ╚═╝       ╚═╝       ╚═╝  ╚═╝  ╚══════╝
                                                    
            the automatic annotation and analysis of speech
        
                Copyright (C) 2011-2024  Brigitte Bigi
        Laboratoire Parole et Langage, Aix-en-Provence, France
-------------------------------------------------------------------------

Overview

This is sppas module of the SPPAS software tool.

Use case

You have recorded audio and/or video files with speech, and you want to analyze some parameters you are interested in. You then need automatic or semi-automatic solutions allowing you to annotate the recordings. You also may want these files to be compatible with your favorite manual annotation tool.

SPPAS allows you to customize the automatic annotations to your own needs: you may implement your custom annotation solution.

Features

SPPAS is a pure Python, free, open-source software primarily utilized for the annotation, segmentation, and analysis of recordings, facilitating the study of various aspects of phonetics and linguistics.

SPPAS main page: https://sppas.org/
SPPAS package: https://sourceforge.net/projects/sppas

Content

sppas module includes the followings:

"config": Python package to configure the application;
"preinstall": Python package to install required and optional dependencies;
"src": the Python source code of SPPAS API - Application Programming Interface;
"ui": the User Interfaces, currently Terminal and Graphical ones;
"bin": the Python programs allowing to launch SPPAS features with the Command-Line UI;
"scripts": Python programs distributed without any warranty, they are not maintained;
"plugins": some plugins. Others can be downloaded from the website.
"tests": some of the unittest (currently under migration).
"docs": module and resources documentation

Classically, the po folder contains the translation messages, the docs folder contains some documentation, and, as always, the etc folder is the etcetera - with logos, JSON configuration files, etc.!

The API and UI are Object-Oriented Programming - OOP. Some of the packages contain a "yuml" file to be copied/paste at: https://www.yuml.me/. They are describing the class diagram of the package.

Quick start

Install

Create a virtual environment:


>python -m venv .sppaspyenv~

Below, the term "python" refers either to ".sppaspyenv~/bin/python" (Unix-based) or ".sppaspyenv~/Scripts/python.exe" (Windows).

The "base" dependencies can be installed with:


>python -m pip install .

Any dependency can be installed with the script "preinstall":


>python sppas/bin/preinstall.py -h

Help / How to contribute

If you plan to contribute to the code or to report a bug, please send an e-mail to the author. Any and all constructive comments are welcome.

License/Copyright

See the accompanying LICENSE and AUTHORS.md files for the full list of contributors.

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see https://www.gnu.org/licenses/.