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