No-op; fix GPL address and use the explicit-program-name version.
[dcpomatic.git] / src / wx / audio_mapping_view.cc
index f5d0ecae26e67a54715ecfe093f8bd4fc0b8e1e1..8d39a40ff91c7de810f6a70854e922d0da694df2 100644 (file)
@@ -1,46 +1,54 @@
 /*
-    Copyright (C) 2013 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2013-2015 Carl Hetherington <cth@carlh.net>
 
-    This program is free software; you can redistribute it and/or modify
+    This file is part of DCP-o-matic.
+
+    DCP-o-matic is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
     the Free Software Foundation; either version 2 of the License, or
     (at your option) any later version.
 
-    This program is distributed in the hope that it will be useful,
+    DCP-o-matic is distributed in the hope that it will be useful,
     but WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
     GNU General Public License for more details.
 
     You should have received a copy of the GNU General Public License
-    along with this program; if not, write to the Free Software
-    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+    along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
 
 */
 
-#include <wx/wx.h>
-#include <wx/renderer.h>
-#include <wx/grid.h>
-#include <libdcp/types.h>
+/** @file  src/wx/audio_mapping_view.cc
+ *  @brief AudioMappingView class and helpers.
+ */
+
 #include "lib/audio_mapping.h"
 #include "lib/util.h"
+#include "lib/raw_convert.h"
 #include "audio_mapping_view.h"
 #include "wx_util.h"
+#include "audio_gain_dialog.h"
+#include <dcp/types.h>
+#include <wx/wx.h>
+#include <wx/renderer.h>
+#include <wx/grid.h>
+#include <iostream>
 
 using std::cout;
 using std::list;
+using std::string;
+using std::max;
+using std::vector;
 using boost::shared_ptr;
 
-/* This could go away with wxWidgets 2.9, which has an API call
-   to find these values.
-*/
+#define INDICATOR_SIZE 16
 
-#ifdef __WXMSW__
-#define CHECKBOX_WIDTH 16
-#define CHECKBOX_HEIGHT 16
-#else
-#define CHECKBOX_WIDTH 20
-#define CHECKBOX_HEIGHT 20
-#endif
+enum {
+       ID_off = 1,
+       ID_full = 2,
+       ID_minus6dB = 3,
+       ID_edit = 4
+};
 
 class NoSelectionStringRenderer : public wxGridCellStringRenderer
 {
@@ -51,54 +59,103 @@ public:
        }
 };
 
-class CheckBoxRenderer : public wxGridCellRenderer
+/** @class ValueRenderer
+ *  @brief wxGridCellRenderer for a gain value.
+ */
+class ValueRenderer : public wxGridCellRenderer
 {
 public:
 
        void Draw (wxGrid& grid, wxGridCellAttr &, wxDC& dc, const wxRect& rect, int row, int col, bool)
        {
-               dc.SetPen (*wxThePenList->FindOrCreatePen (wxColour (255, 255, 255), 0, wxPENSTYLE_SOLID));
+               dc.SetPen (*wxThePenList->FindOrCreatePen (wxColour (255, 255, 255), 1, wxPENSTYLE_SOLID));
+               dc.SetBrush (*wxTheBrushList->FindOrCreateBrush (wxColour (255, 255, 255), wxBRUSHSTYLE_SOLID));
                dc.DrawRectangle (rect);
-               
-               wxRendererNative::Get().DrawCheckBox (
-                       &grid,
-                       dc, rect,
-                       grid.GetCellValue (row, col) == wxT("1") ? static_cast<int>(wxCONTROL_CHECKED) : 0
-                       );
+
+               int const xo = (rect.GetWidth() - INDICATOR_SIZE) / 2;
+               int const yo = (rect.GetHeight() - INDICATOR_SIZE) / 2;
+
+               dc.SetPen (*wxThePenList->FindOrCreatePen (wxColour (0, 0, 0), 1, wxPENSTYLE_SOLID));
+               dc.SetBrush (*wxTheBrushList->FindOrCreateBrush (wxColour (255, 255, 255), wxBRUSHSTYLE_SOLID));
+               dc.DrawRectangle (wxRect (rect.GetLeft() + xo, rect.GetTop() + yo, INDICATOR_SIZE, INDICATOR_SIZE));
+
+               float const value = raw_convert<float> (wx_to_std (grid.GetCellValue (row, col)));
+               float const value_dB = 20 * log10 (value);
+               int const range = 18;
+               int height = 0;
+               if (value_dB > -range) {
+                       height = INDICATOR_SIZE * (1 + value_dB / range);
+               }
+
+               height = max (0, height);
+
+               if (value > 0) {
+                       /* Make sure we get a little bit of the marker if there is any gain */
+                       height = max (3, height);
+               }
+
+               dc.SetBrush (*wxTheBrushList->FindOrCreateBrush (wxColour (0, 255, 0), wxBRUSHSTYLE_SOLID));
+               dc.DrawRectangle (wxRect (rect.GetLeft() + xo, rect.GetTop() + yo + INDICATOR_SIZE - height, INDICATOR_SIZE, height));
        }
 
        wxSize GetBestSize (wxGrid &, wxGridCellAttr &, wxDC &, int, int)
        {
-               return wxSize (CHECKBOX_WIDTH + 4, CHECKBOX_HEIGHT + 4);
+               return wxSize (INDICATOR_SIZE + 4, INDICATOR_SIZE + 4);
        }
-       
+
        wxGridCellRenderer* Clone () const
        {
-               return new CheckBoxRenderer;
+               return new ValueRenderer;
        }
 };
 
 
 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, 7);
+       _grid->CreateGrid (0, MAX_DCP_AUDIO_CHANNELS + 1);
        _grid->HideRowLabels ();
        _grid->DisableDragRowSize ();
        _grid->DisableDragColSize ();
        _grid->EnableEditing (false);
        _grid->SetCellHighlightPenWidth (0);
        _grid->SetDefaultRenderer (new NoSelectionStringRenderer);
-
-       set_column_labels ();
+       _grid->AutoSize ();
 
        _sizer = new wxBoxSizer (wxVERTICAL);
        _sizer->Add (_grid, 1, wxEXPAND | wxALL);
        SetSizerAndFit (_sizer);
 
-       Connect (wxID_ANY, wxEVT_GRID_CELL_LEFT_CLICK, wxGridEventHandler (AudioMappingView::left_click), 0, this);
+       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));
+       Bind (wxEVT_SIZE, boost::bind (&AudioMappingView::sized, this, _1));
+
+       _menu = new wxMenu;
+       _menu->Append (ID_off, _("Off"));
+       _menu->Append (ID_full, _("Full"));
+       _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::minus6dB, this), ID_minus6dB);
+       Bind (wxEVT_COMMAND_MENU_SELECTED, boost::bind (&AudioMappingView::edit, this), ID_edit);
+}
+
+/** Called when any gain value has changed */
+void
+AudioMappingView::map_values_changed ()
+{
+       update_cells ();
+       Changed (_map);
+       _last_tooltip_column = -1;
 }
 
 void
@@ -107,101 +164,171 @@ AudioMappingView::left_click (wxGridEvent& ev)
        if (ev.GetCol() == 0) {
                return;
        }
-       
-       if (_grid->GetCellValue (ev.GetRow(), ev.GetCol()) == wxT("1")) {
-               _grid->SetCellValue (ev.GetRow(), ev.GetCol(), wxT("0"));
+
+       int const d = ev.GetCol() - 1;
+
+       if (_map.get (ev.GetRow(), d) > 0) {
+               _map.set (ev.GetRow(), d, 0);
        } else {
-               _grid->SetCellValue (ev.GetRow(), ev.GetCol(), wxT("1"));
+               _map.set (ev.GetRow(), d, 1);
        }
 
-       _map = AudioMapping (_map.content_channels ());
-       
-       for (int i = 0; i < _grid->GetNumberRows(); ++i) {
-               for (int j = 1; j < _grid->GetNumberCols(); ++j) {
-                       if (_grid->GetCellValue (i, j) == wxT ("1")) {
-                               _map.add (i, static_cast<libdcp::Channel> (j - 1));
-                       }
-               }
+       map_values_changed ();
+}
+
+void
+AudioMappingView::right_click (wxGridEvent& ev)
+{
+       if (ev.GetCol() == 0) {
+               return;
        }
 
-       Changed (_map);
+       _menu_row = ev.GetRow ();
+       _menu_column = ev.GetCol ();
+       PopupMenu (_menu, ev.GetPosition ());
 }
 
 void
-AudioMappingView::set (AudioMapping map)
+AudioMappingView::off ()
 {
-       _map = map;
-       
-       if (_grid->GetNumberRows ()) {
-               _grid->DeleteRows (0, _grid->GetNumberRows ());
-       }
+       _map.set (_menu_row, _menu_column - 1, 0);
+       map_values_changed ();
+}
 
-       _grid->InsertRows (0, _map.content_channels ());
+void
+AudioMappingView::full ()
+{
+       _map.set (_menu_row, _menu_column - 1, 1);
+       map_values_changed ();
+}
 
-       for (int r = 0; r < _map.content_channels(); ++r) {
-               for (int c = 1; c < 7; ++c) {
-                       _grid->SetCellRenderer (r, c, new CheckBoxRenderer);
-               }
+void
+AudioMappingView::minus6dB ()
+{
+       _map.set (_menu_row, _menu_column - 1, pow (10, -6.0 / 20));
+       map_values_changed ();
+}
+
+void
+AudioMappingView::edit ()
+{
+       int const d = _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 ());
+               map_values_changed ();
        }
-       
-       for (int i = 0; i < _map.content_channels(); ++i) {
-               _grid->SetCellValue (i, 0, wxString::Format (wxT("%d"), i + 1));
 
-               list<libdcp::Channel> const d = _map.content_to_dcp (i);
-               for (list<libdcp::Channel>::const_iterator j = d.begin(); j != d.end(); ++j) {
-                       int const c = static_cast<int>(*j) + 1;
-                       if (c < _grid->GetNumberCols ()) {
-                               _grid->SetCellValue (i, c, wxT("1"));
-                       }
-               }
+       dialog->Destroy ();
+}
+
+void
+AudioMappingView::set (AudioMapping map)
+{
+       _map = map;
+       update_cells ();
+}
+
+void
+AudioMappingView::set_input_channels (vector<string> const & names)
+{
+       for (int i = 0; i < _grid->GetNumberRows(); ++i) {
+               _grid->SetCellValue (i, 0, std_to_wx (names[i]));
        }
 }
 
 void
-AudioMappingView::set_channels (int c)
+AudioMappingView::set_output_channels (vector<string> const & names)
 {
-       c++;
+       int const o = names.size() + 1;
+       if (o < _grid->GetNumberCols ()) {
+               _grid->DeleteCols (o, _grid->GetNumberCols() - o);
+       } else if (o > _grid->GetNumberCols ()) {
+               _grid->InsertCols (_grid->GetNumberCols(), o - _grid->GetNumberCols());
+       }
 
-       if (c < _grid->GetNumberCols ()) {
-               _grid->DeleteCols (c, _grid->GetNumberCols() - c);
-       } else if (c > _grid->GetNumberCols ()) {
-               _grid->InsertCols (_grid->GetNumberCols(), c - _grid->GetNumberCols());
-               set_column_labels ();
+       _grid->SetColLabelValue (0, wxT (""));
+
+       for (size_t i = 0; i < names.size(); ++i) {
+               _grid->SetColLabelValue (i + 1, std_to_wx (names[i]));
        }
 
-       set (_map);
+       update_cells ();
 }
 
 void
-AudioMappingView::set_column_labels ()
+AudioMappingView::update_cells ()
 {
-       int const c = _grid->GetNumberCols ();
-       
-       _grid->SetColLabelValue (0, _("Content channel"));
-       
-       if (c > 0) {
-               _grid->SetColLabelValue (1, _("L"));
+       vector<string> row_names;
+       for (int i = 0; i < _grid->GetNumberRows (); ++i) {
+               row_names.push_back (wx_to_std (_grid->GetCellValue (i, 0)));
        }
-       
-       if (c > 1) {
-               _grid->SetColLabelValue (2, _("R"));
+
+       if (_grid->GetNumberRows ()) {
+               _grid->DeleteRows (0, _grid->GetNumberRows ());
        }
-       
-       if (c > 2) {
-               _grid->SetColLabelValue (3, _("C"));
+
+       _grid->InsertRows (0, _map.input_channels ());
+
+       for (int i = 0; i < _map.input_channels(); ++i) {
+               for (int j = 0; j < _map.output_channels(); ++j) {
+                       _grid->SetCellRenderer (i, j + 1, new ValueRenderer);
+               }
        }
-       
-       if (c > 3) {
-               _grid->SetColLabelValue (4, _("Lfe"));
+
+       for (int i = 0; i < _map.input_channels(); ++i) {
+               if (i < int (row_names.size ())) {
+                       _grid->SetCellValue (i, 0, std_to_wx (row_names[i]));
+               }
+               for (int j = 1; j < _grid->GetNumberCols(); ++j) {
+                       _grid->SetCellValue (i, j, std_to_wx (raw_convert<string> (_map.get (i, j - 1))));
+               }
        }
-       
-       if (c > 4) {
-               _grid->SetColLabelValue (5, _("Ls"));
+
+       _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 (c > 5) {
-               _grid->SetColLabelValue (6, _("Rs"));
+
+       if (row != _last_tooltip_row || column != _last_tooltip_column) {
+
+               wxString s;
+               float const gain = _map.get (row, 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 ();
+}
+
+void
+AudioMappingView::sized (wxSizeEvent& ev)
+{
        _grid->AutoSize ();
+       ev.Skip ();
 }