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_DRAINED,      /*< The stream stopped playing because there was no data to play */
  43     PA_SINK_INPUT_RUNNING,      /*< The stream is alive and kicking */
  44     PA_SINK_INPUT_CORKED,       /*< The stream was corked on user request */
  45     PA_SINK_INPUT_DISCONNECTED  /*< The stream is dead */
  46 } pa_sink_input_state_t;
  47
  48 typedef enum pa_sink_input_flags {
  49     PA_SINK_INPUT_VARIABLE_RATE = 1,
  50     PA_SINK_INPUT_NO_HOOKS = 2
  51 } pa_sink_input_flags_t;
  52
  53 struct pa_sink_input {
  54     pa_msgobject parent;
  55
  56     uint32_t index;
  57     pa_core *core;
  58
  59     /* Please note that this state should only be read with
  60      * pa_sink_input_get_state(). That function will transparently
  61      * merge the thread_info.drained value in. */
  62     pa_sink_input_state_t state;
  63     pa_sink_input_flags_t flags;
  64
  65     char *name, *driver;                /* may be NULL */
  66     pa_module *module;                  /* may be NULL */
  67     pa_client *client;                  /* may be NULL */
  68
  69     pa_sink *sink;
  70
  71     pa_sample_spec sample_spec;
  72     pa_channel_map channel_map;
  73
  74     pa_sink_input *sync_prev, *sync_next;
  75
  76     pa_cvolume volume;
  77     int muted;
  78
  79     int (*peek) (pa_sink_input *i, pa_memchunk *chunk);
  80     void (*drop) (pa_sink_input *i, size_t length);
  81     void (*kill) (pa_sink_input *i);             /* may be NULL */
  82     pa_usec_t (*get_latency) (pa_sink_input *i); /* may be NULL */
  83     void (*underrun) (pa_sink_input *i);         /* may be NULL */
  84
  85     pa_resample_method_t resample_method;
  86
  87     struct {
  88         pa_sink_input_state_t state;
  89         pa_atomic_t drained;
  90
  91         pa_sample_spec sample_spec;
  92
  93         pa_memchunk resampled_chunk;
  94         pa_resampler *resampler;                     /* may be NULL */
  95
  96         /* Some silence to play before the actual data. This is used to
  97          * compensate for latency differences when moving a sink input
  98          * "hot" between sinks. */
  99         /*         size_t move_silence; */
 100         pa_memblock *silence_memblock;               /* may be NULL */
 101
 102         pa_sink_input *sync_prev, *sync_next;
 103
 104         pa_cvolume volume;
 105         int muted;
 106     } thread_info;
 107
 108     void *userdata;
 109 };
 110
 111 PA_DECLARE_CLASS(pa_sink_input);
 112 #define PA_SINK_INPUT(o) pa_sink_input_cast(o)
 113
 114 enum {
 115     PA_SINK_INPUT_MESSAGE_SET_VOLUME,
 116     PA_SINK_INPUT_MESSAGE_SET_MUTE,
 117     PA_SINK_INPUT_MESSAGE_GET_LATENCY,
 118     PA_SINK_INPUT_MESSAGE_SET_RATE,
 119     PA_SINK_INPUT_MESSAGE_SET_STATE,
 120     PA_SINK_INPUT_MESSAGE_MAX
 121 };
 122
 123 typedef struct pa_sink_input_new_data {
 124     const char *name, *driver;
 125     pa_module *module;
 126     pa_client *client;
 127
 128     pa_sink *sink;
 129
 130     pa_sample_spec sample_spec;
 131     int sample_spec_is_set;
 132     pa_channel_map channel_map;
 133     int channel_map_is_set;
 134
 135     pa_cvolume volume;
 136     int volume_is_set;
 137     int muted;
 138     int muted_is_set;
 139
 140     pa_resample_method_t resample_method;
 141
 142     int start_corked;
 143     pa_sink_input *sync_base;
 144 } pa_sink_input_new_data;
 145
 146 pa_sink_input_new_data* pa_sink_input_new_data_init(pa_sink_input_new_data *data);
 147 void pa_sink_input_new_data_set_sample_spec(pa_sink_input_new_data *data, const pa_sample_spec *spec);
 148 void pa_sink_input_new_data_set_channel_map(pa_sink_input_new_data *data, const pa_channel_map *map);
 149 void pa_sink_input_new_data_set_volume(pa_sink_input_new_data *data, const pa_cvolume *volume);
 150 void pa_sink_input_new_data_set_muted(pa_sink_input_new_data *data, int mute);
 151
 152 /* To be called by the implementing module only */
 153
 154 pa_sink_input* pa_sink_input_new(
 155         pa_core *core,
 156         pa_sink_input_new_data *data,
 157         pa_sink_input_flags_t flags);
 158
 159 void pa_sink_input_put(pa_sink_input *i);
 160 void pa_sink_input_disconnect(pa_sink_input* i);
 161
 162 void pa_sink_input_set_name(pa_sink_input *i, const char *name);
 163
 164 /* Callable by everyone */
 165
 166 /* External code may request disconnection with this function */
 167 void pa_sink_input_kill(pa_sink_input*i);
 168
 169 pa_usec_t pa_sink_input_get_latency(pa_sink_input *i);
 170
 171 void pa_sink_input_set_volume(pa_sink_input *i, const pa_cvolume *volume);
 172 const pa_cvolume *pa_sink_input_get_volume(pa_sink_input *i);
 173 void pa_sink_input_set_mute(pa_sink_input *i, int mute);
 174 int pa_sink_input_get_mute(pa_sink_input *i);
 175
 176 void pa_sink_input_cork(pa_sink_input *i, int b);
 177
 178 int pa_sink_input_set_rate(pa_sink_input *i, uint32_t rate);
 179
 180 pa_resample_method_t pa_sink_input_get_resample_method(pa_sink_input *i);
 181
 182 int pa_sink_input_move_to(pa_sink_input *i, pa_sink *dest, int immediately);
 183
 184 pa_sink_input_state_t pa_sink_input_get_state(pa_sink_input *i);
 185
 186 /* To be used exclusively by the sink driver thread */
 187
 188 int pa_sink_input_peek(pa_sink_input *i, pa_memchunk *chunk, pa_cvolume *volume);
 189 void pa_sink_input_drop(pa_sink_input *i, size_t length);
 190 int pa_sink_input_process_msg(pa_msgobject *o, int code, void *userdata, int64_t offset, pa_memchunk *chunk);
 191
 192 #endif