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