2 Copyright (C) 2008-2012 Paul Davis
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation; either version 2 of the License, or
8 (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software
17 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21 #include "ardour/export_graph_builder.h"
25 #include <glibmm/miscutils.h>
27 #include "audiographer/process_context.h"
28 #include "audiographer/general/chunker.h"
29 #include "audiographer/general/interleaver.h"
30 #include "audiographer/general/normalizer.h"
31 #include "audiographer/general/analyser.h"
32 #include "audiographer/general/peak_reader.h"
33 #include "audiographer/general/loudness_reader.h"
34 #include "audiographer/general/sample_format_converter.h"
35 #include "audiographer/general/sr_converter.h"
36 #include "audiographer/general/silence_trimmer.h"
37 #include "audiographer/general/threader.h"
38 #include "audiographer/sndfile/tmp_file.h"
39 #include "audiographer/sndfile/tmp_file_rt.h"
40 #include "audiographer/sndfile/sndfile_writer.h"
42 #include "ardour/audioengine.h"
43 #include "ardour/export_channel_configuration.h"
44 #include "ardour/export_filename.h"
45 #include "ardour/export_format_specification.h"
46 #include "ardour/export_timespan.h"
47 #include "ardour/session_directory.h"
48 #include "ardour/sndfile_helpers.h"
50 #include "pbd/file_utils.h"
53 using namespace AudioGrapher;
58 ExportGraphBuilder::ExportGraphBuilder (Session const & session)
60 , thread_pool (hardware_concurrency())
62 process_buffer_frames = session.engine().samples_per_cycle();
65 ExportGraphBuilder::~ExportGraphBuilder ()
70 ExportGraphBuilder::process (framecnt_t frames, bool last_cycle)
72 assert(frames <= process_buffer_frames);
74 for (ChannelMap::iterator it = channels.begin(); it != channels.end(); ++it) {
75 Sample const * process_buffer = 0;
76 it->first->read (process_buffer, frames);
77 ConstProcessContext<Sample> context(process_buffer, frames, 1);
78 if (last_cycle) { context().set_flag (ProcessContext<Sample>::EndOfInput); }
79 it->second->process (context);
86 ExportGraphBuilder::process_normalize ()
88 for (std::list<Normalizer *>::iterator it = normalizers.begin(); it != normalizers.end(); /* ++ in loop */) {
89 if ((*it)->process()) {
90 it = normalizers.erase (it);
96 return normalizers.empty();
100 ExportGraphBuilder::get_normalize_cycle_count() const
103 for (std::list<Normalizer *>::const_iterator it = normalizers.begin(); it != normalizers.end(); ++it) {
104 max = std::max(max, (*it)->get_normalize_cycle_count());
110 ExportGraphBuilder::reset ()
113 channel_configs.clear ();
115 normalizers.clear ();
116 analysis_map.clear();
120 ExportGraphBuilder::cleanup (bool remove_out_files/*=false*/)
122 ChannelConfigList::iterator iter = channel_configs.begin();
124 while (iter != channel_configs.end() ) {
125 iter->remove_children(remove_out_files);
126 iter = channel_configs.erase(iter);
131 ExportGraphBuilder::set_current_timespan (boost::shared_ptr<ExportTimespan> span)
137 ExportGraphBuilder::add_config (FileSpec const & config)
139 ExportChannelConfiguration::ChannelList const & channels =
140 config.channel_config->get_channels();
141 for(ExportChannelConfiguration::ChannelList::const_iterator it = channels.begin();
142 it != channels.end(); ++it) {
143 (*it)->set_max_buffer_size(process_buffer_frames);
146 // If the sample rate is "session rate", change it to the real value.
147 // However, we need to copy it to not change the config which is saved...
148 FileSpec new_config (config);
149 new_config.format.reset(new ExportFormatSpecification(*new_config.format, false));
150 if(new_config.format->sample_rate() == ExportFormatBase::SR_Session) {
151 framecnt_t session_rate = session.nominal_frame_rate();
152 new_config.format->set_sample_rate(ExportFormatBase::nearest_sample_rate(session_rate));
156 if (!new_config.channel_config->get_split ()) {
157 add_split_config (new_config);
161 // Split channel configurations are split into several channel configurations,
162 // each corresponding to a file, at this stage
163 typedef std::list<boost::shared_ptr<ExportChannelConfiguration> > ConfigList;
164 ConfigList file_configs;
165 new_config.channel_config->configurations_for_files (file_configs);
168 for (ConfigList::iterator it = file_configs.begin(); it != file_configs.end(); ++it, ++chan) {
169 FileSpec copy = new_config;
170 copy.channel_config = *it;
172 copy.filename.reset (new ExportFilename (*copy.filename));
173 copy.filename->include_channel = true;
174 copy.filename->set_channel (chan);
176 add_split_config (copy);
181 ExportGraphBuilder::get_analysis_results (AnalysisResults& results) {
182 for (AnalysisMap::iterator i = analysis_map.begin(); i != analysis_map.end(); ++i) {
183 ExportAnalysisPtr p = i->second->result ();
185 results.insert (std::make_pair (i->first, p));
191 ExportGraphBuilder::add_split_config (FileSpec const & config)
193 for (ChannelConfigList::iterator it = channel_configs.begin(); it != channel_configs.end(); ++it) {
195 it->add_child (config);
200 // No duplicate channel config found, create new one
201 channel_configs.push_back (new ChannelConfig (*this, config, channels));
207 boost::shared_ptr<AudioGrapher::Sink<Sample> >
208 ExportGraphBuilder::Encoder::init (FileSpec const & new_config)
211 init_writer (float_writer);
216 boost::shared_ptr<AudioGrapher::Sink<int> >
217 ExportGraphBuilder::Encoder::init (FileSpec const & new_config)
220 init_writer (int_writer);
225 boost::shared_ptr<AudioGrapher::Sink<short> >
226 ExportGraphBuilder::Encoder::init (FileSpec const & new_config)
229 init_writer (short_writer);
234 ExportGraphBuilder::Encoder::add_child (FileSpec const & new_config)
236 filenames.push_back (new_config.filename);
240 ExportGraphBuilder::Encoder::destroy_writer (bool delete_out_file)
242 if (delete_out_file ) {
245 float_writer->close ();
249 int_writer->close ();
253 short_writer->close ();
256 if (std::remove(writer_filename.c_str() ) != 0) {
257 std::cout << "Encoder::destroy_writer () : Error removing file: " << strerror(errno) << std::endl;
261 float_writer.reset ();
263 short_writer.reset ();
267 ExportGraphBuilder::Encoder::operator== (FileSpec const & other_config) const
269 return get_real_format (config) == get_real_format (other_config);
273 ExportGraphBuilder::Encoder::get_real_format (FileSpec const & config)
275 ExportFormatSpecification & format = *config.format;
276 return format.format_id() | format.sample_format() | format.endianness();
281 ExportGraphBuilder::Encoder::init_writer (boost::shared_ptr<AudioGrapher::SndfileWriter<T> > & writer)
283 unsigned channels = config.channel_config->get_n_chans();
284 int format = get_real_format (config);
285 config.filename->set_channel_config(config.channel_config);
286 writer_filename = config.filename->get_path (config.format);
288 writer.reset (new AudioGrapher::SndfileWriter<T> (writer_filename, format, channels, config.format->sample_rate(), config.broadcast_info));
289 writer->FileWritten.connect_same_thread (copy_files_connection, boost::bind (&ExportGraphBuilder::Encoder::copy_files, this, _1));
293 ExportGraphBuilder::Encoder::copy_files (std::string orig_path)
295 while (filenames.size()) {
296 ExportFilenamePtr & filename = filenames.front();
297 PBD::copy_file (orig_path, filename->get_path (config.format).c_str());
298 filenames.pop_front();
304 ExportGraphBuilder::SFC::SFC (ExportGraphBuilder &parent, FileSpec const & new_config, framecnt_t max_frames)
308 data_width = sndfile_data_width (Encoder::get_real_format (config));
309 unsigned channels = new_config.channel_config->get_n_chans();
310 _analyse = config.format->analyse();
312 framecnt_t sample_rate = parent.session.nominal_frame_rate();
313 framecnt_t sb = config.format->silence_beginning_at (parent.timespan->get_start(), sample_rate);
314 framecnt_t se = config.format->silence_end_at (parent.timespan->get_end(), sample_rate);
315 framecnt_t duration = parent.timespan->get_length () + sb + se;
316 max_frames = min ((framecnt_t) 8192 * channels, max ((framecnt_t) 4096 * channels, max_frames));
317 chunker.reset (new Chunker<Sample> (max_frames));
318 analyser.reset (new Analyser (config.format->sample_rate(), channels, max_frames,
319 (framecnt_t) ceil (duration * config.format->sample_rate () / (double) sample_rate)));
320 chunker->add_output (analyser);
322 config.filename->set_channel_config (config.channel_config);
323 parent.add_analyser (config.filename->get_path (config.format), analyser);
326 if (data_width == 8 || data_width == 16) {
327 short_converter = ShortConverterPtr (new SampleFormatConverter<short> (channels));
328 short_converter->init (max_frames, config.format->dither_type(), data_width);
330 if (_analyse) { analyser->add_output (short_converter); }
332 } else if (data_width == 24 || data_width == 32) {
333 int_converter = IntConverterPtr (new SampleFormatConverter<int> (channels));
334 int_converter->init (max_frames, config.format->dither_type(), data_width);
336 if (_analyse) { analyser->add_output (int_converter); }
338 int actual_data_width = 8 * sizeof(Sample);
339 float_converter = FloatConverterPtr (new SampleFormatConverter<Sample> (channels));
340 float_converter->init (max_frames, config.format->dither_type(), actual_data_width);
342 if (_analyse) { analyser->add_output (float_converter); }
347 ExportGraphBuilder::SFC::set_peak (float gain)
350 analyser->set_normalization_gain (gain);
354 ExportGraphBuilder::FloatSinkPtr
355 ExportGraphBuilder::SFC::sink ()
359 } else if (data_width == 8 || data_width == 16) {
360 return short_converter;
361 } else if (data_width == 24 || data_width == 32) {
362 return int_converter;
364 return float_converter;
369 ExportGraphBuilder::SFC::add_child (FileSpec const & new_config)
371 for (boost::ptr_list<Encoder>::iterator it = children.begin(); it != children.end(); ++it) {
372 if (*it == new_config) {
373 it->add_child (new_config);
378 children.push_back (new Encoder());
379 Encoder & encoder = children.back();
381 if (data_width == 8 || data_width == 16) {
382 short_converter->add_output (encoder.init<short> (new_config));
383 } else if (data_width == 24 || data_width == 32) {
384 int_converter->add_output (encoder.init<int> (new_config));
386 float_converter->add_output (encoder.init<Sample> (new_config));
391 ExportGraphBuilder::SFC::remove_children (bool remove_out_files)
393 boost::ptr_list<Encoder>::iterator iter = children.begin ();
395 while (iter != children.end() ) {
397 if (remove_out_files) {
398 iter->destroy_writer(remove_out_files);
400 iter = children.erase (iter);
405 ExportGraphBuilder::SFC::operator== (FileSpec const & other_config) const
407 return config.format->sample_format() == other_config.format->sample_format();
412 ExportGraphBuilder::Normalizer::Normalizer (ExportGraphBuilder & parent, FileSpec const & new_config, framecnt_t max_frames)
414 , use_loudness (false)
416 std::string tmpfile_path = parent.session.session_directory().export_path();
417 tmpfile_path = Glib::build_filename(tmpfile_path, "XXXXXX");
418 std::vector<char> tmpfile_path_buf(tmpfile_path.size() + 1);
419 std::copy(tmpfile_path.begin(), tmpfile_path.end(), tmpfile_path_buf.begin());
420 tmpfile_path_buf[tmpfile_path.size()] = '\0';
423 uint32_t const channels = config.channel_config->get_n_chans();
424 max_frames_out = 4086 - (4086 % channels); // TODO good chunk size
425 use_loudness = config.format->normalize_loudness ();
427 buffer.reset (new AllocatingProcessContext<Sample> (max_frames_out, channels));
428 peak_reader.reset (new PeakReader ());
429 loudness_reader.reset (new LoudnessReader (config.format->sample_rate(), channels, max_frames));
430 normalizer.reset (new AudioGrapher::Normalizer (use_loudness ? 0.0 : config.format->normalize_dbfs()));
431 threader.reset (new Threader<Sample> (parent.thread_pool));
433 normalizer->alloc_buffer (max_frames_out);
434 normalizer->add_output (threader);
436 int format = ExportFormatBase::F_RAW | ExportFormatBase::SF_Float;
437 tmp_file.reset (new TmpFile<float> (&tmpfile_path_buf[0], format, channels, config.format->sample_rate()));
438 tmp_file->FileWritten.connect_same_thread (post_processing_connection,
439 boost::bind (&Normalizer::start_post_processing, this));
441 add_child (new_config);
444 loudness_reader->add_output (tmp_file);
446 peak_reader->add_output (tmp_file);
450 ExportGraphBuilder::FloatSinkPtr
451 ExportGraphBuilder::Normalizer::sink ()
454 return loudness_reader;
460 ExportGraphBuilder::Normalizer::add_child (FileSpec const & new_config)
462 for (boost::ptr_list<SFC>::iterator it = children.begin(); it != children.end(); ++it) {
463 if (*it == new_config) {
464 it->add_child (new_config);
469 children.push_back (new SFC (parent, new_config, max_frames_out));
470 threader->add_output (children.back().sink());
474 ExportGraphBuilder::Normalizer::remove_children (bool remove_out_files)
476 boost::ptr_list<SFC>::iterator iter = children.begin ();
478 while (iter != children.end() ) {
479 iter->remove_children (remove_out_files);
480 iter = children.erase (iter);
485 ExportGraphBuilder::Normalizer::operator== (FileSpec const & other_config) const
487 return config.format->normalize() == other_config.format->normalize() &&
488 config.format->normalize_loudness () == other_config.format->normalize_loudness() &&
490 (!config.format->normalize_loudness () && config.format->normalize_dbfs() == other_config.format->normalize_dbfs())
492 // FIXME: allow simultaneous export of two formats with different loundness normalization settings
493 (config.format->normalize_loudness () /* lufs/dbtp is a result option, not an instantaion option */)
498 ExportGraphBuilder::Normalizer::get_normalize_cycle_count() const
500 return static_cast<unsigned>(std::ceil(static_cast<float>(tmp_file->get_frames_written()) /
505 ExportGraphBuilder::Normalizer::process()
507 framecnt_t frames_read = tmp_file->read (*buffer);
508 return frames_read != buffer->frames();
512 ExportGraphBuilder::Normalizer::start_post_processing()
516 gain = normalizer->set_peak (loudness_reader->get_peak (config.format->normalize_lufs (), config.format->normalize_dbtp ()));
518 gain = normalizer->set_peak (peak_reader->get_peak());
520 for (boost::ptr_list<SFC>::iterator i = children.begin(); i != children.end(); ++i) {
521 (*i).set_peak (gain);
523 tmp_file->seek (0, SEEK_SET);
524 tmp_file->add_output (normalizer);
525 parent.normalizers.push_back (this);
530 ExportGraphBuilder::SRC::SRC (ExportGraphBuilder & parent, FileSpec const & new_config, framecnt_t max_frames)
534 converter.reset (new SampleRateConverter (new_config.channel_config->get_n_chans()));
535 ExportFormatSpecification & format = *new_config.format;
536 converter->init (parent.session.nominal_frame_rate(), format.sample_rate(), format.src_quality());
537 max_frames_out = converter->allocate_buffers (max_frames);
539 add_child (new_config);
542 ExportGraphBuilder::FloatSinkPtr
543 ExportGraphBuilder::SRC::sink ()
549 ExportGraphBuilder::SRC::add_child (FileSpec const & new_config)
551 if (new_config.format->normalize()) {
552 add_child_to_list (new_config, normalized_children);
554 add_child_to_list (new_config, children);
559 ExportGraphBuilder::SRC::remove_children (bool remove_out_files)
561 boost::ptr_list<SFC>::iterator sfc_iter = children.begin();
563 while (sfc_iter != children.end() ) {
564 converter->remove_output (sfc_iter->sink() );
565 sfc_iter->remove_children (remove_out_files);
566 sfc_iter = children.erase (sfc_iter);
569 boost::ptr_list<Normalizer>::iterator norm_iter = normalized_children.begin();
571 while (norm_iter != normalized_children.end() ) {
572 converter->remove_output (norm_iter->sink() );
573 norm_iter->remove_children (remove_out_files);
574 norm_iter = normalized_children.erase (norm_iter);
581 ExportGraphBuilder::SRC::add_child_to_list (FileSpec const & new_config, boost::ptr_list<T> & list)
583 for (typename boost::ptr_list<T>::iterator it = list.begin(); it != list.end(); ++it) {
584 if (*it == new_config) {
585 it->add_child (new_config);
590 list.push_back (new T (parent, new_config, max_frames_out));
591 converter->add_output (list.back().sink ());
595 ExportGraphBuilder::SRC::operator== (FileSpec const & other_config) const
597 return config.format->sample_rate() == other_config.format->sample_rate();
601 ExportGraphBuilder::SilenceHandler::SilenceHandler (ExportGraphBuilder & parent, FileSpec const & new_config, framecnt_t max_frames)
605 max_frames_in = max_frames;
606 framecnt_t sample_rate = parent.session.nominal_frame_rate();
609 silence_trimmer.reset (new SilenceTrimmer<Sample>(max_frames_in, -90));
611 // TODO silence-threshold should be per export-preset, with Config->get_silence_threshold being the default
612 silence_trimmer.reset (new SilenceTrimmer<Sample>(max_frames_in, Config->get_export_silence_threshold ()));
614 silence_trimmer->set_trim_beginning (config.format->trim_beginning());
615 silence_trimmer->set_trim_end (config.format->trim_end());
617 framecnt_t sb = config.format->silence_beginning_at (parent.timespan->get_start(), sample_rate);
618 framecnt_t se = config.format->silence_end_at (parent.timespan->get_end(), sample_rate);
620 silence_trimmer->add_silence_to_beginning (sb);
621 silence_trimmer->add_silence_to_end (se);
623 add_child (new_config);
626 ExportGraphBuilder::FloatSinkPtr
627 ExportGraphBuilder::SilenceHandler::sink ()
629 return silence_trimmer;
633 ExportGraphBuilder::SilenceHandler::add_child (FileSpec const & new_config)
635 for (boost::ptr_list<SRC>::iterator it = children.begin(); it != children.end(); ++it) {
636 if (*it == new_config) {
637 it->add_child (new_config);
642 children.push_back (new SRC (parent, new_config, max_frames_in));
643 silence_trimmer->add_output (children.back().sink());
647 ExportGraphBuilder::SilenceHandler::remove_children (bool remove_out_files)
649 boost::ptr_list<SRC>::iterator iter = children.begin();
651 while (iter != children.end() ) {
652 silence_trimmer->remove_output (iter->sink() );
653 iter->remove_children (remove_out_files);
654 iter = children.erase (iter);
659 ExportGraphBuilder::SilenceHandler::operator== (FileSpec const & other_config) const
661 ExportFormatSpecification & format = *config.format;
662 ExportFormatSpecification & other_format = *other_config.format;
663 return (format.trim_beginning() == other_format.trim_beginning()) &&
664 (format.trim_end() == other_format.trim_end()) &&
665 (format.silence_beginning_time() == other_format.silence_beginning_time()) &&
666 (format.silence_end_time() == other_format.silence_end_time());
671 ExportGraphBuilder::ChannelConfig::ChannelConfig (ExportGraphBuilder & parent, FileSpec const & new_config, ChannelMap & channel_map)
674 typedef ExportChannelConfiguration::ChannelList ChannelList;
678 framecnt_t max_frames = parent.session.engine().samples_per_cycle();
679 interleaver.reset (new Interleaver<Sample> ());
680 interleaver->init (new_config.channel_config->get_n_chans(), max_frames);
682 // Make the chunk size divisible by the channel count
683 int chan_count = new_config.channel_config->get_n_chans();
684 max_frames_out = 8192;
685 if (chan_count > 0) {
686 max_frames_out -= max_frames_out % chan_count;
688 chunker.reset (new Chunker<Sample> (max_frames_out));
689 interleaver->add_output(chunker);
691 ChannelList const & channel_list = config.channel_config->get_channels();
693 for (ChannelList::const_iterator it = channel_list.begin(); it != channel_list.end(); ++it, ++chan) {
694 ChannelMap::iterator map_it = channel_map.find (*it);
695 if (map_it == channel_map.end()) {
696 std::pair<ChannelMap::iterator, bool> result_pair =
697 channel_map.insert (std::make_pair (*it, IdentityVertexPtr (new IdentityVertex<Sample> ())));
698 assert (result_pair.second);
699 map_it = result_pair.first;
701 map_it->second->add_output (interleaver->input (chan));
704 add_child (new_config);
708 ExportGraphBuilder::ChannelConfig::add_child (FileSpec const & new_config)
710 assert (*this == new_config);
712 for (boost::ptr_list<SilenceHandler>::iterator it = children.begin(); it != children.end(); ++it) {
713 if (*it == new_config) {
714 it->add_child (new_config);
719 children.push_back (new SilenceHandler (parent, new_config, max_frames_out));
720 chunker->add_output (children.back().sink ());
724 ExportGraphBuilder::ChannelConfig::remove_children (bool remove_out_files)
726 boost::ptr_list<SilenceHandler>::iterator iter = children.begin();
728 while(iter != children.end() ) {
730 chunker->remove_output (iter->sink ());
731 iter->remove_children (remove_out_files);
732 iter = children.erase(iter);
737 ExportGraphBuilder::ChannelConfig::operator== (FileSpec const & other_config) const
739 return config.channel_config == other_config.channel_config;
742 } // namespace ARDOUR