mhsF0: mhsF0

In IPS-LMU/wrassp: Interface to the 'ASSP' Library

mhsF0

Description

mhsF0 function adapted from libassp

Usage

mhsF0(
  listOfFiles = NULL,
  optLogFilePath = NULL,
  beginTime = 0,
  centerTime = FALSE,
  endTime = 0,
  windowShift = 5,
  gender = "u",
  maxF = 600,
  minF = 50,
  minAmp = 50,
  minAC1 = 0.25,
  minRMS = 18,
  maxZCR = 3000,
  minProb = 0.52,
  plainSpectrum = FALSE,
  toFile = TRUE,
  explicitExt = NULL,
  outputDirectory = NULL,
  forceToLog = useWrasspLogger,
  verbose = TRUE
)

Arguments

listOfFiles	vector of file paths to be processed by function
optLogFilePath	path to option log file
beginTime	= <time>: set begin of analysis interval to <time> seconds (default = 0: begin of file)
centerTime	= <time>: set single-frame analysis with the analysis window centred at <time> seconds; overrules beginTime, endTime and windowShift options
endTime	= <time>: set end of analysis interval to <time> seconds (default = 0: end of file)
windowShift	= <dur>: set analysis window shift to <dur> ms (default: 5.0)
gender	= <code> set gender-specific pitch ranges; <code> may be: "f[emale]" (80.0 - 600.0 Hz) "m[ale]" (50.0 - 375.0 Hz) "u[nknown]" (default; 50.0 - 600.0 Hz)
maxF	= <freq>: set maximum pitch value to <freq> Hz (default: 500.0)
minF	= <freq>: set minimum pitch value to <freq> Hz (default: 50.0 minimum: 25.0)
minAmp	= <amp>: minimum signal amplitude (default: 50)
minAC1	= <freq>: minimum 1st correlation coefficient (default: 0.250)
minRMS	= <num>: minimum RMS amplitude in dB (default: 18.0)
maxZCR	= <freq>: maximum zero crossing rate in Hz (default: 3000)
minProb	= <num>: minimum quality value of F0 fit (default: 0.520)
plainSpectrum	use plain rather than masked power spectrum
toFile	write results to file (default extension is .pit)
explicitExt	set if you wish to override the default extension
outputDirectory	directory in which output files are stored. Defaults to NULL, i.e. the directory of the input files
forceToLog	is set by the global package variable useWrasspLogger. This is set to FALSE by default and should be set to TRUE is logging is desired.
verbose	display infos & show progress bar

Details

Pitch analysis of the speech signal in <listOfFile> using Michel's/Modified Harmonic Sieve algorithm. Analysis results will be written to a file with the base name of the input file and extension '.pit'. Default output is in SSFF binary format (track 'pitch').

Value

nrOfProcessedFiles or if only one file to process return AsspDataObj of that file

Author(s)

Raphael Winkelmann

Lasse Bombien

See Also

ksvF0 for an tracking the fundamental frequency

Examples

# get path to audio file
path2wav <- list.files(system.file("extdata", package = "wrassp"), 
                       pattern = glob2rx("*.wav"), 
                       full.names = TRUE)[1]

# calculate fundamental frequency contour
res <- mhsF0(path2wav, toFile=FALSE)

# plot fundamental frequency contour
plot(seq(0,numRecs.AsspDataObj(res) - 1) / rate.AsspDataObj(res) +
       attr(res, 'startTime'),
     res$pitch, 
     type='l', 
     xlab='time (s)', 
     ylab='F0 frequency (Hz)')

IPS-LMU/wrassp documentation built on Feb. 1, 2024, 1:25 a.m.