/*
- Copyright (C) 2000 Paul Davis
+ Copyright (C) 2000-2006 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
along with this program; if not, write to the Free Software
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
- $Id$
*/
#ifndef __ardour_diskstream_h__
#define __ardour_diskstream_h__
-#include <sigc++/signal.h>
-
-#include <cmath>
#include <string>
#include <queue>
#include <map>
#include <vector>
-
+#include <cmath>
#include <time.h>
-#include <pbd/fastlog.h>
-#include <pbd/ringbufferNPT.h>
-#include <pbd/atomic.h>
+#include <sigc++/signal.h>
+
+#include <boost/utility.hpp>
+
+#include "evoral/types.hpp"
-#include <ardour/ardour.h>
-#include <ardour/configuration.h>
-#include <ardour/session.h>
-#include <ardour/route_group.h>
-#include <ardour/route.h>
-#include <ardour/port.h>
-#include <ardour/utils.h>
-#include <ardour/stateful.h>
+#include "pbd/fastlog.h"
+#include "pbd/ringbufferNPT.h"
+#include "pbd/stateful.h"
+#include "pbd/statefuldestructible.h"
+
+#include "ardour/ardour.h"
+#include "ardour/location.h"
+#include "ardour/session_object.h"
+#include "ardour/types.h"
+#include "ardour/utils.h"
+#include "ardour/chan_count.h"
struct tm;
namespace ARDOUR {
class AudioEngine;
+class IO;
+class Playlist;
+class Processor;
+class Region;
+class Route;
class Send;
class Session;
-class AudioPlaylist;
-class FileSource;
-class IO;
-class DiskStream : public Stateful, public sigc::trackable
-{
+class Diskstream : public SessionObject, public boost::noncopyable
+{
public:
enum Flag {
- Recordable = 0x1,
- Hidden = 0x2
+ Recordable = 0x1,
+ Hidden = 0x2,
+ Destructive = 0x4,
+ NonLayered = 0x8
};
- DiskStream (Session &, const string& name, Flag f = Recordable);
- DiskStream (Session &, const XMLNode&);
+ Diskstream (Session &, const std::string& name, Flag f = Recordable);
+ Diskstream (Session &, const XMLNode&);
+ virtual ~Diskstream();
- string name() const { return _name; }
+ bool set_name (const std::string& str);
- ARDOUR::IO* io() const { return _io; }
- void set_io (ARDOUR::IO& io);
+ boost::shared_ptr<ARDOUR::IO> io() const { return _io; }
+ void set_route (ARDOUR::Route&);
- DiskStream& ref() { _refcnt++; return *this; }
- void unref() { if (_refcnt) _refcnt--; if (_refcnt == 0) delete this; }
- uint32_t refcnt() const { return _refcnt; }
+ virtual float playback_buffer_load() const = 0;
+ virtual float capture_buffer_load() const = 0;
- float playback_buffer_load() const;
- float capture_buffer_load() const;
+ void set_flag (Flag f) { _flags = Flag (_flags | f); }
+ void unset_flag (Flag f) { _flags = Flag (_flags & ~f); }
- void set_flag (Flag f) {
- _flags |= f;
- }
+ AlignStyle alignment_style() const { return _alignment_style; }
+ void set_align_style (AlignStyle);
+ void set_persistent_align_style (AlignStyle a) { _persistent_alignment_style = a; }
- void unset_flag (Flag f) {
- _flags &= ~f;
- }
+ nframes_t roll_delay() const { return _roll_delay; }
+ void set_roll_delay (nframes_t);
- AlignStyle alignment_style() const { return _alignment_style; }
- void set_align_style (AlignStyle);
- void set_persistent_align_style (AlignStyle);
+ bool record_enabled() const { return g_atomic_int_get (&_record_enabled); }
+ virtual void set_record_enabled (bool yn) = 0;
- bool hidden() const { return _flags & Hidden; }
- bool recordable() const { return _flags & Recordable; }
+ bool destructive() const { return _flags & Destructive; }
+ virtual int set_destructive (bool /*yn*/) { return -1; }
+ virtual int set_non_layered (bool /*yn*/) { return -1; }
+ virtual bool can_become_destructive (bool& /*requires_bounce*/) const { return false; }
- jack_nframes_t roll_delay() const { return _roll_delay; }
- void set_roll_delay (jack_nframes_t);
+ bool hidden() const { return _flags & Hidden; }
+ bool recordable() const { return _flags & Recordable; }
+ bool non_layered() const { return _flags & NonLayered; }
+ bool reversed() const { return _actual_speed < 0.0f; }
+ double speed() const { return _visible_speed; }
- void set_name (string str, void* src);
+ virtual void punch_in() {}
+ virtual void punch_out() {}
- string input_source (uint32_t n=0) const {
- if (n < channels.size()) {
- return channels[n].source ? channels[n].source->name() : "";
- } else {
- return "";
- }
- }
+ void set_speed (double);
+ void non_realtime_set_speed ();
+ virtual void non_realtime_locate (nframes_t /*location*/) {};
+ virtual void playlist_modified ();
- Port *input_source_port (uint32_t n=0) const {
- if (n < channels.size()) return channels[n].source; return 0;
- }
+ boost::shared_ptr<Playlist> playlist () { return _playlist; }
- void set_record_enabled (bool yn, void *src);
- bool record_enabled() const { return atomic_read (&_record_enabled); }
- void punch_in ();
- void punch_out ();
+ virtual int use_playlist (boost::shared_ptr<Playlist>);
+ virtual int use_new_playlist () = 0;
+ virtual int use_copy_playlist () = 0;
- bool reversed() const { return _actual_speed < 0.0f; }
- double speed() const { return _visible_speed; }
- void set_speed (double);
+ nframes_t current_capture_start() const { return capture_start_frame; }
+ nframes_t current_capture_end() const { return capture_start_frame + capture_captured; }
+ nframes_t get_capture_start_frame (uint32_t n=0);
+ nframes_t get_captured_frames (uint32_t n=0);
- float peak_power(uint32_t n=0) {
- float x = channels[n].peak_power;
- channels[n].peak_power = 0.0f;
- if (x > 0.0f) {
- return 20.0f * fast_log10(x);
- } else {
- return minus_infinity();
- }
- }
-
- int use_playlist (AudioPlaylist *);
- int use_new_playlist ();
- int use_copy_playlist ();
-
- void start_scrub (jack_nframes_t where);
- void end_scrub ();
-
- Sample *playback_buffer (uint32_t n=0) {
- if (n < channels.size())
- return channels[n].current_playback_buffer;
- return 0;
- }
-
- Sample *capture_buffer (uint32_t n=0) {
- if (n < channels.size())
- return channels[n].current_capture_buffer;
- return 0;
- }
-
- AudioPlaylist *playlist () { return _playlist; }
-
- FileSource *fades_source (uint32_t n=0) {
- if (n < channels.size())
- return channels[n].fades_source;
- return 0;
- }
- FileSource *write_source (uint32_t n=0) {
- if (n < channels.size())
- return channels[n].write_source;
- return 0;
- }
-
- jack_nframes_t current_capture_start() const { return capture_start_frame; }
- jack_nframes_t current_capture_end() const { return capture_start_frame + capture_captured; }
- jack_nframes_t get_capture_start_frame (uint32_t n=0);
- jack_nframes_t get_captured_frames (uint32_t n=0);
-
- uint32_t n_channels() { return _n_channels; }
+ ChanCount n_channels() { return _n_channels; }
- int add_channel ();
- int remove_channel ();
-
- static void set_disk_io_chunk_frames (uint32_t n) {
- disk_io_chunk_frames = n;
- }
+ static nframes_t disk_io_frames() { return disk_io_chunk_frames; }
+ static void set_disk_io_chunk_frames (uint32_t n) { disk_io_chunk_frames = n; }
- static jack_nframes_t disk_io_frames() { return disk_io_chunk_frames; }
+ /* Stateful */
+ virtual XMLNode& get_state(void) = 0;
+ virtual int set_state(const XMLNode&, int version = 3000) = 0;
- sigc::signal<void,void*> record_enable_changed;
- sigc::signal<void> speed_changed;
- sigc::signal<void,void*> reverse_changed;
- sigc::signal<void> PlaylistChanged;
- sigc::signal<void> AlignmentStyleChanged;
-
- static sigc::signal<void> DiskOverrun;
- static sigc::signal<void> DiskUnderrun;
- static sigc::signal<void,DiskStream*> DiskStreamCreated; // XXX use a ref with sigc2
- static sigc::signal<void,DiskStream*> CannotRecordNoInput; // XXX use a ref with sigc2
- static sigc::signal<void,list<Source*>*> DeleteSources;
-
- /* stateful */
-
- XMLNode& get_state(void);
- int set_state(const XMLNode& node);
-
- void monitor_input (bool);
-
- jack_nframes_t capture_offset() const { return _capture_offset; }
- void set_capture_offset ();
-
- static void swap_by_ptr (Sample *first, Sample *last) {
- while (first < last) {
- Sample tmp = *first;
- *first++ = *last;
- *last-- = tmp;
- }
- }
-
- static void swap_by_ptr (Sample *first, Sample *last, jack_nframes_t n) {
- while (n--) {
- Sample tmp = *first;
- *first++ = *last;
- *last-- = tmp;
- }
- }
-
- bool slaved() const { return _slaved; }
+ virtual void monitor_input (bool) {}
+
+ nframes_t capture_offset() const { return _capture_offset; }
+ virtual void set_capture_offset ();
+
+ bool slaved() const { return _slaved; }
void set_slaved(bool yn) { _slaved = yn; }
int set_loop (Location *loc);
- sigc::signal<void,Location *> LoopSet;
- std::list<Region*>& last_capture_regions () {
- return _last_capture_regions;
- }
+ std::list<boost::shared_ptr<Region> >& last_capture_regions () { return _last_capture_regions; }
void handle_input_change (IOChange, void *src);
- id_t id() const { return _id; }
+ void remove_region_from_last_capture (boost::weak_ptr<Region> wregion);
- XMLNode* deprecated_io_node;
+ void move_processor_automation (boost::weak_ptr<Processor>,
+ std::list< Evoral::RangeMove<nframes_t> > const &);
+
+ sigc::signal<void> RecordEnableChanged;
+ sigc::signal<void> SpeedChanged;
+ sigc::signal<void> ReverseChanged;
+ sigc::signal<void> PlaylistChanged;
+ sigc::signal<void> AlignmentStyleChanged;
+ sigc::signal<void,Location *> LoopSet;
+
+ static sigc::signal<void> DiskOverrun;
+ static sigc::signal<void> DiskUnderrun;
protected:
friend class Session;
- /* the Session is the only point of access for these
- because they require that the Session is "inactive"
- while they are called.
- */
+ /* the Session is the only point of access for these because they require
+ * that the Session is "inactive" while they are called.
+ */
- void set_pending_overwrite (bool);
- int overwrite_existing_buffers ();
- void reverse_scrub_buffer (bool to_forward);
- void set_block_size (jack_nframes_t);
- int internal_playback_seek (jack_nframes_t distance);
- int can_internal_playback_seek (jack_nframes_t distance);
- void reset_write_sources (bool);
- void non_realtime_input_change ();
+ virtual void set_pending_overwrite (bool) = 0;
+ virtual int overwrite_existing_buffers () = 0;
+ virtual void set_block_size (nframes_t) = 0;
+ virtual int internal_playback_seek (nframes_t distance) = 0;
+ virtual int can_internal_playback_seek (nframes_t distance) = 0;
+ virtual int rename_write_sources () = 0;
+ virtual void reset_write_sources (bool, bool force = false) = 0;
+ virtual void non_realtime_input_change () = 0;
uint32_t read_data_count() const { return _read_data_count; }
uint32_t write_data_count() const { return _write_data_count; }
protected:
friend class Auditioner;
- int seek (jack_nframes_t which_sample, bool complete_refill = false);
+ virtual int seek (nframes_t which_sample, bool complete_refill = false) = 0;
protected:
- friend class AudioTrack;
-
- void prepare ();
- int process (jack_nframes_t transport_frame, jack_nframes_t nframes, jack_nframes_t offset, bool can_record, bool rec_monitors_input);
- bool commit (jack_nframes_t nframes);
- void recover (); /* called if commit will not be called, but process was */
+ friend class Track;
- private:
+ virtual void prepare ();
+ virtual int process (nframes_t transport_frame, nframes_t nframes, bool can_record, bool rec_monitors_input) = 0;
+ virtual bool commit (nframes_t nframes) = 0;
+ virtual void recover (); /* called if commit will not be called, but process was */
- /* use unref() to destroy a diskstream */
+ //private:
- ~DiskStream();
-
- struct ChannelInfo {
+ enum TransitionType {
+ CaptureStart = 0,
+ CaptureEnd
+ };
- Sample *playback_wrap_buffer;
- Sample *capture_wrap_buffer;
- Sample *speed_buffer;
+ struct CaptureTransition {
+ TransitionType type;
+ nframes_t capture_val; ///< The start or end file frame position
+ };
- float peak_power;
+ /* The two central butler operations */
+ virtual int do_flush (RunContext context, bool force = false) = 0;
+ virtual int do_refill () = 0;
- FileSource *fades_source;
- FileSource *write_source;
+ /** For non-butler contexts (allocates temporary working buffers) */
+ virtual int do_refill_with_alloc() = 0;
- Port *source;
- Sample *current_capture_buffer;
- Sample *current_playback_buffer;
+ /* XXX fix this redundancy ... */
- RingBufferNPT<Sample> *playback_buf;
- RingBufferNPT<Sample> *capture_buf;
+ virtual void playlist_changed (Change);
+ virtual void playlist_deleted (boost::weak_ptr<Playlist>);
+ virtual void playlist_ranges_moved (std::list< Evoral::RangeMove<nframes_t> > const &);
- Sample* scrub_buffer;
- Sample* scrub_forward_buffer;
- Sample* scrub_reverse_buffer;
+ virtual void transport_stopped (struct tm&, time_t, bool abort) = 0;
+ virtual void transport_looped (nframes_t transport_frame) = 0;
- RingBufferNPT<Sample>::rw_vector playback_vector;
- RingBufferNPT<Sample>::rw_vector capture_vector;
+ struct CaptureInfo {
+ uint32_t start;
+ uint32_t frames;
};
- typedef vector<ChannelInfo> ChannelList;
+ virtual void init (Flag);
- string _name;
- ARDOUR::Session& _session;
- ARDOUR::IO* _io;
- ChannelList channels;
- uint32_t _n_channels;
- id_t _id;
+ virtual int use_new_write_source (uint32_t n=0) = 0;
- atomic_t _record_enabled;
- AudioPlaylist* _playlist;
- double _visible_speed;
- double _actual_speed;
- /* items needed for speed change logic */
- bool _buffer_reallocation_required;
- bool _seek_required;
-
- bool force_refill;
- jack_nframes_t capture_start_frame;
- jack_nframes_t capture_captured;
- bool was_recording;
- jack_nframes_t adjust_capture_position;
- jack_nframes_t _capture_offset;
- jack_nframes_t _roll_delay;
- jack_nframes_t first_recordable_frame;
- jack_nframes_t last_recordable_frame;
- int last_possibly_recording;
- AlignStyle _alignment_style;
- bool _scrubbing;
- bool _slaved;
- bool _processed;
- Location* loop_location;
- jack_nframes_t overwrite_frame;
- off_t overwrite_offset;
- bool pending_overwrite;
- bool overwrite_queued;
- IOChange input_change_pending;
- jack_nframes_t wrap_buffer_size;
- jack_nframes_t speed_buffer_size;
-
- uint64_t last_phase;
- uint64_t phi;
-
- jack_nframes_t file_frame;
- jack_nframes_t playback_sample;
- jack_nframes_t playback_distance;
-
- uint32_t _read_data_count;
- uint32_t _write_data_count;
+ virtual int find_and_use_playlist (const std::string&) = 0;
- bool in_set_state;
- AlignStyle _persistent_alignment_style;
- bool first_input_change;
+ virtual void allocate_temporary_buffers () = 0;
- PBD::NonBlockingLock state_lock;
+ virtual bool realtime_set_speed (double, bool global_change);
- jack_nframes_t scrub_start;
- jack_nframes_t scrub_buffer_size;
- jack_nframes_t scrub_offset;
- uint32_t _refcnt;
-
- sigc::connection ports_created_c;
- sigc::connection plmod_connection;
- sigc::connection plstate_connection;
- sigc::connection plgone_connection;
+ std::list<boost::shared_ptr<Region> > _last_capture_regions;
- /* the two central butler operations */
+ virtual int use_pending_capture_data (XMLNode& node) = 0;
- int do_flush (bool force = false);
- int do_refill (Sample *mixdown_buffer, float *gain_buffer);
+ virtual void get_input_sources () = 0;
+ virtual void check_record_status (nframes_t transport_frame, nframes_t nframes, bool can_record) = 0;
+ virtual void set_align_style_from_io() {}
+ virtual void setup_destructive_playlist () {}
+ virtual void use_destructive_playlist () {}
- int read (Sample* buf, Sample* mixdown_buffer, float* gain_buffer, jack_nframes_t& start, jack_nframes_t cnt,
- ChannelInfo& channel_info, int channel, bool reversed);
+ static nframes_t disk_io_chunk_frames;
+ std::vector<CaptureInfo*> capture_info;
+ Glib::Mutex capture_info_lock;
uint32_t i_am_the_modifier;
-
- /* XXX fix this redundancy ... */
-
- void playlist_changed (Change);
- void playlist_modified ();
- void playlist_deleted (Playlist*);
- void session_controls_changed (Session::ControlType);
-
- void finish_capture (bool rec_monitors_input);
- void clean_up_capture (struct tm&, time_t, bool abort);
- void transport_stopped (struct tm&, time_t, bool abort);
-
- struct CaptureInfo {
- uint32_t start;
- uint32_t frames;
- };
- vector<CaptureInfo*> capture_info;
- PBD::Lock capture_info_lock;
-
- void init (Flag);
-
- void init_channel (ChannelInfo &chan);
- void destroy_channel (ChannelInfo &chan);
-
- static jack_nframes_t disk_io_chunk_frames;
-
- int use_new_write_source (uint32_t n=0);
- int use_new_fade_source (uint32_t n=0);
-
- int find_and_use_playlist (const string&);
-
- void allocate_temporary_buffers ();
-
- unsigned char _flags;
-
- int create_input_port ();
- int connect_input_port ();
- int seek_unlocked (jack_nframes_t which_sample);
+ boost::shared_ptr<ARDOUR::IO> _io;
+ Route* _route;
+ ChanCount _n_channels;
- int ports_created ();
+ boost::shared_ptr<Playlist> _playlist;
- bool realtime_set_speed (double, bool global_change);
- void non_realtime_set_speed ();
-
- std::list<Region*> _last_capture_regions;
- std::vector<FileSource*> capturing_sources;
- int use_pending_capture_data (XMLNode& node);
+ mutable gint _record_enabled;
+ double _visible_speed;
+ double _actual_speed;
+ /* items needed for speed change logic */
+ bool _buffer_reallocation_required;
+ bool _seek_required;
+
+ bool force_refill;
+ nframes_t capture_start_frame;
+ nframes_t capture_captured;
+ bool was_recording;
+ nframes_t adjust_capture_position;
+ nframes_t _capture_offset;
+ nframes_t _roll_delay;
+ nframes_t first_recordable_frame;
+ nframes_t last_recordable_frame;
+ int last_possibly_recording;
+ AlignStyle _alignment_style;
+ bool _scrubbing;
+ bool _slaved;
+ bool _processed;
+ Location* loop_location;
+ nframes_t overwrite_frame;
+ off_t overwrite_offset;
+ bool pending_overwrite;
+ bool overwrite_queued;
+ IOChange input_change_pending;
+ nframes_t wrap_buffer_size;
+ nframes_t speed_buffer_size;
+
+ double _speed;
+ double _target_speed;
+
+ nframes_t file_frame;
+ nframes_t playback_sample;
+ nframes_t playback_distance;
+ bool commit_should_unlock;
+
+ uint32_t _read_data_count;
+ uint32_t _write_data_count;
+
+ bool in_set_state;
+ AlignStyle _persistent_alignment_style;
+ bool first_input_change;
+
+ Glib::Mutex state_lock;
+
+ nframes_t scrub_start;
+ nframes_t scrub_buffer_size;
+ nframes_t scrub_offset;
- void get_input_sources ();
-
- void check_record_status (jack_nframes_t transport_frame, jack_nframes_t nframes, bool can_record);
+ sigc::connection ports_created_c;
+ sigc::connection plmod_connection;
+ sigc::connection plgone_connection;
+ sigc::connection plregion_connection;
- void set_align_style_from_io();
+ Flag _flags;
+ void route_going_away ();
};
}; /* namespace ARDOUR */
projects / ardour.git / blobdiff