Skip to contents

Pitch detection using the YIN metod

yin.Rd

This function applies the YIN (Cheveigné and Kawahara 2002) method to estimate the fundamental frequency.

Usage

yin(
  listOfFiles,
  beginTime = 0,
  endTime = 0,
  windowShift = 5,
  windowSize = 30,
  minF = 70,
  maxF = 200,
  trough_threshold = 0.1,
  center = TRUE,
  pad_mode = "constant",
  explicitExt = "yip",
  outputDirectory = NULL,
  toFile = TRUE
)

Arguments

listOfFiles

A vector of file paths to wav files.

beginTime

The start time of the section of the sound file that should be processed.

endTime

The end time of the section of the sound file that should be processed.

windowShift

The measurement interval (frame duration), in seconds.

minF

Candidate f0 frequencies below this frequency will not be considered.

maxF

Candidates above this frequency will be ignored.

trough_threshold

The absolute threshold for peak estimation.

center

Should analysis windows be centered around the time of the window (TRUE, the default) or should the window be considered to have started at the indicated time point (FALSE).

pad_mode

The mode in which padding occurs. Ignored if center is not TRUE. Padding occurs in the python library librosa, and the user should therefore consult the manual of the NumPy library function numpy.pad for other options.

explicitExt

the file extension that should be used.

outputDirectory

set an explicit directory for where the signal file will be written. If not defined, the file will be written to the same directory as the sound file.

toFile

write the output to a file? The file will be written in outputDirectory, if defined, or in the same directory as the soundfile.

Value

An SSFF track object containing two tracks (f0 and pitch) that are either returned (toFile == FALSE) or stored on disk.

Details

This function calls the librosa (McFee et al. 2022) Python library to load the audio data an make pitch related estimates.

References

Cheveigné Ad, Kawahara H (2002). “YIN, a fundamental frequency estimator for speech and music.” The Journal of the Acoustical Society of America, 111(4), 1917--1930. ISSN 0001-4966, doi:10.1121/1.1458024 , http://www.ncbi.nlm.nih.gov/pubmed/12002874.

McFee B, Metsai A, McVicar M, Balke S, Thomé C, Raffel C, Zalkow F, Malek A, Dana, Lee K, Nieto O, Ellis D, Mason J, Battenberg E, Seyfarth S, Yamamoto R, viktorandreevichmorozov, Choi K, Moore J, Bittner R, Hidaka S, Wei Z, nullmightybofo, Weiss A, Hereñú D, Stöter F, Friesch P, Vollrath M, Kim T, Thassilo (2022). “librosa/librosa: 0.9.1.” doi:10.5281/zenodo.6097378 .

See also

pyin