src/pulsecore/source-output.h

   1 #ifndef foopulsesourceoutputhfoo
   2 #define foopulsesourceoutputhfoo
   3
   4 /***
   5   This file is part of PulseAudio.
   6
   7   Copyright 2004-2006 Lennart Poettering
   8
   9   PulseAudio is free software; you can redistribute it and/or modify
  10   it under the terms of the GNU Lesser General Public License as published
  11   by the Free Software Foundation; either version 2 of the License,
  12   or (at your option) any later version.
  13
  14   PulseAudio is distributed in the hope that it will be useful, but
  15   WITHOUT ANY WARRANTY; without even the implied warranty of
  16   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  17   General Public License for more details.
  18
  19   You should have received a copy of the GNU Lesser General Public License
  20   along with PulseAudio; if not, write to the Free Software
  21   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  22   USA.
  23 ***/
  24
  25 #include <inttypes.h>
  26
  27 typedef struct pa_source_output pa_source_output;
  28
  29 #include <pulse/sample.h>
  30 #include <pulsecore/source.h>
  31 #include <pulsecore/memblockq.h>
  32 #include <pulsecore/resampler.h>
  33 #include <pulsecore/module.h>
  34 #include <pulsecore/client.h>
  35 #include <pulsecore/sink-input.h>
  36
  37 typedef enum pa_source_output_state {
  38     PA_SOURCE_OUTPUT_INIT,
  39     PA_SOURCE_OUTPUT_RUNNING,
  40     PA_SOURCE_OUTPUT_CORKED,
  41     PA_SOURCE_OUTPUT_UNLINKED
  42 } pa_source_output_state_t;
  43
  44 static inline pa_bool_t PA_SOURCE_OUTPUT_IS_LINKED(pa_source_output_state_t x) {
  45     return x == PA_SOURCE_OUTPUT_RUNNING || x == PA_SOURCE_OUTPUT_CORKED;
  46 }
  47
  48 typedef enum pa_source_output_flags {
  49     PA_SOURCE_OUTPUT_VARIABLE_RATE = 1,
  50     PA_SOURCE_OUTPUT_DONT_MOVE = 2,
  51     PA_SOURCE_OUTPUT_START_CORKED = 4,
  52     PA_SOURCE_OUTPUT_NO_REMAP = 8,
  53     PA_SOURCE_OUTPUT_NO_REMIX = 16,
  54     PA_SOURCE_OUTPUT_FIX_FORMAT = 32,
  55     PA_SOURCE_OUTPUT_FIX_RATE = 64,
  56     PA_SOURCE_OUTPUT_FIX_CHANNELS = 128,
  57     PA_SOURCE_OUTPUT_DONT_INHIBIT_AUTO_SUSPEND = 256,
  58     PA_SOURCE_OUTPUT_FAIL_ON_SUSPEND = 512
  59 } pa_source_output_flags_t;
  60
  61 struct pa_source_output {
  62     pa_msgobject parent;
  63
  64     uint32_t index;
  65     pa_core *core;
  66
  67     pa_source_output_state_t state;
  68     pa_source_output_flags_t flags;
  69
  70     char *driver;                         /* may be NULL */
  71     pa_proplist *proplist;
  72
  73     pa_module *module;                    /* may be NULL */
  74     pa_client *client;                    /* may be NULL */
  75
  76     pa_source *source; /* NULL while being moved */
  77
  78     /* A source output can monitor just a single input of a sink, in which case we find it here */
  79     pa_sink_input *direct_on_input;       /* may be NULL */
  80
  81     pa_sample_spec sample_spec;
  82     pa_channel_map channel_map;
  83
  84     /* if TRUE then the source we are connected to is worth
  85      * remembering, i.e. was explicitly chosen by the user and not
  86      * automatically. module-stream-restore looks for this.*/
  87     pa_bool_t save_source:1;
  88
  89     pa_resample_method_t requested_resample_method, actual_resample_method;
  90
  91     /* Pushes a new memchunk into the output. Called from IO thread
  92      * context. */
  93     void (*push)(pa_source_output *o, const pa_memchunk *chunk); /* may NOT be NULL */
  94
  95     /* Only relevant for monitor sources right now: called when the
  96      * recorded stream is rewound. Called from IO context */
  97     void (*process_rewind)(pa_source_output *o, size_t nbytes); /* may be NULL */
  98
  99     /* Called whenever the maximum rewindable size of the source
 100      * changes. Called from IO thread context. */
 101     void (*update_max_rewind) (pa_source_output *o, size_t nbytes); /* may be NULL */
 102
 103     /* Called whenever the configured latency of the source
 104      * changes. Called from IO context. */
 105     void (*update_source_requested_latency) (pa_source_output *o); /* may be NULL */
 106
 107     /* Called whenver the latency range of the source changes. Called
 108      * from IO context. */
 109     void (*update_source_latency_range) (pa_source_output *o); /* may be NULL */
 110
 111     /* If non-NULL this function is called when the output is first
 112      * connected to a source. Called from IO thread context */
 113     void (*attach) (pa_source_output *o);           /* may be NULL */
 114
 115     /* If non-NULL this function is called when the output is
 116      * disconnected from its source. Called from IO thread context */
 117     void (*detach) (pa_source_output *o);           /* may be NULL */
 118
 119     /* If non-NULL called whenever the the source this output is attached
 120      * to suspends or resumes. Called from main context */
 121     void (*suspend) (pa_source_output *o, pa_bool_t b);   /* may be NULL */
 122
 123     /* If non-NULL called whenever the the source this output is attached
 124      * to changes. Called from main context */
 125     void (*moved) (pa_source_output *o);   /* may be NULL */
 126
 127     /* Supposed to unlink and destroy this stream. Called from main
 128      * context. */
 129     void (*kill)(pa_source_output* o);              /* may NOT be NULL */
 130
 131     /* Return the current latency (i.e. length of bufferd audio) of
 132     this stream. Called from main context. This is added to what the
 133     PA_SOURCE_OUTPUT_MESSAGE_GET_LATENCY message sent to the IO thread
 134     returns */
 135     pa_usec_t (*get_latency) (pa_source_output *o); /* may be NULL */
 136
 137     /* If non-NULL this function is called from thread context if the
 138      * state changes. The old state is found in thread_info.state.  */
 139     void (*state_change) (pa_source_output *o, pa_source_output_state_t state); /* may be NULL */
 140
 141     /* If non-NULL this function is called before this source output
 142      * is moved to a source and if it returns FALSE the move
 143      * will not be allowed */
 144     pa_bool_t (*may_move_to) (pa_source_output *o, pa_source *s); /* may be NULL */
 145
 146     /* If non-NULL this function is used to dispatch asynchronous
 147      * control events. */
 148     void (*send_event)(pa_source_output *o, const char *event, pa_proplist* data);
 149
 150     struct {
 151         pa_source_output_state_t state;
 152
 153         pa_bool_t attached:1; /* True only between ->attach() and ->detach() calls */
 154
 155         pa_sample_spec sample_spec;
 156
 157         pa_resampler* resampler;              /* may be NULL */
 158
 159         /* We maintain a delay memblockq here for source outputs that
 160          * don't implement rewind() */
 161         pa_memblockq *delay_memblockq;
 162
 163         /* The requested latency for the source */
 164         pa_usec_t requested_source_latency;
 165
 166         pa_sink_input *direct_on_input;       /* may be NULL */
 167     } thread_info;
 168
 169     void *userdata;
 170 };
 171
 172 PA_DECLARE_CLASS(pa_source_output);
 173 #define PA_SOURCE_OUTPUT(o) pa_source_output_cast(o)
 174
 175 enum {
 176     PA_SOURCE_OUTPUT_MESSAGE_GET_LATENCY,
 177     PA_SOURCE_OUTPUT_MESSAGE_SET_RATE,
 178     PA_SOURCE_OUTPUT_MESSAGE_SET_STATE,
 179     PA_SOURCE_OUTPUT_MESSAGE_SET_REQUESTED_LATENCY,
 180     PA_SOURCE_OUTPUT_MESSAGE_GET_REQUESTED_LATENCY,
 181     PA_SOURCE_OUTPUT_MESSAGE_MAX
 182 };
 183
 184 typedef struct pa_source_output_send_event_hook_data {
 185     pa_source_output *source_output;
 186     const char *event;
 187     pa_proplist *data;
 188 } pa_source_output_send_event_hook_data;
 189
 190 typedef struct pa_source_output_new_data {
 191     pa_proplist *proplist;
 192     pa_sink_input *direct_on_input;
 193
 194     const char *driver;
 195     pa_module *module;
 196     pa_client *client;
 197
 198     pa_source *source;
 199
 200     pa_resample_method_t resample_method;
 201
 202     pa_sample_spec sample_spec;
 203     pa_channel_map channel_map;
 204
 205     pa_bool_t sample_spec_is_set:1;
 206     pa_bool_t channel_map_is_set:1;
 207
 208     pa_bool_t save_source:1;
 209 } pa_source_output_new_data;
 210
 211 pa_source_output_new_data* pa_source_output_new_data_init(pa_source_output_new_data *data);
 212 void pa_source_output_new_data_set_sample_spec(pa_source_output_new_data *data, const pa_sample_spec *spec);
 213 void pa_source_output_new_data_set_channel_map(pa_source_output_new_data *data, const pa_channel_map *map);
 214 void pa_source_output_new_data_done(pa_source_output_new_data *data);
 215
 216 /* To be called by the implementing module only */
 217
 218 int pa_source_output_new(
 219         pa_source_output**o,
 220         pa_core *core,
 221         pa_source_output_new_data *data,
 222         pa_source_output_flags_t flags);
 223
 224 void pa_source_output_put(pa_source_output *o);
 225 void pa_source_output_unlink(pa_source_output*o);
 226
 227 void pa_source_output_set_name(pa_source_output *o, const char *name);
 228
 229 pa_usec_t pa_source_output_set_requested_latency(pa_source_output *o, pa_usec_t usec);
 230
 231 void pa_source_output_cork(pa_source_output *o, pa_bool_t b);
 232
 233 int pa_source_output_set_rate(pa_source_output *o, uint32_t rate);
 234
 235 /* Callable by everyone */
 236
 237 /* External code may request disconnection with this funcion */
 238 void pa_source_output_kill(pa_source_output*o);
 239
 240 pa_usec_t pa_source_output_get_latency(pa_source_output *o, pa_usec_t *source_latency);
 241
 242 void pa_source_output_update_proplist(pa_source_output *o, pa_update_mode_t mode, pa_proplist *p);
 243
 244 pa_resample_method_t pa_source_output_get_resample_method(pa_source_output *o);
 245
 246 void pa_source_output_send_event(pa_source_output *o, const char *name, pa_proplist *data);
 247
 248 pa_bool_t pa_source_output_may_move(pa_source_output *o);
 249 pa_bool_t pa_source_output_may_move_to(pa_source_output *o, pa_source *dest);
 250 int pa_source_output_move_to(pa_source_output *o, pa_source *dest, pa_bool_t save);
 251
 252 /* The same as pa_source_output_move_to() but in two seperate steps,
 253  * first the detaching from the old source, then the attaching to the
 254  * new source */
 255 int pa_source_output_start_move(pa_source_output *o);
 256 int pa_source_output_finish_move(pa_source_output *o, pa_source *dest, pa_bool_t save);
 257
 258 #define pa_source_output_get_state(o) ((o)->state)
 259
 260 pa_usec_t pa_source_output_get_requested_latency(pa_source_output *o);
 261
 262 /* To be used exclusively by the source driver thread */
 263
 264 void pa_source_output_push(pa_source_output *o, const pa_memchunk *chunk);
 265 void pa_source_output_process_rewind(pa_source_output *o, size_t nbytes);
 266 void pa_source_output_update_max_rewind(pa_source_output *o, size_t nbytes);
 267
 268 void pa_source_output_set_state_within_thread(pa_source_output *o, pa_source_output_state_t state);
 269
 270 int pa_source_output_process_msg(pa_msgobject *mo, int code, void *userdata, int64_t offset, pa_memchunk *chunk);
 271
 272 pa_usec_t pa_source_output_set_requested_latency_within_thread(pa_source_output *o, pa_usec_t usec);
 273
 274 #endif