code.delx.au - pulseaudio/blob - src/pulsecore/sink-input.h

   1 #ifndef foopulsesinkinputhfoo
   2 #define foopulsesinkinputhfoo
   3
   4 /***
   5   This file is part of PulseAudio.
   6
   7   Copyright 2004-2006 Lennart Poettering
   8   Copyright 2006 Pierre Ossman <ossman@cendio.se> for Cendio AB
   9
  10   PulseAudio is free software; you can redistribute it and/or modify
  11   it under the terms of the GNU Lesser General Public License as published
  12   by the Free Software Foundation; either version 2 of the License,
  13   or (at your option) any later version.
  14
  15   PulseAudio is distributed in the hope that it will be useful, but
  16   WITHOUT ANY WARRANTY; without even the implied warranty of
  17   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  18   General Public License for more details.
  19
  20   You should have received a copy of the GNU Lesser General Public License
  21   along with PulseAudio; if not, write to the Free Software
  22   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  23   USA.
  24 ***/
  25
  26 #include <inttypes.h>
  27
  28 typedef struct pa_sink_input pa_sink_input;
  29
  30 #include <pulse/sample.h>
  31 #include <pulsecore/hook-list.h>
  32 #include <pulsecore/memblockq.h>
  33 #include <pulsecore/resampler.h>
  34 #include <pulsecore/module.h>
  35 #include <pulsecore/client.h>
  36 #include <pulsecore/sink.h>
  37 #include <pulsecore/core.h>
  38
  39 typedef enum pa_sink_input_state {
  40     PA_SINK_INPUT_INIT,         /*< The stream is not active yet, because pa_sink_put() has not been called yet */
  41     PA_SINK_INPUT_DRAINED,      /*< The stream stopped playing because there was no data to play */
  42     PA_SINK_INPUT_RUNNING,      /*< The stream is alive and kicking */
  43     PA_SINK_INPUT_CORKED,       /*< The stream was corked on user request */
  44     PA_SINK_INPUT_UNLINKED      /*< The stream is dead */
  45 } pa_sink_input_state_t;
  46
  47 static inline pa_bool_t PA_SINK_INPUT_IS_LINKED(pa_sink_input_state_t x) {
  48     return x == PA_SINK_INPUT_DRAINED || x == PA_SINK_INPUT_RUNNING || x == PA_SINK_INPUT_CORKED;
  49 }
  50
  51 typedef enum pa_sink_input_flags {
  52     PA_SINK_INPUT_VARIABLE_RATE = 1,
  53     PA_SINK_INPUT_DONT_MOVE = 2,
  54     PA_SINK_INPUT_START_CORKED = 4,
  55     PA_SINK_INPUT_NO_REMAP = 8,
  56     PA_SINK_INPUT_NO_REMIX = 16,
  57     PA_SINK_INPUT_FIX_FORMAT = 32,
  58     PA_SINK_INPUT_FIX_RATE = 64,
  59     PA_SINK_INPUT_FIX_CHANNELS = 128
  60 } pa_sink_input_flags_t;
  61
  62 struct pa_sink_input {
  63     pa_msgobject parent;
  64
  65     uint32_t index;
  66     pa_core *core;
  67
  68     /* Please note that this state should only be read with
  69      * pa_sink_input_get_state(). That function will transparently
  70      * merge the thread_info.drained value in. */
  71     pa_sink_input_state_t state;
  72     pa_sink_input_flags_t flags;
  73
  74     char *driver;                       /* may be NULL */
  75     pa_proplist *proplist;
  76
  77     pa_module *module;                  /* may be NULL */
  78     pa_client *client;                  /* may be NULL */
  79
  80     pa_sink *sink;
  81
  82     /* A sink input may be connected to multiple source outputs
  83      * directly, so that they don't get mixed data of the entire
  84      * source. */
  85     pa_idxset *direct_outputs;
  86
  87     pa_sample_spec sample_spec;
  88     pa_channel_map channel_map;
  89
  90     pa_sink_input *sync_prev, *sync_next;
  91
  92     pa_cvolume volume;
  93     pa_bool_t muted;
  94
  95     pa_resample_method_t resample_method;
  96
  97     /* Returns the chunk of audio data and drops it from the
  98      * queue. Returns -1 on failure. Called from IO thread context. If
  99      * data needs to be generated from scratch then please in the
 100      * specified length request_nbytes. This is an optimization
 101      * only. If less data is available, it's fine to return a smaller
 102      * block. If more data is already ready, it is better to return
 103      * the full block. */
 104     int (*pop) (pa_sink_input *i, size_t request_nbytes, pa_memchunk *chunk); /* may NOT be NULL */
 105
 106     /* Rewind the queue by the specified number of bytes. Called just
 107      * before peek() if it is called at all. Only called if the sink
 108      * input driver ever plans to call
 109      * pa_sink_input_request_rewind(). Called from IO context. */
 110     void (*process_rewind) (pa_sink_input *i, size_t nbytes);     /* may NOT be NULL */
 111
 112     /* Called whenever the maximum rewindable size of the sink
 113      * changes. Called from IO context. */
 114     void (*update_max_rewind) (pa_sink_input *i, size_t nbytes); /* may be NULL */
 115
 116     /* Called whenever the maxiumum request size of the sink
 117      * changes. Called from IO context. */
 118     void (*update_max_request) (pa_sink_input *i, size_t nbytes); /* may be NULL */
 119
 120     /* Called whenever the configured latency of the sink
 121      * changes. Called from IO context. */
 122     void (*update_sink_requested_latency) (pa_sink_input *i); /* may be NULL */
 123
 124     /* Called whenver the latency range of the sink changes. Called
 125      * from IO context. */
 126     void (*update_sink_latency_range) (pa_sink_input *i); /* may be NULL */
 127
 128     /* If non-NULL this function is called when the input is first
 129      * connected to a sink or when the rtpoll/asyncmsgq fields
 130      * change. You usually don't need to implement this function
 131      * unless you rewrite a sink that is piggy-backed onto
 132      * another. Called from IO thread context */
 133     void (*attach) (pa_sink_input *i);           /* may be NULL */
 134
 135     /* If non-NULL this function is called when the output is
 136      * disconnected from its sink. Called from IO thread context */
 137     void (*detach) (pa_sink_input *i);           /* may be NULL */
 138
 139     /* If non-NULL called whenever the the sink this input is attached
 140      * to suspends or resumes. Called from main context */
 141     void (*suspend) (pa_sink_input *i, pa_bool_t b);   /* may be NULL */
 142
 143     /* If non-NULL called whenever the the sink this input is attached
 144      * to changes. Called from main context */
 145     void (*moved) (pa_sink_input *i);   /* may be NULL */
 146
 147     /* Supposed to unlink and destroy this stream. Called from main
 148      * context. */
 149     void (*kill) (pa_sink_input *i);             /* may NOT be NULL */
 150
 151     /* Return the current latency (i.e. length of bufferd audio) of
 152     this stream. Called from main context. This is added to what the
 153     PA_SINK_INPUT_MESSAGE_GET_LATENCY message sent to the IO thread
 154     returns */
 155     pa_usec_t (*get_latency) (pa_sink_input *i); /* may be NULL */
 156
 157     /* If non_NULL this function is called from thread context if the
 158      * state changes. The old state is found in thread_info.state.  */
 159     void (*state_change) (pa_sink_input *i, pa_sink_input_state_t state); /* may be NULL */
 160
 161     struct {
 162         pa_sink_input_state_t state;
 163         pa_atomic_t drained;
 164
 165         pa_bool_t attached; /* True only between ->attach() and ->detach() calls */
 166
 167         pa_sample_spec sample_spec;
 168
 169         pa_resampler *resampler;                     /* may be NULL */
 170
 171         /* We maintain a history of resampled audio data here. */
 172         pa_memblockq *render_memblockq;
 173
 174         size_t rewrite_nbytes;
 175         pa_bool_t rewrite_flush;
 176         uint64_t underrun_for, playing_for;
 177
 178         pa_sink_input *sync_prev, *sync_next;
 179
 180         pa_cvolume volume;
 181         pa_bool_t muted;
 182
 183         /* The requested latency for the sink */
 184         pa_usec_t requested_sink_latency;
 185
 186         pa_hashmap *direct_outputs;
 187     } thread_info;
 188
 189     void *userdata;
 190 };
 191
 192 PA_DECLARE_CLASS(pa_sink_input);
 193 #define PA_SINK_INPUT(o) pa_sink_input_cast(o)
 194
 195 enum {
 196     PA_SINK_INPUT_MESSAGE_SET_VOLUME,
 197     PA_SINK_INPUT_MESSAGE_SET_MUTE,
 198     PA_SINK_INPUT_MESSAGE_GET_LATENCY,
 199     PA_SINK_INPUT_MESSAGE_SET_RATE,
 200     PA_SINK_INPUT_MESSAGE_SET_STATE,
 201     PA_SINK_INPUT_MESSAGE_SET_REQUESTED_LATENCY,
 202     PA_SINK_INPUT_MESSAGE_GET_REQUESTED_LATENCY,
 203     PA_SINK_INPUT_MESSAGE_MAX
 204 };
 205
 206 typedef struct pa_sink_input_new_data {
 207     pa_proplist *proplist;
 208
 209     const char *driver;
 210     pa_module *module;
 211     pa_client *client;
 212
 213     pa_sink *sink;
 214
 215     pa_sample_spec sample_spec;
 216     pa_bool_t sample_spec_is_set;
 217     pa_channel_map channel_map;
 218     pa_bool_t channel_map_is_set;
 219
 220     pa_cvolume volume;
 221     pa_bool_t volume_is_set;
 222     pa_bool_t muted;
 223     pa_bool_t muted_is_set;
 224
 225     pa_resample_method_t resample_method;
 226
 227     pa_sink_input *sync_base;
 228 } pa_sink_input_new_data;
 229
 230 pa_sink_input_new_data* pa_sink_input_new_data_init(pa_sink_input_new_data *data);
 231 void pa_sink_input_new_data_set_sample_spec(pa_sink_input_new_data *data, const pa_sample_spec *spec);
 232 void pa_sink_input_new_data_set_channel_map(pa_sink_input_new_data *data, const pa_channel_map *map);
 233 void pa_sink_input_new_data_set_volume(pa_sink_input_new_data *data, const pa_cvolume *volume);
 234 void pa_sink_input_new_data_set_muted(pa_sink_input_new_data *data, pa_bool_t mute);
 235 void pa_sink_input_new_data_done(pa_sink_input_new_data *data);
 236
 237 typedef struct pa_sink_input_move_hook_data {
 238     pa_sink_input *sink_input;
 239     pa_sink *destination;
 240 } pa_sink_input_move_hook_data;
 241
 242 /* To be called by the implementing module only */
 243
 244 pa_sink_input* pa_sink_input_new(
 245         pa_core *core,
 246         pa_sink_input_new_data *data,
 247         pa_sink_input_flags_t flags);
 248
 249 void pa_sink_input_put(pa_sink_input *i);
 250 void pa_sink_input_unlink(pa_sink_input* i);
 251
 252 void pa_sink_input_set_name(pa_sink_input *i, const char *name);
 253
 254 pa_usec_t pa_sink_input_set_requested_latency(pa_sink_input *i, pa_usec_t usec);
 255
 256 /* Request that the specified number of bytes already written out to
 257 the hw device is rewritten, if possible.  Please note that this is
 258 only a kind request. The sink driver may not be able to fulfill it
 259 fully -- or at all. If the request for a rewrite was successful, the
 260 sink driver will call ->rewind() and pass the number of bytes that
 261 could be rewound in the HW device. This functionality is required for
 262 implementing the "zero latency" write-through functionality. */
 263 void pa_sink_input_request_rewind(pa_sink_input *i, size_t nbytes, pa_bool_t rewrite, pa_bool_t flush);
 264
 265 void pa_sink_input_cork(pa_sink_input *i, pa_bool_t b);
 266
 267 int pa_sink_input_set_rate(pa_sink_input *i, uint32_t rate);
 268
 269 /* Callable by everyone from main thread*/
 270
 271 /* External code may request disconnection with this function */
 272 void pa_sink_input_kill(pa_sink_input*i);
 273
 274 pa_usec_t pa_sink_input_get_latency(pa_sink_input *i, pa_usec_t *sink_latency);
 275
 276 void pa_sink_input_set_volume(pa_sink_input *i, const pa_cvolume *volume);
 277 const pa_cvolume *pa_sink_input_get_volume(pa_sink_input *i);
 278 void pa_sink_input_set_mute(pa_sink_input *i, pa_bool_t mute);
 279 pa_bool_t pa_sink_input_get_mute(pa_sink_input *i);
 280
 281 pa_resample_method_t pa_sink_input_get_resample_method(pa_sink_input *i);
 282
 283 int pa_sink_input_move_to(pa_sink_input *i, pa_sink *dest);
 284
 285 pa_sink_input_state_t pa_sink_input_get_state(pa_sink_input *i);
 286
 287 pa_usec_t pa_sink_input_get_requested_latency(pa_sink_input *i);
 288
 289 /* To be used exclusively by the sink driver IO thread */
 290
 291 int pa_sink_input_peek(pa_sink_input *i, size_t length, pa_memchunk *chunk, pa_cvolume *volume);
 292 void pa_sink_input_drop(pa_sink_input *i, size_t length);
 293 void pa_sink_input_process_rewind(pa_sink_input *i, size_t nbytes /* in the sink's sample spec */);
 294 void pa_sink_input_update_max_rewind(pa_sink_input *i, size_t nbytes  /* in the sink's sample spec */);
 295 void pa_sink_input_update_max_request(pa_sink_input *i, size_t nbytes  /* in the sink's sample spec */);
 296
 297 void pa_sink_input_set_state_within_thread(pa_sink_input *i, pa_sink_input_state_t state);
 298
 299 int pa_sink_input_process_msg(pa_msgobject *o, int code, void *userdata, int64_t offset, pa_memchunk *chunk);
 300
 301 pa_usec_t pa_sink_input_set_requested_latency_within_thread(pa_sink_input *i, pa_usec_t usec);
 302
 303 pa_bool_t pa_sink_input_safe_to_remove(pa_sink_input *i);
 304
 305 pa_memchunk* pa_sink_input_get_silence(pa_sink_input *i, pa_memchunk *ret);
 306
 307 #endif