Tidy up the region menu a bit, and hopefully clarify what regions will be
[ardour.git] / gtk2_ardour / rhythm_ferret.cc
index d8d2f3c28be4e0173a5bf777627e5d6421395b9b..da31feca3c8fc6f81f3ae3f7489138fbec86301d 100644 (file)
@@ -1,19 +1,22 @@
 #include <gtkmm/stock.h>
 #include <gtkmm2ext/utils.h>
 
-#include <pbd/memento_command.h>
+#include "pbd/memento_command.h"
+#include "pbd/convert.h"
 
-#include <ardour/transient_detector.h>
-#include <ardour/audiosource.h>
-#include <ardour/audioregion.h>
-#include <ardour/playlist.h>
-#include <ardour/region_factory.h>
-#include <ardour/session.h>
+#include "ardour/transient_detector.h"
+#include "ardour/onset_detector.h"
+#include "ardour/audiosource.h"
+#include "ardour/audioregion.h"
+#include "ardour/playlist.h"
+#include "ardour/region_factory.h"
+#include "ardour/session.h"
 
 #include "rhythm_ferret.h"
 #include "audio_region_view.h"
-#include "public_editor.h"
+#include "editor.h"
 #include "utils.h"
+#include "time_axis_view.h"
 
 #include "i18n.h"
 
@@ -32,109 +35,121 @@ static const gchar * _analysis_mode_strings[] = {
        0
 };
 
-RhythmFerret::RhythmFerret (PublicEditor& e)
+static const gchar * _onset_function_strings[] = {
+       N_("Energy Based"),
+       N_("Spectral Difference"),
+       N_("High-Frequency Content"),
+       N_("Complex Domain"),
+       N_("Phase Deviation"),
+       N_("Kullback-Liebler"),
+       N_("Modified Kullback-Liebler"),
+       0
+};
+
+static const gchar * _operation_strings[] = {
+       N_("Split region"),
+       N_("Set tempo map"),
+       N_("Conform region"),
+       0
+};
+
+RhythmFerret::RhythmFerret (Editor& e)
        : ArdourDialog (_("Rhythm Ferret"))
        , editor (e)
-       , operation_frame (_("Operation"))
-       , selection_frame (_("Selection"))
-       , ferret_frame (_("Analysis"))
-       , logo (0)
-       , region_split_button (operation_button_group, _("Split Region"))
-       , tempo_button (operation_button_group, _("Set Tempo Map"))
-       , region_conform_button (operation_button_group, _("Conform Region"))
-       , analysis_mode_label (_("Mode"))
        , detection_threshold_adjustment (3, 0, 20, 1, 4)
        , detection_threshold_scale (detection_threshold_adjustment)
-       , detection_threshold_label (_("Threshold"))
        , sensitivity_adjustment (40, 0, 100, 1, 10)
        , sensitivity_scale (sensitivity_adjustment)
-       , sensitivity_label (_("Sensitivity"))
        , analyze_button (_("Analyze"))
+       , peak_picker_threshold_adjustment (0.3, 0.0, 1.0, 0.01, 0.1)
+       , peak_picker_threshold_scale (peak_picker_threshold_adjustment)
+       , silence_threshold_adjustment (-90.0, -120.0, 0.0, 1, 10)
+       , silence_threshold_scale (silence_threshold_adjustment)
        , trigger_gap_adjustment (3, 0, 100, 1, 10)
        , trigger_gap_spinner (trigger_gap_adjustment)
-       , trigger_gap_label (_("Trigger gap (msecs)"))
        , action_button (Stock::APPLY)
-
 {
-       upper_hpacker.set_spacing (6);
-
-       upper_hpacker.pack_start (ferret_frame, true, true);
-       upper_hpacker.pack_start (selection_frame, true, true);
-       upper_hpacker.pack_start (operation_frame, true, true);
-
-       op_packer.pack_start (region_split_button, false, false);
-       op_packer.pack_start (tempo_button, false, false);
-       op_packer.pack_start (region_conform_button, false, false);
-
-       operation_frame.add (op_packer);
-
-       HBox* box;
-
-       ferret_packer.set_spacing (6);
-       ferret_packer.set_border_width (6);
-       
-       vector<string> strings;
+       operation_strings = I18N (_operation_strings);
+       Gtkmm2ext::set_popdown_strings (operation_selector, operation_strings);
+       operation_selector.set_active (0);
 
        analysis_mode_strings = I18N (_analysis_mode_strings);
        Gtkmm2ext::set_popdown_strings (analysis_mode_selector, analysis_mode_strings);
        analysis_mode_selector.set_active_text (analysis_mode_strings.front());
-
-       box = manage (new HBox);
-       box->set_spacing (6);
-       box->pack_start (analysis_mode_label, false, false);
-       box->pack_start (analysis_mode_selector, true, true);
-       ferret_packer.pack_start (*box, false, false);
-
-       box = manage (new HBox);
-       box->set_spacing (6);
-       box->pack_start (detection_threshold_label, false, false);
-       box->pack_start (detection_threshold_scale, true, true);
-       ferret_packer.pack_start (*box, false, false);
-
-       box = manage (new HBox);
-       box->set_spacing (6);
-       box->pack_start (sensitivity_label, false, false);
-       box->pack_start (sensitivity_scale, true, true);
-       ferret_packer.pack_start (*box, false, false);
-
-       box = manage (new HBox);
-       box->set_spacing (6);
-       box->pack_start (trigger_gap_label, false, false);
-       box->pack_start (trigger_gap_spinner, false, false);
-       ferret_packer.pack_start (*box, false, false);
-
-       ferret_packer.pack_start (analyze_button, false, false);
-
-       analyze_button.signal_clicked().connect (mem_fun (*this, &RhythmFerret::run_analysis));
-       
-       ferret_frame.add (ferret_packer);
+       analysis_mode_selector.signal_changed().connect (sigc::mem_fun (*this, &RhythmFerret::analysis_mode_changed));
+
+       onset_function_strings = I18N (_onset_function_strings);
+       Gtkmm2ext::set_popdown_strings (onset_detection_function_selector, onset_function_strings);
+       /* Onset plugin uses complex domain as default function
+          XXX there should be a non-hacky way to set this
+        */
+       onset_detection_function_selector.set_active_text (onset_function_strings[3]);
+
+       Table* t = manage (new Table (7, 3));
+       t->set_spacings (12);
+
+       int n = 0;
+
+       t->attach (*manage (new Label (_("Mode"), 1, 0.5)), 0, 1, n, n + 1, FILL);
+       t->attach (analysis_mode_selector, 1, 2, n, n + 1, FILL);
+       ++n;
+
+       t->attach (*manage (new Label (_("Detection function"), 1, 0.5)), 0, 1, n, n + 1, FILL);
+       t->attach (onset_detection_function_selector, 1, 2, n, n + 1, FILL);
+       ++n;
+
+       t->attach (*manage (new Label (_("Trigger gap"), 1, 0.5)), 0, 1, n, n + 1, FILL);
+       t->attach (trigger_gap_spinner, 1, 2, n, n + 1, FILL);
+       t->attach (*manage (new Label (_("ms"))), 2, 3, n, n + 1, FILL);
+       ++n;
+
+       t->attach (*manage (new Label (_("Threshold"), 1, 0.5)), 0, 1, n, n + 1, FILL);
+       t->attach (detection_threshold_scale, 1, 2, n, n + 1, FILL);
+       t->attach (*manage (new Label (_("dB"))), 2, 3, n, n + 1, FILL);
+       ++n;
+
+       t->attach (*manage (new Label (_("Peak threshold"), 1, 0.5)), 0, 1, n, n + 1, FILL);
+       t->attach (peak_picker_threshold_scale, 1, 2, n, n + 1, FILL);
+       t->attach (*manage (new Label (_("dB"))), 2, 3, n, n + 1, FILL);
+       ++n;
        
-       logo = manage (new Gtk::Image (::get_icon (X_("ferret_02"))));
+       t->attach (*manage (new Label (_("Silence threshold"), 1, 0.5)), 0, 1, n, n + 1, FILL);
+       t->attach (silence_threshold_scale, 1, 2, n, n + 1, FILL);
+       t->attach (*manage (new Label (_("dB"))), 2, 3, n, n + 1, FILL);
+       ++n;
 
-       if (logo) {
-               lower_hpacker.pack_start (*logo, false, false);
-       }
+       t->attach (*manage (new Label (_("Sensitivity"), 1, 0.5)), 0, 1, n, n + 1, FILL);
+       t->attach (sensitivity_scale, 1, 2, n, n + 1, FILL);
+       ++n;
 
-       lower_hpacker.pack_start (operation_clarification_label, true, true);
-       lower_hpacker.pack_start (action_button, false, false);
-       lower_hpacker.set_border_width (6);
-       lower_hpacker.set_spacing (6);
+       t->attach (*manage (new Label (_("Operation"), 1, 0.5)), 0, 1, n, n + 1, FILL);
+       t->attach (operation_selector, 1, 2, n, n + 1, FILL);
+       ++n;
+
+       analyze_button.signal_clicked().connect (sigc::mem_fun (*this, &RhythmFerret::run_analysis));
+       action_button.signal_clicked().connect (sigc::mem_fun (*this, &RhythmFerret::do_action));
 
-       action_button.signal_clicked().connect (mem_fun (*this, &RhythmFerret::do_action));
-       
        get_vbox()->set_border_width (6);
        get_vbox()->set_spacing (6);
-       get_vbox()->pack_start (upper_hpacker, true, true);
-       get_vbox()->pack_start (lower_hpacker, false, false);
+       get_vbox()->pack_start (*t);
+
+       add_action_widget (analyze_button, 1);
+       add_action_widget (action_button, 0);
 
        show_all ();
+       analysis_mode_changed ();
 }
 
-RhythmFerret::~RhythmFerret()
+void
+RhythmFerret::analysis_mode_changed ()
 {
-       if (logo) {
-               delete logo;
-       }
+       bool const perc = get_analysis_mode() == PercussionOnset;
+       
+       detection_threshold_scale.set_sensitive (perc);
+       sensitivity_scale.set_sensitive (perc);
+       onset_detection_function_selector.set_sensitive (!perc);
+       peak_picker_threshold_scale.set_sensitive (!perc);
+       silence_threshold_scale.set_sensitive (!perc);
 }
 
 RhythmFerret::AnalysisMode
@@ -142,9 +157,9 @@ RhythmFerret::get_analysis_mode () const
 {
        string str = analysis_mode_selector.get_active_text ();
 
-       if (str == _(_analysis_mode_strings[(int) NoteOnset])) {
+       if (str == analysis_mode_strings[(int) NoteOnset]) {
                return NoteOnset;
-       } 
+       }
 
        return PercussionOnset;
 }
@@ -152,9 +167,9 @@ RhythmFerret::get_analysis_mode () const
 RhythmFerret::Action
 RhythmFerret::get_action () const
 {
-       if (tempo_button.get_active()) {
+       if (operation_selector.get_active_row_number() == 1) {
                return DefineTempoMap;
-       } else if (region_conform_button.get_active()) {
+       } else if (operation_selector.get_active_row_number() == 2) {
                return ConformRegion;
        }
 
@@ -164,7 +179,7 @@ RhythmFerret::get_action () const
 void
 RhythmFerret::run_analysis ()
 {
-       if (!session) {
+       if (!_session) {
                return;
        }
 
@@ -184,22 +199,22 @@ RhythmFerret::run_analysis ()
                case PercussionOnset:
                        run_percussion_onset_analysis (rd, (*i)->region()->position(), current_results);
                        break;
+               case NoteOnset:
+                       run_note_onset_analysis (rd, (*i)->region()->position(), current_results);
+                       break;
                default:
                        break;
                }
-
-       }
-
-       for (RegionSelection::iterator i = regions.begin(); i != regions.end(); ++i) {
-               (*i)->get_time_axis_view().show_temporary_lines (current_results);
+               
+               (*i)->region()->set_transients (current_results);
+               current_results.clear();
        }
-
 }
 
 int
-RhythmFerret::run_percussion_onset_analysis (boost::shared_ptr<Readable> readable, nframes64_t offset, AnalysisFeatureList& results)
+RhythmFerret::run_percussion_onset_analysis (boost::shared_ptr<Readable> readable, framepos_t /*offset*/, AnalysisFeatureList& results)
 {
-       TransientDetector t (session->frame_rate());
+       TransientDetector t (_session->frame_rate());
 
        for (uint32_t i = 0; i < readable->n_channels(); ++i) {
 
@@ -215,18 +230,79 @@ RhythmFerret::run_percussion_onset_analysis (boost::shared_ptr<Readable> readabl
 
                /* translate all transients to give absolute position */
 
-               for (AnalysisFeatureList::iterator x = these_results.begin(); x != these_results.end(); ++x) {
-                       (*x) += offset;
-               }
+               //for (AnalysisFeatureList::iterator x = these_results.begin(); x != these_results.end(); ++x) {
+               //      (*x) += offset;
+               //}
 
                /* merge */
-               
+
                results.insert (results.end(), these_results.begin(), these_results.end());
                these_results.clear ();
        }
 
        if (!results.empty()) {
-               TransientDetector::cleanup_transients (results, session->frame_rate(), trigger_gap_adjustment.get_value());
+               TransientDetector::cleanup_transients (results, _session->frame_rate(), trigger_gap_adjustment.get_value());
+       }
+
+       return 0;
+}
+
+int
+RhythmFerret::get_note_onset_function ()
+{
+       string txt = onset_detection_function_selector.get_active_text();
+
+       for (int n = 0; _onset_function_strings[n]; ++n) {
+               /* compare translated versions */
+               if (txt == onset_function_strings[n]) {
+                       return n;
+               }
+       }
+       fatal << string_compose (_("programming error: %1 (%2)"), X_("illegal note onset function string"), txt)
+             << endmsg;
+       /*NOTREACHED*/
+       return -1;
+}
+
+int
+RhythmFerret::run_note_onset_analysis (boost::shared_ptr<Readable> readable, framepos_t /*offset*/, AnalysisFeatureList& results)
+{
+       try {
+               OnsetDetector t (_session->frame_rate());
+
+               for (uint32_t i = 0; i < readable->n_channels(); ++i) {
+
+                       AnalysisFeatureList these_results;
+
+                       t.reset ();
+
+                       t.set_function (get_note_onset_function());
+                       t.set_silence_threshold (silence_threshold_adjustment.get_value());
+                       t.set_peak_threshold (peak_picker_threshold_adjustment.get_value());
+
+                       if (t.run ("", readable.get(), i, these_results)) {
+                               continue;
+                       }
+
+                       /* translate all transients to give absolute position */
+
+                       //for (AnalysisFeatureList::iterator x = these_results.begin(); x != these_results.end(); ++x) {
+                       //      (*x) += offset;
+                       //}
+
+                       /* merge */
+
+                       results.insert (results.end(), these_results.begin(), these_results.end());
+                       these_results.clear ();
+               }
+
+       } catch (failed_constructor& err) {
+               error << "Could not load note onset detection plugin" << endmsg;
+               return -1;
+       }
+
+       if (!results.empty()) {
+               OnsetDetector::cleanup_onsets (results, _session->frame_rate(), trigger_gap_adjustment.get_value());
        }
 
        return 0;
@@ -235,7 +311,7 @@ RhythmFerret::run_percussion_onset_analysis (boost::shared_ptr<Readable> readabl
 void
 RhythmFerret::do_action ()
 {
-       if (!session || current_results.empty()) {
+       if (!_session) {
                return;
        }
 
@@ -243,7 +319,9 @@ RhythmFerret::do_action ()
        case SplitRegion:
                do_split_action ();
                break;
-
+       case ConformRegion:
+               editor.close_region_gaps();
+               break;
        default:
                break;
        }
@@ -252,15 +330,27 @@ RhythmFerret::do_action ()
 void
 RhythmFerret::do_split_action ()
 {
-       /* this can/will change the current selection, so work with a copy */
-
        RegionSelection& regions (editor.get_selection().regions);
-
+       
        if (regions.empty()) {
                return;
        }
 
-       session->begin_reversible_command (_("split regions (rhythm ferret)"));
+       _session->begin_reversible_command (_("split regions (rhythm ferret)"));
+       
+       /* Merge the transient positions for regions in consideration */
+       AnalysisFeatureList merged_features;
+       
+       for (RegionSelection::iterator i = regions.begin(); i != regions.end(); ++i) {
+               
+               AnalysisFeatureList features;
+               features = (*i)->region()->transients();
+               
+               merged_features.insert (merged_features.end(), features.begin(), features.end());               
+       }
+       
+       merged_features.sort();
+       merged_features.unique();
 
        for (RegionSelection::iterator i = regions.begin(); i != regions.end(); ) {
 
@@ -269,15 +359,16 @@ RhythmFerret::do_split_action ()
                tmp = i;
                ++tmp;
 
-               (*i)->get_time_axis_view().hide_temporary_lines ();
-
-               editor.split_region_at_points ((*i)->region(), current_results);
+               AnalysisFeatureList features;
+               features = (*i)->region()->transients();
+               editor.split_region_at_points ((*i)->region(), merged_features, false);
 
                /* i is invalid at this point */
 
                i = tmp;
        }
 
+       _session->commit_reversible_command ();
 }
 
 void
@@ -286,3 +377,10 @@ RhythmFerret::set_session (Session* s)
        ArdourDialog::set_session (s);
        current_results.clear ();
 }
+
+void
+RhythmFerret::on_hide ()
+{
+       ArdourDialog::on_hide ();
+}
+