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