tsk-50: Added properties

Closes #49

Reviewed-on: #51
Co-authored-by: phoenix <kundeng00@pm.me>
Co-committed-by: phoenix <kundeng00@pm.me>

.gitea/workflows/tag_release.yml

@@ -4,6 +4,9 @@ on:
   push:
     branches:
       - main
+  pull_request:
+    branches:
+      - main
 
 jobs:
   release:

Cargo.lock

@@ -104,7 +104,7 @@ dependencies = [
 
 [[package]]
 name = "icarus_meta"
-version = "0.4.2"
+version = "0.4.4"
 dependencies = [
  "imghdr",
  "infer",

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "icarus_meta"
-version = "0.4.2"
+version = "0.4.4"
 edition = "2024"
 rust-version = "1.90"
 

src/detection/coverart.rs

@@ -1,8 +1,16 @@
 /// Gets the file type of a CoverArt given it's path
-pub fn file_type_from_filepath(filepath: &str) -> Result<String, std::io::Error> {
+pub fn file_type_from_filepath(
+    filepath: &str,
+) -> Result<crate::detection::FileType, std::io::Error> {
     match imghdr::from_file(filepath) {
-        Ok(Some(imghdr::Type::Jpeg)) => Ok(String::from("jpeg")),
-        Ok(Some(imghdr::Type::Png)) => Ok(String::from("png")),
+        Ok(Some(imghdr::Type::Jpeg)) => Ok(crate::detection::FileType {
+            mime: String::from(constants::mime::JPEG),
+            file_type: String::from(constants::JPEG_TYPE),
+        }),
+        Ok(Some(imghdr::Type::Png)) => Ok(crate::detection::FileType {
+            mime: String::from(constants::mime::PNG),
+            file_type: String::from(constants::PNG_TYPE),
+        }),
         Ok(None) => Err(std::io::Error::other("Image file not supported")),
         Err(err) => Err(err),
         _ => Err(std::io::Error::other("Image file not supported")),
@@ -10,15 +18,32 @@ pub fn file_type_from_filepath(filepath: &str) -> Result<String, std::io::Error>
 }
 
 /// Gets the file type of a CoverArt given it's data
-pub fn file_type_from_data(data: &Vec<u8>) -> Result<String, std::io::Error> {
+pub fn file_type_from_data(data: &Vec<u8>) -> Result<crate::detection::FileType, std::io::Error> {
     match imghdr::from_bytes(data) {
-        Some(imghdr::Type::Jpeg) => Ok(String::from("jpeg")),
-        Some(imghdr::Type::Png) => Ok(String::from("png")),
+        Some(imghdr::Type::Jpeg) => Ok(crate::detection::FileType {
+            mime: String::from(constants::mime::JPEG),
+            file_type: String::from(constants::JPEG_TYPE),
+        }),
+        Some(imghdr::Type::Png) => Ok(crate::detection::FileType {
+            mime: String::from(constants::mime::PNG),
+            file_type: String::from(constants::PNG_TYPE),
+        }),
         None => Err(std::io::Error::other("Image file not supported")),
         _ => Err(std::io::Error::other("Image file not supported")),
     }
 }
 
+pub mod constants {
+    pub const PNG_TYPE: &str = "png";
+    pub const JPEG_TYPE: &str = "jpeg";
+    pub const JPG_TYPE: &str = "jpg";
+
+    pub mod mime {
+        pub const JPEG: &str = "image/jpeg";
+        pub const PNG: &str = "image/png";
+    }
+}
+
 #[cfg(test)]
 mod tests {
     #[test]
@@ -30,7 +55,8 @@ mod tests {
         match super::file_type_from_filepath(&filepath) {
             Ok(filetype) => {
                 assert_eq!(
-                    filetype, "png",
+                    filetype.file_type,
+                    super::constants::PNG_TYPE,
                     "The file type of the CoverArt should have been png"
                 );
             }
@@ -50,7 +76,8 @@ mod tests {
         match super::file_type_from_data(&data) {
             Ok(filetype) => {
                 assert_eq!(
-                    filetype, "png",
+                    filetype.file_type,
+                    super::constants::PNG_TYPE,
                     "The file type of the CoverArt should have been png"
                 );
             }

src/detection/mod.rs

@@ -1 +1,34 @@
 pub mod coverart;
+pub mod song;
+
+#[derive(Debug, Default)]
+pub struct FileType {
+    pub mime: String,
+    pub file_type: String,
+}
+
+/// Initializes a FileType given a filetype passed.
+pub fn init_filetype(filetype: &str) -> Result<FileType, std::io::Error> {
+    if filetype == song::constants::FLAC_TYPE {
+        Ok(FileType {
+            mime: String::from(song::constants::mime::FLAC),
+            file_type: String::from(song::constants::FLAC_TYPE),
+        })
+    } else if filetype == coverart::constants::PNG_TYPE {
+        Ok(FileType {
+            mime: String::from(coverart::constants::mime::PNG),
+            file_type: String::from(coverart::constants::PNG_TYPE),
+        })
+    } else if filetype == coverart::constants::JPEG_TYPE
+        || filetype == coverart::constants::JPG_TYPE
+    {
+        Ok(FileType {
+            mime: String::from(coverart::constants::mime::JPEG),
+            file_type: String::from(coverart::constants::JPEG_TYPE),
+        })
+    } else {
+        Err(std::io::Error::other(format!(
+            "Unsupported FileType: {filetype:?}"
+        )))
+    }
+}

src/detection/song.rs

@@ -0,0 +1,90 @@
+/// Gets the file type of a Song from it's path
+pub fn file_type_from_filepath(
+    filepath: &str,
+) -> Result<crate::detection::FileType, std::io::Error> {
+    match infer::get_from_path(filepath) {
+        Ok(Some(kind)) => {
+            let mime = kind.mime_type();
+            if mime == constants::mime::FLAC {
+                Ok(crate::detection::FileType {
+                    mime: String::from(mime),
+                    file_type: String::from(constants::FLAC_TYPE),
+                })
+            } else {
+                Err(std::io::Error::other("Unsupported file type"))
+            }
+        }
+        Ok(None) => Err(std::io::Error::other("File type not determined")),
+        Err(err) => Err(err),
+    }
+}
+
+/// Gets the file type of a Song given it's data
+pub fn file_type_from_data(data: &[u8]) -> Result<crate::detection::FileType, std::io::Error> {
+    match infer::get(data) {
+        Some(kind) => {
+            let mime = kind.mime_type();
+            if mime == constants::mime::FLAC {
+                Ok(crate::detection::FileType {
+                    mime: String::from(mime),
+                    file_type: String::from(constants::FLAC_TYPE),
+                })
+            } else {
+                Err(std::io::Error::other("Unsupported file type"))
+            }
+        }
+        None => Err(std::io::Error::other("File type not determined")),
+    }
+}
+
+pub mod constants {
+    pub const FLAC_TYPE: &str = "flac";
+
+    pub mod mime {
+        pub const FLAC: &str = "audio/x-flac";
+    }
+}
+
+#[cfg(test)]
+mod tests {
+    #[test]
+    fn test_song_file_type() {
+        let directory = String::from(crate::test_util::util::TESTFILEDIRECTORY);
+        let filename = String::from("track01.flac");
+        let filepath = format!("{directory}/{filename}");
+
+        match super::file_type_from_filepath(&filepath) {
+            Ok(filetype) => {
+                assert_eq!(
+                    filetype.file_type,
+                    crate::detection::song::constants::FLAC_TYPE,
+                    "Types do not match"
+                )
+            }
+            Err(err) => {
+                assert!(false, "Error: {err:?}")
+            }
+        }
+    }
+
+    #[test]
+    fn test_song_file_type_from_data() {
+        let directory = String::from(crate::test_util::util::TESTFILEDIRECTORY);
+        let filename = String::from("track01.flac");
+        let filepath = format!("{directory}/{filename}");
+        let data = crate::test_util::util::get_data_from_file(&filepath).unwrap();
+
+        match super::file_type_from_data(&data) {
+            Ok(filetype) => {
+                assert_eq!(
+                    filetype.file_type,
+                    crate::detection::song::constants::FLAC_TYPE,
+                    "Types do not match"
+                )
+            }
+            Err(err) => {
+                assert!(false, "Error: {err:?}")
+            }
+        }
+    }
+}

src/properties/audio.rs

@@ -0,0 +1,16 @@
+use lofty::file::AudioFile;
+
+pub fn get_properties(songpath: &str) -> Result<lofty::flac::FlacProperties, std::io::Error> {
+    match std::fs::File::open(songpath) {
+        Ok(mut content) => {
+            match lofty::flac::FlacFile::read_from(&mut content, lofty::config::ParseOptions::new())
+            {
+                Ok(flac_file) => {
+                    Ok(*flac_file.properties())
+                }
+                Err(err) => Err(std::io::Error::other(err.to_string())),
+            }
+        }
+        Err(err) => Err(err),
+    }
+}

src/properties/mod.rs

@@ -1,21 +1,43 @@
-use lofty::file::AudioFile;
+pub mod audio;
 
-pub fn get_duration(song_path: &String) -> Result<std::time::Duration, std::io::Error> {
-    match std::fs::File::open(song_path) {
-        Ok(mut content) => {
-            match lofty::flac::FlacFile::read_from(&mut content, lofty::config::ParseOptions::new())
-            {
-                Ok(flac_file) => {
-                    let properties = flac_file.properties();
-                    Ok(properties.duration())
-                }
-                Err(err) => Err(std::io::Error::other(err.to_string())),
+
+#[derive(Clone, Debug, Default)]
+pub struct SongProperties {
+    pub duration: std::time::Duration,
+    pub sample_rate: u32,
+    pub bitrate: u32,
+    pub overall_bitrate: u32,
+    pub bit_depth: u8,
+    pub channels: u8,
 }
+
+
+pub fn get_song_properties(song_path: &str) -> Result<SongProperties, std::io::Error> {
+    match audio::get_properties(song_path) {
+        Ok(flac_properties) => {
+            Ok(SongProperties {
+                duration: flac_properties.duration(),
+                sample_rate: flac_properties.sample_rate(),
+                bitrate: flac_properties.audio_bitrate(),
+                overall_bitrate: flac_properties.overall_bitrate(),
+                bit_depth: flac_properties.bit_depth(),
+                channels: flac_properties.channels(),
+            })
         }
         Err(err) => Err(err),
     }
 }
 
+pub fn get_duration(song_path: &String) -> Result<std::time::Duration, std::io::Error> {
+    match get_song_properties(song_path) {
+        Ok(song_properties) => {
+            Ok(song_properties.duration)
+        }
+        Err(err) => Err(err),
+    }
+}
+
+
 #[cfg(test)]
 mod tests {
     use crate::test_util;