libmpdclient  2.9
song.h
Go to the documentation of this file.
1 /* libmpdclient
2  (c) 2003-2010 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 <mpd/tag.h>
43 #include <mpd/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 
115 mpd_pure
116 unsigned
117 mpd_song_get_start(const struct mpd_song *song);
118 
124 mpd_pure
125 unsigned
126 mpd_song_get_end(const struct mpd_song *song);
127 
132 mpd_pure
133 time_t
134 mpd_song_get_last_modified(const struct mpd_song *song);
135 
143 void
144 mpd_song_set_pos(struct mpd_song *song, unsigned pos);
145 
150 mpd_pure
151 unsigned
152 mpd_song_get_pos(const struct mpd_song *song);
153 
158 mpd_pure
159 unsigned
160 mpd_song_get_id(const struct mpd_song *song);
161 
166 mpd_pure
167 unsigned
168 mpd_song_get_prio(const struct mpd_song *song);
169 
177 mpd_malloc
178 struct mpd_song *
179 mpd_song_begin(const struct mpd_pair *pair);
180 
189 bool
190 mpd_song_feed(struct mpd_song *song, const struct mpd_pair *pair);
191 
198 mpd_malloc
199 struct mpd_song *
200 mpd_recv_song(struct mpd_connection *connection);
201 
202 #ifdef __cplusplus
203 }
204 #endif
205 
206 #endif