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/sample_format_converter.h"
34 #include "audiographer/general/sr_converter.h"
35 #include "audiographer/general/silence_trimmer.h"
36 #include "audiographer/general/threader.h"
37 #include "audiographer/sndfile/tmp_file.h"
38 #include "audiographer/sndfile/sndfile_writer.h"
40 #include "ardour/audioengine.h"
41 #include "ardour/export_channel_configuration.h"
42 #include "ardour/export_filename.h"
43 #include "ardour/export_format_specification.h"
44 #include "ardour/export_timespan.h"
45 #include "ardour/session_directory.h"
46 #include "ardour/sndfile_helpers.h"
48 #include "pbd/file_utils.h"
51 using namespace AudioGrapher;
56 ExportGraphBuilder::ExportGraphBuilder (Session const & session)
58 , thread_pool (hardware_concurrency())
60 process_buffer_frames = session.engine().samples_per_cycle();
63 ExportGraphBuilder::~ExportGraphBuilder ()
68 ExportGraphBuilder::process (framecnt_t frames, bool last_cycle)
70 assert(frames <= process_buffer_frames);
72 for (ChannelMap::iterator it = channels.begin(); it != channels.end(); ++it) {
73 Sample const * process_buffer = 0;
74 it->first->read (process_buffer, frames);
75 ConstProcessContext<Sample> context(process_buffer, frames, 1);
76 if (last_cycle) { context().set_flag (ProcessContext<Sample>::EndOfInput); }
77 it->second->process (context);
84 ExportGraphBuilder::process_normalize ()
86 for (std::list<Normalizer *>::iterator it = normalizers.begin(); it != normalizers.end(); /* ++ in loop */) {
87 if ((*it)->process()) {
88 it = normalizers.erase (it);
94 return normalizers.empty();
98 ExportGraphBuilder::get_normalize_cycle_count() const
101 for (std::list<Normalizer *>::const_iterator it = normalizers.begin(); it != normalizers.end(); ++it) {
102 max = std::max(max, (*it)->get_normalize_cycle_count());
108 ExportGraphBuilder::reset ()
111 channel_configs.clear ();
113 normalizers.clear ();
114 analysis_map.clear();
118 ExportGraphBuilder::cleanup (bool remove_out_files/*=false*/)
120 ChannelConfigList::iterator iter = channel_configs.begin();
122 while (iter != channel_configs.end() ) {
123 iter->remove_children(remove_out_files);
124 iter = channel_configs.erase(iter);
129 ExportGraphBuilder::set_current_timespan (boost::shared_ptr<ExportTimespan> span)
135 ExportGraphBuilder::add_config (FileSpec const & config)
137 ExportChannelConfiguration::ChannelList const & channels =
138 config.channel_config->get_channels();
139 for(ExportChannelConfiguration::ChannelList::const_iterator it = channels.begin();
140 it != channels.end(); ++it) {
141 (*it)->set_max_buffer_size(process_buffer_frames);
144 // If the sample rate is "session rate", change it to the real value.
145 // However, we need to copy it to not change the config which is saved...
146 FileSpec new_config (config);
147 new_config.format.reset(new ExportFormatSpecification(*new_config.format, false));
148 if(new_config.format->sample_rate() == ExportFormatBase::SR_Session) {
149 framecnt_t session_rate = session.nominal_frame_rate();
150 new_config.format->set_sample_rate(ExportFormatBase::nearest_sample_rate(session_rate));
154 if (!new_config.channel_config->get_split ()) {
155 add_split_config (new_config);
159 // Split channel configurations are split into several channel configurations,
160 // each corresponding to a file, at this stage
161 typedef std::list<boost::shared_ptr<ExportChannelConfiguration> > ConfigList;
162 ConfigList file_configs;
163 new_config.channel_config->configurations_for_files (file_configs);
166 for (ConfigList::iterator it = file_configs.begin(); it != file_configs.end(); ++it, ++chan) {
167 FileSpec copy = new_config;
168 copy.channel_config = *it;
170 copy.filename.reset (new ExportFilename (*copy.filename));
171 copy.filename->include_channel = true;
172 copy.filename->set_channel (chan);
174 add_split_config (copy);
179 ExportGraphBuilder::get_analysis_results (AnalysisResults& results) {
180 for (AnalysisMap::iterator i = analysis_map.begin(); i != analysis_map.end(); ++i) {
181 ExportAnalysisPtr p = i->second->result ();
183 results.insert (std::make_pair (i->first, p));
189 ExportGraphBuilder::add_split_config (FileSpec const & config)
191 for (ChannelConfigList::iterator it = channel_configs.begin(); it != channel_configs.end(); ++it) {
193 it->add_child (config);
198 // No duplicate channel config found, create new one
199 channel_configs.push_back (new ChannelConfig (*this, config, channels));
205 boost::shared_ptr<AudioGrapher::Sink<Sample> >
206 ExportGraphBuilder::Encoder::init (FileSpec const & new_config)
209 init_writer (float_writer);
214 boost::shared_ptr<AudioGrapher::Sink<int> >
215 ExportGraphBuilder::Encoder::init (FileSpec const & new_config)
218 init_writer (int_writer);
223 boost::shared_ptr<AudioGrapher::Sink<short> >
224 ExportGraphBuilder::Encoder::init (FileSpec const & new_config)
227 init_writer (short_writer);
232 ExportGraphBuilder::Encoder::add_child (FileSpec const & new_config)
234 filenames.push_back (new_config.filename);
238 ExportGraphBuilder::Encoder::destroy_writer (bool delete_out_file)
240 if (delete_out_file ) {
243 float_writer->close ();
247 int_writer->close ();
251 short_writer->close ();
254 if (std::remove(writer_filename.c_str() ) != 0) {
255 std::cout << "Encoder::destroy_writer () : Error removing file: " << strerror(errno) << std::endl;
259 float_writer.reset ();
261 short_writer.reset ();
265 ExportGraphBuilder::Encoder::operator== (FileSpec const & other_config) const
267 return get_real_format (config) == get_real_format (other_config);
271 ExportGraphBuilder::Encoder::get_real_format (FileSpec const & config)
273 ExportFormatSpecification & format = *config.format;
274 return format.format_id() | format.sample_format() | format.endianness();
279 ExportGraphBuilder::Encoder::init_writer (boost::shared_ptr<AudioGrapher::SndfileWriter<T> > & writer)
281 unsigned channels = config.channel_config->get_n_chans();
282 int format = get_real_format (config);
283 config.filename->set_channel_config(config.channel_config);
284 writer_filename = config.filename->get_path (config.format);
286 writer.reset (new AudioGrapher::SndfileWriter<T> (writer_filename, format, channels, config.format->sample_rate(), config.broadcast_info));
287 writer->FileWritten.connect_same_thread (copy_files_connection, boost::bind (&ExportGraphBuilder::Encoder::copy_files, this, _1));
291 ExportGraphBuilder::Encoder::copy_files (std::string orig_path)
293 while (filenames.size()) {
294 ExportFilenamePtr & filename = filenames.front();
295 PBD::copy_file (orig_path, filename->get_path (config.format).c_str());
296 filenames.pop_front();
302 ExportGraphBuilder::SFC::SFC (ExportGraphBuilder &parent, FileSpec const & new_config, framecnt_t max_frames)
306 data_width = sndfile_data_width (Encoder::get_real_format (config));
307 unsigned channels = new_config.channel_config->get_n_chans();
308 _analyse = config.format->analyse();
310 framecnt_t sample_rate = parent.session.nominal_frame_rate();
311 framecnt_t sb = config.format->silence_beginning_at (parent.timespan->get_start(), sample_rate);
312 framecnt_t se = config.format->silence_end_at (parent.timespan->get_end(), sample_rate);
313 framecnt_t duration = parent.timespan->get_length () + sb + se;
314 analyser.reset (new Analyser (config.format->sample_rate(), channels, max_frames,
315 (framecnt_t) ceil (duration * config.format->sample_rate () / sample_rate)));
316 parent.add_analyser (config.filename->get_path (config.format), analyser);
319 if (data_width == 8 || data_width == 16) {
320 short_converter = ShortConverterPtr (new SampleFormatConverter<short> (channels));
321 short_converter->init (max_frames, config.format->dither_type(), data_width);
323 if (_analyse) { analyser->add_output (short_converter); }
325 } else if (data_width == 24 || data_width == 32) {
326 int_converter = IntConverterPtr (new SampleFormatConverter<int> (channels));
327 int_converter->init (max_frames, config.format->dither_type(), data_width);
329 if (_analyse) { analyser->add_output (int_converter); }
331 int actual_data_width = 8 * sizeof(Sample);
332 float_converter = FloatConverterPtr (new SampleFormatConverter<Sample> (channels));
333 float_converter->init (max_frames, config.format->dither_type(), actual_data_width);
335 if (_analyse) { analyser->add_output (float_converter); }
340 ExportGraphBuilder::SFC::set_peak (float gain)
343 analyser->set_normalization_gain (gain);
347 ExportGraphBuilder::FloatSinkPtr
348 ExportGraphBuilder::SFC::sink ()
352 } else if (data_width == 8 || data_width == 16) {
353 return short_converter;
354 } else if (data_width == 24 || data_width == 32) {
355 return int_converter;
357 return float_converter;
362 ExportGraphBuilder::SFC::add_child (FileSpec const & new_config)
364 for (boost::ptr_list<Encoder>::iterator it = children.begin(); it != children.end(); ++it) {
365 if (*it == new_config) {
366 it->add_child (new_config);
371 children.push_back (new Encoder());
372 Encoder & encoder = children.back();
374 if (data_width == 8 || data_width == 16) {
375 short_converter->add_output (encoder.init<short> (new_config));
376 } else if (data_width == 24 || data_width == 32) {
377 int_converter->add_output (encoder.init<int> (new_config));
379 float_converter->add_output (encoder.init<Sample> (new_config));
384 ExportGraphBuilder::SFC::remove_children (bool remove_out_files)
386 boost::ptr_list<Encoder>::iterator iter = children.begin ();
388 while (iter != children.end() ) {
390 if (remove_out_files) {
391 iter->destroy_writer(remove_out_files);
393 iter = children.erase (iter);
398 ExportGraphBuilder::SFC::operator== (FileSpec const & other_config) const
400 return config.format->sample_format() == other_config.format->sample_format();
405 ExportGraphBuilder::Normalizer::Normalizer (ExportGraphBuilder & parent, FileSpec const & new_config, framecnt_t /*max_frames*/)
408 std::string tmpfile_path = parent.session.session_directory().export_path();
409 tmpfile_path = Glib::build_filename(tmpfile_path, "XXXXXX");
410 std::vector<char> tmpfile_path_buf(tmpfile_path.size() + 1);
411 std::copy(tmpfile_path.begin(), tmpfile_path.end(), tmpfile_path_buf.begin());
412 tmpfile_path_buf[tmpfile_path.size()] = '\0';
415 uint32_t const channels = config.channel_config->get_n_chans();
416 max_frames_out = 4086 - (4086 % channels); // TODO good chunk size
418 buffer.reset (new AllocatingProcessContext<Sample> (max_frames_out, channels));
419 peak_reader.reset (new PeakReader ());
420 normalizer.reset (new AudioGrapher::Normalizer (config.format->normalize_target()));
421 threader.reset (new Threader<Sample> (parent.thread_pool));
423 normalizer->alloc_buffer (max_frames_out);
424 normalizer->add_output (threader);
426 int format = ExportFormatBase::F_RAW | ExportFormatBase::SF_Float;
427 tmp_file.reset (new TmpFile<float> (&tmpfile_path_buf[0], format, channels, config.format->sample_rate()));
428 tmp_file->FileWritten.connect_same_thread (post_processing_connection,
429 boost::bind (&Normalizer::start_post_processing, this));
431 add_child (new_config);
433 peak_reader->add_output (tmp_file);
436 ExportGraphBuilder::FloatSinkPtr
437 ExportGraphBuilder::Normalizer::sink ()
443 ExportGraphBuilder::Normalizer::add_child (FileSpec const & new_config)
445 for (boost::ptr_list<SFC>::iterator it = children.begin(); it != children.end(); ++it) {
446 if (*it == new_config) {
447 it->add_child (new_config);
452 children.push_back (new SFC (parent, new_config, max_frames_out));
453 threader->add_output (children.back().sink());
457 ExportGraphBuilder::Normalizer::remove_children (bool remove_out_files)
459 boost::ptr_list<SFC>::iterator iter = children.begin ();
461 while (iter != children.end() ) {
462 iter->remove_children (remove_out_files);
463 iter = children.erase (iter);
468 ExportGraphBuilder::Normalizer::operator== (FileSpec const & other_config) const
470 return config.format->normalize() == other_config.format->normalize() &&
471 config.format->normalize_target() == other_config.format->normalize_target();
475 ExportGraphBuilder::Normalizer::get_normalize_cycle_count() const
477 return static_cast<unsigned>(std::ceil(static_cast<float>(tmp_file->get_frames_written()) /
482 ExportGraphBuilder::Normalizer::process()
484 framecnt_t frames_read = tmp_file->read (*buffer);
485 return frames_read != buffer->frames();
489 ExportGraphBuilder::Normalizer::start_post_processing()
491 const float gain = normalizer->set_peak (peak_reader->get_peak());
492 for (boost::ptr_list<SFC>::iterator i = children.begin(); i != children.end(); ++i) {
493 (*i).set_peak (gain);
495 tmp_file->seek (0, SEEK_SET);
496 tmp_file->add_output (normalizer);
497 parent.normalizers.push_back (this);
502 ExportGraphBuilder::SRC::SRC (ExportGraphBuilder & parent, FileSpec const & new_config, framecnt_t max_frames)
506 converter.reset (new SampleRateConverter (new_config.channel_config->get_n_chans()));
507 ExportFormatSpecification & format = *new_config.format;
508 converter->init (parent.session.nominal_frame_rate(), format.sample_rate(), format.src_quality());
509 max_frames_out = converter->allocate_buffers (max_frames);
511 add_child (new_config);
514 ExportGraphBuilder::FloatSinkPtr
515 ExportGraphBuilder::SRC::sink ()
521 ExportGraphBuilder::SRC::add_child (FileSpec const & new_config)
523 if (new_config.format->normalize()) {
524 add_child_to_list (new_config, normalized_children);
526 add_child_to_list (new_config, children);
531 ExportGraphBuilder::SRC::remove_children (bool remove_out_files)
533 boost::ptr_list<SFC>::iterator sfc_iter = children.begin();
535 while (sfc_iter != children.end() ) {
536 converter->remove_output (sfc_iter->sink() );
537 sfc_iter->remove_children (remove_out_files);
538 sfc_iter = children.erase (sfc_iter);
541 boost::ptr_list<Normalizer>::iterator norm_iter = normalized_children.begin();
543 while (norm_iter != normalized_children.end() ) {
544 converter->remove_output (norm_iter->sink() );
545 norm_iter->remove_children (remove_out_files);
546 norm_iter = normalized_children.erase (norm_iter);
553 ExportGraphBuilder::SRC::add_child_to_list (FileSpec const & new_config, boost::ptr_list<T> & list)
555 for (typename boost::ptr_list<T>::iterator it = list.begin(); it != list.end(); ++it) {
556 if (*it == new_config) {
557 it->add_child (new_config);
562 list.push_back (new T (parent, new_config, max_frames_out));
563 converter->add_output (list.back().sink ());
567 ExportGraphBuilder::SRC::operator== (FileSpec const & other_config) const
569 return config.format->sample_rate() == other_config.format->sample_rate();
573 ExportGraphBuilder::SilenceHandler::SilenceHandler (ExportGraphBuilder & parent, FileSpec const & new_config, framecnt_t max_frames)
577 max_frames_in = max_frames;
578 framecnt_t sample_rate = parent.session.nominal_frame_rate();
580 silence_trimmer.reset (new SilenceTrimmer<Sample>(max_frames_in));
581 silence_trimmer->set_trim_beginning (config.format->trim_beginning());
582 silence_trimmer->set_trim_end (config.format->trim_end());
584 framecnt_t sb = config.format->silence_beginning_at (parent.timespan->get_start(), sample_rate);
585 framecnt_t se = config.format->silence_end_at (parent.timespan->get_end(), sample_rate);
587 silence_trimmer->add_silence_to_beginning (sb);
588 silence_trimmer->add_silence_to_end (se);
590 add_child (new_config);
593 ExportGraphBuilder::FloatSinkPtr
594 ExportGraphBuilder::SilenceHandler::sink ()
596 return silence_trimmer;
600 ExportGraphBuilder::SilenceHandler::add_child (FileSpec const & new_config)
602 for (boost::ptr_list<SRC>::iterator it = children.begin(); it != children.end(); ++it) {
603 if (*it == new_config) {
604 it->add_child (new_config);
609 children.push_back (new SRC (parent, new_config, max_frames_in));
610 silence_trimmer->add_output (children.back().sink());
614 ExportGraphBuilder::SilenceHandler::remove_children (bool remove_out_files)
616 boost::ptr_list<SRC>::iterator iter = children.begin();
618 while (iter != children.end() ) {
619 silence_trimmer->remove_output (iter->sink() );
620 iter->remove_children (remove_out_files);
621 iter = children.erase (iter);
626 ExportGraphBuilder::SilenceHandler::operator== (FileSpec const & other_config) const
628 ExportFormatSpecification & format = *config.format;
629 ExportFormatSpecification & other_format = *other_config.format;
630 return (format.trim_beginning() == other_format.trim_beginning()) &&
631 (format.trim_end() == other_format.trim_end()) &&
632 (format.silence_beginning_time() == other_format.silence_beginning_time()) &&
633 (format.silence_end_time() == other_format.silence_end_time());
638 ExportGraphBuilder::ChannelConfig::ChannelConfig (ExportGraphBuilder & parent, FileSpec const & new_config, ChannelMap & channel_map)
641 typedef ExportChannelConfiguration::ChannelList ChannelList;
645 framecnt_t max_frames = parent.session.engine().samples_per_cycle();
646 interleaver.reset (new Interleaver<Sample> ());
647 interleaver->init (new_config.channel_config->get_n_chans(), max_frames);
649 // Make the chunk size divisible by the channel count
650 int chan_count = new_config.channel_config->get_n_chans();
651 max_frames_out = 8192;
652 if (chan_count > 0) {
653 max_frames_out -= max_frames_out % chan_count;
655 chunker.reset (new Chunker<Sample> (max_frames_out));
656 interleaver->add_output(chunker);
658 ChannelList const & channel_list = config.channel_config->get_channels();
660 for (ChannelList::const_iterator it = channel_list.begin(); it != channel_list.end(); ++it, ++chan) {
661 ChannelMap::iterator map_it = channel_map.find (*it);
662 if (map_it == channel_map.end()) {
663 std::pair<ChannelMap::iterator, bool> result_pair =
664 channel_map.insert (std::make_pair (*it, IdentityVertexPtr (new IdentityVertex<Sample> ())));
665 assert (result_pair.second);
666 map_it = result_pair.first;
668 map_it->second->add_output (interleaver->input (chan));
671 add_child (new_config);
675 ExportGraphBuilder::ChannelConfig::add_child (FileSpec const & new_config)
677 assert (*this == new_config);
679 for (boost::ptr_list<SilenceHandler>::iterator it = children.begin(); it != children.end(); ++it) {
680 if (*it == new_config) {
681 it->add_child (new_config);
686 children.push_back (new SilenceHandler (parent, new_config, max_frames_out));
687 chunker->add_output (children.back().sink ());
691 ExportGraphBuilder::ChannelConfig::remove_children (bool remove_out_files)
693 boost::ptr_list<SilenceHandler>::iterator iter = children.begin();
695 while(iter != children.end() ) {
697 chunker->remove_output (iter->sink ());
698 iter->remove_children (remove_out_files);
699 iter = children.erase(iter);
704 ExportGraphBuilder::ChannelConfig::operator== (FileSpec const & other_config) const
706 return config.channel_config == other_config.channel_config;
709 } // namespace ARDOUR