2014-01-06 Carl Hetherington <cth@carlh.net>
+ * Basics of per-channel audio gain (#247).
+
* Give a warning on make DCP if it seems unlikely that the disk
will have enough space to store the finished DCP (#92).
#include <libxml++/libxml++.h>
#include <libcxml/cxml.h>
#include "audio_mapping.h"
+#include "util.h"
using std::list;
using std::cout;
* @param c Number of channels.
*/
AudioMapping::AudioMapping (int c)
- : _content_channels (c)
{
+ setup (c);
+}
+void
+AudioMapping::setup (int c)
+{
+ _content_channels = c;
+
+ _gain.resize (_content_channels);
+ for (int i = 0; i < _content_channels; ++i) {
+ _gain[i].resize (MAX_AUDIO_CHANNELS);
+ }
}
void
AudioMapping::make_default ()
{
+ for (int i = 0; i < _content_channels; ++i) {
+ for (int j = 0; j < MAX_AUDIO_CHANNELS; ++j) {
+ _gain[i][j] = 0;
+ }
+ }
+
if (_content_channels == 1) {
/* Mono -> Centre */
- add (0, libdcp::CENTRE);
+ set (0, libdcp::CENTRE, 1);
} else {
/* 1:1 mapping */
for (int i = 0; i < _content_channels; ++i) {
- add (i, static_cast<libdcp::Channel> (i));
+ set (i, static_cast<libdcp::Channel> (i), 1);
}
}
}
-AudioMapping::AudioMapping (shared_ptr<const cxml::Node> node)
+AudioMapping::AudioMapping (shared_ptr<const cxml::Node> node, int state_version)
{
- _content_channels = node->number_child<int> ("ContentChannels");
-
- list<cxml::NodePtr> const c = node->node_children ("Map");
- for (list<cxml::NodePtr>::const_iterator i = c.begin(); i != c.end(); ++i) {
- add ((*i)->number_child<int> ("ContentIndex"), static_cast<libdcp::Channel> ((*i)->number_child<int> ("DCP")));
+ setup (node->number_child<int> ("ContentChannels"));
+
+ if (state_version <= 5) {
+ /* Old-style: on/off mapping */
+ list<cxml::NodePtr> const c = node->node_children ("Map");
+ for (list<cxml::NodePtr>::const_iterator i = c.begin(); i != c.end(); ++i) {
+ set ((*i)->number_child<int> ("ContentIndex"), static_cast<libdcp::Channel> ((*i)->number_child<int> ("DCP")), 1);
+ }
+ } else {
+ list<cxml::NodePtr> const c = node->node_children ("Gain");
+ for (list<cxml::NodePtr>::const_iterator i = c.begin(); i != c.end(); ++i) {
+ set (
+ (*i)->number_attribute<int> ("Content"),
+ static_cast<libdcp::Channel> ((*i)->number_attribute<int> ("DCP")),
+ lexical_cast<float> ((*i)->content ())
+ );
+ }
}
}
void
-AudioMapping::add (int c, libdcp::Channel d)
+AudioMapping::set (int c, libdcp::Channel d, float g)
{
- _content_to_dcp.push_back (make_pair (c, d));
+ _gain[c][d] = g;
}
-list<int>
-AudioMapping::dcp_to_content (libdcp::Channel d) const
+float
+AudioMapping::get (int c, libdcp::Channel d) const
{
- list<int> c;
- for (list<pair<int, libdcp::Channel> >::const_iterator i = _content_to_dcp.begin(); i != _content_to_dcp.end(); ++i) {
- if (i->second == d) {
- c.push_back (i->first);
- }
- }
-
- return c;
-}
-
-list<libdcp::Channel>
-AudioMapping::content_to_dcp (int c) const
-{
- assert (c < _content_channels);
-
- list<libdcp::Channel> d;
- for (list<pair<int, libdcp::Channel> >::const_iterator i = _content_to_dcp.begin(); i != _content_to_dcp.end(); ++i) {
- if (i->first == c) {
- d.push_back (i->second);
- }
- }
-
- return d;
+ return _gain[c][d];
}
void
AudioMapping::as_xml (xmlpp::Node* node) const
{
node->add_child ("ContentChannels")->add_child_text (lexical_cast<string> (_content_channels));
-
- for (list<pair<int, libdcp::Channel> >::const_iterator i = _content_to_dcp.begin(); i != _content_to_dcp.end(); ++i) {
- xmlpp::Node* t = node->add_child ("Map");
- t->add_child ("ContentIndex")->add_child_text (lexical_cast<string> (i->first));
- t->add_child ("DCP")->add_child_text (lexical_cast<string> (i->second));
+
+ for (int c = 0; c < _content_channels; ++c) {
+ for (int d = 0; d < MAX_AUDIO_CHANNELS; ++d) {
+ xmlpp::Element* t = node->add_child ("Gain");
+ t->set_attribute ("Content", lexical_cast<string> (c));
+ t->set_attribute ("DCP", lexical_cast<string> (d));
+ t->add_child_text (lexical_cast<string> (get (c, static_cast<libdcp::Channel> (d))));
+ }
}
}
#ifndef DCPOMATIC_AUDIO_MAPPING_H
#define DCPOMATIC_AUDIO_MAPPING_H
-#include <list>
+#include <vector>
#include <libdcp/types.h>
#include <boost/shared_ptr.hpp>
/** A many-to-many mapping from some content channels to DCP channels.
* The number of content channels is set on construction and fixed,
- * and then each of those content channels can be mapped to zero or
- * more DCP channels.
+ * and then each of those content channels are mapped to each DCP channel
+ * by a linear gain.
*/
class AudioMapping
{
public:
AudioMapping ();
AudioMapping (int);
- AudioMapping (boost::shared_ptr<const cxml::Node>);
+ AudioMapping (boost::shared_ptr<const cxml::Node>, int);
/* Default copy constructor is fine */
void as_xml (xmlpp::Node *) const;
- void add (int, libdcp::Channel);
void make_default ();
- std::list<int> dcp_to_content (libdcp::Channel) const;
- std::list<std::pair<int, libdcp::Channel> > content_to_dcp () const {
- return _content_to_dcp;
- }
+ void set (int, libdcp::Channel, float);
+ float get (int, libdcp::Channel) const;
int content_channels () const {
return _content_channels;
}
- std::list<libdcp::Channel> content_to_dcp (int) const;
-
private:
+ void setup (int);
+
int _content_channels;
- std::list<std::pair<int, libdcp::Channel> > _content_to_dcp;
+ std::vector<std::vector<float> > _gain;
};
#endif
FFmpegAudioStream::FFmpegAudioStream (shared_ptr<const cxml::Node> node, int version)
: FFmpegStream (node, version)
- , mapping (node->node_child ("Mapping"))
+ , mapping (node->node_child ("Mapping"), version)
{
frame_rate = node->number_child<int> ("FrameRate");
channels = node->number_child<int64_t> ("Channels");
using libdcp::Size;
using libdcp::Signer;
-int const Film::state_version = 5;
+/* 5 -> 6
+ * AudioMapping XML changed.
+ */
+int const Film::state_version = 6;
/** Construct a Film object in a given directory.
*
/* Remap channels */
shared_ptr<AudioBuffers> dcp_mapped (new AudioBuffers (_film->audio_channels(), audio->frames()));
dcp_mapped->make_silent ();
- list<pair<int, libdcp::Channel> > map = content->audio_mapping().content_to_dcp ();
- for (list<pair<int, libdcp::Channel> >::iterator i = map.begin(); i != map.end(); ++i) {
- if (i->first < audio->channels() && i->second < dcp_mapped->channels()) {
- dcp_mapped->accumulate_channel (audio.get(), i->first, i->second);
+
+ AudioMapping map = content->audio_mapping ();
+ for (int i = 0; i < map.content_channels(); ++i) {
+ for (int j = 0; j < _film->audio_channels(); ++j) {
+ if (map.get (i, static_cast<libdcp::Channel> (j)) > 0) {
+ dcp_mapped->accumulate_channel (
+ audio.get(),
+ i,
+ static_cast<libdcp::Channel> (j),
+ map.get (i, static_cast<libdcp::Channel> (j))
+ );
+ }
}
}
}
-SndfileContent::SndfileContent (shared_ptr<const Film> f, shared_ptr<const cxml::Node> node, int)
+SndfileContent::SndfileContent (shared_ptr<const Film> f, shared_ptr<const cxml::Node> node, int version)
: Content (f, node)
, AudioContent (f, node)
- , _audio_mapping (node->node_child ("AudioMapping"))
+ , _audio_mapping (node->node_child ("AudioMapping"), version)
{
_audio_channels = node->number_child<int> ("AudioChannels");
_audio_length = node->number_child<AudioContent::Frame> ("AudioLength");
#include "lib/util.h"
#include "audio_mapping_view.h"
#include "wx_util.h"
+#include "audio_gain_dialog.h"
using std::cout;
using std::list;
+using std::string;
+using std::max;
using boost::shared_ptr;
+using boost::lexical_cast;
-/* This could go away with wxWidgets 2.9, which has an API call
- to find these values.
-*/
+#define INDICATOR_SIZE 20
-#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_minus3dB = 3,
+ ID_edit = 4
+};
class NoSelectionStringRenderer : public wxGridCellStringRenderer
{
}
};
-class CheckBoxRenderer : public wxGridCellRenderer
+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);
+
+ 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 = lexical_cast<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);
- wxRendererNative::Get().DrawCheckBox (
- &grid,
- dc, rect,
- grid.GetCellValue (row, col) == wxT("1") ? static_cast<int>(wxCONTROL_CHECKED) : 0
- );
+ 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)
{
_grid = new wxGrid (this, wxID_ANY);
- _grid->CreateGrid (0, 7);
+ _grid->CreateGrid (0, MAX_AUDIO_CHANNELS + 1);
_grid->HideRowLabels ();
_grid->DisableDragRowSize ();
_grid->DisableDragColSize ();
SetSizerAndFit (_sizer);
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));
+
+ _menu = new wxMenu;
+ _menu->Append (ID_off, _("Off"));
+ _menu->Append (ID_full, _("Full"));
+ _menu->Append (ID_minus3dB, _("-3dB"));
+ _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::edit, this), ID_edit);
}
void
if (ev.GetCol() == 0) {
return;
}
+
+ libdcp::Channel d = static_cast<libdcp::Channel> (ev.GetCol() - 1);
- if (_grid->GetCellValue (ev.GetRow(), ev.GetCol()) == wxT("1")) {
- _grid->SetCellValue (ev.GetRow(), ev.GetCol(), wxT("0"));
+ 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));
- }
- }
+ update_cells ();
+ Changed (_map);
+}
+
+void
+AudioMappingView::right_click (wxGridEvent& ev)
+{
+ if (ev.GetCol() == 0) {
+ return;
}
+ _menu_row = ev.GetRow ();
+ _menu_column = ev.GetCol ();
+ PopupMenu (_menu, ev.GetPosition ());
+}
+
+void
+AudioMappingView::off ()
+{
+ _map.set (_menu_row, static_cast<libdcp::Channel> (_menu_column - 1), 0);
+ update_cells ();
+ Changed (_map);
+}
+
+void
+AudioMappingView::full ()
+{
+ _map.set (_menu_row, static_cast<libdcp::Channel> (_menu_column - 1), 1);
+ update_cells ();
Changed (_map);
}
+void
+AudioMappingView::minus3dB ()
+{
+ _map.set (_menu_row, static_cast<libdcp::Channel> (_menu_column - 1), 1 / sqrt (2));
+ update_cells ();
+ Changed (_map);
+}
+
+void
+AudioMappingView::edit ()
+{
+ libdcp::Channel d = static_cast<libdcp::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);
+ }
+
+ dialog->Destroy ();
+}
+
void
AudioMappingView::set (AudioMapping map)
{
_map = map;
-
+ update_cells ();
+}
+
+void
+AudioMappingView::update_cells ()
+{
if (_grid->GetNumberRows ()) {
_grid->DeleteRows (0, _grid->GetNumberRows ());
}
_grid->InsertRows (0, _map.content_channels ());
- for (int r = 0; r < _map.content_channels(); ++r) {
- for (int c = 1; c < 7; ++c) {
- _grid->SetCellRenderer (r, c, new CheckBoxRenderer);
+ for (int i = 0; i < _map.content_channels(); ++i) {
+ for (int j = 0; j < MAX_AUDIO_CHANNELS; ++j) {
+ _grid->SetCellRenderer (i, j + 1, new ValueRenderer);
}
}
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"));
- }
+ 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->AutoSize ();
}
+/** @param c Number of DCP channels */
void
AudioMappingView::set_channels (int c)
{
set_column_labels ();
}
- set (_map);
+ update_cells ();
}
void
private:
void left_click (wxGridEvent &);
+ void right_click (wxGridEvent &);
void set_column_labels ();
+ void update_cells ();
+
+ void off ();
+ void full ();
+ void minus3dB ();
+ void edit ();
wxGrid* _grid;
wxSizer* _sizer;
AudioMapping _map;
+
+ wxMenu* _menu;
+ int _menu_row;
+ int _menu_column;
};
case Film::AUDIO_CHANNELS:
_mapping->set_channels (_editor->film()->audio_channels ());
_sizer->Layout ();
+ _sizer->Fit (this);
break;
default:
break;
} else if (property == FFmpegContentProperty::AUDIO_STREAM) {
setup_stream_description ();
_mapping->set (acs ? acs->audio_mapping () : AudioMapping ());
+ _sizer->Layout ();
} else if (property == FFmpegContentProperty::AUDIO_STREAMS) {
_stream->Clear ();
if (fcs) {
sources = """
about_dialog.cc
audio_dialog.cc
+ audio_gain_dialog.cc
audio_mapping_view.cc
audio_panel.cc
audio_plot.cc
BOOST_CHECK_EQUAL (a.channels, 2);
BOOST_CHECK_EQUAL (a.name, "hello there world");
BOOST_CHECK_EQUAL (a.mapping.content_channels(), 2);
- BOOST_CHECK_EQUAL (a.mapping.content_to_dcp().size(), 4);
- list<pair<int, libdcp::Channel> > m = a.mapping.content_to_dcp ();
- list<pair<int, libdcp::Channel> >::iterator i = m.begin();
-
- BOOST_CHECK_EQUAL (i->first, 0);
- BOOST_CHECK_EQUAL (i->second, libdcp::LEFT);
- ++i;
-
- BOOST_CHECK_EQUAL (i->first, 0);
- BOOST_CHECK_EQUAL (i->second, libdcp::CENTRE);
- ++i;
-
- BOOST_CHECK_EQUAL (i->first, 1);
- BOOST_CHECK_EQUAL (i->second, libdcp::RIGHT);
- ++i;
-
- BOOST_CHECK_EQUAL (i->first, 1);
- BOOST_CHECK_EQUAL (i->second, libdcp::CENTRE);
- ++i;
+ BOOST_CHECK_EQUAL (a.mapping.get (0, libdcp::LEFT), 1);
+ BOOST_CHECK_EQUAL (a.mapping.get (0, libdcp::RIGHT), 0);
+ BOOST_CHECK_EQUAL (a.mapping.get (0, libdcp::CENTRE), 1);
+ BOOST_CHECK_EQUAL (a.mapping.get (1, libdcp::LEFT), 0);
+ BOOST_CHECK_EQUAL (a.mapping.get (1, libdcp::RIGHT), 1);
+ BOOST_CHECK_EQUAL (a.mapping.get (1, libdcp::CENTRE), 1);
}