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

   1 #ifndef foopulsesinkhfoo
   2 #define foopulsesinkhfoo
   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 typedef struct pa_sink pa_sink;
  29
  30 #include <inttypes.h>
  31
  32 #include <pulse/sample.h>
  33 #include <pulse/channelmap.h>
  34 #include <pulse/volume.h>
  35
  36 #include <pulsecore/core-def.h>
  37 #include <pulsecore/core.h>
  38 #include <pulsecore/idxset.h>
  39 #include <pulsecore/source.h>
  40 #include <pulsecore/module.h>
  41 #include <pulsecore/refcnt.h>
  42 #include <pulsecore/msgobject.h>
  43 #include <pulsecore/rtpoll.h>
  44
  45 #define PA_MAX_INPUTS_PER_SINK 32
  46
  47 typedef enum pa_sink_state {
  48     PA_SINK_INIT,
  49     PA_SINK_RUNNING,
  50     PA_SINK_SUSPENDED,
  51     PA_SINK_IDLE,
  52     PA_SINK_UNLINKED
  53 } pa_sink_state_t;
  54
  55 static inline pa_bool_t PA_SINK_OPENED(pa_sink_state_t x) {
  56     return x == PA_SINK_RUNNING || x == PA_SINK_IDLE;
  57 }
  58
  59 static inline pa_bool_t PA_SINK_LINKED(pa_sink_state_t x) {
  60     return x == PA_SINK_RUNNING || x == PA_SINK_IDLE || x == PA_SINK_SUSPENDED;
  61 }
  62
  63 struct pa_sink {
  64     pa_msgobject parent;
  65
  66     uint32_t index;
  67     pa_core *core;
  68     pa_sink_state_t state;
  69     pa_sink_flags_t flags;
  70
  71     char *name;
  72     char *description, *driver;            /* may be NULL */
  73
  74     pa_module *module;                      /* may be NULL */
  75
  76     pa_sample_spec sample_spec;
  77     pa_channel_map channel_map;
  78
  79     pa_idxset *inputs;
  80     unsigned n_corked;
  81     pa_source *monitor_source;
  82
  83     pa_cvolume volume;
  84     pa_bool_t muted;
  85     pa_bool_t refresh_volume;
  86     pa_bool_t refresh_mute;
  87
  88     int (*set_state)(pa_sink *s, pa_sink_state_t state); /* may be NULL */
  89     int (*set_volume)(pa_sink *s);           /* dito */
  90     int (*get_volume)(pa_sink *s);           /* dito */
  91     int (*get_mute)(pa_sink *s);             /* dito */
  92     int (*set_mute)(pa_sink *s);             /* dito */
  93     pa_usec_t (*get_latency)(pa_sink *s);    /* dito */
  94
  95     pa_asyncmsgq *asyncmsgq;
  96     pa_rtpoll *rtpoll;
  97
  98     /* Contains copies of the above data so that the real-time worker
  99      * thread can work without access locking */
 100     struct {
 101         pa_sink_state_t state;
 102         pa_hashmap *inputs;
 103         pa_cvolume soft_volume;
 104         pa_bool_t soft_muted;
 105     } thread_info;
 106
 107     pa_memblock *silence;
 108
 109     void *userdata;
 110 };
 111
 112 PA_DECLARE_CLASS(pa_sink);
 113 #define PA_SINK(s) (pa_sink_cast(s))
 114
 115 typedef enum pa_sink_message {
 116     PA_SINK_MESSAGE_ADD_INPUT,
 117     PA_SINK_MESSAGE_REMOVE_INPUT,
 118     PA_SINK_MESSAGE_GET_VOLUME,
 119     PA_SINK_MESSAGE_SET_VOLUME,
 120     PA_SINK_MESSAGE_GET_MUTE,
 121     PA_SINK_MESSAGE_SET_MUTE,
 122     PA_SINK_MESSAGE_GET_LATENCY,
 123     PA_SINK_MESSAGE_SET_STATE,
 124     PA_SINK_MESSAGE_PING,
 125     PA_SINK_MESSAGE_REMOVE_INPUT_AND_BUFFER,
 126     PA_SINK_MESSAGE_ATTACH,
 127     PA_SINK_MESSAGE_DETACH,
 128     PA_SINK_MESSAGE_MAX
 129 } pa_sink_message_t;
 130
 131 /* To be called exclusively by the sink driver, from main context */
 132
 133 pa_sink* pa_sink_new(
 134         pa_core *core,
 135         const char *driver,
 136         const char *name,
 137         int namereg_fail,
 138         const pa_sample_spec *spec,
 139         const pa_channel_map *map);
 140
 141 void pa_sink_put(pa_sink *s);
 142 void pa_sink_unlink(pa_sink* s);
 143
 144 void pa_sink_set_module(pa_sink *sink, pa_module *m);
 145 void pa_sink_set_description(pa_sink *s, const char *description);
 146 void pa_sink_set_asyncmsgq(pa_sink *s, pa_asyncmsgq *q);
 147 void pa_sink_set_rtpoll(pa_sink *s, pa_rtpoll *p);
 148
 149 void pa_sink_detach(pa_sink *s);
 150 void pa_sink_attach(pa_sink *s);
 151
 152 /* May be called by everyone, from main context */
 153
 154 pa_usec_t pa_sink_get_latency(pa_sink *s);
 155
 156 int pa_sink_update_status(pa_sink*s);
 157 int pa_sink_suspend(pa_sink *s, pa_bool_t suspend);
 158 int pa_sink_suspend_all(pa_core *c, pa_bool_t suspend);
 159
 160 /* Sends a ping message to the sink thread, to make it wake up and
 161  * check for data to process even if there is no real message is
 162  * sent */
 163 void pa_sink_ping(pa_sink *s);
 164
 165 void pa_sink_set_volume(pa_sink *sink, const pa_cvolume *volume);
 166 const pa_cvolume *pa_sink_get_volume(pa_sink *sink);
 167 void pa_sink_set_mute(pa_sink *sink, pa_bool_t mute);
 168 pa_bool_t pa_sink_get_mute(pa_sink *sink);
 169
 170 unsigned pa_sink_linked_by(pa_sink *s); /* Number of connected streams */
 171 unsigned pa_sink_used_by(pa_sink *s); /* Number of connected streams which are not corked */
 172 #define pa_sink_get_state(s) ((s)->state)
 173
 174 /* To be called exclusively by the sink driver, from IO context */
 175
 176 void pa_sink_render(pa_sink*s, size_t length, pa_memchunk *result);
 177 void pa_sink_render_full(pa_sink *s, size_t length, pa_memchunk *result);
 178 void pa_sink_render_into(pa_sink*s, pa_memchunk *target);
 179 void pa_sink_render_into_full(pa_sink *s, pa_memchunk *target);
 180
 181 void pa_sink_skip(pa_sink *s, size_t length);
 182
 183 int pa_sink_process_msg(pa_msgobject *o, int code, void *userdata, int64_t offset, pa_memchunk *chunk);
 184
 185 void pa_sink_attach_within_thread(pa_sink *s);
 186 void pa_sink_detach_within_thread(pa_sink *s);
 187
 188 #endif