2 * This file is part of DisOrder.
3 * Copyright (C) 2006, 2007 Richard Kettlewell
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
20 /** @file disobedience/log.c
21 * @brief State monitoring
23 * Disobedience relies on the server to tell when essentially anything changes,
24 * even if it initiated the change itself. It uses the @c log command to
28 #include "disobedience.h"
30 /* State monitoring -------------------------------------------------------- */
32 static void log_connected(void *v
);
33 static void log_completed(void *v
, const char *track
);
34 static void log_failed(void *v
, const char *track
, const char *status
);
35 static void log_moved(void *v
, const char *user
);
36 static void log_playing(void *v
, const char *track
, const char *user
);
37 static void log_queue(void *v
, struct queue_entry
*q
);
38 static void log_recent_added(void *v
, struct queue_entry
*q
);
39 static void log_recent_removed(void *v
, const char *id
);
40 static void log_removed(void *v
, const char *id
, const char *user
);
41 static void log_scratched(void *v
, const char *track
, const char *user
);
42 static void log_state(void *v
, unsigned long state
);
43 static void log_volume(void *v
, int l
, int r
);
44 static void log_rescanned(void *v
);
46 /** @brief Callbacks for server state monitoring */
47 const disorder_eclient_log_callbacks log_callbacks
= {
63 /** @brief State monitor
65 * We keep a linked list of everything that is interested in state changes.
68 /** @brief Next monitor */
71 /** @brief State bits of interest */
74 /** @brief Function to call if any of @c mask change */
75 monitor_callback
*callback
;
77 /** @brief User data for callback */
81 /** @brief List of monitors */
82 static struct monitor
*monitors
;
84 /** @brief Update everything */
85 void all_update(void) {
92 /** @brief Called when the client connects
94 * Depending on server and network state the TCP connection to the server may
95 * go up or down many times during the lifetime of Disobedience. This function
96 * is called whenever it connects.
98 * The intent is to use the monitor logic to achieve this in future.
100 static void log_connected(void attribute((unused
)) *v
) {
101 /* Don't know what we might have missed while disconnected so update
102 * everything. We get this at startup too and this is how we do the initial
107 /** @brief Called when the current track finishes playing */
108 static void log_completed(void attribute((unused
)) *v
,
109 const char attribute((unused
)) *track
) {
112 /** @brief Called when the current track fails */
113 static void log_failed(void attribute((unused
)) *v
,
114 const char attribute((unused
)) *track
,
115 const char attribute((unused
)) *status
) {
118 /** @brief Called when some track is moved within the queue */
119 static void log_moved(void attribute((unused
)) *v
,
120 const char attribute((unused
)) *user
) {
124 static void log_playing(void attribute((unused
)) *v
,
125 const char attribute((unused
)) *track
,
126 const char attribute((unused
)) *user
) {
129 /** @brief Called when a track is added to the queue */
130 static void log_queue(void attribute((unused
)) *v
,
131 struct queue_entry
attribute((unused
)) *q
) {
135 /** @brief Called when a track is added to the recently-played list */
136 static void log_recent_added(void attribute((unused
)) *v
,
137 struct queue_entry
attribute((unused
)) *q
) {
141 /** @brief Called when a track is removed from the recently-played list
143 * We do nothing here - log_recent_added() suffices.
145 static void log_recent_removed(void attribute((unused
)) *v
,
146 const char attribute((unused
)) *id
) {
147 /* nothing - log_recent_added() will trigger the relevant update */
150 /** @brief Called when a track is removed from the queue */
151 static void log_removed(void attribute((unused
)) *v
,
152 const char attribute((unused
)) *id
,
153 const char attribute((unused
)) *user
) {
158 /** @brief Called when the current track is scratched */
159 static void log_scratched(void attribute((unused
)) *v
,
160 const char attribute((unused
)) *track
,
161 const char attribute((unused
)) *user
) {
164 /** @brief Called when a state change occurs */
165 static void log_state(void attribute((unused
)) *v
,
166 unsigned long state
) {
167 const struct monitor
*m
;
168 unsigned long changes
= state
^ last_state
;
169 static int first
= 1;
175 D(("log_state old=%s new=%s changed=%s",
176 disorder_eclient_interpret_state(last_state
),
177 disorder_eclient_interpret_state(state
),
178 disorder_eclient_interpret_state(changes
)));
180 /* Tell anything that cares about the state change */
181 for(m
= monitors
; m
; m
= m
->next
) {
182 if(changes
& m
->mask
)
187 /** @brief Called when volume changes */
188 static void log_volume(void attribute((unused
)) *v
,
190 if(!rtp_supported
&& (volume_l
!= l
|| volume_r
!= r
)) {
197 /** @brief Called when a rescan completes */
198 static void log_rescanned(void attribute((unused
)) *v
) {
202 /** @brief Add a monitor to the list
203 * @param callback Function to call
204 * @param u User data to pass to @p callback
205 * @param mask Mask of flags that @p callback cares about
207 * Pass @p mask as -1UL to match all flags.
209 void register_monitor(monitor_callback
*callback
,
211 unsigned long mask
) {
212 struct monitor
*m
= xmalloc(sizeof *m
);
216 m
->callback
= callback
;