summaryrefslogtreecommitdiff
path: root/include/cdio/cdio.h
diff options
context:
space:
mode:
Diffstat (limited to 'include/cdio/cdio.h')
-rw-r--r--include/cdio/cdio.h84
1 files changed, 84 insertions, 0 deletions
diff --git a/include/cdio/cdio.h b/include/cdio/cdio.h
new file mode 100644
index 00000000..84e54b10
--- /dev/null
+++ b/include/cdio/cdio.h
@@ -0,0 +1,84 @@
+/* -*- c -*-
+ $Id: cdio.h,v 1.82 2008/03/25 15:59:08 karl Exp $
+
+ Copyright (C) 2003, 2004, 2005, 2008 Rocky Bernstein <rocky@gnu.org>
+ Copyright (C) 2001 Herbert Valerio Riedel <hvr@gnu.org>
+
+ This program 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 3 of the License, or
+ (at your option) any later version.
+
+ This program 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 this program. If not, see <http://www.gnu.org/licenses/>.
+*/
+
+/** \file cdio.h
+ *
+ * \brief The top-level header for libcdio: the CD Input and Control
+ * library. Applications include this for anything regarding libcdio.
+ */
+
+
+#ifndef __CDIO_H__
+#define __CDIO_H__
+
+/** Application Interface or Protocol version number. If the public
+ * interface changes, we increase this number.
+ */
+#define CDIO_API_VERSION 5
+
+#include <cdio/version.h>
+
+#ifdef HAVE_SYS_TYPES_H
+#include <sys/types.h>
+#endif
+#ifdef HAVE_UNISTD_H
+#include <unistd.h>
+#endif
+
+#include <cdio/types.h>
+#include <cdio/sector.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif /* __cplusplus */
+
+/* For compatibility. */
+#define CdIo CdIo_t
+
+ /** This is an opaque structure for the CD object. */
+ typedef struct _CdIo CdIo_t;
+
+ /** This is an opaque structure for the CD-Text object. */
+ typedef struct cdtext cdtext_t;
+
+#ifdef __cplusplus
+}
+#endif /* __cplusplus */
+
+/* Drive(r)/Device-related functions. Perhaps we should break out
+ Driver from device?
+*/
+#include <cdio/device.h>
+
+/* Disc-related functions. */
+#include <cdio/disc.h>
+
+/* Sector (frame, or block)-related functions. Uses driver_return_code_t
+ from <cdio/device.h> so it should come after that.
+*/
+#include <cdio/read.h>
+
+/* CD-Text-related functions. */
+#include <cdio/cdtext.h>
+
+/* Track-related functions. */
+#include <cdio/track.h>
+
+#endif /* __CDIO_H__ */