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 virtual_volume;
  93
  94     pa_cvolume volume;
  95     pa_bool_t muted;
  96
  97     pa_resample_method_t resample_method;
  98
  99     /* Returns the chunk of audio data and drops it from the
 100      * queue. Returns -1 on failure. Called from IO thread context. If
 101      * data needs to be generated from scratch then please in the
 102      * specified length request_nbytes. This is an optimization
 103      * only. If less data is available, it's fine to return a smaller
 104      * block. If more data is already ready, it is better to return
 105      * the full block. */
 106     int (*pop) (pa_sink_input *i, size_t request_nbytes, pa_memchunk *chunk); /* may NOT be NULL */
 107
 108     /* Rewind the queue by the specified number of bytes. Called just
 109      * before peek() if it is called at all. Only called if the sink
 110      * input driver ever plans to call
 111      * pa_sink_input_request_rewind(). Called from IO context. */
 112     void (*process_rewind) (pa_sink_input *i, size_t nbytes);     /* may NOT be NULL */
 113
 114     /* Called whenever the maximum rewindable size of the sink
 115      * changes. Called from IO context. */
 116     void (*update_max_rewind) (pa_sink_input *i, size_t nbytes); /* may be NULL */
 117
 118     /* Called whenever the maxiumum request size of the sink
 119      * changes. Called from IO context. */
 120     void (*update_max_request) (pa_sink_input *i, size_t nbytes); /* may be NULL */
 121
 122     /* Called whenever the configured latency of the sink
 123      * changes. Called from IO context. */
 124     void (*update_sink_requested_latency) (pa_sink_input *i); /* may be NULL */
 125
 126     /* Called whenver the latency range of the sink changes. Called
 127      * from IO context. */
 128     void (*update_sink_latency_range) (pa_sink_input *i); /* may be NULL */
 129
 130     /* If non-NULL this function is called when the input is first
 131      * connected to a sink or when the rtpoll/asyncmsgq fields
 132      * change. You usually don't need to implement this function
 133      * unless you rewrite a sink that is piggy-backed onto
 134      * another. Called from IO thread context */
 135     void (*attach) (pa_sink_input *i);           /* may be NULL */
 136
 137     /* If non-NULL this function is called when the output is
 138      * disconnected from its sink. Called from IO thread context */
 139     void (*detach) (pa_sink_input *i);           /* may be NULL */
 140
 141     /* If non-NULL called whenever the the sink this input is attached
 142      * to suspends or resumes. Called from main context */
 143     void (*suspend) (pa_sink_input *i, pa_bool_t b);   /* may be NULL */
 144
 145     /* If non-NULL called whenever the the sink this input is attached
 146      * to changes. Called from main context */
 147     void (*moved) (pa_sink_input *i);   /* may be NULL */
 148
 149     /* Supposed to unlink and destroy this stream. Called from main
 150      * context. */
 151     void (*kill) (pa_sink_input *i);             /* may NOT be NULL */
 152
 153     /* Return the current latency (i.e. length of bufferd audio) of
 154     this stream. Called from main context. This is added to what the
 155     PA_SINK_INPUT_MESSAGE_GET_LATENCY message sent to the IO thread
 156     returns */
 157     pa_usec_t (*get_latency) (pa_sink_input *i); /* may be NULL */
 158
 159     /* If non_NULL this function is called from thread context if the
 160      * state changes. The old state is found in thread_info.state.  */
 161     void (*state_change) (pa_sink_input *i, pa_sink_input_state_t state); /* may be NULL */
 162
 163     struct {
 164         pa_sink_input_state_t state;
 165         pa_atomic_t drained;
 166
 167         pa_bool_t attached; /* True only between ->attach() and ->detach() calls */
 168
 169         pa_sample_spec sample_spec;
 170
 171         pa_resampler *resampler;                     /* may be NULL */
 172
 173         /* We maintain a history of resampled audio data here. */
 174         pa_memblockq *render_memblockq;
 175
 176         size_t rewrite_nbytes;
 177         pa_bool_t rewrite_flush;
 178         uint64_t underrun_for, playing_for;
 179
 180         pa_sink_input *sync_prev, *sync_next;
 181
 182         pa_cvolume volume;
 183         pa_bool_t muted;
 184
 185         /* The requested latency for the sink */
 186         pa_usec_t requested_sink_latency;
 187
 188         pa_hashmap *direct_outputs;
 189     } thread_info;
 190
 191     void *userdata;
 192 };
 193
 194 PA_DECLARE_CLASS(pa_sink_input);
 195 #define PA_SINK_INPUT(o) pa_sink_input_cast(o)
 196
 197 enum {
 198     PA_SINK_INPUT_MESSAGE_SET_VOLUME,
 199     PA_SINK_INPUT_MESSAGE_SET_MUTE,
 200     PA_SINK_INPUT_MESSAGE_GET_LATENCY,
 201     PA_SINK_INPUT_MESSAGE_SET_RATE,
 202     PA_SINK_INPUT_MESSAGE_SET_STATE,
 203     PA_SINK_INPUT_MESSAGE_SET_REQUESTED_LATENCY,
 204     PA_SINK_INPUT_MESSAGE_GET_REQUESTED_LATENCY,
 205     PA_SINK_INPUT_MESSAGE_MAX
 206 };
 207
 208 typedef struct pa_sink_input_new_data {
 209     pa_proplist *proplist;
 210
 211     const char *driver;
 212     pa_module *module;
 213     pa_client *client;
 214
 215     pa_sink *sink;
 216
 217     pa_resample_method_t resample_method;
 218
 219     pa_sink_input *sync_base;
 220
 221     pa_sample_spec sample_spec;
 222     pa_channel_map channel_map;
 223
 224     pa_cvolume virtual_volume;
 225
 226     pa_cvolume volume;
 227     pa_bool_t muted:1;
 228
 229     pa_bool_t sample_spec_is_set:1;
 230     pa_bool_t channel_map_is_set:1;
 231     pa_bool_t volume_is_set:1;
 232     pa_bool_t muted_is_set:1;
 233 } pa_sink_input_new_data;
 234
 235 pa_sink_input_new_data* pa_sink_input_new_data_init(pa_sink_input_new_data *data);
 236 void pa_sink_input_new_data_set_sample_spec(pa_sink_input_new_data *data, const pa_sample_spec *spec);
 237 void pa_sink_input_new_data_set_channel_map(pa_sink_input_new_data *data, const pa_channel_map *map);
 238 void pa_sink_input_new_data_set_volume(pa_sink_input_new_data *data, const pa_cvolume *volume);
 239 void pa_sink_input_new_data_set_muted(pa_sink_input_new_data *data, pa_bool_t mute);
 240 void pa_sink_input_new_data_done(pa_sink_input_new_data *data);
 241
 242 typedef struct pa_sink_input_move_hook_data {
 243     pa_sink_input *sink_input;
 244     pa_sink *destination;
 245 } pa_sink_input_move_hook_data;
 246
 247 typedef struct pa_sink_set_input_volume_data {
 248   pa_sink_input *sink_input;
 249   pa_cvolume virtual_volume;
 250   pa_cvolume volume;
 251 } pa_sink_input_set_volume_data;
 252
 253 /* To be called by the implementing module only */
 254
 255 pa_sink_input* pa_sink_input_new(
 256         pa_core *core,
 257         pa_sink_input_new_data *data,
 258         pa_sink_input_flags_t flags);
 259
 260 void pa_sink_input_put(pa_sink_input *i);
 261 void pa_sink_input_unlink(pa_sink_input* i);
 262
 263 void pa_sink_input_set_name(pa_sink_input *i, const char *name);
 264
 265 pa_usec_t pa_sink_input_set_requested_latency(pa_sink_input *i, pa_usec_t usec);
 266
 267 /* Request that the specified number of bytes already written out to
 268 the hw device is rewritten, if possible.  Please note that this is
 269 only a kind request. The sink driver may not be able to fulfill it
 270 fully -- or at all. If the request for a rewrite was successful, the
 271 sink driver will call ->rewind() and pass the number of bytes that
 272 could be rewound in the HW device. This functionality is required for
 273 implementing the "zero latency" write-through functionality. */
 274 void pa_sink_input_request_rewind(pa_sink_input *i, size_t nbytes, pa_bool_t rewrite, pa_bool_t flush);
 275
 276 void pa_sink_input_cork(pa_sink_input *i, pa_bool_t b);
 277
 278 int pa_sink_input_set_rate(pa_sink_input *i, uint32_t rate);
 279
 280 /* Callable by everyone from main thread*/
 281
 282 /* External code may request disconnection with this function */
 283 void pa_sink_input_kill(pa_sink_input*i);
 284
 285 pa_usec_t pa_sink_input_get_latency(pa_sink_input *i, pa_usec_t *sink_latency);
 286
 287 void pa_sink_input_set_volume(pa_sink_input *i, const pa_cvolume *volume);
 288 const pa_cvolume *pa_sink_input_get_volume(pa_sink_input *i);
 289 void pa_sink_input_set_mute(pa_sink_input *i, pa_bool_t mute);
 290 pa_bool_t pa_sink_input_get_mute(pa_sink_input *i);
 291
 292 pa_resample_method_t pa_sink_input_get_resample_method(pa_sink_input *i);
 293
 294 int pa_sink_input_move_to(pa_sink_input *i, pa_sink *dest);
 295
 296 pa_sink_input_state_t pa_sink_input_get_state(pa_sink_input *i);
 297
 298 pa_usec_t pa_sink_input_get_requested_latency(pa_sink_input *i);
 299
 300 /* To be used exclusively by the sink driver IO thread */
 301
 302 int pa_sink_input_peek(pa_sink_input *i, size_t length, pa_memchunk *chunk, pa_cvolume *volume);
 303 void pa_sink_input_drop(pa_sink_input *i, size_t length);
 304 void pa_sink_input_process_rewind(pa_sink_input *i, size_t nbytes /* in the sink's sample spec */);
 305 void pa_sink_input_update_max_rewind(pa_sink_input *i, size_t nbytes  /* in the sink's sample spec */);
 306 void pa_sink_input_update_max_request(pa_sink_input *i, size_t nbytes  /* in the sink's sample spec */);
 307
 308 void pa_sink_input_set_state_within_thread(pa_sink_input *i, pa_sink_input_state_t state);
 309
 310 int pa_sink_input_process_msg(pa_msgobject *o, int code, void *userdata, int64_t offset, pa_memchunk *chunk);
 311
 312 pa_usec_t pa_sink_input_set_requested_latency_within_thread(pa_sink_input *i, pa_usec_t usec);
 313
 314 pa_bool_t pa_sink_input_safe_to_remove(pa_sink_input *i);
 315
 316 pa_memchunk* pa_sink_input_get_silence(pa_sink_input *i, pa_memchunk *ret);
 317
 318 #endif