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_DONT_INHIBIT_AUTO_SUSPEND = 256,
  61     PA_SINK_INPUT_FAIL_ON_SUSPEND = 512
  62 } pa_sink_input_flags_t;
  63
  64 struct pa_sink_input {
  65     pa_msgobject parent;
  66
  67     uint32_t index;
  68     pa_core *core;
  69
  70     /* Please note that this state should only be read with
  71      * pa_sink_input_get_state(). That function will transparently
  72      * merge the thread_info.drained value in. */
  73     pa_sink_input_state_t state;
  74     pa_sink_input_flags_t flags;
  75
  76     char *driver;                       /* may be NULL */
  77     pa_proplist *proplist;
  78
  79     pa_module *module;                  /* may be NULL */
  80     pa_client *client;                  /* may be NULL */
  81
  82     pa_sink *sink; /* NULL while we are being moved */
  83
  84     /* A sink input may be connected to multiple source outputs
  85      * directly, so that they don't get mixed data of the entire
  86      * source. */
  87     pa_idxset *direct_outputs;
  88
  89     pa_sample_spec sample_spec;
  90     pa_channel_map channel_map;
  91
  92     pa_sink_input *sync_prev, *sync_next;
  93
  94     pa_cvolume virtual_volume, soft_volume, volume_factor;
  95     pa_bool_t muted:1;
  96
  97     /* if TRUE then the source we are connected to and/or the volume
  98      * set is worth remembering, i.e. was explicitly chosen by the
  99      * user and not automatically. module-stream-restore looks for
 100      * this.*/
 101     pa_bool_t save_sink:1, save_volume:1, save_muted:1;
 102
 103     pa_resample_method_t requested_resample_method, actual_resample_method;
 104
 105     /* Returns the chunk of audio data and drops it from the
 106      * queue. Returns -1 on failure. Called from IO thread context. If
 107      * data needs to be generated from scratch then please in the
 108      * specified length request_nbytes. This is an optimization
 109      * only. If less data is available, it's fine to return a smaller
 110      * block. If more data is already ready, it is better to return
 111      * the full block. */
 112     int (*pop) (pa_sink_input *i, size_t request_nbytes, pa_memchunk *chunk); /* may NOT be NULL */
 113
 114     /* Rewind the queue by the specified number of bytes. Called just
 115      * before peek() if it is called at all. Only called if the sink
 116      * input driver ever plans to call
 117      * pa_sink_input_request_rewind(). Called from IO context. */
 118     void (*process_rewind) (pa_sink_input *i, size_t nbytes);     /* may NOT be NULL */
 119
 120     /* Called whenever the maximum rewindable size of the sink
 121      * changes. Called from IO context. */
 122     void (*update_max_rewind) (pa_sink_input *i, size_t nbytes); /* may be NULL */
 123
 124     /* Called whenever the maxiumum request size of the sink
 125      * changes. Called from IO context. */
 126     void (*update_max_request) (pa_sink_input *i, size_t nbytes); /* may be NULL */
 127
 128     /* Called whenever the configured latency of the sink
 129      * changes. Called from IO context. */
 130     void (*update_sink_requested_latency) (pa_sink_input *i); /* may be NULL */
 131
 132     /* Called whenver the latency range of the sink changes. Called
 133      * from IO context. */
 134     void (*update_sink_latency_range) (pa_sink_input *i); /* may be NULL */
 135
 136     /* If non-NULL this function is called when the input is first
 137      * connected to a sink or when the rtpoll/asyncmsgq fields
 138      * change. You usually don't need to implement this function
 139      * unless you rewrite a sink that is piggy-backed onto
 140      * another. Called from IO thread context */
 141     void (*attach) (pa_sink_input *i);           /* may be NULL */
 142
 143     /* If non-NULL this function is called when the output is
 144      * disconnected from its sink. Called from IO thread context */
 145     void (*detach) (pa_sink_input *i);           /* may be NULL */
 146
 147     /* If non-NULL called whenever the the sink this input is attached
 148      * to suspends or resumes. Called from main context */
 149     void (*suspend) (pa_sink_input *i, pa_bool_t b);   /* may be NULL */
 150
 151     /* If non-NULL called whenever the the sink this input is attached
 152      * to changes. Called from main context */
 153     void (*moved) (pa_sink_input *i);   /* may be NULL */
 154
 155     /* Supposed to unlink and destroy this stream. Called from main
 156      * context. */
 157     void (*kill) (pa_sink_input *i);             /* may NOT be NULL */
 158
 159     /* Return the current latency (i.e. length of bufferd audio) of
 160     this stream. Called from main context. This is added to what the
 161     PA_SINK_INPUT_MESSAGE_GET_LATENCY message sent to the IO thread
 162     returns */
 163     pa_usec_t (*get_latency) (pa_sink_input *i); /* may be NULL */
 164
 165     /* If non-NULL this function is called from thread context if the
 166      * state changes. The old state is found in thread_info.state.  */
 167     void (*state_change) (pa_sink_input *i, pa_sink_input_state_t state); /* may be NULL */
 168
 169     /* If non-NULL this function is called before this sink input is
 170      * move to a sink and if it returns FALSE the move will not
 171      * be allowed */
 172     pa_bool_t (*may_move_to) (pa_sink_input *i, pa_sink *s); /* may be NULL */
 173
 174     /* If non-NULL this function is used to dispatch asynchronous
 175      * control events. */
 176     void (*send_event)(pa_sink_input *i, const char *event, pa_proplist* data);
 177
 178     struct {
 179         pa_sink_input_state_t state;
 180         pa_atomic_t drained;
 181
 182         pa_cvolume soft_volume;
 183         pa_bool_t muted:1;
 184
 185         pa_bool_t attached:1; /* True only between ->attach() and ->detach() calls */
 186
 187         /* 0: rewrite nothing, (size_t) -1: rewrite everything, otherwise how many bytes to rewrite */
 188         pa_bool_t rewrite_flush:1, dont_rewind_render:1;
 189         size_t rewrite_nbytes;
 190         uint64_t underrun_for, playing_for;
 191
 192         pa_sample_spec sample_spec;
 193
 194         pa_resampler *resampler;                     /* may be NULL */
 195
 196         /* We maintain a history of resampled audio data here. */
 197         pa_memblockq *render_memblockq;
 198
 199         pa_sink_input *sync_prev, *sync_next;
 200
 201         /* The requested latency for the sink */
 202         pa_usec_t requested_sink_latency;
 203
 204         pa_hashmap *direct_outputs;
 205     } thread_info;
 206
 207     void *userdata;
 208 };
 209
 210 PA_DECLARE_CLASS(pa_sink_input);
 211 #define PA_SINK_INPUT(o) pa_sink_input_cast(o)
 212
 213 enum {
 214     PA_SINK_INPUT_MESSAGE_SET_SOFT_VOLUME,
 215     PA_SINK_INPUT_MESSAGE_SET_SOFT_MUTE,
 216     PA_SINK_INPUT_MESSAGE_GET_LATENCY,
 217     PA_SINK_INPUT_MESSAGE_SET_RATE,
 218     PA_SINK_INPUT_MESSAGE_SET_STATE,
 219     PA_SINK_INPUT_MESSAGE_SET_REQUESTED_LATENCY,
 220     PA_SINK_INPUT_MESSAGE_GET_REQUESTED_LATENCY,
 221     PA_SINK_INPUT_MESSAGE_MAX
 222 };
 223
 224 typedef struct pa_sink_input_send_event_hook_data {
 225     pa_sink_input *sink_input;
 226     const char *event;
 227     pa_proplist *data;
 228 } pa_sink_input_send_event_hook_data;
 229
 230 typedef struct pa_sink_input_new_data {
 231     pa_proplist *proplist;
 232
 233     const char *driver;
 234     pa_module *module;
 235     pa_client *client;
 236
 237     pa_sink *sink;
 238
 239     pa_resample_method_t resample_method;
 240
 241     pa_sink_input *sync_base;
 242
 243     pa_sample_spec sample_spec;
 244     pa_channel_map channel_map;
 245
 246     pa_cvolume volume, volume_factor;
 247     pa_bool_t muted:1;
 248
 249     pa_bool_t sample_spec_is_set:1;
 250     pa_bool_t channel_map_is_set:1;
 251
 252     pa_bool_t volume_is_set:1, volume_factor_is_set:1;
 253     pa_bool_t muted_is_set:1;
 254
 255     pa_bool_t volume_is_absolute:1;
 256
 257     pa_bool_t save_sink:1, save_volume:1, save_muted:1;
 258 } pa_sink_input_new_data;
 259
 260 pa_sink_input_new_data* pa_sink_input_new_data_init(pa_sink_input_new_data *data);
 261 void pa_sink_input_new_data_set_sample_spec(pa_sink_input_new_data *data, const pa_sample_spec *spec);
 262 void pa_sink_input_new_data_set_channel_map(pa_sink_input_new_data *data, const pa_channel_map *map);
 263 void pa_sink_input_new_data_set_volume(pa_sink_input_new_data *data, const pa_cvolume *volume);
 264 void pa_sink_input_new_data_apply_volume_factor(pa_sink_input_new_data *data, const pa_cvolume *volume_factor);
 265 void pa_sink_input_new_data_set_muted(pa_sink_input_new_data *data, pa_bool_t mute);
 266 void pa_sink_input_new_data_done(pa_sink_input_new_data *data);
 267
 268 /* To be called by the implementing module only */
 269
 270 int pa_sink_input_new(
 271         pa_sink_input **i,
 272         pa_core *core,
 273         pa_sink_input_new_data *data,
 274         pa_sink_input_flags_t flags);
 275
 276 void pa_sink_input_put(pa_sink_input *i);
 277 void pa_sink_input_unlink(pa_sink_input* i);
 278
 279 void pa_sink_input_set_name(pa_sink_input *i, const char *name);
 280
 281 pa_usec_t pa_sink_input_set_requested_latency(pa_sink_input *i, pa_usec_t usec);
 282
 283 /* Request that the specified number of bytes already written out to
 284 the hw device is rewritten, if possible.  Please note that this is
 285 only a kind request. The sink driver may not be able to fulfill it
 286 fully -- or at all. If the request for a rewrite was successful, the
 287 sink driver will call ->rewind() and pass the number of bytes that
 288 could be rewound in the HW device. This functionality is required for
 289 implementing the "zero latency" write-through functionality. */
 290 void pa_sink_input_request_rewind(pa_sink_input *i, size_t nbytes, pa_bool_t rewrite, pa_bool_t flush, pa_bool_t dont_rewind_render);
 291
 292 void pa_sink_input_cork(pa_sink_input *i, pa_bool_t b);
 293
 294 int pa_sink_input_set_rate(pa_sink_input *i, uint32_t rate);
 295
 296 /* Callable by everyone from main thread*/
 297
 298 /* External code may request disconnection with this function */
 299 void pa_sink_input_kill(pa_sink_input*i);
 300
 301 pa_usec_t pa_sink_input_get_latency(pa_sink_input *i, pa_usec_t *sink_latency);
 302
 303 void pa_sink_input_set_volume(pa_sink_input *i, const pa_cvolume *volume, pa_bool_t save);
 304 const pa_cvolume *pa_sink_input_get_volume(pa_sink_input *i);
 305 void pa_sink_input_set_mute(pa_sink_input *i, pa_bool_t mute, pa_bool_t save);
 306 pa_bool_t pa_sink_input_get_mute(pa_sink_input *i);
 307 void pa_sink_input_update_proplist(pa_sink_input *i, pa_update_mode_t mode, pa_proplist *p);
 308
 309 pa_resample_method_t pa_sink_input_get_resample_method(pa_sink_input *i);
 310
 311 void pa_sink_input_send_event(pa_sink_input *i, const char *name, pa_proplist *data);
 312
 313 int pa_sink_input_move_to(pa_sink_input *i, pa_sink *dest, pa_bool_t save);
 314 pa_bool_t pa_sink_input_may_move(pa_sink_input *i); /* may this sink input move at all? */
 315 pa_bool_t pa_sink_input_may_move_to(pa_sink_input *i, pa_sink *dest); /* may this sink input move to this sink? */
 316
 317 /* The same as pa_sink_input_move_to() but in two seperate steps,
 318  * first the detaching from the old sink, then the attaching to the
 319  * new sink */
 320 int pa_sink_input_start_move(pa_sink_input *i);
 321 int pa_sink_input_finish_move(pa_sink_input *i, pa_sink *dest, pa_bool_t save);
 322
 323 pa_sink_input_state_t pa_sink_input_get_state(pa_sink_input *i);
 324
 325 pa_usec_t pa_sink_input_get_requested_latency(pa_sink_input *i);
 326
 327 /* To be used exclusively by the sink driver IO thread */
 328
 329 void pa_sink_input_peek(pa_sink_input *i, size_t length, pa_memchunk *chunk, pa_cvolume *volume);
 330 void pa_sink_input_drop(pa_sink_input *i, size_t length);
 331 void pa_sink_input_process_rewind(pa_sink_input *i, size_t nbytes /* in the sink's sample spec */);
 332 void pa_sink_input_update_max_rewind(pa_sink_input *i, size_t nbytes  /* in the sink's sample spec */);
 333 void pa_sink_input_update_max_request(pa_sink_input *i, size_t nbytes  /* in the sink's sample spec */);
 334
 335 void pa_sink_input_set_state_within_thread(pa_sink_input *i, pa_sink_input_state_t state);
 336
 337 int pa_sink_input_process_msg(pa_msgobject *o, int code, void *userdata, int64_t offset, pa_memchunk *chunk);
 338
 339 pa_usec_t pa_sink_input_set_requested_latency_within_thread(pa_sink_input *i, pa_usec_t usec);
 340
 341 pa_bool_t pa_sink_input_safe_to_remove(pa_sink_input *i);
 342
 343 pa_memchunk* pa_sink_input_get_silence(pa_sink_input *i, pa_memchunk *ret);
 344
 345 #endif