Parselmouth

https://github.com/yannickjadoul/parselmouth
Admin
Parselmouth is a Python library that provides a Pythonic interface to Praat's speech processing...
Tokens:104,978
Snippets:1,202
Trust Score:8.5
License:GPL-3.0
Update:1 month ago
Show doc for...
Tokens:
Raw
### Install Project Targets

Source: https://github.com/yannickjadoul/parselmouth/blob/master/pybind11/CMakeLists.txt

Installs the project headers, configuration files, and exports the targets.

```cmake
install(
    FILES ${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}Config.cmake
          ${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}ConfigVersion.cmake
          tools/FindPythonLibsNew.cmake
          tools/pybind11Common.cmake
          tools/pybind11Tools.cmake
          tools/pybind11NewTools.cmake
    DESTINATION ${PYBIND11_CMAKECONFIG_INSTALL_DIR})

  if(NOT PYBIND11_EXPORT_NAME)
    set(PYBIND11_EXPORT_NAME "${PROJECT_NAME}Targets")
  endif()

  install(TARGETS pybind11_headers EXPORT "${PYBIND11_EXPORT_NAME}")

  install(
    EXPORT "${PYBIND11_EXPORT_NAME}"
    NAMESPACE "pybind11::"
    DESTINATION ${PYBIND11_CMAKECONFIG_INSTALL_DIR})
```

--------------------------------

### Install pybind11 via vcpkg

Source: https://github.com/yannickjadoul/parselmouth/blob/master/pybind11/docs/installing.rst

Use the Microsoft vcpkg dependency manager to clone and install the library.

```bash
git clone https://github.com/Microsoft/vcpkg.git
cd vcpkg
./bootstrap-vcpkg.sh
./vcpkg integrate install
vcpkg install pybind11
```

--------------------------------

### Install pybind11 via PyPI

Source: https://github.com/yannickjadoul/parselmouth/blob/master/pybind11/docs/installing.rst

Install pybind11 using pip. The global variant is recommended only for virtual environments.

```bash
pip install pybind11
```

```bash
pip install "pybind11[global]"
```

--------------------------------

### Test praat_barren installation

Source: https://github.com/yannickjadoul/parselmouth/blob/master/praat/README.md

Verify the installation of the barren build by checking the version.

```bash
# on Ubuntu command line
praatb --version
```

--------------------------------

### Test praat_nogui installation

Source: https://github.com/yannickjadoul/parselmouth/blob/master/praat/README.md

Verify the installation of the no-GUI build by checking the version.

```bash
# on Ubuntu command line
praatn --version
```

--------------------------------

### Install build dependencies on Ubuntu

Source: https://github.com/yannickjadoul/parselmouth/blob/master/praat/README.md

Install the necessary build tools and graphics/sound libraries required for compiling Praat.

```bash
sudo apt install make gcc g++ rsync pkg-config
sudo apt install libgtk-3-dev
sudo apt install libasound2-dev
sudo apt install libpulse-dev
sudo apt install libjack-dev
```

--------------------------------

### Project and Module Path Setup

Source: https://github.com/yannickjadoul/parselmouth/blob/master/pybind11/tests/CMakeLists.txt

Initializes the project and adds the tools directory to the CMake module path.

```cmake
project(pybind11_tests CXX)

# Access FindCatch and more
list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_LIST_DIR}/../tools")
```

--------------------------------

### Usage Example

Source: https://github.com/yannickjadoul/parselmouth/blob/master/praat/generate/Unicode/gen-unicode-ctype.c.html

Command line usage for the gen-unicode utility.

```bash
$ gen-unicode /usr/local/share/Unidata/UnicodeData.txt 3.1
```

--------------------------------

### Binding functional examples

Source: https://github.com/yannickjadoul/parselmouth/blob/master/pybind11/docs/advanced/cast/functional.rst

Exposing the functional examples to Python using the pybind11 module definition.

```cpp
#include <pybind11/functional.h>

PYBIND11_MODULE(example, m) {
    m.def("func_arg", &func_arg);
    m.def("func_ret", &func_ret);
    m.def("func_cpp", &func_cpp);
}
```

--------------------------------

### Basic CMake Configuration

Source: https://github.com/yannickjadoul/parselmouth/blob/master/pybind11/docs/compiling.rst

Standard setup for a pybind11 project using find_package.

```cmake
cmake_minimum_required(VERSION 3.4...3.18)
project(example LANGUAGES CXX)

find_package(pybind11 REQUIRED)
pybind11_add_module(example example.cpp)
```

--------------------------------

### Import setup_helpers from a submodule

Source: https://github.com/yannickjadoul/parselmouth/blob/master/pybind11/docs/compiling.rst

Dynamically add a local pybind11 submodule path to sys.path to import setup helpers.

```python
DIR = os.path.abspath(os.path.dirname(__file__))

sys.path.append(os.path.join(DIR, "extern", "pybind11"))
from pybind11.setup_helpers import Pybind11Extension  # noqa: E402

del sys.path[-1]
```

--------------------------------

### Define Build Options

Source: https://github.com/yannickjadoul/parselmouth/blob/master/pybind11/CMakeLists.txt

Sets user-configurable options for installation, testing, and Python integration.

```cmake
option(PYBIND11_INSTALL "Install pybind11 header files?" ${PYBIND11_MASTER_PROJECT})
option(PYBIND11_TEST "Build pybind11 test suite?" ${PYBIND11_MASTER_PROJECT})
option(PYBIND11_NOPYTHON "Disable search for Python" OFF)

cmake_dependent_option(
  USE_PYTHON_INCLUDE_DIR
  "Install pybind11 headers in Python include directory instead of default installation prefix"
  OFF "PYBIND11_INSTALL" OFF)

cmake_dependent_option(PYBIND11_FINDPYTHON "Force new FindPython" OFF
                       "NOT CMAKE_VERSION VERSION_LESS 3.12" OFF)
```

--------------------------------

### Verify Installation in PsychoPy

Source: https://github.com/yannickjadoul/parselmouth/blob/master/docs/installation.rst

Use this command in the PsychoPy Coder shell to confirm the library is correctly installed.

```python
import parselmouth
```

--------------------------------

### Install Parselmouth from Python

Source: https://github.com/yannickjadoul/parselmouth/blob/master/docs/installation.rst

Programmatically trigger a pip installation using the current Python interpreter's path.

```python
>>> import sys, subprocess
>>> subprocess.call([sys.executable, '-m', 'pip', 'install', 'praat-parselmouth'])
```

--------------------------------

### Install pybind11 via Homebrew

Source: https://github.com/yannickjadoul/parselmouth/blob/master/pybind11/docs/installing.rst

Use the brew package manager on macOS or Linux to install the pybind11 package.

```bash
brew install pybind11
```

--------------------------------

### Configure Installation Directory

Source: https://github.com/yannickjadoul/parselmouth/blob/master/pybind11/CMakeLists.txt

Sets the installation directory for include files based on the detected Python include path.

```cmake
if(USE_PYTHON_INCLUDE_DIR AND DEFINED Python_INCLUDE_DIRS)
  file(RELATIVE_PATH CMAKE_INSTALL_INCLUDEDIR ${CMAKE_INSTALL_PREFIX} ${Python_INCLUDE_DIRS})
elseif(USE_PYTHON_INCLUDE_DIR AND DEFINED PYTHON_INCLUDE_DIR)
  file(RELATIVE_PATH CMAKE_INSTALL_INCLUDEDIR ${CMAKE_INSTALL_PREFIX} ${PYTHON_INCLUDE_DIRS})
endif()
```

--------------------------------

### Handle setup_requires for legacy Pip versions

Source: https://github.com/yannickjadoul/parselmouth/blob/master/pybind11/docs/compiling.rst

Use a try-except block to allow setup.py to function when pybind11 is not yet installed in the environment.

```python
try:
    from pybind11.setup_helpers import Pybind11Extension
except ImportError:
    from setuptools import Extension as Pybind11Extension
```

--------------------------------

### Installing pybind11 via CMake

Source: https://github.com/yannickjadoul/parselmouth/blob/master/pybind11/docs/compiling.rst

Commands to install pybind11 from source using classic or modern CMake workflows.

```bash
# Classic CMake
cd pybind11
mkdir build
cd build
cmake ..
make install

# CMake 3.15+
cd pybind11
cmake -S . -B build
cmake --build build -j 2  # Build on 2 cores
cmake --install build
```

--------------------------------

### Canonical Combining Class Alias Examples

Source: https://github.com/yannickjadoul/parselmouth/blob/master/praat/generate/Unicode/UAX 

Example entries from PropertyValueAliases.txt demonstrating numeric values mapped to abbreviated and long symbolic name aliases.

```text
ccc; 230; A    ; Above
ccc; 232; AR   ; Above_Right
```

--------------------------------

### NormalizationTest.txt segment delimiter example

Source: https://github.com/yannickjadoul/parselmouth/blob/master/praat/generate/Unicode/UAX 

Example of a line starting with an '@' sign used to distinguish segments in test data files.

```text
@Part1 # Character by character test
```

--------------------------------

### Test Environment Setup

Source: https://github.com/yannickjadoul/parselmouth/blob/master/pybind11/tests/test_embed/CMakeLists.txt

Copies the Python test script to the binary directory and defines the custom test execution target.

```cmake
if(NOT CMAKE_CURRENT_SOURCE_DIR STREQUAL CMAKE_CURRENT_BINARY_DIR)
  file(COPY test_interpreter.py DESTINATION "${CMAKE_CURRENT_BINARY_DIR}")
endif()

add_custom_target(
  cpptest
  COMMAND "$<TARGET_FILE:test_embed>"
  WORKING_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}")
```

--------------------------------

### Create a complete binding module

Source: https://github.com/yannickjadoul/parselmouth/blob/master/pybind11/docs/basics.rst

Full example of a C++ file defining a function and its corresponding Python module binding.

```cpp
#include <pybind11/pybind11.h>

int add(int i, int j) {
    return i + j;
}

PYBIND11_MODULE(example, m) {
    m.doc() = "pybind11 example plugin"; // optional module docstring

    m.def("add", &add, "A function which adds two numbers");
}
```

--------------------------------

### Deprecation Warning Example

Source: https://github.com/yannickjadoul/parselmouth/blob/master/pybind11/docs/upgrade.rst

Example of the runtime warning message displayed in debug mode when using deprecated placement-new constructors.

```none
pybind11-bound class 'mymodule.Foo' is using an old-style placement-new '__init__'
which has been deprecated. See the upgrade guide in pybind11's docs.
```

--------------------------------

### Example pybind11 class binding

Source: https://github.com/yannickjadoul/parselmouth/blob/master/pybind11/docs/benchmark.rst

Demonstrates the structure of a C++ class and its corresponding pybind11 module binding code used in the benchmark.

```cpp
...
class cl034 {
public:
    cl279 *fn_000(cl084 *, cl057 *, cl065 *, cl042 *);
    cl025 *fn_001(cl098 *, cl262 *, cl414 *, cl121 *);
    cl085 *fn_002(cl445 *, cl297 *, cl145 *, cl421 *);
    cl470 *fn_003(cl200 *, cl323 *, cl332 *, cl492 *);
};
...

PYBIND11_MODULE(example, m) {
    ...
    py::class_<cl034>(m, "cl034")
        .def("fn_000", &cl034::fn_000)
        .def("fn_001", &cl034::fn_001)
        .def("fn_002", &cl034::fn_002)
        .def("fn_003", &cl034::fn_003)
    ...
}
```

--------------------------------

### Example set of Script_Extensions sets

Source: https://github.com/yannickjadoul/parselmouth/blob/master/praat/generate/Unicode/UAX 

A representation of the set of sets that constitute meaningful values for the Script_Extensions property.

```text
{{Adlm, Arab, Mand, Mani, Phlp, Rohg, Sogd, Syrc}, {Arab, Copt}, {Arab, Rohg}, {Arab, Syrc}, {Arab, Thaa}, {Arab, Syrc, Thaa}, {Armn, Geor}, ...}
```

--------------------------------

### Splitting binding code across multiple files

Source: https://github.com/yannickjadoul/parselmouth/blob/master/pybind11/docs/faq.rst

Example structure for splitting pybind11 modules into multiple files to improve build times.

```cpp
void init_ex1(py::module_ &);
void init_ex2(py::module_ &);
/* ... */

PYBIND11_MODULE(example, m) {
    init_ex1(m);
    init_ex2(m);
    /* ... */
}
```

```cpp
void init_ex1(py::module_ &m) {
    m.def("add", [](int a, int b) { return a + b; });
}
```

```cpp
void init_ex2(py::module_ &m) {
    m.def("sub", [](int a, int b) { return a - b; });
}
```

--------------------------------

### East Asian Width Property Aliases

Source: https://github.com/yannickjadoul/parselmouth/blob/master/praat/generate/Unicode/UAX 

Example lines from PropertyValueAliases.txt defining the East_Asian_Width property values.

```text
# East_Asian_Width (ea)

ea ; A         ; Ambiguous
ea ; F         ; Fullwidth
ea ; H         ; Halfwidth
ea ; N         ; Neutral
ea ; Na        ; Narrow
ea ; W         ; Wide
```

--------------------------------

### Python Environment and Test Target Setup

Source: https://github.com/yannickjadoul/parselmouth/blob/master/pybind11/tests/test_cmake_build/installed_function/CMakeLists.txt

Determines the Python executable and creates a custom target to run verification tests.

```cmake
if(DEFINED Python_EXECUTABLE)
  set(_Python_EXECUTABLE "${Python_EXECUTABLE}")
elseif(DEFINED PYTHON_EXECUTABLE)
  set(_Python_EXECUTABLE "${PYTHON_EXECUTABLE}")
else()
  message(FATAL_ERROR "No Python executable defined (should not be possible at this stage)")
endif()

add_custom_target(
  check_installed_function
  ${CMAKE_COMMAND}
  -E
  env
  PYTHONPATH=$<TARGET_FILE_DIR:test_installed_function>
  ${_Python_EXECUTABLE}
  ${PROJECT_SOURCE_DIR}/../test.py
  ${PROJECT_NAME})
```

--------------------------------

### Code Point Labels

Source: https://github.com/yannickjadoul/parselmouth/blob/master/praat/generate/Unicode/UAX 

Example of using code point labels for characters without formal names.

```text
2065          ; Default_Ignorable_Code_Point # Cn       <reserved-2065>
```

--------------------------------

### Example of a Derived Property Definition

Source: https://github.com/yannickjadoul/parselmouth/blob/master/praat/generate/Unicode/UAX 

A representation of how the ID_Start property is derived using set operations on other character properties.

```text
# Derived Property: ID_Start
#  Characters that can start an identifier.
#  Generated from:
#      Lu + Ll + Lt + Lm + Lo + Nl
#    + Other_ID_Start
#    - Pattern_Syntax
#    - Pattern_White_Space
```

--------------------------------

### Main Entry Point

Source: https://github.com/yannickjadoul/parselmouth/blob/master/praat/generate/Unicode/gen-unicode-ctype.c.html

Initializes the program and validates command-line arguments.

```c
int
main (int argc, char * argv[])
{
if (argc != 3)
{
```

--------------------------------

### Defining Code Point Ranges

Source: https://github.com/yannickjadoul/parselmouth/blob/master/praat/generate/Unicode/UAX 

Examples of range specifications using the X..Y format and the legacy First/Last convention.

```text
0000..007F; Basic Latin
0080..00FF; Latin-1 Supplement
```

```text
4E00;<CJK Ideograph, First>;Lo;0;L;;;;;N;;;;;
9FEF;<CJK Ideograph, Last>;Lo;0;L;;;;;N;;;;;
```

--------------------------------

### Representing kCantonese property values

Source: https://github.com/yannickjadoul/parselmouth/blob/master/praat/generate/Unicode/UAX 

Example of a kCantonese property entry in the Unihan Database representing a set of pronunciation strings.

```text
U+342B	kCantonese	gun3 hung1 zung1
```

--------------------------------

### Perform manual packaging and upload

Source: https://github.com/yannickjadoul/parselmouth/blob/master/pybind11/docs/release.rst

Build source distributions and wheels locally, then upload them to PyPI using twine.

```bash
python3 -m pip install build
python3 -m build
PYBIND11_SDIST_GLOBAL=1 python3 -m build
twine upload dist/*
```

--------------------------------

### UCD Comment Formatting

Source: https://github.com/yannickjadoul/parselmouth/blob/master/praat/generate/Unicode/UAX 

Examples of comment usage in UCD files, including General_Category values, range indicators, and L& aliases.

```text
09B2          ; Bengali # Lo       BENGALI LETTER LA
```

```text
0386          ; Greek # L&       GREEK CAPITAL LETTER ALPHA WITH TONOS
```

```text
00BC..00BE    ; Numeric # No   [3] VULGAR FRACTION ONE QUARTER..VULGAR FRACTION THREE QUARTERS
```

--------------------------------

### Script Property Default Value Comment

Source: https://github.com/yannickjadoul/parselmouth/blob/master/praat/generate/Unicode/UAX 

Example of a comment block in Scripts.txt indicating the default value for unlisted code points.

```text
#  All code points not explicitly listed for Script
#  have the value Unknown (Zzzz).
```

--------------------------------

### Initialize Mock PsychoPy Components

Source: https://github.com/yannickjadoul/parselmouth/blob/master/docs/examples/psychopy_experiments.ipynb

Sets up mock classes for Trials, Sound, and Keyboard components to simulate the PsychoPy environment for testing.

```python
# 'filename' variable is also set by PsychoPy and contains base file name of saved log/output files
filename = "data/participant_staircase_23032017"

# PsychoPy also create a Trials object, containing e.g. information about the current iteration of the loop
# So let's quickly fake this, in this example, such that the code can be executed without errors
# In PsychoPy this would be a `psychopy.data.TrialHandler` (https://www.psychopy.org/api/data.html#psychopy.data.TrialHandler)
class MockTrials:
    def addResponse(self, response):
        print("Registering that this trial was {}successful".format("" if response else "un"))
trials = MockTrials()
trials.thisTrialN = 5 # We only need the 'thisTrialN' attribute of the 'trials' variable

# The Sound component can also be accessed by it's name, so let's quickly mock that as well
# In PsychoPy this would be a `psychopy.sound.Sound` (https://www.psychopy.org/api/sound.html#psychopy.sound.Sound)
class MockSound:
    def setSound(self, file_name):
        print("Setting audio file of Sound component to '{}'".format(file_name))
sound_1 = MockSound()

# And the same for our Keyboard component, `key_resp_2`:
class MockKeyboard:
    pass
key_resp_2 = MockKeyboard()

# Finally, let's also seed the random module to have a consistent output across different runs
random.seed(42)
```

--------------------------------

### Initialize Project and Includes

Source: https://github.com/yannickjadoul/parselmouth/blob/master/pybind11/CMakeLists.txt

Defines the project name, language, and version, and includes standard CMake utility modules.

```cmake
project(
  pybind11
  LANGUAGES CXX
  VERSION "${PYBIND11_VERSION_MAJOR}.${PYBIND11_VERSION_MINOR}.${PYBIND11_VERSION_PATCH}")

# Standard includes
include(GNUInstallDirs)
include(CMakePackageConfigHelpers)
include(CMakeDependentOption)

if(NOT pybind11_FIND_QUIETLY)
  message(STATUS "pybind11 v${pybind11_VERSION} ${pybind11_VERSION_TYPE}")
endif()
```

--------------------------------

### Install pybind11 via conda-forge

Source: https://github.com/yannickjadoul/parselmouth/blob/master/pybind11/docs/installing.rst

Use the conda package manager to install pybind11 from the conda-forge channel.

```bash
conda install -c conda-forge pybind11
```

--------------------------------

### Install Parselmouth via pip

Source: https://github.com/yannickjadoul/parselmouth/blob/master/docs/installation.rst

Use the module flag to ensure the package is installed for the correct Python interpreter.

```bash
python -m pip install praat-parselmouth
```

--------------------------------

### Install and Update Parselmouth via pip

Source: https://github.com/yannickjadoul/parselmouth/blob/master/docs/installation.rst

Standard commands to install or upgrade the library using the Python package manager.

```bash
pip install praat-parselmouth
```

```bash
pip install -U praat-parselmouth
```

--------------------------------

### Compile and test on Windows

Source: https://github.com/yannickjadoul/parselmouth/blob/master/pybind11/docs/basics.rst

Command line instructions for building and testing using CMake on Windows.

```batch
mkdir build
cd build
cmake ..
cmake --build . --config Release --target check
```

--------------------------------

### Define a Pybind11Extension in setup.py

Source: https://github.com/yannickjadoul/parselmouth/blob/master/pybind11/docs/compiling.rst

Use Pybind11Extension to define C++ extensions within a standard setup.py file.

```python
from glob import glob
from setuptools import setup
from pybind11.setup_helpers import Pybind11Extension

ext_modules = [
    Pybind11Extension(
        "python_example",
        sorted(glob("src/*.cpp")),  # Sort source files for reproducibility
    ),
]

setup(
    ...,
    ext_modules=ext_modules
)
```

--------------------------------

### Configure FLAC header includes

Source: https://github.com/yannickjadoul/parselmouth/blob/master/praat/external/flac/READ_ME.TXT

Replace standard config headers with project-specific flac_config.h in C files.

```c
#  include <config.h>
#endif
```

```c
//ppgb #if HAVE_CONFIG_H
#include "flac_config.h"
//ppgb #endif
```

--------------------------------

### Type Casting

Source: https://github.com/yannickjadoul/parselmouth/blob/master/praat/external/espeak/ESPEAK_NG_READ_ME.TXT

Example of an explicit cast used in the source code.

```cpp
static_cast<espeak_ng_STATUS> (errno)
```

--------------------------------

### Execute Build and Transfer

Source: https://github.com/yannickjadoul/parselmouth/blob/master/praat/README.md

Run this command on the Ubuntu command line to build the project and sync it to the intermediary computer.

```bash
praatc-mid
```

--------------------------------

### Binding classes with factory functions

Source: https://github.com/yannickjadoul/parselmouth/blob/master/pybind11/docs/advanced/classes.rst

Demonstrates using py::init with lambdas to return pointers to class instances, including support for alias types.

```cpp
#include <pybind11/factory.h>
class Example {
public:
    // ...
    virtual ~Example() = default;
};
class PyExample : public Example {
public:
    using Example::Example;
    PyExample(Example &&base) : Example(std::move(base)) {}
};
py::class_<Example, PyExample>(m, "Example")
    // Returns an Example pointer.  If a PyExample is needed, the Example
    // instance will be moved via the extra constructor in PyExample, above.
    .def(py::init([]() { return new Example(); }))
    // Two callbacks:
    .def(py::init([]() { return new Example(); } /* no alias needed */,
                  []() { return new PyExample(); } /* alias needed */))
    // *Always* returns an alias instance (like py::init_alias<>())
    .def(py::init([]() { return new PyExample(); }))
    ;
```

--------------------------------

### Update pip

Source: https://github.com/yannickjadoul/parselmouth/blob/master/docs/installation.rst

Ensure pip is up to date to support binary wheel installations.

```bash
pip install -U pip
```

--------------------------------

### Initialize and configure the praat library target

Source: https://github.com/yannickjadoul/parselmouth/blob/master/praat/CMakeLists.txt

Adds the library, processes subdirectories, and sets target properties.

```cmake
add_library(praat)
foreach(SUBDIR ${PRAAT_SUBDIRECTORIES})
	add_subdirectory(${SUBDIR})
endforeach()

target_include_directories(praat INTERFACE ${PRAAT_INCLUDE_DIRS})
target_compile_definitions(praat PUBLIC ${PRAAT_DEFINITIONS} PRIVATE ${PRAAT_DEFINITIONS_PRIVATE})
target_compile_options(praat PUBLIC ${PRAAT_FLAGS} PRIVATE ${PRAAT_FLAGS_PRIVATE})
target_link_libraries(praat PUBLIC fmt::fmt)

set_target_properties(praat PROPERTIES C_STANDARD 99 CXX_STANDARD 17 CXX_STANDARD_REQUIRED TRUE)
```

--------------------------------

### Python Override Usage

Source: https://github.com/yannickjadoul/parselmouth/blob/master/pybind11/docs/advanced/classes.rst

Example of overriding the C++ virtual function in Python.

```pycon
>>> from example import *
>>> d = Dog()
>>> call_go(d)
u'woof! woof! woof! '
>>> class Cat(Animal):
...     def go(self, n_times):
...             return "meow! " * n_times
...
>>> c = Cat()
>>> call_go(c)
u'meow! meow! meow! '
```

--------------------------------

### Platform Path Configuration

Source: https://github.com/yannickjadoul/parselmouth/blob/master/praat/external/espeak/ESPEAK_NG_READ_ME.TXT

Preprocessor logic in speak_ng.h to handle platform-specific path separators.

```cpp
	#if DATA_FROM_SOURCECODE_FILES
		#define PLATFORM_WINDOWS  0
		#define PATHSEP '/'
	#else
		#define PLATFORM_WINDOWS  1
		#define PATHSEP '\\'
	#endif
#endif
```

--------------------------------

### Library Export Configuration

Source: https://github.com/yannickjadoul/parselmouth/blob/master/pybind11/tests/test_cmake_build/subdirectory_embed/CMakeLists.txt

Configures library installation and export settings for the custom export group.

```cmake
# Test custom export group -- PYBIND11_EXPORT_NAME
add_library(test_embed_lib ../embed.cpp)
target_link_libraries(test_embed_lib PRIVATE pybind11::embed)

install(
  TARGETS test_embed_lib
  EXPORT test_export
  ARCHIVE DESTINATION bin
  LIBRARY DESTINATION lib
  RUNTIME DESTINATION lib)
install(EXPORT test_export DESTINATION lib/cmake/test_export/test_export-Targets.cmake)
```

--------------------------------

### Example of a mangled C++ symbol

Source: https://github.com/yannickjadoul/parselmouth/blob/master/pybind11/docs/faq.rst

A representation of a mangled symbol name generated by template metaprogramming.

```none
__ZN8pybind1112cpp_functionC1Iv8Example2JRNSt3__16vectorINS3_12basic_stringIwNS3_11char_traitsIwEENS3_9allocatorIwEEEENS8_ISA_EEEEEJNS_4nameENS_7siblingENS_9is_methodEA28_cEEEMT0_FT_DpT1_EDpRKT2_
```

```cpp
__ZN8pybind1112cpp_functionC1Iv8Example2JRNSt3__16vectorINS3_12basic_stringIwNS3_11char_traitsIwEENS3_9allocatorIwEEEENS8_ISA_EEEEEJNS_4nameENS_7siblingENS_9is_methodEA28_cEEEMT0_FT_DpT1_EDpRKT2_
```

--------------------------------

### C++ reference and pointer arguments

Source: https://github.com/yannickjadoul/parselmouth/blob/master/pybind11/docs/faq.rst

Basic examples of C++ functions using mutable references or pointers.

```cpp
void increment(int &i) { i++; }
void increment_ptr(int *i) { (*i)++; }
```

--------------------------------

### Invoke a vectorized function in Python

Source: https://github.com/yannickjadoul/parselmouth/blob/master/pybind11/docs/advanced/pycpp/numpy.rst

Example of calling a vectorized function with NumPy arrays and scalar arguments.

```pycon
>>> x = np.array([[1, 3],[5, 7]])
>>> y = np.array([[2, 4],[6, 8]])
>>> z = 3
>>> result = vectorized_func(x, y, z)
```

--------------------------------

### Compile and test on Linux/macOS

Source: https://github.com/yannickjadoul/parselmouth/blob/master/pybind11/docs/basics.rst

Standard sequence of commands to build and verify the project on Unix-like systems.

```bash
mkdir build
cd build
cmake ..
make check -j 4
```

--------------------------------

### Display Audio File in Notebook

Source: https://github.com/yannickjadoul/parselmouth/blob/master/docs/examples/web_service.ipynb

Uses IPython to render an audio player for the local wave file.

```python
from IPython.display import Audio
Audio(filename="audio/the_north_wind_and_the_sun.wav")
```

--------------------------------

### Inspect function signatures with help()

Source: https://github.com/yannickjadoul/parselmouth/blob/master/pybind11/docs/basics.rst

Displays the generated function signature including argument names in Python's help system.

```pycon
>>> help(example)

....

FUNCTIONS
    add(...)
        Signature : (i: int, j: int) -> int

        A function which adds two numbers
```

--------------------------------

### Conflicting Type Bindings

Source: https://github.com/yannickjadoul/parselmouth/blob/master/pybind11/docs/advanced/classes.rst

Example of an ImportError caused by multiple modules attempting to register the same external type globally.

```cpp
// dogs.cpp

// Binding for external library class:
py::class<pets::Pet>(m, "Pet")
    .def("name", &pets::Pet::name);

// Binding for local extension class:
py::class<Dog, pets::Pet>(m, "Dog")
    .def(py::init<std::string>());
```

```cpp
// cats.cpp, in a completely separate project from the above dogs.cpp.

// Binding for external library class:
py::class<pets::Pet>(m, "Pet")
    .def("get_name", &pets::Pet::name);

// Binding for local extending class:
py::class<Cat, pets::Pet>(m, "Cat")
    .def(py::init<std::string>());
```

```pycon
>>> import cats
>>> import dogs
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
ImportError: generic_type: type "Pet" is already registered!
```

--------------------------------

### Incorrect Binding Example

Source: https://github.com/yannickjadoul/parselmouth/blob/master/pybind11/docs/advanced/classes.rst

Demonstrates an incorrect approach where the trampoline method is bound instead of the base class method.

```cpp
py::class_<Animal, PyAnimal /* <--- trampoline*/>(m, "Animal");
    .def(py::init<>())
    .def("go", &PyAnimal::go); /* <--- THIS IS WRONG, use &Animal::go */
```

--------------------------------

### Host API Initialization Declarations

Source: https://github.com/yannickjadoul/parselmouth/blob/master/praat/external/portaudio/READ_ME.TXT

Function prototypes for host API initialization copied into pa_hostapi.h from platform-specific host API files.

```C
/*
	ppgb: the following declarations copied here from pa_unix_hostapis.c.
*/
PaError PaJack_Initialize( PaUtilHostApiRepresentation **hostApi, PaHostApiIndex index );
PaError PaAlsa_Initialize( PaUtilHostApiRepresentation **hostApi, PaHostApiIndex index );
PaError PaOSS_Initialize( PaUtilHostApiRepresentation **hostApi, PaHostApiIndex index );
/* Added for IRIX, Pieter, oct 2, 2003: */
PaError PaSGI_Initialize( PaUtilHostApiRepresentation **hostApi, PaHostApiIndex index );
/* Linux AudioScience HPI */
PaError PaAsiHpi_Initialize( PaUtilHostApiRepresentation **hostApi, PaHostApiIndex index );
PaError PaMacCore_Initialize( PaUtilHostApiRepresentation **hostApi, PaHostApiIndex index );
PaError PaSkeleton_Initialize( PaUtilHostApiRepresentation **hostApi, PaHostApiIndex index );
```

```C
/*
	ppgb: the following declarations copied here from pa_win_hostapis.c.
*/
PaError PaSkeleton_Initialize( PaUtilHostApiRepresentation **hostApi, PaHostApiIndex index );
PaError PaWinMme_Initialize( PaUtilHostApiRepresentation **hostApi, PaHostApiIndex index );
PaError PaWinDs_Initialize( PaUtilHostApiRepresentation **hostApi, PaHostApiIndex index );
PaError PaAsio_Initialize( PaUtilHostApiRepresentation **hostApi, PaHostApiIndex index );
PaError PaWinWdm_Initialize( PaUtilHostApiRepresentation **hostApi, PaHostApiIndex index );
PaError PaWasapi_Initialize( PaUtilHostApiRepresentation **hostApi, PaHostApiIndex index );
```

--------------------------------

### Initialize Parselmouth in PsychoPy Begin Experiment

Source: https://github.com/yannickjadoul/parselmouth/blob/master/docs/examples/psychopy_experiments.ipynb

Use this code in the 'Begin Experiment' tab to import necessary libraries and pre-process audio stimuli.

```python
# ** Begin Experiment **

import parselmouth
import numpy as np
import random

conditions = ['a', 'e']
stimulus_files = {'a': "audio/bat.wav", 'e': "audio/bet.wav"}

STANDARD_INTENSITY = 70.
stimuli = {}
for condition in conditions:
    stimulus = parselmouth.Sound(stimulus_files[condition])
    stimulus.scale_intensity(STANDARD_INTENSITY)
    stimuli[condition] = stimulus
```

--------------------------------

### Configure Python and Subdirectories

Source: https://github.com/yannickjadoul/parselmouth/blob/master/CMakeLists.txt

Finds the Python interpreter and development modules, adds necessary subdirectories, and handles installation for SKBuild.

```cmake
set(Python_FIND_IMPLEMENTATIONS CPython PyPy)
find_package(Python COMPONENTS Interpreter Development.Module REQUIRED)
add_subdirectory(pybind11)

add_subdirectory(src)
add_subdirectory(tests)
add_subdirectory(docs)

if(SKBUILD)
	install(TARGETS parselmouth LIBRARY DESTINATION ${CMAKE_INSTALL_PREFIX})
endif()
```

--------------------------------

### Migrate Module Entry Points

Source: https://github.com/yannickjadoul/parselmouth/blob/master/pybind11/docs/upgrade.rst

Replace the deprecated PYBIND11_PLUGIN macro with the modern PYBIND11_MODULE macro.

```cpp
// old
PYBIND11_PLUGIN(example) {
    py::module m("example", "documentation string");

    m.def("add", [](int a, int b) { return a + b; });

    return m.ptr();
}

// new
PYBIND11_MODULE(example, m) {
    m.doc() = "documentation string"; // optional

    m.def("add", [](int a, int b) { return a + b; });
}
```

--------------------------------

### Unmangled function type representation

Source: https://github.com/yannickjadoul/parselmouth/blob/master/pybind11/docs/faq.rst

The unmangled C++ function type corresponding to the complex symbol shown in the previous example.

```cpp
pybind11::cpp_function::cpp_function<void, Example2, std::__1::vector<std::__1::basic_string<wchar_t, std::__1::char_traits<wchar_t>, std::__1::allocator<wchar_t> >, std::__1::allocator<std::__1::basic_string<wchar_t, std::__1::char_traits<wchar_t>, std::__1::allocator<wchar_t> > > >&, pybind11::name, pybind11::sibling, pybind11::is_method, char [28]>(void (Example2::*)(std::__1::vector<std::__1::basic_string<wchar_t, std::__1::char_traits<wchar_t>, std::__1::allocator<wchar_t> >, std::__1::allocator<std::__1::basic_string<wchar_t, std::__1::char_traits<wchar_t>, std::__1::allocator<wchar_t> > > >&), pybind11::name const&, pybind11::sibling const&, pybind11::is_method const&, char const (&) [28])
```

--------------------------------

### Create a Flask Web Service for Pitch Tracking

Source: https://github.com/yannickjadoul/parselmouth/blob/master/docs/examples/web_service.ipynb

Defines a Flask route that accepts an audio file, processes it with Parselmouth to extract pitch frequencies, and returns the result as JSON.

```python
%%writefile server.py

from flask import Flask, request, jsonify
import tempfile

app = Flask(__name__)

@app.route('/pitch_track', methods=['POST'])
def pitch_track():
    import parselmouth

    # Save the file that was sent, and read it into a parselmouth.Sound
    with tempfile.NamedTemporaryFile() as tmp:
        tmp.write(request.files['audio'].read())
        sound = parselmouth.Sound(tmp.name)
    
    # Calculate the pitch track with Parselmouth
    pitch_track = sound.to_pitch().selected_array['frequency']
    
    # Convert the NumPy array into a list, then encode as JSON to send back
    return jsonify(list(pitch_track))
```

--------------------------------

### Example of C++ Type in Docstring

Source: https://github.com/yannickjadoul/parselmouth/blob/master/pybind11/docs/advanced/misc.rst

Shows how an unregistered C++ type appears as a raw type name in a generated docstring.

```text
 |  __init__(...)
 |      __init__(self: example.Foo, arg0: ns::Bar) -> None
                                          ^^^^^^^
```

--------------------------------

### Defining RowMajor matrices

Source: https://github.com/yannickjadoul/parselmouth/blob/master/pybind11/docs/advanced/cast/eigen.rst

Example of defining a RowMajor matrix type to match NumPy's default storage order.

```cpp
using RowMatrixXd = Eigen::Matrix<double, Eigen::Dynamic, Eigen::Dynamic, Eigen::RowMajor>;
// Use RowMatrixXd instead of MatrixXd
```

--------------------------------

### Define Custom Constructors

Source: https://github.com/yannickjadoul/parselmouth/blob/master/pybind11/docs/upgrade.rst

Transition from placement-new custom constructors to the safer py::init() factory function approach.

```cpp
// old -- deprecated (runtime warning shown only in debug mode)
py::class<Foo>(m, "Foo")
    .def("__init__", [](Foo &self, ...) {
        new (&self) Foo(...); // uses placement-new
    });

// new
py::class<Foo>(m, "Foo")
    .def(py::init([](...) { // Note: no `self` argument
        return new Foo(...); // return by raw pointer
        // or: return std::make_unique<Foo>(...); // return by holder
        // or: return Foo(...); // return by value (move constructor)
    }));
```

--------------------------------

### Define Adaptive Staircase Level

Source: https://github.com/yannickjadoul/parselmouth/blob/master/docs/examples/psychopy_experiments.ipynb

Example variable assignment representing the current signal-to-noise ratio level in a staircase loop.

```python
level = 10
```

--------------------------------

### CMake Configuration and Module Definition

Source: https://github.com/yannickjadoul/parselmouth/blob/master/pybind11/tests/test_cmake_build/installed_function/CMakeLists.txt

Sets up the project, handles CMake policy versions, and defines the pybind11 module target.

```cmake
cmake_minimum_required(VERSION 3.4)
project(test_installed_module CXX)

# The `cmake_minimum_required(VERSION 3.4...3.18)` syntax does not work with
# some versions of VS that have a patched CMake 3.11. This forces us to emulate
# the behavior using the following workaround:
if(${CMAKE_VERSION} VERSION_LESS 3.18)
  cmake_policy(VERSION ${CMAKE_MAJOR_VERSION}.${CMAKE_MINOR_VERSION})
else()
  cmake_policy(VERSION 3.18)
endif()

project(test_installed_function CXX)

find_package(pybind11 CONFIG REQUIRED)
message(
  STATUS "Found pybind11 v${pybind11_VERSION} ${pybind11_VERSION_TYPE}: ${pybind11_INCLUDE_DIRS}")

pybind11_add_module(test_installed_function SHARED NO_EXTRAS ../main.cpp)
set_target_properties(test_installed_function PROPERTIES OUTPUT_NAME test_cmake_build)
```

--------------------------------

### CMake Project Configuration and pybind11 Integration

Source: https://github.com/yannickjadoul/parselmouth/blob/master/pybind11/tests/test_cmake_build/subdirectory_embed/CMakeLists.txt

Sets up the project environment, handles CMake version policies, and includes pybind11 as a subdirectory.

```cmake
cmake_minimum_required(VERSION 3.4)

# The `cmake_minimum_required(VERSION 3.4...3.18)` syntax does not work with
# some versions of VS that have a patched CMake 3.11. This forces us to emulate
# the behavior using the following workaround:
if(${CMAKE_VERSION} VERSION_LESS 3.18)
  cmake_policy(VERSION ${CMAKE_MAJOR_VERSION}.${CMAKE_MINOR_VERSION})
else()
  cmake_policy(VERSION 3.18)
endif()

project(test_subdirectory_embed CXX)

set(PYBIND11_INSTALL
    ON
    CACHE BOOL "")
set(PYBIND11_EXPORT_NAME test_export)

add_subdirectory("${pybind11_SOURCE_DIR}" pybind11)
```

--------------------------------

### Fetch Raspberry Pi edition

Source: https://github.com/yannickjadoul/parselmouth/blob/master/praat/README.md

Command to sync the Raspberry Pi executable from the device to the local machine.

```bash
# on Mac command line
rsync -tpvz pi@192.168.1.2:~/praats/praat ~/Dropbox/Praats/bin/rpi-armv7
```

--------------------------------

### Package executables for distribution

Source: https://github.com/yannickjadoul/parselmouth/blob/master/praat/README.md

Commands to compress and move executables into the web distribution folder.

```bash
# on Mac command line
zip $PRAAT_WWW/praat${PRAAT_VERSION}_win-intel64.zip ~/Dropbox/Praats/bin/win-intel64/Praat.exe
zip $PRAAT_WWW/praat${PRAAT_VERSION}_win-intel32.zip ~/Dropbox/Praats/bin/win-intel32/Praat.exe
zip $PRAAT_WWW/praat${PRAAT_VERSION}_win-arm64.zip ~/Dropbox/Praats/bin/win-arm64/Praat.exe
( cd ~/Dropbox/Praats/bin/linux-intel64 &&\
  tar cvf praat${PRAAT_VERSION}_linux-intel64.tar praat &&\
  gzip praat${PRAAT_VERSION}_linux-intel64.tar &&\
  mv praat${PRAAT_VERSION}_linux-intel64.tar.gz $PRAAT_WWW )
( cd ~/Dropbox/Praats/bin/linux-intel64 &&\
  tar cvf praat${PRAAT_VERSION}_linux-intel64-barren.tar praat_barren &&\
  gzip praat${PRAAT_VERSION}_linux-intel64-barren.tar &&\
  mv praat${PRAAT_VERSION}_linux-intel64-barren.tar.gz $PRAAT_WWW )
( cd ~/Dropbox/Praats/bin/linux-intel64 &&\
  tar cvf praat${PRAAT_VERSION}_linux-intel64-nogui.tar praat_nogui &&\
  gzip praat${PRAAT_VERSION}_linux-intel64-nogui.tar &&\
  mv praat${PRAAT_VERSION}_linux-intel64-nogui.tar.gz $PRAAT_WWW )
( cd ~/Dropbox/Praats/bin/chrome-intel64 &&\
  tar cvf praat${PRAAT_VERSION}_chrome-intel64.tar praat &&\
  gzip praat${PRAAT_VERSION}_chrome-intel64.tar &&\
  mv praat${PRAAT_VERSION}_chrome-intel64.tar.gz $PRAAT_WWW )
( cd ~/Dropbox/Praats/bin/linux-arm64 &&\
  tar cvf praat${PRAAT_VERSION}_linux-arm64.tar praat &&\
  gzip praat${PRAAT_VERSION}_linux-arm64.tar &&\
  mv praat${PRAAT_VERSION}_linux-arm64.tar.gz $PRAAT_WWW )
( cd ~/Dropbox/Praats/bin/linux-arm64 &&\
  tar cvf praat${PRAAT_VERSION}_linux-arm64-barren.tar praat_barren &&\
  gzip praat${PRAAT_VERSION}_linux-arm64-barren.tar &&\
  mv praat${PRAAT_VERSION}_linux-arm64-barren.tar.gz $PRAAT_WWW )
( cd ~/Dropbox/Praats/bin/linux-arm64 &&\
  tar cvf praat${PRAAT_VERSION}_linux-arm64-nogui.tar praat_nogui &&\
  gzip praat${PRAAT_VERSION}_linux-arm64-nogui.tar &&\
  mv praat${PRAAT_VERSION}_linux-arm64-nogui.tar.gz $PRAAT_WWW )
( cd ~/Dropbox/Praats/bin/chrome-arm64 &&\
  tar cvf praat${PRAAT_VERSION}_chrome-arm64.tar praat &&\
  gzip praat${PRAAT_VERSION}_chrome-arm64.tar &&\
  mv praat${PRAAT_VERSION}_chrome-arm64.tar.gz $PRAAT_WWW )
( cd ~/Dropbox/Praats/bin/rpi-armv7 &&\
  tar cvf praat${PRAAT_VERSION}_rpi-armv7.tar praat &&\
  gzip praat${PRAAT_VERSION}_rpi-armv7.tar &&\
  mv praat${PRAAT_VERSION}_rpi-armv7.tar.gz $PRAAT_WWW )
```
Tokens:
Raw