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