Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Copy over FMOD plugin styling #41

Merged
merged 1 commit into from
Sep 21, 2024
Merged

Copy over FMOD plugin styling #41

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions crates/phonon-fmod/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,7 @@ Once built the dylib can be loaded into FMOD Studio and the application:
For FMOD Studio place it in one of the folders indicated here:
https://www.fmod.com/docs/2.02/studio/plugin-reference.html#loading-plug-ins

Place phonon_fmod.plugin.js in the same folder to give the plugin a user-friendly appearance inside FMOD.

On the application side the plugin can either be dynamically or statically linked.
By default, this should be done statically. (todo)
322 changes: 322 additions & 0 deletions crates/phonon-fmod/phonon_fmod.plugin.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,322 @@
//
// Copyright 2017-2023 Valve Corporation.
// Copyright 2024 phonon_rs contributors.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//

studio.plugins.registerPluginDescription("Phonon Spatializer", {
companyName: "The Rust Community",
productName: "Phonon Spatializer",
parameters: {
"DirectBinaural": {displayName: "Apply HRTF To Direct"},
"ApplyDA": {displayName: "Distance Attenuation"},
"ApplyAA": {displayName: "Air Absorption"},
"ApplyDir": {displayName: "Directivity"},
"ApplyOc": {displayName: "Occlusion"},
"ApplyTrans": {displayName: "Transmission"},
"ApplyReflections": {displayName: "Reflections"},
"ApplyPathing": {displayName: "Pathing"},
"HrtfInterp": {displayName: "HRTF Interpolation"},
"DistAtt": {displayName: "Value"},
"AirAbsLow": {displayName: "AA Low"},
"AirAbsMid": {displayName: "AA Mid"},
"AirAbsHigh": {displayName: "AA High"},
"Directivity": {displayName: "Dir. Value"},
"DipoleWeight": {displayName: "Weight"},
"DipolePower": {displayName: "Power"},
"Occlusion": {displayName: "Occl. Value"},
"TransType": {displayName: "Transmission Type"},
"TransLow": {displayName: "Trans. Low"},
"TransMid": {displayName: "Trans. Mid"},
"TransHigh": {displayName: "Trans. High"},
"DirMixLevel": {displayName: "Direct Mix Level"},
"ReflBinaural": {displayName: "Apply HRTF To Reflections"},
"ReflMixLevel": {displayName: "Reflections Mix Level"},
"PathBinaural": {displayName: "Apply HRTF To Pathing"},
"PathMixLevel": {displayName: "Pathing Mix Level"},
"OutputFormat": {displayName: "Output Format"},
},
deckUi: {
deckWidgetType: studio.ui.deckWidgetType.Layout,
layout: studio.ui.layoutType.HBoxLayout,
spacing: 8,
items: [
{
deckWidgetType: studio.ui.deckWidgetType.InputMeter
},
{
deckWidgetType: studio.ui.deckWidgetType.Layout,
layout: studio.ui.layoutType.VBoxLayout,
minimumWidth: 128,
maximumWidth: 150,
spacing: 8,
contentsMargins: {left: 4, right: 4},
alignment: studio.ui.alignment.AlignTop,
isFramed: true,
items: [
{
deckWidgetType: studio.ui.deckWidgetType.Dropdown,
binding: "HrtfInterp"
},
{
deckWidgetType: studio.ui.deckWidgetType.Dropdown,
binding: "ApplyDA"
},
{
deckWidgetType: studio.ui.deckWidgetType.Dropdown,
binding: "ApplyAA"
},
{
deckWidgetType: studio.ui.deckWidgetType.Dropdown,
binding: "ApplyDir"
},
]
},
{
deckWidgetType: studio.ui.deckWidgetType.Layout,
layout: studio.ui.layoutType.VBoxLayout,
minimumWidth: 128,
maximumWidth: 250,
spacing: 8,
contentsMargins: {left: 4, right: 4},
alignment: studio.ui.alignment.AlignTop,
isFramed: true,
items: [
{
deckWidgetType: studio.ui.deckWidgetType.DistanceRolloffGraph,
rolloffTypeBinding: "DAType",
minimumDistanceBinding: "DAMinDist",
maximumDistanceBinding: "DAMaxDist",
rolloffTypes: {
0: studio.project.distanceRolloffType.LinearSquared,
1: studio.project.distanceRolloffType.Linear,
2: studio.project.distanceRolloffType.Inverse,
3: studio.project.distanceRolloffType.InverseSquared,
4: studio.project.distanceRolloffType.Custom,
}
},
{
deckWidgetType: studio.ui.deckWidgetType.MinMaxFader,
text: "Min & Max Distances",
minimumBinding: "DAMinDist",
maximumBinding: "DAMaxDist"
}
]
},
{
deckWidgetType: studio.ui.deckWidgetType.Layout,
layout: studio.ui.layoutType.VBoxLayout,
minimumWidth: 128,
maximumWidth: 150,
spacing: 8,
contentsMargins: {left: 4, right: 4},
alignment: studio.ui.alignment.AlignTop,
isFramed: true,
items: [
{
deckWidgetType: studio.ui.deckWidgetType.Label,
text: "Directivity"
},
{
deckWidgetType: studio.ui.deckWidgetType.PolarDirectivityGraph,
directivityBinding: "DipoleWeight",
sharpnessBinding: "DipolePower"
},
{
deckWidgetType: studio.ui.deckWidgetType.Layout,
layout: studio.ui.layoutType.HBoxLayout,
items: [
{
deckWidgetType: studio.ui.deckWidgetType.Dial,
binding: "DipoleWeight"
},
{
deckWidgetType: studio.ui.deckWidgetType.Dial,
binding: "DipolePower"
}
]
}
]
},
{
deckWidgetType: studio.ui.deckWidgetType.Layout,
layout: studio.ui.layoutType.VBoxLayout,
minimumWidth: 128,
maximumWidth: 150,
spacing: 8,
contentsMargins: {left: 4, right: 4},
alignment: studio.ui.alignment.AlignTop,
isFramed: true,
items: [
{
deckWidgetType: studio.ui.deckWidgetType.Dropdown,
binding: "ApplyOc"
},
{
deckWidgetType: studio.ui.deckWidgetType.Dropdown,
binding: "ApplyTrans"
},
{
deckWidgetType: studio.ui.deckWidgetType.Dropdown,
binding: "TransType"
}
]
},
{
deckWidgetType: studio.ui.deckWidgetType.Layout,
layout: studio.ui.layoutType.VBoxLayout,
minimumWidth: 128,
maximumWidth: 250,
spacing: 8,
contentsMargins: {left: 4, right: 4},
alignment: studio.ui.alignment.AlignTop,
isFramed: true,
items: [
{
deckWidgetType: studio.ui.deckWidgetType.Layout,
layout: studio.ui.layoutType.HBoxLayout,
spacing: 8,
items: [
{
deckWidgetType: studio.ui.deckWidgetType.Dial,
binding: "AirAbsLow"
},
{
deckWidgetType: studio.ui.deckWidgetType.Dial,
binding: "AirAbsMid"
},
{
deckWidgetType: studio.ui.deckWidgetType.Dial,
binding: "AirAbsHigh"
},
{
deckWidgetType: studio.ui.deckWidgetType.Dial,
binding: "Directivity"
}
]
},
{
deckWidgetType: studio.ui.deckWidgetType.Layout,
layout: studio.ui.layoutType.HBoxLayout,
spacing: 8,
items: [
{
deckWidgetType: studio.ui.deckWidgetType.Dial,
binding: "Occlusion"
},
{
deckWidgetType: studio.ui.deckWidgetType.Dial,
binding: "TransLow"
},
{
deckWidgetType: studio.ui.deckWidgetType.Dial,
binding: "TransMid"
},
{
deckWidgetType: studio.ui.deckWidgetType.Dial,
binding: "TransHigh"
}
]
}
]
},
{
deckWidgetType: studio.ui.deckWidgetType.Layout,
layout: studio.ui.layoutType.VBoxLayout,
minimumWidth: 128,
maximumWidth: 150,
spacing: 8,
contentsMargins: {left: 4, right: 4},
alignment: studio.ui.alignment.AlignTop,
isFramed: true,
items: [
{
deckWidgetType: studio.ui.deckWidgetType.Button,
binding: "DirectBinaural",
text: "On"
},
{
deckWidgetType: studio.ui.deckWidgetType.Button,
binding: "ApplyReflections",
text: "On"
},
{
deckWidgetType: studio.ui.deckWidgetType.Button,
binding: "ReflBinaural",
text: "On"
},
]
},
{
deckWidgetType: studio.ui.deckWidgetType.Layout,
layout: studio.ui.layoutType.VBoxLayout,
minimumWidth: 128,
maximumWidth: 150,
spacing: 8,
contentsMargins: {left: 4, right: 4},
alignment: studio.ui.alignment.AlignTop,
isFramed: true,
items: [
{
deckWidgetType: studio.ui.deckWidgetType.Button,
binding: "ApplyPathing",
text: "On"
},
{
deckWidgetType: studio.ui.deckWidgetType.Button,
binding: "PathBinaural",
text: "On"
},
{
deckWidgetType: studio.ui.deckWidgetType.Dropdown,
binding: "OutputFormat"
},
]
},
{
deckWidgetType: studio.ui.deckWidgetType.Layout,
layout: studio.ui.layoutType.VBoxLayout,
minimumWidth: 225,
maximumWidth: 350,
spacing: 8,
contentsMargins: {left: 4, right: 4},
alignment: studio.ui.alignment.AlignTop,
isFramed: true,
items: [
{
deckWidgetType: studio.ui.deckWidgetType.Dial,
binding: "DirMixLevel",
},
{
deckWidgetType: studio.ui.deckWidgetType.Layout,
layout: studio.ui.layoutType.HBoxLayout,
items: [
{
deckWidgetType: studio.ui.deckWidgetType.Dial,
binding: "ReflMixLevel",
},
{
deckWidgetType: studio.ui.deckWidgetType.Dial,
binding: "PathMixLevel",
}
]
}
]
},
{
deckWidgetType: studio.ui.deckWidgetType.OutputMeter
}
]
}
});
1 change: 1 addition & 0 deletions crates/phonon-fmod/src/callbacks.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,7 @@ pub(crate) unsafe extern "C" fn process_callback(
let sample_rate = (*effect_state).audio_settings.sampling_rate;

if (new_block_size != block_size) || (new_sample_rate != sample_rate) {
// todo: I haven't found a way to test this path yet
let audio_settings = AudioSettings::new(new_sample_rate, new_block_size);
(*effect_state).in_buffer_stereo = AudioBuffer::new(new_block_size);
(*effect_state).in_buffer_mono = AudioBuffer::new(new_block_size);
Expand Down