2005-09-25 14:42:24 -04:00
/*
2009-10-14 12:10:01 -04:00
Copyright ( C ) 2000 Paul Davis
2005-09-25 14:42:24 -04:00
This program is free software ; you can redistribute it and / or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation ; either version 2 of the License , or
( at your option ) any later version .
This program is distributed in the hope that it will be useful ,
but WITHOUT ANY WARRANTY ; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE . See the
GNU General Public License for more details .
You should have received a copy of the GNU General Public License
along with this program ; if not , write to the Free Software
Foundation , Inc . , 675 Mass Ave , Cambridge , MA 0213 9 , USA .
*/
2009-07-12 20:26:28 -04:00
# ifdef WAF_BUILD
# include "gtk2ardour-config.h"
# endif
2005-09-25 14:42:24 -04:00
# include <climits>
# include <cerrno>
# include <cmath>
# include <string>
2009-02-25 13:26:51 -05:00
# include "pbd/stl_delete.h"
# include "pbd/xml++.h"
# include "pbd/failed_constructor.h"
2005-09-25 14:42:24 -04:00
2006-08-10 23:24:57 -04:00
# include <gtkmm/widget.h>
2008-10-13 15:45:20 -04:00
# include <gtkmm/box.h>
2005-09-25 16:33:00 -04:00
# include <gtkmm2ext/click_box.h>
# include <gtkmm2ext/fastmeter.h>
# include <gtkmm2ext/barcontroller.h>
# include <gtkmm2ext/utils.h>
# include <gtkmm2ext/doi.h>
2006-07-13 23:43:32 -04:00
# include <gtkmm2ext/slider_controller.h>
2010-11-15 14:53:31 -05:00
# include <gtkmm2ext/application.h>
2005-09-25 14:42:24 -04:00
2009-10-30 11:30:22 -04:00
# include "ardour/session.h"
2009-02-25 13:26:51 -05:00
# include "ardour/plugin.h"
# include "ardour/plugin_insert.h"
# include "ardour/ladspa_plugin.h"
2011-11-21 12:42:29 -05:00
# ifdef WINDOWS_VST_SUPPORT
# include "ardour/windows_vst_plugin.h"
# include "windows_vst_plugin_ui.h"
2005-09-25 14:42:24 -04:00
# endif
2011-09-20 16:29:47 -04:00
# ifdef LXVST_SUPPORT
# include "ardour/lxvst_plugin.h"
# include "lxvst_plugin_ui.h"
# endif
2011-05-14 13:59:16 -04:00
# ifdef LV2_SUPPORT
2009-02-25 13:26:51 -05:00
# include "ardour/lv2_plugin.h"
2008-09-10 17:27:39 -04:00
# include "lv2_plugin_ui.h"
# endif
2005-09-25 14:42:24 -04:00
2011-11-18 19:56:35 -05:00
# include "ardour_window.h"
2005-09-25 14:42:24 -04:00
# include "prompter.h"
# include "plugin_ui.h"
# include "utils.h"
# include "gui_thread.h"
2006-08-10 23:24:57 -04:00
# include "public_editor.h"
2008-09-10 11:03:30 -04:00
# include "keyboard.h"
2009-05-04 13:49:28 -04:00
# include "latency_gui.h"
2009-03-07 06:17:06 -05:00
# include "plugin_eq_gui.h"
2010-12-05 21:41:46 -05:00
# include "new_plugin_preset_dialog.h"
2015-01-05 00:32:14 -05:00
# include "tooltips.h"
2005-09-25 14:42:24 -04:00
# include "i18n.h"
using namespace std ;
using namespace ARDOUR ;
2014-06-25 15:27:37 -04:00
using namespace ARDOUR_UI_UTILS ;
Large nasty commit in the form of a 5000 line patch chock-full of completely
unecessary changes. (Sorry, doing a "sprint" based thing, this is the end of the first one)
Achieved MIDI track and bus creation, associated Jack port and diskstream creation, and minimal GUI stuff for creating them. Should be set to start work on actually recording and playing midi to/from disk now.
Relevant (significant) changes:
- Creation of a Buffer class. Base class is type agnostic so things can point to a buffer but not care what kind it is (otherwise it'd be a template). Derived into AudioBuffer and MidiBuffer, with a type tag because checking type is necessary in parts of the code where dynamic_cast wouldn't be wise. Originally I considered this a hack, but passing around a type proved to be a very good solution to all the other problems (below). There is a 1:1 mapping between jack port data types and ardour Buffer types (with a conversion function), but that's easily removed if it ever becomes necessary. Having the type scoped in the Buffer class is maybe not the best spot for it, but whatever (this is proof of concept kinda stuff right now...)
- IO now has a "default" port type (passed to the constructor and stored as a member), used by ensure_io (and similar) to create n ports. IO::register_***_port has a type argument that defaults to the default type if not passed. Rationale: previous IO API is identical, no changes needed to existing code, but path is paved for multiple port types in one IO, which we will need for eg synth plugin inserts, among other things. This is not quite ideal (best would be to only have the two port register functions and have them take a type), but the alternative is a lot of work (namely destroying the 'ensure' functions and everything that uses them) for very little gain. (I am convinced after quite a few tries at the whiteboard that subclassing IO in any way is not a feasible option, look at it's inheritance diagram in Doxygen and you can see why)
- AudioEngine::register_audio_input_port is now register_input_port and takes a type argument. Ditto for output.
- (Most significant change) AudioDiskstream abstracted into Distream, and sibling MidiDiskstream created. Very much still a work in progress, but Diskstream is there to switch references over to (most already are), which is the important part. It is still unclear what the MIDI diskstream's relation to channels is, but I'm pretty sure they will be single channel only (so SMF Type 0) since noone can come up with a reason otherwise.
- MidiTrack creation. Same thing as AudioTrack but with a different default type basically. No big deal here.
- Random cleanups and variable renamings etc. because I have OCD and can't help myself. :)
Known broken: Loading of sessions containing MIDI tracks.
git-svn-id: svn://localhost/ardour2/branches/midi@641 d708f5d6-7413-0410-9779-e7cbd77b26cf
2006-06-26 12:01:34 -04:00
using namespace PBD ;
2005-09-25 16:33:00 -04:00
using namespace Gtkmm2ext ;
2005-09-25 14:42:24 -04:00
using namespace Gtk ;
2011-05-18 01:00:44 -04:00
PluginUIWindow : : PluginUIWindow (
boost : : shared_ptr < PluginInsert > insert ,
bool scrollable ,
bool editor )
2013-05-02 10:11:57 -04:00
: ArdourWindow ( string ( ) )
2011-05-18 01:00:44 -04:00
, was_visible ( false )
, _keyboard_focused ( false )
2012-06-05 21:43:35 -04:00
# ifdef AUDIOUNIT_SUPPORT
, pre_deactivate_x ( - 1 )
, pre_deactivate_y ( - 1 )
# endif
2005-09-25 14:42:24 -04:00
{
2008-01-10 16:20:59 -05:00
bool have_gui = false ;
2008-01-19 00:06:33 -05:00
Label * label = manage ( new Label ( ) ) ;
label - > set_markup ( " <b>THIS IS THE PLUGIN UI</b> " ) ;
2011-05-18 01:00:44 -04:00
if ( editor & & insert - > plugin ( ) - > has_editor ( ) ) {
2008-01-10 16:20:59 -05:00
switch ( insert - > type ( ) ) {
2011-11-21 12:42:29 -05:00
case ARDOUR : : Windows_VST :
have_gui = create_windows_vst_editor ( insert ) ;
2008-01-10 16:20:59 -05:00
break ;
2015-10-05 10:17:49 -04:00
2011-09-20 16:29:47 -04:00
case ARDOUR : : LXVST :
have_gui = create_lxvst_editor ( insert ) ;
break ;
2008-01-10 16:20:59 -05:00
case ARDOUR : : AudioUnit :
2008-02-16 17:43:18 -05:00
have_gui = create_audiounit_editor ( insert ) ;
2008-01-10 16:20:59 -05:00
break ;
2009-10-14 12:10:01 -04:00
2008-01-10 16:20:59 -05:00
case ARDOUR : : LADSPA :
error < < _ ( " Eh? LADSPA plugins don't have editors! " ) < < endmsg ;
break ;
2008-09-10 17:27:39 -04:00
case ARDOUR : : LV2 :
have_gui = create_lv2_editor ( insert ) ;
break ;
2008-01-10 16:20:59 -05:00
default :
2011-11-21 12:42:29 -05:00
# ifndef WINDOWS_VST_SUPPORT
2013-02-05 13:18:35 -05:00
error < < string_compose ( _ ( " unknown type of editor-supplying plugin (note: no VST support in this version of %1) " ) , PROGRAM_NAME )
2005-09-25 14:42:24 -04:00
< < endmsg ;
2008-01-19 00:06:33 -05:00
# else
error < < _ ( " unknown type of editor-supplying plugin " )
< < endmsg ;
# endif
2005-09-25 14:42:24 -04:00
throw failed_constructor ( ) ;
}
2009-10-14 12:10:01 -04:00
}
2008-01-10 16:20:59 -05:00
if ( ! have_gui ) {
2011-05-18 01:00:44 -04:00
GenericPluginUI * pu = new GenericPluginUI ( insert , scrollable ) ;
2009-10-14 12:10:01 -04:00
2005-09-25 14:42:24 -04:00
_pluginui = pu ;
2010-08-20 18:36:35 -04:00
_pluginui - > KeyboardFocused . connect ( sigc : : mem_fun ( * this , & PluginUIWindow : : keyboard_focused ) ) ;
2010-02-02 19:52:45 -05:00
add ( * pu ) ;
2010-08-16 20:28:20 -04:00
set_wmclass ( X_ ( " ardour_plugin_editor " ) , PROGRAM_NAME ) ;
2007-03-18 02:07:08 -04:00
2009-12-11 18:29:48 -05:00
signal_map_event ( ) . connect ( sigc : : mem_fun ( * pu , & GenericPluginUI : : start_updating ) ) ;
signal_unmap_event ( ) . connect ( sigc : : mem_fun ( * pu , & GenericPluginUI : : stop_updating ) ) ;
2005-09-25 14:42:24 -04:00
}
set_name ( " PluginEditor " ) ;
2006-04-26 12:04:04 -04:00
add_events ( Gdk : : KEY_PRESS_MASK | Gdk : : KEY_RELEASE_MASK | Gdk : : BUTTON_PRESS_MASK | Gdk : : BUTTON_RELEASE_MASK ) ;
2005-09-25 14:42:24 -04:00
2010-03-30 11:18:43 -04:00
insert - > DropReferences . connect ( death_connection , invalidator ( * this ) , boost : : bind ( & PluginUIWindow : : plugin_going_away , this ) , gui_context ( ) ) ;
2009-10-14 12:10:01 -04:00
2008-01-10 16:20:59 -05:00
gint h = _pluginui - > get_preferred_height ( ) ;
gint w = _pluginui - > get_preferred_width ( ) ;
2005-09-25 14:42:24 -04:00
if ( scrollable ) {
if ( h > 600 ) h = 600 ;
}
2009-10-14 12:10:01 -04:00
set_default_size ( w , h ) ;
2012-03-25 13:17:40 -04:00
set_resizable ( _pluginui - > resizable ( ) ) ;
2005-09-25 14:42:24 -04:00
}
2006-08-10 23:24:57 -04:00
PluginUIWindow : : ~ PluginUIWindow ( )
2005-09-25 14:42:24 -04:00
{
2014-02-03 14:25:05 -05:00
# ifndef NDEBUG
2013-10-13 22:41:17 -04:00
cerr < < " PluginWindow deleted for " < < this < < endl ;
2014-02-03 10:54:07 -05:00
# endif
2009-04-16 12:02:25 -04:00
delete _pluginui ;
2005-09-25 14:42:24 -04:00
}
2006-11-19 11:45:16 -05:00
2008-01-19 00:06:33 -05:00
void
PluginUIWindow : : on_show ( )
{
2009-10-01 12:28:02 -04:00
set_role ( " plugin_ui " ) ;
2008-03-17 16:54:03 -04:00
if ( _pluginui ) {
2010-12-19 18:11:01 -05:00
_pluginui - > update_preset_list ( ) ;
_pluginui - > update_preset ( ) ;
2008-03-17 16:54:03 -04:00
}
2009-10-01 12:28:02 -04:00
if ( _pluginui ) {
2013-04-30 11:15:23 -04:00
# if defined (HAVE_AUDIOUNITS) && defined(GTKOSX)
2015-10-04 14:51:05 -04:00
if ( pre_deactivate_x > = 0 ) {
2013-04-30 11:15:23 -04:00
move ( pre_deactivate_x , pre_deactivate_y ) ;
2015-10-04 14:51:05 -04:00
}
2013-04-30 11:15:23 -04:00
# endif
2009-10-01 12:28:02 -04:00
if ( _pluginui - > on_window_show ( _title ) ) {
Window : : on_show ( ) ;
}
}
2008-01-19 00:06:33 -05:00
}
void
PluginUIWindow : : on_hide ( )
{
2013-04-30 11:15:23 -04:00
# if defined (HAVE_AUDIOUNITS) && defined(GTKOSX)
2015-10-04 14:51:05 -04:00
get_position ( pre_deactivate_x , pre_deactivate_y ) ;
2013-04-30 11:15:23 -04:00
# endif
2008-02-16 17:43:18 -05:00
Window : : on_hide ( ) ;
2009-10-01 12:28:02 -04:00
if ( _pluginui ) {
_pluginui - > on_window_hide ( ) ;
}
}
void
2010-09-14 12:51:02 -04:00
PluginUIWindow : : set_title ( const std : : string & title )
2009-10-01 12:28:02 -04:00
{
Gtk : : Window : : set_title ( title ) ;
_title = title ;
2008-01-19 00:06:33 -05:00
}
2008-01-10 16:20:59 -05:00
bool
2011-11-21 12:42:29 -05:00
# ifdef WINDOWS_VST_SUPPORT
PluginUIWindow : : create_windows_vst_editor ( boost : : shared_ptr < PluginInsert > insert )
2009-07-21 11:55:17 -04:00
# else
2011-11-21 12:42:29 -05:00
PluginUIWindow : : create_windows_vst_editor ( boost : : shared_ptr < PluginInsert > )
2009-10-14 12:10:01 -04:00
# endif
2008-01-10 16:20:59 -05:00
{
2011-11-21 12:42:29 -05:00
# ifndef WINDOWS_VST_SUPPORT
2008-01-10 16:20:59 -05:00
return false ;
# else
2011-11-21 12:42:29 -05:00
boost : : shared_ptr < WindowsVSTPlugin > vp ;
2008-01-10 16:20:59 -05:00
2011-11-21 12:42:29 -05:00
if ( ( vp = boost : : dynamic_pointer_cast < WindowsVSTPlugin > ( insert - > plugin ( ) ) ) = = 0 ) {
2013-02-05 13:18:35 -05:00
error < < string_compose ( _ ( " unknown type of editor-supplying plugin (note: no VST support in this version of %1) " ) , PROGRAM_NAME )
< < endmsg ;
2008-01-10 16:20:59 -05:00
throw failed_constructor ( ) ;
} else {
2014-04-17 19:54:59 -04:00
WindowsVSTPluginUI * vpu = new WindowsVSTPluginUI ( insert , vp , GTK_WIDGET ( this - > gobj ( ) ) ) ;
2009-10-14 12:10:01 -04:00
2008-01-10 16:20:59 -05:00
_pluginui = vpu ;
2010-08-20 18:36:35 -04:00
_pluginui - > KeyboardFocused . connect ( sigc : : mem_fun ( * this , & PluginUIWindow : : keyboard_focused ) ) ;
2008-02-16 17:43:18 -05:00
add ( * vpu ) ;
2008-01-10 16:20:59 -05:00
vpu - > package ( * this ) ;
}
return true ;
# endif
}
2011-09-20 16:29:47 -04:00
bool
# ifdef LXVST_SUPPORT
PluginUIWindow : : create_lxvst_editor ( boost : : shared_ptr < PluginInsert > insert )
# else
PluginUIWindow : : create_lxvst_editor ( boost : : shared_ptr < PluginInsert > )
# endif
{
# ifndef LXVST_SUPPORT
return false ;
# else
boost : : shared_ptr < LXVSTPlugin > lxvp ;
if ( ( lxvp = boost : : dynamic_pointer_cast < LXVSTPlugin > ( insert - > plugin ( ) ) ) = = 0 ) {
2013-02-05 13:18:35 -05:00
error < < string_compose ( _ ( " unknown type of editor-supplying plugin (note: no linuxVST support in this version of %1) " ) , PROGRAM_NAME )
< < endmsg ;
2011-09-20 16:29:47 -04:00
throw failed_constructor ( ) ;
} else {
LXVSTPluginUI * lxvpu = new LXVSTPluginUI ( insert , lxvp ) ;
_pluginui = lxvpu ;
_pluginui - > KeyboardFocused . connect ( sigc : : mem_fun ( * this , & PluginUIWindow : : keyboard_focused ) ) ;
add ( * lxvpu ) ;
lxvpu - > package ( * this ) ;
}
return true ;
# endif
}
2008-01-10 16:20:59 -05:00
bool
2011-12-02 15:03:03 -05:00
# ifdef AUDIOUNIT_SUPPORT
2008-01-10 16:20:59 -05:00
PluginUIWindow : : create_audiounit_editor ( boost : : shared_ptr < PluginInsert > insert )
2009-07-21 11:55:17 -04:00
# else
PluginUIWindow : : create_audiounit_editor ( boost : : shared_ptr < PluginInsert > )
2009-10-14 12:10:01 -04:00
# endif
2008-01-10 16:20:59 -05:00
{
2011-12-02 15:03:03 -05:00
# ifndef AUDIOUNIT_SUPPORT
2008-01-10 16:20:59 -05:00
return false ;
# else
VBox * box ;
_pluginui = create_au_gui ( insert , & box ) ;
2011-05-18 01:00:44 -04:00
_pluginui - > KeyboardFocused . connect ( sigc : : mem_fun ( * this , & PluginUIWindow : : keyboard_focused ) ) ;
2008-02-16 17:43:18 -05:00
add ( * box ) ;
2008-01-10 16:20:59 -05:00
2010-11-15 14:53:31 -05:00
Application : : instance ( ) - > ActivationChanged . connect ( mem_fun ( * this , & PluginUIWindow : : app_activated ) ) ;
2008-01-10 16:20:59 -05:00
return true ;
# endif
}
void
2010-11-13 00:14:48 -05:00
# ifdef GTKOSX
2008-01-10 16:20:59 -05:00
PluginUIWindow : : app_activated ( bool yn )
2009-07-21 11:55:17 -04:00
# else
PluginUIWindow : : app_activated ( bool )
2009-10-14 12:10:01 -04:00
# endif
2008-01-10 16:20:59 -05:00
{
2011-12-02 15:03:03 -05:00
# ifdef AUDIOUNIT_SUPPORT
2008-02-16 17:43:18 -05:00
if ( _pluginui ) {
if ( yn ) {
2008-04-11 10:06:50 -04:00
if ( was_visible ) {
_pluginui - > activate ( ) ;
2012-06-05 21:43:35 -04:00
if ( pre_deactivate_x > = 0 ) {
move ( pre_deactivate_x , pre_deactivate_y ) ;
}
2008-04-11 10:06:50 -04:00
present ( ) ;
was_visible = true ;
}
2008-02-16 17:43:18 -05:00
} else {
2008-04-11 10:06:50 -04:00
was_visible = is_visible ( ) ;
2012-06-05 21:43:35 -04:00
get_position ( pre_deactivate_x , pre_deactivate_y ) ;
2008-02-16 17:43:18 -05:00
hide ( ) ;
_pluginui - > deactivate ( ) ;
2008-01-19 00:06:33 -05:00
}
2009-10-14 12:10:01 -04:00
}
2008-01-10 16:20:59 -05:00
# endif
}
2008-09-10 17:27:39 -04:00
bool
PluginUIWindow : : create_lv2_editor ( boost : : shared_ptr < PluginInsert > insert )
{
2011-10-03 14:10:05 -04:00
# ifdef HAVE_SUIL
2008-09-10 17:27:39 -04:00
boost : : shared_ptr < LV2Plugin > vp ;
2009-10-14 12:10:01 -04:00
2008-09-10 17:27:39 -04:00
if ( ( vp = boost : : dynamic_pointer_cast < LV2Plugin > ( insert - > plugin ( ) ) ) = = 0 ) {
error < < _ ( " create_lv2_editor called on non-LV2 plugin " ) < < endmsg ;
throw failed_constructor ( ) ;
} else {
LV2PluginUI * lpu = new LV2PluginUI ( insert , vp ) ;
_pluginui = lpu ;
add ( * lpu ) ;
lpu - > package ( * this ) ;
2015-02-20 21:00:33 -05:00
_pluginui - > KeyboardFocused . connect ( sigc : : mem_fun ( * this , & PluginUIWindow : : keyboard_focused ) ) ;
2008-09-10 17:27:39 -04:00
}
return true ;
2011-05-15 19:10:13 -04:00
# else
return false ;
2008-09-10 17:27:39 -04:00
# endif
}
2010-08-20 18:36:35 -04:00
void
PluginUIWindow : : keyboard_focused ( bool yn )
{
_keyboard_focused = yn ;
}
2006-08-10 23:24:57 -04:00
bool
PluginUIWindow : : on_key_press_event ( GdkEventKey * event )
2005-09-25 14:42:24 -04:00
{
2010-08-20 18:36:35 -04:00
if ( _keyboard_focused ) {
if ( _pluginui ) {
2015-02-20 21:16:04 -05:00
_pluginui - > grab_focus ( ) ;
2011-05-18 01:00:44 -04:00
if ( _pluginui - > non_gtk_gui ( ) ) {
2011-06-01 13:00:29 -04:00
_pluginui - > forward_key_event ( event ) ;
2011-05-18 01:00:44 -04:00
} else {
2015-04-01 14:13:14 -04:00
return relay_key_press ( event , this ) ;
2011-05-18 01:00:44 -04:00
}
2010-08-20 18:36:35 -04:00
}
return true ;
} else {
2011-05-18 01:00:44 -04:00
/* for us to be getting key press events, there really
MUST be a _pluginui , but just to be safe , check . . .
*/
if ( _pluginui ) {
2015-02-20 21:16:04 -05:00
_pluginui - > grab_focus ( ) ;
2011-05-18 01:00:44 -04:00
if ( _pluginui - > non_gtk_gui ( ) ) {
/* pass editor window as the window for the event
to be handled in , not this one , because there are
no widgets in this window that we want to have
key focus .
*/
return relay_key_press ( event , & PublicEditor : : instance ( ) ) ;
} else {
2015-04-01 16:54:09 -04:00
return relay_key_press ( event , this ) ;
2011-05-18 01:00:44 -04:00
}
} else {
return false ;
}
2010-08-20 18:36:35 -04:00
}
2005-09-25 14:42:24 -04:00
}
2006-08-10 23:24:57 -04:00
bool
2010-08-20 18:36:35 -04:00
PluginUIWindow : : on_key_release_event ( GdkEventKey * event )
2005-09-25 14:42:24 -04:00
{
2010-08-20 18:36:35 -04:00
if ( _keyboard_focused ) {
if ( _pluginui ) {
2011-05-18 01:00:44 -04:00
if ( _pluginui - > non_gtk_gui ( ) ) {
_pluginui - > forward_key_event ( event ) ;
2011-06-01 13:00:29 -04:00
}
2011-05-18 01:00:44 -04:00
return true ;
2010-08-20 18:36:35 -04:00
}
return false ;
} else {
return true ;
}
2005-09-25 14:42:24 -04:00
}
void
2006-08-29 17:21:48 -04:00
PluginUIWindow : : plugin_going_away ( )
2005-09-25 14:42:24 -04:00
{
2009-12-11 18:29:48 -05:00
ENSURE_GUI_THREAD ( * this , & PluginUIWindow : : plugin_going_away )
2009-10-14 12:10:01 -04:00
2008-01-19 00:06:33 -05:00
if ( _pluginui ) {
_pluginui - > stop_updating ( 0 ) ;
}
2009-04-16 12:02:25 -04:00
death_connection . disconnect ( ) ;
2005-09-25 14:42:24 -04:00
}
2008-01-10 16:20:59 -05:00
PlugUIBase : : PlugUIBase ( boost : : shared_ptr < PluginInsert > pi )
2011-04-19 12:05:28 -04:00
: insert ( pi )
, plugin ( insert - > plugin ( ) )
, add_button ( _ ( " Add " ) )
, save_button ( _ ( " Save " ) )
, delete_button ( _ ( " Delete " ) )
2015-05-04 14:48:41 -04:00
, reset_button ( _ ( " Reset " ) )
2011-11-10 10:25:01 -05:00
, bypass_button ( ArdourButton : : led_default_elements )
2012-04-19 22:12:29 -04:00
, description_expander ( _ ( " Description " ) )
2011-11-23 14:29:43 -05:00
, plugin_analysis_expander ( _ ( " Plugin analysis " ) )
2011-04-19 12:05:28 -04:00
, latency_gui ( 0 )
, latency_dialog ( 0 )
, eqgui ( 0 )
2005-09-25 14:42:24 -04:00
{
2010-12-19 18:11:01 -05:00
_preset_modified . set_size_request ( 16 , - 1 ) ;
2015-03-06 19:05:29 -05:00
_preset_combo . set_text ( " (default) " ) ;
2015-01-05 00:32:14 -05:00
set_tooltip ( _preset_combo , _ ( " Presets (if any) for this plugin \n (Both factory and user-created) " ) ) ;
set_tooltip ( add_button , _ ( " Save a new preset " ) ) ;
set_tooltip ( save_button , _ ( " Save the current preset " ) ) ;
set_tooltip ( delete_button , _ ( " Delete the current preset " ) ) ;
set_tooltip ( reset_button , _ ( " Reset parameters to default (if no parameters are in automation play mode) " ) ) ;
set_tooltip ( bypass_button , _ ( " Disable signal processing by the plugin " ) ) ;
2010-12-19 18:11:01 -05:00
_no_load_preset = 0 ;
update_preset_list ( ) ;
update_preset ( ) ;
2011-06-01 13:00:29 -04:00
2015-03-06 19:05:29 -05:00
add_button . set_name ( " generic button " ) ;
add_button . signal_clicked . connect ( sigc : : mem_fun ( * this , & PlugUIBase : : add_plugin_setting ) ) ;
2010-12-14 20:06:57 -05:00
2015-03-06 19:05:29 -05:00
save_button . set_name ( " generic button " ) ;
save_button . signal_clicked . connect ( sigc : : mem_fun ( * this , & PlugUIBase : : save_plugin_setting ) ) ;
2005-09-25 14:42:24 -04:00
2015-03-06 19:05:29 -05:00
delete_button . set_name ( " generic button " ) ;
delete_button . signal_clicked . connect ( sigc : : mem_fun ( * this , & PlugUIBase : : delete_plugin_setting ) ) ;
2010-12-05 23:29:06 -05:00
2015-05-04 14:48:41 -04:00
reset_button . set_name ( " generic button " ) ;
reset_button . signal_clicked . connect ( sigc : : mem_fun ( * this , & PlugUIBase : : reset_plugin_parameters ) ) ;
2010-03-30 11:18:43 -04:00
insert - > ActiveChanged . connect ( active_connection , invalidator ( * this ) , boost : : bind ( & PlugUIBase : : processor_active_changed , this , boost : : weak_ptr < Processor > ( insert ) ) , gui_context ( ) ) ;
2009-03-07 06:17:06 -05:00
2011-11-10 10:25:01 -05:00
bypass_button . set_name ( " plugin bypass button " ) ;
bypass_button . set_text ( _ ( " Bypass " ) ) ;
2012-02-07 12:43:55 -05:00
bypass_button . set_active ( ! pi - > active ( ) ) ;
2014-08-28 15:55:39 -04:00
bypass_button . signal_button_release_event ( ) . connect ( sigc : : mem_fun ( * this , & PlugUIBase : : bypass_button_release ) , false ) ;
2008-12-12 09:43:24 -05:00
focus_button . add_events ( Gdk : : ENTER_NOTIFY_MASK | Gdk : : LEAVE_NOTIFY_MASK ) ;
2009-12-11 18:29:48 -05:00
focus_button . signal_button_release_event ( ) . connect ( sigc : : mem_fun ( * this , & PlugUIBase : : focus_toggled ) ) ;
2008-12-12 09:43:24 -05:00
focus_button . add_events ( Gdk : : ENTER_NOTIFY_MASK | Gdk : : LEAVE_NOTIFY_MASK ) ;
/* these images are not managed, so that we can remove them at will */
focus_out_image = new Image ( get_icon ( X_ ( " computer_keyboard " ) ) ) ;
focus_in_image = new Image ( get_icon ( X_ ( " computer_keyboard_active " ) ) ) ;
2009-10-14 12:10:01 -04:00
2008-12-12 09:43:24 -05:00
focus_button . add ( * focus_out_image ) ;
2015-01-05 00:32:14 -05:00
set_tooltip ( focus_button , string_compose ( _ ( " Click to allow the plugin to receive keyboard events that %1 would normally use as a shortcut " ) , PROGRAM_NAME ) ) ;
set_tooltip ( bypass_button , _ ( " Click to enable/disable this plugin " ) ) ;
2009-03-07 06:17:06 -05:00
2012-04-19 22:12:29 -04:00
description_expander . property_expanded ( ) . signal_changed ( ) . connect ( sigc : : mem_fun ( * this , & PlugUIBase : : toggle_description ) ) ;
description_expander . set_expanded ( false ) ;
2009-12-11 18:29:48 -05:00
plugin_analysis_expander . property_expanded ( ) . signal_changed ( ) . connect ( sigc : : mem_fun ( * this , & PlugUIBase : : toggle_plugin_analysis ) ) ;
2009-05-08 13:21:17 -04:00
plugin_analysis_expander . set_expanded ( false ) ;
2011-06-01 13:00:29 -04:00
2010-03-30 11:18:43 -04:00
insert - > DropReferences . connect ( death_connection , invalidator ( * this ) , boost : : bind ( & PlugUIBase : : plugin_going_away , this ) , gui_context ( ) ) ;
2010-12-05 23:29:06 -05:00
2010-12-19 18:11:01 -05:00
plugin - > PresetAdded . connect ( * this , invalidator ( * this ) , boost : : bind ( & PlugUIBase : : preset_added_or_removed , this ) , gui_context ( ) ) ;
2011-06-01 13:00:29 -04:00
plugin - > PresetRemoved . connect ( * this , invalidator ( * this ) , boost : : bind ( & PlugUIBase : : preset_added_or_removed , this ) , gui_context ( ) ) ;
2010-12-19 18:11:01 -05:00
plugin - > PresetLoaded . connect ( * this , invalidator ( * this ) , boost : : bind ( & PlugUIBase : : update_preset , this ) , gui_context ( ) ) ;
plugin - > ParameterChanged . connect ( * this , invalidator ( * this ) , boost : : bind ( & PlugUIBase : : parameter_changed , this , _1 , _2 ) , gui_context ( ) ) ;
2015-05-04 14:48:41 -04:00
insert - > AutomationStateChanged . connect ( * this , invalidator ( * this ) , boost : : bind ( & PlugUIBase : : automation_state_changed , this ) , gui_context ( ) ) ;
automation_state_changed ( ) ;
2005-09-25 14:42:24 -04:00
}
2009-04-16 12:02:25 -04:00
PlugUIBase : : ~ PlugUIBase ( )
{
2011-04-19 12:05:28 -04:00
delete eqgui ;
2009-05-04 13:49:28 -04:00
delete latency_gui ;
}
2009-07-12 20:26:28 -04:00
void
PlugUIBase : : plugin_going_away ( )
{
/* drop references to the plugin/insert */
insert . reset ( ) ;
plugin . reset ( ) ;
}
2009-05-04 13:49:28 -04:00
void
PlugUIBase : : set_latency_label ( )
{
2010-12-03 17:26:29 -05:00
framecnt_t const l = insert - > effective_latency ( ) ;
framecnt_t const sr = insert - > session ( ) . frame_rate ( ) ;
2009-05-04 13:49:28 -04:00
2010-12-21 20:44:00 -05:00
string t ;
2009-05-04 13:49:28 -04:00
if ( l < sr / 1000 ) {
2013-01-05 07:30:12 -05:00
t = string_compose ( P_ ( " latency (%1 sample) " , " latency (%1 samples) " , l ) , l ) ;
2009-05-04 13:49:28 -04:00
} else {
2010-12-21 20:44:00 -05:00
t = string_compose ( _ ( " latency (%1 ms) " ) , ( float ) l / ( ( float ) sr / 1000.0f ) ) ;
2009-05-04 13:49:28 -04:00
}
2015-03-06 19:05:29 -05:00
latency_button . set_text ( t ) ;
2009-05-04 13:49:28 -04:00
}
void
PlugUIBase : : latency_button_clicked ( )
{
if ( ! latency_gui ) {
latency_gui = new LatencyGUI ( * ( insert . get ( ) ) , insert - > session ( ) . frame_rate ( ) , insert - > session ( ) . get_block_size ( ) ) ;
2011-11-18 19:56:35 -05:00
latency_dialog = new ArdourWindow ( _ ( " Edit Latency " ) ) ;
2012-06-22 12:38:15 -04:00
/* use both keep-above and transient for to try cover as many
different WM ' s as possible .
*/
latency_dialog - > set_keep_above ( true ) ;
Window * win = dynamic_cast < Window * > ( bypass_button . get_toplevel ( ) ) ;
if ( win ) {
latency_dialog - > set_transient_for ( * win ) ;
}
2011-11-18 19:56:35 -05:00
latency_dialog - > add ( * latency_gui ) ;
2009-12-11 18:29:48 -05:00
latency_dialog - > signal_hide ( ) . connect ( sigc : : mem_fun ( * this , & PlugUIBase : : set_latency_label ) ) ;
2009-05-04 13:49:28 -04:00
}
latency_dialog - > show_all ( ) ;
2009-04-16 12:02:25 -04:00
}
2008-02-16 17:43:18 -05:00
void
PlugUIBase : : processor_active_changed ( boost : : weak_ptr < Processor > weak_p )
{
2011-11-10 10:25:01 -05:00
ENSURE_GUI_THREAD ( * this , & PlugUIBase : : processor_active_changed , weak_p ) ;
boost : : shared_ptr < Processor > p ( weak_p . lock ( ) ) ;
2008-02-16 17:43:18 -05:00
if ( p ) {
2012-02-07 12:43:55 -05:00
bypass_button . set_active ( ! p - > active ( ) ) ;
2008-02-16 17:43:18 -05:00
}
}
2005-11-23 12:21:12 -05:00
void
2015-03-06 19:05:29 -05:00
PlugUIBase : : preset_selected ( Plugin : : PresetRecord preset )
2005-09-25 14:42:24 -04:00
{
2010-12-19 18:11:01 -05:00
if ( _no_load_preset ) {
2009-11-19 07:38:15 -05:00
return ;
}
2015-03-06 19:05:29 -05:00
if ( ! preset . label . empty ( ) ) {
plugin - > load_preset ( preset ) ;
2012-06-19 12:02:24 -04:00
} else {
// blank selected = no preset
plugin - > clear_preset ( ) ;
2005-09-25 14:42:24 -04:00
}
}
2013-06-13 22:50:54 -04:00
# ifdef NO_PLUGIN_STATE
static bool seen_saving_message = false ;
2015-03-22 19:05:47 -04:00
static void show_no_plugin_message ( )
{
info < < string_compose ( _ ( " Plugin presets are not supported in this build of %1. Consider paying for a full version " ) ,
PROGRAM_NAME )
< < endmsg ;
info < < _ ( " To get full access to updates without this limitation \n "
" consider becoming a subscriber for a low cost every month. " )
< < endmsg ;
info < < X_ ( " https://community.ardour.org/s/subscribe " )
< < endmsg ;
ARDOUR_UI : : instance ( ) - > popup_error ( _ ( " Plugin presets are not supported in this build, see the Log window for more information. " ) ) ;
}
2013-06-13 22:50:54 -04:00
# endif
2005-09-25 14:42:24 -04:00
void
2010-12-14 20:06:57 -05:00
PlugUIBase : : add_plugin_setting ( )
2005-09-25 14:42:24 -04:00
{
2013-06-13 22:50:54 -04:00
# ifndef NO_PLUGIN_STATE
2010-12-05 21:41:46 -05:00
NewPluginPresetDialog d ( plugin ) ;
2005-09-25 14:42:24 -04:00
2010-12-05 21:41:46 -05:00
switch ( d . run ( ) ) {
2005-11-24 22:36:42 -05:00
case Gtk : : RESPONSE_ACCEPT :
2010-12-05 21:41:46 -05:00
if ( d . name ( ) . empty ( ) ) {
break ;
}
if ( d . replace ( ) ) {
plugin - > remove_preset ( d . name ( ) ) ;
}
2010-12-19 18:11:01 -05:00
Plugin : : PresetRecord const r = plugin - > save_preset ( d . name ( ) ) ;
if ( ! r . uri . empty ( ) ) {
plugin - > load_preset ( r ) ;
2005-09-25 14:42:24 -04:00
}
2005-10-26 21:10:36 -04:00
break ;
2005-09-25 14:42:24 -04:00
}
2015-10-04 14:51:05 -04:00
# else
2013-06-13 22:50:54 -04:00
if ( ! seen_saving_message ) {
seen_saving_message = true ;
2015-03-22 19:05:47 -04:00
show_no_plugin_message ( ) ;
2013-06-13 22:50:54 -04:00
}
# endif
2005-09-25 14:42:24 -04:00
}
2010-12-05 23:29:06 -05:00
void
2010-12-14 20:06:57 -05:00
PlugUIBase : : save_plugin_setting ( )
2010-12-05 23:29:06 -05:00
{
2013-06-13 22:50:54 -04:00
# ifndef NO_PLUGIN_STATE
2015-03-06 19:05:29 -05:00
string const name = _preset_combo . get_text ( ) ;
2010-12-14 20:06:57 -05:00
plugin - > remove_preset ( name ) ;
2010-12-19 18:11:01 -05:00
Plugin : : PresetRecord const r = plugin - > save_preset ( name ) ;
if ( ! r . uri . empty ( ) ) {
plugin - > load_preset ( r ) ;
}
2015-10-04 14:51:05 -04:00
# else
2013-06-13 22:50:54 -04:00
if ( ! seen_saving_message ) {
seen_saving_message = true ;
2015-03-22 19:05:47 -04:00
show_no_plugin_message ( ) ;
2013-06-13 22:50:54 -04:00
}
# endif
2010-12-14 20:06:57 -05:00
}
void
PlugUIBase : : delete_plugin_setting ( )
{
2013-06-13 22:50:54 -04:00
# ifndef NO_PLUGIN_STATE
2015-03-06 19:05:29 -05:00
plugin - > remove_preset ( _preset_combo . get_text ( ) ) ;
2013-06-13 22:50:54 -04:00
# else
if ( ! seen_saving_message ) {
seen_saving_message = true ;
2015-03-22 19:05:47 -04:00
show_no_plugin_message ( ) ;
2013-06-13 22:50:54 -04:00
}
# endif
2010-12-05 23:29:06 -05:00
}
2015-05-04 14:48:41 -04:00
void
PlugUIBase : : automation_state_changed ( )
{
reset_button . set_sensitive ( insert - > can_reset_all_parameters ( ) ) ;
}
void
PlugUIBase : : reset_plugin_parameters ( )
{
insert - > reset_parameters_to_default ( ) ;
}
2011-11-10 10:25:01 -05:00
bool
PlugUIBase : : bypass_button_release ( GdkEventButton * )
2005-09-25 14:42:24 -04:00
{
2011-11-10 10:25:01 -05:00
bool view_says_bypassed = ( bypass_button . active_state ( ) ! = 0 ) ;
2015-10-05 10:17:49 -04:00
2011-11-10 10:25:01 -05:00
if ( view_says_bypassed ! = insert - > active ( ) ) {
if ( view_says_bypassed ) {
2009-01-30 02:40:13 -05:00
insert - > activate ( ) ;
2011-11-10 10:25:01 -05:00
} else {
insert - > deactivate ( ) ;
2009-01-30 02:40:13 -05:00
}
2005-09-25 14:42:24 -04:00
}
2011-11-10 10:25:01 -05:00
return false ;
2005-09-25 14:42:24 -04:00
}
2008-03-17 16:54:03 -04:00
2008-12-12 09:43:24 -05:00
bool
2009-07-21 11:55:17 -04:00
PlugUIBase : : focus_toggled ( GdkEventButton * )
2008-12-12 09:43:24 -05:00
{
if ( Keyboard : : the_keyboard ( ) . some_magic_widget_has_focus ( ) ) {
Keyboard : : the_keyboard ( ) . magic_widget_drop_focus ( ) ;
focus_button . remove ( ) ;
focus_button . add ( * focus_out_image ) ;
focus_out_image - > show ( ) ;
2015-01-05 00:32:14 -05:00
set_tooltip ( focus_button , string_compose ( _ ( " Click to allow the plugin to receive keyboard events that %1 would normally use as a shortcut " ) , PROGRAM_NAME ) ) ;
2010-08-20 18:36:35 -04:00
KeyboardFocused ( false ) ;
2008-12-12 09:43:24 -05:00
} else {
Keyboard : : the_keyboard ( ) . magic_widget_grab_focus ( ) ;
focus_button . remove ( ) ;
focus_button . add ( * focus_in_image ) ;
focus_in_image - > show ( ) ;
2015-01-05 00:32:14 -05:00
set_tooltip ( focus_button , string_compose ( _ ( " Click to allow normal use of %1 keyboard shortcuts " ) , PROGRAM_NAME ) ) ;
2010-08-20 18:36:35 -04:00
KeyboardFocused ( true ) ;
2008-12-12 09:43:24 -05:00
}
return true ;
}
2012-04-19 22:12:29 -04:00
void
PlugUIBase : : toggle_description ( )
{
if ( description_expander . get_expanded ( ) & &
! description_expander . get_child ( ) ) {
const std : : string text = plugin - > get_docs ( ) ;
if ( text . empty ( ) ) {
return ;
}
Gtk : : Label * label = manage ( new Gtk : : Label ( text ) ) ;
label - > set_line_wrap ( true ) ;
label - > set_line_wrap_mode ( Pango : : WRAP_WORD ) ;
description_expander . add ( * label ) ;
description_expander . show_all ( ) ;
}
2015-10-05 10:17:49 -04:00
2012-04-19 22:12:29 -04:00
if ( ! description_expander . get_expanded ( ) ) {
description_expander . remove ( ) ;
}
}
2009-03-07 06:17:06 -05:00
void
PlugUIBase : : toggle_plugin_analysis ( )
{
2009-10-14 12:10:01 -04:00
if ( plugin_analysis_expander . get_expanded ( ) & &
2012-04-19 22:12:29 -04:00
! plugin_analysis_expander . get_child ( ) ) {
2009-03-07 06:17:06 -05:00
// Create the GUI
2011-04-19 12:05:28 -04:00
if ( eqgui = = 0 ) {
eqgui = new PluginEqGui ( insert ) ;
}
Gtk : : Window * toplevel = ( Gtk : : Window * ) plugin_analysis_expander . get_ancestor ( GTK_TYPE_WINDOW ) ;
if ( toplevel ) {
toplevel - > get_size ( pre_eq_size . width , pre_eq_size . height ) ;
}
plugin_analysis_expander . add ( * eqgui ) ;
plugin_analysis_expander . show_all ( ) ;
eqgui - > start_listening ( ) ;
2009-10-14 12:10:01 -04:00
}
2011-04-19 12:05:28 -04:00
if ( ! plugin_analysis_expander . get_expanded ( ) ) {
// Hide & remove from expander
2009-03-07 06:17:06 -05:00
2011-04-19 12:05:28 -04:00
eqgui - > hide ( ) ;
eqgui - > stop_listening ( ) ;
plugin_analysis_expander . remove ( ) ;
2009-03-07 06:17:06 -05:00
2011-04-19 12:05:28 -04:00
Gtk : : Window * toplevel = ( Gtk : : Window * ) plugin_analysis_expander . get_ancestor ( GTK_TYPE_WINDOW ) ;
2009-03-07 06:17:06 -05:00
2011-04-19 12:05:28 -04:00
if ( toplevel ) {
toplevel - > resize ( pre_eq_size . width , pre_eq_size . height ) ;
2009-03-07 06:17:06 -05:00
}
}
}
2008-03-17 16:54:03 -04:00
void
2010-12-19 18:11:01 -05:00
PlugUIBase : : update_preset_list ( )
2008-03-17 16:54:03 -04:00
{
2015-03-06 19:05:29 -05:00
using namespace Menu_Helpers ;
2009-02-13 22:28:12 -05:00
vector < ARDOUR : : Plugin : : PresetRecord > presets = plugin - > get_presets ( ) ;
2009-11-19 07:38:15 -05:00
2010-12-19 18:11:01 -05:00
+ + _no_load_preset ;
2009-11-19 07:38:15 -05:00
2015-03-06 19:05:29 -05:00
// Add a menu entry for each preset
_preset_combo . clear_items ( ) ;
2009-11-19 07:38:15 -05:00
for ( vector < ARDOUR : : Plugin : : PresetRecord > : : const_iterator i = presets . begin ( ) ; i ! = presets . end ( ) ; + + i ) {
2015-03-06 19:05:29 -05:00
_preset_combo . AddMenuElem (
MenuElem ( i - > label , sigc : : bind ( sigc : : mem_fun ( * this , & PlugUIBase : : preset_selected ) , * i ) ) ) ;
2009-02-13 22:28:12 -05:00
}
2009-11-19 07:38:15 -05:00
2015-03-06 19:05:29 -05:00
// Add an empty entry for un-setting current preset (see preset_selected)
Plugin : : PresetRecord no_preset ;
_preset_combo . AddMenuElem (
MenuElem ( " " , sigc : : bind ( sigc : : mem_fun ( * this , & PlugUIBase : : preset_selected ) , no_preset ) ) ) ;
2011-06-01 13:00:29 -04:00
2010-12-19 18:11:01 -05:00
- - _no_load_preset ;
}
void
PlugUIBase : : update_preset ( )
{
Plugin : : PresetRecord p = plugin - > last_preset ( ) ;
+ + _no_load_preset ;
2015-03-06 19:05:29 -05:00
if ( p . uri . empty ( ) ) {
2015-04-02 21:26:04 -04:00
_preset_combo . set_text ( _ ( " (none) " ) ) ;
2015-03-06 19:05:29 -05:00
} else {
_preset_combo . set_text ( p . label ) ;
}
2010-12-19 18:11:01 -05:00
- - _no_load_preset ;
2010-12-14 20:06:57 -05:00
2010-12-19 18:11:01 -05:00
save_button . set_sensitive ( ! p . uri . empty ( ) & & p . user ) ;
delete_button . set_sensitive ( ! p . uri . empty ( ) & & p . user ) ;
update_preset_modified ( ) ;
2010-12-14 20:06:57 -05:00
}
void
2010-12-19 18:11:01 -05:00
PlugUIBase : : update_preset_modified ( )
2010-12-14 20:06:57 -05:00
{
2012-06-19 12:02:24 -04:00
2010-12-19 18:11:01 -05:00
if ( plugin - > last_preset ( ) . uri . empty ( ) ) {
_preset_modified . set_text ( " " ) ;
return ;
}
2011-06-01 13:00:29 -04:00
2010-12-19 18:11:01 -05:00
bool const c = plugin - > parameter_changed_since_last_preset ( ) ;
if ( _preset_modified . get_text ( ) . empty ( ) = = c ) {
_preset_modified . set_text ( c ? " * " : " " ) ;
}
}
void
PlugUIBase : : parameter_changed ( uint32_t , float )
{
update_preset_modified ( ) ;
}
void
PlugUIBase : : preset_added_or_removed ( )
{
/* Update both the list and the currently-displayed preset */
update_preset_list ( ) ;
update_preset ( ) ;
2008-03-17 16:54:03 -04:00
}
2012-06-05 21:43:35 -04:00