libs/ardour/ardour/export_format_specification.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_format_specification_h__
  22 #define __ardour_export_format_specification_h__
  23
  24 #include <string>
  25
  26 #include "pbd/uuid.h"
  27
  28 #include "ardour/types.h"
  29 #include "ardour/export_format_base.h"
  30
  31 class XMLNode;
  32
  33 namespace ARDOUR
  34 {
  35
  36 class ExportFormat;
  37 class ExportFormatCompatibility;
  38 class Session;
  39
  40 class ExportFormatSpecification : public ExportFormatBase {
  41
  42   private:
  43
  44         /* Time struct for keeping time formats as close as possible to what was requested */
  45
  46         struct Time : public AnyTime {
  47                 Time (Session & session) : AnyTime (), session (session) {}
  48                 Time & operator= (AnyTime const & other);
  49
  50                 framecnt_t get_frames_at (framepos_t position, framecnt_t target_rate) const;
  51
  52                 /* Serialization */
  53
  54                 XMLNode & get_state ();
  55                 int set_state (const XMLNode & node);
  56
  57           private:
  58                 Session & session;
  59         };
  60
  61   private:
  62         friend class ExportElementFactory;
  63         explicit ExportFormatSpecification (Session & s);
  64         ExportFormatSpecification (Session & s, XMLNode const & state);
  65
  66   public:
  67         ExportFormatSpecification (ExportFormatSpecification const & other);
  68         ~ExportFormatSpecification ();
  69
  70         /* compatibility */
  71
  72         bool is_compatible_with (ExportFormatCompatibility const & compatibility) const;
  73         bool is_complete () const;
  74
  75         /* Modifying functions */
  76
  77         void set_format (boost::shared_ptr<ExportFormat> format);
  78
  79         void set_name (std::string const & name) { _name = name; }
  80
  81         void set_type (Type type) { _type = type; }
  82         void set_format_id (FormatId value) { format_ids.clear(); format_ids.insert (value); }
  83         void set_endianness (Endianness value) { endiannesses.clear(); endiannesses.insert (value); }
  84         void set_sample_format (SampleFormat value) { sample_formats.clear(); sample_formats.insert (value); }
  85         void set_sample_rate (SampleRate value) { sample_rates.clear(); sample_rates.insert (value); }
  86         void set_quality (Quality value) { qualities.clear(); qualities.insert (value); }
  87
  88         void set_dither_type (DitherType value) { _dither_type = value; }
  89         void set_src_quality (SRCQuality value) { _src_quality = value; }
  90         void set_trim_beginning (bool value) { _trim_beginning = value; }
  91         void set_trim_end (bool value) { _trim_end = value; }
  92         void set_normalize (bool value) { _normalize = value; }
  93         void set_normalize_target (float value) { _normalize_target = value; }
  94
  95         void set_tag (bool tag_it) { _tag = tag_it; }
  96
  97         void set_silence_beginning (AnyTime const & value) { _silence_beginning = value; }
  98         void set_silence_end (AnyTime const & value) { _silence_end = value; }
  99
 100         /* Accessing functions */
 101
 102         PBD::UUID const & id () { return _id; }
 103         std::string const & name () const { return _name; }
 104         std::string description ();
 105
 106         bool has_broadcast_info () const { return _has_broadcast_info; }
 107         uint32_t channel_limit () const { return _channel_limit; }
 108         std::string format_name () const { return _format_name; }
 109
 110         Type type () const { return _type; }
 111         FormatId format_id () const { return *format_ids.begin(); }
 112         Endianness endianness () const { return *endiannesses.begin(); }
 113         SampleFormat sample_format () const { return *sample_formats.begin(); }
 114         SampleRate sample_rate () const { return *sample_rates.begin(); }
 115         Quality quality () const { return *qualities.begin(); }
 116
 117         DitherType dither_type () const { return _dither_type; }
 118         SRCQuality src_quality () const { return _src_quality; }
 119         bool trim_beginning () const { return _trim_beginning; }
 120         bool trim_end () const { return _trim_end; }
 121         bool normalize () const { return _normalize; }
 122         float normalize_target () const { return _normalize_target; }
 123
 124         bool tag () const { return _tag && supports_tagging; }
 125
 126         framecnt_t silence_beginning_at (framepos_t position, framecnt_t samplerate) const
 127                 { return _silence_beginning.get_frames_at (position, samplerate); }
 128         framecnt_t silence_end_at (framepos_t position, framecnt_t samplerate) const
 129                 { return _silence_end.get_frames_at (position, samplerate); }
 130
 131         AnyTime silence_beginning_time () const { return _silence_beginning; }
 132         AnyTime silence_end_time () const { return _silence_end; }
 133
 134         /* Serialization */
 135
 136         XMLNode & get_state ();
 137         int set_state (const XMLNode & root);
 138
 139
 140   private:
 141
 142         Session &        session;
 143
 144         /* The variables below do not have setters (usually set via set_format) */
 145
 146         std::string  _format_name;
 147         bool            has_sample_format;
 148         bool            supports_tagging;
 149         bool           _has_broadcast_info;
 150         uint32_t       _channel_limit;
 151
 152         /* The variables below have getters and setters */
 153
 154         std::string   _name;
 155         PBD::UUID       _id;
 156
 157         Type            _type;
 158         DitherType      _dither_type;
 159         SRCQuality      _src_quality;
 160
 161         bool            _tag;
 162
 163         bool            _trim_beginning;
 164         Time            _silence_beginning;
 165         bool            _trim_end;
 166         Time            _silence_end;
 167
 168         bool            _normalize;
 169         float           _normalize_target;
 170
 171         /* serialization helpers */
 172
 173         void add_option (XMLNode * node, std::string const & name, std::string const & value);
 174         std::string get_option (XMLNode const * node, std::string const & name);
 175
 176 };
 177
 178 } // namespace ARDOUR
 179
 180 #endif /* __ardour_export_format_specification_h__ */