"""freefield1010 Dataset Loader
.. admonition:: Dataset Info
:class: dropdown
**freefield1010: A Dataset of Field Recording Excerpts for Bioacoustic Research**
*Created By:*
| Dan Stowell, Mark D. Plumbley.
| Centre for Digital Music, Queen Mary University of London.
Version 1.0
*Description:*
The freefield1010 dataset is a collection of 7,690 field recording excerpts from various global locations, standardized for research purposes. These recordings cover a wide range of environments and locales. The dataset is part of the "Bird Audio Detection" challenge, a joint venture by DCASE (Detection and Classification of Acoustic Scenes and Events) and the IEEE Signal Processing Society. It's particularly useful for bioacoustic classification models, with annotations indicating the presence or absence of birds in the recordings.
*Audio Files Included:*
* The dataset consists of 7,690 audio clips, sourced from the field-recording tag in the Freesound audio archive.
* All sounds have been converted to standard CD-quality mono WAV format.
* Files are stored as 16-bit 44.1 kHz WAV files in the 'wav' folder.
* Amplitude of each excerpt has been normalized due to the varying levels in the Freesound archive.
*Meta-data Files Included:*
* A binary label "hasbird" is associated with every recording.
* The metadata is available on the DCASE "Bird Audio Detection" challenge website: http://machine-listening.eecs.qmul.ac.uk/bird-audio-detection-challenge/
*Please Acknowledge freefield1010 in Academic Research:*
When using the freefield1010 dataset for academic research, please cite the following paper:
.. code-block:: latex
D. Stowell, M. Plumbley. "An open dataset for research on audio field recording archives: Freefield1010.", Proc. Audio Engineering Society 53rd Conference on Semantic Audio (AES53), 2014.
*Conditions of Use:*
* The freefield1010 dataset is created by Dan Stowell and Mark D. Plumbley.
* It is available under the Creative Commons Attribution 4.0 International (CC BY 4.0) license: https://creativecommons.org/licenses/by/4.0/
"""
import os
from typing import BinaryIO, Optional, TextIO, Tuple
import librosa
import numpy as np
import csv
from soundata import download_utils
from soundata import jams_utils
from soundata import core
from soundata import annotations
from soundata import io
BIBTEX = """
@inproceedings{Stowell:2014f,
title = {freefield1010 - an open dataset for research on audio field recording archives},
booktitle={Proceedings of the Audio Engineering Society 53rd Conference on Semantic Audio (AES53)},
author={Stowell, D. and Plumbley, M. D.},
year={2014},
publisher={Audio Engineering Society}}
"""
REMOTES = {
"dataset": download_utils.RemoteFileMetadata(
filename="ff1010bird_wav.zip",
url="https://archive.org/download/ff1010bird/ff1010bird_wav.zip",
checksum="2f4e7e194ccbd3de86e997af8f2a0405",
unpack_directories=["wav"],
),
"metadata": download_utils.RemoteFileMetadata(
filename="ff1010bird_metadata_2018.csv",
url="https://ndownloader.figshare.com/files/10853303",
checksum="2f4e7e194ccbd3de86e997af8f2a0405",
),
}
LICENSE_INFO = "Creative Commons Attribution Non Commercial 4.0 International"
[docs]class Clip(core.Clip):
"""freefield1010 Clip class
Args:
clip_id (str): id of the clip
Attributes:
audio (np.ndarray, float): path to the audio file
audio_path (str): path to the audio file
itemid (str): clip id
datasetid (str): the dataset to which the clip belongs to
hasbird (str): indication of whether the clips contains bird sounds (0/1)
"""
def __init__(self, clip_id, data_home, dataset_name, index, metadata):
super().__init__(clip_id, data_home, dataset_name, index, metadata)
self.audio_path = self.get_path("audio")
@property
def audio(self) -> Optional[Tuple[np.ndarray, float]]:
"""The clip's audio
Returns:
* np.ndarray - audio signal
* float - sample rate
"""
return load_audio(self.audio_path)
@property
def item_id(self):
"""The clip's item ID.
Returns:
* str - ID of the clip
"""
return self._clip_metadata.get("itemid")
@property
def dataset_id(self):
"""The clip's dataset ID.
Returns:
* str - ID of the dataset from where this clip is extracted
"""
return self._clip_metadata.get("datasetid")
@property
def has_bird(self):
"""The flag to tell whether the clip has bird sound or not.
Returns:
* str - 1/0 depending on whether the clip contains bird sound
"""
return self._clip_metadata.get("hasbird")
[docs] def to_jams(self):
"""Get the clip's data in jams format
Returns:
jams.JAMS: the clip's data in jams format
"""
return jams_utils.jams_converter(
audio_path=self.audio_path, metadata=self._clip_metadata
)
[docs]@io.coerce_to_bytes_io
def load_audio(fhandle: BinaryIO, sr=44100) -> Tuple[np.ndarray, float]:
"""Load a freefield1010 audio file.
Args:
fhandle (str or file-like): File-like object or path to audio file
sr (int or None): sample rate for loaded audio, 44100 Hz by default.
If different from file's sample rate it will be resampled on load.
Use None to load the file using its original sample rate (sample rate
varies from file to file).
Returns:
* np.ndarray - the mono audio signal
* float - The sample rate of the audio file
"""
audio, sr = librosa.load(fhandle, sr=sr, mono=True)
return audio, sr
[docs]@core.docstring_inherit(core.Dataset)
class Dataset(core.Dataset):
"""
The freefield1010 dataset
"""
def __init__(self, data_home=None):
super().__init__(
data_home,
name="freefield1010",
clip_class=Clip,
bibtex=BIBTEX,
remotes=REMOTES,
license_info=LICENSE_INFO,
)
[docs] @core.copy_docs(load_audio)
def load_audio(self, *args, **kwargs):
return load_audio(*args, **kwargs)
@core.cached_property
def _metadata(self):
metadata_path = os.path.join(self.data_home, "ff1010bird_metadata_2018.csv")
if not os.path.exists(metadata_path):
raise FileNotFoundError(
f"Metadata file not found at {metadata_path}. Did you run .download()?"
)
with open(metadata_path, "r") as fhandle:
reader = csv.reader(fhandle, delimiter=",")
raw_data = [line for line in reader if line[0] != "slice_file_name"]
metadata_index = {}
for line in raw_data:
clip_id = line[0].replace(".wav", "")
metadata_index[clip_id] = {
"itemid": line[0],
"datasetid": line[1],
"hasbird": line[2],
}
return metadata_index