audio/audio_int.h

   1 /*
   2  * QEMU Audio subsystem header
   3  *
   4  * Copyright (c) 2003-2005 Vassili Karpov (malc)
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a copy
   7  * of this software and associated documentation files (the "Software"), to deal
   8  * in the Software without restriction, including without limitation the rights
   9  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  10  * copies of the Software, and to permit persons to whom the Software is
  11  * furnished to do so, subject to the following conditions:
  12  *
  13  * The above copyright notice and this permission notice shall be included in
  14  * all copies or substantial portions of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
  19  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  22  * THE SOFTWARE.
  23  */
  24
  25 #ifndef QEMU_AUDIO_INT_H
  26 #define QEMU_AUDIO_INT_H
  27
  28 #ifdef CONFIG_AUDIO_COREAUDIO
  29 #define FLOAT_MIXENG
  30 /* #define RECIPROCAL */
  31 #endif
  32 #include "mixeng.h"
  33
  34 #ifdef CONFIG_GIO
  35 #include <gio/gio.h>
  36 #endif
  37
  38 struct audio_pcm_ops;
  39
  40 struct audio_callback {
  41     void *opaque;
  42     audio_callback_fn fn;
  43 };
  44
  45 struct audio_pcm_info {
  46     int bits;
  47     bool is_signed;
  48     bool is_float;
  49     int freq;
  50     int nchannels;
  51     int bytes_per_frame;
  52     int bytes_per_second;
  53     int swap_endianness;
  54 };
  55
  56 typedef struct AudioState AudioState;
  57 typedef struct SWVoiceCap SWVoiceCap;
  58
  59 typedef struct STSampleBuffer {
  60     size_t pos, size;
  61     st_sample samples[];
  62 } STSampleBuffer;
  63
  64 typedef struct HWVoiceOut {
  65     AudioState *s;
  66     int enabled;
  67     int poll_mode;
  68     int pending_disable;
  69     struct audio_pcm_info info;
  70
  71     f_sample *clip;
  72     uint64_t ts_helper;
  73
  74     STSampleBuffer *mix_buf;
  75     void *buf_emul;
  76     size_t pos_emul, pending_emul, size_emul;
  77
  78     size_t samples;
  79     QLIST_HEAD (sw_out_listhead, SWVoiceOut) sw_head;
  80     QLIST_HEAD (sw_cap_listhead, SWVoiceCap) cap_head;
  81     struct audio_pcm_ops *pcm_ops;
  82     QLIST_ENTRY (HWVoiceOut) entries;
  83 } HWVoiceOut;
  84
  85 typedef struct HWVoiceIn {
  86     AudioState *s;
  87     int enabled;
  88     int poll_mode;
  89     struct audio_pcm_info info;
  90
  91     t_sample *conv;
  92
  93     size_t total_samples_captured;
  94     uint64_t ts_helper;
  95
  96     STSampleBuffer *conv_buf;
  97     void *buf_emul;
  98     size_t pos_emul, pending_emul, size_emul;
  99
 100     size_t samples;
 101     QLIST_HEAD (sw_in_listhead, SWVoiceIn) sw_head;
 102     struct audio_pcm_ops *pcm_ops;
 103     QLIST_ENTRY (HWVoiceIn) entries;
 104 } HWVoiceIn;
 105
 106 struct SWVoiceOut {
 107     QEMUSoundCard *card;
 108     AudioState *s;
 109     struct audio_pcm_info info;
 110     t_sample *conv;
 111     int64_t ratio;
 112     struct st_sample *buf;
 113     void *rate;
 114     size_t total_hw_samples_mixed;
 115     int active;
 116     int empty;
 117     HWVoiceOut *hw;
 118     char *name;
 119     struct mixeng_volume vol;
 120     struct audio_callback callback;
 121     QLIST_ENTRY (SWVoiceOut) entries;
 122 };
 123
 124 struct SWVoiceIn {
 125     QEMUSoundCard *card;
 126     AudioState *s;
 127     int active;
 128     struct audio_pcm_info info;
 129     int64_t ratio;
 130     void *rate;
 131     size_t total_hw_samples_acquired;
 132     struct st_sample *buf;
 133     f_sample *clip;
 134     HWVoiceIn *hw;
 135     char *name;
 136     struct mixeng_volume vol;
 137     struct audio_callback callback;
 138     QLIST_ENTRY (SWVoiceIn) entries;
 139 };
 140
 141 typedef struct audio_driver audio_driver;
 142 struct audio_driver {
 143     const char *name;
 144     const char *descr;
 145     void *(*init) (Audiodev *);
 146     void (*fini) (void *);
 147 #ifdef CONFIG_GIO
 148     void (*set_dbus_server) (AudioState *s, GDBusObjectManagerServer *manager);
 149 #endif
 150     struct audio_pcm_ops *pcm_ops;
 151     int can_be_default;
 152     int max_voices_out;
 153     int max_voices_in;
 154     int voice_size_out;
 155     int voice_size_in;
 156     QLIST_ENTRY(audio_driver) next;
 157 };
 158
 159 struct audio_pcm_ops {
 160     int    (*init_out)(HWVoiceOut *hw, audsettings *as, void *drv_opaque);
 161     void   (*fini_out)(HWVoiceOut *hw);
 162     size_t (*write)   (HWVoiceOut *hw, void *buf, size_t size);
 163     void   (*run_buffer_out)(HWVoiceOut *hw);
 164     /*
 165      * Get the free output buffer size. This is an upper limit. The size
 166      * returned by function get_buffer_out may be smaller.
 167      */
 168     size_t (*buffer_get_free)(HWVoiceOut *hw);
 169     /*
 170      * get a buffer that after later can be passed to put_buffer_out; optional
 171      * returns the buffer, and writes it's size to size (in bytes)
 172      */
 173     void  *(*get_buffer_out)(HWVoiceOut *hw, size_t *size);
 174     /*
 175      * put back the buffer returned by get_buffer_out; optional
 176      * buf must be equal the pointer returned by get_buffer_out,
 177      * size may be smaller
 178      */
 179     size_t (*put_buffer_out)(HWVoiceOut *hw, void *buf, size_t size);
 180     void   (*enable_out)(HWVoiceOut *hw, bool enable);
 181     void   (*volume_out)(HWVoiceOut *hw, Volume *vol);
 182
 183     int    (*init_in) (HWVoiceIn *hw, audsettings *as, void *drv_opaque);
 184     void   (*fini_in) (HWVoiceIn *hw);
 185     size_t (*read)    (HWVoiceIn *hw, void *buf, size_t size);
 186     void   (*run_buffer_in)(HWVoiceIn *hw);
 187     void  *(*get_buffer_in)(HWVoiceIn *hw, size_t *size);
 188     void   (*put_buffer_in)(HWVoiceIn *hw, void *buf, size_t size);
 189     void   (*enable_in)(HWVoiceIn *hw, bool enable);
 190     void   (*volume_in)(HWVoiceIn *hw, Volume *vol);
 191 };
 192
 193 void audio_generic_run_buffer_in(HWVoiceIn *hw);
 194 void *audio_generic_get_buffer_in(HWVoiceIn *hw, size_t *size);
 195 void audio_generic_put_buffer_in(HWVoiceIn *hw, void *buf, size_t size);
 196 void audio_generic_run_buffer_out(HWVoiceOut *hw);
 197 size_t audio_generic_buffer_get_free(HWVoiceOut *hw);
 198 void *audio_generic_get_buffer_out(HWVoiceOut *hw, size_t *size);
 199 size_t audio_generic_put_buffer_out(HWVoiceOut *hw, void *buf, size_t size);
 200 size_t audio_generic_write(HWVoiceOut *hw, void *buf, size_t size);
 201 size_t audio_generic_read(HWVoiceIn *hw, void *buf, size_t size);
 202
 203 struct capture_callback {
 204     struct audio_capture_ops ops;
 205     void *opaque;
 206     QLIST_ENTRY (capture_callback) entries;
 207 };
 208
 209 struct CaptureVoiceOut {
 210     HWVoiceOut hw;
 211     void *buf;
 212     QLIST_HEAD (cb_listhead, capture_callback) cb_head;
 213     QLIST_ENTRY (CaptureVoiceOut) entries;
 214 };
 215
 216 struct SWVoiceCap {
 217     SWVoiceOut sw;
 218     CaptureVoiceOut *cap;
 219     QLIST_ENTRY (SWVoiceCap) entries;
 220 };
 221
 222 typedef struct AudioState {
 223     struct audio_driver *drv;
 224     Audiodev *dev;
 225     void *drv_opaque;
 226
 227     QEMUTimer *ts;
 228     QLIST_HEAD (card_listhead, QEMUSoundCard) card_head;
 229     QLIST_HEAD (hw_in_listhead, HWVoiceIn) hw_head_in;
 230     QLIST_HEAD (hw_out_listhead, HWVoiceOut) hw_head_out;
 231     QLIST_HEAD (cap_listhead, CaptureVoiceOut) cap_head;
 232     int nb_hw_voices_out;
 233     int nb_hw_voices_in;
 234     int vm_running;
 235     int64_t period_ticks;
 236
 237     bool timer_running;
 238     uint64_t timer_last;
 239
 240     QTAILQ_ENTRY(AudioState) list;
 241 } AudioState;
 242
 243 extern const struct mixeng_volume nominal_volume;
 244
 245 extern const char *audio_prio_list[];
 246
 247 void audio_driver_register(audio_driver *drv);
 248 audio_driver *audio_driver_lookup(const char *name);
 249
 250 void audio_pcm_init_info (struct audio_pcm_info *info, struct audsettings *as);
 251 void audio_pcm_info_clear_buf (struct audio_pcm_info *info, void *buf, int len);
 252
 253 int audio_bug (const char *funcname, int cond);
 254 void *audio_calloc (const char *funcname, int nmemb, size_t size);
 255
 256 void audio_run(AudioState *s, const char *msg);
 257
 258 const char *audio_application_name(void);
 259
 260 typedef struct RateCtl {
 261     int64_t start_ticks;
 262     int64_t bytes_sent;
 263 } RateCtl;
 264
 265 void audio_rate_start(RateCtl *rate);
 266 size_t audio_rate_get_bytes(struct audio_pcm_info *info, RateCtl *rate,
 267                             size_t bytes_avail);
 268
 269 static inline size_t audio_ring_dist(size_t dst, size_t src, size_t len)
 270 {
 271     return (dst >= src) ? (dst - src) : (len - src + dst);
 272 }
 273
 274 /**
 275  * audio_ring_posb() - returns new position in ringbuffer in backward
 276  * direction at given distance
 277  *
 278  * @pos: current position in ringbuffer
 279  * @dist: distance in ringbuffer to walk in reverse direction
 280  * @len: size of ringbuffer
 281  */
 282 static inline size_t audio_ring_posb(size_t pos, size_t dist, size_t len)
 283 {
 284     return pos >= dist ? pos - dist : len - dist + pos;
 285 }
 286
 287 #define dolog(fmt, ...) AUD_log(AUDIO_CAP, fmt, ## __VA_ARGS__)
 288
 289 #ifdef DEBUG
 290 #define ldebug(fmt, ...) AUD_log(AUDIO_CAP, fmt, ## __VA_ARGS__)
 291 #else
 292 #define ldebug(fmt, ...) (void)0
 293 #endif
 294
 295 #define AUDIO_STRINGIFY_(n) #n
 296 #define AUDIO_STRINGIFY(n) AUDIO_STRINGIFY_(n)
 297
 298 typedef struct AudiodevListEntry {
 299     Audiodev *dev;
 300     QSIMPLEQ_ENTRY(AudiodevListEntry) next;
 301 } AudiodevListEntry;
 302
 303 typedef QSIMPLEQ_HEAD(, AudiodevListEntry) AudiodevListHead;
 304 AudiodevListHead audio_handle_legacy_opts(void);
 305
 306 void audio_free_audiodev_list(AudiodevListHead *head);
 307
 308 void audio_create_pdos(Audiodev *dev);
 309 AudiodevPerDirectionOptions *audio_get_pdo_in(Audiodev *dev);
 310 AudiodevPerDirectionOptions *audio_get_pdo_out(Audiodev *dev);
 311
 312 #endif /* QEMU_AUDIO_INT_H */