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_flags_t;
  54
  55 struct pa_source_output {
  56     pa_msgobject parent;
  57
  58     uint32_t index;
  59     pa_core *core;
  60     pa_source_output_state_t state;
  61     pa_source_output_flags_t flags;
  62
  63     char *name, *driver;                  /* may be NULL */
  64     pa_module *module;                    /* may be NULL */
  65     pa_client *client;                    /* may be NULL */
  66
  67     pa_source *source;
  68
  69     pa_sample_spec sample_spec;
  70     pa_channel_map channel_map;
  71
  72     /* Pushes a new memchunk into the output. Called from IO thread
  73      * context. */
  74     void (*push)(pa_source_output *o, const pa_memchunk *chunk);
  75
  76     /* If non-NULL this function is called when the output is first
  77      * connected to a source. Called from IO thread context */
  78     void (*attach) (pa_source_output *o);           /* may be NULL */
  79
  80     /* If non-NULL this function is called when the output is
  81      * disconnected from its source. Called from IO thread context */
  82     void (*detach) (pa_source_output *o);           /* may be NULL */
  83
  84     /* If non-NULL called whenever the the source this output is attached
  85      * to suspends or resumes. Called from main context */
  86     void (*suspend) (pa_source_output *o, int b);   /* may be NULL */
  87
  88     /* Supposed to unlink and destroy this stream. Called from main
  89      * context. */
  90     void (*kill)(pa_source_output* o);              /* may be NULL */
  91
  92     /* Return the current latency (i.e. length of bufferd audio) of
  93     this stream. Called from main context. If NULL a
  94     PA_SOURCE_OUTPUT_MESSAGE_GET_LATENCY message is sent to the IO
  95     thread instead. */
  96     pa_usec_t (*get_latency) (pa_source_output *o); /* may be NULL */
  97
  98     pa_resample_method_t resample_method;
  99
 100     struct {
 101         pa_source_output_state_t state;
 102
 103         pa_sample_spec sample_spec;
 104
 105         pa_resampler* resampler;              /* may be NULL */
 106     } thread_info;
 107
 108     void *userdata;
 109 };
 110
 111 PA_DECLARE_CLASS(pa_source_output);
 112 #define PA_SOURCE_OUTPUT(o) pa_source_output_cast(o)
 113
 114 enum {
 115     PA_SOURCE_OUTPUT_MESSAGE_GET_LATENCY,
 116     PA_SOURCE_OUTPUT_MESSAGE_SET_RATE,
 117     PA_SOURCE_OUTPUT_MESSAGE_SET_STATE,
 118     PA_SOURCE_OUTPUT_MESSAGE_MAX
 119 };
 120
 121 typedef struct pa_source_output_new_data {
 122     const char *name, *driver;
 123     pa_module *module;
 124     pa_client *client;
 125
 126     pa_source *source;
 127
 128     pa_sample_spec sample_spec;
 129     pa_bool_t sample_spec_is_set;
 130     pa_channel_map channel_map;
 131     pa_bool_t channel_map_is_set;
 132
 133     pa_resample_method_t resample_method;
 134 } pa_source_output_new_data;
 135
 136 pa_source_output_new_data* pa_source_output_new_data_init(pa_source_output_new_data *data);
 137 void pa_source_output_new_data_set_sample_spec(pa_source_output_new_data *data, const pa_sample_spec *spec);
 138 void pa_source_output_new_data_set_channel_map(pa_source_output_new_data *data, const pa_channel_map *map);
 139 void pa_source_output_new_data_set_volume(pa_source_output_new_data *data, const pa_cvolume *volume);
 140
 141 /* To be called by the implementing module only */
 142
 143 pa_source_output* pa_source_output_new(
 144         pa_core *core,
 145         pa_source_output_new_data *data,
 146         pa_source_output_flags_t flags);
 147
 148 void pa_source_output_put(pa_source_output *o);
 149 void pa_source_output_unlink(pa_source_output*o);
 150
 151 void pa_source_output_set_name(pa_source_output *i, const char *name);
 152
 153 /* Callable by everyone */
 154
 155 /* External code may request disconnection with this funcion */
 156 void pa_source_output_kill(pa_source_output*o);
 157
 158 pa_usec_t pa_source_output_get_latency(pa_source_output *i);
 159
 160 void pa_source_output_cork(pa_source_output *i, pa_bool_t b);
 161
 162 int pa_source_output_set_rate(pa_source_output *o, uint32_t rate);
 163
 164 pa_resample_method_t pa_source_output_get_resample_method(pa_source_output *o);
 165
 166 int pa_source_output_move_to(pa_source_output *o, pa_source *dest);
 167
 168 #define pa_source_output_get_state(o) ((o)->state)
 169
 170 /* To be used exclusively by the source driver thread */
 171
 172 void pa_source_output_push(pa_source_output *o, const pa_memchunk *chunk);
 173 int pa_source_output_process_msg(pa_msgobject *mo, int code, void *userdata, int64_t offset, pa_memchunk *chunk);
 174
 175 #endif