Learn R Programming

⚠️There's a newer version (2.7.2) of this package.Take me there.

R package for sound synthesis and acoustic analysis.
Homepage with help, demos, etc: http://cogsci.se/soundgen.html
Source code on github: https://github.com/tatters/soundgen

Performs parametric synthesis of sounds with harmonic and noise components such as animal vocalizations or human voice. Also includes tools for spectral analysis, pitch tracking, audio segmentation, self-similarity matrices, morphing, etc.

Key functions

  • Sound synthesis from R console: soundgen()
  • Shiny app for sound synthesis (opens in a browser): soundgen_app()
  • Acoustic analysis of a wav/mp3 file / folder: analyze() / analyzeFolder()
  • Shiny app for editing intonation contours (opens in a browser): pitch_app()
  • Shiny app for measuring formants (opens in a browser): formant_app()
  • Measuring syllables, pauses, and bursts in a wav/mp3 file / folder: segment() / segmentFolder

For more information, please see the vignettes on sound synthesis and acoustic analysis:

vignette("sound_generation", package="soundgen")

vignette("acoustic_analysis", package="soundgen")

Or, to open the vignettes in a browser:
RShowDoc('sound_generation', package = 'soundgen')

RShowDoc('acoustic_analysis', package = 'soundgen')

Example of sound synthesis

Use the soundgen() function to create a breathy moan:

s = soundgen(
  sylLen = 230,               # duration of voiced part, ms
  pitch = c(305, 280),        # pitch, Hz (goes down from 305 to 380 Hz)
  ampl = c(0, -20),           # amplitude, dB (gradual fade-out by 20 dB)
  rolloff = -30,              # strong f0, weak harmonics
  temperature = 0.05,         # some stochasticity in generation
  formants = c(260, 960, 1500, 2200,  # F1-F8 formant frequencies, Hz
               2600, 3600, 4200, 4500),
  noise = data.frame(
    time = c(-50, 120, 700),  # time of noise anchors
    value = c(-15, -5, -50)   # noise amplitude, dB
  ),
  rolloffNoise = 0,           # flat noise spectrum before adding formants
  addSilence = 0, samplingRate = 44100, pitchSamplingRate = 44100,
  play = TRUE, plot = TRUE, osc = TRUE, ylim = c(0, 6)
)

Example of acoustic analysis

Use the analyze() function to detect pitch and obtain other spectral descriptives of the sound we have just synthesized:

a = analyze(s, 44100, ylim = c(0, 6))
#> Scale not specified. Assuming that max amplitude is 1
a[1:5, c('pitch', 'peakFreq', 'harmHeight', 'HNR', 'ampl', 'loudness')]
#>      pitch peakFreq harmHeight       HNR      ampl  loudness
#> 1       NA       NA         NA        NA 0.0305833        NA
#> 2       NA 305.2747         NA  1.083205 0.1442435  9.636858
#> 3 300.0882 305.2747   1197.802 12.934929 0.3642711 17.808124
#> 4 299.4505 305.2747   1197.802 14.042033 0.5131389 22.289716
#> 5 296.0563 305.2747   1110.114 13.450248 0.4959925 22.193244
colnames(a)
#>  [1] "duration"           "duration_noSilence" "time"               "ampl"              
#>  [5] "amplVoiced"         "dom"                "entropy"            "f1_freq"           
#>  [9] "f1_width"           "f2_freq"            "f2_width"           "f3_freq"           
#> [13] "f3_width"           "harmEnergy"         "harmHeight"         "HNR"               
#> [17] "loudness"           "peakFreq"           "pitch"              "quartile25"        
#> [21] "quartile50"         "quartile75"         "specCentroid"       "specSlope"         
#> [25] "voiced"

Installation

To install the current release from CRAN: install.packages("soundgen")

NB: Make sure all dependencies have been installed correctly! For problems with seewave, see http://rug.mnhn.fr/seewave/

On Macs, you may need to do the following:

  • First install brew according to the instructions here: https://brew.sh/
  • Then run the following from the terminal
    brew install libsndfile
    brew install fftw
  • Finally, install soundgen in R:
    install.packages("soundgen")

Copy Link

Version

Install

install.packages('soundgen')

Monthly Downloads

819

Version

2.1.0

License

GPL (>= 2)

Maintainer

Andrey Anikin

Last Published

June 19th, 2021

Functions in soundgen (2.1.0)

Mode

Modified mode
addVectors

Add overlapping vectors
addAM

Add amplitude modulation
analyze

Acoustic analysis
HzToSemitones

Convert Hz to semitones
analyzeFrame

Analyze fft frame
audSpectrogram

Auditory spectrogram
addFormants

Add formants
addPitchCands

Plot pitch candidates
averageMatrices

Average matrices
analyzeFolder

Analyze folder
costJumps

Cost of jumps
convert_sec_to_hms

Print time
divideIntoSyllables

Syllable structure of a bout
.addAM

Add AM to a sound
clumper

Clump a sequence into large segments
checkInputType

Check audio input type
def_form

Defaults and ranges for formant_app()
.getLoudness

Loudness per sound
compareSounds

Compare two sounds
filled.contour.mod

Modified filled.contour
beat

Generate beat
defaults_analyze

Defaults and ranges for analyze()
defaults_analyze_pitchCand

Defaults for plotting with analyze()
convertStringToFormants

Prepare a list of formants
crossFade

Join two waveforms by cross-fading
costPerPath

Cost per path
.filterSoundByMS

Filter a single sound by MS
.audSpectrogram

Auditory spectrogram per sound
filterMS

Filter modulation spectrum
defaults

Shiny app defaults
.analyze

Analyze per sound
.addFormants

Add formants per sound
.reverb

Add reverb to a sound
.pitchDescriptives

Pitch descriptives per file
.modulationSpectrum

Modulation spectrum per sound
fade

Fade
fart

Fart
.getRMS

RMS amplitude per sound
.osc

Oscillogram per sound
.flatEnv

Flat envelope per sound
downsample

Downsample a vector
drawContour

Draw contour
flatEnv

Flat envelope / compressor
findInflections

Find inflections
findZeroCrossing

Find zero crossing
findGrad

Find gradient
.flatSpectrum

Flat spectrum per sound
estimateVTL

Estimate vocal tract length
filterSoundByMS

Filter sound by modulation spectrum
evaluatePars

Evaluate parameters for optimization
findBursts

Find bursts
.segment

Internal soundgen function
getEnv

Get amplitude envelope
.shiftFormants

Shift formants per sound
generateNoise

Generate noise
.ssm

SSM per sound
.spectrogram

Spectrogram per sound
generatePath

Generate path
getFormantDispersion

Get formant dispersion
getLoudnessFolder

Get loudness folder
getRMSFolder

Get RMS folder
getLoudnessPerFrame

Get loudness per frame
getRandomWalk

Random walk
findSyllables

Find syllables
generateGC

Generate glottal cycles
generateHarmonics

Generate harmonics
harmHeight_dif

Height of harmonics: difference method
harmHeight_peaks

Height of harmonics: peaks method
flatSpectrum

Flat spectrum
forcePerPath

Force per path
findVoicedSegments

Find voiced segments
getPitchHps

Harmonic product spectrum
getDom

Get lowest dominant frequency band
morphFormants

Morph formants
formant_app

Interactive formant tracker
getPitchSpec

BaNa pitch tracker
getCheckerboardKernel

Checkerboard kernel
getMelSpec

Mel-transformed spectrogram
morphList

Morph lists
getDiscreteContour

Discrete smooth contour from anchors
getNovelty

SSM novelty
formatPitchManual

Format pitchManual
gaussianSmooth2D

Gaussian smoothing in 2D
getEntropy

Entropy
getSmoothSpectrum

Get smooth spectrum
getPitchAutocor

Autocorrelation pitch tracker
getPitchCep

Cepstral pitch tracker
getAM

Get amplitude modulation
getBandwidth

Get bandwidth
pitchDescriptives

Pitch descriptives
generateEpoch

Generate an epoch
pitchManual

Manual pitch estimation in 260 sounds
getSpectralEnvelope

Spectral envelope
htmlPlots

HTML for clickable plots
hillenbrand

Formants in American vowels
logMatrix

Log-warp matrix
getLoudness

Get loudness
getIntegerRandomWalk

Discrete random walk
matchColumns

Match number of columns
semitonesToHz

Convert semitones to Hz
getVocalFry

Subharmonics
getVocalFry_per_epoch

Constant subharmonics regime
getRolloff

Control rolloff of harmonics
interpolate

Interpolate
getRough

Get roughness
interpolMatrix

Interpolate matrix
getSmoothContour

Smooth contour from anchors
getSigmoid

Get sigmoid filter
shiftFormants

Shift formants
getFrameBank

Frame bank
silenceSegments

Silence sound segments
iso226

iso226
isCentral.localMax

Simple peak detection
guessPhase_GL

Guess phase GL
guessPhase_spsi

Guess phase SPSI
harmEnergy

Energy in harmonics
harmHeight

Height of harmonics
lockToFormants

Lock to formants
pathfinder

Pathfinder
log01

log01
phon2sone

Convert phon to sone
pathfinding_fast

Path through pitch candidates: fast
pitchContour

Manually corrected pitch contours in 260 sounds
getGlottalCycles

Divide f0 contour into glottal cycles
snake

Snake
medianSmoother

Median smoothing
modulationSpectrum

Modulation spectrum
invertSpectrogram

Invert spectrogram
intplPitch

Interpolate pitch contour
getPrior

Get prior for pitch candidates
getRMS

RMS amplitude
presets

Presets
morph

Morph sounds
processAudio

Process audio
selfsim

Compute self-similarity
segmentManual

Manual counts of syllables in 260 sounds
morphDF

Morph dataframes
matchLengths

Resize vector to required length
specToMS

Spectrogram to modulation spectrum
spectrogram

Spectrogram
upsample

Upsample pitch contour
killDC

Kill DC
matchPars

Match soundgen pars (experimental)
upsamplePitchContour

Upsample pitch contour
listDepth

List depth
objectToString

Object to string
notesDict

Conversion table from Hz to musical notation
modulationSpectrumFolder

Modulation spectrum folder
modulationSpectrumFragment

Modulation spectrum per fragment
wigglePars

Wiggle parameters
zeroOne

Normalize 0 to 1
pitch_app

Interactive pitch tracker
pitchSmoothPraat

Pitch smoothing as in Praat
optimizePars

Optimize parameters for acoustic analysis
osc

Oscillogram
pDistr

Proportion of total
msToSpec

Modulation spectrum to spectrogram
readAudio

Read audio
reportTime

Report time
rbind_fill

rbind_fill
reportCI

Report CI
normalizeFolder

Normalize folder
parabPeakInterpol

Parabolic peak interpolation
playme

Play audio
plotSpec

Plot spectrogram
segment

Segment a sound
segmentFolder

Segment folder
soundgen

Generate a sound
soundgen_app

Interactive sound synthesizer
transplantFormants

Transplant formants
reformatFormants

Reformat formants
reformatAnchors

Reformat anchors
permittedValues

Defaults and ranges for soundgen()
sampleModif

sampleModif
pathfinding_slow

Path through pitch candidates: slow
updateAnalyze

Update analyze
scaleNoiseAnchors

Scale noise anchors
reverb

Reverb & echo
subhToHarm

Subharmonics-to-harmonics ratio
summarizeAnalyze

Summarize the output of analyze()
rnorm_truncated

Random draw from a truncated normal distribution
spectrogramFolder

Spectrogram folder
transplantEnv

Transplant envelope
splitContour

Split contour
warpMatrix

Warp matrix
validatePars

Validate parameters
to_dB

Convert to dB
scaleSPL

Scale SPL
schwa

Schwa-related formant conversion
ssm

Self-similarity matrix
spreadSpec

Spread spectrum
timeSeriesSummary

Time series summary
switchColorTheme

Switch color theme
wiggleAnchors

Randomly modify anchors
wiggleGC

Wiggle glottal cycles