156 lines
4.9 KiB
C++
156 lines
4.9 KiB
C++
/*
|
|
* Copyright (C) 2006-2009 David Robillard <d@drobilla.net>
|
|
* Copyright (C) 2008-2013 Paul Davis <paul@linuxaudiosystems.com>
|
|
* Copyright (C) 2009-2012 Carl Hetherington <carl@carlh.net>
|
|
*
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License along
|
|
* with this program; if not, write to the Free Software Foundation, Inc.,
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
|
|
*/
|
|
|
|
#ifndef __ardour_port_set_h__
|
|
#define __ardour_port_set_h__
|
|
|
|
#include <vector>
|
|
#include "ardour/chan_count.h"
|
|
#include <boost/utility.hpp>
|
|
|
|
namespace ARDOUR {
|
|
|
|
class Port;
|
|
class AudioPort;
|
|
class MidiPort;
|
|
|
|
/** An ordered list of Ports, possibly of various types.
|
|
*
|
|
* This allows access to all the ports as a list, ignoring type, or accessing
|
|
* the nth port of a given type. Note that port(n) and nth_audio_port(n) may
|
|
* NOT return the same port.
|
|
*
|
|
* Each port is held twice; once in a per-type vector of vectors (_ports)
|
|
* and once in a vector of all port (_all_ports). This is to speed up the
|
|
* fairly common case of iterating over all ports.
|
|
*/
|
|
class LIBARDOUR_API PortSet : public boost::noncopyable {
|
|
public:
|
|
PortSet();
|
|
|
|
size_t num_ports() const;
|
|
size_t num_ports(DataType type) const { return _ports[type].size(); }
|
|
|
|
void add (boost::shared_ptr<Port> port);
|
|
bool remove (boost::shared_ptr<Port> port);
|
|
|
|
/** nth port
|
|
* @param index port index
|
|
*/
|
|
boost::shared_ptr<Port> port(size_t index) const;
|
|
|
|
/** nth port of type @a t, or nth port if t = NIL
|
|
* @param t data type
|
|
* @param index port index
|
|
*/
|
|
boost::shared_ptr<Port> port(DataType t, size_t index) const;
|
|
|
|
boost::shared_ptr<AudioPort> nth_audio_port(size_t n) const;
|
|
|
|
boost::shared_ptr<MidiPort> nth_midi_port(size_t n) const;
|
|
|
|
bool contains (boost::shared_ptr<const Port> port) const;
|
|
|
|
/** Remove all ports from the PortSet. Ports are not deregistered with
|
|
* the engine, it's the caller's responsibility to not leak here!
|
|
*/
|
|
void clear();
|
|
|
|
const ChanCount& count() const { return _count; }
|
|
|
|
bool empty() const { return (_count.n_total() == 0); }
|
|
|
|
template<typename PS, typename P>
|
|
class iterator_base {
|
|
public:
|
|
boost::shared_ptr<P> operator*() { return _set.port(_type, _index); }
|
|
boost::shared_ptr<P> operator->() { return _set.port(_type, _index); }
|
|
iterator_base<PS,P>& operator++() { ++_index; return *this; } // yes, prefix only
|
|
bool operator==(const iterator_base<PS,P>& other) { return (_index == other._index); }
|
|
bool operator!=(const iterator_base<PS,P>& other) { return (_index != other._index); }
|
|
|
|
private:
|
|
friend class PortSet;
|
|
|
|
iterator_base<PS,P>(PS& list, DataType type, size_t index)
|
|
: _set(list), _type(type), _index(index) {}
|
|
|
|
PS& _set;
|
|
DataType _type; ///< Ignored if NIL (to iterator over entire set)
|
|
size_t _index;
|
|
};
|
|
|
|
typedef iterator_base<PortSet, Port> iterator;
|
|
typedef iterator_base<const PortSet, const Port> const_iterator;
|
|
|
|
iterator begin(DataType type = DataType::NIL) {
|
|
return iterator(*this, type, 0);
|
|
}
|
|
|
|
iterator end(DataType type = DataType::NIL) {
|
|
return iterator(*this, type,
|
|
(type == DataType::NIL) ? _count.n_total() : _count.get(type));
|
|
}
|
|
|
|
const_iterator begin(DataType type = DataType::NIL) const {
|
|
return const_iterator(*this, type, 0);
|
|
}
|
|
|
|
const_iterator end(DataType type = DataType::NIL) const {
|
|
return const_iterator(*this, type,
|
|
(type == DataType::NIL) ? _count.n_total() : _count.get(type));
|
|
}
|
|
|
|
class audio_iterator {
|
|
public:
|
|
boost::shared_ptr<AudioPort> operator*() { return _set.nth_audio_port(_index); }
|
|
boost::shared_ptr<AudioPort> operator->() { return _set.nth_audio_port(_index); }
|
|
audio_iterator& operator++() { ++_index; return *this; } // yes, prefix only
|
|
bool operator==(const audio_iterator& other) { return (_index == other._index); }
|
|
bool operator!=(const audio_iterator& other) { return (_index != other._index); }
|
|
|
|
private:
|
|
friend class PortSet;
|
|
|
|
audio_iterator(PortSet& list, size_t index) : _set(list), _index(index) {}
|
|
|
|
PortSet& _set;
|
|
size_t _index;
|
|
};
|
|
|
|
audio_iterator audio_begin() { return audio_iterator(*this, 0); }
|
|
audio_iterator audio_end() { return audio_iterator(*this, _count.n_audio()); }
|
|
|
|
private:
|
|
typedef std::vector<boost::shared_ptr<Port> > PortVec;
|
|
|
|
// Vector of vectors, indexed by DataType::to_index()
|
|
std::vector<PortVec> _ports;
|
|
// All ports in _ports in one vector, to speed some operations
|
|
PortVec _all_ports;
|
|
|
|
ChanCount _count;
|
|
};
|
|
|
|
|
|
} // namespace ARDOUR
|
|
|
|
#endif // __ardour_port_set_h__
|