bp/PySoundConcat
1
0
Fork 0
Code Issues 2 Pull Requests Actions Packages Projects Releases Wiki Activity

Re-added tutorial changes that mysteriously dissapeared...

Browse Source
This commit is contained in:
Pezz89
2016-03-26 18:25:50 +00:00
parent d23cd65d1d
commit 5a7c0ff1ca
2 changed files with 105 additions and 101 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/sppysound/docs/api.rst
-101
View File
@@ -1,106 +1,5 @@
API
===
---------------------------
concatenate.py Script Usage
---------------------------
-h, --help show help message and exit
--analyse, -a [ANALYSES, ...] Specify analyses to be created. Valid analyses are:
- "rms"
- "zerox"
- "fft"
- "spccntr"
- "spcsprd"
- "spcflux"
- "spccf"
- "spcflatness"
- "f0"
- "peak"
- "centroid"
- "variance"
- "kurtosis"
- "skewness"
- "harm_ratio"
--analysis_dict Set the formatting of each analysis for grain matching.
Example: '--f0 median --rms mean'
--fft Overwrite default config setting for fft analysis.
Example: '--window_size 2048'
--kurtosis Overwrite default config setting for kurtosis
analysis.
Example: '--window_size 100 --overlap 2'
--matcher Set matcher settings.
Example: 'match_quantity'
--matcher_weightings Set weighting for analysis to set their presedence when matching.
Example: '--f0 2 --rms 1.5'
--rms Overwrite default config setting for rms analysis.
Example: '--window_size 100 --overlap 2'
--skewness Overwrite default config setting for skewness
analysis.
Example: '--window_size 100 --overlap 2'
--synthesizer Set synthesis settings.
Example: '--enf_rms_ratio_limit 2'
--variance Overwrite default config setting for variance
analysis.
Example: '--window_size 100 --overlap 2'
--reanalyse Force re-analysis of all analyses, overwriting any
existing analyses
--rematch Force re-matching, overwriting any existing match data
--enforcef0 This flag enables pitch shifting of matched grainsto
better match the target.
--enforcerms This flag enables scaling of matched grains to better
match the target's volume.
--copy This flag enables the copying of audio files from
their location to the database, rather than creating
symbolic links. This is useful for creating portable
databases.
--match_method Choose the algorithm to use when matching analyses. Available algorithms are:
Brute force: 'bruteforce'
K-d Tree Search: 'kdtree'
--verbose, -v Specifies level of verbosity in output. For example:
'-vvvvv' will output all information. '-v' will output
minimal information.
-------------------
AudioFile Class
src/sppysound/docs/tutorial.rst
+105
View File
@@ -33,6 +33,8 @@ A list of all commands available is then presented:
...
(Details on all available commands are available in the :ref:`usage`)
For this demonstration, the following file structure will be used:
::
@@ -279,3 +281,106 @@ each parameter. The default config.py file looks like this:
"channels": 1
}
.. _usage:
concatenate.py Script Usage
---------------------------
-h, --help show help message and exit
--analyse, -a [ANALYSES, ...] Specify analyses to be created. Valid analyses are:
- "rms"
- "zerox"
- "fft"
- "spccntr"
- "spcsprd"
- "spcflux"
- "spccf"
- "spcflatness"
- "f0"
- "peak"
- "centroid"
- "variance"
- "kurtosis"
- "skewness"
- "harm_ratio"
--analysis_dict Set the formatting of each analysis for grain matching.
Example: '--f0 median --rms mean'
--fft Overwrite default config setting for fft analysis.
Example: '--window_size 2048'
--kurtosis Overwrite default config setting for kurtosis
analysis.
Example: '--window_size 100 --overlap 2'
--matcher Set matcher settings.
Example: 'match_quantity'
--matcher_weightings Set weighting for analysis to set their presedence when matching.
Example: '--f0 2 --rms 1.5'
--rms Overwrite default config setting for rms analysis.
Example: '--window_size 100 --overlap 2'
--skewness Overwrite default config setting for skewness
analysis.
Example: '--window_size 100 --overlap 2'
--synthesizer Set synthesis settings.
Example: '--enf_rms_ratio_limit 2'
--variance Overwrite default config setting for variance
analysis.
Example: '--window_size 100 --overlap 2'
--reanalyse Force re-analysis of all analyses, overwriting any
existing analyses
--rematch Force re-matching, overwriting any existing match data
--enforcef0 This flag enables pitch shifting of matched grainsto
better match the target.
--enforcerms This flag enables scaling of matched grains to better
match the target's volume.
--copy This flag enables the copying of audio files from
their location to the database, rather than creating
symbolic links. This is useful for creating portable
databases.
--match_method Choose the algorithm to use when matching analyses. Available algorithms are:
Brute force: 'bruteforce'
K-d Tree Search: 'kdtree'
--verbose, -v Specifies level of verbosity in output. For example:
'-vvvvv' will output all information. '-v' will output
minimal information.