libs/ardour/ardour/export_channel_configuration.h

   1 /*
   2     Copyright (C) 2008 Paul Davis
   3     Author: Sakari Bergen
   4
   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.
   9
  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.
  14
  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.
  18
  19 */
  20
  21 #ifndef __ardour_export_channel_configuration_h__
  22 #define __ardour_export_channel_configuration_h__
  23
  24 #include <list>
  25
  26 #include <glibmm/ustring.h>
  27 #include <sigc++/signal.h>
  28
  29 #include "ardour/export_channel.h"
  30 #include "ardour/export_status.h"
  31 #include "ardour/ardour.h"
  32
  33 #include "pbd/xml++.h"
  34
  35 namespace ARDOUR
  36 {
  37
  38 class ExportHandler;
  39 class AudioPort;
  40 class ExportChannel;
  41 class ExportFormatSpecification;
  42 class ExportFilename;
  43 class ExportProcessor;
  44 class ExportTimespan;
  45 class Session;
  46
  47 class ExportChannelConfiguration
  48 {
  49   private:
  50         typedef boost::shared_ptr<ExportProcessor> ProcessorPtr;
  51         typedef boost::shared_ptr<ExportTimespan> TimespanPtr;
  52         typedef boost::shared_ptr<ExportFormatSpecification const> FormatPtr;
  53         typedef boost::shared_ptr<ExportFilename> FilenamePtr;
  54
  55         typedef std::pair<FormatPtr, FilenamePtr> FileConfig;
  56         typedef std::list<FileConfig> FileConfigList;
  57
  58         /// Struct for threading, acts like a pointer to a ExportChannelConfiguration
  59         struct WriterThread {
  60                 WriterThread (ExportChannelConfiguration & channel_config) :
  61                         channel_config (channel_config), running (false) {}
  62
  63                 ExportChannelConfiguration * operator-> () { return &channel_config; }
  64                 ExportChannelConfiguration & operator* () { return channel_config; }
  65
  66                 ExportChannelConfiguration & channel_config;
  67
  68                 pthread_t thread;
  69                 bool      running;
  70         };
  71
  72   private:
  73         friend class ExportElementFactory;
  74         ExportChannelConfiguration (Session & session);
  75
  76   public:
  77         XMLNode & get_state ();
  78         int set_state (const XMLNode &);
  79
  80         typedef std::list<ExportChannelPtr> ChannelList;
  81
  82         ChannelList const & get_channels () const { return channels; }
  83         bool all_channels_have_ports () const;
  84
  85         Glib::ustring name () const { return _name; }
  86         void set_name (Glib::ustring name) { _name = name; }
  87         void set_split (bool value) { split = value; }
  88
  89         bool get_split () const { return split; }
  90         uint32_t get_n_chans () const { return channels.size(); }
  91
  92         void register_channel (ExportChannelPtr channel) { channels.push_back (channel); }
  93         void register_file_config (FormatPtr format, FilenamePtr filename) { file_configs.push_back (FileConfig (format, filename)); }
  94
  95         void clear_channels () { channels.clear (); }
  96
  97         /// Writes all files for this channel config @return true if a new thread was spawned
  98         bool write_files (boost::shared_ptr<ExportProcessor> new_processor);
  99         sigc::signal<void> FilesWritten;
 100
 101         // Tells the handler the necessary information for it to handle tempfiles
 102         void register_with_timespan (TimespanPtr timespan);
 103
 104         void unregister_all ();
 105
 106   private:
 107
 108         typedef boost::shared_ptr<ExportStatus> ExportStatusPtr;
 109
 110         Session & session;
 111
 112         // processor has to be prepared before doing this.
 113         void write_file ();
 114
 115         /// The actual write files, needed for threading
 116         static void *  _write_files (void *arg);
 117         WriterThread    writer_thread;
 118         ProcessorPtr    processor;
 119         ExportStatusPtr status;
 120
 121         bool            files_written;
 122
 123         TimespanPtr     timespan;
 124         ChannelList     channels;
 125         FileConfigList  file_configs;
 126
 127         bool            split; // Split to mono files
 128         Glib::ustring  _name;
 129 };
 130
 131 } // namespace ARDOUR
 132
 133 #endif /* __ardour_export_channel_configuration_h__ */