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 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
  28 #include <inttypes.h>
  29
  30 #include <pulse/sample.h>
  31 #include <pulse/channelmap.h>
  32 #include <pulse/volume.h>
  33
  34 #include <pulsecore/core.h>
  35 #include <pulsecore/idxset.h>
  36 #include <pulsecore/memblock.h>
  37 #include <pulsecore/memchunk.h>
  38 #include <pulsecore/sink.h>
  39 #include <pulsecore/module.h>
  40 #include <pulsecore/asyncmsgq.h>
  41 #include <pulsecore/msgobject.h>
  42 #include <pulsecore/rtpoll.h>
  43 #include <pulsecore/source-output.h>
  44 #include <pulsecore/card.h>
  45
  46 #define PA_MAX_OUTPUTS_PER_SOURCE 32
  47
  48 /* Returns true if source is linked: registered and accessible from client side. */
  49 static inline pa_bool_t PA_SOURCE_IS_LINKED(pa_source_state_t x) {
  50     return x == PA_SOURCE_RUNNING || x == PA_SOURCE_IDLE || x == PA_SOURCE_SUSPENDED;
  51 }
  52
  53 struct pa_source {
  54     pa_msgobject parent;
  55
  56     uint32_t index;
  57     pa_core *core;
  58     pa_source_state_t state;
  59     pa_source_flags_t flags;
  60
  61     char *name;
  62     char *driver;                             /* may be NULL */
  63     pa_proplist *proplist;
  64
  65     pa_module *module;                        /* may be NULL */
  66     pa_card *card;                            /* may be NULL */
  67
  68     pa_sample_spec sample_spec;
  69     pa_channel_map channel_map;
  70
  71     pa_idxset *outputs;
  72     unsigned n_corked;
  73     pa_sink *monitor_of;                     /* may be NULL */
  74
  75     pa_cvolume volume;
  76     pa_bool_t muted;
  77
  78     pa_volume_t base_volume; /* shall be constant */
  79
  80     pa_bool_t refresh_volume:1;
  81     pa_bool_t refresh_muted:1;
  82
  83     pa_asyncmsgq *asyncmsgq;
  84     pa_rtpoll *rtpoll;
  85
  86     pa_memchunk silence;
  87
  88     /* Called when the main loop requests a state change. Called from
  89      * main loop context. If returns -1 the state change will be
  90      * inhibited */
  91     int (*set_state)(pa_source*source, pa_source_state_t state); /* may be NULL */
  92
  93     /* Callled when the volume is queried. Called from main loop
  94      * context. If this is NULL a PA_SOURCE_MESSAGE_GET_VOLUME message
  95      * will be sent to the IO thread instead. If refresh_volume is
  96      * FALSE neither this function is called nor a message is sent. */
  97     int (*get_volume)(pa_source *s);         /* dito */
  98
  99     /* Called when the volume shall be changed. Called from main loop
 100      * context. If this is NULL a PA_SOURCE_MESSAGE_SET_VOLUME message
 101      * will be sent to the IO thread instead. */
 102     int (*set_volume)(pa_source *s);         /* dito */
 103
 104     /* Called when the mute setting is queried. Called from main loop
 105      * context. If this is NULL a PA_SOURCE_MESSAGE_GET_MUTE message
 106      * will be sent to the IO thread instead. If refresh_mute is
 107      * FALSE neither this function is called nor a message is sent.*/
 108     int (*get_mute)(pa_source *s);           /* dito */
 109
 110     /* Called when the mute setting shall be changed. Called from main
 111      * loop context. If this is NULL a PA_SOURCE_MESSAGE_SET_MUTE
 112      * message will be sent to the IO thread instead. */
 113     int (*set_mute)(pa_source *s);           /* dito */
 114
 115     /* Called when a the requested latency is changed. Called from IO
 116      * thread context. */
 117     void (*update_requested_latency)(pa_source *s); /* dito */
 118
 119     /* Contains copies of the above data so that the real-time worker
 120      * thread can work without access locking */
 121     struct {
 122         pa_source_state_t state;
 123         pa_hashmap *outputs;
 124         pa_cvolume soft_volume;
 125         pa_bool_t soft_muted:1;
 126
 127         pa_bool_t requested_latency_valid:1;
 128         pa_usec_t requested_latency;
 129
 130         /* Then number of bytes this source will be rewound for at
 131          * max. (Only used on monitor sources) */
 132         size_t max_rewind;
 133
 134         pa_usec_t min_latency; /* we won't go below this latency */
 135         pa_usec_t max_latency; /* An upper limit for the latencies */
 136     } thread_info;
 137
 138     void *userdata;
 139 };
 140
 141 PA_DECLARE_CLASS(pa_source);
 142 #define PA_SOURCE(s) pa_source_cast(s)
 143
 144 typedef enum pa_source_message {
 145     PA_SOURCE_MESSAGE_ADD_OUTPUT,
 146     PA_SOURCE_MESSAGE_REMOVE_OUTPUT,
 147     PA_SOURCE_MESSAGE_GET_VOLUME,
 148     PA_SOURCE_MESSAGE_SET_VOLUME,
 149     PA_SOURCE_MESSAGE_GET_MUTE,
 150     PA_SOURCE_MESSAGE_SET_MUTE,
 151     PA_SOURCE_MESSAGE_GET_LATENCY,
 152     PA_SOURCE_MESSAGE_GET_REQUESTED_LATENCY,
 153     PA_SOURCE_MESSAGE_SET_STATE,
 154     PA_SOURCE_MESSAGE_ATTACH,
 155     PA_SOURCE_MESSAGE_DETACH,
 156     PA_SOURCE_MESSAGE_SET_LATENCY_RANGE,
 157     PA_SOURCE_MESSAGE_GET_LATENCY_RANGE,
 158     PA_SOURCE_MESSAGE_GET_MAX_REWIND,
 159     PA_SOURCE_MESSAGE_MAX
 160 } pa_source_message_t;
 161
 162 typedef struct pa_source_new_data {
 163     char *name;
 164     pa_proplist *proplist;
 165
 166     const char *driver;
 167     pa_module *module;
 168     pa_card *card;
 169
 170     pa_sample_spec sample_spec;
 171     pa_channel_map channel_map;
 172     pa_cvolume volume;
 173     pa_bool_t muted:1;
 174
 175     pa_bool_t volume_is_set:1;
 176     pa_bool_t muted_is_set:1;
 177     pa_bool_t sample_spec_is_set:1;
 178     pa_bool_t channel_map_is_set:1;
 179
 180     pa_bool_t namereg_fail:1;
 181 } pa_source_new_data;
 182
 183 pa_source_new_data* pa_source_new_data_init(pa_source_new_data *data);
 184 void pa_source_new_data_set_name(pa_source_new_data *data, const char *name);
 185 void pa_source_new_data_set_sample_spec(pa_source_new_data *data, const pa_sample_spec *spec);
 186 void pa_source_new_data_set_channel_map(pa_source_new_data *data, const pa_channel_map *map);
 187 void pa_source_new_data_set_volume(pa_source_new_data *data, const pa_cvolume *volume);
 188 void pa_source_new_data_set_muted(pa_source_new_data *data, pa_bool_t mute);
 189 void pa_source_new_data_done(pa_source_new_data *data);
 190
 191 /* To be called exclusively by the source driver, from main context */
 192
 193 pa_source* pa_source_new(
 194         pa_core *core,
 195         pa_source_new_data *data,
 196         pa_source_flags_t flags);
 197
 198 void pa_source_put(pa_source *s);
 199 void pa_source_unlink(pa_source *s);
 200
 201 void pa_source_set_description(pa_source *s, const char *description);
 202 void pa_source_set_asyncmsgq(pa_source *s, pa_asyncmsgq *q);
 203 void pa_source_set_rtpoll(pa_source *s, pa_rtpoll *p);
 204
 205 void pa_source_set_latency_range(pa_source *s, pa_usec_t min_latency, pa_usec_t max_latency);
 206
 207 void pa_source_detach(pa_source *s);
 208 void pa_source_attach(pa_source *s);
 209
 210 /* May be called by everyone, from main context */
 211
 212 /* The returned value is supposed to be in the time domain of the sound card! */
 213 pa_usec_t pa_source_get_latency(pa_source *s);
 214 pa_usec_t pa_source_get_requested_latency(pa_source *s);
 215 void pa_source_get_latency_range(pa_source *s, pa_usec_t *min_latency, pa_usec_t *max_latency);
 216
 217 size_t pa_source_get_max_rewind(pa_source *s);
 218
 219 int pa_source_update_status(pa_source*s);
 220 int pa_source_suspend(pa_source *s, pa_bool_t suspend);
 221 int pa_source_suspend_all(pa_core *c, pa_bool_t suspend);
 222
 223 void pa_source_set_volume(pa_source *source, const pa_cvolume *volume);
 224 void pa_source_set_soft_volume(pa_source *s, const pa_cvolume *volume);
 225 const pa_cvolume *pa_source_get_volume(pa_source *source, pa_bool_t force_refresh);
 226 void pa_source_set_mute(pa_source *source, pa_bool_t mute);
 227 pa_bool_t pa_source_get_mute(pa_source *source, pa_bool_t force_refresh);
 228
 229 pa_bool_t pa_source_update_proplist(pa_source *s, pa_update_mode_t mode, pa_proplist *p);
 230
 231 unsigned pa_source_linked_by(pa_source *s); /* Number of connected streams */
 232 unsigned pa_source_used_by(pa_source *s); /* Number of connected streams that are not corked */
 233 unsigned pa_source_check_suspend(pa_source *s); /* Returns how many streams are active that don't allow suspensions */
 234 #define pa_source_get_state(s) ((pa_source_state_t) (s)->state)
 235
 236 /* To be called exclusively by the source driver, from IO context */
 237
 238 void pa_source_post(pa_source*s, const pa_memchunk *chunk);
 239 void pa_source_post_direct(pa_source*s, pa_source_output *o, const pa_memchunk *chunk);
 240 void pa_source_process_rewind(pa_source *s, size_t nbytes);
 241
 242 int pa_source_process_msg(pa_msgobject *o, int code, void *userdata, int64_t, pa_memchunk *chunk);
 243
 244 void pa_source_attach_within_thread(pa_source *s);
 245 void pa_source_detach_within_thread(pa_source *s);
 246
 247 pa_usec_t pa_source_get_requested_latency_within_thread(pa_source *s);
 248
 249 void pa_source_set_max_rewind(pa_source *s, size_t max_rewind);
 250 void pa_source_update_latency_range(pa_source *s, pa_usec_t min_latency, pa_usec_t max_latency);
 251
 252 /* To be called exclusively by source output drivers, from IO context */
 253
 254 void pa_source_invalidate_requested_latency(pa_source *s);
 255
 256 #endif