Skip to content

Commit 3e021c2

Browse files
committed
add CLI guide in README.md
1 parent 2e86df6 commit 3e021c2

1 file changed

Lines changed: 12 additions & 0 deletions

File tree

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,18 @@ In this version, TD-PSOLA only supports the fixed time stretching factor alpha.
9696

9797
You can modify pitch of the audio sequence in two ways. The first one is beta, which is the fixed pitch shifting factor. The other one is target_f0, which supports target pitch sequence you want to convert. You cannot use both of the parameters.
9898

99+
### Using PyTSMod from the command line
100+
101+
From version 0.3.0, this package includes a command-line tool named `tsmod`, which can create the result file easily from a shell. To generate the WSOLA result of `input.wav` with stretching factor 1.3 and save to `output.wav`, please run:
102+
103+
```shell
104+
$ tsmod wsola input.wav output.wav 1.3 # ola, wsola, pv, pv_int are available.
105+
```
106+
107+
Currently, OLA, WSOLA, and Phase Vocoder(PV) are supported. TD-PSOLA is excluded due to the difficulty of sending extracted pitch data to TD-PSOLA. Also, non-linear TSM is not supported in command-line.
108+
109+
For more information, use `-h` or `--help` command to see the detailed usage of `tsmod`.
110+
99111
## Audio examples
100112

101113
The original audio is from TSM toolbox.

0 commit comments

Comments
 (0)