devela/media/audio/

drum_machine.rs

// devela::media::audio::drum_machine
//
//!
//
// TODO
// - DrumGrid
// - DrumFlags
//
// - Define subsets
// - 8-bit
// - 16-bit
// - 128-bit full? GM?

// - convert From and TryFrom 8 and 16)
// - [ ] define docs with CONST macro.
// - enum DrumEvent MAYBE
// - parser from str

#![allow(unused, reason = "WIP")]

#[cfg(_bit··)]
use crate::{bitfield, enumset};

#[cfg(feature = "_bit_u8")]
bitfield! {
    /// A set of 8 drum instruments.
    pub struct DrumFrame8(u8) {
        /* Cymbals */

        /// Cymbal.
        ///
        /// Ride or crash cymbal, depending on context.
        ///
        /// Adds texture and color, often marking transitions or downbeats.
        CY: 0;

        /// Closed Hi-Hat.
        ///
        /// A hi-hat played with the cymbals closed. Produces a short, crisp "chick" sound.
        ///
        /// Drives the rhythm with a tight, precise feel.
        CH: 1;
        /// Open Hi-Hat.
        ///
        /// A hi-hat played with the cymbals slightly apart. Produces a longer, sustaining sound.
        ///
        /// Adds variation and accentuates beats or fills.
        OH: 2;

        /* Drums */

        /// Bass Drum.
        ///
        /// The largest drum, played with a foot pedal, producing a deep, resonant sound.
        ///
        /// Anchors the rhythm, often providing the downbeat in patterns.
        BD: 3;
        /// Snare Drum.
        ///
        /// A drum with snares (metal wires) underneath, producing a sharp, cracking sound.
        ///
        /// Central to most drum patterns, providing backbeat on the 2nd and 4th beats in 4/4 time.
        SD: 4;

        /* Toms */

        /// Low Tom.
        ///
        /// The largest and lowest-pitched tom in a drum set (sometimes called the floor tom).
        ///
        /// Adds weight and depth, commonly used in fills and breakdowns.
        LT: 5;

        /* Auxiliary */

        /// Claps.
        ///
        /// A synthesized or sampled handclap sound.
        ///
        /// Provides a human touch to electronic grooves or reinforces the snare in patterns.
        CPS: 6;

        /// Cowbell.
        ///
        /// A metallic percussion instrument producing a distinct, ringing tone.
        ///
        /// Adds syncopation or an off-beat feel, famously used in Latin and funk rhythms.
        CB: 7;

        /* masks */

        /// Cymbals.
        CYMBALS: 0, 2;

        /// Drums.
        DRUMS: 3, 4;

        /// Toms.
        TOMS: 5;

        /// Auxiliary percussion.
        AUXILIARY: 6, 7;
    }
}

#[cfg(feature = "_bit_u16")]
bitfield! {
    /// A set of 16 drum instruments.
    pub struct DrumFrame16(u16) {
        /* Cymbals */

        /// Cymbal.
        ///
        /// Ride or crash cymbal, depending on context.
        ///
        /// Adds texture and color, often marking transitions or downbeats.
        CY: 0;

        /// Closed Hi-Hat.
        ///
        /// A hi-hat played with the cymbals closed. Produces a short, crisp "chick" sound.
        ///
        /// Drives the rhythm with a tight, precise feel.
        CH: 1;
        /// Open Hi-Hat.
        ///
        /// A hi-hat played with the cymbals slightly apart. Produces a longer, sustaining sound.
        ///
        /// Adds variation and accentuates beats or fills.
        OH: 2;

        /// Splash Cymbal.
        ///
        /// A small cymbal with a short, bright sound for quick accents.
        ///
        /// Provides a quick, bright accent, frequently used in transitions.
        SP: 3;

        /* Drums */

        /// Bass Drum.
        ///
        /// The largest drum, played with a foot pedal, producing a deep, resonant sound.
        ///
        /// Anchors the rhythm, often providing the downbeat in patterns.
        BD: 4;
        /// Snare Drum.
        ///
        /// A drum with snares (metal wires) underneath, producing a sharp, cracking sound.
        ///
        /// Central to most drum patterns, providing backbeat on the 2nd and 4th beats in 4/4 time.
        SD: 5;
        /// Rim Shot.
        ///
        /// A snare drum technique where the stick strikes both the rim and the head simultaneously.
        ///
        /// Adds a louder, more emphatic snare hit for accents or dynamic variation.
        RS: 6;

        /* Toms */

        /// High Tom.
        ///
        /// The smallest and highest-pitched tom in a drum set.
        ///
        /// Adds melodic or percussive fills, often used for quick accents.
        HT: 7;
        /// Mid Tom.
        ///
        /// A tom with a pitch between the high tom and low tom.
        ///
        /// Bridges the high and low toms in fills, creating smoother transitions.
        MT: 8;
        /// Low Tom.
        ///
        /// The largest and lowest-pitched tom in a drum set (sometimes called the floor tom).
        ///
        /// Adds weight and depth, commonly used in fills and breakdowns.
        LT: 9;

        /* Auxiliary */

        /// Accent (dynamic marking).
        ///
        /// A non-pitched percussive hit used to emphasize specific beats in the rhythm.
        ///
        /// Provides dynamic emphasis in patterns, helping to punctuate the groove.
        AC: 10;

        /// Claps.
        ///
        /// A synthesized or sampled handclap sound.
        ///
        /// Provides a human touch to electronic grooves or reinforces the snare in patterns.
        CPS: 11;

        /// Cowbell.
        ///
        /// A metallic percussion instrument producing a distinct, ringing tone.
        ///
        /// Adds syncopation or an off-beat feel, famously used in Latin and funk rhythms.
        CB: 12;

        /* other */

        /// Tambourine.
        ///
        /// Produces a jingling sound from its zills (metal discs).
        ///
        /// Often used for embellishment or to add a rhythmic shimmer or subdivision.
        TAM: 13;

        /// Shaker.
        ///
        /// Complements patterns with soft, steady motion, often for 16th-note grooves.
        SH: 14;

        /// Woodblock
        ///
        /// A sharp, percussive sound used in many styles, especially electronic music.
        WB: 15;

        /* Extra that don't fit */

        // /// Clave
        // CL: 16;

        // /// Triangle.
        // TR: 17;

        /* masks */

        /// Cymbals.
        CYMBALS: 0, 3;

        /// Drums.
        DRUMS: 4, 6;

        /// Toms.
        TOMS: 7, 9;

        /// Auxiliary percussion.
        AUXILIARY: 10, 15;

        // /// High-Hat (either open or closed)
        // HH: 2, 3;
    }
}

/* dynamics */
// * Accent:
// - Flam: A rapid grace note before the main hit, often used on snare or toms.
// - Ghost Note: A very soft hit, often on the snare.
// - Roll: A series of rapid hits, typically used on snare or toms.
// - Velocity: Low
// - Velocity: Medium
// - Velocity: High
// - Choke: Muting a cymbal immediately after striking it.?