2 Copyright (C) 2008 Paul Davis
3 Author: Sampo Savolainen
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation; either version 2 of the License, or
8 (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software
17 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21 #include "plugin_eq_gui.h"
24 #include "ardour_ui.h"
25 #include "gui_thread.h"
26 #include "ardour/audio_buffer.h"
27 #include "ardour/data_type.h"
28 #include "ardour/chan_mapping.h"
29 #include "ardour/session.h"
31 #include <gtkmm/box.h>
32 #include <gtkmm/button.h>
33 #include <gtkmm/checkbutton.h>
40 using namespace ARDOUR;
42 PluginEqGui::PluginEqGui(boost::shared_ptr<ARDOUR::PluginInsert> pluginInsert)
47 , _signal_input_fft(0)
48 , _signal_output_fft(0)
49 , _plugin_insert(pluginInsert)
51 _signal_analysis_running = false;
52 _samplerate = ARDOUR_UI::instance()->the_session()->frame_rate();
54 _log_coeff = (1.0 - 2.0 * (1000.0/(_samplerate/2.0))) / powf(1000.0/(_samplerate/2.0), 2.0);
55 _log_max = log10f(1 + _log_coeff);
57 // Setup analysis drawing area
58 _analysis_scale_surface = 0;
60 _analysis_area = new Gtk::DrawingArea();
61 _analysis_width = 256.0;
62 _analysis_height = 256.0;
63 _analysis_area->set_size_request(_analysis_width, _analysis_height);
65 _analysis_area->signal_expose_event().connect( sigc::mem_fun (*this, &PluginEqGui::expose_analysis_area));
66 _analysis_area->signal_size_allocate().connect( sigc::mem_fun (*this, &PluginEqGui::resize_analysis_area));
69 dBScaleModel = Gtk::ListStore::create(dBColumns);
71 /* this grotty-looking cast allows compilation against gtkmm 2.24.0, which
72 added a new ComboBox constructor.
74 dBScaleCombo = new Gtk::ComboBox ((Glib::RefPtr<Gtk::TreeModel> &) dBScaleModel);
75 dBScaleCombo->set_title (_("dB scale"));
77 #define ADD_DB_ROW(MIN,MAX,STEP,NAME) \
79 Gtk::TreeModel::Row row = *(dBScaleModel->append()); \
80 row[dBColumns.dBMin] = (MIN); \
81 row[dBColumns.dBMax] = (MAX); \
82 row[dBColumns.dBStep] = (STEP); \
83 row[dBColumns.name] = NAME; \
86 ADD_DB_ROW( -6, +6, 1, "-6dB .. +6dB");
87 ADD_DB_ROW(-12, +12, 3, "-12dB .. +12dB");
88 ADD_DB_ROW(-24, +24, 5, "-24dB .. +24dB");
89 ADD_DB_ROW(-36, +36, 6, "-36dB .. +36dB");
90 ADD_DB_ROW(-64, +64,12, "-64dB .. +64dB");
94 dBScaleCombo -> pack_start(dBColumns.name);
95 dBScaleCombo -> set_active(1);
97 dBScaleCombo -> signal_changed().connect( sigc::mem_fun(*this, &PluginEqGui::change_dB_scale) );
99 Gtk::Label *dBComboLabel = new Gtk::Label (_("dB scale"));
101 Gtk::HBox *dBSelectBin = new Gtk::HBox(false, 5);
102 dBSelectBin->add( *manage(dBComboLabel));
103 dBSelectBin->add( *manage(dBScaleCombo));
106 _phase_button = new Gtk::CheckButton (_("Show phase"));
107 _phase_button->set_active(true);
108 _phase_button->signal_toggled().connect( sigc::mem_fun(*this, &PluginEqGui::redraw_scales));
111 attach( *manage(_analysis_area), 1, 3, 1, 2);
112 attach( *manage(dBSelectBin), 1, 2, 2, 3, Gtk::SHRINK, Gtk::SHRINK);
113 attach( *manage(_phase_button), 2, 3, 2, 3, Gtk::SHRINK, Gtk::SHRINK);
116 PluginEqGui::~PluginEqGui()
120 if (_analysis_scale_surface) {
121 cairo_surface_destroy (_analysis_scale_surface);
126 delete _signal_input_fft;
127 _signal_input_fft = 0;
128 delete _signal_output_fft;
129 _signal_output_fft = 0;
131 // all gui objects are *manage'd by the inherited Table object
135 PluginEqGui::start_listening ()
138 _plugin = _plugin_insert->get_impulse_analysis_plugin();
142 set_buffer_size(4096, 16384);
143 // Connect the realtime signal collection callback
144 _plugin_insert->AnalysisDataGathered.connect (analysis_connection, invalidator (*this), boost::bind (&PluginEqGui::signal_collect_callback, this, _1, _2), gui_context());
148 PluginEqGui::stop_listening ()
150 analysis_connection.disconnect ();
151 _plugin->deactivate ();
155 PluginEqGui::on_hide()
158 Gtk::Table::on_hide();
162 PluginEqGui::stop_updating()
164 if (_update_connection.connected()) {
165 _update_connection.disconnect();
170 PluginEqGui::start_updating()
172 if (!_update_connection.connected() && is_visible()) {
173 _update_connection = Glib::signal_timeout().connect( sigc::mem_fun(this, &PluginEqGui::timeout_callback), 250);
178 PluginEqGui::on_show()
180 Gtk::Table::on_show();
184 Gtk::Widget *toplevel = get_toplevel();
186 if (!_window_unmap_connection.connected()) {
187 _window_unmap_connection = toplevel->signal_unmap().connect( sigc::mem_fun(this, &PluginEqGui::stop_updating));
190 if (!_window_map_connection.connected()) {
191 _window_map_connection = toplevel->signal_map().connect( sigc::mem_fun(this, &PluginEqGui::start_updating));
197 PluginEqGui::change_dB_scale()
199 Gtk::TreeModel::iterator iter = dBScaleCombo -> get_active();
201 Gtk::TreeModel::Row row;
203 if(iter && (row = *iter)) {
204 _min_dB = row[dBColumns.dBMin];
205 _max_dB = row[dBColumns.dBMax];
206 _step_dB = row[dBColumns.dBStep];
214 PluginEqGui::redraw_scales()
217 if (_analysis_scale_surface) {
218 cairo_surface_destroy (_analysis_scale_surface);
219 _analysis_scale_surface = 0;
222 _analysis_area->queue_draw();
224 // TODO: Add graph legend!
228 PluginEqGui::set_buffer_size(uint32_t size, uint32_t signal_size)
230 if (_buffer_size == size && _signal_buffer_size == signal_size) {
234 GTKArdour::FFT *tmp1 = _impulse_fft;
235 GTKArdour::FFT *tmp2 = _signal_input_fft;
236 GTKArdour::FFT *tmp3 = _signal_output_fft;
239 _impulse_fft = new GTKArdour::FFT(size);
240 _signal_input_fft = new GTKArdour::FFT(signal_size);
241 _signal_output_fft = new GTKArdour::FFT(signal_size);
243 // Don't care about lost memory, we're screwed anyhow
245 _signal_input_fft = tmp2;
246 _signal_output_fft = tmp3;
255 _signal_buffer_size = signal_size;
257 ARDOUR::ChanCount count = ARDOUR::ChanCount::max (_plugin->get_info()->n_inputs, _plugin->get_info()->n_outputs);
259 for (ARDOUR::DataType::iterator i = ARDOUR::DataType::begin(); i != ARDOUR::DataType::end(); ++i) {
260 _bufferset.ensure_buffers (*i, count.get (*i), _buffer_size);
261 _collect_bufferset.ensure_buffers (*i, count.get (*i), _buffer_size);
264 _bufferset.set_count (count);
265 _collect_bufferset.set_count (count);
269 PluginEqGui::resize_analysis_area (Gtk::Allocation& size)
271 _analysis_width = (float)size.get_width();
272 _analysis_height = (float)size.get_height();
274 if (_analysis_scale_surface) {
275 cairo_surface_destroy (_analysis_scale_surface);
276 _analysis_scale_surface = 0;
281 PluginEqGui::timeout_callback()
283 if (!_signal_analysis_running) {
284 _signal_analysis_running = true;
285 _plugin_insert -> collect_signal_for_analysis(_signal_buffer_size);
287 run_impulse_analysis();
293 PluginEqGui::signal_collect_callback(ARDOUR::BufferSet *in, ARDOUR::BufferSet *out)
295 ENSURE_GUI_THREAD (*this, &PluginEqGui::signal_collect_callback, in, out)
297 _signal_input_fft ->reset();
298 _signal_output_fft->reset();
300 for (uint32_t i = 0; i < _plugin_insert->input_streams().n_audio(); ++i) {
301 _signal_input_fft ->analyze(in ->get_audio(i).data(), GTKArdour::FFT::HANN);
304 for (uint32_t i = 0; i < _plugin_insert->output_streams().n_audio(); ++i) {
305 _signal_output_fft->analyze(out->get_audio(i).data(), GTKArdour::FFT::HANN);
308 _signal_input_fft ->calculate();
309 _signal_output_fft->calculate();
311 _signal_analysis_running = false;
313 // This signals calls expose_analysis_area()
314 _analysis_area->queue_draw();
318 PluginEqGui::run_impulse_analysis()
320 /* Allocate some thread-local buffers so that Plugin::connect_and_run can use them */
321 ARDOUR_UI::instance()->get_process_buffers ();
323 uint32_t inputs = _plugin->get_info()->n_inputs.n_audio();
324 uint32_t outputs = _plugin->get_info()->n_outputs.n_audio();
326 // Create the impulse, can't use silence() because consecutive calls won't work
327 for (uint32_t i = 0; i < inputs; ++i) {
328 ARDOUR::AudioBuffer& buf = _bufferset.get_audio(i);
329 ARDOUR::Sample* d = buf.data();
330 memset(d, 0, sizeof(ARDOUR::Sample)*_buffer_size);
334 ARDOUR::ChanMapping in_map(_plugin->get_info()->n_inputs);
335 ARDOUR::ChanMapping out_map(_plugin->get_info()->n_outputs);
337 _plugin->connect_and_run(_bufferset, in_map, out_map, _buffer_size, 0);
338 framecnt_t f = _plugin->signal_latency ();
339 // Adding user_latency() could be interesting
341 // Gather all output, taking latency into account.
342 _impulse_fft->reset();
344 // Silence collect buffers to copy data to, can't use silence() because consecutive calls won't work
345 for (uint32_t i = 0; i < outputs; ++i) {
346 ARDOUR::AudioBuffer &buf = _collect_bufferset.get_audio(i);
347 ARDOUR::Sample *d = buf.data();
348 memset(d, 0, sizeof(ARDOUR::Sample)*_buffer_size);
352 //std::cerr << "0: no latency, copying full buffer, trivial.." << std::endl;
353 for (uint32_t i = 0; i < outputs; ++i) {
354 memcpy(_collect_bufferset.get_audio(i).data(),
355 _bufferset.get_audio(i).data(), _buffer_size * sizeof(float));
359 //std::cerr << (++C) << ": latency is " << f << " frames, doing split processing.." << std::endl;
360 framecnt_t target_offset = 0;
361 framecnt_t frames_left = _buffer_size; // refaktoroi
363 if (f >= _buffer_size) {
364 //std::cerr << (++C) << ": f (=" << f << ") is larger than buffer_size, still trying to reach the actual output" << std::endl;
365 // there is no data in this buffer regarding to the input!
368 // this buffer contains either the first, last or a whole bu the output of the impulse
369 // first part: offset is 0, so we copy to the start of _collect_bufferset
370 // we start at output offset "f"
371 // .. and copy "buffer size" - "f" - "offset" frames
373 framecnt_t length = _buffer_size - f - target_offset;
375 //std::cerr << (++C) << ": copying " << length << " frames to _collect_bufferset.get_audio(i)+" << target_offset << " from bufferset at offset " << f << std::endl;
376 for (uint32_t i = 0; i < outputs; ++i) {
377 memcpy(_collect_bufferset.get_audio(i).data(target_offset),
378 _bufferset.get_audio(i).data() + f,
379 length * sizeof(float));
382 target_offset += length;
383 frames_left -= length;
386 if (frames_left > 0) {
387 // Silence the buffers
388 for (uint32_t i = 0; i < inputs; ++i) {
389 ARDOUR::AudioBuffer &buf = _bufferset.get_audio(i);
390 ARDOUR::Sample *d = buf.data();
391 memset(d, 0, sizeof(ARDOUR::Sample)*_buffer_size);
394 in_map = ARDOUR::ChanMapping(_plugin->get_info()->n_inputs);
395 out_map = ARDOUR::ChanMapping(_plugin->get_info()->n_outputs);
396 _plugin->connect_and_run(_bufferset, in_map, out_map, _buffer_size, 0);
398 } while ( frames_left > 0);
403 for (uint32_t i = 0; i < outputs; ++i) {
404 _impulse_fft->analyze(_collect_bufferset.get_audio(i).data());
407 // normalize the output
408 _impulse_fft->calculate();
410 // This signals calls expose_analysis_area()
411 _analysis_area->queue_draw();
413 ARDOUR_UI::instance()->drop_process_buffers ();
417 PluginEqGui::expose_analysis_area(GdkEventExpose *)
419 redraw_analysis_area();
424 PluginEqGui::draw_analysis_scales(cairo_t *ref_cr)
426 // TODO: check whether we need rounding
427 _analysis_scale_surface = cairo_surface_create_similar(cairo_get_target(ref_cr),
432 cairo_t *cr = cairo_create (_analysis_scale_surface);
434 cairo_set_source_rgb(cr, 0.0, 0.0, 0.0);
435 cairo_rectangle(cr, 0.0, 0.0, _analysis_width, _analysis_height);
439 draw_scales_power(_analysis_area, cr);
440 if (_phase_button->get_active()) {
441 draw_scales_phase(_analysis_area, cr);
449 PluginEqGui::redraw_analysis_area()
453 cr = gdk_cairo_create(GDK_DRAWABLE(_analysis_area->get_window()->gobj()));
455 if (_analysis_scale_surface == 0) {
456 draw_analysis_scales(cr);
462 cairo_set_source_surface(cr, _analysis_scale_surface, 0.0, 0.0);
465 if (_phase_button->get_active()) {
466 plot_impulse_phase(_analysis_area, cr);
468 plot_impulse_amplitude(_analysis_area, cr);
470 // TODO: make this optional
471 plot_signal_amplitude_difference(_analysis_area, cr);
478 #define PHASE_PROPORTION 0.5
481 PluginEqGui::draw_scales_phase(Gtk::Widget */*w*/, cairo_t *cr)
484 cairo_font_extents_t extents;
485 cairo_font_extents(cr, &extents);
488 cairo_text_extents_t t_ext;
490 for (uint32_t i = 0; i < 3; i++) {
492 y = _analysis_height/2.0 - (float)i*(_analysis_height/8.0)*PHASE_PROPORTION;
494 cairo_set_source_rgb(cr, .8, .9, 0.2);
496 snprintf(buf,256, "0\u00b0");
498 snprintf(buf,256, "%d\u00b0", (i * 45));
500 cairo_text_extents(cr, buf, &t_ext);
501 cairo_move_to(cr, _analysis_width - t_ext.width - t_ext.x_bearing - 2.0, y - extents.descent);
502 cairo_show_text(cr, buf);
508 cairo_set_source_rgba(cr, .8, .9, 0.2, 0.6/(float)i);
509 cairo_move_to(cr, 0.0, y);
510 cairo_line_to(cr, _analysis_width, y);
513 y = _analysis_height/2.0 + (float)i*(_analysis_height/8.0)*PHASE_PROPORTION;
516 snprintf(buf,256, "-%d\u00b0", (i * 45));
517 cairo_set_source_rgb(cr, .8, .9, 0.2);
518 cairo_text_extents(cr, buf, &t_ext);
519 cairo_move_to(cr, _analysis_width - t_ext.width - t_ext.x_bearing - 2.0, y - extents.descent);
520 cairo_show_text(cr, buf);
523 cairo_set_source_rgba(cr, .8, .9, 0.2, 0.6/(float)i);
524 cairo_move_to(cr, 0.0, y);
525 cairo_line_to(cr, _analysis_width, y);
527 cairo_set_line_width (cr, 0.25 + 1.0/(float)(i+1));
533 PluginEqGui::plot_impulse_phase(Gtk::Widget *w, cairo_t *cr)
541 // float width = w->get_width();
542 float height = w->get_height();
544 cairo_set_source_rgba(cr, 0.95, 0.3, 0.2, 1.0);
545 for (uint32_t i = 0; i < _impulse_fft->bins()-1; i++) {
546 // x coordinate of bin i
547 x = log10f(1.0 + (float)i / (float)_impulse_fft->bins() * _log_coeff) / _log_max;
548 x *= _analysis_width;
550 y = _analysis_height/2.0 - (_impulse_fft->phase_at_bin(i)/M_PI)*(_analysis_height/2.0)*PHASE_PROPORTION;
553 cairo_move_to(cr, x, y);
557 } else if (rint(x) > prevX || i == _impulse_fft->bins()-1 ) {
558 avgY = avgY/(float)avgNum;
559 if (avgY > (height * 10.0) ) avgY = height * 10.0;
560 if (avgY < (-height * 10.0) ) avgY = -height * 10.0;
561 cairo_line_to(cr, prevX, avgY);
562 //cairo_line_to(cr, prevX, avgY/(float)avgNum);
574 cairo_set_line_width (cr, 2.0);
579 PluginEqGui::draw_scales_power(Gtk::Widget */*w*/, cairo_t *cr)
581 if (_impulse_fft == 0) {
585 static float scales[] = { 30.0, 70.0, 125.0, 250.0, 500.0, 1000.0, 2000.0, 5000.0, 10000.0, 15000.0, 20000.0, -1.0 };
586 float divisor = _samplerate / 2.0 / _impulse_fft->bins();
589 cairo_set_line_width (cr, 1.5);
590 cairo_set_font_size(cr, 9);
592 cairo_font_extents_t extents;
593 cairo_font_extents(cr, &extents);
594 // float fontXOffset = extents.descent + 1.0;
598 for (uint32_t i = 0; scales[i] != -1.0; ++i) {
599 float bin = scales[i] / divisor;
601 x = log10f(1.0 + bin / (float)_impulse_fft->bins() * _log_coeff) / _log_max;
602 x *= _analysis_width;
604 if (scales[i] < 1000.0) {
605 snprintf(buf, 256, "%0.0f", scales[i]);
607 snprintf(buf, 256, "%0.0fk", scales[i]/1000.0);
610 cairo_set_source_rgb(cr, 0.4, 0.4, 0.4);
612 //cairo_move_to(cr, x + fontXOffset, 3.0);
613 cairo_move_to(cr, x - extents.height, 3.0);
615 cairo_rotate(cr, M_PI / 2.0);
616 cairo_show_text(cr, buf);
617 cairo_rotate(cr, -M_PI / 2.0);
620 cairo_set_source_rgb(cr, 0.3, 0.3, 0.3);
621 cairo_move_to(cr, x, _analysis_height);
622 cairo_line_to(cr, x, 0.0);
628 //double dashes[] = { 1.0, 3.0, 4.5, 3.0 };
629 double dashes[] = { 3.0, 5.0 };
631 for (float dB = 0.0; dB < _max_dB; dB += _step_dB ) {
632 snprintf(buf, 256, "+%0.0f", dB );
634 y = ( _max_dB - dB) / ( _max_dB - _min_dB );
635 //std::cerr << " y = " << y << std::endl;
636 y *= _analysis_height;
639 cairo_set_source_rgb(cr, 0.4, 0.4, 0.4);
640 cairo_move_to(cr, 1.0, y + extents.height + 1.0);
641 cairo_show_text(cr, buf);
645 cairo_set_source_rgb(cr, 0.2, 0.2, 0.2);
646 cairo_move_to(cr, 0, y);
647 cairo_line_to(cr, _analysis_width, y);
651 cairo_set_dash(cr, dashes, 2, 0.0);
657 for (float dB = - _step_dB; dB > _min_dB; dB -= _step_dB ) {
658 snprintf(buf, 256, "%0.0f", dB );
660 y = ( _max_dB - dB) / ( _max_dB - _min_dB );
661 y *= _analysis_height;
663 cairo_set_source_rgb(cr, 0.4, 0.4, 0.4);
664 cairo_move_to(cr, 1.0, y - extents.descent - 1.0);
665 cairo_show_text(cr, buf);
668 cairo_set_source_rgb(cr, 0.2, 0.2, 0.2);
669 cairo_move_to(cr, 0, y);
670 cairo_line_to(cr, _analysis_width, y);
674 cairo_set_dash(cr, 0, 0, 0.0);
681 return 10.0 * log10f(a);
685 PluginEqGui::plot_impulse_amplitude(Gtk::Widget *w, cairo_t *cr)
692 // float width = w->get_width();
693 float height = w->get_height();
695 cairo_set_source_rgb(cr, 1.0, 1.0, 1.0);
696 cairo_set_line_width (cr, 2.5);
698 for (uint32_t i = 0; i < _impulse_fft->bins()-1; i++) {
699 // x coordinate of bin i
700 x = log10f(1.0 + (float)i / (float)_impulse_fft->bins() * _log_coeff) / _log_max;
701 x *= _analysis_width;
703 float yCoeff = ( power_to_dB(_impulse_fft->power_at_bin(i)) - _min_dB) / (_max_dB - _min_dB);
705 y = _analysis_height - _analysis_height*yCoeff;
708 cairo_move_to(cr, x, y);
712 } else if (rint(x) > prevX || i == _impulse_fft->bins()-1 ) {
713 avgY = avgY/(float)avgNum;
714 if (avgY > (height * 10.0) ) avgY = height * 10.0;
715 if (avgY < (-height * 10.0) ) avgY = -height * 10.0;
716 cairo_line_to(cr, prevX, avgY);
717 //cairo_line_to(cr, prevX, avgY/(float)avgNum);
733 PluginEqGui::plot_signal_amplitude_difference(Gtk::Widget *w, cairo_t *cr)
741 // float width = w->get_width();
742 float height = w->get_height();
744 cairo_set_source_rgb(cr, 0.0, 1.0, 0.0);
745 cairo_set_line_width (cr, 2.5);
747 for (uint32_t i = 0; i < _signal_input_fft->bins()-1; i++) {
748 // x coordinate of bin i
749 x = log10f(1.0 + (float)i / (float)_signal_input_fft->bins() * _log_coeff) / _log_max;
750 x *= _analysis_width;
752 float power_out = power_to_dB(_signal_output_fft->power_at_bin(i));
753 float power_in = power_to_dB(_signal_input_fft ->power_at_bin(i));
754 float power = power_out - power_in;
758 double p = 10.0 * log10( 1.0 + (double)_signal_output_fft->power_at_bin(i) - (double)
759 - _signal_input_fft ->power_at_bin(i));
761 float power = (float)p;
763 if ( (i % 1000) == 0) {
764 std::cerr << i << ": " << power << std::endl;
768 if (std::isinf(power)) {
770 power = _min_dB - 1.0;
772 power = _max_dB - 1.0;
774 } else if (std::isnan(power)) {
775 power = _min_dB - 1.0;
778 float yCoeff = ( power - _min_dB) / (_max_dB - _min_dB);
780 y = _analysis_height - _analysis_height*yCoeff;
783 cairo_move_to(cr, x, y);
787 } else if (rint(x) > prevX || i == _impulse_fft->bins()-1 ) {
788 avgY = avgY/(float)avgNum;
789 if (avgY > (height * 10.0) ) avgY = height * 10.0;
790 if (avgY < (-height * 10.0) ) avgY = -height * 10.0;
791 cairo_line_to(cr, prevX, avgY);