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.
23 /* isinf() & isnan() are C99 standards, which older MSVC doesn't provide */
24 #define isinf(val) !((bool)_finite((double)val))
25 #define isnan(val) (bool)_isnan((double)val)
28 #include "plugin_eq_gui.h"
31 #include "ardour_ui.h"
32 #include "gui_thread.h"
33 #include "ardour/audio_buffer.h"
34 #include "ardour/data_type.h"
35 #include "ardour/chan_mapping.h"
36 #include "ardour/session.h"
38 #include <gtkmm/box.h>
39 #include <gtkmm/button.h>
40 #include <gtkmm/checkbutton.h>
47 using namespace ARDOUR;
49 PluginEqGui::PluginEqGui(boost::shared_ptr<ARDOUR::PluginInsert> pluginInsert)
54 , _signal_input_fft(0)
55 , _signal_output_fft(0)
56 , _plugin_insert(pluginInsert)
58 _signal_analysis_running = false;
59 _samplerate = ARDOUR_UI::instance()->the_session()->frame_rate();
61 _log_coeff = (1.0 - 2.0 * (1000.0/(_samplerate/2.0))) / powf(1000.0/(_samplerate/2.0), 2.0);
62 _log_max = log10f(1 + _log_coeff);
64 // Setup analysis drawing area
65 _analysis_scale_surface = 0;
67 _analysis_area = new Gtk::DrawingArea();
68 _analysis_width = 256.0;
69 _analysis_height = 256.0;
70 _analysis_area->set_size_request(_analysis_width, _analysis_height);
72 _analysis_area->signal_expose_event().connect( sigc::mem_fun (*this, &PluginEqGui::expose_analysis_area));
73 _analysis_area->signal_size_allocate().connect( sigc::mem_fun (*this, &PluginEqGui::resize_analysis_area));
76 dBScaleModel = Gtk::ListStore::create(dBColumns);
78 /* this grotty-looking cast allows compilation against gtkmm 2.24.0, which
79 added a new ComboBox constructor.
81 dBScaleCombo = new Gtk::ComboBox ((Glib::RefPtr<Gtk::TreeModel> &) dBScaleModel);
82 dBScaleCombo->set_title (_("dB scale"));
84 #define ADD_DB_ROW(MIN,MAX,STEP,NAME) \
86 Gtk::TreeModel::Row row = *(dBScaleModel->append()); \
87 row[dBColumns.dBMin] = (MIN); \
88 row[dBColumns.dBMax] = (MAX); \
89 row[dBColumns.dBStep] = (STEP); \
90 row[dBColumns.name] = NAME; \
93 ADD_DB_ROW( -6, +6, 1, "-6dB .. +6dB");
94 ADD_DB_ROW(-12, +12, 3, "-12dB .. +12dB");
95 ADD_DB_ROW(-24, +24, 5, "-24dB .. +24dB");
96 ADD_DB_ROW(-36, +36, 6, "-36dB .. +36dB");
97 ADD_DB_ROW(-64, +64,12, "-64dB .. +64dB");
101 dBScaleCombo -> pack_start(dBColumns.name);
102 dBScaleCombo -> set_active(1);
104 dBScaleCombo -> signal_changed().connect( sigc::mem_fun(*this, &PluginEqGui::change_dB_scale) );
106 Gtk::Label *dBComboLabel = new Gtk::Label (_("dB scale"));
108 Gtk::HBox *dBSelectBin = new Gtk::HBox(false, 5);
109 dBSelectBin->add( *manage(dBComboLabel));
110 dBSelectBin->add( *manage(dBScaleCombo));
113 _phase_button = new Gtk::CheckButton (_("Show phase"));
114 _phase_button->set_active(true);
115 _phase_button->signal_toggled().connect( sigc::mem_fun(*this, &PluginEqGui::redraw_scales));
118 attach( *manage(_analysis_area), 1, 3, 1, 2);
119 attach( *manage(dBSelectBin), 1, 2, 2, 3, Gtk::SHRINK, Gtk::SHRINK);
120 attach( *manage(_phase_button), 2, 3, 2, 3, Gtk::SHRINK, Gtk::SHRINK);
123 PluginEqGui::~PluginEqGui()
127 if (_analysis_scale_surface) {
128 cairo_surface_destroy (_analysis_scale_surface);
133 delete _signal_input_fft;
134 _signal_input_fft = 0;
135 delete _signal_output_fft;
136 _signal_output_fft = 0;
138 // all gui objects are *manage'd by the inherited Table object
142 PluginEqGui::start_listening ()
145 _plugin = _plugin_insert->get_impulse_analysis_plugin();
149 set_buffer_size(4096, 16384);
150 // Connect the realtime signal collection callback
151 _plugin_insert->AnalysisDataGathered.connect (analysis_connection, invalidator (*this), boost::bind (&PluginEqGui::signal_collect_callback, this, _1, _2), gui_context());
155 PluginEqGui::stop_listening ()
157 analysis_connection.disconnect ();
158 _plugin->deactivate ();
162 PluginEqGui::on_hide()
165 Gtk::Table::on_hide();
169 PluginEqGui::stop_updating()
171 if (_update_connection.connected()) {
172 _update_connection.disconnect();
177 PluginEqGui::start_updating()
179 if (!_update_connection.connected() && is_visible()) {
180 _update_connection = Glib::signal_timeout().connect( sigc::mem_fun(this, &PluginEqGui::timeout_callback), 250);
185 PluginEqGui::on_show()
187 Gtk::Table::on_show();
191 Gtk::Widget *toplevel = get_toplevel();
193 if (!_window_unmap_connection.connected()) {
194 _window_unmap_connection = toplevel->signal_unmap().connect( sigc::mem_fun(this, &PluginEqGui::stop_updating));
197 if (!_window_map_connection.connected()) {
198 _window_map_connection = toplevel->signal_map().connect( sigc::mem_fun(this, &PluginEqGui::start_updating));
204 PluginEqGui::change_dB_scale()
206 Gtk::TreeModel::iterator iter = dBScaleCombo -> get_active();
208 Gtk::TreeModel::Row row;
210 if(iter && (row = *iter)) {
211 _min_dB = row[dBColumns.dBMin];
212 _max_dB = row[dBColumns.dBMax];
213 _step_dB = row[dBColumns.dBStep];
221 PluginEqGui::redraw_scales()
224 if (_analysis_scale_surface) {
225 cairo_surface_destroy (_analysis_scale_surface);
226 _analysis_scale_surface = 0;
229 _analysis_area->queue_draw();
231 // TODO: Add graph legend!
235 PluginEqGui::set_buffer_size(uint32_t size, uint32_t signal_size)
237 if (_buffer_size == size && _signal_buffer_size == signal_size) {
241 GTKArdour::FFT *tmp1 = _impulse_fft;
242 GTKArdour::FFT *tmp2 = _signal_input_fft;
243 GTKArdour::FFT *tmp3 = _signal_output_fft;
246 _impulse_fft = new GTKArdour::FFT(size);
247 _signal_input_fft = new GTKArdour::FFT(signal_size);
248 _signal_output_fft = new GTKArdour::FFT(signal_size);
250 // Don't care about lost memory, we're screwed anyhow
252 _signal_input_fft = tmp2;
253 _signal_output_fft = tmp3;
262 _signal_buffer_size = signal_size;
264 ARDOUR::ChanCount count = ARDOUR::ChanCount::max (_plugin->get_info()->n_inputs, _plugin->get_info()->n_outputs);
266 for (ARDOUR::DataType::iterator i = ARDOUR::DataType::begin(); i != ARDOUR::DataType::end(); ++i) {
267 _bufferset.ensure_buffers (*i, count.get (*i), _buffer_size);
268 _collect_bufferset.ensure_buffers (*i, count.get (*i), _buffer_size);
271 _bufferset.set_count (count);
272 _collect_bufferset.set_count (count);
276 PluginEqGui::resize_analysis_area (Gtk::Allocation& size)
278 _analysis_width = (float)size.get_width();
279 _analysis_height = (float)size.get_height();
281 if (_analysis_scale_surface) {
282 cairo_surface_destroy (_analysis_scale_surface);
283 _analysis_scale_surface = 0;
288 PluginEqGui::timeout_callback()
290 if (!_signal_analysis_running) {
291 _signal_analysis_running = true;
292 _plugin_insert -> collect_signal_for_analysis(_signal_buffer_size);
294 run_impulse_analysis();
300 PluginEqGui::signal_collect_callback(ARDOUR::BufferSet *in, ARDOUR::BufferSet *out)
302 ENSURE_GUI_THREAD (*this, &PluginEqGui::signal_collect_callback, in, out)
304 _signal_input_fft ->reset();
305 _signal_output_fft->reset();
307 for (uint32_t i = 0; i < _plugin_insert->input_streams().n_audio(); ++i) {
308 _signal_input_fft ->analyze(in ->get_audio(i).data(), GTKArdour::FFT::HANN);
311 for (uint32_t i = 0; i < _plugin_insert->output_streams().n_audio(); ++i) {
312 _signal_output_fft->analyze(out->get_audio(i).data(), GTKArdour::FFT::HANN);
315 _signal_input_fft ->calculate();
316 _signal_output_fft->calculate();
318 _signal_analysis_running = false;
320 // This signals calls expose_analysis_area()
321 _analysis_area->queue_draw();
325 PluginEqGui::run_impulse_analysis()
327 /* Allocate some thread-local buffers so that Plugin::connect_and_run can use them */
328 ARDOUR_UI::instance()->get_process_buffers ();
330 uint32_t inputs = _plugin->get_info()->n_inputs.n_audio();
331 uint32_t outputs = _plugin->get_info()->n_outputs.n_audio();
333 // Create the impulse, can't use silence() because consecutive calls won't work
334 for (uint32_t i = 0; i < inputs; ++i) {
335 ARDOUR::AudioBuffer& buf = _bufferset.get_audio(i);
336 ARDOUR::Sample* d = buf.data();
337 memset(d, 0, sizeof(ARDOUR::Sample)*_buffer_size);
341 ARDOUR::ChanMapping in_map(_plugin->get_info()->n_inputs);
342 ARDOUR::ChanMapping out_map(_plugin->get_info()->n_outputs);
344 _plugin->connect_and_run(_bufferset, in_map, out_map, _buffer_size, 0);
345 framecnt_t f = _plugin->signal_latency ();
346 // Adding user_latency() could be interesting
348 // Gather all output, taking latency into account.
349 _impulse_fft->reset();
351 // Silence collect buffers to copy data to, can't use silence() because consecutive calls won't work
352 for (uint32_t i = 0; i < outputs; ++i) {
353 ARDOUR::AudioBuffer &buf = _collect_bufferset.get_audio(i);
354 ARDOUR::Sample *d = buf.data();
355 memset(d, 0, sizeof(ARDOUR::Sample)*_buffer_size);
359 //std::cerr << "0: no latency, copying full buffer, trivial.." << std::endl;
360 for (uint32_t i = 0; i < outputs; ++i) {
361 memcpy(_collect_bufferset.get_audio(i).data(),
362 _bufferset.get_audio(i).data(), _buffer_size * sizeof(float));
366 //std::cerr << (++C) << ": latency is " << f << " frames, doing split processing.." << std::endl;
367 framecnt_t target_offset = 0;
368 framecnt_t frames_left = _buffer_size; // refaktoroi
370 if (f >= _buffer_size) {
371 //std::cerr << (++C) << ": f (=" << f << ") is larger than buffer_size, still trying to reach the actual output" << std::endl;
372 // there is no data in this buffer regarding to the input!
375 // this buffer contains either the first, last or a whole bu the output of the impulse
376 // first part: offset is 0, so we copy to the start of _collect_bufferset
377 // we start at output offset "f"
378 // .. and copy "buffer size" - "f" - "offset" frames
380 framecnt_t length = _buffer_size - f - target_offset;
382 //std::cerr << (++C) << ": copying " << length << " frames to _collect_bufferset.get_audio(i)+" << target_offset << " from bufferset at offset " << f << std::endl;
383 for (uint32_t i = 0; i < outputs; ++i) {
384 memcpy(_collect_bufferset.get_audio(i).data(target_offset),
385 _bufferset.get_audio(i).data() + f,
386 length * sizeof(float));
389 target_offset += length;
390 frames_left -= length;
393 if (frames_left > 0) {
394 // Silence the buffers
395 for (uint32_t i = 0; i < inputs; ++i) {
396 ARDOUR::AudioBuffer &buf = _bufferset.get_audio(i);
397 ARDOUR::Sample *d = buf.data();
398 memset(d, 0, sizeof(ARDOUR::Sample)*_buffer_size);
401 in_map = ARDOUR::ChanMapping(_plugin->get_info()->n_inputs);
402 out_map = ARDOUR::ChanMapping(_plugin->get_info()->n_outputs);
403 _plugin->connect_and_run(_bufferset, in_map, out_map, _buffer_size, 0);
405 } while ( frames_left > 0);
410 for (uint32_t i = 0; i < outputs; ++i) {
411 _impulse_fft->analyze(_collect_bufferset.get_audio(i).data());
414 // normalize the output
415 _impulse_fft->calculate();
417 // This signals calls expose_analysis_area()
418 _analysis_area->queue_draw();
420 ARDOUR_UI::instance()->drop_process_buffers ();
424 PluginEqGui::expose_analysis_area(GdkEventExpose *)
426 redraw_analysis_area();
431 PluginEqGui::draw_analysis_scales(cairo_t *ref_cr)
433 // TODO: check whether we need rounding
434 _analysis_scale_surface = cairo_surface_create_similar(cairo_get_target(ref_cr),
439 cairo_t *cr = cairo_create (_analysis_scale_surface);
441 cairo_set_source_rgb(cr, 0.0, 0.0, 0.0);
442 cairo_rectangle(cr, 0.0, 0.0, _analysis_width, _analysis_height);
446 draw_scales_power(_analysis_area, cr);
447 if (_phase_button->get_active()) {
448 draw_scales_phase(_analysis_area, cr);
456 PluginEqGui::redraw_analysis_area()
460 cr = gdk_cairo_create(GDK_DRAWABLE(_analysis_area->get_window()->gobj()));
462 if (_analysis_scale_surface == 0) {
463 draw_analysis_scales(cr);
469 cairo_set_source_surface(cr, _analysis_scale_surface, 0.0, 0.0);
472 if (_phase_button->get_active()) {
473 plot_impulse_phase(_analysis_area, cr);
475 plot_impulse_amplitude(_analysis_area, cr);
477 // TODO: make this optional
478 plot_signal_amplitude_difference(_analysis_area, cr);
485 #define PHASE_PROPORTION 0.5
488 PluginEqGui::draw_scales_phase(Gtk::Widget */*w*/, cairo_t *cr)
491 cairo_font_extents_t extents;
492 cairo_font_extents(cr, &extents);
495 cairo_text_extents_t t_ext;
497 for (uint32_t i = 0; i < 3; i++) {
499 y = _analysis_height/2.0 - (float)i*(_analysis_height/8.0)*PHASE_PROPORTION;
501 cairo_set_source_rgb(cr, .8, .9, 0.2);
503 snprintf(buf,256, "0\u00b0");
505 snprintf(buf,256, "%d\u00b0", (i * 45));
507 cairo_text_extents(cr, buf, &t_ext);
508 cairo_move_to(cr, _analysis_width - t_ext.width - t_ext.x_bearing - 2.0, y - extents.descent);
509 cairo_show_text(cr, buf);
515 cairo_set_source_rgba(cr, .8, .9, 0.2, 0.6/(float)i);
516 cairo_move_to(cr, 0.0, y);
517 cairo_line_to(cr, _analysis_width, y);
520 y = _analysis_height/2.0 + (float)i*(_analysis_height/8.0)*PHASE_PROPORTION;
523 snprintf(buf,256, "-%d\u00b0", (i * 45));
524 cairo_set_source_rgb(cr, .8, .9, 0.2);
525 cairo_text_extents(cr, buf, &t_ext);
526 cairo_move_to(cr, _analysis_width - t_ext.width - t_ext.x_bearing - 2.0, y - extents.descent);
527 cairo_show_text(cr, buf);
530 cairo_set_source_rgba(cr, .8, .9, 0.2, 0.6/(float)i);
531 cairo_move_to(cr, 0.0, y);
532 cairo_line_to(cr, _analysis_width, y);
534 cairo_set_line_width (cr, 0.25 + 1.0/(float)(i+1));
540 PluginEqGui::plot_impulse_phase(Gtk::Widget *w, cairo_t *cr)
548 // float width = w->get_width();
549 float height = w->get_height();
551 cairo_set_source_rgba(cr, 0.95, 0.3, 0.2, 1.0);
552 for (uint32_t i = 0; i < _impulse_fft->bins()-1; i++) {
553 // x coordinate of bin i
554 x = log10f(1.0 + (float)i / (float)_impulse_fft->bins() * _log_coeff) / _log_max;
555 x *= _analysis_width;
557 y = _analysis_height/2.0 - (_impulse_fft->phase_at_bin(i)/M_PI)*(_analysis_height/2.0)*PHASE_PROPORTION;
560 cairo_move_to(cr, x, y);
564 } else if (rint(x) > prevX || i == _impulse_fft->bins()-1 ) {
565 avgY = avgY/(float)avgNum;
566 if (avgY > (height * 10.0) ) avgY = height * 10.0;
567 if (avgY < (-height * 10.0) ) avgY = -height * 10.0;
568 cairo_line_to(cr, prevX, avgY);
569 //cairo_line_to(cr, prevX, avgY/(float)avgNum);
581 cairo_set_line_width (cr, 2.0);
586 PluginEqGui::draw_scales_power(Gtk::Widget */*w*/, cairo_t *cr)
588 if (_impulse_fft == 0) {
592 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 };
593 float divisor = _samplerate / 2.0 / _impulse_fft->bins();
596 cairo_set_line_width (cr, 1.5);
597 cairo_set_font_size(cr, 9);
599 cairo_font_extents_t extents;
600 cairo_font_extents(cr, &extents);
601 // float fontXOffset = extents.descent + 1.0;
605 for (uint32_t i = 0; scales[i] != -1.0; ++i) {
606 float bin = scales[i] / divisor;
608 x = log10f(1.0 + bin / (float)_impulse_fft->bins() * _log_coeff) / _log_max;
609 x *= _analysis_width;
611 if (scales[i] < 1000.0) {
612 snprintf(buf, 256, "%0.0f", scales[i]);
614 snprintf(buf, 256, "%0.0fk", scales[i]/1000.0);
617 cairo_set_source_rgb(cr, 0.4, 0.4, 0.4);
619 //cairo_move_to(cr, x + fontXOffset, 3.0);
620 cairo_move_to(cr, x - extents.height, 3.0);
622 cairo_rotate(cr, M_PI / 2.0);
623 cairo_show_text(cr, buf);
624 cairo_rotate(cr, -M_PI / 2.0);
627 cairo_set_source_rgb(cr, 0.3, 0.3, 0.3);
628 cairo_move_to(cr, x, _analysis_height);
629 cairo_line_to(cr, x, 0.0);
635 //double dashes[] = { 1.0, 3.0, 4.5, 3.0 };
636 double dashes[] = { 3.0, 5.0 };
638 for (float dB = 0.0; dB < _max_dB; dB += _step_dB ) {
639 snprintf(buf, 256, "+%0.0f", dB );
641 y = ( _max_dB - dB) / ( _max_dB - _min_dB );
642 //std::cerr << " y = " << y << std::endl;
643 y *= _analysis_height;
646 cairo_set_source_rgb(cr, 0.4, 0.4, 0.4);
647 cairo_move_to(cr, 1.0, y + extents.height + 1.0);
648 cairo_show_text(cr, buf);
652 cairo_set_source_rgb(cr, 0.2, 0.2, 0.2);
653 cairo_move_to(cr, 0, y);
654 cairo_line_to(cr, _analysis_width, y);
658 cairo_set_dash(cr, dashes, 2, 0.0);
664 for (float dB = - _step_dB; dB > _min_dB; dB -= _step_dB ) {
665 snprintf(buf, 256, "%0.0f", dB );
667 y = ( _max_dB - dB) / ( _max_dB - _min_dB );
668 y *= _analysis_height;
670 cairo_set_source_rgb(cr, 0.4, 0.4, 0.4);
671 cairo_move_to(cr, 1.0, y - extents.descent - 1.0);
672 cairo_show_text(cr, buf);
675 cairo_set_source_rgb(cr, 0.2, 0.2, 0.2);
676 cairo_move_to(cr, 0, y);
677 cairo_line_to(cr, _analysis_width, y);
681 cairo_set_dash(cr, 0, 0, 0.0);
688 return 10.0 * log10f(a);
692 PluginEqGui::plot_impulse_amplitude(Gtk::Widget *w, cairo_t *cr)
699 // float width = w->get_width();
700 float height = w->get_height();
702 cairo_set_source_rgb(cr, 1.0, 1.0, 1.0);
703 cairo_set_line_width (cr, 2.5);
705 for (uint32_t i = 0; i < _impulse_fft->bins()-1; i++) {
706 // x coordinate of bin i
707 x = log10f(1.0 + (float)i / (float)_impulse_fft->bins() * _log_coeff) / _log_max;
708 x *= _analysis_width;
710 float yCoeff = ( power_to_dB(_impulse_fft->power_at_bin(i)) - _min_dB) / (_max_dB - _min_dB);
712 y = _analysis_height - _analysis_height*yCoeff;
715 cairo_move_to(cr, x, y);
719 } else if (rint(x) > prevX || i == _impulse_fft->bins()-1 ) {
720 avgY = avgY/(float)avgNum;
721 if (avgY > (height * 10.0) ) avgY = height * 10.0;
722 if (avgY < (-height * 10.0) ) avgY = -height * 10.0;
723 cairo_line_to(cr, prevX, avgY);
724 //cairo_line_to(cr, prevX, avgY/(float)avgNum);
740 PluginEqGui::plot_signal_amplitude_difference(Gtk::Widget *w, cairo_t *cr)
748 // float width = w->get_width();
749 float height = w->get_height();
751 cairo_set_source_rgb(cr, 0.0, 1.0, 0.0);
752 cairo_set_line_width (cr, 2.5);
754 for (uint32_t i = 0; i < _signal_input_fft->bins()-1; i++) {
755 // x coordinate of bin i
756 x = log10f(1.0 + (float)i / (float)_signal_input_fft->bins() * _log_coeff) / _log_max;
757 x *= _analysis_width;
759 float power_out = power_to_dB(_signal_output_fft->power_at_bin(i));
760 float power_in = power_to_dB(_signal_input_fft ->power_at_bin(i));
761 float power = power_out - power_in;
765 double p = 10.0 * log10( 1.0 + (double)_signal_output_fft->power_at_bin(i) - (double)
766 - _signal_input_fft ->power_at_bin(i));
768 float power = (float)p;
770 if ( (i % 1000) == 0) {
771 std::cerr << i << ": " << power << std::endl;
777 power = _min_dB - 1.0;
779 power = _max_dB - 1.0;
781 } else if (isnan(power)) {
782 power = _min_dB - 1.0;
785 float yCoeff = ( power - _min_dB) / (_max_dB - _min_dB);
787 y = _analysis_height - _analysis_height*yCoeff;
790 cairo_move_to(cr, x, y);
794 } else if (rint(x) > prevX || i == _impulse_fft->bins()-1 ) {
795 avgY = avgY/(float)avgNum;
796 if (avgY > (height * 10.0) ) avgY = height * 10.0;
797 if (avgY < (-height * 10.0) ) avgY = -height * 10.0;
798 cairo_line_to(cr, prevX, avgY);