src/pulsecore/sink.h

   1 #ifndef foosinkhfoo
   2 #define foosinkhfoo
   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 pa_sink;
  31
  32 #include <pulse/sample.h>
  33 #include <pulse/channelmap.h>
  34 #include <pulse/volume.h>
  35 #include <pulsecore/core-def.h>
  36 #include <pulsecore/core.h>
  37 #include <pulsecore/idxset.h>
  38 #include <pulsecore/source.h>
  39 #include <pulsecore/module.h>
  40
  41 #define PA_MAX_INPUTS_PER_SINK 32
  42
  43 typedef enum pa_sink_state {
  44     PA_SINK_RUNNING,
  45     PA_SINK_DISCONNECTED
  46 } pa_sink_state_t;
  47
  48 struct pa_sink {
  49     int ref;
  50     uint32_t index;
  51     pa_core *core;
  52     pa_sink_state_t state;
  53
  54     char *name;
  55     char *description, *driver;            /* may be NULL */
  56     int is_hardware;
  57
  58     pa_module *owner;                      /* may be NULL */
  59
  60     pa_sample_spec sample_spec;
  61     pa_channel_map channel_map;
  62
  63     pa_idxset *inputs;
  64     pa_source *monitor_source;             /* may be NULL */
  65
  66     pa_cvolume hw_volume, sw_volume;
  67     int hw_muted, sw_muted;
  68
  69     void (*notify)(pa_sink*sink);          /* may be NULL */
  70     pa_usec_t (*get_latency)(pa_sink *s);  /* dito */
  71     int (*set_hw_volume)(pa_sink *s);      /* dito */
  72     int (*get_hw_volume)(pa_sink *s);      /* dito */
  73     int (*set_hw_mute)(pa_sink *s);        /* dito */
  74     int (*get_hw_mute)(pa_sink *s);        /* dito */
  75
  76     void *userdata;
  77 };
  78
  79 pa_sink* pa_sink_new(
  80     pa_core *core,
  81     const char *driver,
  82     const char *name,
  83     int namereg_fail,
  84     const pa_sample_spec *spec,
  85     const pa_channel_map *map);
  86
  87 void pa_sink_disconnect(pa_sink* s);
  88 void pa_sink_unref(pa_sink*s);
  89 pa_sink* pa_sink_ref(pa_sink *s);
  90
  91 int pa_sink_render(pa_sink*s, size_t length, pa_memchunk *result);
  92 void pa_sink_render_full(pa_sink *s, size_t length, pa_memchunk *result);
  93 int pa_sink_render_into(pa_sink*s, pa_memchunk *target);
  94 void pa_sink_render_into_full(pa_sink *s, pa_memchunk *target);
  95
  96 pa_usec_t pa_sink_get_latency(pa_sink *s);
  97
  98 void pa_sink_notify(pa_sink*s);
  99
 100 void pa_sink_set_owner(pa_sink *sink, pa_module *m);
 101
 102 void pa_sink_set_volume(pa_sink *sink, pa_mixer_t m, const pa_cvolume *volume);
 103 const pa_cvolume *pa_sink_get_volume(pa_sink *sink, pa_mixer_t m);
 104 void pa_sink_set_mute(pa_sink *sink, pa_mixer_t m, int mute);
 105 int pa_sink_get_mute(pa_sink *sink, pa_mixer_t m);
 106
 107 void pa_sink_set_description(pa_sink *s, const char *description);
 108
 109 unsigned pa_sink_used_by(pa_sink *s);
 110
 111 #endif