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