compose_as_waveform

scikitplot.doremi.compose_as_waveform(composition='\n# Format: NoteOctave-Duration\n# NoteOctave: Musical note + octave number (e.g., G4 means G in the 4th octave)\n# Duration: Length of the note (relative)\n#   1   = quarter note\n#  0.5  = eighth note\n#   2   = half note\n#\n# Happy Birthday Melody — Western notation with lyrics:\n\nG4-0.5    -  G4-0.25   -  A4-0.5    -  G4-0.5    -  C5-0.5    -  B4-1\n# "Happy"    "birth-"   "day"     "to"     "you"\n\nG4-0.5    -  G4-0.25   -  A4-0.5    -  G4-0.5    -  D5-0.5    -  C5-1\n# "Happy"    "birth-"   "day"     "to"     "you"\n\nG4-0.5    -  G4-0.25   -  G5-0.5    -  E5-0.5    -  C5-0.5    -  B4-0.5    -  A4-1\n# "Happy"    "birth-"   "day"     "dear"    "[Name]"\n\nF5-0.5    -  F5-0.25   -  E5-0.5    -  C5-0.5    -  D5-0.5    -  C5-1\n# "Happy"    "birth-"   "day"     "to"     "you"\n', envelope='hann', **kwargs)

Generate a concatenated waveform from a musical composition input.

Parameters:

compositionstr or list of tuples or dict, optional

Musical composition to synthesize. Supported formats:

• str: Musical notation string, e.g. “C4-0.5 G4-0.5”

• list of tuples: [(‘C’, 4, 0.5), (‘G’, 4, 0.5), …]

• dict: {‘notes’: [{‘note’: ‘C’, ‘octave’: 4, ‘duration’: 0.5}, …]}

Defaults to an internal sample SHEET.

envelopestr or callable, optional

Envelope to shape amplitude over time. Choose from: ‘hann’, ‘soft’, ‘triangular’, or provide a custom function.

**kwargsdict

Additional keyword arguments passed to note_to_sine_wave, such as amplitude, envelope, sample_rate, etc.

Returns:

np.ndarray

Concatenated audio waveform representing the full composition.

Parameters:

• composition (str | list[tuple[str, int, float]] | dict)

• envelope (Union[str, callable[[np.ndarray, float], np.ndarray], None])

Return type:

ndarray

Notes

• Invalid or unrecognized note tokens are skipped silently.

• Octave and duration must be numeric values.

• Supports rests, generating silence of appropriate duration.