#include <file_source.h>

Inheritance diagram for ARDOUR::FileSource:

Public Member Functions
virtual	~FileSource ()

const std::string &	path () const

virtual bool	safe_file_extension (const std::string &path) const =0

int	move_to_trash (const std::string &trash_dir_name)

void	mark_take (const std::string &id)

void	mark_immutable ()

void	mark_immutable_except_write ()

void	mark_nonremovable ()

bool	within_session () const

uint16_t	channel () const

float	gain () const

virtual void	set_gain (float g, bool temporarily=false)

virtual void	set_channel (uint16_t c)

int	set_state (const XMLNode &, int version)

int	set_source_name (const std::string &newname)

bool	removable () const

bool	is_stub () const

const std::string &	origin () const

void	set_origin (std::string const &o)

virtual void	set_path (const std::string &)

void	replace_file (const std::string &)

void	existence_check ()

virtual void	prevent_deletion ()

int	rename (const std::string &name)

virtual void	close ()=0

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 timepos_t	length () const

virtual bool	empty () const

virtual void	update_length (timepos_t const &dur)

void	set_take_id (std::string id)

const std::string &	take_id () const

void	mark_for_remove ()

virtual void	mark_streaming_write_started (const WriterLock &lock)

virtual void	mark_streaming_write_completed (const WriterLock &lock, Temporal::timecnt_t const &duration)=0

virtual void	session_saved ()

XMLNode &	get_state () const

int	set_state (XMLNode const &, int version)

bool	writable () const

virtual bool	length_mutable () const

bool	has_been_analysed () const

virtual bool	can_be_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 &)

size_t	n_captured_xruns () const

XrunPositions const &	captured_xruns () const

void	set_captured_xruns (XrunPositions const &xruns)

void	set_captured_marks (CueMarkers const &marks)

CueMarkers const &	cue_markers () const

bool	add_cue_marker (CueMarker const &)

bool	move_cue_marker (CueMarker const &, timepos_t const &source_relative_position)

bool	remove_cue_marker (CueMarker const &)

bool	rename_cue_marker (CueMarker &, std::string const &)

bool	clear_cue_markers ()

virtual timepos_t	natural_position () const

virtual void	set_natural_position (timepos_t const &pos)

bool	have_natural_position () const

timecnt_t	time_since_capture_start (timepos_t const &pos)

void	set_allow_remove_if_empty (bool yn)

Glib::Threads::RWLock &	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)

void	set_captured_for (std::string str)

std::string	captured_for () const

bool	get_segment_descriptor (TimelineRange const &, SegmentDescriptor &)

int	set_segment_descriptor (SegmentDescriptor const &)

Public Member Functions inherited from ARDOUR::SessionObject
	SessionObject (Session &session, const std::string &name)

Session &	session () 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 ()

	ScopedConnectionList (const ScopedConnectionList &)=delete

ScopedConnectionList &	operator= (const ScopedConnectionList &)=delete

virtual	~ScopedConnectionList ()

void	add_connection (const UnscopedConnection &c)

void	drop_connections ()

Public Member Functions inherited from PBD::Stateful
	Stateful ()

virtual	~Stateful ()

virtual bool	apply_change (PropertyBase const &)

PropertyChange	apply_changes (PropertyList const &)

const OwnedPropertyList &	properties () const

void	add_property (PropertyBase &s)

void	add_extra_xml (XMLNode &)

XMLNode *	extra_xml (const std::string &str, bool add_if_missing=false)

void	save_extra_xml (const XMLNode &)

const PBD::ID &	id () const

bool	set_id (const XMLNode &)

void	set_id (const std::string &)

void	reset_id ()

void	clear_changes ()

virtual void	clear_owned_changes ()

PropertyList *	get_changes_as_properties (PBD::Command *) const

virtual void	rdiff (std::vector< PBD::Command * > &) const

bool	changed () const

virtual PropertyList *	property_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
virtual	~Destructible ()

virtual void	drop_references ()

Static Public Member Functions
static bool	find (Session &, DataType type, const std::string &path, bool must_exist, bool &is_new, uint16_t &chan, std::string &found_path)

static bool	find_2X (Session &, DataType type, const std::string &path, bool must_exist, bool &is_new, uint16_t &chan, std::string &found_path)

Static Public Member Functions inherited from ARDOUR::SessionObject
static void	make_property_quarks ()

Static Public Attributes
static PBD::Signal< int(std::string, std::vector< std::string >)>	AmbiguousFileName

Static Public Attributes inherited from ARDOUR::Source
static PBD::Signal< void(Source *)>	SourceCreated

Static Public Attributes inherited from PBD::Stateful
static int	current_state_version

static int	loading_state_version

Protected Member Functions
	FileSource (Session &session, DataType type, const std::string &path, const std::string &origin, Source::Flag flags=Source::Flag(0))

	FileSource (Session &session, const XMLNode &node, bool must_exist)

virtual int	init (const std::string &idstr, bool must_exist)

virtual int	move_dependents_to_trash ()

void	set_within_session_from_path (const std::string &)

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)

XMLNode *	instant_xml (const std::string &str, const std::string &directory_path)

void	add_properties (XMLNode &) const

PropertyChange	set_values (XMLNode const &)

virtual void	post_set (const PropertyChange &)

virtual void	send_change (const PropertyChange &)

virtual void	mid_thaw (const PropertyChange &)

bool	regenerate_xml_or_string_ids () const

Protected Attributes
std::string	_path

bool	_file_is_new

uint16_t	_channel

bool	_within_session

std::string	_origin

float	_gain

Protected Attributes inherited from ARDOUR::Source
DataType	_type

Flag	_flags

time_t	_timestamp

std::string	_take_id

timepos_t	_natural_position

bool	_have_natural_position

bool	_analysed

std::atomic< int >	_use_count

uint32_t	_level

std::string	_ancestor_name

std::string	_captured_for

timepos_t	_length

XrunPositions	_xruns

CueMarkers	_cue_markers

SegmentDescriptors	segment_descriptors

Glib::Threads::RWLock	_lock

Glib::Threads::Mutex	_analysis_lock

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

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 , RF64_RIFF = 0x200 , Missing = 0x400 }

typedef Glib::Threads::RWLock::ReaderLock	ReaderLock

typedef Glib::Threads::RWLock::WriterLock	WriterLock

Public Attributes inherited from ARDOUR::Source
PBD::Signal< void()>	AnalysisChanged

AnalysisFeatureList	transients

PBD::Signal< void()>	CueMarkersChanged

Public Attributes inherited from PBD::Stateful
PBD::Signal< void(const PropertyChange &)>	PropertyChanged

Public Attributes inherited from PBD::Destructible
PBD::Signal< void()>	Destroyed

PBD::Signal< void()>	DropReferences

Protected Types inherited from ARDOUR::Source
typedef std::vector< SegmentDescriptor >	SegmentDescriptors

Detailed Description

A source associated with a file on disk somewhere

Definition at line 46 of file file_source.h.

Constructor & Destructor Documentation

◆ ~FileSource()

virtual ARDOUR::FileSource::~FileSource ( )

virtual

◆ FileSource() [1/2]

ARDOUR::FileSource::FileSource	(	Session &	session,
		DataType	type,
		const std::string &	path,
		const std::string &	origin,
		Source::Flag	flags = `Source::Flag(0)`
	)

protected

◆ FileSource() [2/2]

ARDOUR::FileSource::FileSource	(	Session &	session,
		const XMLNode &	node,
		bool	must_exist
	)

protected

Member Function Documentation

◆ channel()

uint16_t ARDOUR::FileSource::channel ( ) const

inline

Definition at line 61 of file file_source.h.

◆ close()

virtual void ARDOUR::FileSource::close ( )

pure virtual

Implemented in ARDOUR::SrcFileSource, ARDOUR::SndFileSource, ARDOUR::SMFSource, ARDOUR::SilentFileSource, ARDOUR::Mp3FileSource, ARDOUR::FFMPEGFileSource, and ARDOUR::CoreAudioSource.

◆ existence_check()

void ARDOUR::FileSource::existence_check ( )

◆ find()

static bool ARDOUR::FileSource::find	(	Session &	,
		DataType	type,
		const std::string &	path,
		bool	must_exist,
		bool &	is_new,
		uint16_t &	chan,
		std::string &	found_path
	)

static

◆ find_2X()

static bool ARDOUR::FileSource::find_2X	(	Session &	,
		DataType	type,
		const std::string &	path,
		bool	must_exist,
		bool &	is_new,
		uint16_t &	chan,
		std::string &	found_path
	)

static

◆ gain()

float ARDOUR::FileSource::gain ( ) const

inline

Definition at line 62 of file file_source.h.

◆ init()

virtual int ARDOUR::FileSource::init	(	const std::string &	idstr,
		bool	must_exist
	)

protectedvirtual

Reimplemented in ARDOUR::AudioFileSource.

◆ is_stub()

bool ARDOUR::FileSource::is_stub ( ) const

◆ mark_immutable()

void ARDOUR::FileSource::mark_immutable ( )

◆ mark_immutable_except_write()

void ARDOUR::FileSource::mark_immutable_except_write ( )

◆ mark_nonremovable()

void ARDOUR::FileSource::mark_nonremovable ( )

◆ mark_take()

void ARDOUR::FileSource::mark_take ( const std::string & id )

◆ move_dependents_to_trash()

virtual int ARDOUR::FileSource::move_dependents_to_trash ( )

inlineprotectedvirtual

Reimplemented in ARDOUR::AudioFileSource.

Definition at line 108 of file file_source.h.

◆ move_to_trash()

int ARDOUR::FileSource::move_to_trash ( const std::string & trash_dir_name )

◆ origin()

const std::string& ARDOUR::FileSource::origin ( ) const

inline

Definition at line 82 of file file_source.h.

◆ path()

const std::string& ARDOUR::FileSource::path ( ) const

inline

Definition at line 50 of file file_source.h.

◆ prevent_deletion()

virtual void ARDOUR::FileSource::prevent_deletion ( )

virtual

Reimplemented in ARDOUR::SMFSource.

◆ removable()

bool ARDOUR::FileSource::removable ( ) const

◆ rename()

int ARDOUR::FileSource::rename ( const std::string & name )

Rename the file on disk referenced by this source to newname

◆ replace_file()

void ARDOUR::FileSource::replace_file ( const std::string & )

◆ safe_file_extension()

virtual bool ARDOUR::FileSource::safe_file_extension ( const std::string & path ) const

pure virtual

Implemented in ARDOUR::SMFSource, and ARDOUR::AudioFileSource.

◆ set_channel()

virtual void ARDOUR::FileSource::set_channel ( uint16_t c )

inlinevirtual

Definition at line 65 of file file_source.h.

◆ set_gain()

virtual void ARDOUR::FileSource::set_gain	(	float	g,
		bool	temporarily = `false`
	)

inlinevirtual

Reimplemented in ARDOUR::AudioFileSource.

Definition at line 64 of file file_source.h.

◆ set_origin()

void ARDOUR::FileSource::set_origin ( std::string const & o )

inline

Definition at line 83 of file file_source.h.

◆ set_path()

virtual void ARDOUR::FileSource::set_path ( const std::string & )

virtual

Reimplemented in ARDOUR::SndFileSource, ARDOUR::CoreAudioSource, and ARDOUR::SMFSource.

◆ set_source_name()

int ARDOUR::FileSource::set_source_name ( const std::string & newname )

◆ set_state()

int ARDOUR::FileSource::set_state	(	const XMLNode &	,
		int	version
	)

virtual

Implements PBD::Stateful.

Reimplemented in ARDOUR::SMFSource.

◆ set_within_session_from_path()

void ARDOUR::FileSource::set_within_session_from_path ( const std::string & )

protected

◆ within_session()

bool ARDOUR::FileSource::within_session ( ) const

inline

Definition at line 60 of file file_source.h.

Member Data Documentation

◆ _channel

uint16_t ARDOUR::FileSource::_channel

protected

Definition at line 113 of file file_source.h.

◆ _file_is_new

bool ARDOUR::FileSource::_file_is_new

protected

Definition at line 112 of file file_source.h.

◆ _gain

float ARDOUR::FileSource::_gain

protected

Definition at line 116 of file file_source.h.

◆ _origin

std::string ARDOUR::FileSource::_origin

protected

Definition at line 115 of file file_source.h.

◆ _path

std::string ARDOUR::FileSource::_path

protected

Definition at line 111 of file file_source.h.

◆ _within_session

bool ARDOUR::FileSource::_within_session

protected

Definition at line 114 of file file_source.h.

◆ AmbiguousFileName

PBD::Signal<int(std::string,std::vector<std::string> )> ARDOUR::FileSource::AmbiguousFileName

static

Definition at line 88 of file file_source.h.

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

file_source.h

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~FileSource()

◆ FileSource() [1/2]

◆ FileSource() [2/2]

Member Function Documentation

◆ channel()

◆ close()

◆ existence_check()

◆ find()

◆ find_2X()

◆ gain()

◆ init()

◆ is_stub()

◆ mark_immutable()

◆ mark_immutable_except_write()

◆ mark_nonremovable()

◆ mark_take()

◆ move_dependents_to_trash()

◆ move_to_trash()

◆ origin()

◆ path()

◆ prevent_deletion()

◆ removable()

◆ rename()

◆ replace_file()

◆ safe_file_extension()

◆ set_channel()

◆ set_gain()

◆ set_origin()

◆ set_path()

◆ set_source_name()

◆ set_state()

◆ set_within_session_from_path()

◆ within_session()

Member Data Documentation

◆ _channel

◆ _file_is_new

◆ _gain

◆ _origin

◆ _path

◆ _within_session

◆ AmbiguousFileName