src/pulsecore/play-memblockq.c

   1 /***
   2   This file is part of PulseAudio.
   3
   4   Copyright 2006-2008 Lennart Poettering
   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 published
   8   by the Free Software Foundation; either version 2.1 of the License,
   9   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   General Public License for more details.
  15
  16   You should have received a copy of the GNU Lesser General Public License
  17   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 <stdlib.h>
  27 #include <stdio.h>
  28 #include <string.h>
  29
  30 #include <pulse/xmalloc.h>
  31 #include <pulse/gccmacro.h>
  32
  33 #include <pulsecore/sink-input.h>
  34 #include <pulsecore/thread-mq.h>
  35 #include <pulsecore/sample-util.h>
  36
  37 #include "play-memblockq.h"
  38
  39 typedef struct memblockq_stream {
  40     pa_msgobject parent;
  41     pa_core *core;
  42     pa_sink_input *sink_input;
  43     pa_memblockq *memblockq;
  44 } memblockq_stream;
  45
  46 enum {
  47     MEMBLOCKQ_STREAM_MESSAGE_UNLINK,
  48 };
  49
  50 PA_DEFINE_PRIVATE_CLASS(memblockq_stream, pa_msgobject);
  51 #define MEMBLOCKQ_STREAM(o) (memblockq_stream_cast(o))
  52
  53 static void memblockq_stream_unlink(memblockq_stream *u) {
  54     pa_assert(u);
  55
  56     if (!u->sink_input)
  57         return;
  58
  59     pa_sink_input_unlink(u->sink_input);
  60     pa_sink_input_unref(u->sink_input);
  61     u->sink_input = NULL;
  62
  63     memblockq_stream_unref(u);
  64 }
  65
  66 static void memblockq_stream_free(pa_object *o) {
  67     memblockq_stream *u = MEMBLOCKQ_STREAM(o);
  68     pa_assert(u);
  69
  70     if (u->memblockq)
  71         pa_memblockq_free(u->memblockq);
  72
  73     pa_xfree(u);
  74 }
  75
  76 static int memblockq_stream_process_msg(pa_msgobject *o, int code, void*userdata, int64_t offset, pa_memchunk *chunk) {
  77     memblockq_stream *u = MEMBLOCKQ_STREAM(o);
  78     memblockq_stream_assert_ref(u);
  79
  80     switch (code) {
  81         case MEMBLOCKQ_STREAM_MESSAGE_UNLINK:
  82             memblockq_stream_unlink(u);
  83             break;
  84     }
  85
  86     return 0;
  87 }
  88
  89 static void sink_input_kill_cb(pa_sink_input *i) {
  90     memblockq_stream *u;
  91
  92     pa_sink_input_assert_ref(i);
  93     u = MEMBLOCKQ_STREAM(i->userdata);
  94     memblockq_stream_assert_ref(u);
  95
  96     memblockq_stream_unlink(u);
  97 }
  98
  99 /* Called from IO thread context */
 100 static void sink_input_state_change_cb(pa_sink_input *i, pa_sink_input_state_t state) {
 101     memblockq_stream *u;
 102
 103     pa_sink_input_assert_ref(i);
 104     u = MEMBLOCKQ_STREAM(i->userdata);
 105     memblockq_stream_assert_ref(u);
 106
 107     /* If we are added for the first time, ask for a rewinding so that
 108      * we are heard right-away. */
 109     if (PA_SINK_INPUT_IS_LINKED(state) &&
 110         i->thread_info.state == PA_SINK_INPUT_INIT)
 111         pa_sink_input_request_rewind(i, 0, FALSE, TRUE, TRUE);
 112 }
 113
 114 static int sink_input_pop_cb(pa_sink_input *i, size_t nbytes, pa_memchunk *chunk) {
 115     memblockq_stream *u;
 116
 117     pa_sink_input_assert_ref(i);
 118     pa_assert(chunk);
 119     u = MEMBLOCKQ_STREAM(i->userdata);
 120     memblockq_stream_assert_ref(u);
 121
 122     if (!u->memblockq)
 123         return -1;
 124
 125     if (pa_memblockq_peek(u->memblockq, chunk) < 0) {
 126
 127         if (pa_sink_input_safe_to_remove(i)) {
 128
 129             pa_memblockq_free(u->memblockq);
 130             u->memblockq = NULL;
 131
 132             pa_asyncmsgq_post(pa_thread_mq_get()->outq, PA_MSGOBJECT(u), MEMBLOCKQ_STREAM_MESSAGE_UNLINK, NULL, 0, NULL, NULL);
 133         }
 134
 135         return -1;
 136     }
 137
 138     /* FIXME: u->memblockq doesn't have a silence memchunk set, so
 139      * pa_memblockq_peek() will return 0 without returning any memblock if the
 140      * read index points to a hole. If the memblockq is rewound beyond index 0,
 141      * then there will be a hole. */
 142     pa_assert(chunk->memblock);
 143
 144     chunk->length = PA_MIN(chunk->length, nbytes);
 145     pa_memblockq_drop(u->memblockq, chunk->length);
 146
 147     return 0;
 148 }
 149
 150 static void sink_input_process_rewind_cb(pa_sink_input *i, size_t nbytes) {
 151     memblockq_stream *u;
 152
 153     pa_sink_input_assert_ref(i);
 154     u = MEMBLOCKQ_STREAM(i->userdata);
 155     memblockq_stream_assert_ref(u);
 156
 157     if (!u->memblockq)
 158         return;
 159
 160     pa_memblockq_rewind(u->memblockq, nbytes);
 161 }
 162
 163 static void sink_input_update_max_rewind_cb(pa_sink_input *i, size_t nbytes) {
 164     memblockq_stream *u;
 165
 166     pa_sink_input_assert_ref(i);
 167     u = MEMBLOCKQ_STREAM(i->userdata);
 168     memblockq_stream_assert_ref(u);
 169
 170     if (!u->memblockq)
 171         return;
 172
 173     pa_memblockq_set_maxrewind(u->memblockq, nbytes);
 174 }
 175
 176 pa_sink_input* pa_memblockq_sink_input_new(
 177         pa_sink *sink,
 178         const pa_sample_spec *ss,
 179         const pa_channel_map *map,
 180         pa_memblockq *q,
 181         pa_cvolume *volume,
 182         pa_proplist *p,
 183         pa_sink_input_flags_t flags) {
 184
 185     memblockq_stream *u = NULL;
 186     pa_sink_input_new_data data;
 187
 188     pa_assert(sink);
 189     pa_assert(ss);
 190
 191     /* We allow creating this stream with no q set, so that it can be
 192      * filled in later */
 193
 194     u = pa_msgobject_new(memblockq_stream);
 195     u->parent.parent.free = memblockq_stream_free;
 196     u->parent.process_msg = memblockq_stream_process_msg;
 197     u->core = sink->core;
 198     u->sink_input = NULL;
 199     u->memblockq = NULL;
 200
 201     pa_sink_input_new_data_init(&data);
 202     data.sink = sink;
 203     data.driver = __FILE__;
 204     pa_sink_input_new_data_set_sample_spec(&data, ss);
 205     pa_sink_input_new_data_set_channel_map(&data, map);
 206     pa_sink_input_new_data_set_volume(&data, volume);
 207     pa_proplist_update(data.proplist, PA_UPDATE_REPLACE, p);
 208     data.flags |= flags;
 209
 210     pa_sink_input_new(&u->sink_input, sink->core, &data);
 211     pa_sink_input_new_data_done(&data);
 212
 213     if (!u->sink_input)
 214         goto fail;
 215
 216     u->sink_input->pop = sink_input_pop_cb;
 217     u->sink_input->process_rewind = sink_input_process_rewind_cb;
 218     u->sink_input->update_max_rewind = sink_input_update_max_rewind_cb;
 219     u->sink_input->kill = sink_input_kill_cb;
 220     u->sink_input->state_change = sink_input_state_change_cb;
 221     u->sink_input->userdata = u;
 222
 223     if (q)
 224         pa_memblockq_sink_input_set_queue(u->sink_input, q);
 225
 226     /* The reference to u is dangling here, because we want
 227      * to keep this stream around until it is fully played. */
 228
 229     /* This sink input is not "put" yet, i.e. pa_sink_input_put() has
 230      * not been called! */
 231
 232     return pa_sink_input_ref(u->sink_input);
 233
 234 fail:
 235     if (u)
 236         memblockq_stream_unref(u);
 237
 238     return NULL;
 239 }
 240
 241 int pa_play_memblockq(
 242         pa_sink *sink,
 243         const pa_sample_spec *ss,
 244         const pa_channel_map *map,
 245         pa_memblockq *q,
 246         pa_cvolume *volume,
 247         pa_proplist *p,
 248         pa_sink_input_flags_t flags,
 249         uint32_t *sink_input_index) {
 250
 251     pa_sink_input *i;
 252
 253     pa_assert(sink);
 254     pa_assert(ss);
 255     pa_assert(q);
 256
 257     if (!(i = pa_memblockq_sink_input_new(sink, ss, map, q, volume, p, flags)))
 258         return -1;
 259
 260     pa_sink_input_put(i);
 261
 262     if (sink_input_index)
 263         *sink_input_index = i->index;
 264
 265     pa_sink_input_unref(i);
 266
 267     return 0;
 268 }
 269
 270 void pa_memblockq_sink_input_set_queue(pa_sink_input *i, pa_memblockq *q) {
 271     memblockq_stream *u;
 272
 273     pa_sink_input_assert_ref(i);
 274     u = MEMBLOCKQ_STREAM(i->userdata);
 275     memblockq_stream_assert_ref(u);
 276
 277     if (u->memblockq)
 278         pa_memblockq_free(u->memblockq);
 279
 280     if ((u->memblockq = q)) {
 281         pa_memblockq_set_prebuf(q, 0);
 282         pa_memblockq_set_silence(q, NULL);
 283         pa_memblockq_willneed(q);
 284     }
 285 }