2 Copyright (C) 2012 Paul Davis
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 2 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20 #include <gtkmm/stock.h>
21 #include <gtkmm2ext/utils.h>
23 #include "pbd/memento_command.h"
24 #include "pbd/convert.h"
26 #include "ardour/audioregion.h"
27 #include "ardour/onset_detector.h"
28 #include "ardour/session.h"
29 #include "ardour/transient_detector.h"
31 #include "rhythm_ferret.h"
32 #include "audio_region_view.h"
34 #include "time_axis_view.h"
42 using namespace ARDOUR;
44 /* order of these must match the AnalysisMode enums
47 static const gchar * _analysis_mode_strings[] = {
48 N_("Percussive Onset"),
53 static const gchar * _onset_function_strings[] = {
55 N_("Spectral Difference"),
56 N_("High-Frequency Content"),
58 N_("Phase Deviation"),
59 N_("Kullback-Liebler"),
60 N_("Modified Kullback-Liebler"),
67 static const gchar * _operation_strings[] = {
69 #if 0 // these don't do what a user expects
71 N_("Conform regions"),
76 RhythmFerret::RhythmFerret (Editor& e)
77 : ArdourDialog (_("Rhythm Ferret"))
79 , detection_threshold_adjustment (-35, -80, -6, 1, 6)
80 , detection_threshold_scale (detection_threshold_adjustment)
81 , sensitivity_adjustment (40, 0, 100, 1, 10)
82 , sensitivity_scale (sensitivity_adjustment)
83 , analyze_button (_("Analyze"))
84 , peak_picker_threshold_adjustment (0.3, 0.0, 1.0, 0.01, 0.1)
85 , peak_picker_threshold_scale (peak_picker_threshold_adjustment)
86 , silence_threshold_adjustment (-90.0, -120.0, 0.0, 1, 10)
87 , silence_threshold_scale (silence_threshold_adjustment)
89 , minioi_adjustment (4, 0, 40, 1, 5)
90 , minioi_scale (minioi_adjustment)
92 , trigger_gap_adjustment (3, 0, 100, 1, 10)
93 , trigger_gap_spinner (trigger_gap_adjustment)
94 , action_button (Stock::APPLY)
96 operation_strings = I18N (_operation_strings);
97 Gtkmm2ext::set_popdown_strings (operation_selector, operation_strings);
98 operation_selector.set_active (0);
100 analysis_mode_strings = I18N (_analysis_mode_strings);
101 Gtkmm2ext::set_popdown_strings (analysis_mode_selector, analysis_mode_strings);
102 analysis_mode_selector.set_active_text (analysis_mode_strings.front());
103 analysis_mode_selector.signal_changed().connect (sigc::mem_fun (*this, &RhythmFerret::analysis_mode_changed));
105 onset_function_strings = I18N (_onset_function_strings);
106 Gtkmm2ext::set_popdown_strings (onset_detection_function_selector, onset_function_strings);
107 /* Onset plugin uses complex domain as default function
108 XXX there should be a non-hacky way to set this
110 onset_detection_function_selector.set_active_text (onset_function_strings[3]);
111 detection_threshold_scale.set_digits (3);
113 Table* t = manage (new Table (7, 3));
114 t->set_spacings (12);
118 t->attach (*manage (new Label (_("Mode"), 1, 0.5)), 0, 1, n, n + 1, FILL);
119 t->attach (analysis_mode_selector, 1, 2, n, n + 1, FILL);
122 t->attach (*manage (new Label (_("Detection function"), 1, 0.5)), 0, 1, n, n + 1, FILL);
123 t->attach (onset_detection_function_selector, 1, 2, n, n + 1, FILL);
126 t->attach (*manage (new Label (_("Trigger gap (postproc)"), 1, 0.5)), 0, 1, n, n + 1, FILL);
127 t->attach (trigger_gap_spinner, 1, 2, n, n + 1, FILL);
128 t->attach (*manage (new Label (_("ms"))), 2, 3, n, n + 1, FILL);
131 t->attach (*manage (new Label (_("Peak threshold"), 1, 0.5)), 0, 1, n, n + 1, FILL);
132 t->attach (peak_picker_threshold_scale, 1, 2, n, n + 1, FILL);
135 t->attach (*manage (new Label (_("Silence threshold"), 1, 0.5)), 0, 1, n, n + 1, FILL);
136 t->attach (silence_threshold_scale, 1, 2, n, n + 1, FILL);
137 t->attach (*manage (new Label (_("dB"))), 2, 3, n, n + 1, FILL);
141 t->attach (*manage (new Label (_("Min Inter-Onset Time"), 1, 0.5)), 0, 1, n, n + 1, FILL);
142 t->attach (minioi_scale, 1, 2, n, n + 1, FILL);
143 t->attach (*manage (new Label (_("ms"))), 2, 3, n, n + 1, FILL);
148 t->attach (*manage (new Label (_("Sensitivity"), 1, 0.5)), 0, 1, n, n + 1, FILL);
149 t->attach (sensitivity_scale, 1, 2, n, n + 1, FILL);
152 t->attach (*manage (new Label (_("Cut Pos Threshold"), 1, 0.5)), 0, 1, n, n + 1, FILL);
153 t->attach (detection_threshold_scale, 1, 2, n, n + 1, FILL);
154 t->attach (*manage (new Label (_("dB"))), 2, 3, n, n + 1, FILL);
157 t->attach (*manage (new Label (_("Operation"), 1, 0.5)), 0, 1, n, n + 1, FILL);
158 t->attach (operation_selector, 1, 2, n, n + 1, FILL);
161 analyze_button.signal_clicked().connect (sigc::mem_fun (*this, &RhythmFerret::run_analysis));
162 action_button.signal_clicked().connect (sigc::mem_fun (*this, &RhythmFerret::do_action));
164 get_vbox()->set_border_width (6);
165 get_vbox()->set_spacing (6);
166 get_vbox()->pack_start (*t);
168 add_action_widget (analyze_button, 1);
169 add_action_widget (action_button, 0);
172 analysis_mode_changed ();
176 RhythmFerret::analysis_mode_changed ()
178 bool const perc = get_analysis_mode() == PercussionOnset;
180 // would be nice to actually hide/show the rows.
181 detection_threshold_scale.set_sensitive (perc);
182 sensitivity_scale.set_sensitive (perc);
183 trigger_gap_spinner.set_sensitive (!perc);
184 onset_detection_function_selector.set_sensitive (!perc);
185 peak_picker_threshold_scale.set_sensitive (!perc);
186 silence_threshold_scale.set_sensitive (!perc);
188 minioi_scale.set_sensitive (!perc);
192 RhythmFerret::AnalysisMode
193 RhythmFerret::get_analysis_mode () const
195 string str = analysis_mode_selector.get_active_text ();
197 if (str == analysis_mode_strings[(int) NoteOnset]) {
201 return PercussionOnset;
205 RhythmFerret::get_action () const
207 if (operation_selector.get_active_row_number() == 1) {
208 return SnapRegionsToGrid;
209 } else if (operation_selector.get_active_row_number() == 2) {
210 return ConformRegion;
217 RhythmFerret::run_analysis ()
225 regions_with_transients = editor.get_selection().regions;
227 current_results.clear ();
229 if (regions_with_transients.empty()) {
233 for (RegionSelection::iterator i = regions_with_transients.begin(); i != regions_with_transients.end(); ++i) {
235 boost::shared_ptr<Readable> rd = boost::static_pointer_cast<AudioRegion> ((*i)->region());
237 switch (get_analysis_mode()) {
238 case PercussionOnset:
239 run_percussion_onset_analysis (rd, (*i)->region()->position(), current_results);
242 run_note_onset_analysis (rd, (*i)->region()->position(), current_results);
248 (*i)->region()->set_onsets (current_results);
249 current_results.clear();
254 RhythmFerret::run_percussion_onset_analysis (boost::shared_ptr<Readable> readable, frameoffset_t /*offset*/, AnalysisFeatureList& results)
256 TransientDetector t (_session->frame_rate());
258 for (uint32_t i = 0; i < readable->n_channels(); ++i) {
260 AnalysisFeatureList these_results;
263 float dB = detection_threshold_adjustment.get_value();
264 float coeff = dB > -80.0f ? pow (10.0f, dB * 0.05f) : 0.0f;
265 t.set_threshold (coeff);
266 t.set_sensitivity (sensitivity_adjustment.get_value());
268 if (t.run ("", readable.get(), i, these_results)) {
274 results.insert (results.end(), these_results.begin(), these_results.end());
275 these_results.clear ();
277 t.update_positions (readable.get(), i, results);
284 RhythmFerret::get_note_onset_function ()
286 string txt = onset_detection_function_selector.get_active_text();
288 for (int n = 0; _onset_function_strings[n]; ++n) {
289 /* compare translated versions */
290 if (txt == onset_function_strings[n]) {
295 fatal << string_compose (_("programming error: %1 (%2)"), X_("illegal note onset function string"), txt)
298 abort(); /*NOTREACHED*/
303 RhythmFerret::run_note_onset_analysis (boost::shared_ptr<Readable> readable, frameoffset_t /*offset*/, AnalysisFeatureList& results)
306 OnsetDetector t (_session->frame_rate());
308 for (uint32_t i = 0; i < readable->n_channels(); ++i) {
310 AnalysisFeatureList these_results;
312 t.set_function (get_note_onset_function());
313 t.set_silence_threshold (silence_threshold_adjustment.get_value());
314 t.set_peak_threshold (peak_picker_threshold_adjustment.get_value());
316 t.set_minioi (minioi_adjustment.get_value());
319 // aubio-vamp only picks up new settings on reset.
322 if (t.run ("", readable.get(), i, these_results)) {
328 results.insert (results.end(), these_results.begin(), these_results.end());
329 these_results.clear ();
332 } catch (failed_constructor& err) {
333 error << "Could not load note onset detection plugin" << endmsg;
337 if (!results.empty()) {
338 OnsetDetector::cleanup_onsets (results, _session->frame_rate(), trigger_gap_adjustment.get_value());
345 RhythmFerret::do_action ()
351 switch (get_action()) {
355 case SnapRegionsToGrid:
356 // split first, select all.. ?!
357 editor.snap_regions_to_grid();
360 editor.close_region_gaps();
368 RhythmFerret::do_split_action ()
370 /* XXX: this is quite a special-case; (currently) the only operation which is
371 performed on the selection only (without entered_regionview or the edit point
374 RegionSelection regions = editor.selection->regions;
376 if (regions.empty()) {
380 editor.EditorFreeze(); /* Emit signal */
382 editor.begin_reversible_command (_("split regions (rhythm ferret)"));
384 /* Merge the transient positions for regions in consideration */
385 AnalysisFeatureList merged_features;
387 for (RegionSelection::iterator i = regions.begin(); i != regions.end(); ++i) {
389 AnalysisFeatureList features;
390 (*i)->region()->transients(features);
392 merged_features.insert (merged_features.end(), features.begin(), features.end());
395 merged_features.sort();
396 merged_features.unique();
398 for (RegionSelection::iterator i = regions.begin(); i != regions.end(); ) {
400 RegionSelection::iterator tmp;
405 editor.split_region_at_points ((*i)->region(), merged_features, false, false);
407 /* i is invalid at this point */
411 editor.commit_reversible_command ();
413 editor.EditorThaw(); /* Emit signal */
417 RhythmFerret::set_session (Session* s)
419 ArdourDialog::set_session (s);
420 current_results.clear ();
424 RhythmFerret::on_hide ()
426 ArdourDialog::on_hide ();
430 /* Clear any transients that we have added */
432 RhythmFerret::clear_transients ()
434 current_results.clear ();
436 for (RegionSelection::iterator i = regions_with_transients.begin(); i != regions_with_transients.end(); ++i) {
437 (*i)->region()->set_onsets (current_results);
440 regions_with_transients.clear ();