chiark - git - mdw - disorder/blob - lib/alsabg.h

   1 /*
   2  * This file is part of DisOrder.
   3  * Copyright (C) 2008 Richard Kettlewell
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful, but
  11  * WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software
  17  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  18  * USA
  19  */
  20 /** @file alsabg.h
  21  * @brief Background-thread interface to ALSA
  22  *
  23  * This wraps ALSA with an interface which calls back to the client from a
  24  * thread.  It's not intended for completely general use, just what DisOrder
  25  * needs.
  26  */
  27
  28 #ifndef ALSABG_H
  29 #define ALSABG_H
  30
  31 /** @brief Supply audio callback
  32  * @param dst Where to write audio data
  33  * @param nsamples Number of samples to write
  34  *
  35  * This function should write up to @p *nsamples samples of data at
  36  * @p dst, and return the number of samples written, or -1 if some error
  37  * occurred.  It will be called in a background thread.
  38  */
  39 typedef int alsa_bg_supply(void *dst,
  40                            unsigned nsamples_max);
  41
  42 void alsa_bg_init(const char *dev,
  43                   alsa_bg_supply *supply);
  44
  45 void alsa_bg_enable(void);
  46
  47 void alsa_bg_disable(void);
  48
  49 void alsa_bg_close(void);
  50
  51 #endif /* ALSABG_H */
  52
  53 /*
  54 Local Variables:
  55 c-basic-offset:2
  56 comment-column:40
  57 fill-column:79
  58 indent-tabs-mode:nil
  59 End:
  60 */