mpd/src/SongSave.hxx

// SPDX-License-Identifier: GPL-2.0-or-later
// Copyright The Music Player Daemon Project

#ifndef MPD_SONG_SAVE_HXX
#define MPD_SONG_SAVE_HXX

#include <memory>

#define SONG_BEGIN "song_begin: "

struct Song;
struct AudioFormat;
class DetachedSong;
class BufferedOutputStream;
class LineReader;

void
song_save(BufferedOutputStream &os, const Song &song);

void
song_save(BufferedOutputStream &os, const DetachedSong &song);

/**
 * Loads a song from the input file.  Reading stops after the
 * "song_end" line.
 *
 * Throws on error.
 */
DetachedSong
song_load(LineReader &file, const char *uri,
	  std::string *target_r=nullptr, bool *in_playlist_r=nullptr);

#endif
use SPDX IDs, replacing the long copyright headers 2023-03-06 14:42:04 +01:00			`// SPDX-License-Identifier: GPL-2.0-or-later`
			`// Copyright The Music Player Daemon Project`
song: moved code to song_print.c, song_save.c Move everything which dumps song information (via tag_print.c) to a separate source file. song_print.c gets code which writes song data to the client; song_save.c is responsible for serializing songs from the tag cache. 2008-09-07 13:35:01 +02:00
db_save, state_file: convert to C++ 2013-01-02 19:52:57 +01:00			`#ifndef MPD_SONG_SAVE_HXX`
			`#define MPD_SONG_SAVE_HXX`
song: moved code to song_print.c, song_save.c Move everything which dumps song information (via tag_print.c) to a separate source file. song_print.c gets code which writes song data to the client; song_save.c is responsible for serializing songs from the tag cache. 2008-09-07 13:35:01 +02:00
SongSave: wrap DetachedSong* in std::unique_ptr 2017-11-26 12:18:31 +01:00			`#include <memory>`

song_save: load one song at a time Changed songvec_load() to song_load(). Added start and end markers for each song. Removed the "key" line, it's redundant. 2009-11-01 17:51:29 +01:00			`#define SONG_BEGIN "song_begin: "`

song: convert header to C++ 2013-07-28 13:25:12 +02:00			`struct Song;`
db/simple: add an AudioFormat to each Song 2018-07-06 13:22:17 +02:00			`struct AudioFormat;`
DetachedSong: fork of struct Song From now on, struct Song will be used by the database only, and DetachedSong will be used by everybody else. DetachedSong is easier to use, but Song has lower overhead. 2014-01-07 21:39:47 +01:00			`class DetachedSong;`
Save, State: use the OutputStream API instead of FILE* 2014-07-30 20:58:14 +02:00			`class BufferedOutputStream;`
replace TextFile references with LineReader 2021-12-03 14:16:32 +01:00			`class LineReader;`
song: moved code to song_print.c, song_save.c Move everything which dumps song information (via tag_print.c) to a separate source file. song_print.c gets code which writes song data to the client; song_save.c is responsible for serializing songs from the tag cache. 2008-09-07 13:35:01 +02:00
queue_save: save tags and range of non-database songs Use the functions song_save() and song_load() to use the same format as in the database file for those songs which need the tags. 2010-07-25 12:21:47 +02:00			`void`
Save, State: use the OutputStream API instead of FILE* 2014-07-30 20:58:14 +02:00			`song_save(BufferedOutputStream &os, const Song &song);`
queue_save: save tags and range of non-database songs Use the functions song_save() and song_load() to use the same format as in the database file for those songs which need the tags. 2010-07-25 12:21:47 +02:00
DetachedSong: fork of struct Song From now on, struct Song will be used by the database only, and DetachedSong will be used by everybody else. DetachedSong is easier to use, but Song has lower overhead. 2014-01-07 21:39:47 +01:00			`void`
Save, State: use the OutputStream API instead of FILE* 2014-07-30 20:58:14 +02:00			`song_save(BufferedOutputStream &os, const DetachedSong &song);`
DetachedSong: fork of struct Song From now on, struct Song will be used by the database only, and DetachedSong will be used by everybody else. DetachedSong is easier to use, but Song has lower overhead. 2014-01-07 21:39:47 +01:00
song_save: use GError for error handling 2009-07-05 08:29:52 +02:00			`/**`
song_save: load one song at a time Changed songvec_load() to song_load(). Added start and end markers for each song. Removed the "key" line, it's redundant. 2009-11-01 17:51:29 +01:00			`* Loads a song from the input file. Reading stops after the`
			`* "song_end" line.`
song_save: use GError for error handling 2009-07-05 08:29:52 +02:00			`*`
SongSave: allow throwing any exception 2019-09-05 20:49:42 +02:00			`* Throws on error.`
song_save: use GError for error handling 2009-07-05 08:29:52 +02:00			`*/`
SongSave: return DetachedSong, not a std::unique_ptr<> Eliminate unnecessary dynamic allocations. 2019-09-05 20:50:00 +02:00			`DetachedSong`
replace TextFile references with LineReader 2021-12-03 14:16:32 +01:00			`song_load(LineReader &file, const char *uri,`
db/SimpleDatabasePlugin: store `in_playlist` value of songs into database Fixes hide_playlist_targets not working after server restart Currently, `hide_playlists_targets` works by skipping songs with `in_playlist` value set to true in [`Directory::Walk`](https://github.com/MusicPlayerDaemon/MPD/blob/a57bcd02382947abbd961594cdf00302c0c7866a/src/db/plugins/simple/Directory.cxx#L237). But `in_playlist` is not stored and only updated in [`UpdateWalk::PurgeDanglingFromPlaylists`](https://github.com/MusicPlayerDaemon/MPD/blob/a57bcd02382947abbd961594cdf00302c0c7866a/src/db/update/Playlist.cxx#L139), which will only be executed while updating DB. This causes the problem that playlist target songs are correctly hidden after database update, but will remain visible after mpd server restarted. This pr solves the problem by storing `in_playlist` value of songs into the `SimpleDatabase` file. 2023-04-11 18:04:37 +02:00			`std::string target_r=nullptr, bool in_playlist_r=nullptr);`
song: moved code to song_print.c, song_save.c Move everything which dumps song information (via tag_print.c) to a separate source file. song_print.c gets code which writes song data to the client; song_save.c is responsible for serializing songs from the tag cache. 2008-09-07 13:35:01 +02:00
			`#endif`