Fix uninitialized variable
[ardour.git] / gtk2_ardour / export_report.cc
index 8d3b78c2ef42793e9499a3fe74453079fd922210..52a5dae0cc83385abe78bba7c210a5061c4d5abc 100644 (file)
 #include <gtkmm/stock.h>
 
 #include "pbd/openuri.h"
+#include "pbd/basename.h"
+
 #include "gtkmm2ext/utils.h"
-#include "gtkmm2ext/utils.h"
-#include "canvas/utils.h"
-#include "canvas/colors.h"
+#include "gtkmm2ext/colors.h"
 
 #include "audiographer/general/analyser.h"
 
 #include "ardour/audioregion.h"
 #include "ardour/auditioner.h"
 #include "ardour/dB.h"
+#include "ardour/logmeter.h"
 #include "ardour/region_factory.h"
 #include "ardour/session.h"
 #include "ardour/smf_source.h"
 #include "ardour/source_factory.h"
 #include "ardour/srcfilesource.h"
+#include "ardour/utils.h"
 
 #include "audio_clock.h"
 #include "export_report.h"
-#include "logmeter.h"
 #include "ui_config.h"
 
-#include "i18n.h"
+#include "pbd/i18n.h"
 
 using namespace Gtk;
 using namespace ARDOUR;
@@ -122,10 +123,11 @@ ExportReport::init (const AnalysisResults & ar, bool with_file)
                SoundFileInfo info;
                std::string errmsg;
 
-               framecnt_t file_length = 0;
-               framecnt_t sample_rate = 0;
-               framecnt_t start_off = 0;
+               samplecnt_t file_length = 0;
+               samplecnt_t sample_rate = 0;
+               samplecnt_t start_off = 0;
                unsigned int channels = 0;
+               std::string file_fmt;
 
                if (with_file && AudioFileSource::get_soundfile_info (path, info, errmsg)) {
                        AudioClock * clock;
@@ -139,18 +141,18 @@ ExportReport::init (const AnalysisResults & ar, bool with_file)
 
                        /* File Info Table */
 
-                       framecnt_t const nfr = _session ? _session->nominal_frame_rate () : 25;
+                       samplecnt_t const nfr = _session ? _session->nominal_sample_rate () : 25;
                        double src_coef = (double) nfr / info.samplerate;
 
                        l = manage (new Label (_("Format:"), ALIGN_END));
                        t->attach (*l, 0, 1, 1, 2);
-                       std::string fmt = info.format_name;
-                       std::replace (fmt.begin (), fmt.end (), '\n', ' ');
+                       file_fmt = info.format_name;
+                       std::replace (file_fmt.begin (), file_fmt.end (), '\n', ' ');
                        l = manage (new Label ());
                        l->set_ellipsize (Pango::ELLIPSIZE_START);
                        l->set_width_chars (48);
                        l->set_max_width_chars (48);
-                       l->set_text (fmt);
+                       l->set_text (file_fmt);
                        l->set_alignment (ALIGN_START, ALIGN_CENTER);
                        t->attach (*l, 1, 3, 1, 2, FILL, SHRINK);
 
@@ -180,10 +182,14 @@ ExportReport::init (const AnalysisResults & ar, bool with_file)
                        clock->set (info.timecode * src_coef + 0.5, true);
                        t->attach (*clock, 3, 4, 3, 4);
                } else if (with_file) {
-                       l = manage (new Label (_("Error:"), ALIGN_END));
-                       t->attach (*l, 0, 1, 1, 2);
-                       l = manage (new Label (errmsg, ALIGN_START));
-                       t->attach (*l, 1, 4, 1, 2);
+                       with_file = false;
+                       /* Note: errmsg can have size = 1, and contain "\0\0" */
+                       if (!errmsg.empty() && 0 != strlen(errmsg.c_str())) {
+                               l = manage (new Label (_("Error:"), ALIGN_END));
+                               t->attach (*l, 0, 1, 1, 2);
+                               l = manage (new Label (errmsg, ALIGN_START));
+                               t->attach (*l, 1, 4, 1, 2);
+                       }
                }
 
                int w, h;
@@ -248,7 +254,7 @@ ExportReport::init (const AnalysisResults & ar, bool with_file)
                mnw = (m_l - /*hist-width*/ 540 - /*box spacing*/ 8 + /*peak-width*/ 800 + m_r) / 2;
                const int nw2 = mnw / 2; // nums, horizontal center
 
-               int y0[4];
+               int y0[6];
                if (p->normalized) {
                        y0[0] = (hh - ht) * .5;
                } else {
@@ -260,6 +266,85 @@ ExportReport::init (const AnalysisResults & ar, bool with_file)
                y0[4] = y0[3] + lin[3] * 1.25;
                y0[5] = y0[4] + lin[4] * 1.25;
 
+               /* calc heights & alignment of png-image */
+               const float specth = sizeof (p->spectrum[0]) / sizeof (float);
+               const float waveh2 = std::min (100, 8 * lin[0] / (int) p->n_channels);
+
+               Cairo::RefPtr<Cairo::ImageSurface> png_surface;
+               int png_w = 0;
+               int png_y0 = 0;
+
+               if (with_file && UIConfiguration::instance().get_save_export_analysis_image ()) { /*png image */
+                       const int top_w = 540 + 2 * (mnw + 4); // 4px spacing
+                       const int wav_w = m_l + m_r + 4 + sizeof (p->peaks) / sizeof (ARDOUR::PeakData::PeakDatum) / 4;
+                       const int spc_w = m_l + m_r + 4 + sizeof (p->spectrum) / sizeof (float) / specth;
+                       int ann_h = 0;
+                       int linesp = 0;
+
+                       if (channels > 0 && file_length > 0 && sample_rate > 0) {
+                               layout->set_font_description (UIConfiguration::instance ().get_SmallMonospaceFont ());
+                               layout->set_text (_("00:00:00.000"));
+                               layout->get_pixel_size (w, h);
+                               int height = h * 1.75;
+                               ann_h = 4 + height /* Time Axis */;
+
+                               layout->set_font_description (UIConfiguration::instance ().get_SmallFont ());
+                               layout->set_text (_("0|A8"));
+                               layout->get_pixel_size (w, h);
+                               linesp = h * 1.5;
+                               ann_h += 4 + 3 * linesp; /* File Info */;
+                       }
+
+                       const int png_h = hh + 4 + p->n_channels * (2 * waveh2 + 4) + ann_h + specth + 4;
+                       png_w = std::max (std::max (top_w, wav_w), spc_w);
+
+                       png_surface = Cairo::ImageSurface::create (Cairo::FORMAT_RGB24, png_w, png_h);
+                       Cairo::RefPtr<Cairo::Context> pcx = Cairo::Context::create (png_surface);
+                       pcx->set_source_rgb (.2, .2, .2);
+                       pcx->paint ();
+
+                       if (channels > 0 && file_length > 0 && sample_rate > 0) {
+                               png_y0 += 4;
+                               // Add file-name, format, duration, sample-rate & timecode
+                               pcx->set_source_rgb (.7, .7, .7);
+                               layout->set_font_description (UIConfiguration::instance ().get_SmallFont ());
+                               layout->set_alignment (Pango::ALIGN_LEFT);
+
+#define IMGLABEL(X0, STR, VAL) {       \
+  layout->set_text (STR);              \
+  pcx->move_to (X0, png_y0);           \
+  layout->get_pixel_size (w, h);       \
+  layout->show_in_cairo_context (pcx); \
+  layout->set_text (VAL);              \
+  pcx->move_to (X0 + w + 2, png_y0);   \
+  layout->show_in_cairo_context (pcx); \
+}
+
+                               // TODO get max width of labels per column, right-align labels,  x-align 1/3, 2/3 columns
+                               const int lx0 = m_l;
+                               const int lx1 = m_l + png_w * 2 / 3; // right-col is short (channels, SR, duration)
+                               std::string sha1sum = ARDOUR::compute_sha1_of_file (path);
+                               if (!sha1sum.empty()) {
+                                       sha1sum = " (sha1: " + sha1sum + ")";
+                               }
+
+                               IMGLABEL (lx0, _("File:"), Glib::path_get_basename (path) + sha1sum);
+                               IMGLABEL (lx1, _("Channels:"), string_compose ("%1", channels));
+                               png_y0 += linesp;
+
+                               IMGLABEL (lx0, _("Format:"), file_fmt);
+                               IMGLABEL (lx1, _("Sample rate:"), string_compose (_("%1 Hz"), sample_rate));
+                               png_y0 += linesp;
+
+                               if (_session) {
+                                       Timecode::Time tct;
+                                       _session->sample_to_timecode (start_off, tct, false, false);
+                                       IMGLABEL (lx0, _("Timecode:"), Timecode::timecode_format_time (tct));
+                               }
+                               IMGLABEL (lx1, _("Duration:"), Timecode::timecode_format_sampletime (file_length, sample_rate, 1000, false));
+                               png_y0 += linesp;
+                       }
+               }
 
                { /* peak, loudness and R128 histogram */
                        Cairo::RefPtr<Cairo::ImageSurface> nums = Cairo::ImageSurface::create (Cairo::FORMAT_ARGB32, mnw, hh);
@@ -448,8 +533,8 @@ ExportReport::init (const AnalysisResults & ar, bool with_file)
                                                        rint ((g + 59.0) * 10.0 - h * .5), 5,
                                                        h + 2, w + 2, 4);
                                        const float pk = (g + 59.0) / 54.0;
-                                       ArdourCanvas::Color c = ArdourCanvas::hsva_to_color (252 - 260 * pk, .9, .3 + pk * .4, .6);
-                                       ArdourCanvas::set_source_rgba (cr, c);
+                                       Gtkmm2ext::Color c = Gtkmm2ext::hsva_to_color (252 - 260 * pk, .9, .3 + pk * .4, .6);
+                                       Gtkmm2ext::set_source_rgba (cr, c);
                                        cr->fill ();
 
                                        cr->save ();
@@ -481,6 +566,17 @@ ExportReport::init (const AnalysisResults & ar, bool with_file)
 
                        hist->flush ();
 
+                       if (png_surface) {
+                               Cairo::RefPtr<Cairo::Context> pcx = Cairo::Context::create (png_surface);
+                               pcx->set_source (nums, 0, png_y0);
+                               pcx->paint ();
+                               pcx->set_source (hist, (png_w - 540) / 2, png_y0);
+                               pcx->paint ();
+                               pcx->set_source (ebur, png_w - mnw, png_y0);
+                               pcx->paint ();
+                               png_y0 += hh + 4;
+                       }
+
                        CimgArea *nu = manage (new CimgArea (nums));
                        CimgArea *eb = manage (new CimgArea (ebur));
                        CimgArea *hi = manage (new CimgArea (hist));
@@ -514,6 +610,9 @@ ExportReport::init (const AnalysisResults & ar, bool with_file)
                        VBox *lrb = manage (new VBox());
                        ToggleButton *log = manage (new ToggleButton (S_("Logscale|Lg")));
                        ToggleButton *rec = manage (new ToggleButton (S_("Rectified|Rf")));
+                       Gtkmm2ext::UI::instance()->set_tip (log, _("Logscale"));
+                       Gtkmm2ext::UI::instance()->set_tip (rec, _("Rectified"));
+
                        lrb->pack_start (*log, false, false, 5);
                        lrb->pack_end (*rec, false, false, 5);
                        log->signal_toggled ().connect (sigc::bind (sigc::mem_fun (*this, &ExportReport::on_logscale_toggled), log));
@@ -530,10 +629,10 @@ ExportReport::init (const AnalysisResults & ar, bool with_file)
                        Cairo::RefPtr<Cairo::ImageSurface> wave_log;
                        Cairo::RefPtr<Cairo::ImageSurface> wave_rect;
                        Cairo::RefPtr<Cairo::ImageSurface> wave_lr;
-                       draw_waveform(wave, p, c, m_l, width, anw, lin[0], false, false);
-                       draw_waveform(wave_log, p, c, m_l, width, anw, lin[0], true, false);
-                       draw_waveform(wave_rect, p, c, m_l, width, anw, lin[0], false, true);
-                       draw_waveform(wave_lr, p, c, m_l, width, anw, lin[0], true, true);
+                       draw_waveform(wave, p, c, m_l, width, anw, waveh2, false, false);
+                       draw_waveform(wave_log, p, c, m_l, width, anw, waveh2, true, false);
+                       draw_waveform(wave_rect, p, c, m_l, width, anw, waveh2, false, true);
+                       draw_waveform(wave_lr, p, c, m_l, width, anw, waveh2, true, true);
 
                        CimgWaveArea *wv = manage (new CimgWaveArea (wave, wave_log, wave_rect, wave_lr, m_l, width));
 
@@ -542,6 +641,13 @@ ExportReport::init (const AnalysisResults & ar, bool with_file)
                        wv->seek_playhead.connect (sigc::bind<0> (sigc::mem_fun (*this, &ExportReport::audition_seek), page));
                        wtbl->attach (*wv, 0, 1, wrow, wrow + 1, SHRINK, SHRINK);
                        ++wrow;
+
+                       if (png_surface) {
+                               Cairo::RefPtr<Cairo::Context> pcx = Cairo::Context::create (png_surface);
+                               pcx->set_source (wave, 0, png_y0);
+                               pcx->paint ();
+                               png_y0 += 2 * waveh2 + 4;
+                       }
                }
 
                if (channels > 0 && file_length > 0 && sample_rate > 0)
@@ -599,12 +705,19 @@ ExportReport::init (const AnalysisResults & ar, bool with_file)
                        tm->seek_playhead.connect (sigc::bind<0> (sigc::mem_fun (*this, &ExportReport::audition_seek), page));
                        wtbl->attach (*tm, 0, 1, wrow, wrow + 1, SHRINK, SHRINK);
                        ++wrow;
+
+                       if (png_surface) {
+                               Cairo::RefPtr<Cairo::Context> pcx = Cairo::Context::create (png_surface);
+                               pcx->set_source (ytme, 0, png_y0);
+                               pcx->paint ();
+                               png_y0 += height + 4;
+                       }
                }
 
                {
                        /* Draw Spectrum */
+                       const size_t height = specth;
                        const size_t swh = sizeof (p->spectrum) / sizeof (float);
-                       const size_t height = sizeof (p->spectrum[0]) / sizeof (float);
                        const size_t width = swh / height;
 
                        Cairo::RefPtr<Cairo::ImageSurface> spec = Cairo::ImageSurface::create (Cairo::FORMAT_ARGB32, m_l + width, height);
@@ -621,8 +734,8 @@ ExportReport::init (const AnalysisResults & ar, bool with_file)
                        for (size_t x = 0 ; x < width; ++x) {
                                for (size_t y = 0 ; y < height; ++y) {
                                        const float pk = p->spectrum[x][y];
-                                       ArdourCanvas::Color c = ArdourCanvas::hsva_to_color (252 - 260 * pk, .9, sqrt(pk));
-                                       ArdourCanvas::set_source_rgba (cr, c);
+                                       Gtkmm2ext::Color c = Gtkmm2ext::hsva_to_color (252 - 260 * pk, .9, sqrt(pk));
+                                       Gtkmm2ext::set_source_rgba (cr, c);
                                        cr->rectangle (m_l + x - .5, y - .5, 1, 1);
                                        cr->fill ();
                                }
@@ -682,8 +795,8 @@ ExportReport::init (const AnalysisResults & ar, bool with_file)
 
                        for (size_t y = 0 ; y < innerheight - 2; ++y) {
                                        const float pk = 1.0 - (float) y / innerheight;
-                                       ArdourCanvas::Color c = ArdourCanvas::hsva_to_color (252 - 260 * pk, .9, sqrt(pk));
-                                       ArdourCanvas::set_source_rgba (cr, c);
+                                       Gtkmm2ext::Color c = Gtkmm2ext::hsva_to_color (252 - 260 * pk, .9, sqrt(pk));
+                                       Gtkmm2ext::set_source_rgba (cr, c);
                                        cr->rectangle (2, innertop + y + .5, m_r - 4 - anw, 1);
                                        cr->fill ();
                        }
@@ -710,6 +823,14 @@ ExportReport::init (const AnalysisResults & ar, bool with_file)
                        wtbl->attach (*sp, 0, 1, wrow, wrow + 1, SHRINK, SHRINK);
                        wtbl->attach (*an, 1, 2, wrow, wrow + 1, SHRINK, SHRINK);
                        ++wrow;
+
+                       if (png_surface) {
+                               Cairo::RefPtr<Cairo::Context> pcx = Cairo::Context::create (png_surface);
+                               pcx->set_source (spec, 0, png_y0);
+                               pcx->paint ();
+                               pcx->set_source (scale, png_w - m_r, png_y0);
+                               pcx->paint ();
+                       }
                }
 
                timeline[page] = playhead_widgets;
@@ -724,6 +845,13 @@ ExportReport::init (const AnalysisResults & ar, bool with_file)
                img->hide();
                pages.pages ().push_back (Notebook_Helpers::TabElem (*vb, *tab));
                pages.signal_switch_page().connect (sigc::mem_fun (*this, &ExportReport::on_switch_page));
+
+               if (png_surface) {
+                       assert (with_file && !path.empty ());
+                       std::string imgpath = Glib::build_filename (Glib::path_get_dirname (path), PBD::basename_nosuffix (path) + ".png");
+                       PBD::info << string_compose(_("Writing Export Analysis Image: %1."), imgpath) << endmsg;
+                       png_surface->write_to_png (imgpath);
+               }
        }
 
        pages.set_show_tabs (true);
@@ -837,7 +965,7 @@ ExportReport::audition (std::string path, unsigned n_chn, int page)
                                SourceFactory::createExternal (DataType::AUDIO, *_session,
                                                                                 path, n,
                                                                                 Source::Flag (ARDOUR::AudioFileSource::NoPeakFile), false));
-                       if (afs->sample_rate() != _session->nominal_frame_rate()) {
+                       if (afs->sample_rate() != _session->nominal_sample_rate()) {
                                boost::shared_ptr<SrcFileSource> sfs (new SrcFileSource(*_session, afs, ARDOUR::SrcGood));
                                srclist.push_back(sfs);
                        } else {
@@ -910,7 +1038,7 @@ ExportReport::on_switch_page (GtkNotebookPage*, guint page_num)
 }
 
 void
-ExportReport::audition_progress (framecnt_t pos, framecnt_t len)
+ExportReport::audition_progress (samplecnt_t pos, samplecnt_t len)
 {
        if (_audition_num == _page_num && timeline.find (_audition_num) != timeline.end ()) {
                const float p = (float)pos / len;
@@ -949,11 +1077,10 @@ ExportReport::on_rectivied_toggled (Gtk::ToggleButton* b)
 }
 
 void
-ExportReport::draw_waveform (Cairo::RefPtr<Cairo::ImageSurface>& wave, ExportAnalysisPtr p, uint32_t c, int m_l, size_t width, int anw, int height, bool log, bool rect)
+ExportReport::draw_waveform (Cairo::RefPtr<Cairo::ImageSurface>& wave, ExportAnalysisPtr p, uint32_t c, int m_l, size_t width, int anw, int height_2, bool log, bool rect)
 {
        int w, h;
        Glib::RefPtr<Pango::Layout> layout = Pango::Layout::create (get_pango_context ());
-       const float height_2 = std::min (100, 8 * height / (int) p->n_channels); // TODO refine
        const float ht = 2.f * height_2;
 
        std::vector<double> dashes;
@@ -1030,7 +1157,7 @@ ExportReport::draw_waveform (Cairo::RefPtr<Cairo::ImageSurface>& wave, ExportAna
                }
        }
 
-       // > 0dBFS
+       // >= 0dBFS
        cr->set_source_rgba (1.0, 0, 0, 1.0);
        for (size_t x = 0 ; x < width; ++x) {
                if (p->peaks[c][x].max >= 1.0) {
@@ -1044,9 +1171,9 @@ ExportReport::draw_waveform (Cairo::RefPtr<Cairo::ImageSurface>& wave, ExportAna
        }
        cr->stroke ();
 
-       // > -1dBTP
+       // >= -1dBTP (coeff >= .89125, libs/vamp-plugins/TruePeak.cpp)
        cr->set_source_rgba (1.0, 0.7, 0, 0.7);
-       for (std::set<framepos_t>::const_iterator i = p->truepeakpos[c].begin (); i != p->truepeakpos[c].end (); ++i) {
+       for (std::set<samplepos_t>::const_iterator i = p->truepeakpos[c].begin (); i != p->truepeakpos[c].end (); ++i) {
                cr->move_to (m_l + (*i) - .5, clip_top);
                cr->line_to (m_l + (*i) - .5, clip_bot);
                cr->stroke ();