Copyright	(c) 2018-2021 Sam May
License	GPL-3.0-or-later
Maintainer	ag@eitilt.life
Stability	stable
Portability	non-portable (requires libcdio)
Safe Haskell	None
Language	Haskell2010

Foreign.Libcdio.Device

Contents

Types
- Capabilities
Drivers
Devices
Session
Device paths
- Hardware
- Images

Description

The entire library architecture revolves around the concept of a device—not the disc, but the drive containing it. A function to read a segment of data is not just a lookup from memory, but an instruction to the device to move the read arm into position and begin interpreting the pits and ridges. With that understanding, it makes sense that this module provides not just the means to determine what any particular drive is capable of, but also the only means to obtain the Cdio object the everything else revolves around.

`device.h`

Types

cdio_drive_cap_misc_t -> DriveCapabilityMisc
- CDIO_DRIVE_CAP_ERROR (removed; handled via Nothing)
- CDIO_DRIVE_CAP_UNKNOWN (removed; handled via Nothing)

cdio_drive_cap_read_t -> DriveCapabilityRead
- CDIO_DRIVE_CAP_READ_AUDIO -> ReadAnalogAudio
- CDIO_DRIVE_CAP_READ_CD_DA -> ReadDigitalAudio
- CDIO_DRIVE_CAP_READ_CD_R -> ReadCdRecordable
- CDIO_DRIVE_CAP_READ_CD_RW -> ReadCdReWritable
- CDIO_DRIVE_CAP_READ_DVD_R -> ReadDvdRecordable
- CDIO_DRIVE_CAP_READ_DVD_PR -> ReadDvdPlusRecordable
- CDIO_DRIVE_CAP_READ_DVD_RW -> ReadDvdReWritable
- CDIO_DRIVE_CAP_READ_DVD_PRW -> ReadDvdPlusReWritable
- CDIO_DRIVE_CAP_READ_C2_ERRS -> ReadC2ErrorCorrection
cdio_drive_cap_write_t -> DriveCapabilityWrite
Note that some values are not included in the Haskell type, as the indexing implementation is stricter than the equivalent bit operations in C.
- CDIO_DRIVE_CAP_WRITE_CD_R -> WriteCdRecordable
- CDIO_DRIVE_CAP_WRITE_CD_RW -> WriteCdReWritable
- CDIO_DRIVE_CAP_WRITE_DVD_R -> WriteDvdRecordable
- CDIO_DRIVE_CAP_WRITE_DVD_PR -> WriteDvdPlusRecordable
- CDIO_DRIVE_CAP_WRITE_DVD_RW -> WriteDvdReWritable
- CDIO_DRIVE_CAP_WRITE_DVD_PRW -> WriteDvdPlusReWritable
- CDIO_DRIVE_CAP_WRITE_CD -> capsWriteCd
- CDIO_DRIVE_CAP_WRITE_DVD -> capsWriteDvd
- CDIO_DRIVE_CAP_WRITE -> capsWrite
cdio_drive_misc_cap_t -> DriveMiscCaps
cdio_drive_read_cap_t -> DriveReadCaps
cdio_drive_write_cap_t -> DriveWriteCaps
cdio_hwinfo_t -> HardwareInfo
- psz_vendor -> vendor
- psz_model -> model
- psz_revision -> revision
cdio_mmc_hw_len_t (type removed; values are structural constants rather than an actual enum)
- CDIO_MMC_HW_VENDOR_LEN -> vendorLength
- CDIO_MMC_HW_MODEL_LEN -> modelLength
- CDIO_MMC_HW_REVISION_LEN -> revisionLength
cdio_src_category_mask_t (removed; never used in the public interface)
driver_id_t -> DriverId
driver_return_code_t -> DriverReturnCode

Symbols

cdio_close_tray -> closeTray
cdio_destroy (removed; handled via garbage collector)
cdio_device_drivers -> deviceDrivers
cdio_driver_describe -> driverDescribe
cdio_driver_errmsg -> driverErrmsg
cdio_drivers -> drivers
cdio_eject_media -> ejectMedia
cdio_eject_media_drive -> ejectDrive
cdio_free_device_list (removed; handled via garbage collector)
cdio_get_arg -> getArg and getAccessMode
cdio_get_default_device -> defaultDevice (CdIo_t* argument dropped as no non-redundant path to get one exists)
cdio_get_default_device_* (removed; defaultDeviceDriver provides the same functionality)
cdio_get_devices -> devices
cdio_get_devices_* (removed; devices provides the same functionality)
cdio_get_devices_with_cap -> devicesWithFilesystem
cdio_get_devices_with_cap_ret -> devicesWithFilesystemRet
cdio_get_drive_cap -> driveCap
cdio_get_drive_cap_dev -> driveCapDevice
cdio_get_driver_id -> driverId
cdio_get_driver_name -> driverName
cdio_get_hwinfo -> hwinfo
cdio_get_last_session -> lastSession
cdio_get_media_changed -> isMediaChanged
cdio_have_atapi -> haveAtapi
cdio_have_driver -> haveDriver
cdio_init (removed; internal function without much external occasion for use)
cdio_is_binfile -> cueFromBin
cdio_is_cuefile -> binFromCue
cdio_is_device -> isDevice
cdio_is_nrg -> isNrg
cdio_is_tocfile -> isToc
cdio_open -> cdioOpen
cdio_open_* (removed; cdioOpen provides the same functionality)
cdio_open_am -> cdioOpenAm
cdio_open_am_* (removed; cdioOpenAm provides the same functionality)
cdio_os_driver -> osDriver
cdio_set_arg (removed; primarily intended for internal use, and is more limited than would be expected)
cdio_set_blocksize -> setBlocksize
cdio_set_speed -> setSpeed

Sound.Libcdio.Device

Cdio -> Sound.Libcdio.Cdio (note, however, that the latter is a more abstracted Monad)
binFromCue -> isCue
cdioOpen -> Sound.Libcdio.open and openDefault
cdioOpenAm -> Sound.Libcdio.openMode and openModeDefault
cdioOpen* (removed; Sound.Libcdio.open handles the auto-detection)
closeTray -> closeDeviceTray and closeDeviceTray'
cueFromBin (removed; this and binFromCue just replace the file extension after validation, they don't go searching)
defaultDevice* (removed; driver type isn't a public part of device opening)
deviceDrivers -> not isImageDriver
devicesRet (removed; Sound.Libcdio.open doesn't require a specific DriverId to be passed)
devicesWithFilesystem (removed; can't think of a use case for searching for discs of a specific data layout)
devicesWithFilesystemRet (removed; can't think of a use case for searching for discs of a specific data layout)
devices* (removed; devices delegates via the DriverId parameter)
driveCap -> capabilities
driveCapDevice -> deviceCapabilities
driverId -> driver
ejectDrive -> ejectDevice
ejectMedia (removed; argument to e.g. Sound.Libcdio.open)
getArg -> Sound.Libcdio.getArg
getAccessMode -> Sound.Libcdio.getAccessMode
haveDriver (removed; use `elem` drivers)
hwinfo -> hardware
lastSession -> Sound.Libcdio.Read.Data.lastSessionOffset
modelLength (removed; unnecessary low-level detail)
revisionLength (removed; unnecessary low-level detail)
vendorLength (removed; unnecessary low-level detail)

Synopsis

data Cdio
data HardwareInfo = HardwareInfo {
- vendor :: String
- model :: String
- revision :: String
}
vendorLength :: Word
modelLength :: Word
revisionLength :: Word
emptyHardwareInfo :: HardwareInfo
data DriverId
- = DriverUnknown
- | DriverAix
- | DriverFreeBsd
- | DriverNetBsd
- | DriverLinux
- | DriverSolaris
- | DriverOsX
- | DriverWin32
- | DriverCdrDao
- | DriverBinCue
- | DriverNrg
- | DriverDevice
- | DriverBsdi
- | DriverOs2
data DriverReturnCode
- = MmcSenseData
- | NoDriver
- | BadPointer
- | BadParameter
- | NotPermitted
- | Uninitialized
- | Unsupported
- | DriverError
- | Success
data SessionArg
- = Source
- | Cue
- | ScsiTuple
- | MmcSupported
data AccessMode
- = Image
- | Ioctl
- | Ioctl_
- | Aspi
- | Atapi
- | Cam
- | Scsi
- | ReadCd
- | Read10
- | MmcReadWrite
- | MmcReadWriteExclusive
data DriveCapabilityRead
- = ReadAnalogAudio
- | ReadDigitalAudio
- | ReadCdGraphics
- | ReadCdRecordable
- | ReadCdReWritable
- | ReadDvdRecordable
- | ReadDvdPlusRecordable
- | ReadDvdRam
- | ReadDvdRom
- | ReadDvdReWritable
- | ReadDvdPlusReWritable
- | ReadC2ErrorCorrection
- | ReadMode2Form1
- | ReadMode2Form2
- | ReadMcn
- | ReadIsrc
type DriveReadCaps = BitArray DriveCapabilityRead
data DriveCapabilityWrite
- = WriteCdRecordable
- | WriteCdReWritable
- | WriteDvdRecordable
- | WriteDvdPlusRecordable
- | WriteDvdRam
- | WriteDvdReWritable
- | WriteDvdPlusReWritable
- | WriteMtRainier
- | WriteBurnProof
type DriveWriteCaps = BitArray DriveCapabilityWrite
capsWriteCd :: DriveWriteCaps
capsWriteDvd :: DriveWriteCaps
capsWrite :: DriveWriteCaps
data DriveCapabilityMisc
- = MiscCloseTray
- | MiscEject
- | MiscLock
- | MiscSelectSpeed
- | MiscSelectDisc
- | MiscMultiSession
- | MiscMediaChanged
- | MiscReset
- | MiscFile
type DriveMiscCaps = BitArray DriveCapabilityMisc
type DriveCaps = (DriveReadCaps, DriveWriteCaps, DriveMiscCaps)
drivers :: [DriverId]
deviceDrivers :: [DriverId]
osDriver :: DriverId
driverName :: Cdio -> IO (Maybe String)
driverId :: Cdio -> IO (Maybe DriverId)
driverDescribe :: DriverId -> String
driverErrmsg :: DriverReturnCode -> String
haveDriver :: DriverId -> Bool
devices :: DriverId -> IO [FilePath]
devicesRet :: DriverId -> IO ([FilePath], DriverId)
devicesWithFilesystem :: [FilePath] -> Maybe Filesystem -> FilesystemClasses -> Bool -> IO [FilePath]
devicesWithFilesystemRet :: [FilePath] -> Maybe Filesystem -> FilesystemClasses -> Bool -> IO ([FilePath], DriverId)
defaultDevice :: IO (Maybe FilePath)
defaultDeviceDriver :: DriverId -> IO (Maybe FilePath, DriverId)
hwinfo :: Cdio -> IO (Maybe HardwareInfo)
driveCap :: Cdio -> IO DriveCaps
driveCapDevice :: FilePath -> IO DriveCaps
haveAtapi :: Cdio -> IO (Maybe Bool)
ejectMedia :: Cdio -> IO DriverReturnCode
ejectDrive :: Maybe FilePath -> IO DriverReturnCode
closeTray :: Maybe FilePath -> DriverId -> IO (DriverReturnCode, DriverId)
getArg :: Cdio -> SessionArg -> IO (Maybe String)
getAccessMode :: Cdio -> IO (Maybe AccessMode)
isMediaChanged :: Cdio -> IO (Either DriverReturnCode Bool)
setBlocksize :: Cdio -> Int -> IO DriverReturnCode
setSpeed :: Cdio -> Int -> IO DriverReturnCode
lastSession :: Cdio -> IO (Either DriverReturnCode Lsn)
cdioOpen :: Maybe FilePath -> DriverId -> IO (Maybe Cdio)
cdioOpenAm :: Maybe FilePath -> DriverId -> AccessMode -> IO (Maybe Cdio)
isDevice :: FilePath -> DriverId -> IO Bool
cdioOpenCd :: Maybe FilePath -> IO (Maybe Cdio)
cdioOpenAmCd :: Maybe FilePath -> AccessMode -> IO (Maybe Cdio)
cueFromBin :: FilePath -> IO (Maybe FilePath)
binFromCue :: FilePath -> IO (Maybe FilePath)
isNrg :: FilePath -> IO Bool
isToc :: FilePath -> IO Bool

Types

data Cdio Source #

A particular disc reading/writing device, along with the data contained on the loaded disc. Note well that this is always a mutable object, and is not thread-safe; moreover, any function this is passed to may wind up silently modifying the data.

data HardwareInfo Source #

Information defining the make and model of a (typically physical) device.

Constructors

HardwareInfo
Fields vendor :: String The company who designed and/or built the drive. model :: String The name of the specific drive design. revision :: String The version number for hardware/firmware following a series.

Instances

Instances details

Eq HardwareInfo Source #
Instance details Defined in Foreign.Libcdio.Device Methods (==) :: HardwareInfo -> HardwareInfo -> Bool # (/=) :: HardwareInfo -> HardwareInfo -> Bool #
Read HardwareInfo Source #
Instance details Defined in Foreign.Libcdio.Device Methods readsPrec :: Int -> ReadS HardwareInfo # readList :: ReadS [HardwareInfo] # readPrec :: ReadPrec HardwareInfo # readListPrec :: ReadPrec [HardwareInfo] #
Show HardwareInfo Source #
Instance details Defined in Foreign.Libcdio.Device Methods showsPrec :: Int -> HardwareInfo -> ShowS # show :: HardwareInfo -> String # showList :: [HardwareInfo] -> ShowS #
Storable HardwareInfo Source #
Instance details Defined in Foreign.Libcdio.Device Methods sizeOf :: HardwareInfo -> Int # alignment :: HardwareInfo -> Int # peekElemOff :: Ptr HardwareInfo -> Int -> IO HardwareInfo # pokeElemOff :: Ptr HardwareInfo -> Int -> HardwareInfo -> IO () # peekByteOff :: Ptr b -> Int -> IO HardwareInfo # pokeByteOff :: Ptr b -> Int -> HardwareInfo -> IO () # peek :: Ptr HardwareInfo -> IO HardwareInfo # poke :: Ptr HardwareInfo -> HardwareInfo -> IO () #

vendorLength :: Word Source #

Length of the drive vendor name in returned in a HardwareInfo query.

modelLength :: Word Source #

Length of the drive model name in returned in a HardwareInfo query.

revisionLength :: Word Source #

Length of the drive revision number in returned in a HardwareInfo query.

emptyHardwareInfo :: HardwareInfo Source #

A HardwareInfo object with values suitable as defaults.

data DriverId Source #

Devices or file types supported by the library.

Constructors

DriverUnknown
DriverAix
DriverFreeBsd
DriverNetBsd
DriverLinux
DriverSolaris
DriverOsX
DriverWin32
DriverCdrDao
DriverBinCue
DriverNrg
DriverDevice
DriverBsdi
DriverOs2

Instances

Instances details

Bounded DriverId Source #
Instance details Defined in Foreign.Libcdio.Types.Enums Methods minBound :: DriverId # maxBound :: DriverId #
Enum DriverId Source #
Instance details Defined in Foreign.Libcdio.Types.Enums Methods succ :: DriverId -> DriverId # pred :: DriverId -> DriverId # toEnum :: Int -> DriverId # fromEnum :: DriverId -> Int # enumFrom :: DriverId -> [DriverId] # enumFromThen :: DriverId -> DriverId -> [DriverId] # enumFromTo :: DriverId -> DriverId -> [DriverId] # enumFromThenTo :: DriverId -> DriverId -> DriverId -> [DriverId] #
Eq DriverId Source #
Instance details Defined in Foreign.Libcdio.Types.Enums Methods (==) :: DriverId -> DriverId -> Bool # (/=) :: DriverId -> DriverId -> Bool #
Ord DriverId Source #
Instance details Defined in Foreign.Libcdio.Types.Enums Methods compare :: DriverId -> DriverId -> Ordering # (<) :: DriverId -> DriverId -> Bool # (<=) :: DriverId -> DriverId -> Bool # (>) :: DriverId -> DriverId -> Bool # (>=) :: DriverId -> DriverId -> Bool # max :: DriverId -> DriverId -> DriverId # min :: DriverId -> DriverId -> DriverId #
Read DriverId Source #
Instance details Defined in Foreign.Libcdio.Types.Enums Methods readsPrec :: Int -> ReadS DriverId # readList :: ReadS [DriverId] # readPrec :: ReadPrec DriverId # readListPrec :: ReadPrec [DriverId] #
Show DriverId Source #
Instance details Defined in Foreign.Libcdio.Types.Enums Methods showsPrec :: Int -> DriverId -> ShowS # show :: DriverId -> String # showList :: [DriverId] -> ShowS #

data DriverReturnCode Source #

Descriptions of various error states which may be returned by driver functions.

Constructors

MmcSenseData
NoDriver
BadPointer
BadParameter
NotPermitted
Uninitialized
Unsupported
DriverError
Success

Instances

Instances details

Bounded DriverReturnCode Source #
Instance details Defined in Foreign.Libcdio.Types.Enums Methods minBound :: DriverReturnCode # maxBound :: DriverReturnCode #
Enum DriverReturnCode Source #
Instance details Defined in Foreign.Libcdio.Types.Enums Methods succ :: DriverReturnCode -> DriverReturnCode # pred :: DriverReturnCode -> DriverReturnCode # toEnum :: Int -> DriverReturnCode # fromEnum :: DriverReturnCode -> Int # enumFrom :: DriverReturnCode -> [DriverReturnCode] # enumFromThen :: DriverReturnCode -> DriverReturnCode -> [DriverReturnCode] # enumFromTo :: DriverReturnCode -> DriverReturnCode -> [DriverReturnCode] # enumFromThenTo :: DriverReturnCode -> DriverReturnCode -> DriverReturnCode -> [DriverReturnCode] #
Eq DriverReturnCode Source #
Instance details Defined in Foreign.Libcdio.Types.Enums Methods (==) :: DriverReturnCode -> DriverReturnCode -> Bool # (/=) :: DriverReturnCode -> DriverReturnCode -> Bool #
Ord DriverReturnCode Source #
Instance details Defined in Foreign.Libcdio.Types.Enums Methods compare :: DriverReturnCode -> DriverReturnCode -> Ordering # (<) :: DriverReturnCode -> DriverReturnCode -> Bool # (<=) :: DriverReturnCode -> DriverReturnCode -> Bool # (>) :: DriverReturnCode -> DriverReturnCode -> Bool # (>=) :: DriverReturnCode -> DriverReturnCode -> Bool # max :: DriverReturnCode -> DriverReturnCode -> DriverReturnCode # min :: DriverReturnCode -> DriverReturnCode -> DriverReturnCode #
Read DriverReturnCode Source #
Instance details Defined in Foreign.Libcdio.Types.Enums Methods readsPrec :: Int -> ReadS DriverReturnCode # readList :: ReadS [DriverReturnCode] # readPrec :: ReadPrec DriverReturnCode # readListPrec :: ReadPrec [DriverReturnCode] #
Show DriverReturnCode Source #
Instance details Defined in Foreign.Libcdio.Types.Enums Methods showsPrec :: Int -> DriverReturnCode -> ShowS # show :: DriverReturnCode -> String # showList :: [DriverReturnCode] -> ShowS #

data SessionArg Source #

Metadata about the session in the form of (often freeform) text, providing a type-safe index to getArg. Note that not every driver type supports every item.

The key "access-mode" is handled separately by getAccessMode, to better reflect its restricted outputs.

Constructors

Source
Cue
ScsiTuple
MmcSupported

Instances

Instances details

Bounded SessionArg Source #
Instance details Defined in Foreign.Libcdio.Device Methods minBound :: SessionArg # maxBound :: SessionArg #
Enum SessionArg Source #
Instance details Defined in Foreign.Libcdio.Device Methods succ :: SessionArg -> SessionArg # pred :: SessionArg -> SessionArg # toEnum :: Int -> SessionArg # fromEnum :: SessionArg -> Int # enumFrom :: SessionArg -> [SessionArg] # enumFromThen :: SessionArg -> SessionArg -> [SessionArg] # enumFromTo :: SessionArg -> SessionArg -> [SessionArg] # enumFromThenTo :: SessionArg -> SessionArg -> SessionArg -> [SessionArg] #
Eq SessionArg Source #
Instance details Defined in Foreign.Libcdio.Device Methods (==) :: SessionArg -> SessionArg -> Bool # (/=) :: SessionArg -> SessionArg -> Bool #
Ord SessionArg Source #
Instance details Defined in Foreign.Libcdio.Device Methods compare :: SessionArg -> SessionArg -> Ordering # (<) :: SessionArg -> SessionArg -> Bool # (<=) :: SessionArg -> SessionArg -> Bool # (>) :: SessionArg -> SessionArg -> Bool # (>=) :: SessionArg -> SessionArg -> Bool # max :: SessionArg -> SessionArg -> SessionArg # min :: SessionArg -> SessionArg -> SessionArg #
Read SessionArg Source #
Instance details Defined in Foreign.Libcdio.Device Methods readsPrec :: Int -> ReadS SessionArg # readList :: ReadS [SessionArg] # readPrec :: ReadPrec SessionArg # readListPrec :: ReadPrec [SessionArg] #
Show SessionArg Source #
Instance details Defined in Foreign.Libcdio.Device Methods showsPrec :: Int -> SessionArg -> ShowS # show :: SessionArg -> String # showList :: [SessionArg] -> ShowS #
Storable SessionArg Source #
Instance details Defined in Foreign.Libcdio.Device Methods sizeOf :: SessionArg -> Int # alignment :: SessionArg -> Int # peekElemOff :: Ptr SessionArg -> Int -> IO SessionArg # pokeElemOff :: Ptr SessionArg -> Int -> SessionArg -> IO () # peekByteOff :: Ptr b -> Int -> IO SessionArg # pokeByteOff :: Ptr b -> Int -> SessionArg -> IO () # peek :: Ptr SessionArg -> IO SessionArg # poke :: Ptr SessionArg -> SessionArg -> IO () #

data AccessMode Source #

Which instruction set should be used to communicate with the driver, providing a type-safe input for session initialization. Note that not every driver type supports every item.

Constructors

Image
Ioctl	The `DriverLinux` and `DriverBsdi` drivers use a different internal representation for `Ioctl_`.
Ioctl_	The `DriverFreeBsd` and `DriverWin32` drivers use a different internal representation for `Ioctl`.
Aspi
Atapi
Cam
Scsi
ReadCd
Read10
MmcReadWrite
MmcReadWriteExclusive

Instances

Instances details

Bounded AccessMode Source #
Instance details Defined in Foreign.Libcdio.Device Methods minBound :: AccessMode # maxBound :: AccessMode #
Enum AccessMode Source #
Instance details Defined in Foreign.Libcdio.Device Methods succ :: AccessMode -> AccessMode # pred :: AccessMode -> AccessMode # toEnum :: Int -> AccessMode # fromEnum :: AccessMode -> Int # enumFrom :: AccessMode -> [AccessMode] # enumFromThen :: AccessMode -> AccessMode -> [AccessMode] # enumFromTo :: AccessMode -> AccessMode -> [AccessMode] # enumFromThenTo :: AccessMode -> AccessMode -> AccessMode -> [AccessMode] #
Eq AccessMode Source #
Instance details Defined in Foreign.Libcdio.Device Methods (==) :: AccessMode -> AccessMode -> Bool # (/=) :: AccessMode -> AccessMode -> Bool #
Ord AccessMode Source #
Instance details Defined in Foreign.Libcdio.Device Methods compare :: AccessMode -> AccessMode -> Ordering # (<) :: AccessMode -> AccessMode -> Bool # (<=) :: AccessMode -> AccessMode -> Bool # (>) :: AccessMode -> AccessMode -> Bool # (>=) :: AccessMode -> AccessMode -> Bool # max :: AccessMode -> AccessMode -> AccessMode # min :: AccessMode -> AccessMode -> AccessMode #
Read AccessMode Source #
Instance details Defined in Foreign.Libcdio.Device Methods readsPrec :: Int -> ReadS AccessMode # readList :: ReadS [AccessMode] # readPrec :: ReadPrec AccessMode # readListPrec :: ReadPrec [AccessMode] #
Show AccessMode Source #
Instance details Defined in Foreign.Libcdio.Device Methods showsPrec :: Int -> AccessMode -> ShowS # show :: AccessMode -> String # showList :: [AccessMode] -> ShowS #
Storable AccessMode Source #
Instance details Defined in Foreign.Libcdio.Device Methods sizeOf :: AccessMode -> Int # alignment :: AccessMode -> Int # peekElemOff :: Ptr AccessMode -> Int -> IO AccessMode # pokeElemOff :: Ptr AccessMode -> Int -> AccessMode -> IO () # peekByteOff :: Ptr b -> Int -> IO AccessMode # pokeByteOff :: Ptr b -> Int -> AccessMode -> IO () # peek :: Ptr AccessMode -> IO AccessMode # poke :: Ptr AccessMode -> AccessMode -> IO () #

Capabilities

data DriveCapabilityRead Source #

Constructors

ReadAnalogAudio
ReadDigitalAudio
ReadCdGraphics
ReadCdRecordable
ReadCdReWritable
ReadDvdRecordable
ReadDvdPlusRecordable
ReadDvdRam
ReadDvdRom
ReadDvdReWritable
ReadDvdPlusReWritable
ReadC2ErrorCorrection
ReadMode2Form1
ReadMode2Form2
ReadMcn
ReadIsrc

Instances

Instances details

Bounded DriveCapabilityRead Source #
Instance details Defined in Foreign.Libcdio.Types.Enums Methods minBound :: DriveCapabilityRead # maxBound :: DriveCapabilityRead #
Enum DriveCapabilityRead Source #	Write-related properties a device can have, mostly describing what formats it can burn, which are collected in `DriveWriteCaps`.
Instance details Defined in Foreign.Libcdio.Types.Enums Methods succ :: DriveCapabilityRead -> DriveCapabilityRead # pred :: DriveCapabilityRead -> DriveCapabilityRead # toEnum :: Int -> DriveCapabilityRead # fromEnum :: DriveCapabilityRead -> Int # enumFrom :: DriveCapabilityRead -> [DriveCapabilityRead] # enumFromThen :: DriveCapabilityRead -> DriveCapabilityRead -> [DriveCapabilityRead] # enumFromTo :: DriveCapabilityRead -> DriveCapabilityRead -> [DriveCapabilityRead] # enumFromThenTo :: DriveCapabilityRead -> DriveCapabilityRead -> DriveCapabilityRead -> [DriveCapabilityRead] #
Eq DriveCapabilityRead Source #
Instance details Defined in Foreign.Libcdio.Types.Enums Methods (==) :: DriveCapabilityRead -> DriveCapabilityRead -> Bool # (/=) :: DriveCapabilityRead -> DriveCapabilityRead -> Bool #
Ord DriveCapabilityRead Source #
Instance details Defined in Foreign.Libcdio.Types.Enums Methods compare :: DriveCapabilityRead -> DriveCapabilityRead -> Ordering # (<) :: DriveCapabilityRead -> DriveCapabilityRead -> Bool # (<=) :: DriveCapabilityRead -> DriveCapabilityRead -> Bool # (>) :: DriveCapabilityRead -> DriveCapabilityRead -> Bool # (>=) :: DriveCapabilityRead -> DriveCapabilityRead -> Bool # max :: DriveCapabilityRead -> DriveCapabilityRead -> DriveCapabilityRead # min :: DriveCapabilityRead -> DriveCapabilityRead -> DriveCapabilityRead #
Read DriveCapabilityRead Source #
Instance details Defined in Foreign.Libcdio.Types.Enums Methods readsPrec :: Int -> ReadS DriveCapabilityRead # readList :: ReadS [DriveCapabilityRead] # readPrec :: ReadPrec DriveCapabilityRead # readListPrec :: ReadPrec [DriveCapabilityRead] #
Show DriveCapabilityRead Source #
Instance details Defined in Foreign.Libcdio.Types.Enums Methods showsPrec :: Int -> DriveCapabilityRead -> ShowS # show :: DriveCapabilityRead -> String # showList :: [DriveCapabilityRead] -> ShowS #
Ix DriveCapabilityRead Source #
Instance details Defined in Foreign.Libcdio.Types.Enums Methods range :: (DriveCapabilityRead, DriveCapabilityRead) -> [DriveCapabilityRead] # index :: (DriveCapabilityRead, DriveCapabilityRead) -> DriveCapabilityRead -> Int # unsafeIndex :: (DriveCapabilityRead, DriveCapabilityRead) -> DriveCapabilityRead -> Int # inRange :: (DriveCapabilityRead, DriveCapabilityRead) -> DriveCapabilityRead -> Bool # rangeSize :: (DriveCapabilityRead, DriveCapabilityRead) -> Int # unsafeRangeSize :: (DriveCapabilityRead, DriveCapabilityRead) -> Int #

type DriveReadCaps = BitArray DriveCapabilityRead Source #

The collection of features for reading discs a device provides.

data DriveCapabilityWrite Source #

Constructors

WriteCdRecordable
WriteCdReWritable
WriteDvdRecordable
WriteDvdPlusRecordable
WriteDvdRam
WriteDvdReWritable
WriteDvdPlusReWritable
WriteMtRainier
WriteBurnProof

Instances

Instances details

Bounded DriveCapabilityWrite Source #
Instance details Defined in Foreign.Libcdio.Types.Enums Methods minBound :: DriveCapabilityWrite # maxBound :: DriveCapabilityWrite #
Enum DriveCapabilityWrite Source #
Instance details Defined in Foreign.Libcdio.Types.Enums Methods succ :: DriveCapabilityWrite -> DriveCapabilityWrite # pred :: DriveCapabilityWrite -> DriveCapabilityWrite # toEnum :: Int -> DriveCapabilityWrite # fromEnum :: DriveCapabilityWrite -> Int # enumFrom :: DriveCapabilityWrite -> [DriveCapabilityWrite] # enumFromThen :: DriveCapabilityWrite -> DriveCapabilityWrite -> [DriveCapabilityWrite] # enumFromTo :: DriveCapabilityWrite -> DriveCapabilityWrite -> [DriveCapabilityWrite] # enumFromThenTo :: DriveCapabilityWrite -> DriveCapabilityWrite -> DriveCapabilityWrite -> [DriveCapabilityWrite] #
Eq DriveCapabilityWrite Source #
Instance details Defined in Foreign.Libcdio.Types.Enums Methods (==) :: DriveCapabilityWrite -> DriveCapabilityWrite -> Bool # (/=) :: DriveCapabilityWrite -> DriveCapabilityWrite -> Bool #
Ord DriveCapabilityWrite Source #
Instance details Defined in Foreign.Libcdio.Types.Enums Methods compare :: DriveCapabilityWrite -> DriveCapabilityWrite -> Ordering # (<) :: DriveCapabilityWrite -> DriveCapabilityWrite -> Bool # (<=) :: DriveCapabilityWrite -> DriveCapabilityWrite -> Bool # (>) :: DriveCapabilityWrite -> DriveCapabilityWrite -> Bool # (>=) :: DriveCapabilityWrite -> DriveCapabilityWrite -> Bool # max :: DriveCapabilityWrite -> DriveCapabilityWrite -> DriveCapabilityWrite # min :: DriveCapabilityWrite -> DriveCapabilityWrite -> DriveCapabilityWrite #
Read DriveCapabilityWrite Source #
Instance details Defined in Foreign.Libcdio.Types.Enums Methods readsPrec :: Int -> ReadS DriveCapabilityWrite # readList :: ReadS [DriveCapabilityWrite] # readPrec :: ReadPrec DriveCapabilityWrite # readListPrec :: ReadPrec [DriveCapabilityWrite] #
Show DriveCapabilityWrite Source #
Instance details Defined in Foreign.Libcdio.Types.Enums Methods showsPrec :: Int -> DriveCapabilityWrite -> ShowS # show :: DriveCapabilityWrite -> String # showList :: [DriveCapabilityWrite] -> ShowS #
Ix DriveCapabilityWrite Source #
Instance details Defined in Foreign.Libcdio.Types.Enums Methods range :: (DriveCapabilityWrite, DriveCapabilityWrite) -> [DriveCapabilityWrite] # index :: (DriveCapabilityWrite, DriveCapabilityWrite) -> DriveCapabilityWrite -> Int # unsafeIndex :: (DriveCapabilityWrite, DriveCapabilityWrite) -> DriveCapabilityWrite -> Int # inRange :: (DriveCapabilityWrite, DriveCapabilityWrite) -> DriveCapabilityWrite -> Bool # rangeSize :: (DriveCapabilityWrite, DriveCapabilityWrite) -> Int # unsafeRangeSize :: (DriveCapabilityWrite, DriveCapabilityWrite) -> Int #

type DriveWriteCaps = BitArray DriveCapabilityWrite Source #

The collection of features for writing discs a device provides.

capsWriteCd :: DriveWriteCaps Source #

Capabilites indicating a device has some sort of CD-writing ability.

capsWriteDvd :: DriveWriteCaps Source #

Capabilites indicating a device has some sort of DVD-writing ability.

capsWrite :: DriveWriteCaps Source #

Capabilites indicating a device has some sort of disc-writing ability.

data DriveCapabilityMisc Source #

Miscellaneous properties a device can have, typically describing hardware features, which are collected in DriveMiscCaps.

Constructors

MiscCloseTray
MiscEject
MiscLock
MiscSelectSpeed
MiscSelectDisc
MiscMultiSession
MiscMediaChanged
MiscReset
MiscFile

Instances

Instances details

Bounded DriveCapabilityMisc Source #
Instance details Defined in Foreign.Libcdio.Types.Enums Methods minBound :: DriveCapabilityMisc # maxBound :: DriveCapabilityMisc #
Enum DriveCapabilityMisc Source #	Read-related properties a device can have, mostly describing what formats it understands, which are collected in `DriveReadCaps`. The difference between `ReadAnalogAudio` and `ReadDigitalAudio` is poorly documented in libcdio; they have been named here according to their assumed meanings (see https://www.cdrfaq.org/faq02.html#S2-4-3), but that pattern may not be completely accurate.
Instance details Defined in Foreign.Libcdio.Types.Enums Methods succ :: DriveCapabilityMisc -> DriveCapabilityMisc # pred :: DriveCapabilityMisc -> DriveCapabilityMisc # toEnum :: Int -> DriveCapabilityMisc # fromEnum :: DriveCapabilityMisc -> Int # enumFrom :: DriveCapabilityMisc -> [DriveCapabilityMisc] # enumFromThen :: DriveCapabilityMisc -> DriveCapabilityMisc -> [DriveCapabilityMisc] # enumFromTo :: DriveCapabilityMisc -> DriveCapabilityMisc -> [DriveCapabilityMisc] # enumFromThenTo :: DriveCapabilityMisc -> DriveCapabilityMisc -> DriveCapabilityMisc -> [DriveCapabilityMisc] #
Eq DriveCapabilityMisc Source #
Instance details Defined in Foreign.Libcdio.Types.Enums Methods (==) :: DriveCapabilityMisc -> DriveCapabilityMisc -> Bool # (/=) :: DriveCapabilityMisc -> DriveCapabilityMisc -> Bool #
Ord DriveCapabilityMisc Source #
Instance details Defined in Foreign.Libcdio.Types.Enums Methods compare :: DriveCapabilityMisc -> DriveCapabilityMisc -> Ordering # (<) :: DriveCapabilityMisc -> DriveCapabilityMisc -> Bool # (<=) :: DriveCapabilityMisc -> DriveCapabilityMisc -> Bool # (>) :: DriveCapabilityMisc -> DriveCapabilityMisc -> Bool # (>=) :: DriveCapabilityMisc -> DriveCapabilityMisc -> Bool # max :: DriveCapabilityMisc -> DriveCapabilityMisc -> DriveCapabilityMisc # min :: DriveCapabilityMisc -> DriveCapabilityMisc -> DriveCapabilityMisc #
Read DriveCapabilityMisc Source #
Instance details Defined in Foreign.Libcdio.Types.Enums Methods readsPrec :: Int -> ReadS DriveCapabilityMisc # readList :: ReadS [DriveCapabilityMisc] # readPrec :: ReadPrec DriveCapabilityMisc # readListPrec :: ReadPrec [DriveCapabilityMisc] #
Show DriveCapabilityMisc Source #
Instance details Defined in Foreign.Libcdio.Types.Enums Methods showsPrec :: Int -> DriveCapabilityMisc -> ShowS # show :: DriveCapabilityMisc -> String # showList :: [DriveCapabilityMisc] -> ShowS #
Ix DriveCapabilityMisc Source #
Instance details Defined in Foreign.Libcdio.Types.Enums Methods range :: (DriveCapabilityMisc, DriveCapabilityMisc) -> [DriveCapabilityMisc] # index :: (DriveCapabilityMisc, DriveCapabilityMisc) -> DriveCapabilityMisc -> Int # unsafeIndex :: (DriveCapabilityMisc, DriveCapabilityMisc) -> DriveCapabilityMisc -> Int # inRange :: (DriveCapabilityMisc, DriveCapabilityMisc) -> DriveCapabilityMisc -> Bool # rangeSize :: (DriveCapabilityMisc, DriveCapabilityMisc) -> Int # unsafeRangeSize :: (DriveCapabilityMisc, DriveCapabilityMisc) -> Int #

type DriveMiscCaps = BitArray DriveCapabilityMisc Source #

The collection of hardware features a device was built with.

type DriveCaps = (DriveReadCaps, DriveWriteCaps, DriveMiscCaps) Source #

The three types are usually passed around together, so we can simplify the type signatures using them.

Drivers

drivers :: [DriverId] Source #

All supported drivers, listed in order of preference.

deviceDrivers :: [DriverId] Source #

All supported drivers for physical devices, listed in order of preference.

osDriver :: DriverId Source #

The particular driver for the current operating system, or DriverUnknown if no device driver exists.

driverName :: Cdio -> IO (Maybe String) Source #

Describe the driver used by the session in a human-readable (English) manner. See also driverId.

driverId :: Cdio -> IO (Maybe DriverId) Source #

The machine-readable identifier of the driver used by the session. This should be preferred to driverName wherever possible.

Returns Nothing if the Cdio object has already been closed.

driverDescribe :: DriverId -> String Source #

Describe the IO driver in a human-readable manner, as opposed to the machine representation returned by the Show instance.

driverErrmsg :: DriverReturnCode -> String Source #

Describe the driver-level error in a human-readable manner, as opposed to the machine representation returned by the Show instance.

haveDriver :: DriverId -> Bool Source #

Determine whether the system provides a particular driver.

Devices

devices :: DriverId -> IO [FilePath] Source #

List (static) available devices on the system which can be accessed with a particular driver; some file devices (e.g. with DriverBinCue) might be returned, but an exhaustive list should not be expected in that case.

If passed DriverDevice, the returned value will list any type of hardware device, but no image files. Likewise, if passed DriverUnknown, all hardware devices will be returned along with any already-known images.

devicesRet :: DriverId -> IO ([FilePath], DriverId) Source #

Like devices, but if DriverDevice or DriverUnknown is passed, the second return value reflects the driver the library would use by default. If any other DriverId is passed, that value is returned unchanged.

devicesWithFilesystem Source #

Arguments

:: [FilePath]	If empty, then search all possible drives.
-> Maybe Filesystem
-> FilesystemClasses
-> Bool	If `True`, then a device matching any of the capabilities succeeds; if `False` then it must match every capability given (empty capabilities always match).
-> IO [FilePath]

Determine which of the devices may read discs fitting the given description.

devicesWithFilesystemRet Source #

Arguments

:: [FilePath]	If empty, then search all possible drives.
-> Maybe Filesystem
-> FilesystemClasses
-> Bool	If `True`, then a device matching any of the capabilities succeeds; if `False` then it must match every capability given (empty capabilities always match).
-> IO ([FilePath], DriverId)

Like devicesWithFilesystem, but returning the type of driver found as with devicesRet. This is only helpful if the device list is empty; otherwise it simply returns DriverDevice.

defaultDevice :: IO (Maybe FilePath) Source #

Find the default disc device for the system, if one exists.

The C library allows getting the default device from a Cdio object, but since that seems to only be initialized from either the default device itself or with an explicit path, doing so seems rather redundant.

defaultDeviceDriver Source #

Arguments

:: DriverId
-> IO (Maybe FilePath, DriverId)	The name of the device, along with the associated driver if passed `DriverUnknown` or `DriverDevice`.

Find the default disc device for a given driver, if one exists.

hwinfo :: Cdio -> IO (Maybe HardwareInfo) Source #

Get a description of the hardware associated with a particular session.

Returns Nothing if the Cdio object has already been closed, or if an error occurred in retrieval.

driveCap :: Cdio -> IO DriveCaps Source #

Get the drive capabilities for the default device.

driveCapDevice :: FilePath -> IO DriveCaps Source #

Get the drive capabilities for a specified device.

haveAtapi :: Cdio -> IO (Maybe Bool) Source #

Determine if the device understands ATAPI commands.

Returns Nothing if the Cdio object has already been closed, or if the capability can't be determined.

ejectMedia :: Cdio -> IO DriverReturnCode Source #

Eject the media represented by the session identifier, if the device supports doing so.

Warning: Assuming this succeeds, the Cdio object is destroyed and any further operations on it will fail!

ejectDrive Source #

Arguments

:: Maybe FilePath	The name of the device to eject, or `Nothing` to use the default drive for the machine.
-> IO DriverReturnCode

Eject media in a CD drive, if the device supports doing so. If a Cdio session has already been opened on the drive, ejectMedia is strongly recommended instead.

closeTray Source #

Arguments

:: Maybe FilePath	The name of the drive to use, or `Nothing` to use `defaultDeviceDriver`.
-> DriverId
-> IO (DriverReturnCode, DriverId)	Any errors, along with the actual driver used if passed `DriverUnknown` or `DriverDevice`.

Close a CD drive, if the device supports doing so.

Session

getArg :: Cdio -> SessionArg -> IO (Maybe String) Source #

Retrieve the session value associated with the given key. The particular case of "access-mode" is instead handled by getAccessMode.

getAccessMode :: Cdio -> IO (Maybe AccessMode) Source #

Check what instruction set is in use for reading the disc. Other session values are handled by getArg.

isMediaChanged :: Cdio -> IO (Either DriverReturnCode Bool) Source #

Find out if the media has changed since the last call.

setBlocksize Source #

Arguments

:: Cdio	The CdText object is mutated as a result of the function.
-> Int
-> IO DriverReturnCode

Set the blocksize for subsequent reads.

setSpeed Source #

Arguments

:: Cdio	The CdText object is mutated as a result of the function.
-> Int
-> IO DriverReturnCode

Set the drive speed. With many devices, if a value above their maximum speed is given, it will be silently capped.

Note that, unlike setSpeed, this uses a unit unique to disc drives, which depends on the type of disc; to convert to or from Kb/s, use the formula dt * cds = kbs where dt is either 176 for raw data or 150 for filesystem data, and cds is the Int passed to this function.

lastSession :: Cdio -> IO (Either DriverReturnCode Lsn) Source #

Get the starting address of the last write session of a disc.

Device paths

cdioOpen :: Maybe FilePath -> DriverId -> IO (Maybe Cdio) Source #

Open a session referencing the given location, or the default device if passed Nothing.

cdioOpenAm :: Maybe FilePath -> DriverId -> AccessMode -> IO (Maybe Cdio) Source #

Open a session referencing the given location, or the default device if passed Nothing, with the desired access mode.

Hardware

isDevice :: FilePath -> DriverId -> IO Bool Source #

Determine whether the given path refers to a hardware device, according to the given driver. DriverUnknown or DriverDevice may be passed if the system is unknown.

cdioOpenCd :: Maybe FilePath -> IO (Maybe Cdio) Source #

Set up the specified CD-ROM device for reading.

cdioOpenAmCd :: Maybe FilePath -> AccessMode -> IO (Maybe Cdio) Source #

Set up the specified CD-ROM device for reading, with the desired access mode.

Images

cueFromBin :: FilePath -> IO (Maybe FilePath) Source #

If the given file is a BIN disc image (determined by file extension), return the corresponding CUE file. Note that this simply replaces the extension to obtain the new file name.

binFromCue :: FilePath -> IO (Maybe FilePath) Source #

If the given file is a valid CUE disc description, return the corresponding BIN file. Note that this simply replaces the file extension to obtain the new file name.

isNrg :: FilePath -> IO Bool Source #

Check that a Nero disc image file is valid.

isToc :: FilePath -> IO Bool Source #

Check that a cdrdao-style TOC description file is valid.