Logo Search packages:      
Sourcecode: ardour version File versions  Download package


    Copyright (C) 2000-2002 Paul Davis 

    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
    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., 675 Mass Ave, Cambridge, MA 02139, USA.


#ifndef __ardour_route_h__
#define __ardour_route_h__

#include <cmath>
#include <list>
#include <set>
#include <map>
#include <string>

#include <boost/shared_ptr.hpp>

#include <pbd/fastlog.h>
#include <glibmm/thread.h>
#include <pbd/xml++.h>
#include <pbd/undo.h>
#include <pbd/stateful.h> 
#include <pbd/controllable.h>
#include <pbd/destructible.h>

#include <ardour/ardour.h>
#include <ardour/io.h>
#include <ardour/session.h>
#include <ardour/redirect.h>
#include <ardour/types.h>

namespace ARDOUR {

class Insert;
class Send;
class RouteGroup;

enum mute_type {
    PRE_FADER =    0x1,
    POST_FADER =   0x2,
    CONTROL_OUTS = 0x4,
    MAIN_OUTS =    0x8

class Route : public IO

        typedef list<boost::shared_ptr<Redirect> > RedirectList;

      enum Flag {
            Hidden = 0x1,
            MasterOut = 0x2,
            ControlOut = 0x4

      Route (Session&, std::string name, int input_min, int input_max, int output_min, int output_max,
             Flag flags = Flag(0), DataType default_type = DataType::AUDIO);
      Route (Session&, const XMLNode&, DataType default_type = DataType::AUDIO);
      virtual ~Route();

      static std::string ensure_track_or_route_name(std::string, Session &);

      std::string comment() { return _comment; }
      void set_comment (std::string str, void *src);

      virtual int set_name (string str, void *src);

      long order_key (const char* name) const;
      void set_order_key (const char* name, long n);

      bool hidden() const { return _flags & Hidden; }
      bool master() const { return _flags & MasterOut; }
      bool control() const { return _flags & ControlOut; }

      /* these are the core of the API of a Route. see the protected sections as well */

      virtual int  roll (nframes_t nframes, nframes_t start_frame, nframes_t end_frame, 
                     int declick, bool can_record, bool rec_monitors_input);

      virtual int  no_roll (nframes_t nframes, nframes_t start_frame, nframes_t end_frame, 
                        bool state_changing, bool can_record, bool rec_monitors_input);

      virtual int  silent_roll (nframes_t nframes, nframes_t start_frame, nframes_t end_frame, 
                          bool can_record, bool rec_monitors_input);
      virtual void toggle_monitor_input ();
      virtual bool can_record() { return false; }
      virtual void set_record_enable (bool yn, void *src) {}
      virtual bool record_enabled() const { return false; }
      virtual void handle_transport_stopped (bool abort, bool did_locate, bool flush_redirects);
      virtual void set_pending_declick (int);

      /* end of vfunc-based API */

      void shift (nframes64_t, nframes64_t);

      /* override IO::set_gain() to provide group control */

      void set_gain (gain_t val, void *src);
      void inc_gain (gain_t delta, void *src);

      void set_solo (bool yn, void *src);
      bool soloed() const { return _soloed; }

      void set_solo_safe (bool yn, void *src);
      bool solo_safe() const { return _solo_safe; }
      void set_mute (bool yn, void *src);
      bool muted() const { return _muted; }
      bool solo_muted() const { return desired_solo_gain == 0.0; }

      void set_mute_config (mute_type, bool, void *src);
      bool get_mute_config (mute_type);

      void set_phase_invert (bool yn, void *src);
      bool phase_invert() const { return _phase_invert; }

      void set_denormal_protection (bool yn, void *src);
      bool denormal_protection() const { return _denormal_protection; }

      void       set_edit_group (RouteGroup *, void *);
      void       drop_edit_group (void *);
      RouteGroup *edit_group () { return _edit_group; }

      void       set_mix_group (RouteGroup *, void *);
      void       drop_mix_group (void *);
      RouteGroup *mix_group () { return _mix_group; }

      virtual void  set_meter_point (MeterPoint, void *src);
      MeterPoint  meter_point() const { return _meter_point; }

      /* Redirects */

      void flush_redirects ();

      template<class T> void foreach_redirect (T *obj, void (T::*func)(boost::shared_ptr<Redirect>)) {
            Glib::RWLock::ReaderLock lm (redirect_lock);
            for (RedirectList::iterator i = _redirects.begin(); i != _redirects.end(); ++i) {
                  (obj->*func) (*i);

      boost::shared_ptr<Redirect> nth_redirect (uint32_t n) {
            Glib::RWLock::ReaderLock lm (redirect_lock);
            RedirectList::iterator i;
            for (i = _redirects.begin(); i != _redirects.end() && n; ++i, --n);
            if (i == _redirects.end()) {
                  return boost::shared_ptr<Redirect> ();
            } else {
                  return *i;
      uint32_t max_redirect_outs () const { return redirect_max_outs; }
      int add_redirect (boost::shared_ptr<Redirect>, void *src, uint32_t* err_streams = 0);
      int add_redirects (const RedirectList&, void *src, uint32_t* err_streams = 0);
      int remove_redirect (boost::shared_ptr<Redirect>, void *src, uint32_t* err_streams = 0);
      int copy_redirects (const Route&, Placement, uint32_t* err_streams = 0);
      int sort_redirects (uint32_t* err_streams = 0);

      void clear_redirects (Placement, void *src);
      void all_redirects_flip();
      void all_redirects_active (Placement, bool state);

      virtual nframes_t update_total_latency();
      nframes_t signal_latency() const { return _own_latency; }
      virtual void set_latency_delay (nframes_t);

      sigc::signal<void,void*> solo_changed;
      sigc::signal<void,void*> solo_safe_changed;
      sigc::signal<void,void*> comment_changed;
      sigc::signal<void,void*> mute_changed;
      sigc::signal<void,void*> pre_fader_changed;
      sigc::signal<void,void*> post_fader_changed;
      sigc::signal<void,void*> control_outs_changed;
      sigc::signal<void,void*> main_outs_changed;
      sigc::signal<void,void*> redirects_changed;
      sigc::signal<void,void*> record_enable_changed;
      sigc::signal<void,void*> edit_group_changed;
      sigc::signal<void,void*> mix_group_changed;
      sigc::signal<void,void*> meter_change;

      /* gui's call this for their own purposes. */

      sigc::signal<void,std::string,void*> gui_changed;

      /* stateful */

      XMLNode& get_state();
      int set_state(const XMLNode& node);
      virtual XMLNode& get_template();

      int save_as_template (const std::string& path, const std::string& name);

      sigc::signal<void,void*> SelectedChanged;

      int set_control_outs (const vector<std::string>& ports);
      IO* control_outs() { return _control_outs; }

      bool feeds (boost::shared_ptr<Route>);
      set<boost::shared_ptr<Route> > fed_by;

      struct ToggleControllable : public PBD::Controllable {
          enum ToggleType {
                MuteControl = 0,
          ToggleControllable (std::string name, Route&, ToggleType);
          void set_value (float);
          float get_value (void) const;

          Route& route;
          ToggleType type;

      PBD::Controllable& solo_control() {
            return _solo_control;

      PBD::Controllable& mute_control() {
            return _mute_control;
      void automation_snapshot (nframes_t now, bool force);
      void protect_automation ();
      void set_remote_control_id (uint32_t id);
      uint32_t remote_control_id () const;
      sigc::signal<void> RemoteControlIDChanged;

      void sync_order_keys (const char* base);
      static sigc::signal<void,const char*> SyncOrderKeys;

      friend class Session;

      void catch_up_on_solo_mute_override ();
      void set_solo_mute (bool yn);
      void set_block_size (nframes_t nframes);
      bool has_external_redirects() const;
      void curve_reallocate ();

      Flag _flags;

      /* tight cache-line access here is more important than sheer speed of

      bool                     _muted : 1;
      bool                     _soloed : 1;
      bool                     _solo_safe : 1;
      bool                     _phase_invert : 1;
      bool                     _denormal_protection : 1;
      bool                     _recordable : 1;
      bool                     _mute_affects_pre_fader : 1;
      bool                     _mute_affects_post_fader : 1;
      bool                     _mute_affects_control_outs : 1;
      bool                     _mute_affects_main_outs : 1;
      bool                     _silent : 1;
      bool                     _declickable : 1;
      int                      _pending_declick;
      MeterPoint               _meter_point;

      gain_t                    solo_gain;
      gain_t                    mute_gain;
      gain_t                    desired_solo_gain;
      gain_t                    desired_mute_gain;

      nframes_t            check_initial_delay (nframes_t, nframes_t&);

      nframes_t           _initial_delay;
      nframes_t           _roll_delay;
      nframes_t           _own_latency;
      RedirectList             _redirects;
      Glib::RWLock      redirect_lock;
      IO                      *_control_outs;
      Glib::Mutex      control_outs_lock;
      RouteGroup              *_edit_group;
      RouteGroup              *_mix_group;
      std::string              _comment;
      bool                     _have_internal_generator;

      ToggleControllable _solo_control;
      ToggleControllable _mute_control;
      void passthru (nframes_t start_frame, nframes_t end_frame, 
                   nframes_t nframes, int declick, bool meter_inputs);

      void process_output_buffers (vector<Sample*>& bufs, uint32_t nbufs,
                             nframes_t start_frame, nframes_t end_frame,
                             nframes_t nframes, bool with_redirects, int declick,
                             bool meter);

      /* for derived classes */

      virtual XMLNode& state(bool);

      void silence (nframes_t nframes);
      sigc::connection input_signal_connection;

      uint32_t redirect_max_outs;
      uint32_t _remote_control_id;

      uint32_t pans_required() const;
      uint32_t n_process_buffers ();

      virtual int  _set_state (const XMLNode&, bool call_base);
      virtual void _set_redirect_states (const XMLNodeList&);

      void init ();

      static uint32_t order_key_cnt;

      struct ltstr
          bool operator()(const char* s1, const char* s2) const
                return strcmp(s1, s2) < 0;

      typedef std::map<const char*,long,ltstr> OrderKeys;
      OrderKeys order_keys;

      void input_change_handler (IOChange, void *src);
      void output_change_handler (IOChange, void *src);

      bool legal_redirect (Redirect&);
      int reset_plugin_counts (uint32_t*); /* locked */
      int _reset_plugin_counts (uint32_t*); /* unlocked */

      /* plugin count handling */

      struct InsertCount {
          boost::shared_ptr<ARDOUR::Insert> insert;
          int32_t cnt;
          int32_t in;
          int32_t out;

          InsertCount (boost::shared_ptr<ARDOUR::Insert> ins) : insert (ins), cnt (-1) {}
      int32_t apply_some_plugin_counts (std::list<InsertCount>& iclist);
      int32_t check_some_plugin_counts (std::list<InsertCount>& iclist, int32_t required_inputs, uint32_t* err_streams);

      void set_deferred_state ();
      void add_redirect_from_xml (const XMLNode&);
      void redirect_active_proxy (Redirect*, void*);

} // namespace ARDOUR

#endif /* __ardour_route_h__ */

Generated by  Doxygen 1.6.0   Back to index