Struct Analysis 

pub struct Analysis { /* private fields */ }

Object holding the results of the song’s analysis.

Only use it if you want to have an in-depth look of what is happening behind the scene, or make a distance metric yourself.

Under the hood, it is just an array of f32 holding different numeric features.

For more info on the different features, build the documentation with private items included using cargo doc --document-private-items, and / or read up this document, that contains a description on most of the features, except the chroma ones, which are documented directly in this code.

Implementations

impl Analysis

pub const fn new(analysis: [Feature; 20]) -> Self

Create a new Analysis object.

Usually not needed, unless you have already computed and stored features somewhere, and need to recreate a Song with an already existing Analysis yourself.

pub fn from_vec(features: Vec<Feature>) -> Result<Self, AnalysisError>

Creates a new Analysis object from a Vec<Feature>.

invariant: features.len() == NUMBER_FEATURES

Errors

This function will return an error if the length of the features is not equal to NUMBER_FEATURES.

pub const fn inner(&self) -> &[Feature; 20]

Return the inner array of the analysis. This is mostly useful if you want to store the features somewhere.

pub fn as_vec(&self) -> Vec<Feature>

Return a Vec<f32> representing the analysis’ features.

Particularly useful if you want iterate through the values to store them somewhere.

pub fn from_samples(audio: &ResampledAudio) -> AnalysisResult<Self>

Create an Analysis object from a ResampledAudio. This is the main function you should use to create an Analysis object. It will compute all the features from the audio samples. You can get a ResampledAudio object by using a Decoder to decode an audio file.

Errors

This function will return an error if the samples are empty or too short. Or if there is an error during the analysis.

Panics

This function will panic it cannot join the threads.

Trait Implementations

impl Clone for Analysis

fn clone(&self) -> Analysis

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Analysis

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Analysis

fn default() -> Analysis

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Analysis

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Index<AnalysisIndex> for Analysis

type Output = f64

The returned type after indexing.

fn index(&self, index: AnalysisIndex) -> &Feature

Performs the indexing (container[index]) operation.

impl Index<usize> for Analysis

type Output = f64

The returned type after indexing.

fn index(&self, index: usize) -> &Feature

Performs the indexing (container[index]) operation.

impl PartialEq for Analysis

fn eq(&self, other: &Analysis) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Analysis

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryInto<Analysis> for ResampledAudio

type Error = AnalysisError

The type returned in the event of a conversion error.

fn try_into(self) -> Result<Analysis, Self::Error>

Performs the conversion.

impl Copy for Analysis

impl StructuralPartialEq for Analysis