1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101

// The MIT License (MIT)
//
// Copyright (c) 2013 Jeremy Letang (letang.jeremy@gmail.com)
//
// Permission is hereby granted, free of charge, to any person obtaining a copy of
// this software and associated documentation files (the "Software"), to deal in
// the Software without restriction, including without limitation the rights to
// use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
// the Software, and to permit persons to whom the Software is furnished to do so,
// subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
// FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
// COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
// IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
// CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

//! The tags extracted from an audio file.

use sndfile::SndFile;
use sndfile::StringSoundType::{
    Title,
    Copyright,
    Software,
    Artist,
    Comment,
    Date,
    Album,
    License,
    TrackNumber,
    Genre
};

/**
 * Structure containing the tags of a sound.
 *
 * If the tags doesn't exist in the sound file, the string is "".
 */
#[derive(Clone, Debug, PartialEq)]
pub struct Tags {
    /// The title of the sound as a String
    pub title: String,
    /// The Copyright of the sound as a String
    pub copyright: String,
    /// The name of the software used to create the sound as a String
    pub software: String,
    /// The name of the artist of the sound as a String
    pub artist: String,
    /// A comment as a String
    pub comment: String,
    /// The creation date of the sound as a String
    pub date: String,
    /// The name of the album where the sound come from as a String
    pub album: String,
    /// The license of the sound as a String
    pub license: String,
    /// The tracknumber of the sound as a String
    pub track_number: String,
    /// The genre of the sound as a String
    pub genre: String
}

pub fn empty() -> Tags {
    Tags {
        title: "".to_string(),
        copyright: "".to_string(),
        software: "".to_string(),
        artist: "".to_string(),
        comment: "".to_string(),
        date: "".to_string(),
        album: "".to_string(),
        license: "".to_string(),
        track_number: "".to_string(),
        genre: "".to_string()
    }
}

pub fn get_sound_tags(file: &SndFile) -> Tags {
    Tags {
        title: file.get_string(Title).unwrap_or("".to_string()),
        copyright: file.get_string(Copyright).unwrap_or("".to_string()),
        software: file.get_string(Software).unwrap_or("".to_string()),
        artist: file.get_string(Artist).unwrap_or("".to_string()),
        comment: file.get_string(Comment).unwrap_or("".to_string()),
        date: file.get_string(Date).unwrap_or("".to_string()),
        album: file.get_string(Album).unwrap_or("".to_string()),
        license: file.get_string(License).unwrap_or("".to_string()),
        track_number: file.get_string(TrackNumber).unwrap_or("".to_string()),
        genre: file.get_string(Genre).unwrap_or("".to_string())
    }
}

/// AudioTags trait implemented by all struct who can provides audio.
pub trait AudioTags{
    /// Get the tags of the audio source.
    fn get_tags(&self) -> Tags;
}