code.delx.au - pulseaudio/blob - src/pulsecore/source.h

   1 #ifndef foopulsesourcehfoo
   2 #define foopulsesourcehfoo
   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 typedef struct pa_source pa_source;
  27 typedef struct pa_source_volume_change pa_source_volume_change;
  28
  29 #include <inttypes.h>
  30
  31 #include <pulse/def.h>
  32 #include <pulse/format.h>
  33 #include <pulse/sample.h>
  34 #include <pulse/channelmap.h>
  35 #include <pulse/volume.h>
  36
  37 #include <pulsecore/core.h>
  38 #include <pulsecore/idxset.h>
  39 #include <pulsecore/memchunk.h>
  40 #include <pulsecore/sink.h>
  41 #include <pulsecore/module.h>
  42 #include <pulsecore/asyncmsgq.h>
  43 #include <pulsecore/msgobject.h>
  44 #include <pulsecore/rtpoll.h>
  45 #include <pulsecore/card.h>
  46 #include <pulsecore/queue.h>
  47 #include <pulsecore/thread-mq.h>
  48 #include <pulsecore/source-output.h>
  49
  50 #define PA_MAX_OUTPUTS_PER_SOURCE 32
  51
  52 /* Returns true if source is linked: registered and accessible from client side. */
  53 static inline pa_bool_t PA_SOURCE_IS_LINKED(pa_source_state_t x) {
  54     return x == PA_SOURCE_RUNNING || x == PA_SOURCE_IDLE || x == PA_SOURCE_SUSPENDED;
  55 }
  56
  57 /* A generic definition for void callback functions */
  58 typedef void(*pa_source_cb_t)(pa_source *s);
  59
  60 struct pa_source {
  61     pa_msgobject parent;
  62
  63     uint32_t index;
  64     pa_core *core;
  65
  66     pa_source_state_t state;
  67     pa_source_flags_t flags;
  68     pa_suspend_cause_t suspend_cause;
  69
  70     char *name;
  71     char *driver;                             /* may be NULL */
  72     pa_proplist *proplist;
  73
  74     pa_module *module;                        /* may be NULL */
  75     pa_card *card;                            /* may be NULL */
  76
  77     pa_sample_spec sample_spec;
  78     pa_channel_map channel_map;
  79
  80     pa_idxset *outputs;
  81     unsigned n_corked;
  82     pa_sink *monitor_of;                     /* may be NULL */
  83     pa_source_output *output_from_master;    /* non-NULL only for filter sources */
  84
  85     pa_volume_t base_volume; /* shall be constant */
  86     unsigned n_volume_steps; /* shall be constant */
  87
  88     /* Also see http://pulseaudio.org/wiki/InternalVolumes */
  89     pa_cvolume reference_volume; /* The volume exported and taken as reference base for relative source output volumes */
  90     pa_cvolume real_volume;      /* The volume that the hardware is configured to  */
  91     pa_cvolume soft_volume;      /* The internal software volume we apply to all PCM data while it passes through */
  92
  93     pa_bool_t muted:1;
  94
  95     pa_bool_t refresh_volume:1;
  96     pa_bool_t refresh_muted:1;
  97     pa_bool_t save_port:1;
  98     pa_bool_t save_volume:1;
  99     pa_bool_t save_muted:1;
 100
 101     /* Saved volume state while we're in passthrough mode */
 102     pa_cvolume saved_volume;
 103     pa_bool_t saved_save_volume:1;
 104
 105     pa_asyncmsgq *asyncmsgq;
 106
 107     pa_memchunk silence;
 108
 109     pa_hashmap *ports;
 110     pa_device_port *active_port;
 111
 112     unsigned priority;
 113
 114     /* Called when the main loop requests a state change. Called from
 115      * main loop context. If returns -1 the state change will be
 116      * inhibited */
 117     int (*set_state)(pa_source*source, pa_source_state_t state); /* may be NULL */
 118
 119     /* Called when the volume is queried. Called from main loop
 120      * context. If this is NULL a PA_SOURCE_MESSAGE_GET_VOLUME message
 121      * will be sent to the IO thread instead. If refresh_volume is
 122      * FALSE neither this function is called nor a message is sent.
 123      *
 124      * You must use the function pa_source_set_get_volume_callback() to
 125      * set this callback. */
 126     pa_source_cb_t get_volume; /* may be NULL */
 127
 128     /* Called when the volume shall be changed. Called from main loop
 129      * context. If this is NULL a PA_SOURCE_MESSAGE_SET_VOLUME message
 130      * will be sent to the IO thread instead.
 131      *
 132      * You must use the function pa_source_set_set_volume_callback() to
 133      * set this callback. */
 134     pa_source_cb_t set_volume; /* may be NULL */
 135
 136     /* Source drivers that set PA_SOURCE_SYNC_VOLUME must provide this
 137      * callback. This callback is not used with source that do not set
 138      * PA_SOURCE_SYNC_VOLUME. This is called from the IO thread when a
 139      * pending hardware volume change has to be written to the
 140      * hardware. The requested volume is passed to the callback
 141      * implementation in s->thread_info.current_hw_volume.
 142      *
 143      * The call is done inside pa_source_volume_change_apply(), which is
 144      * not called automatically - it is the driver's responsibility to
 145      * schedule that function to be called at the right times in the
 146      * IO thread.
 147      *
 148      * You must use the function pa_source_set_write_volume_callback() to
 149      * set this callback. */
 150     pa_source_cb_t write_volume; /* may be NULL */
 151
 152     /* Called when the mute setting is queried. Called from main loop
 153      * context. If this is NULL a PA_SOURCE_MESSAGE_GET_MUTE message
 154      * will be sent to the IO thread instead. If refresh_mute is
 155      * FALSE neither this function is called nor a message is sent.
 156      *
 157      * You must use the function pa_source_set_get_mute_callback() to
 158      * set this callback. */
 159     pa_source_cb_t get_mute; /* may be NULL */
 160
 161     /* Called when the mute setting shall be changed. Called from main
 162      * loop context. If this is NULL a PA_SOURCE_MESSAGE_SET_MUTE
 163      * message will be sent to the IO thread instead.
 164      *
 165      * You must use the function pa_source_set_set_mute_callback() to
 166      * set this callback. */
 167     pa_source_cb_t set_mute; /* may be NULL */
 168
 169     /* Called when a the requested latency is changed. Called from IO
 170      * thread context. */
 171     pa_source_cb_t update_requested_latency; /* may be NULL */
 172
 173     /* Called whenever the port shall be changed. Called from main
 174      * thread. */
 175     int (*set_port)(pa_source *s, pa_device_port *port); /*ditto */
 176
 177     /* Called to get the list of formats supported by the source, sorted
 178      * in descending order of preference. */
 179     pa_idxset* (*get_formats)(pa_source *s); /* ditto */
 180
 181     /* Contains copies of the above data so that the real-time worker
 182      * thread can work without access locking */
 183     struct {
 184         pa_source_state_t state;
 185         pa_hashmap *outputs;
 186
 187         pa_rtpoll *rtpoll;
 188
 189         pa_cvolume soft_volume;
 190         pa_bool_t soft_muted:1;
 191
 192         pa_bool_t requested_latency_valid:1;
 193         pa_usec_t requested_latency;
 194
 195         /* Then number of bytes this source will be rewound for at
 196          * max. (Only used on monitor sources) */
 197         size_t max_rewind;
 198
 199         pa_usec_t min_latency; /* we won't go below this latency */
 200         pa_usec_t max_latency; /* An upper limit for the latencies */
 201
 202         pa_usec_t fixed_latency; /* for sources with PA_SOURCE_DYNAMIC_LATENCY this is 0 */
 203
 204         /* Delayed volume change events are queued here. The events
 205          * are stored in expiration order. The one expiring next is in
 206          * the head of the list. */
 207         PA_LLIST_HEAD(pa_source_volume_change, volume_changes);
 208         pa_source_volume_change *volume_changes_tail;
 209         /* This value is updated in pa_source_volume_change_apply() and
 210          * used only by sources with PA_SOURCE_SYNC_VOLUME. */
 211         pa_cvolume current_hw_volume;
 212
 213         /* The amount of usec volume up events are delayed and volume
 214          * down events are made earlier. */
 215         uint32_t volume_change_safety_margin;
 216         /* Usec delay added to all volume change events, may be negative. */
 217         int32_t volume_change_extra_delay;
 218 } thread_info;
 219
 220     void *userdata;
 221 };
 222
 223 PA_DECLARE_PUBLIC_CLASS(pa_source);
 224 #define PA_SOURCE(s) pa_source_cast(s)
 225
 226 typedef enum pa_source_message {
 227     PA_SOURCE_MESSAGE_ADD_OUTPUT,
 228     PA_SOURCE_MESSAGE_REMOVE_OUTPUT,
 229     PA_SOURCE_MESSAGE_GET_VOLUME,
 230     PA_SOURCE_MESSAGE_SET_SHARED_VOLUME,
 231     PA_SOURCE_MESSAGE_SET_VOLUME_SYNCED,
 232     PA_SOURCE_MESSAGE_SET_VOLUME,
 233     PA_SOURCE_MESSAGE_SYNC_VOLUMES,
 234     PA_SOURCE_MESSAGE_GET_MUTE,
 235     PA_SOURCE_MESSAGE_SET_MUTE,
 236     PA_SOURCE_MESSAGE_GET_LATENCY,
 237     PA_SOURCE_MESSAGE_GET_REQUESTED_LATENCY,
 238     PA_SOURCE_MESSAGE_SET_STATE,
 239     PA_SOURCE_MESSAGE_ATTACH,
 240     PA_SOURCE_MESSAGE_DETACH,
 241     PA_SOURCE_MESSAGE_SET_LATENCY_RANGE,
 242     PA_SOURCE_MESSAGE_GET_LATENCY_RANGE,
 243     PA_SOURCE_MESSAGE_SET_FIXED_LATENCY,
 244     PA_SOURCE_MESSAGE_GET_FIXED_LATENCY,
 245     PA_SOURCE_MESSAGE_GET_MAX_REWIND,
 246     PA_SOURCE_MESSAGE_SET_MAX_REWIND,
 247     PA_SOURCE_MESSAGE_SET_PORT,
 248     PA_SOURCE_MESSAGE_UPDATE_VOLUME_AND_MUTE,
 249     PA_SOURCE_MESSAGE_MAX
 250 } pa_source_message_t;
 251
 252 typedef struct pa_source_new_data {
 253     char *name;
 254     pa_proplist *proplist;
 255
 256     const char *driver;
 257     pa_module *module;
 258     pa_card *card;
 259
 260     pa_hashmap *ports;
 261     char *active_port;
 262
 263     pa_sample_spec sample_spec;
 264     pa_channel_map channel_map;
 265     pa_cvolume volume;
 266     pa_bool_t muted:1;
 267
 268     pa_bool_t volume_is_set:1;
 269     pa_bool_t muted_is_set:1;
 270     pa_bool_t sample_spec_is_set:1;
 271     pa_bool_t channel_map_is_set:1;
 272
 273     pa_bool_t namereg_fail:1;
 274
 275     pa_bool_t save_port:1;
 276     pa_bool_t save_volume:1;
 277     pa_bool_t save_muted:1;
 278 } pa_source_new_data;
 279
 280 pa_source_new_data* pa_source_new_data_init(pa_source_new_data *data);
 281 void pa_source_new_data_set_name(pa_source_new_data *data, const char *name);
 282 void pa_source_new_data_set_sample_spec(pa_source_new_data *data, const pa_sample_spec *spec);
 283 void pa_source_new_data_set_channel_map(pa_source_new_data *data, const pa_channel_map *map);
 284 void pa_source_new_data_set_volume(pa_source_new_data *data, const pa_cvolume *volume);
 285 void pa_source_new_data_set_muted(pa_source_new_data *data, pa_bool_t mute);
 286 void pa_source_new_data_set_port(pa_source_new_data *data, const char *port);
 287 void pa_source_new_data_done(pa_source_new_data *data);
 288
 289 /*** To be called exclusively by the source driver, from main context */
 290
 291 pa_source* pa_source_new(
 292         pa_core *core,
 293         pa_source_new_data *data,
 294         pa_source_flags_t flags);
 295
 296 void pa_source_set_get_volume_callback(pa_source *s, pa_source_cb_t cb);
 297 void pa_source_set_set_volume_callback(pa_source *s, pa_source_cb_t cb);
 298 void pa_source_set_write_volume_callback(pa_source *s, pa_source_cb_t cb);
 299 void pa_source_set_get_mute_callback(pa_source *s, pa_source_cb_t cb);
 300 void pa_source_set_set_mute_callback(pa_source *s, pa_source_cb_t cb);
 301 void pa_source_enable_decibel_volume(pa_source *s, pa_bool_t enable);
 302
 303 void pa_source_put(pa_source *s);
 304 void pa_source_unlink(pa_source *s);
 305
 306 void pa_source_set_description(pa_source *s, const char *description);
 307 void pa_source_set_asyncmsgq(pa_source *s, pa_asyncmsgq *q);
 308 void pa_source_set_rtpoll(pa_source *s, pa_rtpoll *p);
 309
 310 void pa_source_set_max_rewind(pa_source *s, size_t max_rewind);
 311 void pa_source_set_latency_range(pa_source *s, pa_usec_t min_latency, pa_usec_t max_latency);
 312 void pa_source_set_fixed_latency(pa_source *s, pa_usec_t latency);
 313
 314 void pa_source_detach(pa_source *s);
 315 void pa_source_attach(pa_source *s);
 316
 317 void pa_source_set_soft_volume(pa_source *s, const pa_cvolume *volume);
 318 void pa_source_volume_changed(pa_source *s, const pa_cvolume *new_volume);
 319 void pa_source_mute_changed(pa_source *s, pa_bool_t new_muted);
 320
 321 int pa_source_sync_suspend(pa_source *s);
 322
 323 void pa_source_update_flags(pa_source *s, pa_source_flags_t mask, pa_source_flags_t value);
 324
 325 /*** May be called by everyone, from main context */
 326
 327 /* The returned value is supposed to be in the time domain of the sound card! */
 328 pa_usec_t pa_source_get_latency(pa_source *s);
 329 pa_usec_t pa_source_get_requested_latency(pa_source *s);
 330 void pa_source_get_latency_range(pa_source *s, pa_usec_t *min_latency, pa_usec_t *max_latency);
 331 pa_usec_t pa_source_get_fixed_latency(pa_source *s);
 332
 333 size_t pa_source_get_max_rewind(pa_source *s);
 334
 335 int pa_source_update_status(pa_source*s);
 336 int pa_source_suspend(pa_source *s, pa_bool_t suspend, pa_suspend_cause_t cause);
 337 int pa_source_suspend_all(pa_core *c, pa_bool_t suspend, pa_suspend_cause_t cause);
 338
 339 /* Use this instead of checking s->flags & PA_SOURCE_FLAT_VOLUME directly. */
 340 pa_bool_t pa_source_flat_volume_enabled(pa_source *s);
 341
 342 /* Is the source in passthrough mode? (that is, is this a monitor source for a sink
 343  * that has a passthrough sink input connected to it. */
 344 pa_bool_t pa_source_is_passthrough(pa_source *s);
 345 /* These should be called when a source enters/leaves passthrough mode */
 346 void pa_source_enter_passthrough(pa_source *s);
 347 void pa_source_leave_passthrough(pa_source *s);
 348
 349 void pa_source_set_volume(pa_source *source, const pa_cvolume *volume, pa_bool_t sendmsg, pa_bool_t save);
 350 const pa_cvolume *pa_source_get_volume(pa_source *source, pa_bool_t force_refresh);
 351
 352 void pa_source_set_mute(pa_source *source, pa_bool_t mute, pa_bool_t save);
 353 pa_bool_t pa_source_get_mute(pa_source *source, pa_bool_t force_refresh);
 354
 355 pa_bool_t pa_source_update_proplist(pa_source *s, pa_update_mode_t mode, pa_proplist *p);
 356
 357 int pa_source_set_port(pa_source *s, const char *name, pa_bool_t save);
 358
 359 unsigned pa_source_linked_by(pa_source *s); /* Number of connected streams */
 360 unsigned pa_source_used_by(pa_source *s); /* Number of connected streams that are not corked */
 361 unsigned pa_source_check_suspend(pa_source *s); /* Returns how many streams are active that don't allow suspensions */
 362 #define pa_source_get_state(s) ((pa_source_state_t) (s)->state)
 363
 364 /* Moves all inputs away, and stores them in pa_queue */
 365 pa_queue *pa_source_move_all_start(pa_source *s, pa_queue *q);
 366 void pa_source_move_all_finish(pa_source *s, pa_queue *q, pa_bool_t save);
 367 void pa_source_move_all_fail(pa_queue *q);
 368
 369 pa_idxset* pa_source_get_formats(pa_source *s);
 370 pa_bool_t pa_source_check_format(pa_source *s, pa_format_info *f);
 371 pa_idxset* pa_source_check_formats(pa_source *s, pa_idxset *in_formats);
 372
 373 /*** To be called exclusively by the source driver, from IO context */
 374
 375 void pa_source_post(pa_source*s, const pa_memchunk *chunk);
 376 void pa_source_post_direct(pa_source*s, pa_source_output *o, const pa_memchunk *chunk);
 377 void pa_source_process_rewind(pa_source *s, size_t nbytes);
 378
 379 int pa_source_process_msg(pa_msgobject *o, int code, void *userdata, int64_t, pa_memchunk *chunk);
 380
 381 void pa_source_attach_within_thread(pa_source *s);
 382 void pa_source_detach_within_thread(pa_source *s);
 383
 384 pa_usec_t pa_source_get_requested_latency_within_thread(pa_source *s);
 385
 386 void pa_source_set_max_rewind_within_thread(pa_source *s, size_t max_rewind);
 387
 388 void pa_source_set_latency_range_within_thread(pa_source *s, pa_usec_t min_latency, pa_usec_t max_latency);
 389 void pa_source_set_fixed_latency_within_thread(pa_source *s, pa_usec_t latency);
 390
 391 void pa_source_update_volume_and_mute(pa_source *s);
 392
 393 pa_bool_t pa_source_volume_change_apply(pa_source *s, pa_usec_t *usec_to_next);
 394
 395 /*** To be called exclusively by source output drivers, from IO context */
 396
 397 void pa_source_invalidate_requested_latency(pa_source *s, pa_bool_t dynamic);
 398 pa_usec_t pa_source_get_latency_within_thread(pa_source *s);
 399
 400 #define pa_source_assert_io_context(s) \
 401     pa_assert(pa_thread_mq_get() || !PA_SOURCE_IS_LINKED((s)->state))
 402
 403 #endif