code.delx.au - pulseaudio/blob - src/pulsecore/source-output.h

   1 #ifndef foopulsesourceoutputhfoo
   2 #define foopulsesourceoutputhfoo
   3
   4 /* $Id$ */
   5
   6 /***
   7   This file is part of PulseAudio.
   8
   9   Copyright 2004-2006 Lennart Poettering
  10
  11   PulseAudio is free software; you can redistribute it and/or modify
  12   it under the terms of the GNU Lesser General Public License as published
  13   by the Free Software Foundation; either version 2 of the License,
  14   or (at your option) any later version.
  15
  16   PulseAudio is distributed in the hope that it will be useful, but
  17   WITHOUT ANY WARRANTY; without even the implied warranty of
  18   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  19   General Public License for more details.
  20
  21   You should have received a copy of the GNU Lesser General Public License
  22   along with PulseAudio; if not, write to the Free Software
  23   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  24   USA.
  25 ***/
  26
  27 #include <inttypes.h>
  28
  29 typedef struct pa_source_output pa_source_output;
  30
  31 #include <pulse/sample.h>
  32 #include <pulsecore/source.h>
  33 #include <pulsecore/memblockq.h>
  34 #include <pulsecore/resampler.h>
  35 #include <pulsecore/module.h>
  36 #include <pulsecore/client.h>
  37
  38 typedef enum pa_source_output_state {
  39     PA_SOURCE_OUTPUT_INIT,
  40     PA_SOURCE_OUTPUT_RUNNING,
  41     PA_SOURCE_OUTPUT_CORKED,
  42     PA_SOURCE_OUTPUT_UNLINKED
  43 } pa_source_output_state_t;
  44
  45 static inline pa_bool_t PA_SOURCE_OUTPUT_LINKED(pa_source_output_state_t x) {
  46     return x == PA_SOURCE_OUTPUT_RUNNING || x == PA_SOURCE_OUTPUT_CORKED;
  47 }
  48
  49 typedef enum pa_source_output_flags {
  50     PA_SOURCE_OUTPUT_VARIABLE_RATE = 1,
  51     PA_SOURCE_OUTPUT_DONT_MOVE = 2,
  52     PA_SOURCE_OUTPUT_START_CORKED = 4,
  53     PA_SOURCE_OUTPUT_NO_REMAP = 8,
  54     PA_SOURCE_OUTPUT_NO_REMIX = 16,
  55     PA_SOURCE_OUTPUT_FIX_FORMAT = 32,
  56     PA_SOURCE_OUTPUT_FIX_RATE = 64,
  57     PA_SOURCE_OUTPUT_FIX_CHANNELS = 128
  58 } pa_source_output_flags_t;
  59
  60 struct pa_source_output {
  61     pa_msgobject parent;
  62
  63     uint32_t index;
  64     pa_core *core;
  65     pa_source_output_state_t state;
  66     pa_source_output_flags_t flags;
  67
  68     char *name, *driver;                  /* may be NULL */
  69     pa_module *module;                    /* may be NULL */
  70     pa_client *client;                    /* may be NULL */
  71
  72     pa_source *source;
  73
  74     pa_sample_spec sample_spec;
  75     pa_channel_map channel_map;
  76
  77     /* Pushes a new memchunk into the output. Called from IO thread
  78      * context. */
  79     void (*push)(pa_source_output *o, const pa_memchunk *chunk);
  80
  81     /* If non-NULL this function is called when the output is first
  82      * connected to a source. Called from IO thread context */
  83     void (*attach) (pa_source_output *o);           /* may be NULL */
  84
  85     /* If non-NULL this function is called when the output is
  86      * disconnected from its source. Called from IO thread context */
  87     void (*detach) (pa_source_output *o);           /* may be NULL */
  88
  89     /* If non-NULL called whenever the the source this output is attached
  90      * to changes. Called from main context */
  91     void (*moved) (pa_source_output *o);   /* may be NULL */
  92
  93     /* If non-NULL called whenever the the source this output is attached
  94      * to suspends or resumes. Called from main context */
  95     void (*suspend) (pa_source_output *o, pa_bool_t b);   /* may be NULL */
  96
  97     /* Supposed to unlink and destroy this stream. Called from main
  98      * context. */
  99     void (*kill)(pa_source_output* o);              /* may be NULL */
 100
 101     /* Return the current latency (i.e. length of bufferd audio) of
 102     this stream. Called from main context. If NULL a
 103     PA_SOURCE_OUTPUT_MESSAGE_GET_LATENCY message is sent to the IO
 104     thread instead. */
 105     pa_usec_t (*get_latency) (pa_source_output *o); /* may be NULL */
 106
 107     pa_resample_method_t resample_method;
 108
 109     struct {
 110         pa_source_output_state_t state;
 111
 112         pa_bool_t attached; /* True only between ->attach() and ->detach() calls */
 113
 114         pa_sample_spec sample_spec;
 115
 116         pa_resampler* resampler;              /* may be NULL */
 117     } thread_info;
 118
 119     void *userdata;
 120 };
 121
 122 PA_DECLARE_CLASS(pa_source_output);
 123 #define PA_SOURCE_OUTPUT(o) pa_source_output_cast(o)
 124
 125 enum {
 126     PA_SOURCE_OUTPUT_MESSAGE_GET_LATENCY,
 127     PA_SOURCE_OUTPUT_MESSAGE_SET_RATE,
 128     PA_SOURCE_OUTPUT_MESSAGE_SET_STATE,
 129     PA_SOURCE_OUTPUT_MESSAGE_MAX
 130 };
 131
 132 typedef struct pa_source_output_new_data {
 133     const char *name, *driver;
 134     pa_module *module;
 135     pa_client *client;
 136
 137     pa_source *source;
 138
 139     pa_sample_spec sample_spec;
 140     pa_bool_t sample_spec_is_set;
 141     pa_channel_map channel_map;
 142     pa_bool_t channel_map_is_set;
 143
 144     pa_resample_method_t resample_method;
 145 } pa_source_output_new_data;
 146
 147 typedef struct pa_source_output_move_hook_data {
 148     pa_source_output *source_output;
 149     pa_source *destination;
 150 } pa_source_output_move_hook_data;
 151
 152 pa_source_output_new_data* pa_source_output_new_data_init(pa_source_output_new_data *data);
 153 void pa_source_output_new_data_set_sample_spec(pa_source_output_new_data *data, const pa_sample_spec *spec);
 154 void pa_source_output_new_data_set_channel_map(pa_source_output_new_data *data, const pa_channel_map *map);
 155 void pa_source_output_new_data_set_volume(pa_source_output_new_data *data, const pa_cvolume *volume);
 156
 157 /* To be called by the implementing module only */
 158
 159 pa_source_output* pa_source_output_new(
 160         pa_core *core,
 161         pa_source_output_new_data *data,
 162         pa_source_output_flags_t flags);
 163
 164 void pa_source_output_put(pa_source_output *o);
 165 void pa_source_output_unlink(pa_source_output*o);
 166
 167 void pa_source_output_set_name(pa_source_output *i, const char *name);
 168
 169 /* Callable by everyone */
 170
 171 /* External code may request disconnection with this funcion */
 172 void pa_source_output_kill(pa_source_output*o);
 173
 174 pa_usec_t pa_source_output_get_latency(pa_source_output *i);
 175
 176 void pa_source_output_cork(pa_source_output *i, pa_bool_t b);
 177
 178 int pa_source_output_set_rate(pa_source_output *o, uint32_t rate);
 179
 180 pa_resample_method_t pa_source_output_get_resample_method(pa_source_output *o);
 181
 182 int pa_source_output_move_to(pa_source_output *o, pa_source *dest);
 183
 184 #define pa_source_output_get_state(o) ((o)->state)
 185
 186 /* To be used exclusively by the source driver thread */
 187
 188 void pa_source_output_push(pa_source_output *o, const pa_memchunk *chunk);
 189 int pa_source_output_process_msg(pa_msgobject *mo, int code, void *userdata, int64_t offset, pa_memchunk *chunk);
 190
 191 #endif