gtkui: use scriptable UI for dsp presets in preferences window

Author: Oleksiy-Yakovenko

configure.ac

@@ -856,7 +856,7 @@ AS_IF([test "${enable_soundtouch}" != "no"], [
     HAVE_SOUNDTOUCH=yes
 ])
 
-PLUGINS_DIRS="plugins/liboggedit plugins/libparser plugins/lastfm plugins/mp3 plugins/vorbis plugins/opus plugins/flac plugins/wavpack plugins/sndfile plugins/vfs_curl plugins/cdda plugins/gtkui plugins/alsa plugins/ffmpeg plugins/hotkeys plugins/oss plugins/artwork plugins/adplug plugins/ffap plugins/sid plugins/nullout plugins/supereq plugins/vtx plugins/gme plugins/pulse plugins/notify plugins/musepack plugins/wildmidi plugins/tta plugins/dca plugins/aac plugins/mms plugins/shellexec plugins/shellexecui plugins/dsp_libsrc plugins/m3u plugins/vfs_zip plugins/converter plugins/dumb plugins/shn plugins/psf plugins/mono2stereo plugins/alac plugins/wma plugins/pltbrowser plugins/coreaudio plugins/sc68 plugins/rg_scanner plugins/soundtouch plugins/medialib plugins/lyrics"
+PLUGINS_DIRS="plugins/liboggedit plugins/lastfm plugins/mp3 plugins/vorbis plugins/opus plugins/flac plugins/wavpack plugins/sndfile plugins/vfs_curl plugins/cdda plugins/gtkui plugins/alsa plugins/ffmpeg plugins/hotkeys plugins/oss plugins/artwork plugins/adplug plugins/ffap plugins/sid plugins/nullout plugins/supereq plugins/vtx plugins/gme plugins/pulse plugins/notify plugins/musepack plugins/wildmidi plugins/tta plugins/dca plugins/aac plugins/mms plugins/shellexec plugins/shellexecui plugins/dsp_libsrc plugins/m3u plugins/vfs_zip plugins/converter plugins/dumb plugins/shn plugins/psf plugins/mono2stereo plugins/alac plugins/wma plugins/pltbrowser plugins/coreaudio plugins/sc68 plugins/rg_scanner plugins/soundtouch plugins/medialib plugins/lyrics"
 
 AM_CONDITIONAL(APE_USE_YASM, test "x$APE_USE_YASM" = "xyes")
 AM_CONDITIONAL(HAVE_VORBIS, test "x$HAVE_VORBISPLUGIN" = "xyes")
@@ -944,7 +944,6 @@ external/ddb_output_pw/Makefile
 pixmaps/Makefile
 icons/Makefile
 plugins/liboggedit/Makefile
-plugins/libparser/Makefile
 plugins/gme/Makefile
 plugins/alsa/Makefile
 plugins/hotkeys/Makefile

include/deadbeef/deadbeef.h

@@ -1807,8 +1807,12 @@ typedef struct {
 #endif
 
 #if (DDB_API_LEVEL >= 18)
-    // sort using title formatting v2, with more direct control over tf evaluation
+    /// sort using title formatting v2, with more direct control over tf evaluation
     void (*plt_sort_v3) (ddb_tf_context_t *tf_ctx, const char *tf_bytecode, int iter, int id, int order);
+
+    /// Get the root of scriptable tree, which contains dsp and encoder presets.
+    /// This is used by GUI plugins for preset editing.
+    ddb_scriptable_item_t * (*get_shared_scriptable_root)(void);
 #endif
 } DB_functions_t;
 

osx/deadbeef.xcodeproj/project.pbxproj

@@ -115,7 +115,7 @@ - (void)windowDidLoad {
     [self initializeWidgets];
     self.window.delegate = self;
 
-    self.dspPresetsDataSource = [ScriptableTableDataSource dataSourceWithScriptable:scriptableDspRoot(scriptableRootShared())];
+    self.dspPresetsDataSource = [ScriptableTableDataSource dataSourceWithScriptable:scriptableDspRoot(deadbeef->get_shared_scriptable_root())];
     self.dspSelectViewController.dataSource = self.dspPresetsDataSource;
     self.dspSelectViewController = [ScriptableSelectViewController new];
     self.dspSelectViewController.view.frame = self.dspPresetSelectorContainer.bounds;
@@ -126,12 +126,12 @@ - (void)windowDidLoad {
 
     char dsp_preset_name[100];
     deadbeef->conf_get_str ("converter.dsp_preset_name", "", dsp_preset_name, sizeof(dsp_preset_name));
-    scriptableItem_t *dspPreset = scriptableItemSubItemForName(scriptableDspRoot(scriptableRootShared()), dsp_preset_name);
+    scriptableItem_t *dspPreset = scriptableItemSubItemForName(scriptableDspRoot(deadbeef->get_shared_scriptable_root()), dsp_preset_name);
     if (dspPreset) {
         [self.dspSelectViewController selectItem:dspPreset];
     }
 
-    self.encoderPresetsDataSource = [ScriptableTableDataSource dataSourceWithScriptable:scriptableEncoderRoot(scriptableRootShared())];
+    self.encoderPresetsDataSource = [ScriptableTableDataSource dataSourceWithScriptable:scriptableEncoderRoot(deadbeef->get_shared_scriptable_root())];
     self.encoderSelectViewController.dataSource = self.dspPresetsDataSource;
 
     self.encoderSelectViewController = [ScriptableSelectViewController new];
@@ -143,7 +143,7 @@ - (void)windowDidLoad {
 
     char enc_preset_name[100];
     deadbeef->conf_get_str ("converter.encoder_preset_name", "", enc_preset_name, sizeof(enc_preset_name));
-    scriptableItem_t *encPreset = scriptableItemSubItemForName(scriptableEncoderRoot(scriptableRootShared()), enc_preset_name);
+    scriptableItem_t *encPreset = scriptableItemSubItemForName(scriptableEncoderRoot(deadbeef->get_shared_scriptable_root()), enc_preset_name);
     if (encPreset) {
         [self.encoderSelectViewController selectItem:encPreset];
     }
@@ -220,7 +220,7 @@ -(void)updateFilenamesPreview {
     if (selectedEncoderPreset == -1) {
         return;
     }
-    scriptableItem_t *preset = scriptableItemChildAtIndex(scriptableEncoderRoot(scriptableRootShared()), (unsigned int)selectedEncoderPreset);
+    scriptableItem_t *preset = scriptableItemChildAtIndex(scriptableEncoderRoot(deadbeef->get_shared_scriptable_root()), (unsigned int)selectedEncoderPreset);
     ddb_encoder_preset_t *encoder_preset = self.converter_plugin->encoder_preset_alloc();
     scriptableEncoderPresetToConverterEncoderPreset(preset, encoder_preset);
 
@@ -402,7 +402,7 @@ - (IBAction)okAction:(id)sender {
 
     NSInteger selectedEncoderPreset = self.encoderSelectViewController.indexOfSelectedItem;
     if (selectedEncoderPreset != -1) {
-        scriptableItem_t *preset = scriptableItemChildAtIndex(scriptableEncoderRoot(scriptableRootShared()), (unsigned int)selectedEncoderPreset);
+        scriptableItem_t *preset = scriptableItemChildAtIndex(scriptableEncoderRoot(deadbeef->get_shared_scriptable_root()), (unsigned int)selectedEncoderPreset);
         self.encoder_preset = self.converter_plugin->encoder_preset_alloc();
         scriptableEncoderPresetToConverterEncoderPreset(preset, self.encoder_preset);
     }
@@ -422,7 +422,7 @@ - (IBAction)okAction:(id)sender {
 
     NSInteger selectedDspPreset = self.dspSelectViewController.indexOfSelectedItem;
     if (selectedDspPreset != -1) {
-        scriptableItem_t *preset = scriptableItemChildAtIndex(scriptableDspRoot(scriptableRootShared()), (unsigned int)selectedDspPreset);
+        scriptableItem_t *preset = scriptableItemChildAtIndex(scriptableDspRoot(deadbeef->get_shared_scriptable_root()), (unsigned int)selectedDspPreset);
         ddb_dsp_context_t *chain = scriptableDspConfigToDspChain(preset);
         if (chain) {
             self.dsp_preset = self.converter_plugin->dsp_preset_alloc ();
@@ -604,27 +604,27 @@ + (void)cleanup {
 #pragma mark - ScriptableSelectDelegate
 
 - (void)scriptableSelectItemSelected:(nonnull scriptableItem_t *)item {
-    if (scriptableItemParent(item) == scriptableEncoderRoot(scriptableRootShared())) {
+    if (scriptableItemParent(item) == scriptableEncoderRoot(deadbeef->get_shared_scriptable_root())) {
         const char *name = scriptableItemPropertyValueForKey(item, "name");
         deadbeef->conf_set_str ("converter.encoder_preset_name", name);
         [self updateFilenamesPreview];
     }
-    else if (scriptableItemParent(item) == scriptableDspRoot(scriptableRootShared())) {
+    else if (scriptableItemParent(item) == scriptableDspRoot(deadbeef->get_shared_scriptable_root())) {
         const char *name = scriptableItemPropertyValueForKey(item, "name");
         deadbeef->conf_set_str ("converter.dsp_preset_name", name);
     }
 }
 
 - (void)scriptableItemDidChange:(scriptableItem_t * _Nonnull)scriptable change:(ScriptableItemChange)change {
-    if (scriptable == scriptableEncoderRoot(scriptableRootShared())) {
+    if (scriptable == scriptableEncoderRoot(deadbeef->get_shared_scriptable_root())) {
         NSInteger selectedEncPresetIndex = self.encoderSelectViewController.indexOfSelectedItem;
-        scriptableItem_t *selectedEncPreset = scriptableItemChildAtIndex(scriptableEncoderRoot(scriptableRootShared()), (unsigned int)selectedEncPresetIndex);
+        scriptableItem_t *selectedEncPreset = scriptableItemChildAtIndex(scriptableEncoderRoot(deadbeef->get_shared_scriptable_root()), (unsigned int)selectedEncPresetIndex);
         [self scriptableSelectItemSelected:selectedEncPreset];
         [self.encoderSelectViewController reloadData];
     }
-    else if (scriptable == scriptableDspRoot(scriptableRootShared())) {
+    else if (scriptable == scriptableDspRoot(deadbeef->get_shared_scriptable_root())) {
         NSInteger selectedDspPresetIndex = self.dspSelectViewController.indexOfSelectedItem;
-        scriptableItem_t *selectedDspPreset = scriptableItemChildAtIndex(scriptableDspRoot(scriptableRootShared()), (unsigned int)selectedDspPresetIndex);
+        scriptableItem_t *selectedDspPreset = scriptableItemChildAtIndex(scriptableDspRoot(deadbeef->get_shared_scriptable_root()), (unsigned int)selectedDspPresetIndex);
         [self scriptableSelectItemSelected:selectedDspPreset];
         [self.dspSelectViewController reloadData];
     }

plugins/cocoaui/ConverterWindowController.m

@@ -58,7 +58,7 @@ - (void)viewDidLoad {
     _currentDspChain = scriptableDspPresetFromDspChain (deadbeef->streamer_get_dsp_chain ());
     self.dspChainDataSource = [ScriptableTableDataSource dataSourceWithScriptable:_currentDspChain];
 
-    self.dspPresetsDataSource = [ScriptableTableDataSource dataSourceWithScriptable:scriptableDspRoot(scriptableRootShared())];
+    self.dspPresetsDataSource = [ScriptableTableDataSource dataSourceWithScriptable:scriptableDspRoot(deadbeef->get_shared_scriptable_root())];
 
     // preset list and browse button
     self.dspSelectViewController = [ScriptableSelectViewController new];
@@ -101,7 +101,7 @@ - (void)segmentedControlAction:(NSSegmentedControl *)sender {
         if (returnCode == NSModalResponseOK) {
             const char *name = self.dspPresetNameTextField.stringValue.UTF8String;
             scriptableItem_t *preset = scriptableItemClone (self.dspChainDataSource.scriptable);
-            scriptableItem_t *presets = scriptableDspRoot(scriptableRootShared());
+            scriptableItem_t *presets = scriptableDspRoot(deadbeef->get_shared_scriptable_root());
             scriptableItemSetUniqueNameUsingPrefixAndRoot(preset, name, presets);
             scriptableItemAddSubItem(presets, preset);
             [self.dspSelectViewController reloadData];
@@ -111,11 +111,11 @@ - (void)segmentedControlAction:(NSSegmentedControl *)sender {
 
 - (IBAction)presetNameOK:(id)sender {
     const char *name = self.dspPresetNameTextField.stringValue.UTF8String;
-    if (scriptableItemContainsSubItemWithName(scriptableDspRoot(scriptableRootShared()), name)) {
+    if (scriptableItemContainsSubItemWithName(scriptableDspRoot(deadbeef->get_shared_scriptable_root()), name)) {
         [ScriptableErrorViewer.sharedInstance displayDuplicateNameError];
         return;
     }
-    if (!scriptableItemIsSubItemNameAllowed(scriptableDspRoot(scriptableRootShared()), name)) {
+    if (!scriptableItemIsSubItemNameAllowed(scriptableDspRoot(deadbeef->get_shared_scriptable_root()), name)) {
         [ScriptableErrorViewer.sharedInstance displayInvalidNameError];
         return;
     }

plugins/cocoaui/Preferences/DspPreferencesViewController.m

@@ -60,6 +60,8 @@ GTKUI_SOURCES = \
 	prefwin/prefwinplugins.c prefwin/prefwinplugins.h\
 	prefwin/prefwinsound.c prefwin/prefwinsound.h\
 	scriptable/gtkScriptable.c scriptable/gtkScriptable.h\
+	scriptable/gtkScriptablePropertySheetEditViewController.c scriptable/gtkScriptablePropertySheetEditViewController.h\
+	scriptable/gtkScriptablePropertySheetEditWindowController.c scriptable/gtkScriptablePropertySheetEditWindowController.h\
 	scriptable/gtkScriptableListEditViewController.c scriptable/gtkScriptableListEditViewController.h\
 	scriptable/gtkScriptableListEditWindowController.c scriptable/gtkScriptableListEditWindowController.h\
 	scriptable/gtkScriptableSelectViewController.c scriptable/gtkScriptableSelectViewController.h\
@@ -103,7 +105,7 @@ GTKUI_SOURCES_GTK2 = $(GTKUI_SOURCES)
 ddb_gui_GTK2_la_SOURCES = $(GTKUI_SOURCES_GTK2)
 ddb_gui_GTK2_la_LDFLAGS = -module -avoid-version -lm
 
-ddb_gui_GTK2_la_LIBADD = $(LDADD) $(GTK2_DEPS_LIBS) $(SM_LIBADD) ../libparser/libparser.la ../../shared/libtrkpropertiesutil.la ../../shared/libeqpreset.la ../../shared/libdeletefromdisk.la ../../shared/libtftintutil.la ../../shared/analyzer/libanalyzer.la ../../shared/scope/libscope.la ../../shared/scriptable/libscriptable.la  $(JANSSON_LIBS) $(DISPATCH_LIBS)
+ddb_gui_GTK2_la_LIBADD = $(LDADD) $(GTK2_DEPS_LIBS) $(SM_LIBADD) ../../shared/libtrkpropertiesutil.la ../../shared/libeqpreset.la ../../shared/libdeletefromdisk.la ../../shared/libtftintutil.la ../../shared/analyzer/libanalyzer.la ../../shared/scope/libscope.la ../../shared/scriptable/libscriptable.la ../../shared/libgrowablebuffer.la ../../shared/libpluginsettings.la ../../shared/libparser.la $(JANSSON_LIBS) $(DISPATCH_LIBS)
 
 ddb_gui_GTK2_la_CFLAGS = -std=c99 -Werror -DGLIB_DISABLE_DEPRECATION_WARNINGS -DGDK_DISABLE_DEPRECATION_WARNINGS -DGTK_DISABLE_DEPRECATION_WARNINGS $(GTK2_DEPS_CFLAGS) $(SM_CFLAGS) $(JANSSON_CFLAGS) $(DISPATCH_CFLAGS) $(MEDIALIB_CFLAGS) -I@top_srcdir@/include -I@top_srcdir@/shared -DDDB_WARN_DEPRECATED=1
 
@@ -112,10 +114,11 @@ endif
 if HAVE_GTK3
 GTKUI_SOURCES_GTK3 = deadbeefapp.c deadbeefapp.h $(GTKUI_SOURCES)
 
+ddb_gui_GTK3_la_SOURCES = $(GTKUI_SOURCES_GTK3)
 ddb_gui_GTK3_la_LDFLAGS = -module -avoid-version -lm
 
-ddb_gui_GTK3_la_SOURCES = $(GTKUI_SOURCES_GTK3)
-ddb_gui_GTK3_la_LIBADD = $(LDADD) $(GTK3_DEPS_LIBS) $(SM_LIBADD) ../libparser/libparser.la ../../shared/libtrkpropertiesutil.la ../../shared/libeqpreset.la ../../shared/libdeletefromdisk.la ../../shared/libtftintutil.la ../../shared/analyzer/libanalyzer.la ../../shared/scope/libscope.la ../../shared/scriptable/libscriptable.la $(JANSSON_LIBS) $(DISPATCH_LIBS)
+ddb_gui_GTK3_la_LIBADD = $(LDADD) $(GTK3_DEPS_LIBS) $(SM_LIBADD) ../../shared/libtrkpropertiesutil.la ../../shared/libeqpreset.la ../../shared/libdeletefromdisk.la ../../shared/libtftintutil.la ../../shared/analyzer/libanalyzer.la ../../shared/scope/libscope.la ../../shared/scriptable/libscriptable.la ../../shared/libgrowablebuffer.la ../../shared/libpluginsettings.la ../../shared/libparser.la $(JANSSON_LIBS) $(DISPATCH_LIBS)
+
 ddb_gui_GTK3_la_CFLAGS = -std=c99 -Werror -DGLIB_DISABLE_DEPRECATION_WARNINGS -DGDK_DISABLE_DEPRECATION_WARNINGS -DGTK_DISABLE_DEPRECATION_WARNINGS $(GTK3_DEPS_CFLAGS) $(SM_CFLAGS) $(JANSSON_CFLAGS) $(DISPATCH_CFLAGS) $(MEDIALIB_CFLAGS) -I@top_srcdir@/include -I@top_srcdir@/shared -DDDB_WARN_DEPRECATED=1
 ddb_gui_GTK3_la_OBJCFLAGS = $(GTK3_DEPS_CFLAGS) $(SM_CFLAGS) $(JANSSON_CFLAGS)
 

plugins/gtkui/Makefile.am

@@ -46,7 +46,7 @@
 #include "search.h"
 #include "progress.h"
 #include "gtkui.h"
-#include "../libparser/parser.h"
+#include "../../shared/parser.h"
 #include "drawing.h"
 #include "eq.h"
 #include "undostack.h"

plugins/gtkui/callbacks.c

@@ -33,7 +33,7 @@
 #include "support.h"
 #include "interface.h"
 #include "callbacks.h"
-#include "../libparser/parser.h"
+#include "../../shared/parser.h"
 #include "ctmapping.h"
 
 static GtkWidget *ctmapping_dlg;