code.delx.au - pulseaudio/blob - src/pulsecore/sink-input.h

   1 #ifndef foopulsesinkinputhfoo
   2 #define foopulsesinkinputhfoo
   3
   4 /* $Id$ */
   5
   6 /***
   7   This file is part of PulseAudio.
   8
   9   Copyright 2004-2006 Lennart Poettering
  10   Copyright 2006 Pierre Ossman <ossman@cendio.se> for Cendio AB
  11
  12   PulseAudio is free software; you can redistribute it and/or modify
  13   it under the terms of the GNU Lesser General Public License as published
  14   by the Free Software Foundation; either version 2 of the License,
  15   or (at your option) any later version.
  16
  17   PulseAudio is distributed in the hope that it will be useful, but
  18   WITHOUT ANY WARRANTY; without even the implied warranty of
  19   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  20   General Public License for more details.
  21
  22   You should have received a copy of the GNU Lesser General Public License
  23   along with PulseAudio; if not, write to the Free Software
  24   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  25   USA.
  26 ***/
  27
  28 #include <inttypes.h>
  29
  30 typedef struct pa_sink_input pa_sink_input;
  31
  32 #include <pulse/sample.h>
  33 #include <pulsecore/hook-list.h>
  34 #include <pulsecore/memblockq.h>
  35 #include <pulsecore/resampler.h>
  36 #include <pulsecore/module.h>
  37 #include <pulsecore/client.h>
  38 #include <pulsecore/sink.h>
  39 #include <pulsecore/core.h>
  40
  41 typedef enum pa_sink_input_state {
  42     PA_SINK_INPUT_INIT,         /*< The stream is not active yet, because pa_sink_put() has not been called yet */
  43     PA_SINK_INPUT_DRAINED,      /*< The stream stopped playing because there was no data to play */
  44     PA_SINK_INPUT_RUNNING,      /*< The stream is alive and kicking */
  45     PA_SINK_INPUT_CORKED,       /*< The stream was corked on user request */
  46     PA_SINK_INPUT_UNLINKED      /*< The stream is dead */
  47 } pa_sink_input_state_t;
  48
  49 static inline int PA_SINK_INPUT_LINKED(pa_sink_input_state_t x) {
  50     return x == PA_SINK_INPUT_DRAINED || x == PA_SINK_INPUT_RUNNING || x == PA_SINK_INPUT_CORKED;
  51 }
  52
  53 typedef enum pa_sink_input_flags {
  54     PA_SINK_INPUT_VARIABLE_RATE = 1,
  55     PA_SINK_INPUT_DONT_MOVE = 2,
  56     PA_SINK_INPUT_START_CORKED = 4
  57 } pa_sink_input_flags_t;
  58
  59 struct pa_sink_input {
  60     pa_msgobject parent;
  61
  62     uint32_t index;
  63     pa_core *core;
  64
  65     /* Please note that this state should only be read with
  66      * pa_sink_input_get_state(). That function will transparently
  67      * merge the thread_info.drained value in. */
  68     pa_sink_input_state_t state;
  69     pa_sink_input_flags_t flags;
  70
  71     char *name, *driver;                /* may be NULL */
  72     pa_module *module;                  /* may be NULL */
  73     pa_client *client;                  /* may be NULL */
  74
  75     pa_sink *sink;
  76
  77     pa_sample_spec sample_spec;
  78     pa_channel_map channel_map;
  79
  80     pa_sink_input *sync_prev, *sync_next;
  81
  82     pa_cvolume volume;
  83     int muted;
  84
  85     /* Returns the chunk of audio data (but doesn't drop it
  86      * yet!). Returns -1 on failure. Called from IO thread context. */
  87     int (*peek) (pa_sink_input *i, pa_memchunk *chunk);
  88
  89     /* Drops the specified number of bytes, usually called right after
  90      * peek(), but not necessarily. Called from IO thread context. */
  91     void (*drop) (pa_sink_input *i, size_t length);
  92
  93     /* If non-NULL this function is called when the input is first
  94      * connected to a sink or when the rtpoll/asyncmsgq fields
  95      * change. You usually don't need to implement this function
  96      * unless you rewrite a sink that is piggy-backed onto
  97      * another. Called from IO thread context */
  98     void (*attach) (pa_sink_input *i);           /* may be NULL */
  99
 100     /* If non-NULL this function is called when the output is
 101      * disconnected from its sink. Called from IO thread context */
 102     void (*detach) (pa_sink_input *i);           /* may be NULL */
 103
 104     /* If non-NULL called whenever the the sink this input is attached
 105      * to suspends or resumes. Called from main context */
 106     void (*suspend) (pa_sink_input *i, int b);   /* may be NULL */
 107
 108     /* Supposed to unlink and destroy this stream. Called from main
 109      * context. */
 110     void (*kill) (pa_sink_input *i);             /* may be NULL */
 111
 112     /* Return the current latency (i.e. length of bufferd audio) of
 113     this stream. Called from main context. If NULL a
 114     PA_SINK_INPUT_MESSAGE_GET_LATENCY message is sent to the IO thread
 115     instead. */
 116     pa_usec_t (*get_latency) (pa_sink_input *i); /* may be NULL */
 117
 118     pa_resample_method_t resample_method;
 119
 120     struct {
 121         pa_sink_input_state_t state;
 122         pa_atomic_t drained;
 123
 124         pa_sample_spec sample_spec;
 125
 126         pa_memchunk resampled_chunk;
 127         pa_resampler *resampler;                     /* may be NULL */
 128
 129         /* Some silence to play before the actual data. This is used to
 130          * compensate for latency differences when moving a sink input
 131          * "hot" between sinks. */
 132         size_t move_silence;
 133         pa_memblock *silence_memblock;               /* may be NULL */
 134
 135         pa_sink_input *sync_prev, *sync_next;
 136
 137         pa_cvolume volume;
 138         int muted;
 139     } thread_info;
 140
 141     void *userdata;
 142 };
 143
 144 PA_DECLARE_CLASS(pa_sink_input);
 145 #define PA_SINK_INPUT(o) pa_sink_input_cast(o)
 146
 147 enum {
 148     PA_SINK_INPUT_MESSAGE_SET_VOLUME,
 149     PA_SINK_INPUT_MESSAGE_SET_MUTE,
 150     PA_SINK_INPUT_MESSAGE_GET_LATENCY,
 151     PA_SINK_INPUT_MESSAGE_SET_RATE,
 152     PA_SINK_INPUT_MESSAGE_SET_STATE,
 153     PA_SINK_INPUT_MESSAGE_MAX
 154 };
 155
 156 typedef struct pa_sink_input_new_data {
 157     const char *name, *driver;
 158     pa_module *module;
 159     pa_client *client;
 160
 161     pa_sink *sink;
 162
 163     pa_sample_spec sample_spec;
 164     int sample_spec_is_set;
 165     pa_channel_map channel_map;
 166     int channel_map_is_set;
 167
 168     pa_cvolume volume;
 169     int volume_is_set;
 170     int muted;
 171     int muted_is_set;
 172
 173     pa_resample_method_t resample_method;
 174
 175     pa_sink_input *sync_base;
 176 } pa_sink_input_new_data;
 177
 178 pa_sink_input_new_data* pa_sink_input_new_data_init(pa_sink_input_new_data *data);
 179 void pa_sink_input_new_data_set_sample_spec(pa_sink_input_new_data *data, const pa_sample_spec *spec);
 180 void pa_sink_input_new_data_set_channel_map(pa_sink_input_new_data *data, const pa_channel_map *map);
 181 void pa_sink_input_new_data_set_volume(pa_sink_input_new_data *data, const pa_cvolume *volume);
 182 void pa_sink_input_new_data_set_muted(pa_sink_input_new_data *data, int mute);
 183
 184 /* To be called by the implementing module only */
 185
 186 pa_sink_input* pa_sink_input_new(
 187         pa_core *core,
 188         pa_sink_input_new_data *data,
 189         pa_sink_input_flags_t flags);
 190
 191 void pa_sink_input_put(pa_sink_input *i);
 192 void pa_sink_input_unlink(pa_sink_input* i);
 193
 194 void pa_sink_input_set_name(pa_sink_input *i, const char *name);
 195
 196 /* Callable by everyone */
 197
 198 /* External code may request disconnection with this function */
 199 void pa_sink_input_kill(pa_sink_input*i);
 200
 201 pa_usec_t pa_sink_input_get_latency(pa_sink_input *i);
 202
 203 void pa_sink_input_set_volume(pa_sink_input *i, const pa_cvolume *volume);
 204 const pa_cvolume *pa_sink_input_get_volume(pa_sink_input *i);
 205 void pa_sink_input_set_mute(pa_sink_input *i, int mute);
 206 int pa_sink_input_get_mute(pa_sink_input *i);
 207
 208 void pa_sink_input_cork(pa_sink_input *i, int b);
 209
 210 int pa_sink_input_set_rate(pa_sink_input *i, uint32_t rate);
 211
 212 pa_resample_method_t pa_sink_input_get_resample_method(pa_sink_input *i);
 213
 214 int pa_sink_input_move_to(pa_sink_input *i, pa_sink *dest, int immediately);
 215
 216 pa_sink_input_state_t pa_sink_input_get_state(pa_sink_input *i);
 217
 218 /* To be used exclusively by the sink driver thread */
 219
 220 int pa_sink_input_peek(pa_sink_input *i, pa_memchunk *chunk, pa_cvolume *volume);
 221 void pa_sink_input_drop(pa_sink_input *i, size_t length);
 222 int pa_sink_input_process_msg(pa_msgobject *o, int code, void *userdata, int64_t offset, pa_memchunk *chunk);
 223
 224 typedef struct pa_sink_input_move_info {
 225     pa_sink_input *sink_input;
 226     pa_sink_input *ghost_sink_input;
 227     pa_memblockq *buffer;
 228     size_t buffer_bytes;
 229 } pa_sink_input_move_info;
 230
 231 #endif