Song customization for filesystem library & source. More...

#include <filesystem.h>

Inheritance diagram for Filesystem::Song:

[legend]

Collaboration diagram for Filesystem::Song:

[legend]

Public Member Functions
void	path (std::string p)
	Assign the path to a song. More...

std::string	path () const
	Retrieve the path to the song. More...

virtual Parsnip::Data	persist () const override final

virtual void	restore (const Parsnip::Data &data) override final

virtual PianodConnection &	transmitPrivate (PianodConnection &recipient) const override final
	Transmit the thingie's user-specific data on a connection. More...

virtual void	serializePrivate (Parsnip::Data &, const User *user) const override final
	Add the thingie's user-specific data for JSON transmission. More...

Public Member Functions inherited from MusicLibrary::Song
	Song (Album *const parent, const std::string &id, const std::string &name)
	Add a song, and register itself with its parent album. More...

virtual	~Song (void) override

Album *const	parent (void) const

Foundation *const	library (void) const

virtual Media::Source *const	source (void) const override final
	MediaSource from which this thingie originates. More...

virtual const std::string &	songId (void) const override

virtual const std::string &	artistId (void) const override final
	Item's artist ID. More...

virtual const std::string &	artist (void) const override final
	Get artist name. More...

virtual PianodArtist *	asArtist () override final

virtual const PianodArtist *	asArtist () const override final

virtual const std::string &	albumId (void) const override final
	Item's album ID. More...

virtual const std::string &	albumTitle (void) const override final

virtual const std::string &	coverArtUrl (void) const override final

virtual bool	compilation () const override final

virtual const std::string &	title (void) const override final
	Get the song's title. More...

virtual PianodPlaylist *	playlist (void) const override final
	Get a playlist instance. More...

virtual const std::string &	genre (void) const override final
	Get genre of this song. More...

virtual int	duration (void) const override final
	Duration of song in seconds. More...

virtual int	year (void) const override final
	Year of release of song. More...

virtual int	trackNumber (void) const override final
	Get track number (sequence number within an album/original media). More...

int	albumTrackCount () const

void	artist (Artist *artist)
	Set the artist for this song. More...

void	genre (const std::string &g)

void	duration (int d)

void	year (int y)

void	trackNumber (int n)

virtual bool	canQueue () const override
	Indicate if specific item can be queued/requested. More...

virtual RatingScheme	ratingScheme (void) const override

virtual RESPONSE_CODE	rate (Rating value, User *user) override
	Rate a song. More...

virtual Rating	rating (const User *user) const override
	Get a song's rating. More...

virtual RESPONSE_CODE	rateOverplayed (User *user) override

Public Member Functions inherited from PianodSong
virtual const std::string	id (void) const override
	Primary ID is album ID. More...

virtual const std::string	id (MusicThingie::Type type) const override final
	Return the complete ID when used in a specific context. More...

virtual const std::string &	internalId (MusicThingie::Type type) const override final
	Return the inner ID when used in a specific context. More...

virtual const std::string &	name (void) const override final
	Return the most specific name of this, whatever type it is. More...

virtual Type	type (void) const override
	Return the type letter for a thingie. More...

virtual Football::Thingie &	transmitCommon (Football::Thingie &recipient) const override final
	Typecode for album type. More...

virtual Parsnip::Data	serialize () const override final
	Assemble the thingie's data for JSON tranmission. More...

ResponseGroup	assembleRatings (const User user, const PianodPlaylist playlist, bool include_json) const

ResponseGroup	assembleCapabilities (const User user, const PianodPlaylist playlist) const

Parsnip::Data	serializeRatings (const User user, const PianodPlaylist playlist) const

Parsnip::Data	serializeCapabilities (const User user, const PianodPlaylist playlist) const
	Provide a list of actions a user can take on this song. More...

virtual bool	matches (const Filter &filter) const override final
	Check if a filter matches this item. More...

virtual PianodSong *	asSong () override final

virtual const PianodSong *	asSong () const override final

bool	expires (void)

bool	expired (void)

time_t	lastPlayed (void) const
	Get time a song last played. More...

void	lastPlayed (time_t t)

virtual const std::string &	playlistName (void) const
	Get name of a playlist to which this belongs. More...

virtual const std::string &	infoUrl (void) const
	Provide a URL with additional info. More...

float	averageRating () const
	Return the average rating of a song, considering all ratings. More...

virtual bool	operator== (const std::string &compare) const override
	Is album a compilation? More...

virtual bool	operator== (const MusicThingie &compare) const override
	Compare artist's name to that of an artist/album/song. More...

virtual SongList	songs () override
	Retrieve a list of requestable songs applicable to this thingie. More...

virtual bool	canSkip (time_t *whenAllowed)
	Check for permission to skip a song. More...

virtual bool	mustPlay () const
	Mark songs (err, adverts) as must-play; they can't be skipped over even when playlist selections are changed or whatnot. More...

Media::Player *	play (const AudioSettings &audio)
	Play the song. More...

Public Member Functions inherited from PianodAlbum
virtual PianodAlbum *	asAlbum () override final

virtual const PianodAlbum *	asAlbum () const override final

Public Member Functions inherited from MusicThingie
	MusicThingie (void)
	When allocated, use count starts at 1 and the object is put in the release pool, justifying its existence. More...

bool	isPrimary (void) const

bool	isSuggestion (void) const

bool	isSeed (void) const

bool	isPlaylist (void) const

bool	isSong (void) const

bool	isAlbum (void) const

bool	isArtist (void) const

bool	isValidType (void) const

Type	primaryType (void) const

virtual PianodPlaylist *	asPlaylist ()

virtual const PianodPlaylist *	asPlaylist () const

std::string	operator() (void) const

void	retain (void) const
	Claim an instance. More...

void	release (void)
	Abandon an instance. More...

int	getUseCount (void) const

virtual Ownership *	parentOwner (void) const
	Defer the ownership to the source. More...

void	serializeCommon (Parsnip::Data &) const
	Insert common items into the serialization dictionary. More...

bool	operator!= (const std::string &compare)

bool	operator!= (const MusicThingie &compare)

Public Member Functions inherited from SubordinateOwnership
virtual bool	isOwnedBy (const User *user) const override

virtual bool	hasPermission (const User *user, Action action) const override

Public Member Functions inherited from Ownership
bool	isVisibleBy (const User *user) const

bool	isUsableBy (const User *user) const

bool	isDecendableBy (const User *user) const

bool	isReadableBy (const User *user) const

bool	isEditableBy (const User *user) const

Private Attributes
friend	Source

friend	Player

friend	Library

std::string	_path
	If starting with `/`, path from library root; otherwise appends to album path. More...

bool	present = false
	Set to false at start of a scan, true when found. More...

Additional Inherited Members
Public Types inherited from MusicThingie
enum class	Type : char { Playlist = 'p' , Artist = 'a' , Album = 'l' , Song = 's' , PlaylistSuggestion = 'e' , ArtistSuggestion = 't' , AlbumSuggestion = 'b' , SongSuggestion = 'n' , PlaylistSeed = 'y' , ArtistSeed = 'd' , AlbumSeed = 'u' , SongSeed = 'g' , SongRating = 'i' }

Public Types inherited from Ownership
enum class	Type { DISOWNED , PRIVATE , SHARED , PUBLISHED , PUBLIC }
	Access levels for an object. More...

enum class	Action { SEE , USE , READ , ALTER }
	Access actions for an object. More...

Static Public Member Functions inherited from PianodSong
static Type	typetype (void)

Static Public Member Functions inherited from PianodAlbum
static Type	typetype (void)
	Typecode for album objects. More...

Static Public Member Functions inherited from PianodArtist
static Type	typetype (void)
	Typecode for artist objects. More...

Static Public Member Functions inherited from MusicThingie
static std::string	TypeName (Type type)
	Get the type name of a music thingie. More...

static Type	TypeFromName (const std::string &name)

static constexpr bool	isPrimary (Type t)

static constexpr bool	isSuggestion (const Type t)

static constexpr bool	isSeed (const Type t)

static constexpr bool	isPlaylist (const Type t)

static constexpr bool	isSong (const Type t)

static constexpr bool	isAlbum (const Type t)

static constexpr bool	isArtist (const Type t)

static constexpr bool	isValidType (const Type t)

static Type	primaryType (const Type t)

Public Attributes inherited from MusicLibrary::Song
Playlist *	_playlist = nullptr

Protected Member Functions inherited from MusicThingie
virtual	~MusicThingie (void)

Protected Attributes inherited from MusicLibrary::Song
Album *const	_album

Protected Attributes inherited from PianodSong
time_t	expiration = 0
	Time at which a queued item becomes invalid, or 0 if good forever. More...

time_t	last_played = 0
	Time song was last played, 0 if never or unknown. More...

Detailed Description

Song customization for filesystem library & source.

Member Function Documentation

◆ path() [1/2]

std::string Filesystem::Song::path ( ) const

Retrieve the path to the song.

If the path starts with '/', append it to the library path.
Otherwise, append it to the album path.
Returns
The path to a song's media file.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ path() [2/2]

void Filesystem::Song::path ( std::string p )

Assign the path to a song.

Set the song path to that provided.
Try setting the artist path to the path, with the filename removed.
Truncate the path by stripping the album off the front.
If the album path can't be removed, strip off the library path instead, leaving a leading '/' to delineate.
Parameters

p The path to adopt.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ persist()

Parsnip::Data Filesystem::Song::persist ( ) const

finaloverridevirtual

Reimplemented from MusicLibrary::Song.

Here is the call graph for this function:

◆ restore()

void Filesystem::Song::restore ( const Parsnip::Data & data )

finaloverridevirtual

Reimplemented from MusicLibrary::Song.

Here is the call graph for this function:

◆ serializePrivate()

void Filesystem::Song::serializePrivate	(	Parsnip::Data &	,
		const User *	user
	)		const

finaloverridevirtual

Add the thingie's user-specific data for JSON transmission.

Reimplemented from PianodSong.

Here is the call graph for this function:

◆ transmitPrivate()

PianodConnection & Filesystem::Song::transmitPrivate ( PianodConnection & recipient ) const

finaloverridevirtual

Transmit the thingie's user-specific data on a connection.

Reimplemented from PianodSong.

Here is the call graph for this function:

Member Data Documentation

◆ _path

std::string Filesystem::Song::_path

private

If starting with /, path from library root; otherwise appends to album path.

◆ Library

friend Filesystem::Song::Library

private

◆ Player

friend Filesystem::Song::Player

private

◆ present

bool Filesystem::Song::present = false

private

Set to false at start of a scan, true when found.

◆ Source

friend Filesystem::Song::Source

private

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

mediaunits/filesystem/filesystem.h
mediaunits/filesystem/filesystemtypes.cpp

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ path() [1/2]

◆ path() [2/2]

◆ persist()

◆ restore()

◆ serializePrivate()

◆ transmitPrivate()

Member Data Documentation

◆ _path

◆ Library

◆ Player

◆ present

◆ Source