audio/audio.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 #ifndef QEMU_AUDIO_H
  25 #define QEMU_AUDIO_H
  26
  27 #include "config.h"
  28 #include "sys-queue.h"
  29
  30 typedef void (*audio_callback_fn_t) (void *opaque, int avail);
  31
  32 typedef enum {
  33     AUD_FMT_U8,
  34     AUD_FMT_S8,
  35     AUD_FMT_U16,
  36     AUD_FMT_S16,
  37     AUD_FMT_U32,
  38     AUD_FMT_S32
  39 } audfmt_e;
  40
  41 #ifdef WORDS_BIGENDIAN
  42 #define AUDIO_HOST_ENDIANNESS 1
  43 #else
  44 #define AUDIO_HOST_ENDIANNESS 0
  45 #endif
  46
  47 typedef struct {
  48     int freq;
  49     int nchannels;
  50     audfmt_e fmt;
  51     int endianness;
  52 } audsettings_t;
  53
  54 typedef enum {
  55     AUD_CNOTIFY_ENABLE,
  56     AUD_CNOTIFY_DISABLE
  57 } audcnotification_e;
  58
  59 struct audio_capture_ops {
  60     void (*notify) (void *opaque, audcnotification_e cmd);
  61     void (*capture) (void *opaque, void *buf, int size);
  62     void (*destroy) (void *opaque);
  63 };
  64
  65 struct capture_ops {
  66     void (*info) (void *opaque);
  67     void (*destroy) (void *opaque);
  68 };
  69
  70 typedef struct CaptureState {
  71     void *opaque;
  72     struct capture_ops ops;
  73     LIST_ENTRY (CaptureState) entries;
  74 } CaptureState;
  75
  76 typedef struct AudioState AudioState;
  77 typedef struct SWVoiceOut SWVoiceOut;
  78 typedef struct CaptureVoiceOut CaptureVoiceOut;
  79 typedef struct SWVoiceIn SWVoiceIn;
  80
  81 typedef struct QEMUSoundCard {
  82     AudioState *audio;
  83     char *name;
  84     LIST_ENTRY (QEMUSoundCard) entries;
  85 } QEMUSoundCard;
  86
  87 typedef struct QEMUAudioTimeStamp {
  88     uint64_t old_ts;
  89 } QEMUAudioTimeStamp;
  90
  91 void AUD_vlog (const char *cap, const char *fmt, va_list ap);
  92 void AUD_log (const char *cap, const char *fmt, ...)
  93 #ifdef __GNUC__
  94     __attribute__ ((__format__ (__printf__, 2, 3)))
  95 #endif
  96     ;
  97
  98 AudioState *AUD_init (void);
  99 void AUD_help (void);
 100 void AUD_register_card (AudioState *s, const char *name, QEMUSoundCard *card);
 101 void AUD_remove_card (QEMUSoundCard *card);
 102 CaptureVoiceOut *AUD_add_capture (
 103     AudioState *s,
 104     audsettings_t *as,
 105     struct audio_capture_ops *ops,
 106     void *opaque
 107     );
 108 void AUD_del_capture (CaptureVoiceOut *cap, void *cb_opaque);
 109
 110 SWVoiceOut *AUD_open_out (
 111     QEMUSoundCard *card,
 112     SWVoiceOut *sw,
 113     const char *name,
 114     void *callback_opaque,
 115     audio_callback_fn_t callback_fn,
 116     audsettings_t *settings
 117     );
 118
 119 void AUD_close_out (QEMUSoundCard *card, SWVoiceOut *sw);
 120 int  AUD_write (SWVoiceOut *sw, void *pcm_buf, int size);
 121 int  AUD_get_buffer_size_out (SWVoiceOut *sw);
 122 void AUD_set_active_out (SWVoiceOut *sw, int on);
 123 int  AUD_is_active_out (SWVoiceOut *sw);
 124
 125 void     AUD_init_time_stamp_out (SWVoiceOut *sw, QEMUAudioTimeStamp *ts);
 126 uint64_t AUD_get_elapsed_usec_out (SWVoiceOut *sw, QEMUAudioTimeStamp *ts);
 127
 128 SWVoiceIn *AUD_open_in (
 129     QEMUSoundCard *card,
 130     SWVoiceIn *sw,
 131     const char *name,
 132     void *callback_opaque,
 133     audio_callback_fn_t callback_fn,
 134     audsettings_t *settings
 135     );
 136
 137 void AUD_close_in (QEMUSoundCard *card, SWVoiceIn *sw);
 138 int  AUD_read (SWVoiceIn *sw, void *pcm_buf, int size);
 139 void AUD_set_active_in (SWVoiceIn *sw, int on);
 140 int  AUD_is_active_in (SWVoiceIn *sw);
 141
 142 void     AUD_init_time_stamp_in (SWVoiceIn *sw, QEMUAudioTimeStamp *ts);
 143 uint64_t AUD_get_elapsed_usec_in (SWVoiceIn *sw, QEMUAudioTimeStamp *ts);
 144
 145 static inline void *advance (void *p, int incr)
 146 {
 147     uint8_t *d = p;
 148     return (d + incr);
 149 }
 150
 151 uint32_t popcount (uint32_t u);
 152 uint32_t lsbindex (uint32_t u);
 153
 154 #ifdef __GNUC__
 155 #define audio_MIN(a, b) ( __extension__ ({      \
 156     __typeof (a) ta = a;                        \
 157     __typeof (b) tb = b;                        \
 158     ((ta)>(tb)?(tb):(ta));                      \
 159 }))
 160
 161 #define audio_MAX(a, b) ( __extension__ ({      \
 162     __typeof (a) ta = a;                        \
 163     __typeof (b) tb = b;                        \
 164     ((ta)<(tb)?(tb):(ta));                      \
 165 }))
 166 #else
 167 #define audio_MIN(a, b) ((a)>(b)?(b):(a))
 168 #define audio_MAX(a, b) ((a)<(b)?(b):(a))
 169 #endif
 170
 171 #endif  /* audio.h */