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