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

   1 #ifndef foopulsesourcehfoo
   2 #define foopulsesourcehfoo
   3
   4 /* $Id$ */
   5
   6 /***
   7   This file is part of PulseAudio.
   8
   9   Copyright 2004-2006 Lennart Poettering
  10   Copyright 2006 Pierre Ossman <ossman@cendio.se> for Cendio AB
  11
  12   PulseAudio is free software; you can redistribute it and/or modify
  13   it under the terms of the GNU Lesser General Public License as published
  14   by the Free Software Foundation; either version 2 of the License,
  15   or (at your option) any later version.
  16
  17   PulseAudio is distributed in the hope that it will be useful, but
  18   WITHOUT ANY WARRANTY; without even the implied warranty of
  19   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  20   General Public License for more details.
  21
  22   You should have received a copy of the GNU Lesser General Public License
  23   along with PulseAudio; if not, write to the Free Software
  24   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  25   USA.
  26 ***/
  27
  28 typedef struct pa_source pa_source;
  29
  30 #include <inttypes.h>
  31
  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/memblock.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
  46 #define PA_MAX_OUTPUTS_PER_SOURCE 32
  47
  48 typedef enum pa_source_state {
  49     PA_SOURCE_INIT,
  50     PA_SOURCE_RUNNING,
  51     PA_SOURCE_SUSPENDED,
  52     PA_SOURCE_IDLE,
  53     PA_SOURCE_UNLINKED
  54 } pa_source_state_t;
  55
  56 static inline pa_bool_t PA_SOURCE_IS_OPENED(pa_source_state_t x) {
  57     return x == PA_SOURCE_RUNNING || x == PA_SOURCE_IDLE;
  58 }
  59
  60 static inline pa_bool_t PA_SOURCE_IS_LINKED(pa_source_state_t x) {
  61     return x == PA_SOURCE_RUNNING || x == PA_SOURCE_IDLE || x == PA_SOURCE_SUSPENDED;
  62 }
  63
  64 struct pa_source {
  65     pa_msgobject parent;
  66
  67     uint32_t index;
  68     pa_core *core;
  69     pa_source_state_t state;
  70     pa_source_flags_t flags;
  71
  72     char *name;
  73     char *driver;                             /* may be NULL */
  74     pa_proplist *proplist;
  75
  76     pa_module *module;                        /* may be NULL */
  77
  78     pa_sample_spec sample_spec;
  79     pa_channel_map channel_map;
  80
  81     pa_idxset *outputs;
  82     unsigned n_corked;
  83     pa_sink *monitor_of;                     /* may be NULL */
  84
  85     pa_cvolume volume;
  86     pa_bool_t muted;
  87     pa_bool_t refresh_volume;
  88     pa_bool_t refresh_muted;
  89
  90     pa_asyncmsgq *asyncmsgq;
  91     pa_rtpoll *rtpoll;
  92
  93     pa_memchunk silence;
  94
  95     pa_usec_t min_latency; /* we won't go below this latency setting */
  96     pa_usec_t max_latency; /* An upper limit for the latencies */
  97
  98     int (*set_state)(pa_source*source, pa_source_state_t state); /* may be NULL */
  99     int (*set_volume)(pa_source *s);         /* dito */
 100     int (*get_volume)(pa_source *s);         /* dito */
 101     int (*set_mute)(pa_source *s);           /* dito */
 102     int (*get_mute)(pa_source *s);           /* dito */
 103     void (*update_requested_latency)(pa_source *s); /* dito */
 104
 105     /* Contains copies of the above data so that the real-time worker
 106      * thread can work without access locking */
 107     struct {
 108         pa_source_state_t state;
 109         pa_hashmap *outputs;
 110         pa_cvolume soft_volume;
 111         pa_bool_t soft_muted;
 112
 113         pa_bool_t requested_latency_valid;
 114         size_t requested_latency;
 115
 116         /* Then number of bytes this source will be rewound for at
 117          * max */
 118         size_t max_rewind;
 119     } thread_info;
 120
 121     void *userdata;
 122 };
 123
 124 PA_DECLARE_CLASS(pa_source);
 125 #define PA_SOURCE(s) pa_source_cast(s)
 126
 127 typedef enum pa_source_message {
 128     PA_SOURCE_MESSAGE_ADD_OUTPUT,
 129     PA_SOURCE_MESSAGE_REMOVE_OUTPUT,
 130     PA_SOURCE_MESSAGE_GET_VOLUME,
 131     PA_SOURCE_MESSAGE_SET_VOLUME,
 132     PA_SOURCE_MESSAGE_GET_MUTE,
 133     PA_SOURCE_MESSAGE_SET_MUTE,
 134     PA_SOURCE_MESSAGE_GET_LATENCY,
 135     PA_SOURCE_MESSAGE_GET_REQUESTED_LATENCY,
 136     PA_SOURCE_MESSAGE_SET_STATE,
 137     PA_SOURCE_MESSAGE_ATTACH,
 138     PA_SOURCE_MESSAGE_DETACH,
 139     PA_SOURCE_MESSAGE_MAX
 140 } pa_source_message_t;
 141
 142 typedef struct pa_source_new_data {
 143     char *name;
 144     pa_bool_t namereg_fail;
 145     pa_proplist *proplist;
 146
 147     const char *driver;
 148     pa_module *module;
 149
 150     pa_sample_spec sample_spec;
 151     pa_bool_t sample_spec_is_set;
 152     pa_channel_map channel_map;
 153     pa_bool_t channel_map_is_set;
 154
 155     pa_cvolume volume;
 156     pa_bool_t volume_is_set;
 157     pa_bool_t muted;
 158     pa_bool_t muted_is_set;
 159 } pa_source_new_data;
 160
 161 pa_source_new_data* pa_source_new_data_init(pa_source_new_data *data);
 162 void pa_source_new_data_set_name(pa_source_new_data *data, const char *name);
 163 void pa_source_new_data_set_sample_spec(pa_source_new_data *data, const pa_sample_spec *spec);
 164 void pa_source_new_data_set_channel_map(pa_source_new_data *data, const pa_channel_map *map);
 165 void pa_source_new_data_set_volume(pa_source_new_data *data, const pa_cvolume *volume);
 166 void pa_source_new_data_set_muted(pa_source_new_data *data, pa_bool_t mute);
 167 void pa_source_new_data_done(pa_source_new_data *data);
 168
 169 /* To be called exclusively by the source driver, from main context */
 170
 171 pa_source* pa_source_new(
 172         pa_core *core,
 173         pa_source_new_data *data,
 174         pa_source_flags_t flags);
 175
 176 void pa_source_put(pa_source *s);
 177 void pa_source_unlink(pa_source *s);
 178
 179 void pa_source_set_description(pa_source *s, const char *description);
 180 void pa_source_set_asyncmsgq(pa_source *s, pa_asyncmsgq *q);
 181 void pa_source_set_rtpoll(pa_source *s, pa_rtpoll *p);
 182
 183 void pa_source_detach(pa_source *s);
 184 void pa_source_attach(pa_source *s);
 185
 186 /* May be called by everyone, from main context */
 187
 188 pa_usec_t pa_source_get_latency(pa_source *s);
 189 pa_usec_t pa_source_get_requested_latency(pa_source *s);
 190
 191 int pa_source_update_status(pa_source*s);
 192 int pa_source_suspend(pa_source *s, pa_bool_t suspend);
 193 int pa_source_suspend_all(pa_core *c, pa_bool_t suspend);
 194
 195 void pa_source_set_volume(pa_source *source, const pa_cvolume *volume);
 196 const pa_cvolume *pa_source_get_volume(pa_source *source);
 197 void pa_source_set_mute(pa_source *source, pa_bool_t mute);
 198 pa_bool_t pa_source_get_mute(pa_source *source);
 199
 200 unsigned pa_source_linked_by(pa_source *s); /* Number of connected streams */
 201 unsigned pa_source_used_by(pa_source *s); /* Number of connected streams that are not corked */
 202 #define pa_source_get_state(s) ((pa_source_state_t) (s)->state)
 203
 204 /* To be called exclusively by the source driver, from IO context */
 205
 206 void pa_source_post(pa_source*s, const pa_memchunk *b);
 207 void pa_source_process_rewind(pa_source *s, size_t nbytes);
 208
 209 int pa_source_process_msg(pa_msgobject *o, int code, void *userdata, int64_t, pa_memchunk *chunk);
 210
 211 void pa_source_attach_within_thread(pa_source *s);
 212 void pa_source_detach_within_thread(pa_source *s);
 213
 214 pa_usec_t pa_source_get_requested_latency_within_thread(pa_source *s);
 215
 216 void pa_source_set_max_rewind(pa_source *s, size_t max_rewind);
 217
 218 /* To be called exclusively by source output drivers, from IO context */
 219
 220 void pa_source_invalidate_requested_latency(pa_source *s);
 221
 222 #endif