para

use NativeCall;

unit module OpenMPT::Bindings::Types;

enum OpenMPTError is export (
    OPENMPT_ERROR_OK                     => 0,
    OPENMPT_ERROR_UNKNOWN                => 257,
    OPENMPT_ERROR_EXCEPTION              => 267,
    OPENMPT_ERROR_OUT_OF_MEMORY          => 277,
    OPENMPT_ERROR_RUNTIME                => 286,
    OPENMPT_ERROR_RANGE                  => 287,
    OPENMPT_ERROR_OVERFLOW               => 288,
    OPENMPT_ERROR_UNDERFLOW              => 289,
    OPENMPT_ERROR_LOGIC                  => 296,
    OPENMPT_ERROR_DOMAIN                 => 297,
    OPENMPT_ERROR_LENGTH                 => 298,
    OPENMPT_ERROR_OUT_OF_RANGE           => 299,
    OPENMPT_ERROR_INVALID_ARGUMENT       => 300,
    OPENMPT_ERROR_GENERAL                => 357,
    OPENMPT_ERROR_INVALID_MODULE_POINTER => 358,
    OPENMPT_ERROR_ARGUMENT_NULL_POINTER  => 359,
);

enum OpenMPTRenderParam is export (
    OPENMPT_MODULE_RENDER_MASTERGAIN_MILLIBEL        => 1,
    OPENMPT_MODULE_RENDER_STEREOSEPARATION_PERCENT   => 2,
    OPENMPT_MODULE_RENDER_INTERPOLATIONFILTER_LENGTH => 3,
    OPENMPT_MODULE_RENDER_VOLUMERAMPING_STRENGTH     => 4,
);

enum OpenMPTProbeFlags is export (
    OPENMPT_PROBE_FILE_HEADER_FLAGS_MODULES    => 0x01,
    OPENMPT_PROBE_FILE_HEADER_FLAGS_CONTAINERS => 0x02,
    OPENMPT_PROBE_FILE_HEADER_FLAGS_DEFAULT    => 0x03,
    OPENMPT_PROBE_FILE_HEADER_FLAGS_NONE       => 0x00,
);

enum OpenMPTProbeResult is export (
    OPENMPT_PROBE_FILE_HEADER_RESULT_SUCCESS     => 1,
    OPENMPT_PROBE_FILE_HEADER_RESULT_FAILURE     => 0,
    OPENMPT_PROBE_FILE_HEADER_RESULT_WANTMOREDATA => -1,
    OPENMPT_PROBE_FILE_HEADER_RESULT_ERROR       => -255,
);

enum OpenMPTErrorFuncResult is export (
    OPENMPT_ERROR_FUNC_RESULT_NONE    => 0,
    OPENMPT_ERROR_FUNC_RESULT_LOG     => 1,
    OPENMPT_ERROR_FUNC_RESULT_STORE   => 2,
    OPENMPT_ERROR_FUNC_RESULT_DEFAULT => 3,
);

enum OpenMPTCommandIndex is export (
    OPENMPT_MODULE_COMMAND_NOTE      => 0,
    OPENMPT_MODULE_COMMAND_INSTRUMENT => 1,
    OPENMPT_MODULE_COMMAND_VOLUMEEFFECT => 2,
    OPENMPT_MODULE_COMMAND_EFFECT    => 3,
    OPENMPT_MODULE_COMMAND_VOLUME    => 4,
    OPENMPT_MODULE_COMMAND_PARAMETER => 5,
);

# ============================================================================
# libopenmpt_ext interface structs
# ============================================================================

class ExtInterfacePatternVis is repr('CStruct') is export {
    has Pointer[void] $.get_pattern_row_channel_volume_effect_type;
    has Pointer[void] $.get_pattern_row_channel_effect_type;
}

class ExtInterfaceInteractive is repr('CStruct') is export {
    has Pointer[void] $.set_current_speed;
    has Pointer[void] $.set_current_tempo;
    has Pointer[void] $.set_tempo_factor;
    has Pointer[void] $.get_tempo_factor;
    has Pointer[void] $.set_pitch_factor;
    has Pointer[void] $.get_pitch_factor;
    has Pointer[void] $.set_global_volume;
    has Pointer[void] $.get_global_volume;
    has Pointer[void] $.set_channel_volume;
    has Pointer[void] $.get_channel_volume;
    has Pointer[void] $.set_channel_mute_status;
    has Pointer[void] $.get_channel_mute_status;
    has Pointer[void] $.set_instrument_mute_status;
    has Pointer[void] $.get_instrument_mute_status;
    has Pointer[void] $.play_note;
    has Pointer[void] $.stop_note;
}

class ExtInterfaceInteractive2 is repr('CStruct') is export {
    has Pointer[void] $.note_off;
    has Pointer[void] $.note_fade;
    has Pointer[void] $.set_channel_panning;
    has Pointer[void] $.get_channel_panning;
    has Pointer[void] $.set_note_finetune;
    has Pointer[void] $.get_note_finetune;
}

class ExtInterfaceInteractive3 is repr('CStruct') is export {
    has Pointer[void] $.set_current_tempo2;
}



head

OpenMPT::Bindings::Types - Enums and CStruct types for libopenmpt bindings


Defines the enums and C-compatible structures used across the bindings.


Error codes returned by libopenmpt C API functions.


item

Render parameter identifiers for C<openmpt_module_get/set_render_param>.


Return values from C<openmpt_probe_file_header>.


Return values from error callback functions.


root

Bindings

Native

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<AI|file:../mcp/index.podlite>
=para L<Download |file:../download/index.podlite>
=para L<About|file:../about/index.podlite>
=para 🔍 K<⌘K>/K<ctrl-K>
=end React


=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<Download | file:../download/index.podlite>
    =item2 L<Raku cheat sheet|https://github.com/Raku/mu/blob/master/docs/Perl6/Cheatsheet/cheatsheet.txt>
    =item2 L<Raku on Exercism|https://exercism.org/tracks/raku>
    =item2 L<Wikipedia|https://en.wikipedia.org/wiki/Raku_(programming_language)>

=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>
    =item2 L<Hand these documents to an AI assistant|file:../mcp/index.podlite>

=end nested
=begin nested :!nested
=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/>

=end nested
=end React


Built with L<Podlite|https://podlite.org> — the markup and publishing tools behind this site.


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


Types

NAME

DESCRIPTION

ENUMS

OpenMPTError

OpenMPTRenderParam

OpenMPTProbeFlags

OpenMPTProbeResult

OpenMPTErrorFuncResult

OpenMPT::Bindings v0.0.3

Authors

License

Dependencies

Test Dependencies

Provides

Documentation