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 pa_bool_t 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     pa_bool_t 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. If
  87      * data needs to be generated from scratch then please in the
  88      * specified length. This is an optimization only. If less data is
  89      * available, it's fine to return a smaller block. If more data is
  90      * already ready, it is better to return the full block.*/
  91     int (*peek) (pa_sink_input *i, size_t length, pa_memchunk *chunk);
  92
  93     /* Drops the specified number of bytes, usually called right after
  94      * peek(), but not necessarily. Called from IO thread context. */
  95     void (*drop) (pa_sink_input *i, size_t length);
  96
  97     /* If non-NULL this function is called when the input is first
  98      * connected to a sink or when the rtpoll/asyncmsgq fields
  99      * change. You usually don't need to implement this function
 100      * unless you rewrite a sink that is piggy-backed onto
 101      * another. Called from IO thread context */
 102     void (*attach) (pa_sink_input *i);           /* may be NULL */
 103
 104     /* If non-NULL this function is called when the output is
 105      * disconnected from its sink. Called from IO thread context */
 106     void (*detach) (pa_sink_input *i);           /* may be NULL */
 107
 108     /* If non-NULL called whenever the the sink this input is attached
 109      * to suspends or resumes. Called from main context */
 110     void (*suspend) (pa_sink_input *i, int b);   /* may be NULL */
 111
 112     /* Supposed to unlink and destroy this stream. Called from main
 113      * context. */
 114     void (*kill) (pa_sink_input *i);             /* 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_SINK_INPUT_MESSAGE_GET_LATENCY message is sent to the IO thread
 119     instead. */
 120     pa_usec_t (*get_latency) (pa_sink_input *i); /* may be NULL */
 121
 122     pa_resample_method_t resample_method;
 123
 124     struct {
 125         pa_sink_input_state_t state;
 126         pa_atomic_t drained;
 127
 128         pa_bool_t attached; /* True only between ->attach() and ->detach() calls */
 129
 130         pa_sample_spec sample_spec;
 131
 132         pa_memchunk resampled_chunk;
 133         pa_resampler *resampler;                     /* may be NULL */
 134
 135         /* Some silence to play before the actual data. This is used to
 136          * compensate for latency differences when moving a sink input
 137          * "hot" between sinks. */
 138         size_t move_silence;
 139         pa_memblock *silence_memblock;               /* may be NULL */
 140
 141         pa_sink_input *sync_prev, *sync_next;
 142
 143         pa_cvolume volume;
 144         pa_bool_t muted;
 145     } thread_info;
 146
 147     void *userdata;
 148 };
 149
 150 PA_DECLARE_CLASS(pa_sink_input);
 151 #define PA_SINK_INPUT(o) pa_sink_input_cast(o)
 152
 153 enum {
 154     PA_SINK_INPUT_MESSAGE_SET_VOLUME,
 155     PA_SINK_INPUT_MESSAGE_SET_MUTE,
 156     PA_SINK_INPUT_MESSAGE_GET_LATENCY,
 157     PA_SINK_INPUT_MESSAGE_SET_RATE,
 158     PA_SINK_INPUT_MESSAGE_SET_STATE,
 159     PA_SINK_INPUT_MESSAGE_MAX
 160 };
 161
 162 typedef struct pa_sink_input_new_data {
 163     const char *name, *driver;
 164     pa_module *module;
 165     pa_client *client;
 166
 167     pa_sink *sink;
 168
 169     pa_sample_spec sample_spec;
 170     pa_bool_t sample_spec_is_set;
 171     pa_channel_map channel_map;
 172     pa_bool_t channel_map_is_set;
 173
 174     pa_cvolume volume;
 175     pa_bool_t volume_is_set;
 176     pa_bool_t muted;
 177     pa_bool_t muted_is_set;
 178
 179     pa_resample_method_t resample_method;
 180
 181     pa_sink_input *sync_base;
 182 } pa_sink_input_new_data;
 183
 184 pa_sink_input_new_data* pa_sink_input_new_data_init(pa_sink_input_new_data *data);
 185 void pa_sink_input_new_data_set_sample_spec(pa_sink_input_new_data *data, const pa_sample_spec *spec);
 186 void pa_sink_input_new_data_set_channel_map(pa_sink_input_new_data *data, const pa_channel_map *map);
 187 void pa_sink_input_new_data_set_volume(pa_sink_input_new_data *data, const pa_cvolume *volume);
 188 void pa_sink_input_new_data_set_muted(pa_sink_input_new_data *data, pa_bool_t mute);
 189
 190 /* To be called by the implementing module only */
 191
 192 pa_sink_input* pa_sink_input_new(
 193         pa_core *core,
 194         pa_sink_input_new_data *data,
 195         pa_sink_input_flags_t flags);
 196
 197 void pa_sink_input_put(pa_sink_input *i);
 198 void pa_sink_input_unlink(pa_sink_input* i);
 199
 200 void pa_sink_input_set_name(pa_sink_input *i, const char *name);
 201
 202 /* Callable by everyone */
 203
 204 /* External code may request disconnection with this function */
 205 void pa_sink_input_kill(pa_sink_input*i);
 206
 207 pa_usec_t pa_sink_input_get_latency(pa_sink_input *i);
 208
 209 void pa_sink_input_set_volume(pa_sink_input *i, const pa_cvolume *volume);
 210 const pa_cvolume *pa_sink_input_get_volume(pa_sink_input *i);
 211 void pa_sink_input_set_mute(pa_sink_input *i, pa_bool_t mute);
 212 int pa_sink_input_get_mute(pa_sink_input *i);
 213
 214 void pa_sink_input_cork(pa_sink_input *i, pa_bool_t b);
 215
 216 int pa_sink_input_set_rate(pa_sink_input *i, uint32_t rate);
 217
 218 pa_resample_method_t pa_sink_input_get_resample_method(pa_sink_input *i);
 219
 220 int pa_sink_input_move_to(pa_sink_input *i, pa_sink *dest, int immediately);
 221
 222 pa_sink_input_state_t pa_sink_input_get_state(pa_sink_input *i);
 223
 224 /* To be used exclusively by the sink driver thread */
 225
 226 int pa_sink_input_peek(pa_sink_input *i, size_t length, pa_memchunk *chunk, pa_cvolume *volume);
 227 void pa_sink_input_drop(pa_sink_input *i, size_t length);
 228 int pa_sink_input_process_msg(pa_msgobject *o, int code, void *userdata, int64_t offset, pa_memchunk *chunk);
 229
 230 typedef struct pa_sink_input_move_info {
 231     pa_sink_input *sink_input;
 232     pa_sink_input *ghost_sink_input;
 233     pa_memblockq *buffer;
 234     size_t buffer_bytes;
 235 } pa_sink_input_move_info;
 236
 237 #endif