chiark / gitweb /
Playing checkbox in Disobedience choose tab is now only visible for
[disorder] / disobedience / log.c
CommitLineData
10e226b3
RK
1/*
2 * This file is part of DisOrder.
3 * Copyright (C) 2006, 2007 Richard Kettlewell
4 *
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.
9 *
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.
14 *
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
18 * USA
19 */
219dc95c
RK
20/** @file disobedience/log.c
21 * @brief State monitoring
22 *
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
25 * achieve this.
26 */
10e226b3
RK
27
28#include "disobedience.h"
29
186f896b 30/* State monitoring -------------------------------------------------------- */
10e226b3
RK
31
32static void log_connected(void *v);
33static void log_completed(void *v, const char *track);
34static void log_failed(void *v, const char *track, const char *status);
35static void log_moved(void *v, const char *user);
36static void log_playing(void *v, const char *track, const char *user);
37static void log_queue(void *v, struct queue_entry *q);
38static void log_recent_added(void *v, struct queue_entry *q);
39static void log_recent_removed(void *v, const char *id);
40static void log_removed(void *v, const char *id, const char *user);
41static void log_scratched(void *v, const char *track, const char *user);
42static void log_state(void *v, unsigned long state);
43static void log_volume(void *v, int l, int r);
e025abff 44static void log_rescanned(void *v);
10e226b3
RK
45
46/** @brief Callbacks for server state monitoring */
47const disorder_eclient_log_callbacks log_callbacks = {
48 log_connected,
49 log_completed,
50 log_failed,
51 log_moved,
52 log_playing,
53 log_queue,
54 log_recent_added,
55 log_recent_removed,
56 log_removed,
57 log_scratched,
58 log_state,
e025abff
RK
59 log_volume,
60 log_rescanned
10e226b3
RK
61};
62
219dc95c 63/** @brief Update everything */
10e226b3 64void all_update(void) {
fb44b59e 65 ++suppress_actions;
3569ddb8
RK
66 event_raise("queue-changed", 0);
67 event_raise("recent-changed", 0);
1f868ca3 68 event_raise("volume-changed", 0);
3569ddb8 69 event_raise("added-changed", 0);
fb44b59e 70 --suppress_actions;
10e226b3
RK
71}
72
219dc95c
RK
73/** @brief Called when the client connects
74 *
75 * Depending on server and network state the TCP connection to the server may
76 * go up or down many times during the lifetime of Disobedience. This function
77 * is called whenever it connects.
219dc95c 78 */
10e226b3 79static void log_connected(void attribute((unused)) *v) {
10e226b3
RK
80 /* Don't know what we might have missed while disconnected so update
81 * everything. We get this at startup too and this is how we do the initial
82 * state fetch. */
83 all_update();
10e226b3
RK
84}
85
219dc95c 86/** @brief Called when the current track finishes playing */
10e226b3
RK
87static void log_completed(void attribute((unused)) *v,
88 const char attribute((unused)) *track) {
10e226b3
RK
89}
90
219dc95c 91/** @brief Called when the current track fails */
10e226b3
RK
92static void log_failed(void attribute((unused)) *v,
93 const char attribute((unused)) *track,
94 const char attribute((unused)) *status) {
10e226b3
RK
95}
96
219dc95c 97/** @brief Called when some track is moved within the queue */
10e226b3
RK
98static void log_moved(void attribute((unused)) *v,
99 const char attribute((unused)) *user) {
3569ddb8 100 event_raise("queue-changed", 0);
10e226b3
RK
101}
102
103static void log_playing(void attribute((unused)) *v,
104 const char attribute((unused)) *track,
105 const char attribute((unused)) *user) {
10e226b3
RK
106}
107
219dc95c 108/** @brief Called when a track is added to the queue */
10e226b3
RK
109static void log_queue(void attribute((unused)) *v,
110 struct queue_entry attribute((unused)) *q) {
3569ddb8 111 event_raise("queue-changed", 0);
10e226b3
RK
112}
113
219dc95c 114/** @brief Called when a track is added to the recently-played list */
10e226b3
RK
115static void log_recent_added(void attribute((unused)) *v,
116 struct queue_entry attribute((unused)) *q) {
3569ddb8 117 event_raise("recent-changed", 0);
10e226b3
RK
118}
119
219dc95c
RK
120/** @brief Called when a track is removed from the recently-played list
121 *
122 * We do nothing here - log_recent_added() suffices.
123 */
10e226b3
RK
124static void log_recent_removed(void attribute((unused)) *v,
125 const char attribute((unused)) *id) {
126 /* nothing - log_recent_added() will trigger the relevant update */
127}
128
219dc95c 129/** @brief Called when a track is removed from the queue */
10e226b3
RK
130static void log_removed(void attribute((unused)) *v,
131 const char attribute((unused)) *id,
132 const char attribute((unused)) *user) {
3569ddb8 133 event_raise("queue-changed", 0);
10e226b3
RK
134}
135
219dc95c 136/** @brief Called when the current track is scratched */
10e226b3
RK
137static void log_scratched(void attribute((unused)) *v,
138 const char attribute((unused)) *track,
139 const char attribute((unused)) *user) {
10e226b3
RK
140}
141
a8cd6f84
RK
142/** @brief Map from state bits to state change events */
143static const struct {
144 unsigned long bit;
145 const char *event;
146} state_events[] = {
147 { DISORDER_PLAYING_ENABLED, "enabled-changed" },
148 { DISORDER_RANDOM_ENABLED, "random-changed" },
149 { DISORDER_TRACK_PAUSED, "pause-changed" },
150 { DISORDER_PLAYING, "playing-changed" },
151};
152#define NSTATE_EVENTS (sizeof state_events / sizeof *state_events)
153
219dc95c 154/** @brief Called when a state change occurs */
10e226b3
RK
155static void log_state(void attribute((unused)) *v,
156 unsigned long state) {
6d1302f0
RK
157 unsigned long changes = state ^ last_state;
158 static int first = 1;
fb44b59e
RK
159
160 ++suppress_actions;
6d1302f0
RK
161 if(first) {
162 changes = -1UL;
163 first = 0;
164 }
165 D(("log_state old=%s new=%s changed=%s",
166 disorder_eclient_interpret_state(last_state),
167 disorder_eclient_interpret_state(state),
168 disorder_eclient_interpret_state(changes)));
00959300 169 last_state = state;
a8cd6f84
RK
170 /* Notify interested parties what has changed */
171 for(unsigned n = 0; n < NSTATE_EVENTS; ++n)
172 if(changes & state_events[n].bit)
173 event_raise(state_events[n].event, 0);
fb44b59e 174 --suppress_actions;
10e226b3
RK
175}
176
219dc95c 177/** @brief Called when volume changes */
10e226b3
RK
178static void log_volume(void attribute((unused)) *v,
179 int l, int r) {
321f7536 180 if(!rtp_supported && (volume_l != l || volume_r != r)) {
10e226b3
RK
181 volume_l = l;
182 volume_r = r;
fb44b59e 183 ++suppress_actions;
1f868ca3 184 event_raise("volume-changed", 0);
fb44b59e 185 --suppress_actions;
10e226b3
RK
186 }
187}
188
e025abff
RK
189/** @brief Called when a rescan completes */
190static void log_rescanned(void attribute((unused)) *v) {
3569ddb8 191 event_raise("added-changed", 0);
e025abff
RK
192}
193
10e226b3
RK
194/*
195Local Variables:
196c-basic-offset:2
197comment-column:40
198fill-column:79
199indent-tabs-mode:nil
200End:
201*/