✨ Fruity Blood Overdrive parser by ttaschke · Pull Request #63 · demberto/PyFLP

ttaschke · 2022-09-27T11:11:54Z

Draft for blood overdrive parsing with support for just the new version of the plugin

ttaschke · 2022-09-27T11:21:12Z

pyflp/plugin.py

+        "I",
+    )
+
+


To support both the recent and the old version of BloodOverdrive two Structs would be used here.

class _FruityBloodOverdriveStruct(StructBase)
->
class _FruityBloodOverdriveNewStruct(StructBase)

class _FruityBloodOverdriveOldStruct(StructBase): PROPS = dict.fromkeys( ( ... "pre_band", "color", "pre_amp", "x100", "post_filter", "post_gain", ... ), "I", )

Didn't think about how big the names would get, use _FruityBloodOverdriveStruct2 probably?

ttaschke · 2022-09-27T11:27:18Z

pyflp/plugin.py

+class FruityBloodOverdriveEvent(StructEventBase):
+    STRUCT = _FruityBloodOverdriveStruct
+
+


The BO event would set both versions of the struct, so NativePluginEvent can use the one it decides to be appropriate.

class FruityBloodOverdriveEvent(NativePluginEvent): struct_old = _FruityBloodOverdriveOldStruct struct_new = _FruityBloodOverdriveNewStruct

NativePluginEvent would look at the events stream and decide which plugin version it encountered.

class NativePluginEvent(StructEventBase) # check the version of the plugin based on stream size and/or plugin marker in the first 4 bytes? # set the appropriate struct

I need to consider whether I should just modify existing StructEventBase logic to accomodate multiple structs, since its very possible that the functionality NativePluginEvent might be used by other events

demberto

Is it possible for you to use FL Studio 20.8.4.2304, for modifying the test FLP? If not maybe I can add the FBO myself in a commit to this PR.

Nice work, thanks :))

demberto · 2022-09-27T11:40:16Z

pyflp/plugin.py

+
+    INTERNAL_NAME = "Fruity Blood Overdrive"
+
+    plugin_marker = _PluginDataProp[int]()  # 3


No need to expose an internal parameter in the public interface.

I think this can be better exposed via a normal boolean is_old property.

This was my workaround to get it to work with StructEventBase.
The proper way would probably be to read the first 4 bytes self._stream.read_I() and then set is_old in NativePluginEvent?

Or maybe, it can be added as a property in _PluginBase itself

pyflp/plugin.py

demberto · 2022-09-27T11:44:49Z

pyflp/plugin.py

+    | Default | 10000 |  0.0000        |
+    """
+
+    unknown_event_first = _PluginDataProp[int]()


Same as a above for both unknown events

Renamed in 6b9e167

No I meant to say, remove them

demberto · 2022-09-27T11:48:37Z

pyflp/plugin.py

+class FruityBloodOverdriveEvent(StructEventBase):
+    STRUCT = _FruityBloodOverdriveStruct
+
+


I need to consider whether I should just modify existing StructEventBase logic to accomodate multiple structs, since its very possible that the functionality NativePluginEvent might be used by other events

docs/reference/plugins.rst

demberto · 2022-09-27T11:52:45Z

pyflp/plugin.py

+        "I",
+    )
+
+


Didn't think about how big the names would get, use _FruityBloodOverdriveStruct2 probably?

ttaschke · 2022-09-27T13:11:47Z

@demberto
Thanks for the review.

I am still unsure whether this should first be released using StructEventBase to support the new Blood Overdrive version only or a complete implementation of NativePluginEvent supporting both versions.
The latter seems to become a bigger refactoring project including modifying StructEventBase and potentially writing NativePluginEvent with support for other events in mind, as you mentioned in #63 (comment).
Just an implementation for the new versions seems more doable given my current grasp of the pyflp API and so on.

Properties

#63 (comment)
#63 (comment)
-> How would plugin_marker, _u1 and _u2 be parsed if not set as a PluginDataProp in class FruityBloodOverdrive?
This probably depends on above-mentioned choice, as this would be handled in NativePluginEvent instead (See: #63 (comment))

Test FLP

Is it possible for you to use FL Studio 20.8.4.2304, for modifying the test FLP? If not maybe I can add the FBO myself in a commit to this PR.

Unfortunately, some project-related properties are changed when saving the same file in another FL Studio breaking existing tests.
Sorry for the inconvenience, but yes it would be great, if you could add Blood Overdrive to the test FLP 🙏
Here is a reference for how I had it set up: #42 (reply in thread)

demberto · 2022-09-28T05:10:03Z

How would plugin_marker, _u1 and _u2 be parsed if not set as a PluginDataProp in class FruityBloodOverdrive?

Structs of some other plugins have a unused / unknown data. StructEventBase will populate its _props dictionary, as it is instantiated. This means, the event already has the property values inside it, and the model just provides a public interface to the known / useful values. The _PluginDataProp just reads from the StructEventBase._props.

This was a conscious design decision of PyFLP 2.0 to provide as informative events as I can in case they are displayed in a tool like FLPEdit, or if the model parsing logic fails due to haphazard event ordering or their absence, these would be a good fallback.

Unfortunately, some project-related properties are changed when saving the same file in another FL Studio breaking existing tests.

Yea. I completely forgot that the licensee name will change if you just save the FLP. To solve this issue, I have create a test-asset-isolation branch to explore the solutions in #6.

Native plugins have FST files in FL Studio's plugin database. I am refactoring the tests to use this new layout, while the full FLP will just be used for project settings, and a few other things which cannot be exported to presets.

I am still unsure whether this should first be released using StructEventBase to support the new Blood Overdrive version only or a complete implementation of NativePluginEvent supporting both versions.
The latter seems to become a bigger refactoring project including modifying StructEventBase and potentially writing NativePluginEvent with support for other events in mind

If NativePluginEvent is created it will mean this multiple struct parsing logic will be limited to subclasses of NativePluginEvent.

If instead, just the existing StructEventBase is modified to accept multiple possible struct layouts and its implementation modified to choose one based on the size of the stream, it can be use anywhere else. I think we should be going with this option.

demberto · 2022-09-29T21:28:50Z

@ttaschke I have reworked most of the unit tests to use presets, including plugins, it should be very easy to add a blood overdrive preset and test it.

ttaschke · 2022-09-30T10:03:33Z

@demberto
Awesome. Thanks!
I will try this out and then give the StructEventBase changes a go.

ttaschke · 2022-10-16T12:22:21Z

@demberto
Hi, I just wanted to check in and see if all the things we discussed before (testing, construct / struct changes) can now be considered stable, so that I can modify this PR accordingly?

demberto · 2022-10-17T04:17:30Z

@ttaschke Yes. Infact you don't need to have 2 different structs at all, you can cover all parsing logic by the classes provided in construct.

demberto · 2022-12-29T08:24:57Z

Hey @ttaschke long time no talks. What do you plan to do with this PR?

ttaschke · 2022-12-29T14:28:57Z

@demberto
Sorry, this got lost in my backlog somehow.

I just started changing the code in this PR to use construct and added a separate .fst for testing. Given how much changed in PyFLP since opening this PR, I think it will be cleanest to open a new PR for a fresh branch (https://github.com/demberto/PyFLP/compare/master...ttaschke:PyFLP:add-plugin-parser-blood-overdrive?expand=1).

demberto · 2022-12-29T16:54:55Z

@ttaschke I am actually considering restructuring the modules into more submodules. pyflp.channel is my prime candidate but pyflp.plugin packs too much into a single module as well. I will be creating a different branch for it however. It will require quite some changes to the docs as well. Currently, the situation is so bad, I need to literally search for a class with Ctrl + F all the time

ttaschke commented Sep 27, 2022

View reviewed changes

ttaschke marked this pull request as draft September 27, 2022 11:35

demberto changed the title ~~[WIP] feat: add blood overdrive plugin parser~~ [WIP] feat: fruity blood overdrive Sep 27, 2022

demberto reviewed Sep 27, 2022

View reviewed changes

demberto added the enhancement New feature or request label Sep 27, 2022

demberto added this to the PyFLP 2.0.0 milestone Sep 27, 2022

ttaschke added 3 commits September 27, 2022 21:34

feat: add blood overdrive plugin parser

0be2a99

fix: plugin order in documentation

cb69ddb

rename unknown events

6b9e167

ttaschke force-pushed the add-plugin-blood-overdrive branch from 978554c to 6b9e167 Compare September 27, 2022 12:43

demberto changed the title ~~[WIP] feat: fruity blood overdrive~~ feat: Fruity Blood Overdrive Oct 17, 2022

demberto changed the title ~~feat: Fruity Blood Overdrive~~ feat: Fruity Blood Overdrive parser Oct 17, 2022

demberto changed the title ~~feat: Fruity Blood Overdrive parser~~ ✨ Fruity Blood Overdrive parser Oct 19, 2022

ttaschke closed this Feb 25, 2023

		class FruityBloodOverdriveEvent(StructEventBase):
		STRUCT = _FruityBloodOverdriveStruct


		INTERNAL_NAME = "Fruity Blood Overdrive"

		plugin_marker = _PluginDataProp[int]() # 3

Conversation

ttaschke commented Sep 27, 2022

Uh oh!

ttaschke Sep 27, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ttaschke Sep 27, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

demberto Sep 27, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

demberto left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

demberto Sep 27, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ttaschke commented Sep 27, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Properties

Test FLP

Uh oh!

demberto commented Sep 28, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

demberto commented Sep 29, 2022

Uh oh!

ttaschke commented Sep 30, 2022

Uh oh!

ttaschke commented Oct 16, 2022

Uh oh!

demberto commented Oct 17, 2022

Uh oh!

demberto commented Dec 29, 2022

Uh oh!

ttaschke commented Dec 29, 2022

Uh oh!

demberto commented Dec 29, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

ttaschke Sep 27, 2022 •

edited

Loading

ttaschke Sep 27, 2022 •

edited

Loading

demberto Sep 27, 2022 •

edited

Loading

demberto Sep 27, 2022 •

edited

Loading

ttaschke commented Sep 27, 2022 •

edited

Loading

demberto commented Sep 28, 2022 •

edited

Loading

demberto commented Dec 29, 2022 •

edited

Loading