src/include/gnunet_microphone_lib.h

   1 /*
   2   This file is part of GNUnet
   3   (C) 2013 Christian Grothoff (and other contributing authors)
   4
   5   GNUnet is free software; you can redistribute it and/or modify
   6   it under the terms of the GNU General Public License as published
   7   by the Free Software Foundation; either version 3, or (at your
   8   option) any later version.
   9
  10   GNUnet 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 GNUnet; see the file COPYING.  If not, write to the
  17   Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18   Boston, MA 02111-1307, USA.
  19  */
  20
  21 /**
  22  * @file include/gnunet_microphone_lib.h
  23  * @brief API to access an audio microphone; provides access to hardware microphones
  24  * @author Simon Dieterle
  25  * @author Andreas Fuchs
  26  * @author Christian Grothoff
  27  */
  28 #ifndef GNUNET_MICROPHONE_SERVICE_H
  29 #define GNUNET_MICROPHONE_SERVICE_H
  30
  31 #ifdef __cplusplus
  32 extern "C"
  33 {
  34 #if 0                           /* keep Emacsens' auto-indent happy */
  35 }
  36 #endif
  37 #endif
  38
  39 #include "gnunet_util_lib.h"
  40
  41 /**
  42  * Process recorded audio data.
  43  *
  44  * @param cls clsoure
  45  * @param data_size number of bytes in @a data
  46  * @param data audio data to play
  47  */
  48 typedef void (*GNUNET_MICROPHONE_RecordedDataCallback)(void *cls,
  49                                                        size_t data_size,
  50                                                        const void *data);
  51
  52 /**
  53  * Enable a microphone.
  54  *
  55  * @param cls clsoure
  56  * @param rdc function to call with recorded data
  57  * @param rdc_cls closure for @a dc
  58  * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
  59  */
  60 typedef int (*GNUNET_MICROPHONE_EnableCallback)(void *cls,
  61                                                 GNUNET_MICROPHONE_RecordedDataCallback rdc,
  62                                                 void *rdc_cls);
  63
  64 /**
  65  * Function that disables a microphone.
  66  *
  67  * @param cls clsoure
  68  */
  69 typedef void (*GNUNET_MICROPHONE_DisableCallback)(void *cls);
  70
  71 /**
  72  * Function to destroy a microphone.
  73  *
  74  * @param cls clsoure
  75  */
  76 typedef void (*GNUNET_MICROPHONE_DestroyCallback)(void *cls);
  77
  78
  79 /**
  80  * A microphone is a device that can play or record audio data.
  81  */
  82 struct GNUNET_MICROPHONE_Handle
  83 {
  84
  85   /**
  86    * Turn on the microphone.
  87    */
  88   GNUNET_MICROPHONE_EnableCallback enable_microphone;
  89
  90   /**
  91    * Turn the microphone off.
  92    */
  93   GNUNET_MICROPHONE_DisableCallback disable_microphone;
  94
  95   /**
  96    * Destroy the microphone.  Called by #GNUNET_MICROPHONE_destroy.
  97    */
  98   GNUNET_MICROPHONE_DestroyCallback destroy_microphone;
  99
 100   /**
 101    * Closure for the callbacks.
 102    */
 103   void *cls;
 104
 105 };
 106
 107
 108 /**
 109  * Create a microphone that corresponds to the microphone hardware
 110  * of our system.
 111  *
 112  * @param cfg configuration to use
 113  * @return NULL on error
 114  */
 115 struct GNUNET_MICROPHONE_Handle *
 116 GNUNET_MICROPHONE_create_from_hardware (const struct GNUNET_CONFIGURATION_Handle *cfg);
 117
 118
 119 /**
 120  * Destroy a microphone.
 121  *
 122  * @param microphone microphone to destroy
 123  */
 124 void
 125 GNUNET_MICROPHONE_destroy (struct GNUNET_MICROPHONE_Handle *microphone);
 126
 127
 128 #if 0                           /* keep Emacsens' auto-indent happy */
 129 {
 130 #endif
 131 #ifdef __cplusplus
 132 }
 133 #endif
 134
 135 #endif
 136 /* end of gnunet_microphone_lib.h */