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.
26 /* isinf() & isnan() are C99 standards, which older MSVC doesn't provide */
27 #define ISINF(val) !((bool)_finite((double)val))
28 #define ISNAN(val) (bool)_isnan((double)val)
30 #define ISINF(val) std::isinf((val))
31 #define ISNAN(val) std::isnan((val))
34 #include <gtkmm/box.h>
35 #include <gtkmm/button.h>
36 #include <gtkmm/checkbutton.h>
38 #include "ardour/audio_buffer.h"
39 #include "ardour/data_type.h"
40 #include "ardour/chan_mapping.h"
41 #include "ardour/plugin_insert.h"
42 #include "ardour/session.h"
44 #include "plugin_eq_gui.h"
46 #include "ardour_ui.h"
47 #include "gui_thread.h"
51 using namespace ARDOUR;
53 PluginEqGui::PluginEqGui(boost::shared_ptr<ARDOUR::PluginInsert> pluginInsert)
58 , _signal_input_fft(0)
59 , _signal_output_fft(0)
60 , _plugin_insert(pluginInsert)
62 _signal_analysis_running = false;
63 _samplerate = ARDOUR_UI::instance()->the_session()->frame_rate();
65 _log_coeff = (1.0 - 2.0 * (1000.0/(_samplerate/2.0))) / powf(1000.0/(_samplerate/2.0), 2.0);
66 _log_max = log10f(1 + _log_coeff);
68 // Setup analysis drawing area
69 _analysis_scale_surface = 0;
71 _analysis_area = new Gtk::DrawingArea();
72 _analysis_width = 256.0;
73 _analysis_height = 256.0;
74 _analysis_area->set_size_request(_analysis_width, _analysis_height);
76 _analysis_area->signal_expose_event().connect( sigc::mem_fun (*this, &PluginEqGui::expose_analysis_area));
77 _analysis_area->signal_size_allocate().connect( sigc::mem_fun (*this, &PluginEqGui::resize_analysis_area));
80 dBScaleModel = Gtk::ListStore::create(dBColumns);
82 dBScaleCombo = new Gtk::ComboBox (dBScaleModel, false);
83 dBScaleCombo->set_title (_("dB scale"));
85 #define ADD_DB_ROW(MIN,MAX,STEP,NAME) \
87 Gtk::TreeModel::Row row = *(dBScaleModel->append()); \
88 row[dBColumns.dBMin] = (MIN); \
89 row[dBColumns.dBMax] = (MAX); \
90 row[dBColumns.dBStep] = (STEP); \
91 row[dBColumns.name] = NAME; \
94 ADD_DB_ROW( -6, +6, 1, "-6dB .. +6dB");
95 ADD_DB_ROW(-12, +12, 3, "-12dB .. +12dB");
96 ADD_DB_ROW(-24, +24, 5, "-24dB .. +24dB");
97 ADD_DB_ROW(-36, +36, 6, "-36dB .. +36dB");
98 ADD_DB_ROW(-64, +64,12, "-64dB .. +64dB");
102 dBScaleCombo -> pack_start(dBColumns.name);
103 dBScaleCombo -> set_active(1);
105 dBScaleCombo -> signal_changed().connect( sigc::mem_fun(*this, &PluginEqGui::change_dB_scale) );
107 Gtk::Label *dBComboLabel = new Gtk::Label (_("dB scale"));
109 Gtk::HBox *dBSelectBin = new Gtk::HBox(false, 5);
110 dBSelectBin->add( *manage(dBComboLabel));
111 dBSelectBin->add( *manage(dBScaleCombo));
114 _phase_button = new Gtk::CheckButton (_("Show phase"));
115 _phase_button->set_active(true);
116 _phase_button->signal_toggled().connect( sigc::mem_fun(*this, &PluginEqGui::redraw_scales));
119 attach( *manage(_analysis_area), 1, 3, 1, 2);
120 attach( *manage(dBSelectBin), 1, 2, 2, 3, Gtk::SHRINK, Gtk::SHRINK);
121 attach( *manage(_phase_button), 2, 3, 2, 3, Gtk::SHRINK, Gtk::SHRINK);
124 PluginEqGui::~PluginEqGui()
128 if (_analysis_scale_surface) {
129 cairo_surface_destroy (_analysis_scale_surface);
134 delete _signal_input_fft;
135 _signal_input_fft = 0;
136 delete _signal_output_fft;
137 _signal_output_fft = 0;
139 // all gui objects are *manage'd by the inherited Table object
143 PluginEqGui::start_listening ()
146 _plugin = _plugin_insert->get_impulse_analysis_plugin();
150 set_buffer_size(4096, 16384);
151 // Connect the realtime signal collection callback
152 _plugin_insert->AnalysisDataGathered.connect (analysis_connection, invalidator (*this), boost::bind (&PluginEqGui::signal_collect_callback, this, _1, _2), gui_context());
156 PluginEqGui::stop_listening ()
158 analysis_connection.disconnect ();
159 _plugin->deactivate ();
163 PluginEqGui::on_hide()
166 Gtk::Table::on_hide();
170 PluginEqGui::stop_updating()
172 if (_update_connection.connected()) {
173 _update_connection.disconnect();
178 PluginEqGui::start_updating()
180 if (!_update_connection.connected() && is_visible()) {
181 _update_connection = Glib::signal_timeout().connect( sigc::mem_fun(this, &PluginEqGui::timeout_callback), 250);
186 PluginEqGui::on_show()
188 Gtk::Table::on_show();
192 Gtk::Widget *toplevel = get_toplevel();
194 if (!_window_unmap_connection.connected()) {
195 _window_unmap_connection = toplevel->signal_unmap().connect( sigc::mem_fun(this, &PluginEqGui::stop_updating));
198 if (!_window_map_connection.connected()) {
199 _window_map_connection = toplevel->signal_map().connect( sigc::mem_fun(this, &PluginEqGui::start_updating));
205 PluginEqGui::change_dB_scale()
207 Gtk::TreeModel::iterator iter = dBScaleCombo -> get_active();
209 Gtk::TreeModel::Row row;
211 if(iter && (row = *iter)) {
212 _min_dB = row[dBColumns.dBMin];
213 _max_dB = row[dBColumns.dBMax];
214 _step_dB = row[dBColumns.dBStep];
222 PluginEqGui::redraw_scales()
225 if (_analysis_scale_surface) {
226 cairo_surface_destroy (_analysis_scale_surface);
227 _analysis_scale_surface = 0;
230 _analysis_area->queue_draw();
232 // TODO: Add graph legend!
236 PluginEqGui::set_buffer_size(uint32_t size, uint32_t signal_size)
238 if (_buffer_size == size && _signal_buffer_size == signal_size) {
242 GTKArdour::FFT *tmp1 = _impulse_fft;
243 GTKArdour::FFT *tmp2 = _signal_input_fft;
244 GTKArdour::FFT *tmp3 = _signal_output_fft;
247 _impulse_fft = new GTKArdour::FFT(size);
248 _signal_input_fft = new GTKArdour::FFT(signal_size);
249 _signal_output_fft = new GTKArdour::FFT(signal_size);
251 // Don't care about lost memory, we're screwed anyhow
253 _signal_input_fft = tmp2;
254 _signal_output_fft = tmp3;
263 _signal_buffer_size = signal_size;
265 ARDOUR::ChanCount count = ARDOUR::ChanCount::max (_plugin->get_info()->n_inputs, _plugin->get_info()->n_outputs);
267 for (ARDOUR::DataType::iterator i = ARDOUR::DataType::begin(); i != ARDOUR::DataType::end(); ++i) {
268 _bufferset.ensure_buffers (*i, count.get (*i), _buffer_size);
269 _collect_bufferset.ensure_buffers (*i, count.get (*i), _buffer_size);
272 _bufferset.set_count (count);
273 _collect_bufferset.set_count (count);
277 PluginEqGui::resize_analysis_area (Gtk::Allocation& size)
279 _analysis_width = (float)size.get_width();
280 _analysis_height = (float)size.get_height();
282 if (_analysis_scale_surface) {
283 cairo_surface_destroy (_analysis_scale_surface);
284 _analysis_scale_surface = 0;
289 PluginEqGui::timeout_callback()
291 if (!_signal_analysis_running) {
292 _signal_analysis_running = true;
293 _plugin_insert -> collect_signal_for_analysis(_signal_buffer_size);
295 run_impulse_analysis();
301 PluginEqGui::signal_collect_callback(ARDOUR::BufferSet *in, ARDOUR::BufferSet *out)
303 ENSURE_GUI_THREAD (*this, &PluginEqGui::signal_collect_callback, in, out)
305 _signal_input_fft ->reset();
306 _signal_output_fft->reset();
308 for (uint32_t i = 0; i < _plugin_insert->input_streams().n_audio(); ++i) {
309 _signal_input_fft ->analyze(in ->get_audio(i).data(), GTKArdour::FFT::HANN);
312 for (uint32_t i = 0; i < _plugin_insert->output_streams().n_audio(); ++i) {
313 _signal_output_fft->analyze(out->get_audio(i).data(), GTKArdour::FFT::HANN);
316 _signal_input_fft ->calculate();
317 _signal_output_fft->calculate();
319 _signal_analysis_running = false;
321 // This signals calls expose_analysis_area()
322 _analysis_area->queue_draw();
326 PluginEqGui::run_impulse_analysis()
328 /* Allocate some thread-local buffers so that Plugin::connect_and_run can use them */
329 ARDOUR_UI::instance()->get_process_buffers ();
331 uint32_t inputs = _plugin->get_info()->n_inputs.n_audio();
332 uint32_t outputs = _plugin->get_info()->n_outputs.n_audio();
334 // Create the impulse, can't use silence() because consecutive calls won't work
335 for (uint32_t i = 0; i < inputs; ++i) {
336 ARDOUR::AudioBuffer& buf = _bufferset.get_audio(i);
337 ARDOUR::Sample* d = buf.data();
338 memset(d, 0, sizeof(ARDOUR::Sample)*_buffer_size);
342 ARDOUR::ChanMapping in_map(_plugin->get_info()->n_inputs);
343 ARDOUR::ChanMapping out_map(_plugin->get_info()->n_outputs);
345 _plugin->set_block_size (_buffer_size);
346 _plugin->connect_and_run(_bufferset, in_map, out_map, _buffer_size, 0);
347 framecnt_t f = _plugin->signal_latency ();
348 // Adding user_latency() could be interesting
350 // Gather all output, taking latency into account.
351 _impulse_fft->reset();
353 // Silence collect buffers to copy data to, can't use silence() because consecutive calls won't work
354 for (uint32_t i = 0; i < outputs; ++i) {
355 ARDOUR::AudioBuffer &buf = _collect_bufferset.get_audio(i);
356 ARDOUR::Sample *d = buf.data();
357 memset(d, 0, sizeof(ARDOUR::Sample)*_buffer_size);
361 //std::cerr << "0: no latency, copying full buffer, trivial.." << std::endl;
362 for (uint32_t i = 0; i < outputs; ++i) {
363 memcpy(_collect_bufferset.get_audio(i).data(),
364 _bufferset.get_audio(i).data(), _buffer_size * sizeof(float));
368 //std::cerr << (++C) << ": latency is " << f << " frames, doing split processing.." << std::endl;
369 framecnt_t target_offset = 0;
370 framecnt_t frames_left = _buffer_size; // refaktoroi
372 if (f >= _buffer_size) {
373 //std::cerr << (++C) << ": f (=" << f << ") is larger than buffer_size, still trying to reach the actual output" << std::endl;
374 // there is no data in this buffer regarding to the input!
377 // this buffer contains either the first, last or a whole bu the output of the impulse
378 // first part: offset is 0, so we copy to the start of _collect_bufferset
379 // we start at output offset "f"
380 // .. and copy "buffer size" - "f" - "offset" frames
382 framecnt_t length = _buffer_size - f - target_offset;
384 //std::cerr << (++C) << ": copying " << length << " frames to _collect_bufferset.get_audio(i)+" << target_offset << " from bufferset at offset " << f << std::endl;
385 for (uint32_t i = 0; i < outputs; ++i) {
386 memcpy(_collect_bufferset.get_audio(i).data(target_offset),
387 _bufferset.get_audio(i).data() + f,
388 length * sizeof(float));
391 target_offset += length;
392 frames_left -= length;
395 if (frames_left > 0) {
396 // Silence the buffers
397 for (uint32_t i = 0; i < inputs; ++i) {
398 ARDOUR::AudioBuffer &buf = _bufferset.get_audio(i);
399 ARDOUR::Sample *d = buf.data();
400 memset(d, 0, sizeof(ARDOUR::Sample)*_buffer_size);
403 in_map = ARDOUR::ChanMapping(_plugin->get_info()->n_inputs);
404 out_map = ARDOUR::ChanMapping(_plugin->get_info()->n_outputs);
405 _plugin->connect_and_run(_bufferset, in_map, out_map, _buffer_size, 0);
407 } while ( frames_left > 0);
412 for (uint32_t i = 0; i < outputs; ++i) {
413 _impulse_fft->analyze(_collect_bufferset.get_audio(i).data());
416 // normalize the output
417 _impulse_fft->calculate();
419 // This signals calls expose_analysis_area()
420 _analysis_area->queue_draw();
422 ARDOUR_UI::instance()->drop_process_buffers ();
426 PluginEqGui::expose_analysis_area(GdkEventExpose *)
428 redraw_analysis_area();
433 PluginEqGui::draw_analysis_scales(cairo_t *ref_cr)
435 // TODO: check whether we need rounding
436 _analysis_scale_surface = cairo_surface_create_similar(cairo_get_target(ref_cr),
441 cairo_t *cr = cairo_create (_analysis_scale_surface);
443 cairo_set_source_rgb(cr, 0.0, 0.0, 0.0);
444 cairo_rectangle(cr, 0.0, 0.0, _analysis_width, _analysis_height);
448 draw_scales_power(_analysis_area, cr);
449 if (_phase_button->get_active()) {
450 draw_scales_phase(_analysis_area, cr);
458 PluginEqGui::redraw_analysis_area()
462 cr = gdk_cairo_create(GDK_DRAWABLE(_analysis_area->get_window()->gobj()));
464 if (_analysis_scale_surface == 0) {
465 draw_analysis_scales(cr);
471 cairo_set_source_surface(cr, _analysis_scale_surface, 0.0, 0.0);
474 if (_phase_button->get_active()) {
475 plot_impulse_phase(_analysis_area, cr);
477 plot_impulse_amplitude(_analysis_area, cr);
479 // TODO: make this optional
480 plot_signal_amplitude_difference(_analysis_area, cr);
487 #define PHASE_PROPORTION 0.5
490 PluginEqGui::draw_scales_phase(Gtk::Widget */*w*/, cairo_t *cr)
493 cairo_font_extents_t extents;
494 cairo_font_extents(cr, &extents);
497 cairo_text_extents_t t_ext;
499 for (uint32_t i = 0; i < 3; i++) {
501 y = _analysis_height/2.0 - (float)i*(_analysis_height/8.0)*PHASE_PROPORTION;
503 cairo_set_source_rgb(cr, .8, .9, 0.2);
505 snprintf(buf,256, "0\u00b0");
507 snprintf(buf,256, "%d\u00b0", (i * 45));
509 cairo_text_extents(cr, buf, &t_ext);
510 cairo_move_to(cr, _analysis_width - t_ext.width - t_ext.x_bearing - 2.0, y - extents.descent);
511 cairo_show_text(cr, buf);
517 cairo_set_source_rgba(cr, .8, .9, 0.2, 0.6/(float)i);
518 cairo_move_to(cr, 0.0, y);
519 cairo_line_to(cr, _analysis_width, y);
522 y = _analysis_height/2.0 + (float)i*(_analysis_height/8.0)*PHASE_PROPORTION;
525 snprintf(buf,256, "-%d\u00b0", (i * 45));
526 cairo_set_source_rgb(cr, .8, .9, 0.2);
527 cairo_text_extents(cr, buf, &t_ext);
528 cairo_move_to(cr, _analysis_width - t_ext.width - t_ext.x_bearing - 2.0, y - extents.descent);
529 cairo_show_text(cr, buf);
532 cairo_set_source_rgba(cr, .8, .9, 0.2, 0.6/(float)i);
533 cairo_move_to(cr, 0.0, y);
534 cairo_line_to(cr, _analysis_width, y);
536 cairo_set_line_width (cr, 0.25 + 1.0/(float)(i+1));
542 PluginEqGui::plot_impulse_phase(Gtk::Widget *w, cairo_t *cr)
550 // float width = w->get_width();
551 float height = w->get_height();
553 cairo_set_source_rgba(cr, 0.95, 0.3, 0.2, 1.0);
554 for (uint32_t i = 0; i < _impulse_fft->bins()-1; i++) {
555 // x coordinate of bin i
556 x = log10f(1.0 + (float)i / (float)_impulse_fft->bins() * _log_coeff) / _log_max;
557 x *= _analysis_width;
559 y = _analysis_height/2.0 - (_impulse_fft->phase_at_bin(i)/M_PI)*(_analysis_height/2.0)*PHASE_PROPORTION;
562 cairo_move_to(cr, x, y);
566 } else if (rint(x) > prevX || i == _impulse_fft->bins()-1 ) {
567 avgY = avgY/(float)avgNum;
568 if (avgY > (height * 10.0) ) avgY = height * 10.0;
569 if (avgY < (-height * 10.0) ) avgY = -height * 10.0;
570 cairo_line_to(cr, prevX, avgY);
571 //cairo_line_to(cr, prevX, avgY/(float)avgNum);
583 cairo_set_line_width (cr, 2.0);
588 PluginEqGui::draw_scales_power(Gtk::Widget */*w*/, cairo_t *cr)
590 if (_impulse_fft == 0) {
594 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 };
595 float divisor = _samplerate / 2.0 / _impulse_fft->bins();
598 cairo_set_line_width (cr, 1.5);
599 cairo_set_font_size(cr, 9);
601 cairo_font_extents_t extents;
602 cairo_font_extents(cr, &extents);
603 // float fontXOffset = extents.descent + 1.0;
607 for (uint32_t i = 0; scales[i] != -1.0; ++i) {
608 float bin = scales[i] / divisor;
610 x = log10f(1.0 + bin / (float)_impulse_fft->bins() * _log_coeff) / _log_max;
611 x *= _analysis_width;
613 if (scales[i] < 1000.0) {
614 snprintf(buf, 256, "%0.0f", scales[i]);
616 snprintf(buf, 256, "%0.0fk", scales[i]/1000.0);
619 cairo_set_source_rgb(cr, 0.4, 0.4, 0.4);
621 //cairo_move_to(cr, x + fontXOffset, 3.0);
622 cairo_move_to(cr, x - extents.height, 3.0);
624 cairo_rotate(cr, M_PI / 2.0);
625 cairo_show_text(cr, buf);
626 cairo_rotate(cr, -M_PI / 2.0);
629 cairo_set_source_rgb(cr, 0.3, 0.3, 0.3);
630 cairo_move_to(cr, x, _analysis_height);
631 cairo_line_to(cr, x, 0.0);
637 //double dashes[] = { 1.0, 3.0, 4.5, 3.0 };
638 double dashes[] = { 3.0, 5.0 };
640 for (float dB = 0.0; dB < _max_dB; dB += _step_dB ) {
641 snprintf(buf, 256, "+%0.0f", dB );
643 y = ( _max_dB - dB) / ( _max_dB - _min_dB );
644 //std::cerr << " y = " << y << std::endl;
645 y *= _analysis_height;
648 cairo_set_source_rgb(cr, 0.4, 0.4, 0.4);
649 cairo_move_to(cr, 1.0, y + extents.height + 1.0);
650 cairo_show_text(cr, buf);
654 cairo_set_source_rgb(cr, 0.2, 0.2, 0.2);
655 cairo_move_to(cr, 0, y);
656 cairo_line_to(cr, _analysis_width, y);
660 cairo_set_dash(cr, dashes, 2, 0.0);
666 for (float dB = - _step_dB; dB > _min_dB; dB -= _step_dB ) {
667 snprintf(buf, 256, "%0.0f", dB );
669 y = ( _max_dB - dB) / ( _max_dB - _min_dB );
670 y *= _analysis_height;
672 cairo_set_source_rgb(cr, 0.4, 0.4, 0.4);
673 cairo_move_to(cr, 1.0, y - extents.descent - 1.0);
674 cairo_show_text(cr, buf);
677 cairo_set_source_rgb(cr, 0.2, 0.2, 0.2);
678 cairo_move_to(cr, 0, y);
679 cairo_line_to(cr, _analysis_width, y);
683 cairo_set_dash(cr, 0, 0, 0.0);
690 return 10.0 * log10f(a);
694 PluginEqGui::plot_impulse_amplitude(Gtk::Widget *w, cairo_t *cr)
701 // float width = w->get_width();
702 float height = w->get_height();
704 cairo_set_source_rgb(cr, 1.0, 1.0, 1.0);
705 cairo_set_line_width (cr, 2.5);
707 for (uint32_t i = 0; i < _impulse_fft->bins()-1; i++) {
708 // x coordinate of bin i
709 x = log10f(1.0 + (float)i / (float)_impulse_fft->bins() * _log_coeff) / _log_max;
710 x *= _analysis_width;
712 float yCoeff = ( power_to_dB(_impulse_fft->power_at_bin(i)) - _min_dB) / (_max_dB - _min_dB);
714 y = _analysis_height - _analysis_height*yCoeff;
717 cairo_move_to(cr, x, y);
721 } else if (rint(x) > prevX || i == _impulse_fft->bins()-1 ) {
722 avgY = avgY/(float)avgNum;
723 if (avgY > (height * 10.0) ) avgY = height * 10.0;
724 if (avgY < (-height * 10.0) ) avgY = -height * 10.0;
725 cairo_line_to(cr, prevX, avgY);
726 //cairo_line_to(cr, prevX, avgY/(float)avgNum);
742 PluginEqGui::plot_signal_amplitude_difference(Gtk::Widget *w, cairo_t *cr)
750 // float width = w->get_width();
751 float height = w->get_height();
753 cairo_set_source_rgb(cr, 0.0, 1.0, 0.0);
754 cairo_set_line_width (cr, 2.5);
756 for (uint32_t i = 0; i < _signal_input_fft->bins()-1; i++) {
757 // x coordinate of bin i
758 x = log10f(1.0 + (float)i / (float)_signal_input_fft->bins() * _log_coeff) / _log_max;
759 x *= _analysis_width;
761 float power_out = power_to_dB(_signal_output_fft->power_at_bin(i));
762 float power_in = power_to_dB(_signal_input_fft ->power_at_bin(i));
763 float power = power_out - power_in;
767 double p = 10.0 * log10( 1.0 + (double)_signal_output_fft->power_at_bin(i) - (double)
768 - _signal_input_fft ->power_at_bin(i));
770 float power = (float)p;
772 if ( (i % 1000) == 0) {
773 std::cerr << i << ": " << power << std::endl;
779 power = _min_dB - 1.0;
781 power = _max_dB - 1.0;
783 } else if (ISNAN(power)) {
784 power = _min_dB - 1.0;
787 float yCoeff = ( power - _min_dB) / (_max_dB - _min_dB);
789 y = _analysis_height - _analysis_height*yCoeff;
792 cairo_move_to(cr, x, y);
796 } else if (rint(x) > prevX || i == _impulse_fft->bins()-1 ) {
797 avgY = avgY/(float)avgNum;
798 if (avgY > (height * 10.0) ) avgY = height * 10.0;
799 if (avgY < (-height * 10.0) ) avgY = -height * 10.0;
800 cairo_line_to(cr, prevX, avgY);