head

Image

code

root

para

L<Examples| file:../examples/index.podlite>


L<Download |file:../download/index.podlite>


React

=begin React :component<HeaderCol> :id<menu> 
=para L<Documentation|/doc/introduction>
=para L<Modules| /mods>
=para L<Examples| file:../examples/index.podlite>
=para L<Download |file:../download/index.podlite>
=para L<About|file:../about/index.podlite>
=para 🔍 K<⌘K>/K<ctrl-K>
=end React


HEADER

FOOTER

README

Documentation

Audio::Hydrogen::Song - description of a song


The song file is a standalone file with the extension C<.h2song> which
contains the descriptions of the patterns and instruments that make up
a "song" in Hydrogen. There can be any number of patterns and these can
be arranged in groups as pattern sequences.  The instruments can either
be copied from a drumkit or can be created afresh as required.


For a song file to be usable in Hydrogen it needs only at least one pattern
and any instruments that may be used, the application will supply its own
defaults if needed.


This is L<Version> object that represents the version of Hydrogen that created
the song file. This defaults to "0.9.5" which is the version I tested with, but
it may have some impact on the way some values are interpreted.


This is the BPM as an integer, it defaults to 120.


This is the global volume as a Rat, it defaults to 1.0


This is the volume of the built in metronome, it defaults
to 0.0


This is the user visible name of the song, it can be left blank.


This is some text describing the author of the song, it may be blank.


Some free text notes regarding the song, it may be blank.


A Bool which is by default not set, it appears that Hydrogen itself
defaults to True though.


This is a string which may be "pattern" or "song" to determine the
playback mode of Hydrogen, the default is "pattern".


This is a Rat in the range 0 .. 1.0 that determines the extent to
which a small random change is applied to the timing of notes. By
default it isn't set which means time isn't "humanized".


This is a Rat in the range 0 .. 1.0 that determines the extent to
which a small random change is applied to the velocity of notes.
By default it isn't set which means velocity isn't "humanized".


This is a factor that adjusts the probability that the timing
of a note will be altered by some amount. I'm not quite sure
of the algorithm used. By default it isn't set which means there
is no "swing".  A good description of the notion of "swing" in
terms of electronic sequencers can be found in this interview
with Roger Linn who largely invented the idea:


https://www.attackmagazine.com/features/interview/roger-linn-swing-groove-magic-mpc-timing/


This is a list of L<Audio::Hydrogen::Pattern> objects. There should be at least one and they
should all have a unique name.


This is a list of L<Audio::Hydrogen::Instrument> objects.  The id attributes of the instruments
should be unique and should be those referenced by the patterns.  The sample filenames (either
single or those in layers,) should be absolute paths (unlike those in drumkits that may be
relative to the drumkit directory.)


This is an ordered list of PatternGroup objects, which in turn contains a on ordered list of
C<pattern-id> Strs which refer to the patterns in the group.


This is a list of Plugin objects that describe the LADSPA plugins that are configured for the
song, there may only be four plugins per song (at least in the UI.) The Plugin object has the
attributes:


The name of the Plugin as will be displayed (determined from the plugin when it is loaded.)


This is the filename (a .so file typically) that the plugin was loaded from, it appears to
default to '-'.


A Bool indicating whether the plugin is enabled.



use XML::Class;
use Audio::Hydrogen::Pattern;
use Audio::Hydrogen::Instrument;

class Audio::Hydrogen::Song does XML::Class[xml-element => 'song'] {
    sub from-version(Version $v --> Str) { $v.Str }
    sub to-version(Str $v --> Version)   { Version.new($v) }
    has Version $.version is xml-element is xml-serialise(&from-version) is xml-deserialise(&to-version) = Version.new("0.9.5");
    has Int     $.bpm               is xml-element is rw = 120;
    has Rat     $.volume            is xml-element is rw = 1.0;
    has Rat     $.metronome-volume  is xml-element('metronomeVolume') is rw;
    has Str     $.name              is xml-element is rw;
    has Str     $.author            is xml-element is rw;
    has Str     $.notes             is xml-element is rw;
    has Str     $.license           is xml-element is rw;
    has Bool    $.loop-enabled      is xml-element('loopEnabled') is rw;
    has Str     $.mode              is xml-element is rw = "pattern";
    has Rat     $.humanize-time     is xml-element('humanize_time') is rw;
    has Rat     $.humanize-velocity is xml-element('humanize_velocity') is rw;
    has Rat     $.swing-factor      is xml-element('swing_factor') is rw;
    has Audio::Hydrogen::Instrument @.instruments is xml-container('instrumentList');
    has Audio::Hydrogen::Pattern    @.patterns    is xml-container('patternList');

    class PatternGroup does XML::Class[xml-element => 'group'] {
        has @.pattern-id is xml-element('patternID');
    }

    has PatternGroup @.pattern-sequence is xml-container('patternSequence');

    class Plugin does XML::Class[xml-element => 'fx'] {
        has Str $.name  is xml-element = 'no plugin';
        has Str $.filename is xml-element = '-';
        has Bool $.enabled is xml-element = False;
        has Rat  $.volume  is xml-element = 0.0;
    }

    has Plugin @.plugins is xml-container('ladspa');
}
# vim: expandtab shiftwidth=4 ft=raku


Song

The Raku Knowledge Base


=begin React :component<HeaderCol> :id<footer>  
=begin nested :!nested
=item1 B<Language>
    =item2 L<Get started|file:../getting-started/getting-started.podlite>
    =item2 L<Why Raku?|/doc/language/faq#Why-should-I-learn-Raku-What's-so-great-about-it>
    =item2 L<Try Raku|https://glot.io/new/raku>
    =item2 L<Raku cheat sheet|https://github.com/Raku/mu/blob/master/docs/Perl6/Cheatsheet/cheatsheet.txt>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<Raku on Exercism|https://exercism.org/tracks/raku>
    =item2 L<Wikipedia|https://en.wikipedia.org/wiki/Raku_(programming_language)>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>

=end nested
=begin nested :!nested

=item1 B<L<Documentation|/doc>>
    =item2 L<Getting started, Migration guides from other languages, & Tutorials | file:../doc/introduction.podlite>
    =item2 L<Language References|file:../doc/reference.podlite>
    =item2 L<Type Reference| file:../doc/types.podlite>
    =item2 L<Miscellaneous| file:../doc/miscellaneous.podlite>
    =item2 L<FAQs (Frequently Asked Questions)|/doc/language/faq>
    =item2 L<Community|/doc/language/community>
    =item2 L<The list of all documents|file:../doc/index.podlite>

=item1 B<Resources>
    =item2 L<The Raku Guide|https://raku.guide/>
    =item2 L<Books |https://perl6book.com/>
    =item2 L<Rosetta Code | https://www.raku.org/community/rosettacode>

=end nested
=begin nested :!nested

=item1 B<Resoures>
    =item2 L<Download | file:../download/index.podlite>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>

=item1 B<Learning>
    =item2 L<The Raku Guide|https://raku.guide/>
    =item2 L<Wikibook |https://en.wikibooks.org/wiki/Raku_Programming>
    =item2 L<Books |https://perl6book.com/>
    =item2 L<Rosetta Code | https://www.raku.org/community/rosettacode>
    =item2 L<Learn Raku in Y minutes|https://learnxinyminutes.com/docs/raku/>
    =item2 L<Golfing |https://github.com/AlexDaniel/raku-golf-cheatsheet>
=end nested
=begin nested :!nested

=item1 B<Explore>
    =item2 L<Raku Blog Aggregator|https://planet.raku.org/>
    =item2 L<Rakudo Weekly|https://rakudoweekly.blog/>
    =item2 L<The Weekly Challenge |https://perlweeklychallenge.org/>
    =item2 L<Raku Advent Calendar|https://raku-advent.blog/>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>

=end nested
=end React


=begin React :component<CookieConsent> :id<CookieConsent> :buttonCaption("Got it!")
=para
This website uses cookies for analytics.
=end React


README

Audio::Hydrogen

image i_github_com_jonathanstowe_audio_hydrogen_workflows_ci_badge_svg not found

Synopsis

Description

Installation

Support

Licence

Audio::Hydrogen v0.0.6

Authors

License

Dependencies

Test Dependencies

Provides

Documentation