Struct AnalyzeArgs 

pub struct AnalyzeArgs {
    pub stem: PathBuf,
    pub bpm: Bpm,
    pub bpm_exact: bool,
    pub notes: Option<PathBuf>,
    pub profile: Option<Profile>,
    pub out: Option<PathBuf>,
    pub force: bool,
    pub synth: Option<Synth>,
}

Arguments of analyze.

Fields

stem: PathBuf

The audio stem: WAV, AIFF, FLAC, MP3, AAC or M4A.

bpm: Bpm

The tempo of the stem in beats per minute, 4 to 1000. It is refined from the stem, 2.91 % below to 3.09 % above it, unless –bpm-exact is given

bpm_exact: bool

Use –bpm as it is, without refining it from the stem

notes: Option<PathBuf>

A MIDI file with the stem’s notes, instead of transcribing the stem; the f0 track still reads the stem unless the notes play chords. Its tempo must match –bpm or the refined tempo

profile: Option<Profile>

Decode with the settings of this kind of stem instead of the detected ones

out: Option<PathBuf>

The output folder [default: a folder named after the stem, next to it]

force: bool

Replace files in the output folder that this stem’s report does not own: a report or notes of another stem, a report of the same name with other content, a file this tool did not write, or a spectrogram.png without a report

synth: Option<Synth>

The target synth that the report names [default: vital]

Implementations

impl AnalyzeArgs

pub fn synth(&self) -> Result<Synth, SynthError>

Resolves the target synth: the flag, else Vital, and only a synth with an adapter.

Errors

SynthError::NotBuilt for a synth without an adapter.

Trait Implementations

impl Args for AnalyzeArgs

fn group_id() -> Option<Id>

Report the [ArgGroup::id][crate::ArgGroup::id] for this set of arguments

fn augment_args<'b>(__clap_app: Command) -> Command

Append to [Command] so it can instantiate Self via [FromArgMatches::from_arg_matches_mut]

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to [Command] so it can instantiate self via [FromArgMatches::update_from_arg_matches_mut]

impl Debug for AnalyzeArgs

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

Formats the value using the given formatter.

impl FromArgMatches for AnalyzeArgs

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.