code.delx.au - pulseaudio/blob - polyp/pdispatch.c

   1 /* $Id$ */
   2
   3 /***
   4   This file is part of polypaudio.
   5
   6   polypaudio is free software; you can redistribute it and/or modify
   7   it under the terms of the GNU General Public License as published
   8   by the Free Software Foundation; either version 2 of the License,
   9   or (at your option) any later version.
  10
  11   polypaudio is distributed in the hope that it will be useful, but
  12   WITHOUT ANY WARRANTY; without even the implied warranty of
  13   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  14   General Public License for more details.
  15
  16   You should have received a copy of the GNU General Public License
  17   along with polypaudio; if not, write to the Free Software
  18   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  19   USA.
  20 ***/
  21
  22 #ifdef HAVE_CONFIG_H
  23 #include <config.h>
  24 #endif
  25
  26 #include <stdio.h>
  27 #include <stdlib.h>
  28 #include <assert.h>
  29
  30 #include "pdispatch.h"
  31 #include "native-common.h"
  32 #include "xmalloc.h"
  33 #include "llist.h"
  34 #include "log.h"
  35
  36 /* #define DEBUG_OPCODES */
  37
  38 #ifdef DEBUG_OPCODES
  39
  40 static const char *command_names[PA_COMMAND_MAX] = {
  41     [PA_COMMAND_ERROR] = "ERROR",
  42     [PA_COMMAND_TIMEOUT] = "TIMEOUT",
  43     [PA_COMMAND_REPLY] = "REPLY",
  44     [PA_COMMAND_CREATE_PLAYBACK_STREAM] = "CREATE_PLAYBACK_STREAM",
  45     [PA_COMMAND_DELETE_PLAYBACK_STREAM] = "DELETE_PLAYBACK_STREAM",
  46     [PA_COMMAND_CREATE_RECORD_STREAM] = "CREATE_RECORD_STREAM",
  47     [PA_COMMAND_DELETE_RECORD_STREAM] = "DELETE_RECORD_STREAM",
  48     [PA_COMMAND_AUTH] = "AUTH",
  49     [PA_COMMAND_REQUEST] = "REQUEST",
  50     [PA_COMMAND_EXIT] = "EXIT",
  51     [PA_COMMAND_SET_CLIENT_NAME] = "SET_CLIENT_NAME",
  52     [PA_COMMAND_LOOKUP_SINK] = "LOOKUP_SINK",
  53     [PA_COMMAND_LOOKUP_SOURCE] = "LOOKUP_SOURCE",
  54     [PA_COMMAND_DRAIN_PLAYBACK_STREAM] = "DRAIN_PLAYBACK_STREAM",
  55     [PA_COMMAND_PLAYBACK_STREAM_KILLED] = "PLAYBACK_STREAM_KILLED",
  56     [PA_COMMAND_RECORD_STREAM_KILLED] = "RECORD_STREAM_KILLED",
  57     [PA_COMMAND_STAT] = "STAT",
  58     [PA_COMMAND_GET_PLAYBACK_LATENCY] = "PLAYBACK_LATENCY",
  59     [PA_COMMAND_CREATE_UPLOAD_STREAM] = "CREATE_UPLOAD_STREAM",
  60     [PA_COMMAND_DELETE_UPLOAD_STREAM] = "DELETE_UPLOAD_STREAM",
  61     [PA_COMMAND_FINISH_UPLOAD_STREAM] = "FINISH_UPLOAD_STREAM",
  62     [PA_COMMAND_PLAY_SAMPLE] = "PLAY_SAMPLE",
  63     [PA_COMMAND_REMOVE_SAMPLE] = "REMOVE_SAMPLE",
  64     [PA_COMMAND_GET_SERVER_INFO] = "GET_SERVER_INFO",
  65     [PA_COMMAND_GET_SINK_INFO] = "GET_SINK_INFO",
  66     [PA_COMMAND_GET_SINK_INFO_LIST] = "GET_SINK_INFO_LIST",
  67     [PA_COMMAND_GET_SOURCE_INFO] = "GET_SOURCE_INFO",
  68     [PA_COMMAND_GET_SOURCE_INFO_LIST] = "GET_SOURCE_INFO_LIST",
  69     [PA_COMMAND_GET_MODULE_INFO] = "GET_MODULE_INFO",
  70     [PA_COMMAND_GET_MODULE_INFO_LIST] = "GET_MODULE_INFO_LIST",
  71     [PA_COMMAND_GET_CLIENT_INFO] = "GET_CLIENT_INFO",
  72     [PA_COMMAND_GET_CLIENT_INFO_LIST] = "GET_CLIENT_INFO_LIST",
  73     [PA_COMMAND_GET_SAMPLE_INFO] = "GET_SAMPLE_INFO",
  74     [PA_COMMAND_GET_SAMPLE_INFO_LIST] = "GET_SAMPLE_INFO_LIST",
  75     [PA_COMMAND_GET_SINK_INPUT_INFO] = "GET_SINK_INPUT_INFO",
  76     [PA_COMMAND_GET_SINK_INPUT_INFO_LIST] = "GET_SINK_INPUT_INFO_LIST",
  77     [PA_COMMAND_GET_SOURCE_OUTPUT_INFO] = "GET_SOURCE_OUTPUT_INFO",
  78     [PA_COMMAND_GET_SOURCE_OUTPUT_INFO_LIST] = "GET_SOURCE_OUTPUT_INFO_LIST",
  79     [PA_COMMAND_SUBSCRIBE] = "SUBSCRIBE",
  80     [PA_COMMAND_SUBSCRIBE_EVENT] = "SUBSCRIBE_EVENT",
  81     [PA_COMMAND_SET_SINK_VOLUME] = "SET_SINK_VOLUME",
  82     [PA_COMMAND_SET_SINK_INPUT_VOLUME] = "SET_SINK_INPUT_VOLUME",
  83     [PA_COMMAND_TRIGGER_PLAYBACK_STREAM] = "TRIGGER_PLAYBACK_STREAM",
  84     [PA_COMMAND_FLUSH_PLAYBACK_STREAM] = "FLUSH_PLAYBACK_STREAM",
  85     [PA_COMMAND_CORK_PLAYBACK_STREAM] = "CORK_PLAYBACK_STREAM",
  86     [PA_COMMAND_GET_AUTOLOAD_INFO] = "GET_AUTOLOAD_INFO",
  87     [PA_COMMAND_GET_AUTOLOAD_INFO_LIST] = "GET_AUTOLOAD_INFO_LIST",
  88 };
  89
  90 #endif
  91
  92 struct reply_info {
  93     struct pa_pdispatch *pdispatch;
  94     PA_LLIST_FIELDS(struct reply_info);
  95     void (*callback)(struct pa_pdispatch *pd, uint32_t command, uint32_t tag, struct pa_tagstruct *t, void *userdata);
  96     void *userdata;
  97     uint32_t tag;
  98     struct pa_time_event *time_event;
  99 };
 100
 101 struct pa_pdispatch {
 102     int ref;
 103     struct pa_mainloop_api *mainloop;
 104     const struct pa_pdispatch_command *command_table;
 105     unsigned n_commands;
 106     PA_LLIST_HEAD(struct reply_info, replies);
 107     void (*drain_callback)(struct pa_pdispatch *pd, void *userdata);
 108     void *drain_userdata;
 109 };
 110
 111 static void reply_info_free(struct reply_info *r) {
 112     assert(r && r->pdispatch && r->pdispatch->mainloop);
 113
 114     if (r->time_event)
 115         r->pdispatch->mainloop->time_free(r->time_event);
 116
 117     PA_LLIST_REMOVE(struct reply_info, r->pdispatch->replies, r);
 118
 119     pa_xfree(r);
 120 }
 121
 122 struct pa_pdispatch* pa_pdispatch_new(struct pa_mainloop_api *mainloop, const struct pa_pdispatch_command*table, unsigned entries) {
 123     struct pa_pdispatch *pd;
 124     assert(mainloop);
 125
 126     assert((entries && table) || (!entries && !table));
 127
 128     pd = pa_xmalloc(sizeof(struct pa_pdispatch));
 129     pd->ref = 1;
 130     pd->mainloop = mainloop;
 131     pd->command_table = table;
 132     pd->n_commands = entries;
 133     PA_LLIST_HEAD_INIT(struct pa_reply_info, pd->replies);
 134     pd->drain_callback = NULL;
 135     pd->drain_userdata = NULL;
 136
 137     return pd;
 138 }
 139
 140 void pdispatch_free(struct pa_pdispatch *pd) {
 141     assert(pd);
 142
 143     while (pd->replies)
 144         reply_info_free(pd->replies);
 145
 146     pa_xfree(pd);
 147 }
 148
 149 static void run_action(struct pa_pdispatch *pd, struct reply_info *r, uint32_t command, struct pa_tagstruct *ts) {
 150     void (*callback)(struct pa_pdispatch *pd, uint32_t command, uint32_t tag, struct pa_tagstruct *t, void *userdata);
 151     void *userdata;
 152     uint32_t tag;
 153     assert(r);
 154
 155     pa_pdispatch_ref(pd);
 156
 157     callback = r->callback;
 158     userdata = r->userdata;
 159     tag = r->tag;
 160
 161     reply_info_free(r);
 162
 163     callback(pd, command, tag, ts, userdata);
 164
 165     if (pd->drain_callback && !pa_pdispatch_is_pending(pd))
 166         pd->drain_callback(pd, pd->drain_userdata);
 167
 168     pa_pdispatch_unref(pd);
 169 }
 170
 171 int pa_pdispatch_run(struct pa_pdispatch *pd, struct pa_packet*packet, void *userdata) {
 172     uint32_t tag, command;
 173     struct pa_tagstruct *ts = NULL;
 174     int ret = -1;
 175     assert(pd && packet && packet->data);
 176
 177     pa_pdispatch_ref(pd);
 178
 179     if (packet->length <= 8)
 180         goto finish;
 181
 182     ts = pa_tagstruct_new(packet->data, packet->length);
 183     assert(ts);
 184
 185     if (pa_tagstruct_getu32(ts, &command) < 0 ||
 186         pa_tagstruct_getu32(ts, &tag) < 0)
 187         goto finish;
 188
 189 #ifdef DEBUG_OPCODES
 190 {
 191     char t[256];
 192     char const *p;
 193     if (!(p = command_names[command]))
 194         snprintf((char*) (p = t), sizeof(t), "%u", command);
 195
 196     pa_log(__FILE__": Recieved opcode <%s>\n", p);
 197 }
 198 #endif
 199
 200     if (command == PA_COMMAND_ERROR || command == PA_COMMAND_REPLY) {
 201         struct reply_info *r;
 202
 203         for (r = pd->replies; r; r = r->next)
 204             if (r->tag == tag)
 205                 break;
 206
 207         if (r)
 208             run_action(pd, r, command, ts);
 209
 210     } else if (pd->command_table && (command < pd->n_commands) && pd->command_table[command].proc) {
 211         const struct pa_pdispatch_command *c = pd->command_table+command;
 212
 213         c->proc(pd, command, tag, ts, userdata);
 214     } else {
 215         pa_log(__FILE__": Recieved unsupported command %u\n", command);
 216         goto finish;
 217     }
 218
 219     ret = 0;
 220
 221 finish:
 222     if (ts)
 223         pa_tagstruct_free(ts);
 224
 225     pa_pdispatch_unref(pd);
 226
 227     return ret;
 228 }
 229
 230 static void timeout_callback(struct pa_mainloop_api*m, struct pa_time_event*e, const struct timeval *tv, void *userdata) {
 231     struct reply_info*r = userdata;
 232     assert(r && r->time_event == e && r->pdispatch && r->pdispatch->mainloop == m && r->callback);
 233
 234     run_action(r->pdispatch, r, PA_COMMAND_TIMEOUT, NULL);
 235 }
 236
 237 void pa_pdispatch_register_reply(struct pa_pdispatch *pd, uint32_t tag, int timeout, void (*cb)(struct pa_pdispatch *pd, uint32_t command, uint32_t tag, struct pa_tagstruct *t, void *userdata), void *userdata) {
 238     struct reply_info *r;
 239     struct timeval tv;
 240     assert(pd && pd->ref >= 1 && cb);
 241
 242     r = pa_xmalloc(sizeof(struct reply_info));
 243     r->pdispatch = pd;
 244     r->callback = cb;
 245     r->userdata = userdata;
 246     r->tag = tag;
 247
 248     gettimeofday(&tv, NULL);
 249     tv.tv_sec += timeout;
 250
 251     r->time_event = pd->mainloop->time_new(pd->mainloop, &tv, timeout_callback, r);
 252     assert(r->time_event);
 253
 254     PA_LLIST_PREPEND(struct reply_info, pd->replies, r);
 255 }
 256
 257 int pa_pdispatch_is_pending(struct pa_pdispatch *pd) {
 258     assert(pd);
 259
 260     return !!pd->replies;
 261 }
 262
 263 void pa_pdispatch_set_drain_callback(struct pa_pdispatch *pd, void (*cb)(struct pa_pdispatch *pd, void *userdata), void *userdata) {
 264     assert(pd);
 265     assert(!cb || pa_pdispatch_is_pending(pd));
 266
 267     pd->drain_callback = cb;
 268     pd->drain_userdata = userdata;
 269 }
 270
 271 void pa_pdispatch_unregister_reply(struct pa_pdispatch *pd, void *userdata) {
 272     struct reply_info *r, *n;
 273     assert(pd);
 274
 275     for (r = pd->replies; r; r = n) {
 276         n = r->next;
 277
 278         if (r->userdata == userdata)
 279             reply_info_free(r);
 280     }
 281 }
 282
 283 void pa_pdispatch_unref(struct pa_pdispatch *pd) {
 284     assert(pd && pd->ref >= 1);
 285
 286     if (!(--(pd->ref)))
 287         pdispatch_free(pd);
 288 }
 289
 290 struct pa_pdispatch* pa_pdispatch_ref(struct pa_pdispatch *pd) {
 291     assert(pd && pd->ref >= 1);
 292     pd->ref++;
 293     return pd;
 294 }