ardour
Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | Friends | List of all members
ARDOUR::AudioPlaylistSource Class Reference

#include <audio_playlist_source.h>

Inheritance diagram for ARDOUR::AudioPlaylistSource:
ARDOUR::PlaylistSource ARDOUR::AudioSource ARDOUR::Source ARDOUR::Source ARDOUR::Readable boost::enable_shared_from_this< ARDOUR::AudioSource > ARDOUR::SessionObject ARDOUR::SessionObject ARDOUR::SessionHandleRef PBD::StatefulDestructible ARDOUR::SessionHandleRef PBD::StatefulDestructible PBD::ScopedConnectionList PBD::Stateful PBD::Destructible PBD::ScopedConnectionList PBD::Stateful PBD::Destructible

Public Member Functions

virtual ~AudioPlaylistSource ()
 
bool empty () const
 
std::string peak_path (std::string audio_path)
 
uint32_t n_channels () const
 
bool clamped_at_unity () const
 
framecnt_t read_unlocked (Sample *dst, framepos_t start, framecnt_t cnt) const
 
framecnt_t write_unlocked (Sample *src, framecnt_t cnt)
 
float sample_rate () const
 
int setup_peakfile ()
 
XMLNodeget_state ()
 
int set_state (const XMLNode &, int version)
 
bool can_truncate_peaks () const
 
bool can_be_analysed () const
 
- Public Member Functions inherited from ARDOUR::PlaylistSource
virtual ~PlaylistSource ()
 
int set_state (const XMLNode &, int version)
 
boost::shared_ptr< const Playlistplaylist () const
 
const PBD::IDoriginal () const
 
- Public Member Functions inherited from ARDOUR::Source
 Source (Session &, DataType type, const std::string &name, Flag flags=Flag(0))
 
 Source (Session &, const XMLNode &)
 
virtual ~Source ()
 
DataType type ()
 
time_t timestamp () const
 
void stamp (time_t when)
 
virtual framepos_t natural_position () const
 
void mark_for_remove ()
 
virtual void mark_streaming_write_started (const Lock &lock)
 
virtual void session_saved ()
 
XMLNodeget_state ()
 
int set_state (const XMLNode &, int version)
 
bool destructive () const
 
bool writable () const
 
virtual bool set_destructive (bool)
 
virtual bool length_mutable () const
 
bool has_been_analysed () const
 
virtual void set_been_analysed (bool yn)
 
virtual bool check_for_analysis_data_on_disk ()
 
std::string get_transients_path () const
 
int load_transients (const std::string &)
 
framepos_t timeline_position () const
 
virtual void set_timeline_position (framepos_t pos)
 
void set_allow_remove_if_empty (bool yn)
 
Glib::Threads::Mutex & mutex ()
 
Flag flags () const
 
virtual void inc_use_count ()
 
virtual void dec_use_count ()
 
int use_count () const
 
bool used () const
 
uint32_t level () const
 
std::string ancestor_name ()
 
void set_ancestor_name (const std::string &name)
 
- Public Member Functions inherited from ARDOUR::SessionObject
 SessionObject (Session &session, const std::string &name)
 
Sessionsession () const
 
std::string name () const
 
virtual bool set_name (const std::string &str)
 
- Public Member Functions inherited from ARDOUR::SessionHandleRef
 SessionHandleRef (ARDOUR::Session &s)
 
virtual ~SessionHandleRef ()
 
- Public Member Functions inherited from PBD::ScopedConnectionList
 ScopedConnectionList ()
 
virtual ~ScopedConnectionList ()
 
void add_connection (const UnscopedConnection &c)
 
void drop_connections ()
 
- Public Member Functions inherited from PBD::Stateful
 Stateful ()
 
virtual ~Stateful ()
 
virtual bool apply_changes (PropertyBase const &)
 
PropertyChange apply_changes (PropertyList const &)
 
const OwnedPropertyListproperties () const
 
void add_property (PropertyBase &s)
 
void add_extra_xml (XMLNode &)
 
XMLNodeextra_xml (const std::string &str, bool add_if_missing=false)
 
void save_extra_xml (const XMLNode &)
 
const PBD::IDid () const
 
bool set_id (const XMLNode &)
 
void set_id (const std::string &)
 
void reset_id ()
 
void clear_changes ()
 
virtual void clear_owned_changes ()
 
PropertyListget_changes_as_properties (Command *) const
 
virtual void rdiff (std::vector< Command * > &) const
 
bool changed () const
 
virtual PropertyListproperty_factory (const XMLNode &) const
 
virtual void suspend_property_changes ()
 
virtual void resume_property_changes ()
 
bool property_changes_suspended () const
 
- Public Member Functions inherited from PBD::Destructible
 Destructible ()
 
virtual ~Destructible ()
 
void drop_references ()
 
- Public Member Functions inherited from ARDOUR::AudioSource
 AudioSource (Session &, std::string name)
 
 AudioSource (Session &, const XMLNode &)
 
virtual ~AudioSource ()
 
framecnt_t readable_length () const
 
framecnt_t length (framepos_t pos) const
 
void update_length (framecnt_t cnt)
 
virtual framecnt_t available_peaks (double zoom) const
 
virtual framecnt_t read (Sample *dst, framepos_t start, framecnt_t cnt, int channel=0) const
 
virtual framecnt_t write (Sample *src, framecnt_t cnt)
 
virtual void mark_streaming_write_completed (const Lock &lock)
 
void set_captured_for (std::string str)
 
std::string captured_for () const
 
int read_peaks (PeakData *peaks, framecnt_t npeaks, framepos_t start, framecnt_t cnt, double samples_per_visual_peak) const
 
int build_peaks ()
 
bool peaks_ready (boost::function< void()> callWhenReady, PBD::ScopedConnection **connection_created_if_not_ready, PBD::EventLoop *event_loop) const
 
XMLNodeget_state ()
 
int set_state (const XMLNode &, int version)
 
int rename_peakfile (std::string newpath)
 
void touch_peakfile ()
 
int prepare_for_peakfile_writes ()
 
void done_with_peakfile_writes (bool done=true)
 
- Public Member Functions inherited from ARDOUR::Readable
 Readable ()
 
virtual ~Readable ()
 

Protected Member Functions

 AudioPlaylistSource (Session &, const PBD::ID &orig, const std::string &name, boost::shared_ptr< AudioPlaylist >, uint32_t chn, frameoffset_t begin, framecnt_t len, Source::Flag flags)
 
 AudioPlaylistSource (Session &, const XMLNode &)
 
- Protected Member Functions inherited from ARDOUR::PlaylistSource
 PlaylistSource (Session &, const PBD::ID &, const std::string &name, boost::shared_ptr< Playlist >, DataType, frameoffset_t begin, framecnt_t len, Source::Flag flags)
 
 PlaylistSource (Session &, const XMLNode &)
 
void add_state (XMLNode &)
 
- Protected Member Functions inherited from ARDOUR::SessionHandleRef
virtual void session_going_away ()
 
virtual void insanity_check ()
 
- Protected Member Functions inherited from PBD::Stateful
void add_instant_xml (XMLNode &, const std::string &directory_path)
 
XMLNodeinstant_xml (const std::string &str, const std::string &directory_path)
 
void add_properties (XMLNode &)
 
PropertyChange set_values (XMLNode const &)
 
virtual void post_set (const PropertyChange &)
 
virtual void send_change (const PropertyChange &)
 
virtual void mid_thaw (const PropertyChange &)
 
- Protected Member Functions inherited from ARDOUR::AudioSource
int initialize_peakfile (std::string path)
 
int build_peaks_from_scratch ()
 
int compute_and_write_peaks (Sample *buf, framecnt_t first_frame, framecnt_t cnt, bool force, bool intermediate_peaks_ready_signal)
 
void truncate_peakfile ()
 
virtual std::string find_broken_peakfile (std::string, std::string audio_path)
 
virtual int read_peaks_with_fpp (PeakData *peaks, framecnt_t npeaks, framepos_t start, framecnt_t cnt, double samples_per_visual_peak, framecnt_t fpp) const
 
int compute_and_write_peaks (Sample *buf, framecnt_t first_frame, framecnt_t cnt, bool force, bool intermediate_peaks_ready_signal, framecnt_t frames_per_peak)
 

Private Member Functions

int set_state (const XMLNode &, int version, bool with_descendants)
 

Private Attributes

uint32_t _playlist_channel
 
std::string _peak_path
 

Friends

class SourceFactory
 

Additional Inherited Members

- Public Types inherited from ARDOUR::Source
enum  Flag {
  Writable = 0x1, CanRename = 0x2, Broadcast = 0x4, Removable = 0x8,
  RemovableIfEmpty = 0x10, RemoveAtDestroy = 0x20, NoPeakFile = 0x40, Destructive = 0x80,
  Empty = 0x100
}
 
typedef Glib::Threads::Mutex::Lock Lock
 
- Static Public Member Functions inherited from ARDOUR::SessionObject
static void make_property_quarks ()
 
- Static Public Member Functions inherited from ARDOUR::AudioSource
static void set_build_missing_peakfiles (bool yn)
 
static void set_build_peakfiles (bool yn)
 
static bool get_build_peakfiles ()
 
static void allocate_working_buffers (framecnt_t framerate)
 
- Public Attributes inherited from ARDOUR::Source
PBD::Signal0< void > AnalysisChanged
 
AnalysisFeatureList transients
 
- Public Attributes inherited from PBD::Stateful
PBD::Signal1< void, const
PropertyChange & > 
PropertyChanged
 
- Public Attributes inherited from PBD::Destructible
PBD::Signal0< void > Destroyed
 
PBD::Signal0< void > DropReferences
 
- Public Attributes inherited from ARDOUR::AudioSource
PBD::Signal0< void > PeaksReady
 
PBD::Signal2< void, framepos_t,
framepos_t
PeakRangeReady
 
- Static Public Attributes inherited from ARDOUR::Source
static PBD::Signal1< void,
Source * > 
SourceCreated
 
- Static Public Attributes inherited from PBD::Stateful
static int current_state_version = 0
 
static int loading_state_version = 0
 
- Static Protected Member Functions inherited from ARDOUR::AudioSource
static void ensure_buffers_for_level (uint32_t, framecnt_t)
 
static void ensure_buffers_for_level_locked (uint32_t, framecnt_t)
 
- Protected Attributes inherited from ARDOUR::PlaylistSource
boost::shared_ptr< Playlist_playlist
 
PBD::ID _original
 
frameoffset_t _playlist_offset
 
framecnt_t _playlist_length
 
- Protected Attributes inherited from ARDOUR::Source
DataType _type
 
Flag _flags
 
time_t _timestamp
 
framepos_t _timeline_position
 
bool _analysed
 
Glib::Threads::Mutex _lock
 
Glib::Threads::Mutex _analysis_lock
 
gint _use_count
 
uint32_t _level
 
std::string _ancestor_name
 
- Protected Attributes inherited from ARDOUR::SessionObject
PBD::Property< std::string > _name
 
- Protected Attributes inherited from ARDOUR::SessionHandleRef
ARDOUR::Session_session
 
- Protected Attributes inherited from PBD::Stateful
XMLNode_extra_xml
 
XMLNode_instant_xml
 
PBD::PropertyChange _pending_changed
 
Glib::Threads::Mutex _lock
 
std::string _xml_node_name
 name of node to use for this object in XML More...
 
OwnedPropertyList_properties
 
- Protected Attributes inherited from ARDOUR::AudioSource
framecnt_t _length
 
std::string peakpath
 
std::string _captured_for
 
off_t _peak_byte_max
 
- Static Protected Attributes inherited from ARDOUR::AudioSource
static bool _build_missing_peakfiles = false
 
static bool _build_peakfiles = false
 
static size_t _working_buffers_size = 0
 
static std::vector
< boost::shared_array< Sample > > 
_mixdown_buffers
 
static std::vector
< boost::shared_array< gain_t > > 
_gain_buffers
 
static Glib::Threads::Mutex _level_buffer_lock
 

Detailed Description

Definition at line 35 of file audio_playlist_source.h.

Constructor & Destructor Documentation

AudioPlaylistSource::~AudioPlaylistSource ( )
virtual

Definition at line 74 of file audio_playlist_source.cc.

AudioPlaylistSource::AudioPlaylistSource ( Session s,
const PBD::ID orig,
const std::string &  name,
boost::shared_ptr< AudioPlaylist p,
uint32_t  chn,
frameoffset_t  begin,
framecnt_t  len,
Source::Flag  flags 
)
protected

Definition at line 44 of file audio_playlist_source.cc.

AudioPlaylistSource::AudioPlaylistSource ( Session s,
const XMLNode node 
)
protected

Definition at line 55 of file audio_playlist_source.cc.

Member Function Documentation

bool ARDOUR::AudioPlaylistSource::can_be_analysed ( ) const
inlinevirtual

Reimplemented from ARDOUR::Source.

Definition at line 54 of file audio_playlist_source.h.

bool ARDOUR::AudioPlaylistSource::can_truncate_peaks ( ) const
inlinevirtual

Reimplemented from ARDOUR::AudioSource.

Definition at line 53 of file audio_playlist_source.h.

bool ARDOUR::AudioPlaylistSource::clamped_at_unity ( ) const
inlinevirtual
Returns
true if the each source sample s must be clamped to -1 < s < 1

Implements ARDOUR::AudioSource.

Definition at line 42 of file audio_playlist_source.h.

bool AudioPlaylistSource::empty ( ) const
virtual

Reimplemented from ARDOUR::AudioSource.

Definition at line 177 of file audio_playlist_source.cc.

XMLNode & AudioPlaylistSource::get_state ( void  )
virtual

Implements PBD::Stateful.

Definition at line 79 of file audio_playlist_source.cc.

uint32_t AudioPlaylistSource::n_channels ( ) const
virtual

Reimplemented from ARDOUR::AudioSource.

Definition at line 183 of file audio_playlist_source.cc.

string AudioPlaylistSource::peak_path ( std::string  audio_path)
virtual

Implements ARDOUR::AudioSource.

Definition at line 220 of file audio_playlist_source.cc.

framecnt_t AudioPlaylistSource::read_unlocked ( Sample dst,
framepos_t  start,
framecnt_t  cnt 
) const
virtual

Implements ARDOUR::AudioSource.

Definition at line 128 of file audio_playlist_source.cc.

float AudioPlaylistSource::sample_rate ( ) const
virtual

Implements ARDOUR::AudioSource.

Definition at line 198 of file audio_playlist_source.cc.

int AudioPlaylistSource::set_state ( const XMLNode node,
int  version 
)
virtual

Implements PBD::Stateful.

Definition at line 95 of file audio_playlist_source.cc.

int AudioPlaylistSource::set_state ( const XMLNode node,
int  version,
bool  with_descendants 
)
private

Definition at line 101 of file audio_playlist_source.cc.

int AudioPlaylistSource::setup_peakfile ( )
virtual

Reimplemented from ARDOUR::AudioSource.

Definition at line 213 of file audio_playlist_source.cc.

framecnt_t AudioPlaylistSource::write_unlocked ( Sample src,
framecnt_t  cnt 
)
virtual

Implements ARDOUR::AudioSource.

Definition at line 169 of file audio_playlist_source.cc.

Friends And Related Function Documentation

friend class SourceFactory
friend

Definition at line 57 of file audio_playlist_source.h.

Member Data Documentation

std::string ARDOUR::AudioPlaylistSource::_peak_path
private

Definition at line 66 of file audio_playlist_source.h.

uint32_t ARDOUR::AudioPlaylistSource::_playlist_channel
private

Definition at line 65 of file audio_playlist_source.h.


The documentation for this class was generated from the following files: