Struct bliss_audio::Analysis

pub struct Analysis { /* fields omitted */ }

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 fn new(analysis: [f32; 20]) -> Analysis

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 as_arr1(&self) -> Array1<f32>

Return an ndarray Array1 representing the analysis’ features.

Particularly useful if you want to make a custom distance metric.

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

Return a Vec representing the analysis’ features.

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

pub fn custom_distance(
    &self,
    other: &Self,
    distance: impl DistanceMetric
) -> f32

Compute distance between two analysis using a user-provided distance metric. You most likely want to use song.custom_distance directly rather than this function.

For this function to be integrated properly with the rest of bliss’ parts, it should be a valid distance metric, i.e.:

1. For X, Y real vectors, d(X, Y) = 0 ⇔ X = Y
2. For X, Y real vectors, d(X, Y) >= 0
3. For X, Y real vectors, d(X, Y) = d(Y, X)
4. For X, Y, Z real vectors d(X, Y) ≤ d(X + Z) + d(Z, Y)

Note that almost all distance metrics you will find obey these properties, so don’t sweat it too much.

Trait Implementations

impl Clone for Analysis

fn clone(&self) -> Analysis

Returns a copy 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 Index<AnalysisIndex> for Analysis

type Output = f32

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl PartialEq<Analysis> for Analysis

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Copy for Analysis

impl StructuralPartialEq for Analysis