Merge master.
[dcpomatic.git] / src / wx / audio_mapping_view.cc
index 54749845d6977146313c74d94d265df43a10a72d..c65eadd5a0676c9122ee968b8f902fe774a399ff 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2013 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2013-2014 Carl Hetherington <cth@carlh.net>
 
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
 
 */
 
+/** @file  src/wx/audio_mapping_view.cc
+ *  @brief AudioMappingView class and helpers.
+ */
+
 #include <wx/wx.h>
 #include <wx/renderer.h>
 #include <wx/grid.h>
-#include <libdcp/types.h>
+#include <dcp/types.h>
 #include "lib/audio_mapping.h"
 #include "lib/util.h"
 #include "audio_mapping_view.h"
 #include "wx_util.h"
 #include "audio_gain_dialog.h"
+#include <boost/lexical_cast.hpp>
 
 using std::cout;
 using std::list;
@@ -34,12 +39,12 @@ using std::max;
 using boost::shared_ptr;
 using boost::lexical_cast;
 
-#define INDICATOR_SIZE 20
+#define INDICATOR_SIZE 16
 
 enum {
        ID_off = 1,
        ID_full = 2,
-       ID_minus3dB = 3,
+       ID_minus6dB = 3,
        ID_edit = 4
 };
 
@@ -52,6 +57,9 @@ public:
        }
 };
 
+/** @class ValueRenderer
+ *  @brief wxGridCellRenderer for a gain value.
+ */
 class ValueRenderer : public wxGridCellRenderer
 {
 public:
@@ -104,10 +112,12 @@ AudioMappingView::AudioMappingView (wxWindow* parent)
        : wxPanel (parent, wxID_ANY)
        , _menu_row (0)
        , _menu_column (1)
+       , _last_tooltip_row (0)
+       , _last_tooltip_column (0)
 {
        _grid = new wxGrid (this, wxID_ANY);
 
-       _grid->CreateGrid (0, MAX_AUDIO_CHANNELS + 1);
+       _grid->CreateGrid (0, MAX_DCP_AUDIO_CHANNELS + 1);
        _grid->HideRowLabels ();
        _grid->DisableDragRowSize ();
        _grid->DisableDragColSize ();
@@ -123,19 +133,28 @@ AudioMappingView::AudioMappingView (wxWindow* parent)
 
        Bind (wxEVT_GRID_CELL_LEFT_CLICK, boost::bind (&AudioMappingView::left_click, this, _1));
        Bind (wxEVT_GRID_CELL_RIGHT_CLICK, boost::bind (&AudioMappingView::right_click, this, _1));
+       _grid->GetGridWindow()->Bind (wxEVT_MOTION, boost::bind (&AudioMappingView::mouse_moved, this, _1));
 
        _menu = new wxMenu;
        _menu->Append (ID_off, _("Off"));
        _menu->Append (ID_full, _("Full"));
-       _menu->Append (ID_minus3dB, _("-3dB"));
+       _menu->Append (ID_minus6dB, _("-6dB"));
        _menu->Append (ID_edit, _("Edit..."));
 
        Bind (wxEVT_COMMAND_MENU_SELECTED, boost::bind (&AudioMappingView::off, this), ID_off);
        Bind (wxEVT_COMMAND_MENU_SELECTED, boost::bind (&AudioMappingView::full, this), ID_full);
-       Bind (wxEVT_COMMAND_MENU_SELECTED, boost::bind (&AudioMappingView::minus3dB, this), ID_minus3dB);
+       Bind (wxEVT_COMMAND_MENU_SELECTED, boost::bind (&AudioMappingView::minus6dB, this), ID_minus6dB);
        Bind (wxEVT_COMMAND_MENU_SELECTED, boost::bind (&AudioMappingView::edit, this), ID_edit);
 }
 
+void
+AudioMappingView::map_changed ()
+{
+       update_cells ();
+       Changed (_map);
+       _last_tooltip_column = -1;
+}      
+
 void
 AudioMappingView::left_click (wxGridEvent& ev)
 {
@@ -143,7 +162,7 @@ AudioMappingView::left_click (wxGridEvent& ev)
                return;
        }
 
-       libdcp::Channel d = static_cast<libdcp::Channel> (ev.GetCol() - 1);
+       dcp::Channel d = static_cast<dcp::Channel> (ev.GetCol() - 1);
        
        if (_map.get (ev.GetRow(), d) > 0) {
                _map.set (ev.GetRow(), d, 0);
@@ -151,8 +170,7 @@ AudioMappingView::left_click (wxGridEvent& ev)
                _map.set (ev.GetRow(), d, 1);
        }
 
-       update_cells ();
-       Changed (_map);
+       map_changed ();
 }
 
 void
@@ -170,37 +188,33 @@ AudioMappingView::right_click (wxGridEvent& ev)
 void
 AudioMappingView::off ()
 {
-       _map.set (_menu_row, static_cast<libdcp::Channel> (_menu_column - 1), 0);
-       update_cells ();
-       Changed (_map);
+       _map.set (_menu_row, static_cast<dcp::Channel> (_menu_column - 1), 0);
+       map_changed ();
 }
 
 void
 AudioMappingView::full ()
 {
-       _map.set (_menu_row, static_cast<libdcp::Channel> (_menu_column - 1), 1);
-       update_cells ();
-       Changed (_map);
+       _map.set (_menu_row, static_cast<dcp::Channel> (_menu_column - 1), 1);
+       map_changed ();
 }
 
 void
-AudioMappingView::minus3dB ()
+AudioMappingView::minus6dB ()
 {
-       _map.set (_menu_row, static_cast<libdcp::Channel> (_menu_column - 1), 1 / sqrt (2));
-       update_cells ();
-       Changed (_map);
+       _map.set (_menu_row, static_cast<dcp::Channel> (_menu_column - 1), pow (10, -6.0 / 20));
+       map_changed ();
 }
 
 void
 AudioMappingView::edit ()
 {
-       libdcp::Channel d = static_cast<libdcp::Channel> (_menu_column - 1);
+       dcp::Channel d = static_cast<dcp::Channel> (_menu_column - 1);
        
        AudioGainDialog* dialog = new AudioGainDialog (this, _menu_row, _menu_column - 1, _map.get (_menu_row, d));
        if (dialog->ShowModal () == wxID_OK) {
                _map.set (_menu_row, d, dialog->value ());
-               update_cells ();
-               Changed (_map);
+               map_changed ();
        }
        
        dialog->Destroy ();
@@ -223,7 +237,7 @@ AudioMappingView::update_cells ()
        _grid->InsertRows (0, _map.content_channels ());
 
        for (int i = 0; i < _map.content_channels(); ++i) {
-               for (int j = 0; j < MAX_AUDIO_CHANNELS; ++j) {
+               for (int j = 0; j < MAX_DCP_AUDIO_CHANNELS; ++j) {
                        _grid->SetCellRenderer (i, j + 1, new ValueRenderer);
                }
        }
@@ -232,7 +246,7 @@ AudioMappingView::update_cells ()
                _grid->SetCellValue (i, 0, wxString::Format (wxT("%d"), i + 1));
 
                for (int j = 1; j < _grid->GetNumberCols(); ++j) {
-                       _grid->SetCellValue (i, j, std_to_wx (lexical_cast<string> (_map.get (i, static_cast<libdcp::Channel> (j - 1)))));
+                       _grid->SetCellValue (i, j, std_to_wx (lexical_cast<string> (_map.get (i, static_cast<dcp::Channel> (j - 1)))));
                }
        }
 
@@ -260,7 +274,11 @@ AudioMappingView::set_column_labels ()
 {
        int const c = _grid->GetNumberCols ();
        
-       _grid->SetColLabelValue (0, _("Content channel"));
+       _grid->SetColLabelValue (0, _("Content"));
+
+#if MAX_DCP_AUDIO_CHANNELS != 12
+#warning AudioMappingView::set_column_labels() is expecting the wrong MAX_DCP_AUDIO_CHANNELS
+#endif 
        
        if (c > 0) {
                _grid->SetColLabelValue (1, _("L"));
@@ -286,5 +304,66 @@ AudioMappingView::set_column_labels ()
                _grid->SetColLabelValue (6, _("Rs"));
        }
 
+       if (c > 6) {
+               _grid->SetColLabelValue (7, _("HI"));
+       }
+
+       if (c > 7) {
+               _grid->SetColLabelValue (8, _("VI"));
+       }
+
+       if (c > 8) {
+               _grid->SetColLabelValue (9, _("Lc"));
+       }
+
+       if (c > 9) {
+               _grid->SetColLabelValue (10, _("Rc"));
+       }
+
+       if (c > 10) {
+               _grid->SetColLabelValue (11, _("BsL"));
+       }
+
+       if (c > 11) {
+               _grid->SetColLabelValue (12, _("BsR"));
+       }
+
        _grid->AutoSize ();
 }
+
+void
+AudioMappingView::mouse_moved (wxMouseEvent& ev)
+{
+       int xx;
+       int yy;
+       _grid->CalcUnscrolledPosition (ev.GetX(), ev.GetY(), &xx, &yy);
+
+       int const row = _grid->YToRow (yy);
+       int const column = _grid->XToCol (xx);
+
+       if (row < 0 || column < 1) {
+               _grid->GetGridWindow()->SetToolTip ("");
+               _last_tooltip_row = row;
+               _last_tooltip_column = column;
+       }
+
+       if (row != _last_tooltip_row || column != _last_tooltip_column) {
+
+               wxString s;
+               float const gain = _map.get (row, static_cast<dcp::Channel> (column - 1));
+               if (gain == 0) {
+                       s = wxString::Format (_("No audio will be passed from content channel %d to DCP channel %d."), row + 1, column);
+               } else if (gain == 1) {
+                       s = wxString::Format (_("Audio will be passed from content channel %d to DCP channel %d unaltered."), row + 1, column);
+               } else {
+                       float const dB = 20 * log10 (gain);
+                       s = wxString::Format (_("Audio will be passed from content channel %d to DCP channel %d with gain %.1fdB."), row + 1, column, dB);
+               }
+               
+               _grid->GetGridWindow()->SetToolTip (s + " " + _("Right click to change gain."));
+               _last_tooltip_row = row;
+               _last_tooltip_column = column;
+       }
+
+        ev.Skip ();
+}