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.Read

Contents

Types
Functions
- Raw
- Sector

Description

After obtaining landmarks through Foreign.Libcdio.Disc (and likely Foreign.Libcdio.Track), this module provides the functions required to actually retrive the primary data from the disc. Some knowledge of its physical layout is required, which may be determined through trackFormat.

`read.h`

Types

cdio_read_mode_t -> ReadMode
- CDIO_READ_MODE_M1F1 -> Mode1Form1
- CDIO_READ_MODE_M1F2 -> Mode1Form2
- CDIO_READ_MODE_M2F1 -> Mode2Form1
- CDIO_READ_MODE_M2F2 -> Mode2Form2

Symbols

cdio_lseek -> seek
cdio_read -> readBytes
cdio_read_audio_sector -> readAudioSector
cdio_read_audio_sectors -> readAudioSectors
cdio_read_data_sectors -> readDataSectors
cdio_read_mode1_sector -> readDataModeSector
cdio_read_mode1_sectors -> readDataModeSectors
cdio_read_mode2_sector -> readXaModeSector
cdio_read_mode2_sectors -> readXaModeSectors
cdio_read_sector -> readSector
cdio_read_sectors -> readSectors

Sound.Libcdio.Read.Data

Each of the single-sector read* aliases have been removed for consistency.

ReadMode (removed; unnecessary low-level detail)
readAudioSectors -> readAudio
readBytes -> readRaw (note that the count is now the number of sectors rather than bytes)
readDataModeSectors -> readData
readDataSectors (removed; unnecessary low-level detail)
readXaModeSectors -> readXa

Synopsis

data ReadMode
- = AudioMode
- | Mode1Form1
- | Mode1Form2
- | Mode2Form1
- | Mode2Form2
data Whence
- = SeekStart
- | SeekCurrent
- | SeekEnd
seek :: Cdio -> Int -> Whence -> IO (Either DriverReturnCode Word)
readBytes :: Cdio -> Word -> IO (Maybe ByteString)
readSector :: Cdio -> Lsn -> ReadMode -> IO (Either DriverReturnCode ByteString)
readSectors :: Cdio -> Lsn -> ReadMode -> Word -> IO (Either DriverReturnCode ByteString)
readAudioSector :: Cdio -> Lsn -> IO (Either DriverReturnCode ByteString)
readAudioSectors :: Cdio -> Lsn -> Word -> IO (Either DriverReturnCode ByteString)
readDataSectors :: Cdio -> Lsn -> Word -> Word -> IO (Either DriverReturnCode ByteString)
readDataModeSector :: Cdio -> Lsn -> Bool -> IO (Either DriverReturnCode ByteString)
readDataModeSectors :: Cdio -> Lsn -> Bool -> Word -> IO (Either DriverReturnCode ByteString)
readXaModeSector :: Cdio -> Lsn -> Bool -> IO (Either DriverReturnCode ByteString)
readXaModeSectors :: Cdio -> Lsn -> Bool -> Word -> IO (Either DriverReturnCode ByteString)

Types

data ReadMode #

How data is laid out on a disc.

Constructors

AudioMode
Mode1Form1
Mode1Form2
Mode2Form1
Mode2Form2

Instances

Instances details

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

data Whence #

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

Constructors

SeekStart
SeekCurrent
SeekEnd

Instances

Instances details

Bounded Whence #
Instance details Defined in Foreign.Libcdio.Types.Enums Methods minBound :: Whence # maxBound :: Whence #
Enum Whence #
Instance details 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 #
Instance details Defined in Foreign.Libcdio.Types.Enums Methods (==) :: Whence -> Whence -> Bool # (/=) :: Whence -> Whence -> Bool #
Ord Whence #
Instance details 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 #
Instance details Defined in Foreign.Libcdio.Types.Enums Methods readsPrec :: Int -> ReadS Whence # readList :: ReadS [Whence] # readPrec :: ReadPrec Whence # readListPrec :: ReadPrec [Whence] #
Show Whence #
Instance details Defined in Foreign.Libcdio.Types.Enums Methods showsPrec :: Int -> Whence -> ShowS # show :: Whence -> String # showList :: [Whence] -> ShowS #

Functions

Raw

seek :: Cdio -> Int -> Whence -> IO (Either DriverReturnCode Word) #

Reposition the read pointer in the Cdio session for a future call to readBytes.

readBytes :: Cdio -> Word -> IO (Maybe ByteString) #

Read a given number of bytes from the disc. With data of a known structure, use readSectors or similar instead, which don't include the headers and footers described in Foreign.Libcdio.Sector.

Sector

readSector :: Cdio -> Lsn -> ReadMode -> IO (Either DriverReturnCode ByteString) #

Read the data contained in a specific sector from the disc.

readSectors :: Cdio -> Lsn -> ReadMode -> Word -> IO (Either DriverReturnCode ByteString) #

Read the data contained in the given number of sectors from the disc, beginning with the specified sector.

readAudioSector :: Cdio -> Lsn -> IO (Either DriverReturnCode ByteString) #

Similar to calling readSector with AudioMode, depending on the driver implementation.

readAudioSectors :: Cdio -> Lsn -> Word -> IO (Either DriverReturnCode ByteString) #

Similar to calling readSectors with AudioMode, depending on the driver implementation.

readDataSectors #

Arguments

:: Cdio
-> Lsn
-> Word	Sector size (e.g. `dataSize` or `dataSizeRawXa`).
-> Word	Number of sectors to read.
-> IO (Either DriverReturnCode ByteString)

Read the raw data from a given number of sectors on the disc, beginning with the specified sector.

readDataModeSector #

Arguments

:: Cdio
-> Lsn
-> Bool	If `True` Form 2, otherwise Form 1 (see Foreign.Libcdio.Sector).
-> IO (Either DriverReturnCode ByteString)

Similar to calling readSector, depending on the driver implementation.

readDataModeSectors #

Arguments

:: Cdio
-> Lsn
-> Bool	If `True` Form 2, otherwise Form 1 (see Foreign.Libcdio.Sector).
-> Word
-> IO (Either DriverReturnCode ByteString)

Similar to calling readSectors, depending on the driver implementation.

readXaModeSector #

Arguments

:: Cdio
-> Lsn
-> Bool	If `True` Form 2, otherwise Form 1 (see Foreign.Libcdio.Sector).
-> IO (Either DriverReturnCode ByteString)

Similar to calling readSector, depending on the driver implementation.

readXaModeSectors #

Arguments

:: Cdio
-> Lsn
-> Bool	If `True` Form 2, otherwise Form 1 (see Foreign.Libcdio.Sector).
-> Word
-> IO (Either DriverReturnCode ByteString)

Similar to calling readSectors, depending on the driver implementation.