port_set.h

Go to the documentation of this file.

/*
 * 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"
namespace ARDOUR {
 
class Port;
class AudioPort;
class MidiPort;
 
class LIBARDOUR_API PortSet {
public:
        PortSet();
 
        size_t num_ports() const;
        size_t num_ports(DataType type) const { return _ports[type].size(); }
 
        void add (std::shared_ptr<Port> port);
        bool remove (std::shared_ptr<Port> port);
 
        std::shared_ptr<Port> port(size_t index) const;
 
        std::shared_ptr<Port> port(DataType t, size_t index) const;
 
        std::shared_ptr<AudioPort> nth_audio_port(size_t n) const;
 
        std::shared_ptr<MidiPort> nth_midi_port(size_t n) const;
 
        bool contains (std::shared_ptr<const Port> port) const;
 
        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:
                std::shared_ptr<P> operator*()  { return _set.port(_type, _index); }
                std::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& list, DataType type, size_t index)
                        : _set (list)
                        , _type (type)
                        , _index (index)
                {
                }
 
                PS&      _set;
                DataType _type; 
                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:
                std::shared_ptr<AudioPort> operator*()  { return _set.nth_audio_port(_index); }
                std::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<std::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__