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