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/session.h"
43 #include "plugin_eq_gui.h"
45 #include "ardour_ui.h"
46 #include "gui_thread.h"
50 using namespace ARDOUR;
52 PluginEqGui::PluginEqGui(boost::shared_ptr<ARDOUR::PluginInsert> pluginInsert)
57 , _signal_input_fft(0)
58 , _signal_output_fft(0)
59 , _plugin_insert(pluginInsert)
61 _signal_analysis_running = false;
62 _samplerate = ARDOUR_UI::instance()->the_session()->frame_rate();
64 _log_coeff = (1.0 - 2.0 * (1000.0/(_samplerate/2.0))) / powf(1000.0/(_samplerate/2.0), 2.0);
65 _log_max = log10f(1 + _log_coeff);
67 // Setup analysis drawing area
68 _analysis_scale_surface = 0;
70 _analysis_area = new Gtk::DrawingArea();
71 _analysis_width = 256.0;
72 _analysis_height = 256.0;
73 _analysis_area->set_size_request(_analysis_width, _analysis_height);
75 _analysis_area->signal_expose_event().connect( sigc::mem_fun (*this, &PluginEqGui::expose_analysis_area));
76 _analysis_area->signal_size_allocate().connect( sigc::mem_fun (*this, &PluginEqGui::resize_analysis_area));
79 dBScaleModel = Gtk::ListStore::create(dBColumns);
81 /* this grotty-looking cast allows compilation against gtkmm 2.24.0, which
82 added a new ComboBox constructor.
84 dBScaleCombo = new Gtk::ComboBox ((Glib::RefPtr<Gtk::TreeModel> &) dBScaleModel);
85 dBScaleCombo->set_title (_("dB scale"));
87 #define ADD_DB_ROW(MIN,MAX,STEP,NAME) \
89 Gtk::TreeModel::Row row = *(dBScaleModel->append()); \
90 row[dBColumns.dBMin] = (MIN); \
91 row[dBColumns.dBMax] = (MAX); \
92 row[dBColumns.dBStep] = (STEP); \
93 row[dBColumns.name] = NAME; \
96 ADD_DB_ROW( -6, +6, 1, "-6dB .. +6dB");
97 ADD_DB_ROW(-12, +12, 3, "-12dB .. +12dB");
98 ADD_DB_ROW(-24, +24, 5, "-24dB .. +24dB");
99 ADD_DB_ROW(-36, +36, 6, "-36dB .. +36dB");
100 ADD_DB_ROW(-64, +64,12, "-64dB .. +64dB");
104 dBScaleCombo -> pack_start(dBColumns.name);
105 dBScaleCombo -> set_active(1);
107 dBScaleCombo -> signal_changed().connect( sigc::mem_fun(*this, &PluginEqGui::change_dB_scale) );
109 Gtk::Label *dBComboLabel = new Gtk::Label (_("dB scale"));
111 Gtk::HBox *dBSelectBin = new Gtk::HBox(false, 5);
112 dBSelectBin->add( *manage(dBComboLabel));
113 dBSelectBin->add( *manage(dBScaleCombo));
116 _phase_button = new Gtk::CheckButton (_("Show phase"));
117 _phase_button->set_active(true);
118 _phase_button->signal_toggled().connect( sigc::mem_fun(*this, &PluginEqGui::redraw_scales));
121 attach( *manage(_analysis_area), 1, 3, 1, 2);
122 attach( *manage(dBSelectBin), 1, 2, 2, 3, Gtk::SHRINK, Gtk::SHRINK);
123 attach( *manage(_phase_button), 2, 3, 2, 3, Gtk::SHRINK, Gtk::SHRINK);
126 PluginEqGui::~PluginEqGui()
130 if (_analysis_scale_surface) {
131 cairo_surface_destroy (_analysis_scale_surface);
136 delete _signal_input_fft;
137 _signal_input_fft = 0;
138 delete _signal_output_fft;
139 _signal_output_fft = 0;
141 // all gui objects are *manage'd by the inherited Table object
145 PluginEqGui::start_listening ()
148 _plugin = _plugin_insert->get_impulse_analysis_plugin();
152 set_buffer_size(4096, 16384);
153 // Connect the realtime signal collection callback
154 _plugin_insert->AnalysisDataGathered.connect (analysis_connection, invalidator (*this), boost::bind (&PluginEqGui::signal_collect_callback, this, _1, _2), gui_context());
158 PluginEqGui::stop_listening ()
160 analysis_connection.disconnect ();
161 _plugin->deactivate ();
165 PluginEqGui::on_hide()
168 Gtk::Table::on_hide();
172 PluginEqGui::stop_updating()
174 if (_update_connection.connected()) {
175 _update_connection.disconnect();
180 PluginEqGui::start_updating()
182 if (!_update_connection.connected() && is_visible()) {
183 _update_connection = Glib::signal_timeout().connect( sigc::mem_fun(this, &PluginEqGui::timeout_callback), 250);
188 PluginEqGui::on_show()
190 Gtk::Table::on_show();
194 Gtk::Widget *toplevel = get_toplevel();
196 if (!_window_unmap_connection.connected()) {
197 _window_unmap_connection = toplevel->signal_unmap().connect( sigc::mem_fun(this, &PluginEqGui::stop_updating));
200 if (!_window_map_connection.connected()) {
201 _window_map_connection = toplevel->signal_map().connect( sigc::mem_fun(this, &PluginEqGui::start_updating));
207 PluginEqGui::change_dB_scale()
209 Gtk::TreeModel::iterator iter = dBScaleCombo -> get_active();
211 Gtk::TreeModel::Row row;
213 if(iter && (row = *iter)) {
214 _min_dB = row[dBColumns.dBMin];
215 _max_dB = row[dBColumns.dBMax];
216 _step_dB = row[dBColumns.dBStep];
224 PluginEqGui::redraw_scales()
227 if (_analysis_scale_surface) {
228 cairo_surface_destroy (_analysis_scale_surface);
229 _analysis_scale_surface = 0;
232 _analysis_area->queue_draw();
234 // TODO: Add graph legend!
238 PluginEqGui::set_buffer_size(uint32_t size, uint32_t signal_size)
240 if (_buffer_size == size && _signal_buffer_size == signal_size) {
244 GTKArdour::FFT *tmp1 = _impulse_fft;
245 GTKArdour::FFT *tmp2 = _signal_input_fft;
246 GTKArdour::FFT *tmp3 = _signal_output_fft;
249 _impulse_fft = new GTKArdour::FFT(size);
250 _signal_input_fft = new GTKArdour::FFT(signal_size);
251 _signal_output_fft = new GTKArdour::FFT(signal_size);
253 // Don't care about lost memory, we're screwed anyhow
255 _signal_input_fft = tmp2;
256 _signal_output_fft = tmp3;
265 _signal_buffer_size = signal_size;
267 ARDOUR::ChanCount count = ARDOUR::ChanCount::max (_plugin->get_info()->n_inputs, _plugin->get_info()->n_outputs);
269 for (ARDOUR::DataType::iterator i = ARDOUR::DataType::begin(); i != ARDOUR::DataType::end(); ++i) {
270 _bufferset.ensure_buffers (*i, count.get (*i), _buffer_size);
271 _collect_bufferset.ensure_buffers (*i, count.get (*i), _buffer_size);
274 _bufferset.set_count (count);
275 _collect_bufferset.set_count (count);
279 PluginEqGui::resize_analysis_area (Gtk::Allocation& size)
281 _analysis_width = (float)size.get_width();
282 _analysis_height = (float)size.get_height();
284 if (_analysis_scale_surface) {
285 cairo_surface_destroy (_analysis_scale_surface);
286 _analysis_scale_surface = 0;
291 PluginEqGui::timeout_callback()
293 if (!_signal_analysis_running) {
294 _signal_analysis_running = true;
295 _plugin_insert -> collect_signal_for_analysis(_signal_buffer_size);
297 run_impulse_analysis();
303 PluginEqGui::signal_collect_callback(ARDOUR::BufferSet *in, ARDOUR::BufferSet *out)
305 ENSURE_GUI_THREAD (*this, &PluginEqGui::signal_collect_callback, in, out)
307 _signal_input_fft ->reset();
308 _signal_output_fft->reset();
310 for (uint32_t i = 0; i < _plugin_insert->input_streams().n_audio(); ++i) {
311 _signal_input_fft ->analyze(in ->get_audio(i).data(), GTKArdour::FFT::HANN);
314 for (uint32_t i = 0; i < _plugin_insert->output_streams().n_audio(); ++i) {
315 _signal_output_fft->analyze(out->get_audio(i).data(), GTKArdour::FFT::HANN);
318 _signal_input_fft ->calculate();
319 _signal_output_fft->calculate();
321 _signal_analysis_running = false;
323 // This signals calls expose_analysis_area()
324 _analysis_area->queue_draw();
328 PluginEqGui::run_impulse_analysis()
330 /* Allocate some thread-local buffers so that Plugin::connect_and_run can use them */
331 ARDOUR_UI::instance()->get_process_buffers ();
333 uint32_t inputs = _plugin->get_info()->n_inputs.n_audio();
334 uint32_t outputs = _plugin->get_info()->n_outputs.n_audio();
336 // Create the impulse, can't use silence() because consecutive calls won't work
337 for (uint32_t i = 0; i < inputs; ++i) {
338 ARDOUR::AudioBuffer& buf = _bufferset.get_audio(i);
339 ARDOUR::Sample* d = buf.data();
340 memset(d, 0, sizeof(ARDOUR::Sample)*_buffer_size);
344 ARDOUR::ChanMapping in_map(_plugin->get_info()->n_inputs);
345 ARDOUR::ChanMapping out_map(_plugin->get_info()->n_outputs);
347 _plugin->set_block_size (_buffer_size);
348 _plugin->connect_and_run(_bufferset, in_map, out_map, _buffer_size, 0);
349 framecnt_t f = _plugin->signal_latency ();
350 // Adding user_latency() could be interesting
352 // Gather all output, taking latency into account.
353 _impulse_fft->reset();
355 // Silence collect buffers to copy data to, can't use silence() because consecutive calls won't work
356 for (uint32_t i = 0; i < outputs; ++i) {
357 ARDOUR::AudioBuffer &buf = _collect_bufferset.get_audio(i);
358 ARDOUR::Sample *d = buf.data();
359 memset(d, 0, sizeof(ARDOUR::Sample)*_buffer_size);
363 //std::cerr << "0: no latency, copying full buffer, trivial.." << std::endl;
364 for (uint32_t i = 0; i < outputs; ++i) {
365 memcpy(_collect_bufferset.get_audio(i).data(),
366 _bufferset.get_audio(i).data(), _buffer_size * sizeof(float));
370 //std::cerr << (++C) << ": latency is " << f << " frames, doing split processing.." << std::endl;
371 framecnt_t target_offset = 0;
372 framecnt_t frames_left = _buffer_size; // refaktoroi
374 if (f >= _buffer_size) {
375 //std::cerr << (++C) << ": f (=" << f << ") is larger than buffer_size, still trying to reach the actual output" << std::endl;
376 // there is no data in this buffer regarding to the input!
379 // this buffer contains either the first, last or a whole bu the output of the impulse
380 // first part: offset is 0, so we copy to the start of _collect_bufferset
381 // we start at output offset "f"
382 // .. and copy "buffer size" - "f" - "offset" frames
384 framecnt_t length = _buffer_size - f - target_offset;
386 //std::cerr << (++C) << ": copying " << length << " frames to _collect_bufferset.get_audio(i)+" << target_offset << " from bufferset at offset " << f << std::endl;
387 for (uint32_t i = 0; i < outputs; ++i) {
388 memcpy(_collect_bufferset.get_audio(i).data(target_offset),
389 _bufferset.get_audio(i).data() + f,
390 length * sizeof(float));
393 target_offset += length;
394 frames_left -= length;
397 if (frames_left > 0) {
398 // Silence the buffers
399 for (uint32_t i = 0; i < inputs; ++i) {
400 ARDOUR::AudioBuffer &buf = _bufferset.get_audio(i);
401 ARDOUR::Sample *d = buf.data();
402 memset(d, 0, sizeof(ARDOUR::Sample)*_buffer_size);
405 in_map = ARDOUR::ChanMapping(_plugin->get_info()->n_inputs);
406 out_map = ARDOUR::ChanMapping(_plugin->get_info()->n_outputs);
407 _plugin->connect_and_run(_bufferset, in_map, out_map, _buffer_size, 0);
409 } while ( frames_left > 0);
414 for (uint32_t i = 0; i < outputs; ++i) {
415 _impulse_fft->analyze(_collect_bufferset.get_audio(i).data());
418 // normalize the output
419 _impulse_fft->calculate();
421 // This signals calls expose_analysis_area()
422 _analysis_area->queue_draw();
424 ARDOUR_UI::instance()->drop_process_buffers ();
428 PluginEqGui::expose_analysis_area(GdkEventExpose *)
430 redraw_analysis_area();
435 PluginEqGui::draw_analysis_scales(cairo_t *ref_cr)
437 // TODO: check whether we need rounding
438 _analysis_scale_surface = cairo_surface_create_similar(cairo_get_target(ref_cr),
443 cairo_t *cr = cairo_create (_analysis_scale_surface);
445 cairo_set_source_rgb(cr, 0.0, 0.0, 0.0);
446 cairo_rectangle(cr, 0.0, 0.0, _analysis_width, _analysis_height);
450 draw_scales_power(_analysis_area, cr);
451 if (_phase_button->get_active()) {
452 draw_scales_phase(_analysis_area, cr);
460 PluginEqGui::redraw_analysis_area()
464 cr = gdk_cairo_create(GDK_DRAWABLE(_analysis_area->get_window()->gobj()));
466 if (_analysis_scale_surface == 0) {
467 draw_analysis_scales(cr);
473 cairo_set_source_surface(cr, _analysis_scale_surface, 0.0, 0.0);
476 if (_phase_button->get_active()) {
477 plot_impulse_phase(_analysis_area, cr);
479 plot_impulse_amplitude(_analysis_area, cr);
481 // TODO: make this optional
482 plot_signal_amplitude_difference(_analysis_area, cr);
489 #define PHASE_PROPORTION 0.5
492 PluginEqGui::draw_scales_phase(Gtk::Widget */*w*/, cairo_t *cr)
495 cairo_font_extents_t extents;
496 cairo_font_extents(cr, &extents);
499 cairo_text_extents_t t_ext;
501 for (uint32_t i = 0; i < 3; i++) {
503 y = _analysis_height/2.0 - (float)i*(_analysis_height/8.0)*PHASE_PROPORTION;
505 cairo_set_source_rgb(cr, .8, .9, 0.2);
507 snprintf(buf,256, "0\u00b0");
509 snprintf(buf,256, "%d\u00b0", (i * 45));
511 cairo_text_extents(cr, buf, &t_ext);
512 cairo_move_to(cr, _analysis_width - t_ext.width - t_ext.x_bearing - 2.0, y - extents.descent);
513 cairo_show_text(cr, buf);
519 cairo_set_source_rgba(cr, .8, .9, 0.2, 0.6/(float)i);
520 cairo_move_to(cr, 0.0, y);
521 cairo_line_to(cr, _analysis_width, y);
524 y = _analysis_height/2.0 + (float)i*(_analysis_height/8.0)*PHASE_PROPORTION;
527 snprintf(buf,256, "-%d\u00b0", (i * 45));
528 cairo_set_source_rgb(cr, .8, .9, 0.2);
529 cairo_text_extents(cr, buf, &t_ext);
530 cairo_move_to(cr, _analysis_width - t_ext.width - t_ext.x_bearing - 2.0, y - extents.descent);
531 cairo_show_text(cr, buf);
534 cairo_set_source_rgba(cr, .8, .9, 0.2, 0.6/(float)i);
535 cairo_move_to(cr, 0.0, y);
536 cairo_line_to(cr, _analysis_width, y);
538 cairo_set_line_width (cr, 0.25 + 1.0/(float)(i+1));
544 PluginEqGui::plot_impulse_phase(Gtk::Widget *w, cairo_t *cr)
552 // float width = w->get_width();
553 float height = w->get_height();
555 cairo_set_source_rgba(cr, 0.95, 0.3, 0.2, 1.0);
556 for (uint32_t i = 0; i < _impulse_fft->bins()-1; i++) {
557 // x coordinate of bin i
558 x = log10f(1.0 + (float)i / (float)_impulse_fft->bins() * _log_coeff) / _log_max;
559 x *= _analysis_width;
561 y = _analysis_height/2.0 - (_impulse_fft->phase_at_bin(i)/M_PI)*(_analysis_height/2.0)*PHASE_PROPORTION;
564 cairo_move_to(cr, x, y);
568 } else if (rint(x) > prevX || i == _impulse_fft->bins()-1 ) {
569 avgY = avgY/(float)avgNum;
570 if (avgY > (height * 10.0) ) avgY = height * 10.0;
571 if (avgY < (-height * 10.0) ) avgY = -height * 10.0;
572 cairo_line_to(cr, prevX, avgY);
573 //cairo_line_to(cr, prevX, avgY/(float)avgNum);
585 cairo_set_line_width (cr, 2.0);
590 PluginEqGui::draw_scales_power(Gtk::Widget */*w*/, cairo_t *cr)
592 if (_impulse_fft == 0) {
596 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 };
597 float divisor = _samplerate / 2.0 / _impulse_fft->bins();
600 cairo_set_line_width (cr, 1.5);
601 cairo_set_font_size(cr, 9);
603 cairo_font_extents_t extents;
604 cairo_font_extents(cr, &extents);
605 // float fontXOffset = extents.descent + 1.0;
609 for (uint32_t i = 0; scales[i] != -1.0; ++i) {
610 float bin = scales[i] / divisor;
612 x = log10f(1.0 + bin / (float)_impulse_fft->bins() * _log_coeff) / _log_max;
613 x *= _analysis_width;
615 if (scales[i] < 1000.0) {
616 snprintf(buf, 256, "%0.0f", scales[i]);
618 snprintf(buf, 256, "%0.0fk", scales[i]/1000.0);
621 cairo_set_source_rgb(cr, 0.4, 0.4, 0.4);
623 //cairo_move_to(cr, x + fontXOffset, 3.0);
624 cairo_move_to(cr, x - extents.height, 3.0);
626 cairo_rotate(cr, M_PI / 2.0);
627 cairo_show_text(cr, buf);
628 cairo_rotate(cr, -M_PI / 2.0);
631 cairo_set_source_rgb(cr, 0.3, 0.3, 0.3);
632 cairo_move_to(cr, x, _analysis_height);
633 cairo_line_to(cr, x, 0.0);
639 //double dashes[] = { 1.0, 3.0, 4.5, 3.0 };
640 double dashes[] = { 3.0, 5.0 };
642 for (float dB = 0.0; dB < _max_dB; dB += _step_dB ) {
643 snprintf(buf, 256, "+%0.0f", dB );
645 y = ( _max_dB - dB) / ( _max_dB - _min_dB );
646 //std::cerr << " y = " << y << std::endl;
647 y *= _analysis_height;
650 cairo_set_source_rgb(cr, 0.4, 0.4, 0.4);
651 cairo_move_to(cr, 1.0, y + extents.height + 1.0);
652 cairo_show_text(cr, buf);
656 cairo_set_source_rgb(cr, 0.2, 0.2, 0.2);
657 cairo_move_to(cr, 0, y);
658 cairo_line_to(cr, _analysis_width, y);
662 cairo_set_dash(cr, dashes, 2, 0.0);
668 for (float dB = - _step_dB; dB > _min_dB; dB -= _step_dB ) {
669 snprintf(buf, 256, "%0.0f", dB );
671 y = ( _max_dB - dB) / ( _max_dB - _min_dB );
672 y *= _analysis_height;
674 cairo_set_source_rgb(cr, 0.4, 0.4, 0.4);
675 cairo_move_to(cr, 1.0, y - extents.descent - 1.0);
676 cairo_show_text(cr, buf);
679 cairo_set_source_rgb(cr, 0.2, 0.2, 0.2);
680 cairo_move_to(cr, 0, y);
681 cairo_line_to(cr, _analysis_width, y);
685 cairo_set_dash(cr, 0, 0, 0.0);
692 return 10.0 * log10f(a);
696 PluginEqGui::plot_impulse_amplitude(Gtk::Widget *w, cairo_t *cr)
703 // float width = w->get_width();
704 float height = w->get_height();
706 cairo_set_source_rgb(cr, 1.0, 1.0, 1.0);
707 cairo_set_line_width (cr, 2.5);
709 for (uint32_t i = 0; i < _impulse_fft->bins()-1; i++) {
710 // x coordinate of bin i
711 x = log10f(1.0 + (float)i / (float)_impulse_fft->bins() * _log_coeff) / _log_max;
712 x *= _analysis_width;
714 float yCoeff = ( power_to_dB(_impulse_fft->power_at_bin(i)) - _min_dB) / (_max_dB - _min_dB);
716 y = _analysis_height - _analysis_height*yCoeff;
719 cairo_move_to(cr, x, y);
723 } else if (rint(x) > prevX || i == _impulse_fft->bins()-1 ) {
724 avgY = avgY/(float)avgNum;
725 if (avgY > (height * 10.0) ) avgY = height * 10.0;
726 if (avgY < (-height * 10.0) ) avgY = -height * 10.0;
727 cairo_line_to(cr, prevX, avgY);
728 //cairo_line_to(cr, prevX, avgY/(float)avgNum);
744 PluginEqGui::plot_signal_amplitude_difference(Gtk::Widget *w, cairo_t *cr)
752 // float width = w->get_width();
753 float height = w->get_height();
755 cairo_set_source_rgb(cr, 0.0, 1.0, 0.0);
756 cairo_set_line_width (cr, 2.5);
758 for (uint32_t i = 0; i < _signal_input_fft->bins()-1; i++) {
759 // x coordinate of bin i
760 x = log10f(1.0 + (float)i / (float)_signal_input_fft->bins() * _log_coeff) / _log_max;
761 x *= _analysis_width;
763 float power_out = power_to_dB(_signal_output_fft->power_at_bin(i));
764 float power_in = power_to_dB(_signal_input_fft ->power_at_bin(i));
765 float power = power_out - power_in;
769 double p = 10.0 * log10( 1.0 + (double)_signal_output_fft->power_at_bin(i) - (double)
770 - _signal_input_fft ->power_at_bin(i));
772 float power = (float)p;
774 if ( (i % 1000) == 0) {
775 std::cerr << i << ": " << power << std::endl;
781 power = _min_dB - 1.0;
783 power = _max_dB - 1.0;
785 } else if (ISNAN(power)) {
786 power = _min_dB - 1.0;
789 float yCoeff = ( power - _min_dB) / (_max_dB - _min_dB);
791 y = _analysis_height - _analysis_height*yCoeff;
794 cairo_move_to(cr, x, y);
798 } else if (rint(x) > prevX || i == _impulse_fft->bins()-1 ) {
799 avgY = avgY/(float)avgNum;
800 if (avgY > (height * 10.0) ) avgY = height * 10.0;
801 if (avgY < (-height * 10.0) ) avgY = -height * 10.0;
802 cairo_line_to(cr, prevX, avgY);