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 #include <glibmm/ustring.h>
  26 #include <boost/enable_shared_from_this.hpp>
  27
  28 #include "ardour/export_channel.h"
  29 #include "ardour/export_status.h"
  30 #include "ardour/ardour.h"
  31
  32 #include "pbd/xml++.h"
  33
  34 namespace ARDOUR
  35 {
  36
  37 class ExportHandler;
  38 class AudioPort;
  39 class ExportChannel;
  40 class ExportFormatSpecification;
  41 class ExportFilename;
  42 class ExportProcessor;
  43 class ExportTimespan;
  44 class Session;
  45
  46 class ExportChannelConfiguration : public boost::enable_shared_from_this<ExportChannelConfiguration>
  47 {
  48
  49   private:
  50         friend class ExportElementFactory;
  51         ExportChannelConfiguration (Session & session);
  52
  53   public:
  54         bool operator== (ExportChannelConfiguration const & other) const { return channels == other.channels; }
  55         bool operator!= (ExportChannelConfiguration const & other) const { return channels != other.channels; }
  56
  57         XMLNode & get_state ();
  58         int set_state (const XMLNode &);
  59
  60         typedef std::list<ExportChannelPtr> ChannelList;
  61
  62         ChannelList const & get_channels () const { return channels; }
  63         bool all_channels_have_ports () const;
  64
  65         Glib::ustring name () const { return _name; }
  66         void set_name (Glib::ustring name) { _name = name; }
  67         void set_split (bool value) { split = value; }
  68
  69         bool get_split () const { return split; }
  70         uint32_t get_n_chans () const { return channels.size(); }
  71
  72         void register_channel (ExportChannelPtr channel) { channels.push_back (channel); }
  73         void clear_channels () { channels.clear (); }
  74
  75         /** Returns a list of channel configurations that match the files created.
  76           * I.e. many configurations if splitting is enabled, one if not. */
  77         void configurations_for_files (std::list<boost::shared_ptr<ExportChannelConfiguration> > & configs);
  78
  79   private:
  80
  81         Session & session;
  82
  83         ChannelList     channels;
  84         bool            split; // Split to mono files
  85         Glib::ustring  _name;
  86 };
  87
  88 } // namespace ARDOUR
  89
  90 #endif /* __ardour_export_channel_configuration_h__ */