New audio subsystem.

[jog] / auerr.h

diff --git a/auerr.h b/auerr.h
new file mode 100644 (file)
index 0000000..bbc15d6
--- /dev/null
+++ b/auerr.h
@@ -0,0 +1,77 @@
+/* -*-c-*-
+ *
+ * $Id: auerr.h,v 1.1 2002/02/02 19:16:28 mdw Exp $
+ *
+ * Audio error reporting
+ *
+ * (c) 2002 Mark Wooding
+ */
+
+/*----- Licensing notice --------------------------------------------------* 
+ *
+ * This file is part of Jog: Programming for a jogging machine.
+ *
+ * Jog is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ * 
+ * Jog is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ * 
+ * You should have received a copy of the GNU General Public License
+ * along with Jog; if not, write to the Free Software Foundation,
+ * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ */
+
+/*----- Revision history --------------------------------------------------* 
+ *
+ * $Log: auerr.h,v $
+ * Revision 1.1  2002/02/02 19:16:28  mdw
+ * New audio subsystem.
+ *
+ */
+
+#ifndef AUERR_H
+#define AUERR_H
+
+#ifdef __cplusplus
+  extern "C" {
+#endif
+
+/*----- Functions provided ------------------------------------------------*/
+
+/* --- @auerr@ --- *
+ *
+ * Arguments:  @int ctx@ = context code
+ *             @int reason@ = reason code
+ *             @unsigned long err@ = error code
+ *
+ * Returns:    ---
+ *
+ * Use:                Reports an error to the audio output.
+ */
+
+extern void auerr(int /*ctx*/, int /*reason*/, unsigned long /*err*/);
+
+/* --- @auerr_abort@ --- *
+ *
+ * Arguments:  @int reason@ = abort reason code
+ *             @unsigned long err@ = error code
+ *
+ * Returns:    ---
+ *
+ * Use:                Reports an abort message to te audio output.
+ */
+
+extern void auerr_abort(int /*reason*/, unsigned long /*err*/);
+
+/*----- That's all, folks -------------------------------------------------*/
+
+#ifdef __cplusplus
+  }
+#endif
+
+#endif