Struct RenderJob 

pub struct RenderJob { /* private fields */ }

One render: the preset state, the notes, the tempo and the recipe.

Implementations

impl RenderJob

pub fn new( state: PresetState, notes: Vec<RenderNote>, bpm: Bpm, ) -> Result<Self, RenderError>

Builds a job with the current recipe.

Errors

Returns RenderError::NoNotes for an empty note list.

pub fn from_midi( state: PresetState, path: &Path, bpm: Bpm, ) -> Result<Self, RenderError>

Builds a job that plays the notes of a MIDI file. The file is read as analyze --notes reads it, so every tempo in it must match bpm. Notes without a velocity take the recipe’s velocity. The record carries the SHA-256 of the file.

Errors

Returns RenderError::Midi for a file the MIDI reader refuses, and the errors of notes_of_list and RenderJob::new.

pub fn for_material(state: PresetState, material: Material, bpm: Bpm) -> Self

Builds a job that plays the recipe’s notes for material.

pub fn state(&self) -> &PresetState

Returns the preset state.

pub fn notes(&self) -> &[RenderNote]

Returns the notes.

pub fn bpm(&self) -> Bpm

Returns the tempo, which synced LFOs and delays follow.

pub fn recipe(&self) -> &Recipe

Returns the recipe.

pub fn with_controls(self, controls: Vec<Control>) -> Result<Self, RenderError>

Adds controller changes. The clip still ends by the notes and the tail, so a change after the clip’s end has no effect.

Errors

Returns RenderError::Play for a value that does not fit its MIDI message, as ControlKind::checked does.

pub fn controls(&self) -> &[Control]

Returns the controller changes.

pub fn midi_sha256(&self) -> Option<&str>

Returns the SHA-256 of the MIDI file the notes came from, in hex.

pub fn last_note_off(&self) -> Seconds

Returns the end of the last note.

Trait Implementations

impl Clone for RenderJob

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RenderJob

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

Formats the value using the given formatter.

impl PartialEq for RenderJob

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for RenderJob