Skip to main content

Prosody stylization

Project description

CoPaSul - Contour-based, parametric, and superpositional intonation stylization

Author

  • Uwe Reichel, Research Institute for Linguistics, Hungarian Academy of Sciences, Budapest

Purpose: Prosodic Feature extraction

  • Intonation
    • Global f0 register
    • Local f0 shapes
    • Prosodic boundaries
  • Energy
  • Rhythm
  • Voice quality

Dependencies

  • Python: >= 3.8
  • Packages: see requirements.txt
  • tested for Linux and Python 3.8, and 3.10

Installation

From PyPI

  • set up a virtual environment venv_copasul, activate it, and install copasul. For Linux this works e.g. as follows:
$ virtualenv --python="/usr/bin/python3" venv_copasul
$ source venv_copasul/bin/activate
(venv_copasul) $ pip install copasul

From GitHub

$ git clone git@github.com:reichelu/copasul.git
$ cd copasul/
$ virtualenv --python="/usr/bin/python3" venv_copasul
$ source venv_copasul/bin/activate
(venv_copasul) $ pip install -r requirements.txt

Usage

Required files

  • audio (wav), f0, pulse, and annotation files (Textgrid), see on GitHub: tests/minex/input
    • f0 and pulse files can be generated with the help of the praat scripts on Github: scripts/*praat
  • a config file (json), see on GitHub tests/minex/config/minex.json
    • see on Github docs/copasul_commented_config.json.txt and the article for further details

Call from terminal (if cloned from GitHub)

  • see on GitHub project page scripts/run_copasul.py [-c myConfigFile.json]
  • PROJECT_DIR: directory where GitHub project has been cloned
(venv_copasul) $ cd PROJECT_DIR/scripts/
(venv_copasul) $ python run_copasul.py -c ../tests/minex/config/minex.json
  • if you use ../tests/minex/config/minex.json as config file, CoPaSul
    • processes the files in ../tests/minex/input/, and
    • outputs feature tables to ../tests/minex/output/test.FEATURESET.{csv, R}
    • outputs the CoPaSul output dict to ../tests/minex/output/test.pickle
    • this output dict can be used for further (warm start) processing
  • if you use your own config file, make sure, that all directories in fsys:*:dir are either absolute paths or relative paths relative to your config file

Example integration into python code

import json
import pickle
import sys

# add this line if you use the cloned code from GitHub
# sys.path.append(PROJECT_DIR)

from copasul import copasul

# feature extractor
fex = copasul.Copasul()

# processing based on config file
config_file = MYCONFIGFILE.json
copa = fex.process(config=config_file)

# processing based on config dict
with open(config_file, 'r') as h:
    config_dict = json.load(h)
copa = fex.process(config=config_dict)

# warm start: continue processing
#   - implicit loading from config
config_dict["navigate"]["from_scratch"] = False
config_dict["navigate"]["overwrite_config"] = True
#     ... change further navigation values to your needs
copa_further_processed = fex.process(config=config_dict)

#   - explicit loading from file
copa_file = MYCOPASULOUTPUT.pickle
config_dict["navigate"]["overwrite_config"] = True
#     ... change further navigation values to your needs
with open(copa_file, "rb") as h:
   copa = pickle.load(h)
copa_further_processed = fex.process(config=config_dict, copa=copa)

Material

Reference

Reichel, U.D. (2017). CoPaSul Manual: Contour-based, parametric, and superpositional intonation stylization, arXiv:1612.04765.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

copasul-1.4.0.tar.gz (132.0 kB view hashes)

Uploaded Source

Built Distribution

copasul-1.4.0-py3-none-any.whl (128.9 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page