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