src/pulsecore/pstream.c

   1 /* $Id$ */
   2
   3 /***
   4   This file is part of PulseAudio.
   5
   6   PulseAudio 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   PulseAudio 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 PulseAudio; 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 #include <unistd.h>
  30
  31 #ifdef HAVE_NETINET_IN_H
  32 #include <netinet/in.h>
  33 #endif
  34
  35 #include "winsock.h"
  36
  37 #include <pulse/xmalloc.h>
  38
  39 #include <pulsecore/queue.h>
  40 #include <pulsecore/log.h>
  41 #include <pulsecore/core-scache.h>
  42
  43 #include "pstream.h"
  44
  45 enum {
  46     PA_PSTREAM_DESCRIPTOR_LENGTH,
  47     PA_PSTREAM_DESCRIPTOR_CHANNEL,
  48     PA_PSTREAM_DESCRIPTOR_OFFSET_HI,
  49     PA_PSTREAM_DESCRIPTOR_OFFSET_LO,
  50     PA_PSTREAM_DESCRIPTOR_SEEK,
  51     PA_PSTREAM_DESCRIPTOR_MAX
  52 };
  53
  54 typedef uint32_t pa_pstream_descriptor[PA_PSTREAM_DESCRIPTOR_MAX];
  55
  56 #define PA_PSTREAM_DESCRIPTOR_SIZE (PA_PSTREAM_DESCRIPTOR_MAX*sizeof(uint32_t))
  57 #define FRAME_SIZE_MAX PA_SCACHE_ENTRY_SIZE_MAX /* allow uploading a single sample in one frame at max */
  58
  59 struct item_info {
  60     enum { PA_PSTREAM_ITEM_PACKET, PA_PSTREAM_ITEM_MEMBLOCK } type;
  61
  62     /* memblock info */
  63     pa_memchunk chunk;
  64     uint32_t channel;
  65     int64_t offset;
  66     pa_seek_mode_t seek_mode;
  67
  68     /* packet info */
  69     pa_packet *packet;
  70 #ifdef SCM_CREDENTIALS
  71     int with_creds;
  72 #endif
  73 };
  74
  75 struct pa_pstream {
  76     int ref;
  77
  78     pa_mainloop_api *mainloop;
  79     pa_defer_event *defer_event;
  80     pa_iochannel *io;
  81     pa_queue *send_queue;
  82
  83     int dead;
  84
  85     struct {
  86         struct item_info* current;
  87         pa_pstream_descriptor descriptor;
  88         void *data;
  89         size_t index;
  90     } write;
  91
  92     struct {
  93         pa_memblock *memblock;
  94         pa_packet *packet;
  95         pa_pstream_descriptor descriptor;
  96         void *data;
  97         size_t index;
  98     } read;
  99
 100     pa_pstream_packet_cb_t recieve_packet_callback;
 101     void *recieve_packet_callback_userdata;
 102
 103     pa_pstream_memblock_cb_t recieve_memblock_callback;
 104     void *recieve_memblock_callback_userdata;
 105
 106     pa_pstream_notify_cb_t drain_callback;
 107     void *drain_callback_userdata;
 108
 109     pa_pstream_notify_cb_t die_callback;
 110     void *die_callback_userdata;
 111
 112     pa_memblock_stat *memblock_stat;
 113
 114 #ifdef SCM_CREDENTIALS
 115     int send_creds_now;
 116     struct ucred ucred;
 117     int creds_valid;
 118 #endif
 119 };
 120
 121 static int do_write(pa_pstream *p);
 122 static int do_read(pa_pstream *p);
 123
 124 static void do_something(pa_pstream *p) {
 125     assert(p);
 126
 127     p->mainloop->defer_enable(p->defer_event, 0);
 128
 129     pa_pstream_ref(p);
 130
 131     if (!p->dead && pa_iochannel_is_readable(p->io)) {
 132         if (do_read(p) < 0)
 133             goto fail;
 134     } else if (!p->dead && pa_iochannel_is_hungup(p->io))
 135         goto fail;
 136
 137     if (!p->dead && pa_iochannel_is_writable(p->io)) {
 138         if (do_write(p) < 0)
 139             goto fail;
 140     }
 141
 142     pa_pstream_unref(p);
 143     return;
 144
 145 fail:
 146
 147     p->dead = 1;
 148
 149     if (p->die_callback)
 150         p->die_callback(p, p->die_callback_userdata);
 151
 152     pa_pstream_unref(p);
 153 }
 154
 155 static void io_callback(pa_iochannel*io, void *userdata) {
 156     pa_pstream *p = userdata;
 157
 158     assert(p);
 159     assert(p->io == io);
 160
 161     do_something(p);
 162 }
 163
 164 static void defer_callback(pa_mainloop_api *m, pa_defer_event *e, void*userdata) {
 165     pa_pstream *p = userdata;
 166
 167     assert(p);
 168     assert(p->defer_event == e);
 169     assert(p->mainloop == m);
 170
 171     do_something(p);
 172 }
 173
 174 pa_pstream *pa_pstream_new(pa_mainloop_api *m, pa_iochannel *io, pa_memblock_stat *s) {
 175     pa_pstream *p;
 176     assert(io);
 177
 178     p = pa_xnew(pa_pstream, 1);
 179
 180     p->ref = 1;
 181     p->io = io;
 182     pa_iochannel_set_callback(io, io_callback, p);
 183
 184     p->dead = 0;
 185
 186     p->mainloop = m;
 187     p->defer_event = m->defer_new(m, defer_callback, p);
 188     m->defer_enable(p->defer_event, 0);
 189
 190     p->send_queue = pa_queue_new();
 191     assert(p->send_queue);
 192
 193     p->write.current = NULL;
 194     p->write.index = 0;
 195
 196     p->read.memblock = NULL;
 197     p->read.packet = NULL;
 198     p->read.index = 0;
 199
 200     p->recieve_packet_callback = NULL;
 201     p->recieve_packet_callback_userdata = NULL;
 202
 203     p->recieve_memblock_callback = NULL;
 204     p->recieve_memblock_callback_userdata = NULL;
 205
 206     p->drain_callback = NULL;
 207     p->drain_callback_userdata = NULL;
 208
 209     p->die_callback = NULL;
 210     p->die_callback_userdata = NULL;
 211
 212     p->memblock_stat = s;
 213
 214     pa_iochannel_socket_set_rcvbuf(io, 1024*8);
 215     pa_iochannel_socket_set_sndbuf(io, 1024*8);
 216
 217 #ifdef SCM_CREDENTIALS
 218     p->send_creds_now = 0;
 219     p->creds_valid = 0;
 220 #endif
 221     return p;
 222 }
 223
 224 static void item_free(void *item, PA_GCC_UNUSED void *p) {
 225     struct item_info *i = item;
 226     assert(i);
 227
 228     if (i->type == PA_PSTREAM_ITEM_MEMBLOCK) {
 229         assert(i->chunk.memblock);
 230         pa_memblock_unref(i->chunk.memblock);
 231     } else {
 232         assert(i->type == PA_PSTREAM_ITEM_PACKET);
 233         assert(i->packet);
 234         pa_packet_unref(i->packet);
 235     }
 236
 237     pa_xfree(i);
 238 }
 239
 240 static void pstream_free(pa_pstream *p) {
 241     assert(p);
 242
 243     pa_pstream_close(p);
 244
 245     pa_queue_free(p->send_queue, item_free, NULL);
 246
 247     if (p->write.current)
 248         item_free(p->write.current, NULL);
 249
 250     if (p->read.memblock)
 251         pa_memblock_unref(p->read.memblock);
 252
 253     if (p->read.packet)
 254         pa_packet_unref(p->read.packet);
 255
 256     pa_xfree(p);
 257 }
 258
 259 void pa_pstream_send_packet(pa_pstream*p, pa_packet *packet, int with_creds) {
 260     struct item_info *i;
 261     assert(p && packet && p->ref >= 1);
 262
 263     if (p->dead)
 264         return;
 265
 266 /*     pa_log(__FILE__": push-packet %p", packet); */
 267
 268     i = pa_xnew(struct item_info, 1);
 269     i->type = PA_PSTREAM_ITEM_PACKET;
 270     i->packet = pa_packet_ref(packet);
 271 #ifdef SCM_CREDENTIALS
 272     i->with_creds = with_creds;
 273 #endif
 274
 275     pa_queue_push(p->send_queue, i);
 276     p->mainloop->defer_enable(p->defer_event, 1);
 277 }
 278
 279 void pa_pstream_send_memblock(pa_pstream*p, uint32_t channel, int64_t offset, pa_seek_mode_t seek_mode, const pa_memchunk *chunk) {
 280     struct item_info *i;
 281     assert(p && channel != (uint32_t) -1 && chunk && p->ref >= 1);
 282
 283     if (p->dead)
 284         return;
 285
 286 /*     pa_log(__FILE__": push-memblock %p", chunk); */
 287
 288     i = pa_xnew(struct item_info, 1);
 289     i->type = PA_PSTREAM_ITEM_MEMBLOCK;
 290     i->chunk = *chunk;
 291     i->channel = channel;
 292     i->offset = offset;
 293     i->seek_mode = seek_mode;
 294     i->with_creds = 0;
 295
 296     pa_memblock_ref(i->chunk.memblock);
 297
 298     pa_queue_push(p->send_queue, i);
 299     p->mainloop->defer_enable(p->defer_event, 1);
 300 }
 301
 302 static void prepare_next_write_item(pa_pstream *p) {
 303     assert(p);
 304
 305     if (!(p->write.current = pa_queue_pop(p->send_queue)))
 306         return;
 307
 308     p->write.index = 0;
 309
 310     if (p->write.current->type == PA_PSTREAM_ITEM_PACKET) {
 311         /*pa_log(__FILE__": pop-packet %p", p->write.current->packet);*/
 312
 313         assert(p->write.current->packet);
 314         p->write.data = p->write.current->packet->data;
 315         p->write.descriptor[PA_PSTREAM_DESCRIPTOR_LENGTH] = htonl(p->write.current->packet->length);
 316         p->write.descriptor[PA_PSTREAM_DESCRIPTOR_CHANNEL] = htonl((uint32_t) -1);
 317         p->write.descriptor[PA_PSTREAM_DESCRIPTOR_OFFSET_HI] = 0;
 318         p->write.descriptor[PA_PSTREAM_DESCRIPTOR_OFFSET_LO] = 0;
 319         p->write.descriptor[PA_PSTREAM_DESCRIPTOR_SEEK] = 0;
 320
 321
 322     } else {
 323         assert(p->write.current->type == PA_PSTREAM_ITEM_MEMBLOCK && p->write.current->chunk.memblock);
 324         p->write.data = (uint8_t*) p->write.current->chunk.memblock->data + p->write.current->chunk.index;
 325         p->write.descriptor[PA_PSTREAM_DESCRIPTOR_LENGTH] = htonl(p->write.current->chunk.length);
 326         p->write.descriptor[PA_PSTREAM_DESCRIPTOR_CHANNEL] = htonl(p->write.current->channel);
 327         p->write.descriptor[PA_PSTREAM_DESCRIPTOR_OFFSET_HI] = htonl((uint32_t) (((uint64_t) p->write.current->offset) >> 32));
 328         p->write.descriptor[PA_PSTREAM_DESCRIPTOR_OFFSET_LO] = htonl((uint32_t) ((uint64_t) p->write.current->offset));
 329         p->write.descriptor[PA_PSTREAM_DESCRIPTOR_SEEK] = htonl(p->write.current->seek_mode);
 330     }
 331
 332 #ifdef SCM_CREDENTIALS
 333     p->send_creds_now = p->write.current->with_creds;
 334 #endif
 335
 336 }
 337
 338 static int do_write(pa_pstream *p) {
 339     void *d;
 340     size_t l;
 341     ssize_t r;
 342     assert(p);
 343
 344     if (!p->write.current)
 345         prepare_next_write_item(p);
 346
 347     if (!p->write.current)
 348         return 0;
 349
 350     assert(p->write.data);
 351
 352     if (p->write.index < PA_PSTREAM_DESCRIPTOR_SIZE) {
 353         d = (uint8_t*) p->write.descriptor + p->write.index;
 354         l = PA_PSTREAM_DESCRIPTOR_SIZE - p->write.index;
 355     } else {
 356         d = (uint8_t*) p->write.data + p->write.index - PA_PSTREAM_DESCRIPTOR_SIZE;
 357         l = ntohl(p->write.descriptor[PA_PSTREAM_DESCRIPTOR_LENGTH]) - (p->write.index - PA_PSTREAM_DESCRIPTOR_SIZE);
 358     }
 359
 360 #ifdef SCM_CREDENTIALS
 361     if (p->send_creds_now) {
 362
 363         if ((r = pa_iochannel_write_with_creds(p->io, d, l)) < 0)
 364             return -1;
 365
 366         p->send_creds_now = 0;
 367     } else
 368 #endif
 369
 370     if ((r = pa_iochannel_write(p->io, d, l)) < 0)
 371         return -1;
 372
 373     p->write.index += r;
 374
 375     if (p->write.index >= PA_PSTREAM_DESCRIPTOR_SIZE+ntohl(p->write.descriptor[PA_PSTREAM_DESCRIPTOR_LENGTH])) {
 376         assert(p->write.current);
 377         item_free(p->write.current, (void *) 1);
 378         p->write.current = NULL;
 379
 380         if (p->drain_callback && !pa_pstream_is_pending(p))
 381             p->drain_callback(p, p->drain_callback_userdata);
 382     }
 383
 384     return 0;
 385 }
 386
 387 static int do_read(pa_pstream *p) {
 388     void *d;
 389     size_t l;
 390     ssize_t r;
 391     assert(p);
 392
 393     if (p->read.index < PA_PSTREAM_DESCRIPTOR_SIZE) {
 394         d = (uint8_t*) p->read.descriptor + p->read.index;
 395         l = PA_PSTREAM_DESCRIPTOR_SIZE - p->read.index;
 396     } else {
 397         assert(p->read.data);
 398         d = (uint8_t*) p->read.data + p->read.index - PA_PSTREAM_DESCRIPTOR_SIZE;
 399         l = ntohl(p->read.descriptor[PA_PSTREAM_DESCRIPTOR_LENGTH]) - (p->read.index - PA_PSTREAM_DESCRIPTOR_SIZE);
 400     }
 401
 402 #ifdef SCM_CREDENTIALS
 403     {
 404         int b;
 405
 406         if ((r = pa_iochannel_read_with_creds(p->io, d, l, &p->ucred, &b)) <= 0)
 407             return -1;
 408
 409         p->creds_valid = p->creds_valid || b;
 410     }
 411 #else
 412     if ((r = pa_iochannel_read(p->io, d, l)) <= 0)
 413         return -1;
 414 #endif
 415
 416     p->read.index += r;
 417
 418     if (p->read.index == PA_PSTREAM_DESCRIPTOR_SIZE) {
 419         /* Reading of frame descriptor complete */
 420
 421         /* Frame size too large */
 422         if (ntohl(p->read.descriptor[PA_PSTREAM_DESCRIPTOR_LENGTH]) > FRAME_SIZE_MAX) {
 423             pa_log_warn(__FILE__": Frame size too large: %lu > %lu", (unsigned long) ntohl(p->read.descriptor[PA_PSTREAM_DESCRIPTOR_LENGTH]), (unsigned long) FRAME_SIZE_MAX);
 424             return -1;
 425         }
 426
 427         assert(!p->read.packet && !p->read.memblock);
 428
 429         if (ntohl(p->read.descriptor[PA_PSTREAM_DESCRIPTOR_CHANNEL]) == (uint32_t) -1) {
 430             /* Frame is a packet frame */
 431             p->read.packet = pa_packet_new(ntohl(p->read.descriptor[PA_PSTREAM_DESCRIPTOR_LENGTH]));
 432             p->read.data = p->read.packet->data;
 433         } else {
 434             /* Frame is a memblock frame */
 435             p->read.memblock = pa_memblock_new(ntohl(p->read.descriptor[PA_PSTREAM_DESCRIPTOR_LENGTH]), p->memblock_stat);
 436             p->read.data = p->read.memblock->data;
 437
 438             if (ntohl(p->read.descriptor[PA_PSTREAM_DESCRIPTOR_SEEK]) > PA_SEEK_RELATIVE_END) {
 439                 pa_log_warn(__FILE__": Invalid seek mode");
 440                 return -1;
 441             }
 442         }
 443
 444     } else if (p->read.index > PA_PSTREAM_DESCRIPTOR_SIZE) {
 445         /* Frame payload available */
 446
 447         if (p->read.memblock && p->recieve_memblock_callback) { /* Is this memblock data? Than pass it to the user */
 448             l = (p->read.index - r) < PA_PSTREAM_DESCRIPTOR_SIZE ? p->read.index - PA_PSTREAM_DESCRIPTOR_SIZE : (size_t) r;
 449
 450             if (l > 0) {
 451                 pa_memchunk chunk;
 452
 453                 chunk.memblock = p->read.memblock;
 454                 chunk.index = p->read.index - PA_PSTREAM_DESCRIPTOR_SIZE - l;
 455                 chunk.length = l;
 456
 457                 if (p->recieve_memblock_callback) {
 458                     int64_t offset;
 459
 460                     offset = (int64_t) (
 461                             (((uint64_t) ntohl(p->read.descriptor[PA_PSTREAM_DESCRIPTOR_OFFSET_HI])) << 32) |
 462                             (((uint64_t) ntohl(p->read.descriptor[PA_PSTREAM_DESCRIPTOR_OFFSET_LO]))));
 463
 464                     p->recieve_memblock_callback(
 465                         p,
 466                         ntohl(p->read.descriptor[PA_PSTREAM_DESCRIPTOR_CHANNEL]),
 467                         offset,
 468                         ntohl(p->read.descriptor[PA_PSTREAM_DESCRIPTOR_SEEK]),
 469                         &chunk,
 470                         p->recieve_memblock_callback_userdata);
 471                 }
 472
 473                 /* Drop seek info for following callbacks */
 474                 p->read.descriptor[PA_PSTREAM_DESCRIPTOR_SEEK] =
 475                     p->read.descriptor[PA_PSTREAM_DESCRIPTOR_OFFSET_HI] =
 476                     p->read.descriptor[PA_PSTREAM_DESCRIPTOR_OFFSET_LO] = 0;
 477             }
 478         }
 479
 480         /* Frame complete */
 481         if (p->read.index >= ntohl(p->read.descriptor[PA_PSTREAM_DESCRIPTOR_LENGTH]) + PA_PSTREAM_DESCRIPTOR_SIZE) {
 482             if (p->read.memblock) {
 483                 assert(!p->read.packet);
 484
 485                 pa_memblock_unref(p->read.memblock);
 486                 p->read.memblock = NULL;
 487             } else {
 488                 assert(p->read.packet);
 489
 490                 if (p->recieve_packet_callback)
 491 #ifdef SCM_CREDENTIALS
 492                     p->recieve_packet_callback(p, p->read.packet, p->creds_valid ? &p->ucred : NULL, p->recieve_packet_callback_userdata);
 493 #else
 494                     p->recieve_packet_callback(p, p->read.packet, NULL, p->recieve_packet_callback_userdata);
 495 #endif
 496
 497                 pa_packet_unref(p->read.packet);
 498                 p->read.packet = NULL;
 499             }
 500
 501             p->read.index = 0;
 502 #ifdef SCM_CREDENTIALS
 503             p->creds_valid = 0;
 504 #endif
 505         }
 506     }
 507
 508     return 0;
 509 }
 510
 511 void pa_pstream_set_die_callback(pa_pstream *p, pa_pstream_notify_cb_t cb, void *userdata) {
 512     assert(p);
 513     assert(p->ref >= 1);
 514
 515     p->die_callback = cb;
 516     p->die_callback_userdata = userdata;
 517 }
 518
 519
 520 void pa_pstream_set_drain_callback(pa_pstream *p, pa_pstream_notify_cb_t cb, void *userdata) {
 521     assert(p);
 522     assert(p->ref >= 1);
 523
 524     p->drain_callback = cb;
 525     p->drain_callback_userdata = userdata;
 526 }
 527
 528 void pa_pstream_set_recieve_packet_callback(pa_pstream *p, pa_pstream_packet_cb_t cb, void *userdata) {
 529     assert(p);
 530     assert(p->ref >= 1);
 531
 532     p->recieve_packet_callback = cb;
 533     p->recieve_packet_callback_userdata = userdata;
 534 }
 535
 536 void pa_pstream_set_recieve_memblock_callback(pa_pstream *p, pa_pstream_memblock_cb_t cb, void *userdata) {
 537     assert(p);
 538     assert(p->ref >= 1);
 539
 540     p->recieve_memblock_callback = cb;
 541     p->recieve_memblock_callback_userdata = userdata;
 542 }
 543
 544 int pa_pstream_is_pending(pa_pstream *p) {
 545     assert(p);
 546
 547     if (p->dead)
 548         return 0;
 549
 550     return p->write.current || !pa_queue_is_empty(p->send_queue);
 551 }
 552
 553 void pa_pstream_unref(pa_pstream*p) {
 554     assert(p);
 555     assert(p->ref >= 1);
 556
 557     if (--p->ref == 0)
 558         pstream_free(p);
 559 }
 560
 561 pa_pstream* pa_pstream_ref(pa_pstream*p) {
 562     assert(p);
 563     assert(p->ref >= 1);
 564
 565     p->ref++;
 566     return p;
 567 }
 568
 569 void pa_pstream_close(pa_pstream *p) {
 570     assert(p);
 571
 572     p->dead = 1;
 573
 574     if (p->io) {
 575         pa_iochannel_free(p->io);
 576         p->io = NULL;
 577     }
 578
 579     if (p->defer_event) {
 580         p->mainloop->defer_free(p->defer_event);
 581         p->defer_event = NULL;
 582     }
 583
 584     p->die_callback = NULL;
 585     p->drain_callback = NULL;
 586     p->recieve_packet_callback = NULL;
 587     p->recieve_memblock_callback = NULL;
 588 }