mp3Subsamp: Extract Short Surveys from Longer mp3 Recordings
In jonkatz2/monitoR: Acoustic Template Detection in R

mp3Subsamp

R Documentation

Extract Short Surveys from Longer mp3 Recordings

Description

Extract short surveys from longer mp3 recordings without decoding and re-encoding. Collects metadata about surveys for upload to an acoustic database and renames files with original date modified. Timing options are one or more surveys per hour starting at the beginning time of the recording or one survey per hour starting on each hour.

Usage

mp3Subsamp(files, from = ".", to, csv.dir = to, csv.name, duration = 600, 
           mins.between = 50, index = "hour", loc.prefix, CardRecorderID = NA,
           kbps = 128, samp.rate = 44100, channels = 2, split = TRUE)

Arguments

`files`	Optional vector of mp3 file paths to extract surveys from.
`from`	Directory containing mp3 recordings to extract survey from; required only if `files` is missing.
`to`	Directory where surveys will be placed after extraction.
`csv.dir`	Directory where csv file of survey metadata will be saved; defaults to the `to` directory.
`csv.name`	Name assigned to csv file of metadata (character value ending in .csv).
`duration`	Duration of surveys to extract (numeric, units = 'seconds'). Defaults to 600 seconds (10 minutes).
`mins.between`	Number of minutes to skip between surveys (numeric). If `index = "hour"`, the value for `mins.between + duration * 60` (duration converted to minutes) equals the repeat period. Defaults to 50 minutes, for a 60 minute repeat period.
`index`	Character value indicating whether to take the first survey at the next hour in the recording (identified based on file date modified) or simply from the start of the recording. In `c("hour", "time0")`. Defaults to `"hour"`.
`loc.prefix`	Six characters identifying the location at which the recording was made. Will be used in the file name (see Details) and the csv file name. Must be in tblLocation.fldLocationName in the acoustics database.
`CardRecorderID`	Numeric key value from tblCardRecorder.pkCardRecorderID, which links the recorder that made the recording with the location it was recorded.
`kbps`	Numeric value for mp3 bitrate. Common values are `c(64, 128, 160, 192, 224, 256, 320)`. Must match the bitrate set by the recording device.
`samp.rate`	Numeric value for mp3 sample rate. Common values are `c(22050, 44100, 48000)`. Must match the sample rate set by the recording device.
`channels`	Numeric value for number of audio channels in mp3 file. Both "Stereo" and "Joint Stereo" are 2-channel recordings. "Mono" is a 1-channel recording.
`split`	Logical. The default `TRUE` will send the call to mp3splt to subsample the surveys; `FALSE` will generate metadata only.

Details

This function calls mp3splt, a third party library that must be installed separately from http://mp3splt.sourceforge.net. Supplemental installation instructions are provided in the document "Installing_mp3splt.pdf", available the monitoR website http://www.uvm.edu/rsenr/vtcfwru/R/?Page=monitoR/monitoR.htm. This function supplants fileCopyRename as a file copying function and a metadata collection tool when using the acoustic database.

The survey file names produced will be of the form PREFIX_YYYY-mm-dd_HHMSS.mp3. Surveys from the same location can be linked by the location prefix and differentiated by different modification dates.

Value

Data frame with metadata about the surveys. Metadata includes: the date modified (fldOriginalDateModified), the original recording name (fldOriginalRecordingName), the new survey name (fldSurveyName), the recording format (fldRecordingFormat), the value for pkCardrecorderID (fkCardRecorderID), the duration of each survey (fldSurveyLength), the sample rate (fldSampleRate), the bit depth (fldBitsperSample), and the number of channels (fldChannels).

Note

dbUploadSurvey assumes a database structure identical to that provided in the acoustics schema.

Author(s)

Jon Katz

Examples

# Specify individual files, 10 minutes every hour from the file start:
## Not run: metadata <- mp3Subsamp(files = '~/media/SDcard/MA01.mp3', to = '~/Desktop/Acoustics/Recordings', 
csv.dir = '~/Desktop/Acoustics/Results', index = "time0", loc.prefix = 'MABI01', CardRecorderID = 1
## End(Not run)

# 10 minute surveys at the top of every hour, from an entire SD card:
## Not run: metadata <- mp3Subsamp(from = '~/media/SDcard', to = '~/Desktop/Acoustics/Recordings', 
csv.dir = '~/Desktop/Acoustics/Results', loc.prefix = 'MABI01', CardRecorderID = 1
## End(Not run)

# 5 minute surveys every 30 minutes starting at the top of every hour, from an entire SD card:
## Not run: metadata <- mp3Subsamp(from = '~/media/SDcard', to = '~/Desktop/Acoustics/Recordings', 
csv.dir = '~/Desktop/Acoustics/Results', duration = 300, mins.between = 25, loc.prefix = 'MABI01', 
CardRecorderID = 1
## End(Not run)

jonkatz2/monitoR documentation built on March 27, 2024, 4:39 p.m.