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