some strategic documentation

[ardour.git] / libs / ardour / ardour / export_graph_builder.h

diff --git a/libs/ardour/ardour/export_graph_builder.h b/libs/ardour/ardour/export_graph_builder.h
index 07e866475aa9513fa472b46e5290a508e56b8cf2..0a9912e43ef3feb06ae6ee6221665a8de027fd38 100644 (file)
--- a/libs/ardour/ardour/export_graph_builder.h
+++ b/libs/ardour/ardour/export_graph_builder.h
@@ -22,6 +22,7 @@
 #define __ardour_export_graph_builder_h__
 
 #include "ardour/export_handler.h"
+#include "ardour/export_analysis.h"
 
 #include "audiographer/utils/identity_vertex.h"
 
@@ -32,6 +33,7 @@ namespace AudioGrapher {
        class SampleRateConverter;
        class PeakReader;
        class Normalizer;
+       class Analyser;
        template <typename T> class Chunker;
        template <typename T> class SampleFormatConverter;
        template <typename T> class Interleaver;
@@ -48,14 +50,16 @@ namespace ARDOUR
 class ExportTimespan;
 class Session;
 
-class ExportGraphBuilder
+class LIBARDOUR_API ExportGraphBuilder
 {
   private:
        typedef ExportHandler::FileSpec FileSpec;
 
        typedef boost::shared_ptr<AudioGrapher::Sink<Sample> > FloatSinkPtr;
        typedef boost::shared_ptr<AudioGrapher::IdentityVertex<Sample> > IdentityVertexPtr;
+       typedef boost::shared_ptr<AudioGrapher::Analyser> AnalysisPtr;
        typedef std::map<ExportChannelPtr,  IdentityVertexPtr> ChannelMap;
+       typedef std::map<std::string, AnalysisPtr> AnalysisMap;
 
   public:
 
@@ -68,22 +72,30 @@ class ExportGraphBuilder
        unsigned get_normalize_cycle_count() const;
 
        void reset ();
+       void cleanup (bool remove_out_files = false);
        void set_current_timespan (boost::shared_ptr<ExportTimespan> span);
        void add_config (FileSpec const & config);
+       void get_analysis_results (AnalysisResults& results);
 
   private:
 
+       void add_analyser (const std::string& fn, AnalysisPtr ap) {
+               analysis_map.insert (std::make_pair (fn, ap));
+       }
+
        void add_split_config (FileSpec const & config);
 
        class Encoder {
-         public:
+            public:
                template <typename T> boost::shared_ptr<AudioGrapher::Sink<T> > init (FileSpec const & new_config);
                void add_child (FileSpec const & new_config);
+               void remove_children ();
+               void destroy_writer (bool delete_out_file);
                bool operator== (FileSpec const & other_config) const;
 
                static int get_real_format (FileSpec const & config);
 
-         private:
+                                               private:
                typedef boost::shared_ptr<AudioGrapher::SndfileWriter<Sample> > FloatWriterPtr;
                typedef boost::shared_ptr<AudioGrapher::SndfileWriter<int> >    IntWriterPtr;
                typedef boost::shared_ptr<AudioGrapher::SndfileWriter<short> >  ShortWriterPtr;
@@ -95,6 +107,8 @@ class ExportGraphBuilder
                std::list<ExportFilenamePtr> filenames;
                PBD::ScopedConnection  copy_files_connection;
 
+               std::string writer_filename;
+
                // Only one of these should be available at a time
                FloatWriterPtr float_writer;
                IntWriterPtr   int_writer;
@@ -103,14 +117,17 @@ class ExportGraphBuilder
 
        // sample format converter
        class SFC {
-         public:
+            public:
                // This constructor so that this can be constructed like a Normalizer
                SFC (ExportGraphBuilder &, FileSpec const & new_config, framecnt_t max_frames);
                FloatSinkPtr sink ();
                void add_child (FileSpec const & new_config);
+               void remove_children (bool remove_out_files);
                bool operator== (FileSpec const & other_config) const;
+               void set_peak (float);
 
-         private:
+                                               private:
+               typedef boost::shared_ptr<AudioGrapher::Chunker<float> > ChunkerPtr;
                typedef boost::shared_ptr<AudioGrapher::SampleFormatConverter<Sample> > FloatConverterPtr;
                typedef boost::shared_ptr<AudioGrapher::SampleFormatConverter<int> >   IntConverterPtr;
                typedef boost::shared_ptr<AudioGrapher::SampleFormatConverter<short> > ShortConverterPtr;
@@ -119,6 +136,9 @@ class ExportGraphBuilder
                boost::ptr_list<Encoder> children;
                int                data_width;
 
+               ChunkerPtr      chunker;
+               AnalysisPtr     analyser;
+               bool            _analyse;
                // Only one of these should be available at a time
                FloatConverterPtr float_converter;
                IntConverterPtr int_converter;
@@ -126,10 +146,11 @@ class ExportGraphBuilder
        };
 
        class Normalizer {
-         public:
+                                               public:
                Normalizer (ExportGraphBuilder & parent, FileSpec const & new_config, framecnt_t max_frames);
                FloatSinkPtr sink ();
                void add_child (FileSpec const & new_config);
+               void remove_children (bool remove_out_files);
                bool operator== (FileSpec const & other_config) const;
 
                unsigned get_normalize_cycle_count() const;
@@ -137,7 +158,7 @@ class ExportGraphBuilder
                /// Returns true when finished
                bool process ();
 
-         private:
+                                               private:
                typedef boost::shared_ptr<AudioGrapher::PeakReader> PeakReaderPtr;
                typedef boost::shared_ptr<AudioGrapher::Normalizer> NormalizerPtr;
                typedef boost::shared_ptr<AudioGrapher::TmpFile<Sample> > TmpFilePtr;
@@ -163,13 +184,15 @@ class ExportGraphBuilder
 
        // sample rate converter
        class SRC {
-         public:
+            public:
                SRC (ExportGraphBuilder & parent, FileSpec const & new_config, framecnt_t max_frames);
                FloatSinkPtr sink ();
                void add_child (FileSpec const & new_config);
+               void remove_children (bool remove_out_files);
+
                bool operator== (FileSpec const & other_config) const;
 
-         private:
+                                               private:
                typedef boost::shared_ptr<AudioGrapher::SampleRateConverter> SRConverterPtr;
 
                template<typename T>
@@ -185,13 +208,14 @@ class ExportGraphBuilder
 
        // Silence trimmer + adder
        class SilenceHandler {
-         public:
+           public:
                SilenceHandler (ExportGraphBuilder & parent, FileSpec const & new_config, framecnt_t max_frames);
                FloatSinkPtr sink ();
                void add_child (FileSpec const & new_config);
+               void remove_children (bool remove_out_files);
                bool operator== (FileSpec const & other_config) const;
 
-         private:
+                                               private:
                typedef boost::shared_ptr<AudioGrapher::SilenceTrimmer<Sample> > SilenceTrimmerPtr;
 
                ExportGraphBuilder & parent;
@@ -203,12 +227,13 @@ class ExportGraphBuilder
 
        // channel configuration
        class ChannelConfig {
-         public:
+           public:
                ChannelConfig (ExportGraphBuilder & parent, FileSpec const & new_config, ChannelMap & channel_map);
                void add_child (FileSpec const & new_config);
+               void remove_children (bool remove_out_files);
                bool operator== (FileSpec const & other_config) const;
 
-         private:
+                                               private:
                typedef boost::shared_ptr<AudioGrapher::Interleaver<Sample> > InterleaverPtr;
                typedef boost::shared_ptr<AudioGrapher::Chunker<Sample> > ChunkerPtr;
 
@@ -234,6 +259,8 @@ class ExportGraphBuilder
 
        std::list<Normalizer *> normalizers;
 
+       AnalysisMap analysis_map;
+
        Glib::ThreadPool thread_pool;
 };