Sound.Libcdio.Read.Data

This module is likely what most usage of the library revolves around: retrieving the data stored on a CD. For more discussion of the layout, see Foreign.Libcdio.Sector.

Types

data Lsn

The type-safe representation of a Logical Sector Number, counting sectors from the start of track 1; this notably excludes the blank session lead-in. See also Lba.

Instances

Bounded Lsn

Defined in Foreign.Libcdio.Types.Internal

Methods

minBound :: Lsn

maxBound :: Lsn

Enum Lsn

Defined in Foreign.Libcdio.Types.Internal

Methods

succ :: Lsn -> Lsn

pred :: Lsn -> Lsn

toEnum :: Int -> Lsn

fromEnum :: Lsn -> Int

enumFrom :: Lsn -> [Lsn]

enumFromThen :: Lsn -> Lsn -> [Lsn]

enumFromTo :: Lsn -> Lsn -> [Lsn]

enumFromThenTo :: Lsn -> Lsn -> Lsn -> [Lsn]

Eq Lsn

Defined in Foreign.Libcdio.Types.Internal

Methods

(==) :: Lsn -> Lsn -> Bool

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

Integral Lsn

Defined in Foreign.Libcdio.Types.Internal

Methods

quot :: Lsn -> Lsn -> Lsn

rem :: Lsn -> Lsn -> Lsn

div :: Lsn -> Lsn -> Lsn

mod :: Lsn -> Lsn -> Lsn

quotRem :: Lsn -> Lsn -> (Lsn, Lsn)

divMod :: Lsn -> Lsn -> (Lsn, Lsn)

toInteger :: Lsn -> Integer

Num Lsn

Defined in Foreign.Libcdio.Types.Internal

Methods

(+) :: Lsn -> Lsn -> Lsn

(-) :: Lsn -> Lsn -> Lsn

(*) :: Lsn -> Lsn -> Lsn

negate :: Lsn -> Lsn

abs :: Lsn -> Lsn

signum :: Lsn -> Lsn

fromInteger :: Integer -> Lsn

Ord Lsn

Defined in Foreign.Libcdio.Types.Internal

Methods

compare :: Lsn -> Lsn -> Ordering

(<) :: Lsn -> Lsn -> Bool

(<=) :: Lsn -> Lsn -> Bool

(>) :: Lsn -> Lsn -> Bool

(>=) :: Lsn -> Lsn -> Bool

max :: Lsn -> Lsn -> Lsn

min :: Lsn -> Lsn -> Lsn

Read Lsn

Defined in Foreign.Libcdio.Types.Internal

Methods

readsPrec :: Int -> ReadS Lsn

readList :: ReadS [Lsn]

readPrec :: ReadPrec Lsn

readListPrec :: ReadPrec [Lsn]

Real Lsn

Defined in Foreign.Libcdio.Types.Internal

Methods

toRational :: Lsn -> Rational

Show Lsn

Defined in Foreign.Libcdio.Types.Internal

Methods

showsPrec :: Int -> Lsn -> ShowS

show :: Lsn -> String

showList :: [Lsn] -> ShowS

Ix Lsn

Defined in Foreign.Libcdio.Types.Internal

Methods

range :: (Lsn, Lsn) -> [Lsn]

index :: (Lsn, Lsn) -> Lsn -> Int

unsafeIndex :: (Lsn, Lsn) -> Lsn -> Int

inRange :: (Lsn, Lsn) -> Lsn -> Bool

rangeSize :: (Lsn, Lsn) -> Int

unsafeRangeSize :: (Lsn, Lsn) -> Int

PrintfArg Lsn

Defined in Foreign.Libcdio.Types.Internal

Methods

formatArg :: Lsn -> FieldFormatter

parseFormat :: Lsn -> ModifierParser

Storable Lsn

Defined in Foreign.Libcdio.Types.Internal

Methods

sizeOf :: Lsn -> Int

alignment :: Lsn -> Int

peekElemOff :: Ptr Lsn -> Int -> IO Lsn

pokeElemOff :: Ptr Lsn -> Int -> Lsn -> IO ()

peekByteOff :: Ptr b -> Int -> IO Lsn

pokeByteOff :: Ptr b -> Int -> Lsn -> IO ()

peek :: Ptr Lsn -> IO Lsn

poke :: Ptr Lsn -> Lsn -> IO ()

Bits Lsn

Defined in Foreign.Libcdio.Types.Internal

Methods

(.&.) :: Lsn -> Lsn -> Lsn

(.|.) :: Lsn -> Lsn -> Lsn

xor :: Lsn -> Lsn -> Lsn

complement :: Lsn -> Lsn

shift :: Lsn -> Int -> Lsn

rotate :: Lsn -> Int -> Lsn

zeroBits :: Lsn

bit :: Int -> Lsn

setBit :: Lsn -> Int -> Lsn

clearBit :: Lsn -> Int -> Lsn

complementBit :: Lsn -> Int -> Lsn

testBit :: Lsn -> Int -> Bool

bitSizeMaybe :: Lsn -> Maybe Int

bitSize :: Lsn -> Int

isSigned :: Lsn -> Bool

shiftL :: Lsn -> Int -> Lsn

unsafeShiftL :: Lsn -> Int -> Lsn

shiftR :: Lsn -> Int -> Lsn

unsafeShiftR :: Lsn -> Int -> Lsn

rotateL :: Lsn -> Int -> Lsn

rotateR :: Lsn -> Int -> Lsn

popCount :: Lsn -> Int

FiniteBits Lsn

Defined in Foreign.Libcdio.Types.Internal

Methods

finiteBitSize :: Lsn -> Int

countLeadingZeros :: Lsn -> Int

countTrailingZeros :: Lsn -> Int

data Whence

Which location an offset passed to seek should be based on.

Constructors

SeekStart

SeekCurrent

SeekEnd

Instances

Bounded Whence

Defined in Foreign.Libcdio.Types.Enums

Methods

minBound :: Whence

maxBound :: Whence

Enum Whence

Defined in Foreign.Libcdio.Types.Enums

Methods

succ :: Whence -> Whence

pred :: Whence -> Whence

toEnum :: Int -> Whence

fromEnum :: Whence -> Int

enumFrom :: Whence -> [Whence]

enumFromThen :: Whence -> Whence -> [Whence]

enumFromTo :: Whence -> Whence -> [Whence]

enumFromThenTo :: Whence -> Whence -> Whence -> [Whence]

Eq Whence

Defined in Foreign.Libcdio.Types.Enums

Methods

(==) :: Whence -> Whence -> Bool

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

Ord Whence

Defined in Foreign.Libcdio.Types.Enums

Methods

compare :: Whence -> Whence -> Ordering

(<) :: Whence -> Whence -> Bool

(<=) :: Whence -> Whence -> Bool

(>) :: Whence -> Whence -> Bool

(>=) :: Whence -> Whence -> Bool

max :: Whence -> Whence -> Whence

min :: Whence -> Whence -> Whence

Read Whence

Defined in Foreign.Libcdio.Types.Enums

Methods

readsPrec :: Int -> ReadS Whence

readList :: ReadS [Whence]

readPrec :: ReadPrec Whence

readListPrec :: ReadPrec [Whence]

Show Whence

Defined in Foreign.Libcdio.Types.Enums

Methods

showsPrec :: Int -> Whence -> ShowS

show :: Whence -> String

showList :: [Whence] -> ShowS

data DiscMode

Different types of disc. Modes are combined from several sources, along with some libcdio-specific additions:

• MMC-5 6.33.3.13 (Send CUESHEET)
• MMC-5 Table 400 "DVD Book"
• GNU/Linux /usr/include/linux/cdrom.h

As C2HS and Haddock don't yet interact well enough to document Enum fields, some of the less obvious mappings include:

• DataCdMode: CD-ROM form 1
• MixedCdMode: some combination of AudioCdMode, DataCdMode, and XaCdMode
• DvdPlusRecordableMode: DVD+R
• DvdPlusReWritableMode: DVD+RW

Constructors

AudioCdMode

DataCdMode

XaCdMode

MixedCdMode

DvdRomMode

DvdRamMode

DvdRecordableMode

DvdReWritableMode

HighDefinitionDvdRomMode

HighDefinitionDvdRamMode

HighDefinitionDvdRecordableMode

DvdPlusRecordableMode

DvdPlusReWritableMode

DoubleLayerDvdPlusReWritableMode

DoubleLayerDvdPlusRecordableMode

OtherDvdMode

NoModeInfo

CdIMode

Instances

Bounded DiscMode

Defined in Foreign.Libcdio.Types.Enums

Methods

minBound :: DiscMode

maxBound :: DiscMode

Enum DiscMode

Defined in Foreign.Libcdio.Types.Enums

Methods

succ :: DiscMode -> DiscMode

pred :: DiscMode -> DiscMode

toEnum :: Int -> DiscMode

fromEnum :: DiscMode -> Int

enumFrom :: DiscMode -> [DiscMode]

enumFromThen :: DiscMode -> DiscMode -> [DiscMode]

enumFromTo :: DiscMode -> DiscMode -> [DiscMode]

enumFromThenTo :: DiscMode -> DiscMode -> DiscMode -> [DiscMode]

Eq DiscMode

Defined in Foreign.Libcdio.Types.Enums

Methods

(==) :: DiscMode -> DiscMode -> Bool

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

Ord DiscMode

Defined in Foreign.Libcdio.Types.Enums

Methods

compare :: DiscMode -> DiscMode -> Ordering

(<) :: DiscMode -> DiscMode -> Bool

(<=) :: DiscMode -> DiscMode -> Bool

(>) :: DiscMode -> DiscMode -> Bool

(>=) :: DiscMode -> DiscMode -> Bool

max :: DiscMode -> DiscMode -> DiscMode

min :: DiscMode -> DiscMode -> DiscMode

Read DiscMode

Defined in Foreign.Libcdio.Types.Enums

Methods

readsPrec :: Int -> ReadS DiscMode

readList :: ReadS [DiscMode]

readPrec :: ReadPrec DiscMode

readListPrec :: ReadPrec [DiscMode]

Show DiscMode

Defined in Foreign.Libcdio.Types.Enums

Methods

showsPrec :: Int -> DiscMode -> ShowS

show :: DiscMode -> String

showList :: [DiscMode] -> ShowS

isCdRom :: DiscMode -> Bool

Return true if a DiscMode refers to some sort of CD.

isDvd :: DiscMode -> Bool

Return true if a DiscMode refers to some sort of DVD.

Info

discMode :: Cdio (Maybe DiscMode)

Determine which type of disc is being accessed.

discJolietLevel :: Cdio (Maybe Word)

The original ISO 9660 (data) filesystem specification was rather restrictive in what files could be named; the Joliet extensions allow such exciting features as lowercase letters, not to mention full Unicode support.

lastAddress :: Cdio (Maybe Lsn)

Get the size of a disc in blocks, or equivalently the address of the end of the readable data.

lastSessionAddress :: Cdio (Either DriverReturnCode Lsn)

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

audioTimestamp :: Lsn -> Text

Print a disc timestamp in the standard "MM:SS:FF" format, assuming the address refers to audio data.

catalogue :: Cdio (Maybe Text)

Get the media catalog number from a disc. This may also be retrieved by code $ info Nothing, though that references a different source and thus may not have the same return value.

isrc :: Track -> Cdio (Maybe Text)

The International Standard Recording Code the given track. This may also be retrieved by code . info $ Just t, though that references a different source and thus may not have the same return value.

Read

For now, the library isn't able to automatically determine which read* function should be used; refer to format, and switch on its return value. For more info on the various data layouts, see the intro to Foreign.Libcdio.Sector.

Compared to the C and Foreign interfaces, all read functions have been tweaked for better internal consistency. Where a cdio_read or readBytes call would ask for the number of bytes to read, here it asks for the number of sectors. On the other hand, the formerly sector-oriented commands operate from the current seek position rather than, effectively, hiding a seek behind the scenes.

seek :: Int -> Whence -> Cdio Lsn

Reposition the read pointer in the Cdio session for a future call to one of the read* functions.

readRaw :: Word -> Cdio ByteString

Read a given number of sectors from the disc. With data of a known structure, use readAudio, readData, or readXa, which don't include the headers and footers described in Foreign.Libcdio.Sector.

readAudio :: Word -> Cdio ByteString

Read a given number of sectors stored as CD-DA from the disc.

readData

Arguments

:: Bool

If True Form 2, otherwise Form 1 (see Foreign.Libcdio.Sector).

-> Word

-> Cdio ByteString

Read a given number of sectors stored as Mode 1 data from the disc.

readXa

Arguments

:: Bool

If True Form 2, otherwise Form 1 (see Foreign.Libcdio.Sector).

-> Word

-> Cdio ByteString

Read a given number of sectors stored according to the Mode 2 extension from the disc.

Basic counts

framesPerSec :: Word

The number of disc sectors comprising a second of audio data.

maxCdSectors :: Word

The maximum number of sectors allowed to be stored on a disc.

maxCdMinutes :: Word

The typical maximum length of a disc, though it's not a strict limit.

defaultPregapSectors :: Word

The number of sectors spanned by a track pre-gap by default.

defaultPostgapSectors :: Word

The number of sectors spanned by a track post-gap by default.