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. 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_sample_spec sample_spec;
 129
 130         pa_memchunk resampled_chunk;
 131         pa_resampler *resampler;                     /* may be NULL */
 132
 133         /* Some silence to play before the actual data. This is used to
 134          * compensate for latency differences when moving a sink input
 135          * "hot" between sinks. */
 136         size_t move_silence;
 137         pa_memblock *silence_memblock;               /* may be NULL */
 138
 139         pa_sink_input *sync_prev, *sync_next;
 140
 141         pa_cvolume volume;
 142         int muted;
 143     } thread_info;
 144
 145     void *userdata;
 146 };
 147
 148 PA_DECLARE_CLASS(pa_sink_input);
 149 #define PA_SINK_INPUT(o) pa_sink_input_cast(o)
 150
 151 enum {
 152     PA_SINK_INPUT_MESSAGE_SET_VOLUME,
 153     PA_SINK_INPUT_MESSAGE_SET_MUTE,
 154     PA_SINK_INPUT_MESSAGE_GET_LATENCY,
 155     PA_SINK_INPUT_MESSAGE_SET_RATE,
 156     PA_SINK_INPUT_MESSAGE_SET_STATE,
 157     PA_SINK_INPUT_MESSAGE_MAX
 158 };
 159
 160 typedef struct pa_sink_input_new_data {
 161     const char *name, *driver;
 162     pa_module *module;
 163     pa_client *client;
 164
 165     pa_sink *sink;
 166
 167     pa_sample_spec sample_spec;
 168     int sample_spec_is_set;
 169     pa_channel_map channel_map;
 170     int channel_map_is_set;
 171
 172     pa_cvolume volume;
 173     int volume_is_set;
 174     int muted;
 175     int muted_is_set;
 176
 177     pa_resample_method_t resample_method;
 178
 179     pa_sink_input *sync_base;
 180 } pa_sink_input_new_data;
 181
 182 pa_sink_input_new_data* pa_sink_input_new_data_init(pa_sink_input_new_data *data);
 183 void pa_sink_input_new_data_set_sample_spec(pa_sink_input_new_data *data, const pa_sample_spec *spec);
 184 void pa_sink_input_new_data_set_channel_map(pa_sink_input_new_data *data, const pa_channel_map *map);
 185 void pa_sink_input_new_data_set_volume(pa_sink_input_new_data *data, const pa_cvolume *volume);
 186 void pa_sink_input_new_data_set_muted(pa_sink_input_new_data *data, int mute);
 187
 188 /* To be called by the implementing module only */
 189
 190 pa_sink_input* pa_sink_input_new(
 191         pa_core *core,
 192         pa_sink_input_new_data *data,
 193         pa_sink_input_flags_t flags);
 194
 195 void pa_sink_input_put(pa_sink_input *i);
 196 void pa_sink_input_unlink(pa_sink_input* i);
 197
 198 void pa_sink_input_set_name(pa_sink_input *i, const char *name);
 199
 200 /* Callable by everyone */
 201
 202 /* External code may request disconnection with this function */
 203 void pa_sink_input_kill(pa_sink_input*i);
 204
 205 pa_usec_t pa_sink_input_get_latency(pa_sink_input *i);
 206
 207 void pa_sink_input_set_volume(pa_sink_input *i, const pa_cvolume *volume);
 208 const pa_cvolume *pa_sink_input_get_volume(pa_sink_input *i);
 209 void pa_sink_input_set_mute(pa_sink_input *i, int mute);
 210 int pa_sink_input_get_mute(pa_sink_input *i);
 211
 212 void pa_sink_input_cork(pa_sink_input *i, int b);
 213
 214 int pa_sink_input_set_rate(pa_sink_input *i, uint32_t rate);
 215
 216 pa_resample_method_t pa_sink_input_get_resample_method(pa_sink_input *i);
 217
 218 int pa_sink_input_move_to(pa_sink_input *i, pa_sink *dest, int immediately);
 219
 220 pa_sink_input_state_t pa_sink_input_get_state(pa_sink_input *i);
 221
 222 /* To be used exclusively by the sink driver thread */
 223
 224 int pa_sink_input_peek(pa_sink_input *i, size_t length, pa_memchunk *chunk, pa_cvolume *volume);
 225 void pa_sink_input_drop(pa_sink_input *i, size_t length);
 226 int pa_sink_input_process_msg(pa_msgobject *o, int code, void *userdata, int64_t offset, pa_memchunk *chunk);
 227
 228 typedef struct pa_sink_input_move_info {
 229     pa_sink_input *sink_input;
 230     pa_sink_input *ghost_sink_input;
 231     pa_memblockq *buffer;
 232     size_t buffer_bytes;
 233 } pa_sink_input_move_info;
 234
 235 #endif