2 Copyright (C) 2008 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 #ifndef __ardour_export_format_specification_h__
22 #define __ardour_export_format_specification_h__
28 #include "ardour/libardour_visibility.h"
29 #include "ardour/types.h"
30 #include "ardour/export_format_base.h"
38 class ExportFormatCompatibility;
41 class LIBARDOUR_API ExportFormatSpecification : public ExportFormatBase {
45 /* Time struct for keeping time formats as close as possible to what was requested */
47 struct Time : public AnyTime {
48 Time (Session & session) : AnyTime (), session (session) {}
49 Time & operator= (AnyTime const & other);
51 framecnt_t get_frames_at (framepos_t position, framecnt_t target_rate) const;
55 XMLNode & get_state ();
56 int set_state (const XMLNode & node);
63 friend class ExportElementFactory;
64 explicit ExportFormatSpecification (Session & s);
65 ExportFormatSpecification (Session & s, XMLNode const & state);
68 ExportFormatSpecification (ExportFormatSpecification const & other, bool modify_name = true);
69 ~ExportFormatSpecification ();
73 bool is_compatible_with (ExportFormatCompatibility const & compatibility) const;
74 bool is_complete () const;
76 /* Modifying functions */
78 void set_format (boost::shared_ptr<ExportFormat> format);
80 void set_name (std::string const & name) { _name = name; }
82 void set_type (Type type) { _type = type; }
83 void set_format_id (FormatId value) { format_ids.clear(); format_ids.insert (value); }
84 void set_endianness (Endianness value) { endiannesses.clear(); endiannesses.insert (value); }
85 void set_sample_format (SampleFormat value) { sample_formats.clear(); sample_formats.insert (value); }
86 void set_sample_rate (SampleRate value) { sample_rates.clear(); sample_rates.insert (value); }
87 void set_quality (Quality value) { qualities.clear(); qualities.insert (value); }
89 void set_dither_type (DitherType value) { _dither_type = value; }
90 void set_src_quality (SRCQuality value) { _src_quality = value; }
91 void set_trim_beginning (bool value) { _trim_beginning = value; }
92 void set_trim_end (bool value) { _trim_end = value; }
93 void set_normalize (bool value) { _normalize = value; }
94 void set_normalize_target (float value) { _normalize_target = value; }
96 void set_tag (bool tag_it) { _tag = tag_it; }
97 void set_with_cue (bool yn) { _with_cue = yn; }
98 void set_with_toc (bool yn) { _with_toc = yn; }
100 void set_silence_beginning (AnyTime const & value) { _silence_beginning = value; }
101 void set_silence_end (AnyTime const & value) { _silence_end = value; }
103 /* Accessing functions */
105 PBD::UUID const & id () { return _id; }
106 std::string const & name () const { return _name; }
107 std::string description (bool include_name = true);
109 bool has_broadcast_info () const { return _has_broadcast_info; }
110 uint32_t channel_limit () const { return _channel_limit; }
111 std::string format_name () const { return _format_name; }
113 Type type () const { return _type; }
114 FormatId format_id () const { return *format_ids.begin(); }
115 Endianness endianness () const { return *endiannesses.begin(); }
116 SampleFormat sample_format () const { return *sample_formats.begin(); }
117 SampleRate sample_rate () const { return *sample_rates.begin(); }
118 Quality quality () const { return *qualities.begin(); }
120 DitherType dither_type () const { return _dither_type; }
121 SRCQuality src_quality () const { return _src_quality; }
122 bool trim_beginning () const { return _trim_beginning; }
123 bool trim_end () const { return _trim_end; }
124 bool normalize () const { return _normalize; }
125 float normalize_target () const { return _normalize_target; }
126 bool with_toc() const { return _with_toc; }
127 bool with_cue() const { return _with_cue; }
129 bool tag () const { return _tag && supports_tagging; }
131 framecnt_t silence_beginning_at (framepos_t position, framecnt_t samplerate) const
132 { return _silence_beginning.get_frames_at (position, samplerate); }
133 framecnt_t silence_end_at (framepos_t position, framecnt_t samplerate) const
134 { return _silence_end.get_frames_at (position, samplerate); }
136 AnyTime silence_beginning_time () const { return _silence_beginning; }
137 AnyTime silence_end_time () const { return _silence_end; }
141 XMLNode & get_state ();
142 int set_state (const XMLNode & root);
149 /* The variables below do not have setters (usually set via set_format) */
151 std::string _format_name;
152 bool has_sample_format;
153 bool supports_tagging;
154 bool _has_broadcast_info;
155 uint32_t _channel_limit;
157 /* The variables below have getters and setters */
163 DitherType _dither_type;
164 SRCQuality _src_quality;
168 bool _trim_beginning;
169 Time _silence_beginning;
174 float _normalize_target;
178 /* serialization helpers */
180 void add_option (XMLNode * node, std::string const & name, std::string const & value);
181 std::string get_option (XMLNode const * node, std::string const & name);
185 } // namespace ARDOUR
187 #endif /* __ardour_export_format_specification_h__ */