src/pulsecore/source-output.h

   1 #ifndef foopulsesourceoutputhfoo
   2 #define foopulsesourceoutputhfoo
   3
   4 /* $Id$ */
   5
   6 /***
   7   This file is part of PulseAudio.
   8
   9   Copyright 2004-2006 Lennart Poettering
  10
  11   PulseAudio is free software; you can redistribute it and/or modify
  12   it under the terms of the GNU Lesser General Public License as published
  13   by the Free Software Foundation; either version 2 of the License,
  14   or (at your option) any later version.
  15
  16   PulseAudio is distributed in the hope that it will be useful, but
  17   WITHOUT ANY WARRANTY; without even the implied warranty of
  18   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  19   General Public License for more details.
  20
  21   You should have received a copy of the GNU Lesser General Public License
  22   along with PulseAudio; if not, write to the Free Software
  23   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  24   USA.
  25 ***/
  26
  27 #include <inttypes.h>
  28
  29 typedef struct pa_source_output pa_source_output;
  30
  31 #include <pulse/sample.h>
  32 #include <pulsecore/source.h>
  33 #include <pulsecore/memblockq.h>
  34 #include <pulsecore/resampler.h>
  35 #include <pulsecore/module.h>
  36 #include <pulsecore/client.h>
  37
  38 typedef enum pa_source_output_state {
  39     PA_SOURCE_OUTPUT_INIT,
  40     PA_SOURCE_OUTPUT_RUNNING,
  41     PA_SOURCE_OUTPUT_CORKED,
  42     PA_SOURCE_OUTPUT_UNLINKED
  43 } pa_source_output_state_t;
  44
  45 static inline pa_bool_t PA_SOURCE_OUTPUT_IS_LINKED(pa_source_output_state_t x) {
  46     return x == PA_SOURCE_OUTPUT_RUNNING || x == PA_SOURCE_OUTPUT_CORKED;
  47 }
  48
  49 typedef enum pa_source_output_flags {
  50     PA_SOURCE_OUTPUT_VARIABLE_RATE = 1,
  51     PA_SOURCE_OUTPUT_DONT_MOVE = 2,
  52     PA_SOURCE_OUTPUT_START_CORKED = 4,
  53     PA_SOURCE_OUTPUT_NO_REMAP = 8,
  54     PA_SOURCE_OUTPUT_NO_REMIX = 16,
  55     PA_SOURCE_OUTPUT_FIX_FORMAT = 32,
  56     PA_SOURCE_OUTPUT_FIX_RATE = 64,
  57     PA_SOURCE_OUTPUT_FIX_CHANNELS = 128
  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     pa_proplist *proplist;
  70     char *driver;                         /* may be NULL */
  71     pa_module *module;                    /* may be NULL */
  72     pa_client *client;                    /* may be NULL */
  73
  74     pa_source *source;
  75
  76     pa_sample_spec sample_spec;
  77     pa_channel_map channel_map;
  78
  79     pa_resample_method_t resample_method;
  80
  81     /* Pushes a new memchunk into the output. Called from IO thread
  82      * context. */
  83     void (*push)(pa_source_output *o, const pa_memchunk *chunk);
  84
  85     /* Only relevant for monitor sources right now: called when the
  86      * recorded stream is rewound. Called from IO context*/
  87     void (*process_rewind)(pa_source_output *o, size_t nbytes);
  88
  89     /* Called whenever the maximum rewindable size of the source
  90      * changes. Called from IO thread context. */
  91     void (*update_max_rewind) (pa_source_output *o, size_t nbytes); /* may be NULL */
  92
  93     /* If non-NULL this function is called when the output is first
  94      * connected to a source. Called from IO thread context */
  95     void (*attach) (pa_source_output *o);           /* may be NULL */
  96
  97     /* If non-NULL this function is called when the output is
  98      * disconnected from its source. Called from IO thread context */
  99     void (*detach) (pa_source_output *o);           /* may be NULL */
 100
 101     /* If non-NULL called whenever the the source this output is attached
 102      * to suspends or resumes. Called from main context */
 103     void (*suspend) (pa_source_output *o, pa_bool_t b);   /* may be NULL */
 104
 105     /* If non-NULL called whenever the the source this output is attached
 106      * to changes. Called from main context */
 107     void (*moved) (pa_source_output *o);   /* may be NULL */
 108
 109     /* Supposed to unlink and destroy this stream. Called from main
 110      * context. */
 111     void (*kill)(pa_source_output* o);              /* may be NULL */
 112
 113     /* Return the current latency (i.e. length of bufferd audio) of
 114     this stream. Called from main context. If NULL a
 115     PA_SOURCE_OUTPUT_MESSAGE_GET_LATENCY message is sent to the IO
 116     thread instead. */
 117     pa_usec_t (*get_latency) (pa_source_output *o); /* may be NULL */
 118
 119     /* If non_NULL this function is called from thread context if the
 120      * state changes. The old state is found in thread_info.state.  */
 121     void (*state_change) (pa_source_output *o, pa_source_output_state_t state); /* may be NULL */
 122
 123     struct {
 124         pa_source_output_state_t state;
 125
 126         pa_bool_t attached; /* True only between ->attach() and ->detach() calls */
 127
 128         pa_sample_spec sample_spec;
 129
 130         pa_resampler* resampler;              /* may be NULL */
 131
 132         /* We maintain a delay memblockq here for source outputs that
 133          * don't implement rewind() */
 134         pa_memblockq *delay_memblockq;
 135
 136         /* The requested latency for the source */
 137         pa_usec_t requested_source_latency;
 138     } thread_info;
 139
 140     void *userdata;
 141 };
 142
 143 PA_DECLARE_CLASS(pa_source_output);
 144 #define PA_SOURCE_OUTPUT(o) pa_source_output_cast(o)
 145
 146 enum {
 147     PA_SOURCE_OUTPUT_MESSAGE_GET_LATENCY,
 148     PA_SOURCE_OUTPUT_MESSAGE_SET_RATE,
 149     PA_SOURCE_OUTPUT_MESSAGE_SET_STATE,
 150     PA_SOURCE_OUTPUT_MESSAGE_SET_REQUESTED_LATENCY,
 151     PA_SOURCE_OUTPUT_MESSAGE_GET_REQUESTED_LATENCY,
 152     PA_SOURCE_OUTPUT_MESSAGE_MAX
 153 };
 154
 155 typedef struct pa_source_output_new_data {
 156     pa_proplist *proplist;
 157
 158     const char *driver;
 159     pa_module *module;
 160     pa_client *client;
 161
 162     pa_source *source;
 163
 164     pa_sample_spec sample_spec;
 165     pa_bool_t sample_spec_is_set;
 166     pa_channel_map channel_map;
 167     pa_bool_t channel_map_is_set;
 168
 169     pa_resample_method_t resample_method;
 170 } pa_source_output_new_data;
 171
 172 pa_source_output_new_data* pa_source_output_new_data_init(pa_source_output_new_data *data);
 173 void pa_source_output_new_data_set_sample_spec(pa_source_output_new_data *data, const pa_sample_spec *spec);
 174 void pa_source_output_new_data_set_channel_map(pa_source_output_new_data *data, const pa_channel_map *map);
 175 void pa_source_output_new_data_done(pa_source_output_new_data *data);
 176
 177 typedef struct pa_source_output_move_hook_data {
 178     pa_source_output *source_output;
 179     pa_source *destination;
 180 } pa_source_output_move_hook_data;
 181
 182 /* To be called by the implementing module only */
 183
 184 pa_source_output* pa_source_output_new(
 185         pa_core *core,
 186         pa_source_output_new_data *data,
 187         pa_source_output_flags_t flags);
 188
 189 void pa_source_output_put(pa_source_output *o);
 190 void pa_source_output_unlink(pa_source_output*o);
 191
 192 void pa_source_output_set_name(pa_source_output *i, const char *name);
 193
 194 pa_usec_t pa_source_output_set_requested_latency(pa_source_output *i, pa_usec_t usec);
 195
 196 void pa_source_output_cork(pa_source_output *i, pa_bool_t b);
 197
 198 int pa_source_output_set_rate(pa_source_output *o, uint32_t rate);
 199
 200 /* Callable by everyone */
 201
 202 /* External code may request disconnection with this funcion */
 203 void pa_source_output_kill(pa_source_output*o);
 204
 205 pa_usec_t pa_source_output_get_latency(pa_source_output *i);
 206
 207 pa_resample_method_t pa_source_output_get_resample_method(pa_source_output *o);
 208
 209 int pa_source_output_move_to(pa_source_output *o, pa_source *dest);
 210
 211 #define pa_source_output_get_state(o) ((o)->state)
 212
 213 pa_usec_t pa_source_output_get_requested_latency(pa_source_output *o);
 214
 215 /* To be used exclusively by the source driver thread */
 216
 217 void pa_source_output_push(pa_source_output *o, const pa_memchunk *chunk);
 218 void pa_source_output_process_rewind(pa_source_output *o, size_t nbytes);
 219 void pa_source_output_update_max_rewind(pa_source_output *o, size_t nbytes);
 220
 221 void pa_source_output_set_state_within_thread(pa_source_output *o, pa_source_output_state_t state);
 222
 223 int pa_source_output_process_msg(pa_msgobject *mo, int code, void *userdata, int64_t offset, pa_memchunk *chunk);
 224
 225 pa_usec_t pa_source_output_set_requested_latency_within_thread(pa_source_output *o, pa_usec_t usec);
 226
 227 #endif