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