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