libmpdclient  2.13
song.h
Go to the documentation of this file.
1 /* libmpdclient
2  (c) 2003-2017 The Music Player Daemon Project
3  This project's homepage is: http://www.musicpd.org
4 
5  Redistribution and use in source and binary forms, with or without
6  modification, are permitted provided that the following conditions
7  are met:
8 
9  - Redistributions of source code must retain the above copyright
10  notice, this list of conditions and the following disclaimer.
11 
12  - Redistributions in binary form must reproduce the above copyright
13  notice, this list of conditions and the following disclaimer in the
14  documentation and/or other materials provided with the distribution.
15 
16  - Neither the name of the Music Player Daemon nor the names of its
17  contributors may be used to endorse or promote products derived from
18  this software without specific prior written permission.
19 
20  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21  ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR
24  CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
25  EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
26  PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
27  PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
28  LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
29  NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
30  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 */
32 
39 #ifndef MPD_SONG_H
40 #define MPD_SONG_H
41 
42 #include "tag.h"
43 #include "compiler.h"
44 
45 #include <stdbool.h>
46 #include <time.h>
47 
48 struct mpd_pair;
50 
58 struct mpd_song;
59 
60 #ifdef __cplusplus
61 extern "C" {
62 #endif
63 
67 void mpd_song_free(struct mpd_song *song);
68 
74 mpd_malloc
75 struct mpd_song *
76 mpd_song_dup(const struct mpd_song *song);
77 
83 mpd_pure
84 const char *
85 mpd_song_get_uri(const struct mpd_song *song);
86 
98 mpd_pure
99 const char *
100 mpd_song_get_tag(const struct mpd_song *song,
101  enum mpd_tag_type type, unsigned idx);
102 
107 mpd_pure
108 unsigned
109 mpd_song_get_duration(const struct mpd_song *song);
110 
117 mpd_pure
118 unsigned
119 mpd_song_get_duration_ms(const struct mpd_song *song);
120 
127 mpd_pure
128 unsigned
129 mpd_song_get_start(const struct mpd_song *song);
130 
138 mpd_pure
139 unsigned
140 mpd_song_get_end(const struct mpd_song *song);
141 
146 mpd_pure
147 time_t
148 mpd_song_get_last_modified(const struct mpd_song *song);
149 
157 void
158 mpd_song_set_pos(struct mpd_song *song, unsigned pos);
159 
164 mpd_pure
165 unsigned
166 mpd_song_get_pos(const struct mpd_song *song);
167 
172 mpd_pure
173 unsigned
174 mpd_song_get_id(const struct mpd_song *song);
175 
182 mpd_pure
183 unsigned
184 mpd_song_get_prio(const struct mpd_song *song);
185 
193 mpd_malloc
194 struct mpd_song *
195 mpd_song_begin(const struct mpd_pair *pair);
196 
205 bool
206 mpd_song_feed(struct mpd_song *song, const struct mpd_pair *pair);
207 
214 mpd_malloc
215 struct mpd_song *
216 mpd_recv_song(struct mpd_connection *connection);
217 
218 #ifdef __cplusplus
219 }
220 #endif
221 
222 #endif
mpd_malloc struct mpd_song * mpd_song_begin(const struct mpd_pair *pair)
void mpd_song_free(struct mpd_song *song)
mpd_pure time_t mpd_song_get_last_modified(const struct mpd_song *song)
mpd_tag_type
Definition: tag.h:40
bool mpd_song_feed(struct mpd_song *song, const struct mpd_pair *pair)
mpd_pure unsigned mpd_song_get_end(const struct mpd_song *song)
Compiler specific definitions.
mpd_pure unsigned mpd_song_get_duration_ms(const struct mpd_song *song)
mpd_pure unsigned mpd_song_get_prio(const struct mpd_song *song)
mpd_malloc struct mpd_song * mpd_song_dup(const struct mpd_song *song)
mpd_pure const char * mpd_song_get_uri(const struct mpd_song *song)
mpd_pure unsigned mpd_song_get_start(const struct mpd_song *song)
mpd_pure unsigned mpd_song_get_id(const struct mpd_song *song)
mpd_pure const char * mpd_song_get_tag(const struct mpd_song *song, enum mpd_tag_type type, unsigned idx)
mpd_malloc struct mpd_song * mpd_recv_song(struct mpd_connection *connection)
Definition: song.h:49
void mpd_song_set_pos(struct mpd_song *song, unsigned pos)
mpd_pure unsigned mpd_song_get_duration(const struct mpd_song *song)
Definition: pair.h:41
mpd_pure unsigned mpd_song_get_pos(const struct mpd_song *song)