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