Skip to contents

Calculate Amplitude Envelope for Audio Segment

amp_env.Rd

Calculates the amplitude envelope for a specified segment of an audio file.

Usage

amp_env(
  segment_row,
  wav_dir = NULL,
  msmooth = NULL,
  norm = FALSE,
  plot = FALSE
)

Arguments

segment_row

A row from either find_motif output or segment class in SAP object

wav_dir

Optional path to WAV files directory (default: NULL)

msmooth

Numeric vector of length 2 for envelope smoothing:

  • First value: Window length in number of points

  • Second value: Overlap between windows (percentage)

If NULL, no smoothing is applied

norm

Logical, Whether to normalize envelope to range between 0 and 1 (default: FALSE)

plot

Logical, whether to plot the envelope (default: FALSE)

Value

A numeric vector containing the amplitude envelope values

Details

The function processes audio segments with the following steps:

  • Validates input segment data

  • Constructs correct file path

  • Reads specified portion of audio file

  • Calculates amplitude envelope

  • Optionally smooths and normalizes the envelope

See also

find_motif for creating segment data

Examples

if (FALSE) { # \dontrun{
# Basic envelope calculation
env <- amp_env(segments[1,], wav_dir = "path/to/wavs")

# With smoothing and normalization
env <- amp_env(segments[1,],
               wav_dir = "path/to/wavs",
               msmooth = c(256, 50),
               norm = TRUE)

# With plot
env <- amp_env(segments[1,],
               wav_dir = "path/to/wavs",
               msmooth = c(256, 50),
               plot = TRUE)
} # }