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