1 /* Copyright (C) 2007 Andre Noll <maan@tuebingen.mpg.de>, see file COPYING. */
15 /** \file playlist.c Functions for loading and saving playlists. */
17 /** Structure used for adding entries to a playlist. */
18 struct playlist_instance {
19 /** The name of the playlist. */
21 /** The number of entries currently in the playlist. */
24 static struct playlist_instance current_playlist;
27 * Re-insert an audio file into the tree of admissible files.
29 * \param aft_row Determines the audio file.
31 * \return The return value of score_update().
33 static int playlist_update_audio_file(const struct osl_row *aft_row)
35 /* always re-insert to the top of the tree */
36 return score_update(aft_row, 0);
39 static int add_playlist_entry(char *path, void *data)
41 struct playlist_instance *playlist = data;
42 struct osl_row *aft_row;
43 int ret = aft_get_row_of_path(path, &aft_row);
46 PARA_NOTICE_LOG("%s: %s\n", path, para_strerror(-ret));
49 ret = score_add(aft_row, -playlist->length);
51 PARA_ERROR_LOG("failed to add %s: %s\n", path, para_strerror(-ret));
58 static int check_playlist_path(char *path, void *data)
60 struct para_buffer *pb = data;
61 struct osl_row *aft_row;
62 int ret = aft_get_row_of_path(path, &aft_row);
65 para_printf(pb, "%s: %s\n", path, para_strerror(-ret));
66 return 1; /* do not fail the loop on bad paths */
69 static int check_playlist(struct osl_row *row, void *data)
71 struct para_buffer *pb = data;
72 struct osl_object playlist_def;
74 int ret = pl_get_name_and_def_by_row(row, &playlist_name, &playlist_def);
76 if (ret < 0) { /* log error, but continue */
77 para_printf(pb, "failed to get playlist data: %s\n",
81 if (*playlist_name) { /* skip dummy row */
82 para_printf(pb, "checking playlist %s...\n", playlist_name);
83 for_each_line(FELF_READ_ONLY, playlist_def.data,
84 playlist_def.size, check_playlist_path, pb);
86 osl_close_disk_object(&playlist_def);
91 * Check the playlist table for inconsistencies.
93 * \param aca This callback ignores ->query.
95 * \return Standard. Invalid paths are reported, but are not considered an
98 int playlist_check_callback(struct afs_callback_arg *aca)
100 para_printf(&aca->pbout, "checking playlists...\n");
101 return osl(osl_rbtree_loop(playlists_table, BLOBCOL_ID, &aca->pbout,
105 /** Free all resources of the current playlist, if any. */
106 void playlist_unload(void)
108 if (!current_playlist.name)
110 free(current_playlist.name);
111 current_playlist.name = NULL;
112 current_playlist.length = 0;
116 * Populate the score table from the paths of a playlist database object.
118 * This loads the blob object which corresponds to the given name from the
119 * playlist table. Each line of the blob is regarded as a path which is looked
120 * up in the audio file table. If the path lookup succeeds, a reference to the
121 * corresponding row of the audio file table is added to the score table.
123 * \param name The name of the playlist to load.
124 * \param msg Error message or playlist info is returned here.
126 * \return The length of the loaded playlist on success, negative error code
127 * else. Files which are listed in the playlist, but are not contained in the
128 * database are ignored. This is not considered an error.
130 int playlist_load(const char *name, char **msg)
133 struct playlist_instance *playlist = ¤t_playlist;
134 struct osl_object playlist_def;
136 ret = pl_get_def_by_name(name, &playlist_def);
138 *msg = make_message("could not read playlist %s\n", name);
142 ret = for_each_line(FELF_READ_ONLY, playlist_def.data,
143 playlist_def.size, add_playlist_entry, playlist);
144 osl_close_disk_object(&playlist_def);
147 ret = -E_PLAYLIST_EMPTY;
148 if (!playlist->length)
150 playlist->name = para_strdup(name);
151 *msg = make_message("loaded playlist %s (%u files)\n", playlist->name,
154 return current_playlist.length;
156 PARA_NOTICE_LOG("unable to load playlist %s\n", name);
157 *msg = make_message("unable to load playlist %s\n", name);
161 static int search_path(char *path, void *data)
163 if (strcmp(path, data))
165 return -E_PATH_FOUND;
168 static int handle_audio_file_event(enum afs_events event, void *data)
171 bool was_admissible = false, is_admissible;
172 struct osl_object playlist_def;
174 const struct osl_row *row = data;
176 if (event == AUDIO_FILE_RENAME)
177 was_admissible = row_belongs_to_score_table(row);
178 ret = get_audio_file_path_of_row(row, &new_path);
181 ret = pl_get_def_by_name(current_playlist.name, &playlist_def);
184 ret = for_each_line(FELF_READ_ONLY, playlist_def.data,
185 playlist_def.size, search_path, new_path);
186 osl_close_disk_object(&playlist_def);
187 is_admissible = (ret < 0);
188 if (was_admissible && is_admissible)
190 if (!was_admissible && !is_admissible)
192 if (was_admissible && !is_admissible) {
193 current_playlist.length--;
194 return score_delete(row);
196 /* !was_admissible && is_admissible */
197 current_playlist.length++;
198 return score_add(row, 0); /* play it immediately */
202 * Handle afs events relevant to playlists.
204 * \param event The event type.
206 * \param data Depends on the event type.
210 int playlists_event_handler(enum afs_events event,
211 __a_unused struct para_buffer *pb, void *data)
213 struct afsi_change_event_data *aced = data;
215 if (!current_playlist.name)
219 return playlist_update_audio_file(aced->aft_row);
220 case AUDIO_FILE_RENAME:
222 return handle_audio_file_event(event, data);
223 case AUDIO_FILE_REMOVE:
224 if (!row_belongs_to_score_table(data))
226 current_playlist.length--;
227 return score_delete(data);