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