claunia/libcdio-osx
Archived
1
0
Fork 0
Code Issues 2 Pull Requests Actions Packages Projects Releases Wiki Activity

doxygen changes.

Browse Source
This commit is contained in:
rocky
2003-11-04 12:28:08 +00:00
parent 28cd39064d
commit 05beaf71de
3 changed files with 106 additions and 87 deletions
Download Patch File Download Diff File Expand all files Collapse all files

58
include/cdio/cd_types.h
View File

@@ -1,5 +1,5 @@
/* /*
$Id: cd_types.h,v 1.4 2003/11/04 04:45:24 rocky Exp $ $Id: cd_types.h,v 1.5 2003/11/04 12:28:08 rocky Exp $
Copyright (C) 2003 Rocky Bernstein <rocky@panix.com> Copyright (C) 2003 Rocky Bernstein <rocky@panix.com>
Copyright (C) 1996,1997,1998 Gerd Knorr <kraxel@bytesex.org> Copyright (C) 1996,1997,1998 Gerd Knorr <kraxel@bytesex.org>
@@ -27,17 +27,21 @@
extern "C" { extern "C" {
#endif /* __cplusplus */ #endif /* __cplusplus */
/*! /**
Filesystem types we understand. The highest-numbered fs type should * Filesystem types we understand. The highest-numbered fs type should
be less than CDIO_FS_MASK defined below. * be less than CDIO_FS_MASK defined below.
*/ */
#define CDIO_FS_AUDIO 1 /**< audio only - not really a
#define CDIO_FS_AUDIO 1 /* audio only - not really a fs */ filesystem */
#define CDIO_FS_HIGH_SIERRA 2 #define CDIO_FS_HIGH_SIERRA 2
#define CDIO_FS_ISO_9660 3 #define CDIO_FS_ISO_9660 3 /**< ISO 9660 filesystem */
#define CDIO_FS_INTERACTIVE 4 #define CDIO_FS_INTERACTIVE 4
#define CDIO_FS_HFS 5 #define CDIO_FS_HFS 5 /**< file system used on the Macintosh
#define CDIO_FS_UFS 6 system in MacOS 6 through MacOS 9
and depricated in OSX. */
#define CDIO_FS_UFS 6 /**< Generic Unix file system derived
from the Berkeley fast file
system. */
/** /**
* EXT2 was the GNU/Linux native filesystem for early kernels. Newer * EXT2 was the GNU/Linux native filesystem for early kernels. Newer
@@ -54,14 +58,16 @@ extern "C" {
* company. These specs are for making a 3DO Interactive Multiplayer * company. These specs are for making a 3DO Interactive Multiplayer
* which uses a CD-player. Panasonic in the early 90's was the first * which uses a CD-player. Panasonic in the early 90's was the first
* company to manufacture and market a 3DO player. * company to manufacture and market a 3DO player.
*/ */
#define CDIO_FS_3DO 10 #define CDIO_FS_3DO 10
#define CDIO_FS_MASK 15 /* Should be 2*n-1 and > above */ #define CDIO_FS_MASK 15 /**< Note: this should be 2**n-1 and
and greater than the highest
CDIO_FS number above */
#define CDIO_FS_UNKNOWN CDIO_FS_MASK #define CDIO_FS_UNKNOWN CDIO_FS_MASK
/** /**
*Macro to extract just the FS type portion defined above * Macro to extract just the FS type portion defined above
*/ */
#define CDIO_FSTYPE(fs) (fs & CDIO_FS_MASK) #define CDIO_FSTYPE(fs) (fs & CDIO_FS_MASK)
@@ -78,23 +84,31 @@ extern "C" {
#define CDIO_FS_ANAL_CDTV 256 #define CDIO_FS_ANAL_CDTV 256
#define CDIO_FS_ANAL_BOOTABLE 512 /**< CD is bootable */ #define CDIO_FS_ANAL_BOOTABLE 512 /**< CD is bootable */
#define CDIO_FS_ANAL_VIDEOCD 1024 /**< VCD 1.1 */ #define CDIO_FS_ANAL_VIDEOCD 1024 /**< VCD 1.1 */
#define CDIO_FS_ANAL_ROCKRIDGE 2048 #define CDIO_FS_ANAL_ROCKRIDGE 2048 /**< Has Rock Ridge Extensions to
#define CDIO_FS_ANAL_JOLIET 4096 /**< Has Joliet extensions */ ISO 9660 */
#define CDIO_FS_ANAL_JOLIET 4096 /**< Microsoft Joliet extensions
to ISO 9660 */
#define CDIO_FS_ANAL_SVCD 8192 /**< Super VCD or Choiji Video CD */ #define CDIO_FS_ANAL_SVCD 8192 /**< Super VCD or Choiji Video CD */
#define CDIO_FS_ANAL_CVD 16384 /**< Choiji Video CD */ #define CDIO_FS_ANAL_CVD 16384 /**< Choiji Video CD */
/** /**
*Pattern which can be used by cdio_get_devices to specify matching * Pattern which can be used by cdio_get_devices to specify matching
any sort of CD. * any sort of CD.
*/ */
#define CDIO_FS_MATCH_ALL (cdio_fs_anal_t) (~CDIO_FS_MASK) #define CDIO_FS_MATCH_ALL (cdio_fs_anal_t) (~CDIO_FS_MASK)
/**
* The type used to return analysis information from
* cdio_guess_cd_type. These fields make sense only for when an ISO 9660
* filesystem is used.
*/
typedef struct typedef struct
{ {
unsigned int joliet_level; unsigned int joliet_level; /**< If has Joliet extensions, this is the
char iso_label[33]; /* 32 + 1 for null byte at the end in associated level number (i.e. 1, 2, or 3). */
formatting the string */ char iso_label[33]; /**< This is 32 + 1 for null byte at the end in
formatting the string */
unsigned int isofs_size; unsigned int isofs_size;
} cdio_analysis_t; } cdio_analysis_t;

128
include/cdio/cdio.h
View File

@@ -1,5 +1,5 @@
/* -*- c -*- /* -*- c -*-
$Id: cdio.h,v 1.31 2003/10/04 23:11:50 rocky Exp $ $Id: cdio.h,v 1.32 2003/11/04 12:28:08 rocky Exp $
Copyright (C) 2001 Herbert Valerio Riedel <hvr@gnu.org> Copyright (C) 2001 Herbert Valerio Riedel <hvr@gnu.org>
Copyright (C) 2003 Rocky Bernstein <rocky@panix.com> Copyright (C) 2003 Rocky Bernstein <rocky@panix.com>
@@ -25,8 +25,8 @@
#ifndef __CDIO_H__ #ifndef __CDIO_H__
#define __CDIO_H__ #define __CDIO_H__
/* Application Interface or Protocol version number. If the public /** Application Interface or Protocol version number. If the public
interface changes, we increase this number. * interface changes, we increase this number.
*/ */
#define CDIO_API_VERSION 1 #define CDIO_API_VERSION 1
@@ -43,8 +43,9 @@
#include <cdio/sector.h> #include <cdio/sector.h>
/* Flags specifying the category of device to open or is opened. */ /* Flags specifying the category of device to open or is opened. */
#define CDIO_SRC_IS_DISK_IMAGE_MASK 0x0001
#define CDIO_SRC_IS_DEVICE_MASK 0x0002 #define CDIO_SRC_IS_DISK_IMAGE_MASK 0x0001 /**< Read source is a CD image. */
#define CDIO_SRC_IS_DEVICE_MASK 0x0002 /**< Read source is a CD device. */
#define CDIO_SRC_IS_SCSI_MASK 0x0004 #define CDIO_SRC_IS_SCSI_MASK 0x0004
#define CDIO_SRC_IS_NATIVE_MASK 0x0008 #define CDIO_SRC_IS_NATIVE_MASK 0x0008
@@ -52,55 +53,58 @@
extern "C" { extern "C" {
#endif /* __cplusplus */ #endif /* __cplusplus */
/* opaque structure */ /** This is an opaque structure. */
typedef struct _CdIo CdIo; typedef struct _CdIo CdIo;
/* The below enumerations may be used to tag a specific driver /** The below enumerations may be used to tag a specific driver
that is opened or is desired to be opened. Note that this is * that is opened or is desired to be opened. Note that this is
different than what is available on a given host. * different than what is available on a given host.
*
Order is a little significant since the order is used in scans. * Order is a little significant since the order is used in scans.
We have to start with UNKNOWN and devices should come before * We have to start with UNKNOWN and devices should come before
disk-image readers. By putting something towards the top (a lower * disk-image readers. By putting something towards the top (a lower
enumeration number), in an iterative scan we prefer that to something * enumeration number), in an iterative scan we prefer that to
with a higher enumeration number. * something with a higher enumeration number.
*
NOTE: IF YOU MODIFY ENUM MAKE SURE INITIALIZATION IN CDIO.C AGREES. * NOTE: IF YOU MODIFY ENUM MAKE SURE INITIALIZATION IN CDIO.C AGREES.
*
*/ */
typedef enum { typedef enum {
DRIVER_UNKNOWN, DRIVER_UNKNOWN,
DRIVER_BSDI, DRIVER_BSDI, /**< BSDI driver */
DRIVER_FREEBSD, DRIVER_FREEBSD, /**< FreeBSD driver */
DRIVER_LINUX, DRIVER_LINUX, /**< GNU/Linux Driver */
DRIVER_SOLARIS, DRIVER_SOLARIS, /**< Sun Solaris Driver */
DRIVER_OSX, DRIVER_OSX, /**< Apple OSX Driver */
DRIVER_WIN32, DRIVER_WIN32, /**< Microsoft Windows Driver */
DRIVER_BINCUE, /* Prefer bincue over nrg when both exist */ DRIVER_BINCUE, /**< BIN/CUE format CD image. This is listed before NRG,
DRIVER_NRG, to make the code prefer BINCUE over NRG when both
DRIVER_DEVICE /* Is really a set of the above; should come last */ exist. */
DRIVER_NRG, /**< Nero NRG format CD image. */
DRIVER_DEVICE /**< Is really a set of the above; should come last */
} driver_id_t; } driver_id_t;
/* Make sure what's listed below is the last one above. Since we have /** Make sure what's listed for CDIO_MIN_DRIVER is the last
a bogus (but useful) 0th entry above we don't have to add one below. enumeration in driver_id_t. Since we have a bogus (but useful) 0th
*/ entry above we don't have to add one below.
*/
#define CDIO_MIN_DRIVER DRIVER_BSDI #define CDIO_MIN_DRIVER DRIVER_BSDI
#define CDIO_MIN_DEVICE_DRIVER CDIO_MIN_DRIVER #define CDIO_MIN_DEVICE_DRIVER CDIO_MIN_DRIVER
#define CDIO_MAX_DRIVER DRIVER_NRG #define CDIO_MAX_DRIVER DRIVER_NRG
#define CDIO_MAX_DEVICE_DRIVER DRIVER_WIN32 #define CDIO_MAX_DEVICE_DRIVER DRIVER_WIN32
typedef enum { typedef enum {
TRACK_FORMAT_AUDIO, /* Audio track, e.g. CD-DA */ TRACK_FORMAT_AUDIO, /**< Audio track, e.g. CD-DA */
TRACK_FORMAT_CDI, /* CD-i. How this is different from DATA below? */ TRACK_FORMAT_CDI, /**< CD-i. How this is different from DATA below? */
TRACK_FORMAT_XA, /* Mode2 of some sort */ TRACK_FORMAT_XA, /**< Mode2 of some sort */
TRACK_FORMAT_DATA, /* Mode1 of some sort */ TRACK_FORMAT_DATA, /**< Mode1 of some sort */
TRACK_FORMAT_PSX, /* Playstation CD. Like audio but only 2336 bytes TRACK_FORMAT_PSX, /**< Playstation CD. Like audio but only 2336 bytes
of user data. * of user data.
*/ */
TRACK_FORMAT_ERROR /* Dunno what is or some other error. */ TRACK_FORMAT_ERROR /**< Dunno what is, or some other error. */
} track_format_t; } track_format_t;
/* Printable tags for above enumeration. */ /*! Printable tags for track_format_t enumeration. */
extern const char *track_format2str[6]; extern const char *track_format2str[6];
/*! /*!
@@ -144,7 +148,7 @@ extern "C" {
char ** cdio_get_devices_with_cap (char* search_devices[], char ** cdio_get_devices_with_cap (char* search_devices[],
cdio_fs_anal_t capabilities, bool any); cdio_fs_anal_t capabilities, bool any);
/*!Return an array of device names. If you want a specific /*! Return an array of device names. If you want a specific
devices, dor a driver give that device, if you want hardware devices, dor a driver give that device, if you want hardware
devices, give DRIVER_DEVICE and if you want all possible devices, devices, give DRIVER_DEVICE and if you want all possible devices,
image drivers and hardware drivers give DRIVER_UNKNOWN. image drivers and hardware drivers give DRIVER_UNKNOWN.
@@ -190,7 +194,7 @@ extern "C" {
track_t cdio_get_num_tracks (const CdIo *obj); track_t cdio_get_num_tracks (const CdIo *obj);
/*! /*!
Get format of track. Get the format (audio, mode2, mode1) of track.
*/ */
track_format_t cdio_get_track_format(const CdIo *obj, track_t track_num); track_format_t cdio_get_track_format(const CdIo *obj, track_t track_num);
@@ -255,39 +259,39 @@ extern "C" {
ssize_t cdio_read(const CdIo *obj, void *buf, size_t size); ssize_t cdio_read(const CdIo *obj, void *buf, size_t size);
/*! /*!
Reads a audio sector from cd device into data starting Reads a audio sector from cd device into data starting
from lsn. Returns 0 if no error. from lsn. Returns 0 if no error.
*/ */
int cdio_read_audio_sector (const CdIo *obj, void *buf, lsn_t lsn); int cdio_read_audio_sector (const CdIo *obj, void *buf, lsn_t lsn);
/*! /*!
Reads a audio sector from cd device into data starting Reads a audio sector from cd device into data starting
from lsn. Returns 0 if no error. from lsn. Returns 0 if no error.
*/ */
int cdio_read_audio_sectors (const CdIo *obj, void *buf, lsn_t lsn, int cdio_read_audio_sectors (const CdIo *obj, void *buf, lsn_t lsn,
unsigned int nblocks); unsigned int nblocks);
/*! /*!
Reads a single mode1 sector from cd device into data starting Reads a single mode1 sector from cd device into data starting
from lsn. Returns 0 if no error. from lsn. Returns 0 if no error.
*/ */
int cdio_read_mode1_sector (const CdIo *obj, void *buf, lsn_t lsn, int cdio_read_mode1_sector (const CdIo *obj, void *buf, lsn_t lsn,
bool is_form2); bool is_form2);
/*! /*!
Reads nblocks of mode1 sectors from cd device into data starting Reads nblocks of mode1 sectors from cd device into data starting
from lsn. Returns 0 if no error. from lsn. Returns 0 if no error.
*/ */
int cdio_read_mode1_sectors (const CdIo *obj, void *buf, lsn_t lsn, int cdio_read_mode1_sectors (const CdIo *obj, void *buf, lsn_t lsn,
bool is_form2, unsigned int num_sectors); bool is_form2, unsigned int num_sectors);
/*! /*!
Reads a single mode2 sector from cd device into data starting Reads a single mode2 sector from cd device into data starting
from lsn. Returns 0 if no error. from lsn. Returns 0 if no error.
*/ */
int cdio_read_mode2_sector (const CdIo *obj, void *buf, lsn_t lsn, int cdio_read_mode2_sector (const CdIo *obj, void *buf, lsn_t lsn,
bool is_form2); bool is_form2);
/*! /*!
Reads nblocks of mode2 sectors from cd device into data starting Reads nblocks of mode2 sectors from cd device into data starting
from lsn. from lsn.
@@ -306,12 +310,12 @@ extern "C" {
Return the size of the CD in logical block address (LBA) units. Return the size of the CD in logical block address (LBA) units.
*/ */
uint32_t cdio_stat_size (const CdIo *obj); uint32_t cdio_stat_size (const CdIo *obj);
/*! /*!
Initialize CD Reading and control routines. Should be called first. Initialize CD Reading and control routines. Should be called first.
*/ */
bool cdio_init(void); bool cdio_init(void);
/* True if xxx driver is available. where xxx=linux, solaris, nrg, ... /* True if xxx driver is available. where xxx=linux, solaris, nrg, ...
*/ */
bool cdio_have_bsdi (void); bool cdio_have_bsdi (void);
@@ -326,13 +330,13 @@ extern "C" {
/* Like above but uses the enumeration instead. */ /* Like above but uses the enumeration instead. */
bool cdio_have_driver (driver_id_t driver_id); bool cdio_have_driver (driver_id_t driver_id);
/* Return a string decribing driver_id. */ /*! Return a string decribing driver_id. */
const char *cdio_driver_describe (driver_id_t driver_id); const char *cdio_driver_describe (driver_id_t driver_id);
/*! Sets up to read from place specified by source_name and /*! Sets up to read from place specified by source_name and
driver_id This should be called before using any other routine, driver_id This should be called before using any other routine,
except cdio_init. This will call cdio_init, if that hasn't been except cdio_init. This will call cdio_init, if that hasn't been
done previously. to call one of the specific routines below. done previously. to call one of the specific routines below.
NULL is returned on error. NULL is returned on error.
*/ */

7
include/cdio/logging.h
View File

@@ -1,7 +1,8 @@
/* /*
$Id: logging.h,v 1.4 2003/11/04 04:45:24 rocky Exp $ $Id: logging.h,v 1.5 2003/11/04 12:28:08 rocky Exp $
Copyright (C) 2000 Herbert Valerio Riedel <hvr@gnu.org> Copyright (C) 2000, Herbert Valerio Riedel <hvr@gnu.org>
Copyright (C) 2003, Rocky Bernstein <rocky@panix.com>
This program is free software; you can redistribute it and/or modify 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 it under the terms of the GNU General Public License as published by
@@ -107,7 +108,7 @@ void cdio_warn (const char format[], ...) GNUC_PRINTF(1,2);
/** /**
* Handle an error message. * Handle an error message.
* *
* @see cdio_log for a more generic routine * @see cdio_log for a more generic routine.
*/ */
void cdio_error (const char format[], ...) GNUC_PRINTF(1,2); void cdio_error (const char format[], ...) GNUC_PRINTF(1,2);