include/core/audioapi-driver.hpp

   1 #ifndef _audioapi_driver__hpp__included__
   2 #define _audioapi_driver__hpp__included__
   3
   4 #include <stdexcept>
   5 #include <string>
   6 #include <map>
   7
   8 class audioapi_instance;
   9
  10 //All the following need to be implemented by the sound driver itself
  11 struct _audioapi_driver
  12 {
  13         //These correspond to various audioapi_driver_* functions.
  14         void (*init)() throw();
  15         void (*quit)() throw();
  16         void (*enable)(bool enable);
  17         bool (*initialized)();
  18         void (*set_device)(const std::string& pdev, const std::string& rdev);
  19         std::string (*get_device)(bool rec);
  20         std::map<std::string, std::string> (*get_devices)(bool rec);
  21         const char* (*name)();
  22 };
  23
  24 struct audioapi_driver
  25 {
  26         audioapi_driver(struct _audioapi_driver driver);
  27 };
  28
  29
  30 /**
  31  * Initialize the driver.
  32  */
  33 void audioapi_driver_init() throw();
  34
  35 /**
  36  * Deinitialize the driver.
  37  */
  38 void audioapi_driver_quit() throw();
  39
  40 /**
  41  * Enable or disable sound.
  42  *
  43  * parameter enable: Enable sounds if true, otherwise disable sounds.
  44  */
  45 void audioapi_driver_enable(bool enable) throw();
  46
  47 /**
  48  * Has the sound system been successfully initialized?
  49  *
  50  * Returns: True if sound system has successfully initialized, false otherwise.
  51  */
  52 bool audioapi_driver_initialized();
  53
  54 /**
  55  * Set sound device (playback).
  56  *
  57  * - If new sound device is invalid, the sound device is not changed.
  58  *
  59  * Parameter pdev: The new sound device (playback).
  60  * Parameter rdev: The new sound device (recording)
  61  */
  62 void audioapi_driver_set_device(const std::string& pdev, const std::string& rdev) throw(std::bad_alloc,
  63          std::runtime_error);
  64
  65 /**
  66  * Get current sound device (playback).
  67  *
  68  * Returns: The current sound device.
  69  */
  70 std::string audioapi_driver_get_device(bool rec) throw(std::bad_alloc);
  71
  72 /**
  73  * Get available sound devices (playback).
  74  *
  75  * Returns: The map of devices. Keyed by name of the device, values are human-readable names for devices.
  76  */
  77 std::map<std::string, std::string> audioapi_driver_get_devices(bool rec) throw(std::bad_alloc);
  78
  79 /**
  80  * Identification for sound plugin.
  81  */
  82 const char* audioapi_driver_name() throw();
  83
  84 /**
  85  * Add an instance to be mixed.
  86  */
  87 void audioapi_connect_instance(audioapi_instance& instance);
  88
  89 /**
  90  * Remove an instance from being mixed.
  91  */
  92 void audioapi_disconnect_instance(audioapi_instance& instance);
  93
  94 /**
  95  * Send a rate change.
  96  */
  97 void audioapi_send_rate_change(unsigned rrate, unsigned prate);
  98
  99 /**
 100  * Broadcast voice input to all instances.
 101  */
 102 void audioapi_put_voice(float* samples, size_t count);
 103
 104 /**
 105  * Get mixed music + voice out from all instances.
 106  */
 107 void audioapi_get_mixed(int16_t* samples, size_t count, bool stereo);
 108
 109 #endif