tonikasoft / fpsdk Goto Github PK

View Code? Open in Web Editor NEW

13.0 2.0 2.0 253 KB

Rust port of FL Studio SDK

Home Page: https://docs.rs/fpsdk/

License: MIT License

Rust 66.74% C++ 31.40% C 1.11% Shell 0.27% Batchfile 0.47%

fl-studio audio fl-sdk

fpsdk's Introduction

fpsdk

Rust port of FL Studio SDK.

The FL Studio SDK provides you the API libraries and developer tools necessary to build, test, and debug plugins for FL Studio.

Example

The example demonstrates how to use this library.

To build it, run:

cargo build --release --example simple

To install it:

./install.mac.sh simple Simple -g # for macOS
./install.win.bat simple Simple -g # for Windows

Check out the corresponding script for your system for usage notes.

The plugin's log file is created at FL's resources root. It's /Applications/FL Studio 20.app/Contents/Resources/FL for macOS and <Drive>:\Program Files\Image-Line\FL Studio 20 for Windows.

fpsdk's People

Contributors

Stargazers

Watchers

Forkers

emily33901

fpsdk's Issues

Port TFruityPlug->Eff_Render

Should be exposed as plugin::Plugin::eff_render.

Example plugin causes FL to crash

When plugin is added to Mixer, the host sometimes crashes.

Port flags to Rust

The next types should be ported to Rust:

bitflags should be used if possible.

For undocumented types see src/cxx/fp_plugclass.h.

Checkout already implemented types to get an example.

Port TFruityPlugHost->OnControllerChanged

Should be exposed as host::Host::on_controller.

Port TFruityPlug->TriggerVoice

Part of #31

Should be exposed as plugin::Plugin::trigger_voice and return Box<dyn Voice>.

HostMessage::ProcessMode value is always empty

Even when the host returns something HostMessage::ProcessMode value is empty.

Port TFruityPlugHost AddWave methods

Needs specification.

Port TFruityPlugHost PlugMsg methods

PlugMsg_Delayed should be exposed as host::Host::loop_out and PlugMsg_Kill as host::Host::loop_kill.

Port TFruityPlugHost->PromptEdit

Should be exposed as host::Host::prompt_edit.

Port TFruityPlug->GetName

Should be exposed as plugin::Plugin::name_of.

Port TFruityPlugHost sample methods

LoadSample -> ~~host::Host::load_sample~~ sample::Sample::load
GetSampleData -> ~~host::Host::sample_data~~ sample::Sample::data
CloseSample -> ~~host::Host::close_sample~~ sample::Sample::close
GetSampleInfo -> ~~host::Host::sample_info~~ sample::Sample::info
GetSampleRegion -> ~~host::Host::sample_region~~ sample::Sample::region

Port event IDs to Rust

They should be exposed as enum host::Event.

Enum's items should keep corresponding values as they're described in the documentation.

Check TFruityPlug->ProcessEvent(...) to get a clue from where the parameters come from.

enum host::HostMessage can be used as an example.

Note: the type is public and documentation should be ported too.

Port TFruityPlug->NewTick

Should be exposed as plugin::Plugin::tick.

Port TFruityPlugHost->GetSampleInfo

Should be exposed as host::Host::sample_info.

Plugin name displays incorrectly

Possibly the cause of #16

Port TFruityPlugHost->GetMixBuffer

Should be exposed as host::Host::mix_buf.

Port TFruityPlugHost suspend/resume output methods

SuspendOutput -> host::Host::suspend_out
ResumeOutput -> host::Host::resume_out

Won't compile on Windows

dtolnay/cxx#98

Port TFruityPlug->MIDITick

Should be exposed as plugin::Plugin::midi_tick.

Port TFruityPlugHost->GetInsBuffer

Should be exposed as host::Host::ins_buf.

Port TOutVoiceHandle

Should be exposed as struct OutputVoice and has methods:

OutputVoice::release (TFruityPlugHost::OutputVoice_Release)
OutputVoice::kill (TFruityPlugHost::OutputVoice_Kill)
OutputVoice::process_event (TFruityPlugHost::OutputVoice_ProcessEvent)

Port TFruityPlugHost time info methods

GetSongMixingTime -> host::Host::mix_time
GetSongMixingTime_A -> host::Host::mix_time_accurate
GetSongPlayingTime -> host::Host::play_time

Port TFruityPlug->Gen_Render

~~Should be exposed as plugin::Plugin::gen_render.~~ Gen_Render and Eff_Render should be merged into plugin::Plugin::render.

Port TFruityPlug->Idle_Public to Rust

Should be exposed as plugin::Plugin::idle.

Port TFruityPlugHost->GetSendBuffer

Should be exposed as host::Host::send_buf.

Possibly outdated.

Plugin dispatcher causes FL to hang

When I return 0 from plugin_dispatcher function (i.e. commenting out its inners) everything's fine, but with the actual code it causes FL Studio to hang.

Port TFruityPlug->MIDIIn

Should be exposed as plugin::Plugin::midi_in.

Port TFruityPlug->SaveRestoreState

Should be exposed as plugin::Plugin::save_state and plugin::Plugin::restore_state.

Add logger to the example

Logging should be performed into a file.

Port TFruityPlug->ProcessEvent

Should be exposed as plugin::Plugin::process_event.

Implement Plugin::on_message for the example

It's also going to be some kind of tests for HostMessage.

Port TFruityPlug->ProcessParam

Should be exposed as plugin::Plugin::process_param.

Port TFruityPlugHost lock/unlock mix

Should be exposed as host::Host::lock_mix and host::Host::unlock_mix.

Example's log path on Windows

As far as the plugin is a DLL, specifying its path goes out of scope for a simple example, so we don't put the log just beside it. We use the current working directory of the process.

So the log file for the example plugin is created in /Applications/FL Studio 20.app/Contents/Resources/FL on macOS.

I think it's inside of FL's root directory on Windows. But this information needs to be clarified and added in README.md.

Push notifications to dev chats

Notify about (if possible):

Add install script on Windows

Add a simple script to install compiled plugin on Windows to simplify debugging process.

It should install only Effects.

It should accept current dll name as the first argument and destination name as the second one.

install.mac.sh can be used as an example.

It's implemented by introducing type Voicer (Host::voice_handler), which sends release, kill, and on_event to the corresponding voice.

Port TVoiceHandle

Should be exposed as trait Voice and have next methods:

Voice::new
Voice::release (TFruityPlug->Voice_Release)
Voice::kill (TFruityPlug->Voice_Kill)
Voice::process_event (TFruityPlug->Voice_ProcessEvent)
~~Voice::render (TFruityPlug->Voice_Render)~~ deprecated

Port TFruityPlugHost->OnHint

Should be exposed as host::Host::on_hint.