2 Copyright (C) 2006 Paul Davis
5 This program is free software; you can redistribute it and/or modify it
6 under the terms of the GNU General Public License as published by the Free
7 Software Foundation; either version 2 of the License, or (at your option)
10 This program is distributed in the hope that it will be useful, but WITHOUT
11 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
15 You should have received a copy of the GNU General Public License along
16 with this program; if not, write to the Free Software Foundation, Inc.,
17 675 Mass Ave, Cambridge, MA 02139, USA.
20 #ifndef __ardour_data_type_h__
21 #define __ardour_data_type_h__
24 #include <jack/jack.h>
29 /** A type of Data Ardour is capable of processing.
31 * The majority of this class is dedicated to conversion to and from various
32 * other type representations, simple comparison between then, etc. This code
33 * is deliberately 'ugly' so other code doesn't have to be.
38 /** Numeric symbol for this DataType.
40 * Castable to int for use as an array index (e.g. by ChanCount).
41 * Note this means NIL is (ntypes-1) and guaranteed to change when
42 * types are added, so this number is NOT suitable for serialization,
43 * network, or binary anything.
45 * WARNING: The number of non-NIL entries here must match num_types.
53 /** Number of types (not including NIL).
54 * WARNING: make sure this matches Symbol!
56 static const uint32_t num_types = 2;
58 DataType(const Symbol& symbol)
62 /** Construct from a string (Used for loading from XML and Ports)
63 * The string can be as in an XML file (eg "audio" or "midi"), or a
64 * Jack type string (from jack_port_type) */
65 DataType(const std::string& str)
67 if (str == "audio" || str == JACK_DEFAULT_AUDIO_TYPE)
69 else if (str == "midi" || str == JACK_DEFAULT_MIDI_TYPE)
73 /** Get the Jack type this DataType corresponds to */
74 const char* to_jack_type() const {
76 case AUDIO: return JACK_DEFAULT_AUDIO_TYPE;
77 case MIDI: return JACK_DEFAULT_MIDI_TYPE;
82 /** Inverse of the from-string constructor */
83 const char* to_string() const {
85 case AUDIO: return "audio";
86 case MIDI: return "midi";
87 default: return "unknown"; // reeeally shouldn't ever happen
91 inline operator uint32_t() const { return (uint32_t)_symbol; }
93 /** DataType iterator, for writing generic loops that iterate over all
99 iterator(uint32_t index) : _index(index) {}
101 DataType operator*() { return DataType((Symbol)_index); }
102 iterator& operator++() { ++_index; return *this; } // yes, prefix only
103 bool operator==(const iterator& other) { return (_index == other._index); }
104 bool operator!=(const iterator& other) { return (_index != other._index); }
107 friend class DataType;
112 static iterator begin() { return iterator(0); }
113 static iterator end() { return iterator(num_types); }
115 bool operator==(const Symbol symbol) { return (_symbol == symbol); }
116 bool operator!=(const Symbol symbol) { return (_symbol != symbol); }
118 bool operator==(const DataType other) { return (_symbol == other._symbol); }
119 bool operator!=(const DataType other) { return (_symbol != other._symbol); }
122 Symbol _symbol; // could be const if not for the string constructor
127 } // namespace ARDOUR
129 #endif // __ardour_data_type_h__