usr/src/cmd/bhyve/audio.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   3  *
   4  * Copyright (c) 2016 Alex Teaca <iateaca@FreeBSD.org>
   5  * All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND
  17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26  * SUCH DAMAGE.
  27  *
  28  * $FreeBSD$
  29  */
  30
  31 #ifndef _AUDIO_EMUL_H_
  32 #define _AUDIO_EMUL_H_
  33
  34 #include <sys/types.h>
  35 #include <sys/soundcard.h>
  36
  37 /*
  38  * Audio Player data structures
  39  */
  40
  41 struct audio;
  42
  43 struct audio_params {
  44         int channels;
  45         int format;
  46         int rate;
  47 };
  48
  49 /*
  50  * Audio Player API
  51  */
  52
  53 /*
  54  * audio_init - initialize an instance of audio player
  55  * @dev_name - the backend sound device used to play / capture
  56  * @dir - dir = 1 for write mode, dir = 0 for read mode
  57  * Returns NULL on error and the address of the audio player instance
  58  */
  59 struct audio *audio_init(const char *dev_name, uint8_t dir);
  60
  61 /*
  62  * audio_set_params - reset the sound device and set the audio params
  63  * @aud - the audio player to be configured
  64  * @params - the audio parameters to be set
  65  * Returns -1 on error and 0 on success
  66  */
  67 int audio_set_params(struct audio *aud, struct audio_params *params);
  68
  69 /*
  70  * audio_playback - plays samples to the sound device using blocking operations
  71  * @aud - the audio player used to play the samples
  72  * @buf - the buffer containing the samples
  73  * @count - the number of bytes in buffer
  74  * Returns -1 on error and 0 on success
  75  */
  76 int audio_playback(struct audio *aud, const uint8_t *buf, size_t count);
  77
  78 /*
  79  * audio_record - records samples from the sound device using blocking
  80  * operations.
  81  * @aud - the audio player used to capture the samples
  82  * @buf - the buffer to receive the samples
  83  * @count - the number of bytes to capture in buffer
  84  * Returns -1 on error and 0 on success
  85  */
  86 int audio_record(struct audio *aud, uint8_t *buf, size_t count);
  87
  88 #endif  /* _AUDIO_EMUL_H_ */