Patch from colinf to fix crash on stem export of 4-channel tracks (#4750).
[ardour.git] / libs / ardour / export_graph_builder.cc
index 738f888b3d817643d2d9a9db24303f872be9c342..8152ff0c20d1700e54cfe98d35a49372cca5c553 100644 (file)
 #include "ardour/export_channel_configuration.h"
 #include "ardour/export_filename.h"
 #include "ardour/export_format_specification.h"
+#include "ardour/export_timespan.h"
 #include "ardour/sndfile_helpers.h"
+#include "ardour/utils.h"
 
 #include "pbd/filesystem.h"
+#include "pbd/cpus.h"
 
 using namespace AudioGrapher;
+using std::string;
 
 namespace ARDOUR {
 
 ExportGraphBuilder::ExportGraphBuilder (Session const & session)
   : session (session)
-  , thread_pool (4) // FIXME thread amount to cores amount
+  , thread_pool (hardware_concurrency())
 {
        process_buffer_frames = session.engine().frames_per_cycle();
-       process_buffer = new Sample[process_buffer_frames];
 }
 
 ExportGraphBuilder::~ExportGraphBuilder ()
 {
-       delete [] process_buffer;
 }
 
 int
-ExportGraphBuilder::process (nframes_t /* frames */, bool last_cycle)
+ExportGraphBuilder::process (framecnt_t frames, bool last_cycle)
 {
+       assert(frames <= process_buffer_frames);
+
        for (ChannelMap::iterator it = channels.begin(); it != channels.end(); ++it) {
-               it->first->read (process_buffer, process_buffer_frames);
-               ProcessContext<Sample> context(process_buffer, process_buffer_frames, 1);
-               if (last_cycle) { context.set_flag (ProcessContext<Sample>::EndOfInput); }
+               Sample const * process_buffer = 0;
+               it->first->read (process_buffer, frames);
+               ConstProcessContext<Sample> context(process_buffer, frames, 1);
+               if (last_cycle) { context().set_flag (ProcessContext<Sample>::EndOfInput); }
                it->second->process (context);
        }
-       
+
        return 0;
 }
 
@@ -59,20 +64,81 @@ ExportGraphBuilder::process_normalize ()
                        ++it;
                }
        }
-       
+
        return normalizers.empty();
 }
 
+unsigned
+ExportGraphBuilder::get_normalize_cycle_count() const
+{
+       unsigned max = 0;
+       for (std::list<Normalizer *>::const_iterator it = normalizers.begin(); it != normalizers.end(); ++it) {
+               max = std::max(max, (*it)->get_normalize_cycle_count());
+       }
+       return max;
+}
+
 void
 ExportGraphBuilder::reset ()
 {
+       timespan.reset();
        channel_configs.clear ();
        channels.clear ();
        normalizers.clear ();
 }
 
+void
+ExportGraphBuilder::set_current_timespan (boost::shared_ptr<ExportTimespan> span)
+{
+       timespan = span;
+}
+
 void
 ExportGraphBuilder::add_config (FileSpec const & config)
+{
+       ExportChannelConfiguration::ChannelList const & channels =
+               config.channel_config->get_channels();
+       for(ExportChannelConfiguration::ChannelList::const_iterator it = channels.begin();
+           it != channels.end(); ++it) {
+               (*it)->set_max_buffer_size(process_buffer_frames);
+       }
+
+       // If the sample rate is "session rate", change it to the real value.
+       // However, we need to copy it to not change the config which is saved...
+       FileSpec new_config (config);
+       new_config.format.reset(new ExportFormatSpecification(*new_config.format));
+       if(new_config.format->sample_rate() == ExportFormatBase::SR_Session) {
+               framecnt_t session_rate = session.nominal_frame_rate();
+               new_config.format->set_sample_rate(ExportFormatBase::nearest_sample_rate(session_rate));
+       }
+
+
+       if (!new_config.channel_config->get_split ()) {
+               add_split_config (new_config);
+               return;
+       }
+
+       // Split channel configurations are split into several channel configurations,
+       // each corresponding to a file, at this stage
+       typedef std::list<boost::shared_ptr<ExportChannelConfiguration> > ConfigList;
+       ConfigList file_configs;
+       new_config.channel_config->configurations_for_files (file_configs);
+
+       unsigned chan = 1;
+       for (ConfigList::iterator it = file_configs.begin(); it != file_configs.end(); ++it, ++chan) {
+               FileSpec copy = new_config;
+               copy.channel_config = *it;
+
+               copy.filename.reset (new ExportFilename (*copy.filename));
+               copy.filename->include_channel = true;
+               copy.filename->set_channel (chan);
+
+               add_split_config (copy);
+       }
+}
+
+void
+ExportGraphBuilder::add_split_config (FileSpec const & config)
 {
        for (ChannelConfigList::iterator it = channel_configs.begin(); it != channel_configs.end(); ++it) {
                if (*it == config) {
@@ -80,11 +146,9 @@ ExportGraphBuilder::add_config (FileSpec const & config)
                        return;
                }
        }
-       
+
        // No duplicate channel config found, create new one
-       channel_configs.push_back (ChannelConfig (*this));
-       ChannelConfig & c_config (channel_configs.back());
-       c_config.init (config, channels);
+       channel_configs.push_back (new ChannelConfig (*this, config, channels));
 }
 
 /* Encoder */
@@ -141,17 +205,18 @@ ExportGraphBuilder::Encoder::init_writer (boost::shared_ptr<AudioGrapher::Sndfil
 {
        unsigned channels = config.channel_config->get_n_chans();
        int format = get_real_format (config);
-       Glib::ustring filename = config.filename->get_path (config.format);
-       
-       writer.reset (new AudioGrapher::SndfileWriter<T> (filename, format, channels, config.format->sample_rate()));
-       writer->FileWritten.connect (sigc::mem_fun (*this, &ExportGraphBuilder::Encoder::copy_files));
+       config.filename->set_channel_config(config.channel_config);
+       string filename = config.filename->get_path (config.format);
+
+       writer.reset (new AudioGrapher::SndfileWriter<T> (filename, format, channels, config.format->sample_rate(), config.broadcast_info));
+       writer->FileWritten.connect_same_thread (copy_files_connection, boost::bind (&ExportGraphBuilder::Encoder::copy_files, this, _1));
 }
 
 void
 ExportGraphBuilder::Encoder::copy_files (std::string orig_path)
 {
        while (filenames.size()) {
-               FilenamePtr & filename = filenames.front();
+               ExportFilenamePtr & filename = filenames.front();
                PBD::sys::copy_file (orig_path, filename->get_path (config.format).c_str());
                filenames.pop_front();
        }
@@ -159,27 +224,37 @@ ExportGraphBuilder::Encoder::copy_files (std::string orig_path)
 
 /* SFC */
 
-ExportGraphBuilder::FloatSinkPtr
-ExportGraphBuilder::SFC::init (FileSpec const & new_config, nframes_t max_frames)
+ExportGraphBuilder::SFC::SFC (ExportGraphBuilder &, FileSpec const & new_config, framecnt_t max_frames)
+  : data_width(0)
 {
        config = new_config;
        data_width = sndfile_data_width (Encoder::get_real_format (config));
        unsigned channels = new_config.channel_config->get_n_chans();
-       
+
        if (data_width == 8 || data_width == 16) {
                short_converter = ShortConverterPtr (new SampleFormatConverter<short> (channels));
                short_converter->init (max_frames, config.format->dither_type(), data_width);
                add_child (config);
-               return short_converter;
        } else if (data_width == 24 || data_width == 32) {
                int_converter = IntConverterPtr (new SampleFormatConverter<int> (channels));
                int_converter->init (max_frames, config.format->dither_type(), data_width);
                add_child (config);
-               return int_converter;
        } else {
+               int actual_data_width = 8 * sizeof(Sample);
                float_converter = FloatConverterPtr (new SampleFormatConverter<Sample> (channels));
-               float_converter->init (max_frames, config.format->dither_type(), data_width);
+               float_converter->init (max_frames, config.format->dither_type(), actual_data_width);
                add_child (config);
+       }
+}
+
+ExportGraphBuilder::FloatSinkPtr
+ExportGraphBuilder::SFC::sink ()
+{
+       if (data_width == 8 || data_width == 16) {
+               return short_converter;
+       } else if (data_width == 24 || data_width == 32) {
+               return int_converter;
+       } else {
                return float_converter;
        }
 }
@@ -187,16 +262,16 @@ ExportGraphBuilder::SFC::init (FileSpec const & new_config, nframes_t max_frames
 void
 ExportGraphBuilder::SFC::add_child (FileSpec const & new_config)
 {
-       for (std::list<Encoder>::iterator it = children.begin(); it != children.end(); ++it) {
+       for (boost::ptr_list<Encoder>::iterator it = children.begin(); it != children.end(); ++it) {
                if (*it == new_config) {
                        it->add_child (new_config);
                        return;
                }
        }
-       
-       children.push_back (Encoder());
+
+       children.push_back (new Encoder());
        Encoder & encoder = children.back();
-       
+
        if (data_width == 8 || data_width == 16) {
                short_converter->add_output (encoder.init<short> (new_config));
        } else if (data_width == 24 || data_width == 32) {
@@ -214,43 +289,49 @@ ExportGraphBuilder::SFC::operator== (FileSpec const & other_config) const
 
 /* Normalizer */
 
-ExportGraphBuilder::FloatSinkPtr
-ExportGraphBuilder::Normalizer::init (FileSpec const & new_config, nframes_t /*max_frames*/)
+ExportGraphBuilder::Normalizer::Normalizer (ExportGraphBuilder & parent, FileSpec const & new_config, framecnt_t /*max_frames*/)
+  : parent (parent)
 {
        config = new_config;
-       max_frames_out = 4086; // TODO good chunk size
+       uint32_t const channels = config.channel_config->get_n_chans();
+       max_frames_out = 4086 - (4086 % channels); // TODO good chunk size
        
-       buffer.reset (new AllocatingProcessContext<Sample> (max_frames_out, config.channel_config->get_n_chans()));
+       buffer.reset (new AllocatingProcessContext<Sample> (max_frames_out, channels));
        peak_reader.reset (new PeakReader ());
        normalizer.reset (new AudioGrapher::Normalizer (config.format->normalize_target()));
        threader.reset (new Threader<Sample> (parent.thread_pool));
-       
+
        normalizer->alloc_buffer (max_frames_out);
        normalizer->add_output (threader);
-       
+
        int format = ExportFormatBase::F_RAW | ExportFormatBase::SF_Float;
-       tmp_file.reset (new TmpFile<float> (format, config.channel_config->get_n_chans(), 
-                                           config.format->sample_rate()));
-       tmp_file->FileWritten.connect (sigc::hide (sigc::mem_fun (*this, &Normalizer::start_post_processing)));
-       
+       tmp_file.reset (new TmpFile<float> (format, channels, config.format->sample_rate()));
+       tmp_file->FileWritten.connect_same_thread (post_processing_connection,
+                                                  boost::bind (&Normalizer::start_post_processing, this));
+
        add_child (new_config);
-       
+
        peak_reader->add_output (tmp_file);
+}
+
+ExportGraphBuilder::FloatSinkPtr
+ExportGraphBuilder::Normalizer::sink ()
+{
        return peak_reader;
 }
 
 void
 ExportGraphBuilder::Normalizer::add_child (FileSpec const & new_config)
 {
-       for (std::list<SFC>::iterator it = children.begin(); it != children.end(); ++it) {
+       for (boost::ptr_list<SFC>::iterator it = children.begin(); it != children.end(); ++it) {
                if (*it == new_config) {
                        it->add_child (new_config);
                        return;
                }
        }
-       
-       children.push_back (SFC (parent));
-       threader->add_output (children.back().init (new_config, max_frames_out));
+
+       children.push_back (new SFC (parent, new_config, max_frames_out));
+       threader->add_output (children.back().sink());
 }
 
 bool
@@ -260,10 +341,17 @@ ExportGraphBuilder::Normalizer::operator== (FileSpec const & other_config) const
               config.format->normalize_target() == other_config.format->normalize_target();
 }
 
+unsigned
+ExportGraphBuilder::Normalizer::get_normalize_cycle_count() const
+{
+       return static_cast<unsigned>(std::ceil(static_cast<float>(tmp_file->get_frames_written()) /
+                                              max_frames_out));
+}
+
 bool
 ExportGraphBuilder::Normalizer::process()
 {
-       nframes_t frames_read = tmp_file->read (*buffer);
+       framecnt_t frames_read = tmp_file->read (*buffer);
        return frames_read != buffer->frames();
 }
 
@@ -278,17 +366,21 @@ ExportGraphBuilder::Normalizer::start_post_processing()
 
 /* SRC */
 
-ExportGraphBuilder::FloatSinkPtr
-ExportGraphBuilder::SRC::init (FileSpec const & new_config, nframes_t max_frames)
+ExportGraphBuilder::SRC::SRC (ExportGraphBuilder & parent, FileSpec const & new_config, framecnt_t max_frames)
+  : parent (parent)
 {
        config = new_config;
        converter.reset (new SampleRateConverter (new_config.channel_config->get_n_chans()));
        ExportFormatSpecification & format = *new_config.format;
        converter->init (parent.session.nominal_frame_rate(), format.sample_rate(), format.src_quality());
        max_frames_out = converter->allocate_buffers (max_frames);
-       
+
        add_child (new_config);
-       
+}
+
+ExportGraphBuilder::FloatSinkPtr
+ExportGraphBuilder::SRC::sink ()
+{
        return converter;
 }
 
@@ -304,17 +396,17 @@ ExportGraphBuilder::SRC::add_child (FileSpec const & new_config)
 
 template<typename T>
 void
-ExportGraphBuilder::SRC::add_child_to_list (FileSpec const & new_config, std::list<T> & list)
+ExportGraphBuilder::SRC::add_child_to_list (FileSpec const & new_config, boost::ptr_list<T> & list)
 {
-       for (typename std::list<T>::iterator it = list.begin(); it != list.end(); ++it) {
+       for (typename boost::ptr_list<T>::iterator it = list.begin(); it != list.end(); ++it) {
                if (*it == new_config) {
                        it->add_child (new_config);
                        return;
                }
        }
-       
-       list.push_back (T (parent));
-       converter->add_output (list.back().init (new_config, max_frames_out));
+
+       list.push_back (new T (parent, new_config, max_frames_out));
+       converter->add_output (list.back().sink ());
 }
 
 bool
@@ -324,36 +416,44 @@ ExportGraphBuilder::SRC::operator== (FileSpec const & other_config) const
 }
 
 /* SilenceHandler */
-ExportGraphBuilder::FloatSinkPtr
-ExportGraphBuilder::SilenceHandler::init (FileSpec const & new_config, nframes_t max_frames)
+ExportGraphBuilder::SilenceHandler::SilenceHandler (ExportGraphBuilder & parent, FileSpec const & new_config, framecnt_t max_frames)
+  : parent (parent)
 {
        config = new_config;
        max_frames_in = max_frames;
-       nframes_t sample_rate = parent.session.nominal_frame_rate();
-       
+       framecnt_t sample_rate = parent.session.nominal_frame_rate();
+
        silence_trimmer.reset (new SilenceTrimmer<Sample>(max_frames_in));
        silence_trimmer->set_trim_beginning (config.format->trim_beginning());
        silence_trimmer->set_trim_end (config.format->trim_end());
-       silence_trimmer->add_silence_to_beginning (config.format->silence_beginning(sample_rate));
-       silence_trimmer->add_silence_to_end (config.format->silence_end(sample_rate));
-       
+
+       framecnt_t sb = config.format->silence_beginning_at (parent.timespan->get_start(), sample_rate);
+       framecnt_t se = config.format->silence_end_at (parent.timespan->get_end(), sample_rate);
+
+       silence_trimmer->add_silence_to_beginning (sb);
+       silence_trimmer->add_silence_to_end (se);
+
        add_child (new_config);
-       
+}
+
+ExportGraphBuilder::FloatSinkPtr
+ExportGraphBuilder::SilenceHandler::sink ()
+{
        return silence_trimmer;
 }
 
 void
 ExportGraphBuilder::SilenceHandler::add_child (FileSpec const & new_config)
 {
-       for (std::list<SRC>::iterator it = children.begin(); it != children.end(); ++it) {
+       for (boost::ptr_list<SRC>::iterator it = children.begin(); it != children.end(); ++it) {
                if (*it == new_config) {
                        it->add_child (new_config);
                        return;
                }
        }
-       
-       children.push_back (SRC (parent));
-       silence_trimmer->add_output (children.back().init (new_config, max_frames_in));
+
+       children.push_back (new SRC (parent, new_config, max_frames_in));
+       silence_trimmer->add_output (children.back().sink());
 }
 
 bool
@@ -363,23 +463,23 @@ ExportGraphBuilder::SilenceHandler::operator== (FileSpec const & other_config) c
        ExportFormatSpecification & other_format = *other_config.format;
        return (format.trim_beginning() == other_format.trim_beginning()) &&
               (format.trim_end() == other_format.trim_end()) &&
-              (format.silence_beginning() == other_format.silence_beginning()) &&
-              (format.silence_end() == other_format.silence_end());
+              (format.silence_beginning_time() == other_format.silence_beginning_time()) &&
+              (format.silence_end_time() == other_format.silence_end_time());
 }
 
 /* ChannelConfig */
 
-void
-ExportGraphBuilder::ChannelConfig::init (FileSpec const & new_config, ChannelMap & channel_map)
+ExportGraphBuilder::ChannelConfig::ChannelConfig (ExportGraphBuilder & parent, FileSpec const & new_config, ChannelMap & channel_map)
+  : parent (parent)
 {
        typedef ExportChannelConfiguration::ChannelList ChannelList;
-       
+
        config = new_config;
        max_frames = parent.session.engine().frames_per_cycle();
-       
+
        interleaver.reset (new Interleaver<Sample> ());
        interleaver->init (new_config.channel_config->get_n_chans(), max_frames);
-       
+
        ChannelList const & channel_list = config.channel_config->get_channels();
        unsigned chan = 0;
        for (ChannelList::const_iterator it = channel_list.begin(); it != channel_list.end(); ++it, ++chan) {
@@ -392,23 +492,23 @@ ExportGraphBuilder::ChannelConfig::init (FileSpec const & new_config, ChannelMap
                }
                map_it->second->add_output (interleaver->input (chan));
        }
-       
+
        add_child (new_config);
 }
 
 void
 ExportGraphBuilder::ChannelConfig::add_child (FileSpec const & new_config)
 {
-       for (std::list<SilenceHandler>::iterator it = children.begin(); it != children.end(); ++it) {
+       for (boost::ptr_list<SilenceHandler>::iterator it = children.begin(); it != children.end(); ++it) {
                if (*it == new_config) {
                        it->add_child (new_config);
                        return;
                }
        }
-       
-       children.push_back (SilenceHandler (parent));
-       nframes_t max_frames_out = new_config.channel_config->get_n_chans() * max_frames;
-       interleaver->add_output (children.back().init (new_config, max_frames_out));
+
+       framecnt_t const max_frames_out = new_config.channel_config->get_n_chans() * max_frames;
+       children.push_back (new SilenceHandler (parent, new_config, max_frames_out));
+       interleaver->add_output (children.back().sink ());
 }
 
 bool