Sound.Libcdio.Device

Any software dealing with CDs has to deal with the fact that they are, ultimately, a physical medium and thus reading from them requires interfacing with system hardware. This module provides the means to do just that. Note that, unlike the C and Foreign.Libcdio interfaces, however, this doesn't provide any means to open a read session; that functionality is instead exported directly from Sound.Libcdio.

Types

data HardwareInfo

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

Eq HardwareInfo

Defined in Foreign.Libcdio.Device

Methods

(==) :: HardwareInfo -> HardwareInfo -> Bool

(/=) :: HardwareInfo -> HardwareInfo -> Bool

Read HardwareInfo

Defined in Foreign.Libcdio.Device

Methods

readsPrec :: Int -> ReadS HardwareInfo

readList :: ReadS [HardwareInfo]

readPrec :: ReadPrec HardwareInfo

readListPrec :: ReadPrec [HardwareInfo]

Show HardwareInfo

Defined in Foreign.Libcdio.Device

Methods

showsPrec :: Int -> HardwareInfo -> ShowS

show :: HardwareInfo -> String

showList :: [HardwareInfo] -> ShowS

Storable HardwareInfo

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 ()

emptyHardwareInfo :: HardwareInfo

A HardwareInfo object with values suitable as defaults.

data DriverId

Devices or file types supported by the library.

Constructors

DriverUnknown

DriverAix

DriverFreeBsd

DriverNetBsd

DriverLinux

DriverSolaris

DriverOsX

DriverWin32

DriverCdrDao

DriverBinCue

DriverNrg

DriverDevice

DriverBsdi

DriverOs2

Instances

Bounded DriverId

Defined in Foreign.Libcdio.Types.Enums

Methods

minBound :: DriverId

maxBound :: DriverId

Enum DriverId

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

Defined in Foreign.Libcdio.Types.Enums

Methods

(==) :: DriverId -> DriverId -> Bool

(/=) :: DriverId -> DriverId -> Bool

Ord DriverId

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

Defined in Foreign.Libcdio.Types.Enums

Methods

readsPrec :: Int -> ReadS DriverId

readList :: ReadS [DriverId]

readPrec :: ReadPrec DriverId

readListPrec :: ReadPrec [DriverId]

Show DriverId

Defined in Foreign.Libcdio.Types.Enums

Methods

showsPrec :: Int -> DriverId -> ShowS

show :: DriverId -> String

showList :: [DriverId] -> ShowS

data DriverReturnCode

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

Constructors

MmcSenseData

NoDriver

BadPointer

BadParameter

NotPermitted

Uninitialized

Unsupported

DriverError

Success

Instances

Bounded DriverReturnCode

Defined in Foreign.Libcdio.Types.Enums

Methods

minBound :: DriverReturnCode

maxBound :: DriverReturnCode

Enum DriverReturnCode

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

Defined in Foreign.Libcdio.Types.Enums

Methods

(==) :: DriverReturnCode -> DriverReturnCode -> Bool

(/=) :: DriverReturnCode -> DriverReturnCode -> Bool

Ord DriverReturnCode

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

Defined in Foreign.Libcdio.Types.Enums

Methods

readsPrec :: Int -> ReadS DriverReturnCode

readList :: ReadS [DriverReturnCode]

readPrec :: ReadPrec DriverReturnCode

readListPrec :: ReadPrec [DriverReturnCode]

Show DriverReturnCode

Defined in Foreign.Libcdio.Types.Enums

Methods

showsPrec :: Int -> DriverReturnCode -> ShowS

show :: DriverReturnCode -> String

showList :: [DriverReturnCode] -> ShowS

Capabilities

type DriveCaps = (DriveReadCaps, DriveWriteCaps, DriveMiscCaps)

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

data DriveCapabilityRead

Constructors

ReadAnalogAudio

ReadDigitalAudio

ReadCdGraphics

ReadCdRecordable

ReadCdReWritable

ReadDvdRecordable

ReadDvdPlusRecordable

ReadDvdRam

ReadDvdRom

ReadDvdReWritable

ReadDvdPlusReWritable

ReadC2ErrorCorrection

ReadMode2Form1

ReadMode2Form2

ReadMcn

ReadIsrc

Instances

Bounded DriveCapabilityRead

Defined in Foreign.Libcdio.Types.Enums

Methods

minBound :: DriveCapabilityRead

maxBound :: DriveCapabilityRead

Enum DriveCapabilityRead

Write-related properties a device can have, mostly describing what formats it can burn, which are collected in DriveWriteCaps.

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

Defined in Foreign.Libcdio.Types.Enums

Methods

(==) :: DriveCapabilityRead -> DriveCapabilityRead -> Bool

(/=) :: DriveCapabilityRead -> DriveCapabilityRead -> Bool

Ord DriveCapabilityRead

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

Defined in Foreign.Libcdio.Types.Enums

Methods

readsPrec :: Int -> ReadS DriveCapabilityRead

readList :: ReadS [DriveCapabilityRead]

readPrec :: ReadPrec DriveCapabilityRead

readListPrec :: ReadPrec [DriveCapabilityRead]

Show DriveCapabilityRead

Defined in Foreign.Libcdio.Types.Enums

Methods

showsPrec :: Int -> DriveCapabilityRead -> ShowS

show :: DriveCapabilityRead -> String

showList :: [DriveCapabilityRead] -> ShowS

Ix DriveCapabilityRead

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

The collection of features for reading discs a device provides.

data DriveCapabilityWrite

Constructors

WriteCdRecordable

WriteCdReWritable

WriteDvdRecordable

WriteDvdPlusRecordable

WriteDvdRam

WriteDvdReWritable

WriteDvdPlusReWritable

WriteMtRainier

WriteBurnProof

Instances

Bounded DriveCapabilityWrite

Defined in Foreign.Libcdio.Types.Enums

Methods

minBound :: DriveCapabilityWrite

maxBound :: DriveCapabilityWrite

Enum DriveCapabilityWrite

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

Defined in Foreign.Libcdio.Types.Enums

Methods

(==) :: DriveCapabilityWrite -> DriveCapabilityWrite -> Bool

(/=) :: DriveCapabilityWrite -> DriveCapabilityWrite -> Bool

Ord DriveCapabilityWrite

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

Defined in Foreign.Libcdio.Types.Enums

Methods

readsPrec :: Int -> ReadS DriveCapabilityWrite

readList :: ReadS [DriveCapabilityWrite]

readPrec :: ReadPrec DriveCapabilityWrite

readListPrec :: ReadPrec [DriveCapabilityWrite]

Show DriveCapabilityWrite

Defined in Foreign.Libcdio.Types.Enums

Methods

showsPrec :: Int -> DriveCapabilityWrite -> ShowS

show :: DriveCapabilityWrite -> String

showList :: [DriveCapabilityWrite] -> ShowS

Ix DriveCapabilityWrite

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

The collection of features for writing discs a device provides.

capsWriteCd :: DriveWriteCaps

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

capsWriteDvd :: DriveWriteCaps

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

capsWrite :: DriveWriteCaps

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

data DriveCapabilityMisc

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

Bounded DriveCapabilityMisc

Defined in Foreign.Libcdio.Types.Enums

Methods

minBound :: DriveCapabilityMisc

maxBound :: DriveCapabilityMisc

Enum DriveCapabilityMisc

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.

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

Defined in Foreign.Libcdio.Types.Enums

Methods

(==) :: DriveCapabilityMisc -> DriveCapabilityMisc -> Bool

(/=) :: DriveCapabilityMisc -> DriveCapabilityMisc -> Bool

Ord DriveCapabilityMisc

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

Defined in Foreign.Libcdio.Types.Enums

Methods

readsPrec :: Int -> ReadS DriveCapabilityMisc

readList :: ReadS [DriveCapabilityMisc]

readPrec :: ReadPrec DriveCapabilityMisc

readListPrec :: ReadPrec [DriveCapabilityMisc]

Show DriveCapabilityMisc

Defined in Foreign.Libcdio.Types.Enums

Methods

showsPrec :: Int -> DriveCapabilityMisc -> ShowS

show :: DriveCapabilityMisc -> String

showList :: [DriveCapabilityMisc] -> ShowS

Ix DriveCapabilityMisc

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

The collection of hardware features a device was built with.

Drivers

driver :: Cdio DriverId

Get the driver through which the disc is being read.

drivers :: [DriverId]

All supported drivers, listed in order of preference.

osDriver :: DriverId

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

isImageDriver :: DriverId -> Bool

Whether a particular driver deals with image files saved to disc, or a CD drive itself.

isDevice :: FilePath -> IO Bool

Whether the path represents a physical disc drive in the system.

Session

setBlocksize :: Int -> Cdio DriverReturnCode

Specify how much data should be read from a disc at once. Note that this only affects the transport; any reading functions operate on independant byte counts or other sizes derived from such.

setSpeed :: Int -> Cdio DriverReturnCode

Specify the speed at which the disc is read. Lower values result in slower IO, but better accuracy.

isMediaChanged :: Cdio (Either DriverReturnCode Bool)

Check if any data in the read session has been changed since the last call of this function. This is most helpful when multiple Cdio computations are run on a partial call of open or similar.

Devices

devices :: DriverId -> IO [FilePath]

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.

defaultDevice :: IO (Maybe FilePath)

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

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.

capabilities :: Cdio DriveCaps

Which features are provided by the current device. See deviceCapabilities when a session has not yet been opened.

deviceCapabilities :: FilePath -> IO DriveCaps

Which features are provided by a particular device. See capabilities for accessing these within a Cdio session.

Images

isCue :: FilePath -> IO Bool

Whether a file is valid according to the (loose) CUE standard.

isToc :: FilePath -> IO Bool

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

isNrg :: FilePath -> IO Bool

Check that a Nero disc image file is valid.

Hardware

hardware :: Cdio HardwareInfo

Get a description of the device in use.

haveAtapi :: Cdio (Maybe Bool)

Whether ATAPI commands are understood by the current device.

Returns Nothing if the capability can't be determined.

ejectDevice :: Maybe FilePath -> IO DriverReturnCode

Open a particular device's tray or otherwise free any disc it holds for removal, replacement, or insertion.

closeDeviceTray :: Maybe FilePath -> IO DriverReturnCode

If a device supports discs on an extending, motorized tray (i.e. a standard CD drive), close it.

closeDeviceTray' :: Maybe FilePath -> DriverId -> IO DriverReturnCode

As closeDeviceTray', but specify the driver to use in case of ambiguity.