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_RUNNING,
  40     PA_SOURCE_OUTPUT_CORKED,
  41     PA_SOURCE_OUTPUT_DISCONNECTED
  42 } pa_source_output_state_t;
  43
  44 typedef enum pa_source_output_flags {
  45     PA_SOURCE_OUTPUT_VARIABLE_RATE = 1
  46 } pa_source_output_flags_t;
  47
  48 struct pa_source_output {
  49     pa_msgobject parent;
  50
  51     uint32_t index;
  52     pa_core *core;
  53     pa_source_output_state_t state;
  54     pa_source_output_flags_t flags;
  55
  56     char *name, *driver;                  /* may be NULL */
  57     pa_module *module;                    /* may be NULL */
  58     pa_client *client;                    /* may be NULL */
  59
  60     pa_source *source;
  61
  62     pa_sample_spec sample_spec;
  63     pa_channel_map channel_map;
  64
  65     void (*push)(pa_source_output *o, const pa_memchunk *chunk);
  66     void (*kill)(pa_source_output* o);              /* may be NULL */
  67     pa_usec_t (*get_latency) (pa_source_output *o); /* may be NULL */
  68
  69     pa_resample_method_t resample_method;
  70
  71     struct {
  72         pa_source_output_state_t state;
  73
  74         pa_sample_spec sample_spec;
  75
  76         pa_resampler* resampler;              /* may be NULL */
  77     } thread_info;
  78
  79     void *userdata;
  80 };
  81
  82 PA_DECLARE_CLASS(pa_source_output);
  83 #define PA_SOURCE_OUTPUT(o) pa_source_output_cast(o)
  84
  85 enum {
  86     PA_SOURCE_OUTPUT_MESSAGE_GET_LATENCY,
  87     PA_SOURCE_OUTPUT_MESSAGE_SET_RATE,
  88     PA_SOURCE_OUTPUT_MESSAGE_SET_STATE,
  89     PA_SOURCE_OUTPUT_MESSAGE_MAX
  90 };
  91
  92 typedef struct pa_source_output_new_data {
  93     const char *name, *driver;
  94     pa_module *module;
  95     pa_client *client;
  96
  97     pa_source *source;
  98
  99     pa_sample_spec sample_spec;
 100     int sample_spec_is_set;
 101     pa_channel_map channel_map;
 102     int channel_map_is_set;
 103
 104     pa_resample_method_t resample_method;
 105
 106     int start_corked;
 107 } pa_source_output_new_data;
 108
 109 pa_source_output_new_data* pa_source_output_new_data_init(pa_source_output_new_data *data);
 110 void pa_source_output_new_data_set_sample_spec(pa_source_output_new_data *data, const pa_sample_spec *spec);
 111 void pa_source_output_new_data_set_channel_map(pa_source_output_new_data *data, const pa_channel_map *map);
 112 void pa_source_output_new_data_set_volume(pa_source_output_new_data *data, const pa_cvolume *volume);
 113
 114 /* To be called by the implementing module only */
 115
 116 pa_source_output* pa_source_output_new(
 117         pa_core *core,
 118         pa_source_output_new_data *data,
 119         pa_source_output_flags_t flags);
 120
 121 void pa_source_output_put(pa_source_output *o);
 122 void pa_source_output_disconnect(pa_source_output*o);
 123
 124 void pa_source_output_set_name(pa_source_output *i, const char *name);
 125
 126 /* Callable by everyone */
 127
 128 /* External code may request disconnection with this funcion */
 129 void pa_source_output_kill(pa_source_output*o);
 130
 131 pa_usec_t pa_source_output_get_latency(pa_source_output *i);
 132
 133 void pa_source_output_cork(pa_source_output *i, int b);
 134
 135 int pa_source_output_set_rate(pa_source_output *o, uint32_t rate);
 136
 137 pa_resample_method_t pa_source_output_get_resample_method(pa_source_output *o);
 138
 139 int pa_source_output_move_to(pa_source_output *o, pa_source *dest);
 140
 141 #define pa_source_output_get_state(o) ((o)->state)
 142
 143 /* To be used exclusively by the source driver thread */
 144
 145 void pa_source_output_push(pa_source_output *o, const pa_memchunk *chunk);
 146 int pa_source_output_process_msg(pa_msgobject *mo, int code, void *userdata, int64_t offset, pa_memchunk *chunk);
 147
 148 #endif