Logo Search packages:      
Sourcecode: ardour version File versions


    Copyright (C) 2000 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.

    $Id: session.h,v 1.173 2005/03/03 16:32:54 pauld Exp $

#ifndef __ardour_session_h__
#define __ardour_session_h__

#include <string>
#if __GNUC__ >= 3
#include <ext/slist>
using __gnu_cxx::slist;
#include <slist.h>
#include <map>
#include <vector>
#include <set>
#include <stack>
#include <stdint.h>

#include <sndfile.h>

#include <pbd/error.h>
#include <pbd/atomic.h>
#include <pbd/lockmonitor.h>
#include <pbd/undo.h>
#include <pbd/pool.h>

#include <midi++/types.h>
#include <midi++/mmc.h>

#include <ardour/ardour.h>
#include <ardour/configuration.h>
#include <ardour/location.h>
#include <ardour/stateful.h>
#include <ardour/gain.h>
#include <ardour/io.h>

class XMLTree;
class XMLNode;
class AEffect;

namespace MIDI {
      class Port;

namespace ARDOUR {

class Port;
class AudioEngine;
class Slave;
class DiskStream; 
class Route;
class AuxInput;
class Source;
class FileSource;
class Auditioner;
class Insert;
class Send;
class Redirect;
class PortInsert;
class PluginInsert;
class Connection;
class TempoMap;
class AudioTrack;
class NamedSelection;
class AudioRegion;
class Region;
class Playlist;
class VSTPlugin;

struct AudioExportSpecification;
struct RouteGroup;

using std::vector;
using std::string;
using std::list;
using std::map;
using std::set;

class Session : public SigC::Object, public Stateful

      typedef std::pair<Route*,bool> RouteBooleanState;
      typedef vector<RouteBooleanState> GlobalRouteBooleanState;

      typedef std::pair<Route*,MeterPoint> RouteMeterState;
      typedef vector<RouteMeterState> GlobalRouteMeterState;

      enum RecordState {
            Disabled = 0,
            Enabled = 1,
            Recording = 2

      enum SlaveSource {
            None = 0,
      enum AutoConnectOption {
            AutoConnectPhysical = 0x1,
            AutoConnectMaster = 0x2

      struct Event {
          enum Type {
                /* only one of each of these events
                   can be queued at any one time


          enum Action {

          Type          type;
          Action              action;
          jack_nframes_t      action_frame;
          jack_nframes_t      target_frame;
          float               speed;

          union {
            void*                ptr;
            bool                 yes_or_no;
            Session::SlaveSource slave;

          list<AudioRange>     audio_range;
          list<MusicRange>     music_range;

          Event(Type t, Action a, jack_nframes_t when, jack_nframes_t where, float spd, bool yn = false)
                : type (t), 
                  action (a),
                  action_frame (when),
                  target_frame (where),
                  speed (spd),
                  yes_or_no (yn) {}

          void set_ptr (void* p) { 
                ptr = p;

          bool before (const Event& other) const {
                return action_frame < other.action_frame;

          bool after (const Event& other) const {
                return action_frame > other.action_frame;

          static bool compare (const Event *e1, const Event *e2) {
                return e1->before (*e2);

          void *operator new (size_t ignored) {
                return pool.alloc ();

          void operator delete(void *ptr, size_t size) {
                pool.release (ptr);

          static const jack_nframes_t Immediate = 0;

          static MultiAllocSingleReleasePool pool;

      /* creating from an XML file */

      Session (AudioEngine&,
             string fullpath,
             string snapshot_name,
             string* mix_template = 0);

      /* creating a new Session */

      Session (AudioEngine&,
             string fullpath,
             string snapshot_name,
             AutoConnectOption input_auto_connect,
             AutoConnectOption output_auto_connect,
             uint32_t control_out_channels,
             uint32_t master_out_channels,
             uint32_t n_physical_in,
             uint32_t n_physical_out,
             jack_nframes_t initial_length);
      virtual ~Session ();

      static int find_session (string str, string& path, string& snapshot, bool& isnew);
      string path() const { return _path; }
      string name() const { return _name; }
      string snap_name() const { return _current_snapshot_name; }

      void set_snap_name ();

      void set_dirty ();
      void set_clean ();
      bool dirty() const { return _state_of_the_state & Dirty; }
      SigC::Signal0<void> DirtyChanged;

      string sound_dir () const;
      string peak_dir () const;
      string dead_sound_dir () const;
      string automation_dir () const;

      static string template_path ();
      static string template_dir ();
      static void get_template_list (list<string>&);
      static string peak_path_from_audio_path (string);
      static string old_peak_path_from_audio_path (string);

      void process (jack_nframes_t nframes);

      vector<Sample*>& get_passthru_buffers() { return _passthru_buffers; }
      vector<Sample*>& get_silent_buffers (uint32_t howmany);

      DiskStream    *diskstream_by_id (id_t id);
      DiskStream    *diskstream_by_name (string name);

      bool have_captured() const { return _have_captured; }

      void refill_all_diskstream_buffers ();
      uint32_t diskstream_buffer_size() const { return dstream_buffer_size; }
      uint32_t get_next_diskstream_id() const { return n_diskstreams(); }
      uint32_t n_diskstreams() const;
      typedef list<DiskStream *> DiskStreamList;

      Session::DiskStreamList disk_streams() const {
            LockMonitor lm (diskstream_lock, __LINE__, __FILE__);
            return diskstreams; /* XXX yes, force a copy */

      void foreach_diskstream (void (DiskStream::*func)(void));
      template<class T> void foreach_diskstream (T *obj, void (T::*func)(DiskStream&));

      typedef slist<Route *> RouteList;

      RouteList get_routes() const {
            LockMonitor rlock (route_lock, __LINE__, __FILE__);
            return routes; /* XXX yes, force a copy */

      uint32_t nroutes() const { return routes.size(); }
      uint32_t ntracks () const;
      uint32_t nbusses () const;

      struct RoutePublicOrderSorter {
          bool operator() (Route *, Route *b);
      template<class T> void foreach_route (T *obj, void (T::*func)(Route&));
      template<class T> void foreach_route (T *obj, void (T::*func)(Route*));
      template<class T, class A> void foreach_route (T *obj, void (T::*func)(Route&, A), A arg);

      Route *route_by_name (string);

      bool route_name_unique (string) const;

      bool get_record_enabled() const { 
            return (record_status () >= Enabled);

      RecordState record_status() const {
            return (RecordState) atomic_read (&_record_status);

      bool actively_recording () {
            return record_status() == Recording;
      SigC::Signal0<void> going_away;

      /* Proxy signal for region hidden changes */

      SigC::Signal1<void,Region*> RegionHiddenChange;
      /* Record status signals */

      SigC::Signal0<void> RecordEnabled;
      SigC::Signal0<void> RecordDisabled;

      /* Transport mechanism signals */

      SigC::Signal0<void> TransportStateChange; /* generic */
      SigC::Signal1<void,jack_nframes_t> PositionChanged; /* sent after any non-sequential motion */
      SigC::Signal0<void> DurationChanged;
      SigC::Signal0<void> HaltOnXrun;

      SigC::Signal1<void,Route*> RouteAdded;
      SigC::Signal1<void,DiskStream*> DiskStreamAdded;

      void request_roll ();
      void request_bounded_roll (jack_nframes_t start, jack_nframes_t end);
      void request_stop (bool abort = false);
      void request_locate (jack_nframes_t frame, bool with_roll = false);
      void request_auto_loop (bool yn);
      jack_nframes_t  last_transport_start() const { return _last_roll_location; }
      void goto_end ()   { request_locate (end_location->start(), false);}
      void goto_start () { request_locate (0, false); }
      void use_rf_shuttle_speed ();
      void request_transport_speed (float speed);
      void request_overwrite_buffer (DiskStream*);
      void request_diskstream_speed (DiskStream&, float speed);
      void request_input_change_handling ();

      int wipe ();
      int wipe_diskstream (DiskStream *);

      int remove_region_from_region_list (Region&);

      jack_nframes_t current_end_frame() const { return end_location->start(); }
      jack_nframes_t frame_rate() const   { return _current_frame_rate; }
      jack_nframes_t frames_per_smpte_frame() const { return _frames_per_smpte_frame; }

      /* Locations */

      Locations *locations() { return &_locations; }

      SigC::Signal1<void,Location*>    auto_loop_location_changed;
      SigC::Signal1<void,Location*>    auto_punch_location_changed;
      SigC::Signal0<void>              locations_modified;

      void set_auto_punch_location (Location *);
      void set_auto_loop_location (Location *);

      bool record_enabling_legal () const;
      void maybe_enable_record ();
      void disable_record ();

      enum ControlType {

      SigC::Signal1<void,ControlType> ControlChanged;

      void set_auto_play (bool yn) { auto_play = yn; ControlChanged (AutoPlay); }
      void set_auto_return (bool yn) { auto_return = yn; ControlChanged (AutoReturn); }
      void set_auto_input (bool yn);
      void set_input_auto_connect (bool yn);
      void set_output_auto_connect (bool yn);
      void set_punch_in (bool yn);
      void set_punch_out (bool yn);
      void set_send_mtc (bool yn);
      void set_send_mmc (bool yn);
      void set_mmc_control (bool yn);
      void set_midi_feedback (bool yn);
      void set_midi_control (bool yn);
      void set_recording_plugins (bool yn) { recording_plugins = yn; ControlChanged (RecordingPlugins); }
      void set_crossfades_active (bool yn) { crossfades_active = yn; ControlChanged (CrossFadesActive); }
      void set_seamless_loop (bool yn);

      bool get_auto_play () const { return auto_play; }
      bool get_auto_input () const { return auto_input; }
      bool get_auto_loop () const { return auto_loop; }
      bool get_seamless_loop () const { return seamless_loop; }
      bool get_punch_in () const { return punch_in; }
      bool get_punch_out () const { return punch_out; }
      bool get_all_safe () const { return all_safe; }
      bool get_auto_return () const { return auto_return; }
      bool get_send_mtc () const;
      bool get_send_mmc () const;
      bool get_mmc_control () const { return mmc_control; }
      bool get_midi_feedback () const { return midi_feedback; }
      bool get_midi_control () const { return midi_control; }
      bool get_recording_plugins () const { return recording_plugins; }
      bool get_crossfades_active () const { return crossfades_active; }
      bool get_input_auto_connect () const { return input_auto_connect; }
      bool get_output_auto_connect () const { return output_auto_connect; }

      enum LayerModel {

      void set_layer_model (LayerModel);
      LayerModel get_layer_model () const { return layer_model; }

      SigC::Signal0<void> LayerModelChanged;

      void set_xfade_model (CrossfadeModel);
      CrossfadeModel get_xfade_model () const { return xfade_model; }

      enum AlignStyle {

      void set_align_style (AlignStyle);
      AlignStyle get_align_style () const { return align_style; }

      void add_event (jack_nframes_t action_frame, Event::Type type, jack_nframes_t target_frame = 0);
      void remove_event (jack_nframes_t frame, Event::Type type);
      void clear_events (Event::Type type);

      jack_nframes_t get_block_size() const { return current_block_size; }
      jack_nframes_t worst_output_latency () const { return _worst_output_latency; }
      jack_nframes_t worst_track_latency () const { return _worst_track_latency; }

      int save_state (string snapshot_name, bool pending = false);
      int restore_state (string snapshot_name);
      int save_template (string template_name);

      static int rename_template (string old_name, string new_name);

      static int delete_template (string name);
      SigC::Signal1<void,string> StateSaved;
      SigC::Signal0<void> StateReady;

      vector<string*>* possible_states() const;
      static vector<string*>* possible_states(string path);

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

      void add_instant_xml (XMLNode&, const std::string& dir);

      void swap_configuration(Configuration** new_config);
      void copy_configuration(Configuration* new_config);

      enum StateOfTheState {
            Clean = 0x0,
            Dirty = 0x1,
            CannotSave = 0x2,
            Deletion = 0x4,
            InitialConnecting = 0x8,
            Loading = 0x10,
            InCleanup = 0x20

      StateOfTheState state_of_the_state() const { return _state_of_the_state; }

      RouteGroup* add_edit_group (string);
      RouteGroup* add_mix_group (string);

      RouteGroup *mix_group_by_name (string);
      RouteGroup *edit_group_by_name (string);

      SigC::Signal1<void,RouteGroup*> edit_group_added;
      SigC::Signal1<void,RouteGroup*> mix_group_added;

      template<class T> void foreach_edit_group (T *obj, void (T::*func)(RouteGroup *)) {
            list<RouteGroup *>::iterator i;
            for (i = edit_groups.begin(); i != edit_groups.end(); i++) {

      template<class T> void foreach_mix_group (T *obj, void (T::*func)(RouteGroup *)) {
            list<RouteGroup *>::iterator i;
            for (i = mix_groups.begin(); i != mix_groups.end(); i++) {

      /* fundamental operations. duh. */

      AudioTrack *new_audio_track (int input_channels, int output_channels);

      Route *new_audio_route (int input_channels, int output_channels);

      void   remove_route (Route&);
      void   resort_routes (void *src);

      AudioEngine &engine() { return _engine; };

      /* configuration. there should really be accessors/mutators
         for these 

      float   meter_hold () { return _meter_hold; }
      void    set_meter_hold (float);
      SigC::Signal0<void> MeterHoldChanged;

      float   meter_falloff () { return _meter_falloff; }
      void    set_meter_falloff (float);
      SigC::Signal0<void> MeterFalloffChanged;
      int32_t  max_level;
      int32_t  min_level;
      string  click_emphasis_sound;
      string  click_sound;
      bool    click_requested;
      jack_nframes_t over_length_short;
      jack_nframes_t over_length_long;
      bool    send_midi_timecode;
      bool    send_midi_machine_control;
      float   shuttle_speed_factor;
      float   shuttle_speed_threshold;
      float   rf_speed;
      float   smpte_frames_per_second;
      bool    smpte_drop_frames;
      AnyTime preroll;
      AnyTime postroll;
      /* Time */

      jack_nframes_t transport_frame () const {return _transport_frame; }
      jack_nframes_t audible_frame () const;

      int  set_smpte_type (float fps, bool drop_frames);

      void bbt_time (jack_nframes_t when, BBT_Time&);

      void smpte_time (SMPTE_Time &);
      void smpte_time (jack_nframes_t when, SMPTE_Time&);
      void smpte_time_subframes (jack_nframes_t when, SMPTE_Time&);

      void smpte_duration (jack_nframes_t, SMPTE_Time&) const;
      void smpte_duration_string (char *, jack_nframes_t) const;

      void           set_smpte_offset (jack_nframes_t);
      jack_nframes_t smpte_offset () const { return _smpte_offset; }

      jack_nframes_t convert_to_frames_at (jack_nframes_t position, AnyTime&);

      SigC::Signal0<void> SMPTEOffsetChanged;
      SigC::Signal0<void> SMPTETypeChanged;

      void        request_slave_source (SlaveSource, jack_nframes_t pos = 0);
      SlaveSource slave_source() const { return _slave_type; }
      bool        synced_to_jack() const { return _slave_type == JACK; }
      float       transport_speed() const { return _transport_speed; }
      bool        transport_stopped() const { return _transport_speed == 0.0f; }
      bool        transport_rolling() const { return _transport_speed != 0.0f; }

      int jack_slave_sync (jack_nframes_t);

      TempoMap& tempo_map() { return *_tempo_map; }
      /* region info  */

      SigC::Signal1<void,AudioRegion *> AudioRegionAdded;
      SigC::Signal1<void,AudioRegion *> AudioRegionRemoved;

      int region_name (string& result, string base = string(""), bool newlevel = false) const;
      string new_region_name (string);
      string path_from_region_name (string name, string identifier);

      AudioRegion* find_whole_file_parent (AudioRegion&);
      void find_equivalent_playlist_regions (AudioRegion&, std::vector<AudioRegion*>& result);

      AudioRegion *XMLRegionFactory (const XMLNode&, bool full);

      template<class T> void foreach_audio_region (T *obj, void (T::*func)(AudioRegion *));

      /* source management */

      struct import_status {
            volatile bool  done;
            volatile bool  cancel;
            volatile float percent_done;
            string doing_what;

            /* control info */
            bool multichan;
            bool sample_convert;
            volatile bool freeze;
            string pathname;

      int import_audiofile (import_status&);
      bool sample_rate_convert (import_status&, string infile, string& outfile);
      string build_tmp_convert_name (string file);

      Session::SlaveSource post_export_slave;
      jack_nframes_t post_export_position;

      int start_audio_export (ARDOUR::AudioExportSpecification&);
      int stop_audio_export (ARDOUR::AudioExportSpecification&);
      void add_source (Source *);
      int  remove_file_source (FileSource&);

      struct cleanup_report {
          vector<string> paths;
          int32_t space;

      int  cleanup_sources (cleanup_report&);
      int  cleanup_trash_sources (cleanup_report&);

      int destroy_region (Region*);
      int destroy_regions (list<Region*>);

      int remove_last_capture ();

      /* handlers should return -1 for "stop cleanup", 0 for
         "yes, delete this playlist" and 1 for "no, don't delete
         this playlist.
      SigC::Signal1<int,ARDOUR::Playlist*> AskAboutPlaylistDeletion;

      /* handlers should return !0 for use pending state, 0 for
         ignore it.

      static SigC::Signal0<int> AskAboutPendingState;
      SigC::Signal1<void,Source *> SourceAdded;
      SigC::Signal1<void,Source *> SourceRemoved;

      FileSource *create_file_source (ARDOUR::DiskStream&, int32_t chan);
      Source *get_source (ARDOUR::id_t);

      /* playlist management */

      Playlist* playlist_by_name (string name);
      void add_playlist (Playlist *);
      SigC::Signal1<void,Playlist*> PlaylistAdded;
      SigC::Signal1<void,Playlist*> PlaylistRemoved;

      Playlist *get_playlist (string name);

      uint32_t n_playlists() const;

      template<class T> void foreach_playlist (T *obj, void (T::*func)(Playlist *));

      /* named selections */

      NamedSelection* named_selection_by_name (string name);
      void add_named_selection (NamedSelection *);
      void remove_named_selection (NamedSelection *);

      template<class T> void foreach_named_selection (T& obj, void (T::*func)(NamedSelection&));
      SigC::Signal0<void> NamedSelectionAdded;
      SigC::Signal0<void> NamedSelectionRemoved;

      /* fade curves */

      float get_default_fade_length () const { return default_fade_msecs; }
      float get_default_fade_steepness () const { return default_fade_steepness; }
      void set_default_fade (float steepness, float msecs);

      /* auditioning */

      Auditioner& the_auditioner() { return *auditioner; }
      void audition_playlist ();
      void audition_region (AudioRegion&);
      void cancel_audition ();
      bool is_auditioning () const;
      SigC::Signal1<void,bool> AuditionActive;

      /* flattening stuff */

      int write_one_track (AudioTrack&, jack_nframes_t start, jack_nframes_t cnt, bool overwrite, vector<Source*>&);
      int freeze ();

      /* session-wide solo/mute/rec-enable */

      enum SoloModel {
      bool soloing() const { return currently_soloing; }

      SoloModel solo_model() const { return _solo_model; }
      void set_solo_model (SoloModel);

      bool solo_latched() const { return _solo_latched; }
      void set_solo_latched (bool yn);
      void set_all_solo (bool);
      void set_all_mute (bool);

      SigC::Signal1<void,bool> SoloActive;
      void record_disenable_all ();
      void record_enable_all ();

      /* control/master out */

      IO* control_out() const { return _control_out; }
      IO* master_out() const { return _master_out; }

      /* insert/send management */
      uint32_t n_port_inserts() const { return _port_inserts.size(); }
      uint32_t n_plugin_inserts() const { return _plugin_inserts.size(); }
      uint32_t n_sends() const { return _sends.size(); }

      string next_send_name();
      string next_insert_name();
      /* s/w "RAID" management */
      jack_nframes_t available_capture_duration();

      /* I/O Connections */

      template<class T> void foreach_connection (T *obj, void (T::*func)(Connection *));
      void add_connection (Connection *);
      void remove_connection (Connection *);
      Connection *connection_by_name (string) const;

      SigC::Signal1<void,Connection *> ConnectionAdded;
      SigC::Signal1<void,Connection *> ConnectionRemoved;

      /* MIDI */
      int set_mtc_port (string port_tag);
      int set_mmc_port (string port_tag);
      int set_midi_port (string port_tag);
      MIDI::Port *mtc_port() const { return _mtc_port; }
      MIDI::Port *mmc_port() const { return _mmc_port; }
      MIDI::Port *midi_port() const { return _midi_port; }

      SigC::Signal0<void> MTC_PortChanged;
      SigC::Signal0<void> MMC_PortChanged;
      SigC::Signal0<void> MIDI_PortChanged;

      void set_trace_midi_input (bool, MIDI::Port* port = 0);
      void set_trace_midi_output (bool, MIDI::Port* port = 0);

      bool get_trace_midi_input(MIDI::Port *port = 0);
      bool get_trace_midi_output(MIDI::Port *port = 0);
      void send_midi_message (MIDI::Port * port, MIDI::eventType ev, MIDI::channel_t, MIDI::EventTwoBytes);
      void send_all_midi_feedback ();

      void deliver_midi (MIDI::Port*, MIDI::byte*, int32_t size);

      /* Scrubbing */

      void start_scrub (jack_nframes_t where);
      void stop_scrub ();
      void set_scrub_speed (float);
      jack_nframes_t scrub_buffer_size() const;
      SigC::Signal0<void> ScrubReady;

      /* History (for editors, mixers, UIs etc.) */

      void undo (uint32_t n) {
            history.undo (n);
      void redo (uint32_t n) {
            history.redo (n);

      uint32_t undo_depth() const { return history.undo_depth(); }
      uint32_t redo_depth() const { return history.redo_depth(); }
      string next_undo() const { return history.next_undo(); }
      string next_redo() const { return history.next_redo(); }

      void begin_reversible_command (string cmd_name, UndoAction *private_undo = 0);
      void commit_reversible_command (UndoAction* private_redo = 0);

      void add_undo (const UndoAction& ua) {
            current_cmd.add_undo (ua);
      void add_redo (const UndoAction& ua) {
            current_cmd.add_redo (ua);
      void add_redo_no_execute (const UndoAction& ua) {
            current_cmd.add_redo_no_execute (ua);

      UndoAction global_solo_memento (void *src);
      UndoAction global_mute_memento (void *src);
      UndoAction global_record_enable_memento (void *src);
      UndoAction global_metering_memento (void *src);

      /* edit mode */

      void set_edit_mode (EditMode);
      EditMode get_edit_mode () const { return _edit_mode; }

      /* clicking */

      IO&  click_io() { return *_click_io; }
      void set_clicking (bool yn);
      bool get_clicking() const { return _clicking; }

      void set_click_sound (string path);
      void set_click_emphasis_sound (string path);
      /* tempo FX */

      struct TimeStretchRequest {
          ARDOUR::AudioRegion* region;
          float                fraction; /* session: read ; GUI: write */
          float                progress; /* session: write ; GUI: read */
          bool                 running;  /* read/write */
          bool                 quick_seek; /* GUI: write */
          bool                 antialias;  /* GUI: write */

          TimeStretchRequest () : region (0) {}

      AudioRegion* tempoize_region (TimeStretchRequest&);

      string raid_path() const;
      void   set_raid_path(string);

      /* need to call this whenever we change native file formats */

      void reset_native_file_format();

      /* disk, buffer loads */

      uint32_t playback_load ();
      uint32_t capture_load ();
      uint32_t playback_load_min ();
      uint32_t capture_load_min ();

      void reset_playback_load_min ();
      void reset_capture_load_min ();
      float read_data_rate () const;
      float write_data_rate () const;

      /* ranges */

      void set_audio_range (list<AudioRange>&);
      void set_music_range (list<MusicRange>&);

      void request_play_range (bool yn);
      bool get_play_range () const { return _play_range; }

      /* favorite dirs */
      typedef vector<string> FavoriteDirs;

      static int read_favorite_dirs (FavoriteDirs&);

      static int write_favorite_dirs (FavoriteDirs&);
      /* file suffixes */

      static const char* template_suffix() { return _template_suffix; }
      static const char* statefile_suffix() { return _statefile_suffix; }
      static const char* pending_suffix() { return _pending_suffix; }

      /* buffers for gain and pan */

      gain_t* gain_automation_buffer () const { return _gain_automation_buffer; }
      pan_t** pan_automation_buffer() const { return _pan_automation_buffer; }

      /* VST support */

      static long vst_callback (AEffect* effect,
                          long opcode,
                          long index,
                          long value,
                          void* ptr,
                          float opt);
      friend class AudioEngine;
      void set_block_size (jack_nframes_t nframes);
      void set_frame_rate (jack_nframes_t nframes);

      friend class DiskStream;
      void stop_butler ();
      void wait_till_butler_finished();

      friend class Route;
      void schedule_curve_reallocation ();
      int  create (bool& new_session, string* mix_template, jack_nframes_t initial_length);

      static const char* _template_suffix;
      static const char* _statefile_suffix;
      static const char* _pending_suffix;

      enum SubState {
            PendingDeclickIn   = 0x1,
            PendingDeclickOut  = 0x2,
            StopPendingCapture = 0x4,
            AutoReturning      = 0x10,
            PendingLocate      = 0x20,
            PendingSetLoop     = 0x40

      /* stuff used in process() should be close together to
         maximise cache hits

      typedef void (Session::*process_function_type)(jack_nframes_t);

      AudioEngine            &_engine;
      atomic_t                 processing_prohibited;
      process_function_type    process_function;
      process_function_type    last_process_function;
      jack_nframes_t          _current_frame_rate;
      int                      transport_sub_state;
      atomic_t                _record_status;
      jack_nframes_t          _transport_frame;
      Location*                end_location;
      Slave                  *_slave;
      SlaveSource             _slave_type;
      float                   _transport_speed;
      volatile float          _desired_transport_speed;
      float                   _last_transport_speed;
      jack_nframes_t          _last_slave_transport_frame;
      jack_nframes_t           maximum_output_latency;
      jack_nframes_t           last_stop_frame;
      vector<Sample *>        _passthru_buffers;
      vector<Sample *>        _silent_buffers;
      jack_nframes_t           current_block_size;
      jack_nframes_t          _worst_output_latency;
      jack_nframes_t          _worst_track_latency;
      bool                    _have_captured;
      float                   _meter_hold;
      float                   _meter_falloff;
      void set_worst_output_latency (bool take_lock);
      void set_worst_output_latency_x (void *ignored) {
            set_worst_output_latency (true);

      void ensure_passthru_buffers (uint32_t howmany);
      void process_scrub          (jack_nframes_t);
      void process_without_events (jack_nframes_t);
      void process_with_events    (jack_nframes_t);
      void process_audition       (jack_nframes_t);
      int  process_export         (jack_nframes_t, ARDOUR::AudioExportSpecification*);
      /* slave tracking */

      static const int delta_accumulator_size = 25;
      int delta_accumulator_cnt;
      long delta_accumulator[delta_accumulator_size];
      long average_slave_delta;
      int  average_dir;
      bool have_first_delta_accumulator;
      enum SlaveState {
      SlaveState slave_state;
      jack_nframes_t slave_wait_end;

      void reset_slave_state ();
      bool follow_slave (jack_nframes_t, jack_nframes_t);

      bool _exporting;
      int prepare_to_export (ARDOUR::AudioExportSpecification&);

      void prepare_diskstreams ();
      void commit_diskstreams (jack_nframes_t, bool& session_requires_butler);
      int  process_routes (jack_nframes_t, jack_nframes_t);
      int  silent_process_routes (jack_nframes_t, jack_nframes_t);

      bool get_rec_monitors_input () {
            if (actively_recording()) {
                  return true;
            } else {
                  if (auto_input) {
                        return false;
                  } else {
                        return true;

      int get_transport_declick_required () {

            if (transport_sub_state & PendingDeclickIn) {
                  transport_sub_state &= ~PendingDeclickIn;
                  return 1;
            } else if (transport_sub_state & PendingDeclickOut) {
                  return -1;
            } else {
                  return 0;

      bool maybe_stop (jack_nframes_t limit) {
            if ((_transport_speed > 0.0f && _transport_frame >= limit) || (_transport_speed < 0.0f && _transport_frame == 0)) {
                  stop_transport ();
                  return true;
            return false;

      void check_declick_out ();

      MIDI::MachineControl*    mmc;
      MIDI::Port*             _mmc_port;
      MIDI::Port*             _mtc_port;
      MIDI::Port*             _midi_port;
      string                  _path;
      string                  _name;
      bool                     recording_plugins;

      /* toggles */

      bool auto_play;
      bool punch_in;
      bool punch_out;
      bool auto_loop;
      bool seamless_loop;
      bool loop_changing;
      jack_nframes_t last_loopend;
      bool auto_input;
      bool crossfades_active;
      bool all_safe;
      bool auto_return;
      bool monitor_in;
      bool send_mtc;
      bool send_mmc;
      bool mmc_control;
      bool midi_feedback;
      bool midi_control;
      RingBuffer<Event*> pending_events;

      void hookup_io ();
      void when_engine_running ();
      SigC::Connection first_time_running;
      void graph_reordered ();

      string _current_snapshot_name;

      XMLTree* state_tree;
      bool     state_was_pending;
      StateOfTheState _state_of_the_state;

      void     auto_save();
      int      load_options (const XMLNode&);
      XMLNode& get_options () const;
      int      load_state (string snapshot_name);

      jack_nframes_t   _last_roll_location;
      jack_nframes_t   _last_record_location;
      bool              pending_locate_roll;
      jack_nframes_t    pending_locate_frame;

      bool              pending_locate_flush;
      bool              pending_abort;
      bool              pending_auto_loop;
      Sample*              butler_mixdown_buffer;
      float*               butler_gain_buffer;
      pthread_t            butler_thread;
      PBD::NonBlockingLock butler_request_lock;
      pthread_cond_t       butler_paused;
      bool                 butler_should_run;
      atomic_t             butler_should_do_transport_work;
      int                  butler_request_pipe[2];
      struct ButlerRequest {
          enum Type {

      enum PostTransportWork {
            PostTransportStop               = 0x1,
            PostTransportDisableRecord      = 0x2,
            PostTransportPosition           = 0x8,
            PostTransportDidRecord          = 0x20,
            PostTransportDuration           = 0x40,
            PostTransportLocate             = 0x80,
            PostTransportRoll               = 0x200,
            PostTransportAbort              = 0x800,
            PostTransportOverWrite          = 0x1000,
            PostTransportSpeed              = 0x2000,
            PostTransportAudition           = 0x4000,
            PostTransportScrub              = 0x8000,
            PostTransportReverse            = 0x10000,
            PostTransportInputChange        = 0x20000,
            PostTransportCurveRealloc       = 0x40000
      static const PostTransportWork ProcessCannotProceedMask = 
            PostTransportWork (PostTransportInputChange|
      PostTransportWork post_transport_work;

      void             summon_butler ();
      void             schedule_butler_transport_work ();
      int              start_butler_thread ();
      void             terminate_butler_thread ();
      static void    *_butler_thread_work (void *arg);
      void*            butler_thread_work ();

      uint32_t    cumulative_rf_motion;
      uint32_t    rf_scale;

      void set_rf_speed (float speed);
      void reset_rf_scale (jack_nframes_t frames_moved);

      Locations        _locations;
      void              locations_changed ();
      void              handle_locations_changed (Locations::LocationList&);

      SigC::Connection auto_punch_start_changed_connection;
      SigC::Connection auto_punch_end_changed_connection;
      SigC::Connection auto_punch_changed_connection;
      void             auto_punch_start_changed (Location *);
      void             auto_punch_end_changed (Location *);
      void             auto_punch_changed (Location *);

      SigC::Connection auto_loop_start_changed_connection;
      SigC::Connection auto_loop_end_changed_connection;
      SigC::Connection auto_loop_changed_connection;
      void             auto_loop_changed (Location *);

      typedef list<Event *> Events;
      Events           events;
      Events           immediate_events;
      Events::iterator next_event;

      /* there can only ever be one of each of these */

      Event *auto_loop_event;
      Event *punch_out_event;
      Event *punch_in_event;

      /* events */

      void dump_events () const;
      void queue_event (Event *ev);
      void merge_event (Event*);
      void replace_event (Event::Type, jack_nframes_t action_frame, jack_nframes_t target = 0);
      bool _replace_event (Event*);
      bool _remove_event (Event *);
      void _clear_event_type (Event::Type);

      void first_stage_init (string path, string snapshot_name);
      int  second_stage_init (bool new_tracks);
      void find_current_end ();
      void remove_empty_sounds ();

      void setup_midi_control ();
      int  midi_read (MIDI::Port *);

      void enable_record () {
            atomic_set (&_record_status, Recording);
            _last_record_location = _transport_frame;
            send_mmc_in_another_thread (MIDI::MachineControl::cmdRecordStrobe);
            RecordEnabled ();
      void increment_transport_position (uint32_t val) {
            if (max_frames - val < _transport_frame) {
                  _transport_frame = max_frames;
            } else {
                  _transport_frame += val;

      void decrement_transport_position (uint32_t val) {
            if (val < _transport_frame) {
                  _transport_frame -= val;
            } else {
                  _transport_frame = 0;

      void post_transport_motion ();
      static void *session_loader_thread (void *arg);

      void *do_work();

      void set_next_event ();
      void process_event (Event *);

      /* MIDI Machine Control */

      void deliver_mmc (MIDI::MachineControl::Command, jack_nframes_t);
      void deliver_midi_message (MIDI::Port * port, MIDI::eventType ev, MIDI::channel_t, MIDI::EventTwoBytes);
      void deliver_data (MIDI::Port* port, MIDI::byte*, int32_t size);

      void mmc_deferred_play (MIDI::MachineControl &);
      void mmc_stop (MIDI::MachineControl &);
      void mmc_step (MIDI::MachineControl &, int);
      void mmc_record_pause (MIDI::MachineControl &);
      void mmc_record_strobe (MIDI::MachineControl &);
      void mmc_record_exit (MIDI::MachineControl &);
      void mmc_track_record_status (MIDI::MachineControl &, 
                              uint32_t track, bool enabled);
      void mmc_fast_forward (MIDI::MachineControl &);
      void mmc_rewind (MIDI::MachineControl &);
      void mmc_locate (MIDI::MachineControl &, const MIDI::byte *);
      void mmc_shuttle (MIDI::MachineControl &mmc, float speed, bool forw);
      void mmc_record_enable (MIDI::MachineControl &mmc, int32_t track, bool enabled);

      struct timeval last_mmc_step;
      double step_speed;

      typedef SigC::Slot0<bool> MidiTimeoutCallback;
      typedef list<MidiTimeoutCallback> MidiTimeoutList;

      MidiTimeoutList midi_timeouts;
      bool mmc_step_timeout ();

      MIDI::byte mmc_buffer[32];
      MIDI::byte mtc_msg[16];
      MIDI::byte mtc_smpte_bits;   /* encoding of SMTPE type for MTC */
      MIDI::byte midi_msg[16];
      jack_nframes_t  last_mtc_smpte_frame;
      jack_nframes_t  last_outbound_mtc_frame;   

      jack_nframes_t _frames_per_smpte_frame;
      jack_nframes_t _smpte_offset;

      /* cache the most-recently requested time conversions.
         this helps when we have multiple clocks showing the
         same time (e.g. the transport frame)

      bool       last_smpte_valid;
      jack_nframes_t  last_smpte_when;
      SMPTE_Time last_smpte;

      int send_full_time_code ();
      int send_midi_time_code ();

      void send_full_time_code_in_another_thread ();
      void send_midi_time_code_in_another_thread ();
      void send_time_code_in_another_thread (bool full);
      void send_mmc_in_another_thread (MIDI::MachineControl::Command, jack_nframes_t frame = 0);

      /* Feedback */

      typedef SigC::Slot0<int> FeedbackFunctionPtr;
      static void* _feedback_thread_work (void *);
      void* feedback_thread_work ();
      int feedback_generic_midi_function ();
      std::list<FeedbackFunctionPtr> feedback_functions;
      int active_feedback;
      int feedback_request_pipe[2];
      pthread_t feedback_thread;

      struct FeedbackRequest {
          enum Type {

      int init_feedback();
      int start_feedback ();
      int stop_feedback ();
      void terminate_feedback ();
      int  poke_feedback (FeedbackRequest::Type);

      jack_nframes_t adjust_apparent_position (jack_nframes_t frames);
      void reset_record_status ();
      int no_roll (jack_nframes_t nframes, jack_nframes_t offset);
      bool non_realtime_work_pending() const { return static_cast<bool>(post_transport_work); }
      bool process_can_proceed() const { return !(post_transport_work & ProcessCannotProceedMask); }

      struct MIDIRequest {
          enum Type {
          Type type;
          MIDI::MachineControl::Command mmc_cmd;
          jack_nframes_t locate_frame;

          // for SendMessage type

          MIDI::Port * port;
          MIDI::channel_t chan;
          union {
            MIDI::EventTwoBytes data;
            MIDI::byte* buf;

          union { 
            MIDI::eventType ev;
            int32_t size;

          MIDIRequest () {}
          void *operator new(size_t ignored) {
                return pool.alloc ();

          void operator delete(void *ptr, size_t size) {
                pool.release (ptr);

          static MultiAllocSingleReleasePool pool;

      PBD::Lock       midi_lock;
      pthread_t       midi_thread;
      int             midi_request_pipe[2];
      atomic_t        butler_active;
      RingBuffer<MIDIRequest*> midi_requests;

      int           start_midi_thread ();
      void          terminate_midi_thread ();
      void          poke_midi_thread ();
      static void *_midi_thread_work (void *arg);
      void          midi_thread_work ();
      void          change_midi_ports ();

      bool waiting_to_start;

      void set_auto_loop (bool yn);
      void overwrite_some_buffers (DiskStream*);
      void flush_all_redirects ();
      void locate (jack_nframes_t, bool with_roll, bool with_flush, bool with_loop=false);
      void start_locate (jack_nframes_t, bool with_roll, bool with_flush, bool with_loop=false);
      void force_locate (jack_nframes_t frame, bool with_roll = false);
      void set_diskstream_speed (DiskStream*, float speed);
      void set_transport_speed (float speed, bool abort = false);
      void stop_transport (bool abort = false);
      void start_transport ();
      void actually_start_transport ();
      void realtime_stop (bool abort);
      void non_realtime_start_scrub ();
      void non_realtime_set_speed ();
      void non_realtime_stop (bool abort);
      void non_realtime_overwrite ();
      void non_realtime_buffer_fill ();
      void butler_transport_work ();
      void post_transport ();
      void engine_halted ();
      void xrun_recovery ();

      TempoMap    *_tempo_map;
      void          tempo_map_changed (Change);

      /* edit/mix groups */

      int load_route_groups (const XMLNode&, bool is_edit);
      int load_edit_groups (const XMLNode&);
      int load_mix_groups (const XMLNode&);

      list<RouteGroup *> edit_groups;
      list<RouteGroup *> mix_groups;

      /* disk-streams */

      DiskStreamList  diskstreams; 
      mutable PBD::Lock diskstream_lock;
      uint32_t dstream_buffer_size;
      void add_diskstream (DiskStream*);
      int  load_diskstreams (const XMLNode&);

      /* routes stuff */

      RouteList       routes;
      mutable PBD::NonBlockingLock route_lock;
      void   add_route (Route*);

      int load_routes (const XMLNode&);
      Route* XMLRouteFactory (const XMLNode&);

      /* mixer stuff */

      bool      _solo_latched;
      SoloModel _solo_model;
      bool       solo_update_disabled;
      bool       currently_soloing;
      void route_mute_changed (void *src);
      void route_solo_changed (void *src, Route *);
      void catch_up_on_solo ();
      void update_route_solo_state ();
      void modify_solo_mute (bool, bool);
      void strip_portname_for_solo (string& portname);


      mutable PBD::Lock region_lock;
      typedef map<ARDOUR::id_t,AudioRegion *> AudioRegionList;
      AudioRegionList audio_regions;
      void region_renamed (Region *);
      void region_changed (Change, Region *);
      void add_region (Region *);
      void remove_region (Region *);

      int load_regions (const XMLNode& node);

      /* SOURCES */
      mutable PBD::Lock source_lock;
      typedef std::map<id_t, Source *>    SourceList;

      SourceList sources;

      int load_sources (const XMLNode& node);
      XMLNode& get_sources_as_xml ();

      void remove_source (Source *);

      Source *XMLSourceFactory (const XMLNode&);

      /* PLAYLISTS */
      mutable PBD::Lock playlist_lock;
      typedef set<Playlist *> PlaylistList;
      PlaylistList playlists;
      PlaylistList unused_playlists;

      int load_playlists (const XMLNode&);
      int load_unused_playlists (const XMLNode&);
      void remove_playlist (Playlist *);
      void track_playlist (Playlist *, bool);

      Playlist *playlist_factory (string name);
      Playlist *XMLPlaylistFactory (const XMLNode&);

      void playlist_length_changed (Playlist *);
      void diskstream_playlist_changed (DiskStream *);


      mutable PBD::Lock named_selection_lock;
      typedef set<NamedSelection *> NamedSelectionList;
      NamedSelectionList named_selections;

      int load_named_selections (const XMLNode&);

      NamedSelection *named_selection_factory (string name);
      NamedSelection *XMLNamedSelectionFactory (const XMLNode&);


      float default_fade_steepness;
      float default_fade_msecs;

      /* AUDITIONING */

      Auditioner *auditioner;
      void set_audition (AudioRegion*);
      void non_realtime_set_audition ();
      AudioRegion *pending_audition_region;

      /* EXPORT */

      /* FLATTEN */

      int flatten_one_track (AudioTrack&, jack_nframes_t start, jack_nframes_t cnt);

      slist<PortInsert *>   _port_inserts;
      slist<PluginInsert *> _plugin_inserts;
      slist<Send *>         _sends;
      uint32_t          send_cnt;
      uint32_t          insert_cnt;

      void add_redirect (Redirect *);
      void remove_redirect (Redirect *);

      /* S/W RAID */

      struct space_and_path {
          uint32_t blocks; /* 4kB blocks */
          string path;
          space_and_path() { 
                blocks = 0;

      struct space_and_path_ascending_cmp {
          bool operator() (space_and_path a, space_and_path b) {
                return a.blocks > b.blocks;
      void setup_raid_path (string path);

      vector<space_and_path> session_dirs;
      vector<space_and_path>::iterator last_rr_session_dir;
      uint32_t _total_free_4k_blocks;
      PBD::Lock space_lock;

      static const char* sound_dir_name;
      static const char* dead_sound_dir_name;
      static const char* peak_dir_name;

      string discover_best_sound_dir ();
      int ensure_sound_dir (string, string&);
      void refresh_disk_space ();

      atomic_t _playback_load;
      atomic_t _capture_load;
      atomic_t _playback_load_min;
      atomic_t _capture_load_min;

      /* I/O Connections */

      typedef list<Connection *> ConnectionList;
      mutable PBD::Lock connection_lock;
      ConnectionList _connections;
      int load_connections (const XMLNode&);

      int set_slave_source (SlaveSource, jack_nframes_t);

      void reverse_diskstream_buffers ();

      UndoHistory history;
      UndoCommand current_cmd;

      GlobalRouteBooleanState get_global_route_boolean (bool (Route::*method)(void) const);
      GlobalRouteMeterState get_global_route_metering ();

      void set_global_route_boolean (GlobalRouteBooleanState s, void (Route::*method)(bool, void*), void *arg);
      void set_global_route_metering (GlobalRouteMeterState s, void *arg);

      void set_global_mute (GlobalRouteBooleanState s, void *src);
      void set_global_solo (GlobalRouteBooleanState s, void *src);
      void set_global_record_enable (GlobalRouteBooleanState s, void *src);

      void jack_timebase_callback (jack_transport_state_t, jack_nframes_t, jack_position_t*, int);
      int  jack_sync_callback (jack_transport_state_t, jack_position_t*);
      void record_enable_change_all (bool yn);

      XMLNode& state(bool);

      /* click track */

      struct Click {
          jack_nframes_t start;
          jack_nframes_t duration;
          jack_nframes_t offset;
          const Sample *data;

          Click (jack_nframes_t s, jack_nframes_t d, const Sample *b) 
                : start (s), duration (d), data (b) { offset = 0; }
          void *operator new(size_t ignored) {
                return pool.alloc ();

          void operator delete(void *ptr, size_t size) {
                pool.release (ptr);

          static Pool pool;
      typedef list<Click*> Clicks;

      Clicks          clicks;
      bool           _clicking;
      IO*            _click_io;
      Sample*         click_data;
      Sample*         click_emphasis_data;
      jack_nframes_t  click_length;
      jack_nframes_t  click_emphasis_length;

      static const Sample         default_click[];
      static const jack_nframes_t default_click_length;
      static const Sample         default_click_emphasis[];
      static const jack_nframes_t default_click_emphasis_length;

      Click *get_click();
      void   setup_click_sounds (int which);
      void   clear_clicks ();
      void   click (jack_nframes_t start, jack_nframes_t nframes, jack_nframes_t offset);

      vector<Route*> master_outs;
      EditMode _edit_mode;
      EditMode pending_edit_mode;

      /* range playback */

      list<AudioRange> current_audio_range;
      bool _play_range;
      void set_play_range (bool yn);
      void setup_auto_play ();

      /* main outs */
      uint32_t main_outs;
      IO* _master_out;
      IO* _control_out;

      AutoConnectOption input_auto_connect;
      AutoConnectOption output_auto_connect;

      AlignStyle align_style;

      gain_t* _gain_automation_buffer;
      pan_t** _pan_automation_buffer;
      void allocate_pan_automation_buffers (jack_nframes_t nframes, uint32_t howmany, bool force);
      uint32_t _npan_buffers;

      /* VST support */

      long _vst_callback (VSTPlugin*,
                      long opcode,
                      long index,
                      long value,
                      void* ptr,
                      float opt);

      /* number of hardware audio ports we're using,
         based on max (requested,available)

      uint32_t n_physical_outputs;
      uint32_t n_physical_inputs;

      void remove_pending_capture_state ();

      int find_all_sources (std::string path, std::set<std::string>& result);
      int find_all_sources_across_snapshots (std::set<std::string>& result, bool exclude_this_snapshot);

      LayerModel layer_model;
      CrossfadeModel xfade_model;

}; /* namespace ARDOUR */

#endif /* __ardour_session_h__ */

Generated by  Doxygen 1.6.0   Back to index