revoxx 1.0.0.dev5__tar.gz

revoxx-1.0.0.dev5/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

revoxx-1.0.0.dev5/MANIFEST.in

@@ -0,0 +1,8 @@
+include README.md
+include LICENSE
+include requirements.txt
+recursive-include revoxx/resources *
+recursive-include revoxx/resources/templates *
+global-exclude __pycache__
+global-exclude *.py[co]
+global-exclude .DS_Store

revoxx-1.0.0.dev5/PKG-INFO

@@ -0,0 +1,301 @@
+Metadata-Version: 2.4
+Name: revoxx
+Version: 1.0.0.dev5
+Summary: Speech recording application for creating high-quality speech datasets
+Author-email: Grammatek ehf <info@grammatek.com>
+Maintainer-email: Grammatek ehf <info@grammatek.com>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/icelandic-lt/revoxx
+Project-URL: Documentation, https://github.com/icelandic-lt/revoxx#readme
+Project-URL: Repository, https://github.com/icelandic-lt/revoxx
+Project-URL: Issues, https://github.com/icelandic-lt/revoxx/issues
+Keywords: speech,recording,tts,dataset,audio,voice,emotional-speech
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Science/Research
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Topic :: Multimedia :: Sound/Audio :: Capture/Recording
+Classifier: Topic :: Multimedia :: Sound/Audio :: Speech
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: setuptools>=60.0.0
+Requires-Dist: numpy<2.0.0,>=1.20.0; python_version < "3.10"
+Requires-Dist: numpy<2.0.0,>=1.23.0; python_version == "3.10.*"
+Requires-Dist: numpy>=1.24.0; python_version >= "3.11"
+Requires-Dist: matplotlib>=3.5.0
+Requires-Dist: librosa<0.10.0,>=0.9.0; python_version < "3.10"
+Requires-Dist: librosa<0.11.0,>=0.10.0; python_version == "3.10.*"
+Requires-Dist: librosa>=0.10.1; python_version >= "3.11"
+Requires-Dist: scipy<1.11.0,>=1.7.0; python_version < "3.10"
+Requires-Dist: scipy>=1.9.0; python_version >= "3.10"
+Requires-Dist: sounddevice>=0.4.0
+Requires-Dist: soundfile>=0.12.0
+Requires-Dist: tqdm>=4.65.0
+Provides-Extra: vad
+Requires-Dist: torch>=2.0.0; extra == "vad"
+Requires-Dist: silero-vad>=5.0; extra == "vad"
+Provides-Extra: dev
+Requires-Dist: black>=22.0.0; extra == "dev"
+Requires-Dist: isort>=5.10.0; extra == "dev"
+Requires-Dist: flake8>=6.0.0; extra == "dev"
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: pytest-cov>=3.0.0; extra == "dev"
+Dynamic: license-file
+
+# Revoxx - Record Voices
+
+This repository provides **Revoxx**, a graphical recording application for recording raw speech and generating datasets.
+
+![Version](https://img.shields.io/badge/Version-main-darkgreen)
+![Python](https://img.shields.io/badge/python-3.9-blue?logo=python&logoColor=white)
+![Python](https://img.shields.io/badge/python-3.10-blue?logo=python&logoColor=white)
+![Python](https://img.shields.io/badge/python-3.11-blue?logo=python&logoColor=white)
+[![CI Status](https://github.com/icelandic-lt/revoxx/actions/workflows/build.yml/badge.svg)](https://github.com/icelandic-lt/revoxx/actions/workflows/build.yml)
+![Docker](https://img.shields.io/badge/Docker-[unavailable]-red)
+
+## Overview
+
+**Revoxx** has been created by [Grammatek ehf](https://www.grammatek.com) and is part of the [Icelandic Language Technology Programme](https://github.com/icelandic-lt/icelandic-lt).
+
+- **Category:** [TTS](https://github.com/icelandic-lt/icelandic-lt/blob/main/doc/tts.md)
+- **Domain:** Laptop/Workstation
+- **Languages:** Python
+- **Language Version/Dialect:**
+  - Python: 3.9, 3.10, 3.11
+- **Audience**: Developers, Researchers
+- **Origins:** [Icelandic EmoSpeech scripts](https://github.com/icelandic-lt/emospeech-scripts)
+
+## Status
+![Production](https://img.shields.io/badge/Production-darkgreen)
+
+## System Requirements
+- **Operating System:** Linux/OS-X, should work on Windows
+- **Recording:** Audio Interface, good voice microphone and headphones
+
+## Description
+
+**Revoxx** is a graphical speech recorder specialized in recording TTS datasets quickly and reliably.<br>
+You can use this project to create emotional / non-emotional voice recordings on a Workstation / Laptop with suitable audio equipment.
+It has integrated support to easily transform raw recordings into datasets for training TTS voice models.<br>
+This tool is especially useful for recording many short utterances - up to an utterance duration of approx. 30-45 secs each.
+For longer texts, you need to split your input texts in appropriately sized chunks that would fit on the speaker screen.
+<br>
+**Revoxx** has been inspired by [Icelandic EmoSpeech scripts](https://github.com/icelandic-lt/emospeech-scripts), but has been vastly improved and is rewritten from scratch.<br>
+
+**Screenshot:**
+
+<img src="doc/screenshot1.png" alt="screenshot1" width="100%"/>
+
+We have condensed our experience from when we recorded [Talrómur 3](https://repository.clarin.is/repository/xmlui/handle/20.500.12537/344),
+the Icelandic emotional speech dataset, and created this tool to minimize hassle, valuable recording & post-processing time.
+
+- **Revoxx** makes recording of speech **fast, reliable and convenient for the recording engineer and the voice talent**
+  - Integrates all necessary tools to check if recordings & equipment meet your expected requirements
+  - Automatically analyzes and validates audio equipment compatibility, including Sample Rate, Bit Depth, and I/O
+    channel configurations
+  - Supports unlimited re-recording while maintaining a complete **archive of raw recordings**, even for deleted content
+  - Text size is automatically adjusted according to available screen real-estate
+  - **Intuitive keyboard shortcuts** for accessing core functionalities
+- Recordings are organized into **Recording Sessions**
+  - Record emotional sessions for each speaker or record more traditional LJSpeech-style sessions
+  - Seamless transitions between different recording sessions with automatic progress tracking: continue where you left-off
+  - Offers advanced search and navigation capabilities for utterances, with flexible sorting by label, emotion, text
+    content, and recorded takes
+  - Consistent audio settings & metadata for all recordings
+- **Real-time monitoring** including toggable recording levels, mel spectrograms, maximum frequency detection, and more
+  - Customizable **industry-standard presets for Peak/RMS levels**
+  - Dedicated **Monitoring mode** for precise input calibration
+- **Multi-Screen Support**
+  - You can use multiple monitors to **separate recording view from speaker view**
+  - We support Apple's "Continuity" feature for a **convenient dual screen setup with an external iPad**
+  - Each screen appearance can be individually configured
+  - All screen layouts, placement & configuration is preserved at exit
+- Export Dataset
+  - Facilitates **batch export of multiple sessions** into T3 (Talrómur3) dataset format
+  - Groups different recording sessions of the same speaker into a common dataset
+
+## Installation
+
+<details>
+<summary><b>Basic Installation</b></summary>
+
+### Using uv
+
+[uv](https://github.com/astral-sh/uv) is a fast Python package installer and resolver:
+
+```bash
+uv pip install revoxx         # From PyPI
+uv pip install .              # From source
+uv pip install revoxx[vad]    # With VAD support
+```
+
+### Using pip
+
+```bash
+pip install revoxx           # From PyPI
+pip install .                # From source
+pip install revoxx[vad]      # With VAD support
+```
+
+### From source
+
+```bash
+git clone https://github.com/icelandic-lt/revoxx.git
+cd revoxx
+# Then use either uv or pip as shown above
+```
+
+### With Voice Activity Detection (VAD)
+
+The VAD functionality requires PyTorch (~2GB). Install it separately if needed:
+
+```bash
+uv pip install revoxx[vad]  # Using uv
+# or
+pip install revoxx[vad]     # Using pip
+```
+
+</details>
+
+<details>
+<summary><b>Development Setup</b></summary>
+
+### For development
+
+#### Using uv (recommended - faster)
+
+```bash
+git clone https://github.com/icelandic-lt/revoxx.git
+cd revoxx
+
+# Create and activate virtual environment
+uv venv
+source .venv/bin/activate  # On Windows: .venv\Scripts\activate
+
+# Install in editable mode with dev dependencies
+uv pip install -e .[dev]
+# With VAD support:
+uv pip install -e .[dev,vad]
+```
+
+#### Using pip (traditional)
+
+```bash
+git clone https://github.com/icelandic-lt/revoxx.git
+cd revoxx
+
+# Create and activate virtual environment
+python3 -m venv venv
+source venv/bin/activate  # On Windows: venv\Scripts\activate
+
+# Install in editable mode with dev dependencies
+pip install -e .[dev]
+# With VAD support:
+pip install -e .[dev,vad]
+```
+
+Development dependencies include:
+- **black**: Code formatter
+- **isort**: Import statement organizer
+- **flake8**: Code linter
+- **pytest**: Testing framework
+- **pytest-cov**: Code coverage reporting
+
+### Running code quality checks
+
+```bash
+# Format code
+black revoxx/ scripts_module/ tests/
+
+# Check code style
+flake8 revoxx/ scripts_module/ tests/
+
+# Run tests
+pytest tests/
+
+# Run tests with coverage
+pytest tests/ --cov=revoxx --cov-report=html
+```
+
+</details>
+
+## Running Revoxx
+
+### After installation
+
+Once installed, you can run Revoxx using:
+
+```bash
+revoxx
+```
+
+### During development (without installation)
+
+Run as a Python module:
+
+```bash
+python -m revoxx
+```
+
+### In PyCharm or other IDEs
+
+Configure your run configuration with:
+- **Module name**: `revoxx` (not script path)
+- **Working directory**: Project root directory
+
+### Command-line tools
+
+The package includes additional utilities:
+
+```bash
+revoxx-export    # Export sessions to dataset format
+revoxx-vadiate   # Voice Activity Detection tool (requires [vad] option)
+```
+
+**Note:** The `revoxx-vadiate` tool requires the VAD dependencies. Install with `pip install revoxx[vad]` or `pip install .[vad]` to use this tool.
+
+### Command-line arguments
+
+```bash
+revoxx --help                    # Show all available options
+revoxx --show-devices            # List available audio devices
+revoxx --session path/to/session # Open specific session
+```
+
+## Prepare recordings
+
+Before you start recording, you should prepare a script with the utterances you want to record.
+The script should be a simple text file with one utterance per line. The utterances can be in any language you want.
+
+A script file follows Festival-style and has the following possible two formats:
+
+For a script with emotion levels:
+
+```text
+( <unique id> "<emotion-level>: <utterance>" )
+```
+
+For a script without emotion levels. This format was used for recording our non-emotional "addendas":
+
+```text
+( <unique id> "<utterance>" )
+```
+
+You can see for both formats an example in the directory [scripts](scripts).
+
+The emotion levels can be from any monotonic numerical value range you want. If you want to follow Talrómur 3 dataset conventions, you can use emotion levels 0-5 for 6 emotions: neutral, happy, sad, angry, surprised, and helpful.
+The emotion levels are used to control the emotion intensity of the speech in combination with the specific emotion.
+Neutral speech corresponds to emotion level 0.
+
+## Record dataset
+
+to be defined
+
+## Acknowledgements
+This project is part of the program Language Technology for Icelandic. The program was funded by the Icelandic Ministry of Culture and Business Affairs.