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.1 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_NO_CREATE_ON_SUSPEND = 512,
  59     PA_SOURCE_OUTPUT_KILL_ON_SUSPEND = 1024
  60 } pa_source_output_flags_t;
  61
  62 struct pa_source_output {
  63     pa_msgobject parent;
  64
  65     uint32_t index;
  66     pa_core *core;
  67
  68     pa_source_output_state_t state;
  69     pa_source_output_flags_t flags;
  70
  71     char *driver;                         /* may be NULL */
  72     pa_proplist *proplist;
  73
  74     pa_module *module;                    /* may be NULL */
  75     pa_client *client;                    /* may be NULL */
  76
  77     pa_source *source; /* NULL while being moved */
  78
  79     /* A source output can monitor just a single input of a sink, in which case we find it here */
  80     pa_sink_input *direct_on_input;       /* may be NULL */
  81
  82     pa_sample_spec sample_spec;
  83     pa_channel_map channel_map;
  84
  85     /* if TRUE then the source we are connected to is worth
  86      * remembering, i.e. was explicitly chosen by the user and not
  87      * automatically. module-stream-restore looks for this.*/
  88     pa_bool_t save_source:1;
  89
  90     pa_resample_method_t requested_resample_method, actual_resample_method;
  91
  92     /* Pushes a new memchunk into the output. Called from IO thread
  93      * context. */
  94     void (*push)(pa_source_output *o, const pa_memchunk *chunk); /* may NOT be NULL */
  95
  96     /* Only relevant for monitor sources right now: called when the
  97      * recorded stream is rewound. Called from IO context */
  98     void (*process_rewind)(pa_source_output *o, size_t nbytes); /* may be NULL */
  99
 100     /* Called whenever the maximum rewindable size of the source
 101      * changes. Called from IO thread context. */
 102     void (*update_max_rewind) (pa_source_output *o, size_t nbytes); /* may be NULL */
 103
 104     /* Called whenever the configured latency of the source
 105      * changes. Called from IO context. */
 106     void (*update_source_requested_latency) (pa_source_output *o); /* may be NULL */
 107
 108     /* Called whenver the latency range of the source changes. Called
 109      * from IO context. */
 110     void (*update_source_latency_range) (pa_source_output *o); /* may be NULL */
 111
 112     /* Called whenver the fixed latency of the source changes, if there
 113      * is one. Called from IO context. */
 114     void (*update_source_fixed_latency) (pa_source_output *i); /* may be NULL */
 115
 116     /* If non-NULL this function is called when the output is first
 117      * connected to a source. Called from IO thread context */
 118     void (*attach) (pa_source_output *o);           /* may be NULL */
 119
 120     /* If non-NULL this function is called when the output is
 121      * disconnected from its source. Called from IO thread context */
 122     void (*detach) (pa_source_output *o);           /* may be NULL */
 123
 124     /* If non-NULL called whenever the source this output is attached
 125      * to suspends or resumes. Called from main context */
 126     void (*suspend) (pa_source_output *o, pa_bool_t b);   /* may be NULL */
 127
 128     /* If non-NULL called whenever the source this output is attached
 129      * to suspends or resumes. Called from IO context */
 130     void (*suspend_within_thread) (pa_source_output *o, pa_bool_t b);   /* may be NULL */
 131
 132     /* If non-NULL called whenever the source output is moved to a new
 133      * source. Called from main context after the stream was detached
 134      * from the old source and before it is attached to the new
 135      * source. If dest is NULL the move was executed in two
 136      * phases and the second one failed; the stream will be destroyed
 137      * after this call. */
 138     void (*moving) (pa_source_output *o, pa_source *dest);   /* may be NULL */
 139
 140     /* Supposed to unlink and destroy this stream. Called from main
 141      * context. */
 142     void (*kill)(pa_source_output* o);              /* may NOT be NULL */
 143
 144     /* Return the current latency (i.e. length of bufferd audio) of
 145     this stream. Called from main context. This is added to what the
 146     PA_SOURCE_OUTPUT_MESSAGE_GET_LATENCY message sent to the IO thread
 147     returns */
 148     pa_usec_t (*get_latency) (pa_source_output *o); /* may be NULL */
 149
 150     /* If non-NULL this function is called from thread context if the
 151      * state changes. The old state is found in thread_info.state.  */
 152     void (*state_change) (pa_source_output *o, pa_source_output_state_t state); /* may be NULL */
 153
 154     /* If non-NULL this function is called before this source output
 155      * is moved to a source and if it returns FALSE the move
 156      * will not be allowed */
 157     pa_bool_t (*may_move_to) (pa_source_output *o, pa_source *s); /* may be NULL */
 158
 159     /* If non-NULL this function is used to dispatch asynchronous
 160      * control events. */
 161     void (*send_event)(pa_source_output *o, const char *event, pa_proplist* data);
 162
 163     struct {
 164         pa_source_output_state_t state;
 165
 166         pa_bool_t attached:1; /* True only between ->attach() and ->detach() calls */
 167
 168         pa_sample_spec sample_spec;
 169
 170         pa_resampler* resampler;              /* may be NULL */
 171
 172         /* We maintain a delay memblockq here for source outputs that
 173          * don't implement rewind() */
 174         pa_memblockq *delay_memblockq;
 175
 176         /* The requested latency for the source */
 177         pa_usec_t requested_source_latency;
 178
 179         pa_sink_input *direct_on_input;       /* may be NULL */
 180     } thread_info;
 181
 182     void *userdata;
 183 };
 184
 185 PA_DECLARE_PUBLIC_CLASS(pa_source_output);
 186 #define PA_SOURCE_OUTPUT(o) pa_source_output_cast(o)
 187
 188 enum {
 189     PA_SOURCE_OUTPUT_MESSAGE_GET_LATENCY,
 190     PA_SOURCE_OUTPUT_MESSAGE_SET_RATE,
 191     PA_SOURCE_OUTPUT_MESSAGE_SET_STATE,
 192     PA_SOURCE_OUTPUT_MESSAGE_SET_REQUESTED_LATENCY,
 193     PA_SOURCE_OUTPUT_MESSAGE_GET_REQUESTED_LATENCY,
 194     PA_SOURCE_OUTPUT_MESSAGE_MAX
 195 };
 196
 197 typedef struct pa_source_output_send_event_hook_data {
 198     pa_source_output *source_output;
 199     const char *event;
 200     pa_proplist *data;
 201 } pa_source_output_send_event_hook_data;
 202
 203 typedef struct pa_source_output_new_data {
 204     pa_proplist *proplist;
 205     pa_sink_input *direct_on_input;
 206
 207     const char *driver;
 208     pa_module *module;
 209     pa_client *client;
 210
 211     pa_source *source;
 212
 213     pa_resample_method_t resample_method;
 214
 215     pa_sample_spec sample_spec;
 216     pa_channel_map channel_map;
 217
 218     pa_bool_t sample_spec_is_set:1;
 219     pa_bool_t channel_map_is_set:1;
 220
 221     pa_bool_t save_source:1;
 222 } pa_source_output_new_data;
 223
 224 pa_source_output_new_data* pa_source_output_new_data_init(pa_source_output_new_data *data);
 225 void pa_source_output_new_data_set_sample_spec(pa_source_output_new_data *data, const pa_sample_spec *spec);
 226 void pa_source_output_new_data_set_channel_map(pa_source_output_new_data *data, const pa_channel_map *map);
 227 void pa_source_output_new_data_done(pa_source_output_new_data *data);
 228
 229 /* To be called by the implementing module only */
 230
 231 int pa_source_output_new(
 232         pa_source_output**o,
 233         pa_core *core,
 234         pa_source_output_new_data *data,
 235         pa_source_output_flags_t flags);
 236
 237 void pa_source_output_put(pa_source_output *o);
 238 void pa_source_output_unlink(pa_source_output*o);
 239
 240 void pa_source_output_set_name(pa_source_output *o, const char *name);
 241
 242 pa_usec_t pa_source_output_set_requested_latency(pa_source_output *o, pa_usec_t usec);
 243
 244 void pa_source_output_cork(pa_source_output *o, pa_bool_t b);
 245
 246 int pa_source_output_set_rate(pa_source_output *o, uint32_t rate);
 247
 248 size_t pa_source_output_get_max_rewind(pa_source_output *o);
 249
 250 /* Callable by everyone */
 251
 252 /* External code may request disconnection with this funcion */
 253 void pa_source_output_kill(pa_source_output*o);
 254
 255 pa_usec_t pa_source_output_get_latency(pa_source_output *o, pa_usec_t *source_latency);
 256
 257 void pa_source_output_update_proplist(pa_source_output *o, pa_update_mode_t mode, pa_proplist *p);
 258
 259 pa_resample_method_t pa_source_output_get_resample_method(pa_source_output *o);
 260
 261 void pa_source_output_send_event(pa_source_output *o, const char *name, pa_proplist *data);
 262
 263 pa_bool_t pa_source_output_may_move(pa_source_output *o);
 264 pa_bool_t pa_source_output_may_move_to(pa_source_output *o, pa_source *dest);
 265 int pa_source_output_move_to(pa_source_output *o, pa_source *dest, pa_bool_t save);
 266
 267 /* The same as pa_source_output_move_to() but in two seperate steps,
 268  * first the detaching from the old source, then the attaching to the
 269  * new source */
 270 int pa_source_output_start_move(pa_source_output *o);
 271 int pa_source_output_finish_move(pa_source_output *o, pa_source *dest, pa_bool_t save);
 272 void pa_source_output_fail_move(pa_source_output *o);
 273
 274 #define pa_source_output_get_state(o) ((o)->state)
 275
 276 pa_usec_t pa_source_output_get_requested_latency(pa_source_output *o);
 277
 278 /* To be used exclusively by the source driver thread */
 279
 280 void pa_source_output_push(pa_source_output *o, const pa_memchunk *chunk);
 281 void pa_source_output_process_rewind(pa_source_output *o, size_t nbytes);
 282 void pa_source_output_update_max_rewind(pa_source_output *o, size_t nbytes);
 283
 284 void pa_source_output_set_state_within_thread(pa_source_output *o, pa_source_output_state_t state);
 285
 286 int pa_source_output_process_msg(pa_msgobject *mo, int code, void *userdata, int64_t offset, pa_memchunk *chunk);
 287
 288 pa_usec_t pa_source_output_set_requested_latency_within_thread(pa_source_output *o, pa_usec_t usec);
 289
 290 #define pa_source_output_assert_io_context(s) \
 291     pa_assert(pa_thread_mq_get() || !PA_SOURCE_OUTPUT_IS_LINKED((s)->state))
 292
 293 #endif