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
  44 #define PA_MAX_INPUTS_PER_SINK 32
  45
  46 typedef enum pa_sink_state {
  47     PA_SINK_RUNNING,
  48     PA_SINK_SUSPENDED,
  49     PA_SINK_IDLE,
  50     PA_SINK_DISCONNECTED
  51 } pa_sink_state_t;
  52
  53 struct pa_sink {
  54     pa_msgobject parent;
  55
  56     uint32_t index;
  57     pa_core *core;
  58     pa_atomic_t state;
  59
  60     char *name;
  61     char *description, *driver;            /* may be NULL */
  62     int is_hardware;
  63
  64     pa_module *module;                      /* may be NULL */
  65
  66     pa_sample_spec sample_spec;
  67     pa_channel_map channel_map;
  68
  69     pa_idxset *inputs;
  70     pa_source *monitor_source;             /* may be NULL */
  71
  72     pa_cvolume volume;
  73     int muted;
  74     int refresh_volume;
  75     int refresh_mute;
  76
  77     int (*start)(pa_sink *s);
  78     int (*stop)(pa_sink *s);
  79     int (*set_volume)(pa_sink *s);      /* dito */
  80     int (*get_volume)(pa_sink *s);      /* dito */
  81     int (*get_mute)(pa_sink *s);        /* dito */
  82     int (*set_mute)(pa_sink *s);        /* dito */
  83     pa_usec_t (*get_latency)(pa_sink *s);    /* dito */
  84
  85     pa_asyncmsgq *asyncmsgq;
  86
  87     /* Contains copies of the above data so that the real-time worker
  88      * thread can work without access locking */
  89     struct {
  90         pa_hashmap *inputs;
  91         pa_cvolume soft_volume;
  92         int soft_muted;
  93     } thread_info;
  94
  95     void *userdata;
  96 };
  97
  98 PA_DECLARE_CLASS(pa_sink);
  99 #define PA_SINK(s) ((pa_sink*) (s))
 100
 101 typedef enum pa_sink_message {
 102     PA_SINK_MESSAGE_ADD_INPUT,
 103     PA_SINK_MESSAGE_REMOVE_INPUT,
 104     PA_SINK_MESSAGE_GET_VOLUME,
 105     PA_SINK_MESSAGE_SET_VOLUME,
 106     PA_SINK_MESSAGE_GET_MUTE,
 107     PA_SINK_MESSAGE_SET_MUTE,
 108     PA_SINK_MESSAGE_GET_LATENCY,
 109     PA_SINK_MESSAGE_START,
 110     PA_SINK_MESSAGE_STOP,
 111     PA_SINK_MESSAGE_MAX
 112 } pa_sink_message_t;
 113
 114 /* To be used exclusively by the sink driver */
 115
 116 pa_sink* pa_sink_new(
 117         pa_core *core,
 118         const char *driver,
 119         const char *name,
 120         int namereg_fail,
 121         const pa_sample_spec *spec,
 122         const pa_channel_map *map);
 123
 124 void pa_sink_disconnect(pa_sink* s);
 125
 126 void pa_sink_set_module(pa_sink *sink, pa_module *m);
 127 void pa_sink_set_description(pa_sink *s, const char *description);
 128
 129 /* Usable by everyone */
 130
 131 pa_usec_t pa_sink_get_latency(pa_sink *s);
 132
 133 void pa_sink_update_status(pa_sink*s);
 134 void pa_sink_suspend(pa_sink *s, int suspend);
 135
 136 void pa_sink_set_volume(pa_sink *sink, const pa_cvolume *volume);
 137 const pa_cvolume *pa_sink_get_volume(pa_sink *sink);
 138 void pa_sink_set_mute(pa_sink *sink, int mute);
 139 int pa_sink_get_mute(pa_sink *sink);
 140
 141 unsigned pa_sink_used_by(pa_sink *s);
 142 #define pa_sink_get_state(s) ((pa_sink_state_t) pa_atomic_load(&(s)->state))
 143
 144 /* To be used exclusively by the sink driver thread */
 145
 146 int pa_sink_render(pa_sink*s, size_t length, pa_memchunk *result);
 147 void pa_sink_render_full(pa_sink *s, size_t length, pa_memchunk *result);
 148 int pa_sink_render_into(pa_sink*s, pa_memchunk *target);
 149 void pa_sink_render_into_full(pa_sink *s, pa_memchunk *target);
 150
 151 int pa_sink_process_msg(pa_msgobject *o, int code, void *userdata, pa_memchunk *chunk);
 152
 153 #endif