1 /***************************************************************************
3 * Open \______ \ ____ ____ | | _\_ |__ _______ ___
4 * Source | _// _ \_/ ___\| |/ /| __ \ / _ \ \/ /
5 * Jukebox | | ( <_> ) \___| < | \_\ ( <_> > < <
6 * Firmware |____|_ /\____/ \___ >__|_ \|___ /\____/__/\_ \
10 * Copyright (C) 2002 by wavey@wavey.org
12 * This program is free software; you can redistribute it and/or
13 * modify it under the terms of the GNU General Public License
14 * as published by the Free Software Foundation; either version 2
15 * of the License, or (at your option) any later version.
17 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
18 * KIND, either express or implied.
20 ****************************************************************************/
22 #ifndef __PLAYLIST_H__
23 #define __PLAYLIST_H__
30 #define PLAYLIST_ATTR_QUEUED 0x01
31 #define PLAYLIST_ATTR_INSERTED 0x02
32 #define PLAYLIST_ATTR_SKIPPED 0x04
33 #define PLAYLIST_MAX_CACHE 16
35 #define PLAYLIST_DISPLAY_COUNT 10
37 #define DEFAULT_DYNAMIC_PLAYLIST_NAME "/dynamic.m3u8"
39 enum playlist_command
{
40 PLAYLIST_COMMAND_PLAYLIST
,
42 PLAYLIST_COMMAND_QUEUE
,
43 PLAYLIST_COMMAND_DELETE
,
44 PLAYLIST_COMMAND_SHUFFLE
,
45 PLAYLIST_COMMAND_UNSHUFFLE
,
46 PLAYLIST_COMMAND_RESET
,
47 PLAYLIST_COMMAND_COMMENT
51 PLAYLIST_PREPEND
= -1,
53 PLAYLIST_INSERT_LAST
= -3,
54 PLAYLIST_INSERT_FIRST
= -4,
55 PLAYLIST_INSERT_SHUFFLED
= -5,
56 PLAYLIST_REPLACE
= -6,
57 PLAYLIST_INSERT_LAST_SHUFFLED
= -7
61 PLAYLIST_DELETE_CURRENT
= -1
64 struct playlist_control_cache
{
65 enum playlist_command command
;
75 bool current
; /* current playing playlist */
76 char filename
[MAX_PATH
]; /* path name of m3u playlist on disk */
77 char control_filename
[MAX_PATH
]; /* full path of control file */
78 bool utf8
; /* playlist is in .m3u8 format */
79 int fd
; /* descriptor of the open playlist file */
80 int control_fd
; /* descriptor of the open control file */
81 bool control_created
; /* has control file been created? */
82 int dirlen
; /* Length of the path to the playlist file */
83 unsigned long *indices
; /* array of indices */
84 const struct dircache_entry
**filenames
; /* Entries from dircache */
85 int max_playlist_size
; /* Max number of files in playlist. Mirror of
86 global_settings.max_files_in_playlist */
87 bool in_ram
; /* playlist stored in ram (dirplay) */
88 char *buffer
; /* buffer for in-ram playlists */
89 int buffer_size
; /* size of buffer */
90 int buffer_end_pos
; /* last position where buffer was written */
91 int index
; /* index of current playing track */
92 int first_index
; /* index of first song in playlist */
93 int resume_index
; /* index of playing track to resume */
94 int amount
; /* number of tracks in the index */
95 int last_insert_pos
; /* last position we inserted a track */
96 int seed
; /* shuffle seed */
97 bool shuffle_modified
; /* has playlist been shuffled with
99 bool deleted
; /* have any tracks been deleted? */
100 int num_inserted_tracks
; /* number of tracks inserted */
101 bool started
; /* has playlist been started? */
103 /* cache of playlist control commands waiting to be flushed to
105 struct playlist_control_cache control_cache
[PLAYLIST_MAX_CACHE
];
106 int num_cached
; /* number of cached entries */
107 bool pending_control_sync
; /* control file needs to be synced */
109 struct mutex
*control_mutex
; /* mutex for control file access */
110 int last_shuffled_start
; /* number of tracks when insert last
111 shuffled command start */
114 struct playlist_track_info
116 char filename
[MAX_PATH
]; /* path name of mp3 file */
117 int attr
; /* playlist attributes for track */
118 int index
; /* index of track in playlist */
119 int display_index
; /* index of track for display */
122 /* Exported functions only for current playlist. */
123 void playlist_init(void) INIT_ATTR
;
124 void playlist_shutdown(void);
125 int playlist_create(const char *dir
, const char *file
);
126 int playlist_resume(void);
127 int playlist_add(const char *filename
);
128 int playlist_shuffle(int random_seed
, int start_index
);
129 void playlist_start(int start_index
, int offset
);
130 bool playlist_check(int steps
);
131 const char *playlist_peek(int steps
, char* buf
, size_t buf_size
);
132 int playlist_next(int steps
);
133 bool playlist_next_dir(int direction
);
134 int playlist_get_resume_info(int *resume_index
);
135 int playlist_get_index(void);
136 int playlist_update_resume_info(const struct mp3entry
* id3
);
137 int playlist_get_display_index(void);
138 int playlist_amount(void);
139 void playlist_set_last_shuffled_start(void);
140 struct playlist_info
*playlist_get_current(void);
142 /* Exported functions for all playlists. Pass NULL for playlist_info
143 structure to work with current playlist. */
144 int playlist_create_ex(struct playlist_info
* playlist
,
145 const char* dir
, const char* file
,
146 void* index_buffer
, int index_buffer_size
,
147 void* temp_buffer
, int temp_buffer_size
);
148 int playlist_set_current(struct playlist_info
* playlist
);
149 void playlist_close(struct playlist_info
* playlist
);
150 void playlist_sync(struct playlist_info
* playlist
);
151 int playlist_insert_track(struct playlist_info
* playlist
, const char *filename
,
152 int position
, bool queue
, bool sync
);
153 int playlist_insert_directory(struct playlist_info
* playlist
,
154 const char *dirname
, int position
, bool queue
,
156 int playlist_insert_playlist(struct playlist_info
* playlist
, const char *filename
,
157 int position
, bool queue
);
158 void playlist_skip_entry(struct playlist_info
*playlist
, int steps
);
159 int playlist_delete(struct playlist_info
* playlist
, int index
);
160 int playlist_move(struct playlist_info
* playlist
, int index
, int new_index
);
161 int playlist_randomise(struct playlist_info
* playlist
, unsigned int seed
,
163 int playlist_sort(struct playlist_info
* playlist
, bool start_current
);
164 bool playlist_modified(const struct playlist_info
* playlist
);
165 int playlist_get_first_index(const struct playlist_info
* playlist
);
166 int playlist_get_seed(const struct playlist_info
* playlist
);
167 int playlist_amount_ex(const struct playlist_info
* playlist
);
168 char *playlist_name(const struct playlist_info
* playlist
, char *buf
,
170 char *playlist_get_name(const struct playlist_info
* playlist
, char *buf
,
172 int playlist_get_track_info(struct playlist_info
* playlist
, int index
,
173 struct playlist_track_info
* info
);
174 int playlist_save(struct playlist_info
* playlist
, char *filename
);
175 int playlist_directory_tracksearch(const char* dirname
, bool recurse
,
176 int (*callback
)(char*, void*),
178 int playlist_remove_all_tracks(struct playlist_info
*playlist
);
179 void playlist_update_resume_index(void);
181 #endif /* __PLAYLIST_H__ */