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_DECLARE_CLASS(memblockq_stream);
  51 #define MEMBLOCKQ_STREAM(o) (memblockq_stream_cast(o))
  52 static PA_DEFINE_CHECK_TYPE(memblockq_stream, pa_msgobject);
  53
  54 static void memblockq_stream_unlink(memblockq_stream *u) {
  55     pa_assert(u);
  56
  57     if (!u->sink_input)
  58         return;
  59
  60     pa_sink_input_unlink(u->sink_input);
  61     pa_sink_input_unref(u->sink_input);
  62     u->sink_input = NULL;
  63
  64     memblockq_stream_unref(u);
  65 }
  66
  67 static void memblockq_stream_free(pa_object *o) {
  68     memblockq_stream *u = MEMBLOCKQ_STREAM(o);
  69     pa_assert(u);
  70
  71     if (u->memblockq)
  72         pa_memblockq_free(u->memblockq);
  73
  74     pa_xfree(u);
  75 }
  76
  77 static int memblockq_stream_process_msg(pa_msgobject *o, int code, void*userdata, int64_t offset, pa_memchunk *chunk) {
  78     memblockq_stream *u = MEMBLOCKQ_STREAM(o);
  79     memblockq_stream_assert_ref(u);
  80
  81     switch (code) {
  82         case MEMBLOCKQ_STREAM_MESSAGE_UNLINK:
  83             memblockq_stream_unlink(u);
  84             break;
  85     }
  86
  87     return 0;
  88 }
  89
  90 static void sink_input_kill_cb(pa_sink_input *i) {
  91     memblockq_stream *u;
  92
  93     pa_sink_input_assert_ref(i);
  94     u = MEMBLOCKQ_STREAM(i->userdata);
  95     memblockq_stream_assert_ref(u);
  96
  97     memblockq_stream_unlink(u);
  98 }
  99
 100 /* Called from IO thread context */
 101 static void sink_input_state_change_cb(pa_sink_input *i, pa_sink_input_state_t state) {
 102     memblockq_stream *u;
 103
 104     pa_sink_input_assert_ref(i);
 105     u = MEMBLOCKQ_STREAM(i->userdata);
 106     memblockq_stream_assert_ref(u);
 107
 108     /* If we are added for the first time, ask for a rewinding so that
 109      * we are heard right-away. */
 110     if (PA_SINK_INPUT_IS_LINKED(state) &&
 111         i->thread_info.state == PA_SINK_INPUT_INIT)
 112         pa_sink_input_request_rewind(i, 0, FALSE, TRUE, TRUE);
 113 }
 114
 115 static int sink_input_pop_cb(pa_sink_input *i, size_t nbytes, pa_memchunk *chunk) {
 116     memblockq_stream *u;
 117
 118     pa_sink_input_assert_ref(i);
 119     pa_assert(chunk);
 120     u = MEMBLOCKQ_STREAM(i->userdata);
 121     memblockq_stream_assert_ref(u);
 122
 123     if (!u->memblockq)
 124         return -1;
 125
 126     if (pa_memblockq_peek(u->memblockq, chunk) < 0) {
 127
 128         if (pa_sink_input_safe_to_remove(i)) {
 129
 130             pa_memblockq_free(u->memblockq);
 131             u->memblockq = NULL;
 132
 133             pa_asyncmsgq_post(pa_thread_mq_get()->outq, PA_MSGOBJECT(u), MEMBLOCKQ_STREAM_MESSAGE_UNLINK, NULL, 0, NULL, NULL);
 134         }
 135
 136         return -1;
 137     }
 138
 139     chunk->length = PA_MIN(chunk->length, nbytes);
 140     pa_memblockq_drop(u->memblockq, chunk->length);
 141
 142     return 0;
 143 }
 144
 145 static void sink_input_process_rewind_cb(pa_sink_input *i, size_t nbytes) {
 146     memblockq_stream *u;
 147
 148     pa_sink_input_assert_ref(i);
 149     u = MEMBLOCKQ_STREAM(i->userdata);
 150     memblockq_stream_assert_ref(u);
 151
 152     if (!u->memblockq)
 153         return;
 154
 155     pa_memblockq_rewind(u->memblockq, nbytes);
 156 }
 157
 158 static void sink_input_update_max_rewind_cb(pa_sink_input *i, size_t nbytes) {
 159     memblockq_stream *u;
 160
 161     pa_sink_input_assert_ref(i);
 162     u = MEMBLOCKQ_STREAM(i->userdata);
 163     memblockq_stream_assert_ref(u);
 164
 165     if (!u->memblockq)
 166         return;
 167
 168     pa_memblockq_set_maxrewind(u->memblockq, nbytes);
 169 }
 170
 171 pa_sink_input* pa_memblockq_sink_input_new(
 172         pa_sink *sink,
 173         const pa_sample_spec *ss,
 174         const pa_channel_map *map,
 175         pa_memblockq *q,
 176         pa_cvolume *volume,
 177         pa_proplist *p) {
 178
 179     memblockq_stream *u = NULL;
 180     pa_sink_input_new_data data;
 181
 182     pa_assert(sink);
 183     pa_assert(ss);
 184
 185     /* We allow creating this stream with no q set, so that it can be
 186      * filled in later */
 187
 188     u = pa_msgobject_new(memblockq_stream);
 189     u->parent.parent.free = memblockq_stream_free;
 190     u->parent.process_msg = memblockq_stream_process_msg;
 191     u->core = sink->core;
 192     u->sink_input = NULL;
 193     u->memblockq = NULL;
 194
 195     pa_sink_input_new_data_init(&data);
 196     data.sink = sink;
 197     data.driver = __FILE__;
 198     pa_sink_input_new_data_set_sample_spec(&data, ss);
 199     pa_sink_input_new_data_set_channel_map(&data, map);
 200     pa_sink_input_new_data_set_volume(&data, volume);
 201     pa_proplist_update(data.proplist, PA_UPDATE_REPLACE, p);
 202
 203     pa_sink_input_new(&u->sink_input, sink->core, &data, 0);
 204     pa_sink_input_new_data_done(&data);
 205
 206     if (!u->sink_input)
 207         goto fail;
 208
 209     u->sink_input->pop = sink_input_pop_cb;
 210     u->sink_input->process_rewind = sink_input_process_rewind_cb;
 211     u->sink_input->update_max_rewind = sink_input_update_max_rewind_cb;
 212     u->sink_input->kill = sink_input_kill_cb;
 213     u->sink_input->state_change = sink_input_state_change_cb;
 214     u->sink_input->userdata = u;
 215
 216     if (q)
 217         pa_memblockq_sink_input_set_queue(u->sink_input, q);
 218
 219     /* The reference to u is dangling here, because we want
 220      * to keep this stream around until it is fully played. */
 221
 222     /* This sink input is not "put" yet, i.e. pa_sink_input_put() has
 223      * not been called! */
 224
 225     return pa_sink_input_ref(u->sink_input);
 226
 227 fail:
 228     if (u)
 229         memblockq_stream_unref(u);
 230
 231     return NULL;
 232 }
 233
 234 int pa_play_memblockq(
 235         pa_sink *sink,
 236         const pa_sample_spec *ss,
 237         const pa_channel_map *map,
 238         pa_memblockq *q,
 239         pa_cvolume *volume,
 240         pa_proplist *p,
 241         uint32_t *sink_input_index) {
 242
 243     pa_sink_input *i;
 244
 245     pa_assert(sink);
 246     pa_assert(ss);
 247     pa_assert(q);
 248
 249     if (!(i = pa_memblockq_sink_input_new(sink, ss, map, q, volume, p)))
 250         return -1;
 251
 252     pa_sink_input_put(i);
 253
 254     if (sink_input_index)
 255         *sink_input_index = i->index;
 256
 257     pa_sink_input_unref(i);
 258
 259     return 0;
 260 }
 261
 262 void pa_memblockq_sink_input_set_queue(pa_sink_input *i, pa_memblockq *q) {
 263     memblockq_stream *u;
 264
 265     pa_sink_input_assert_ref(i);
 266     u = MEMBLOCKQ_STREAM(i->userdata);
 267     memblockq_stream_assert_ref(u);
 268
 269     if (u->memblockq)
 270         pa_memblockq_free(u->memblockq);
 271
 272     if ((u->memblockq = q)) {
 273         pa_memblockq_set_prebuf(q, 0);
 274         pa_memblockq_set_silence(q, NULL);
 275         pa_memblockq_willneed(q);
 276     }
 277 }