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

Contents

Types
Location
Data

Description

What many people would think of as the most important division on a CD isn't quite as an integral a part of the physical data layout: they are described in a table of contents before the first track of any recording session, and may have lower-resolution "echoes" in the subchannels alongside the data, but it would be hard to otherwise recover the track boundaries from the data itself. This module, then, provides the functions to retrieve that metadata from the table of contents and from the subchannels.

`track.h`

Defines

CDIO_CDROM_CDI_TRACK (removed; only has utility in library code)
CDIO_CDROM_DATA_TRACK (removed; only has utility in library code)
CDIO_INVALID_TRACK (removed; handled via Nothing)
CDIO_CDROM_LBA (removed; only has utility in library code)
CDIO_CDROM_LEADOUT_TRACK -> DiscLeadout
CDIO_CDROM_MSF (removed; only has utility in library code)
CDIO_CDROM_XA_TRACK (removed; only has utility in library code)
CDIO_CD_MAX_TRACKS -> maxTrack
CDIO_CD_MIN_TRACK_NO -> minTrack

Types

track_flag_t -> Maybe Bool (CDIO_TRACK_FLAG_ERROR is never used in library code)
track_flags_t (removed; never used in the public interface)
track_format_t -> TrackFormat
- TRACK_FORMAT_PSX -> FormatPlaystation
- TRACK_FORMAT_ERROR (removed; handled via Nothing)

trackmode_t (removed; never used in the public API)

Symbols

cdio_get_first_track_num -> firstTrackNum
cdio_get_last_track_num -> lastTrackNum
cdio_get_track -> trackAt
cdio_get_track_channels -> numChannels
cdio_get_track_copy_permit -> copyPermit
cdio_get_track_format -> trackFormat
cdio_get_track_green -> isGreen
cdio_get_track_isrc -> trackIsrc
cdio_get_track_last_lsn -> trackLastLsn
cdio_get_track_lba -> trackLba
cdio_get_track_lsn -> trackLsn
cdio_get_track_msf -> trackMsf
cdio_get_track_preemphasis -> hasPreemphasis
cdio_get_track_pregap_lba -> pregapLba
cdio_get_track_pregap_lsn -> pregapLsn
cdio_get_track_sec_count -> sectorCount
track_format2str -> trackFormatString

Sound.Libcdio.Track

firstTrackNum -> firstDiscTrack
isrcLength (removed; unnecessary low-level detail)
lastTrackNum -> lastDiscTrack
numChannels -> quadAudio
pregapLba (removed; only Lsn is used in Sound)
pregapLsn -> pregap
sectorCount -> totalLength
trackFormat -> format
trackIsrc -> Sound.Libcdio.Read.Data.isrc
trackLastLsn -> offsetEnd
trackLba (removed; only Lsn is used in Sound)
trackLsn -> offset
trackMsf (removed; only Lsn is used in Sound)

Synopsis

data Track
- = DiscPregap
- | Track TrackNum
- | DiscLeadout
data TrackNum
minTrack :: Track
maxTrack :: Track
data TrackFormat
- = FormatAudio
- | FormatCdI
- | FormatXa
- | FormatData
- | FormatPlaystation
trackFormatString :: TrackFormat -> String
firstTrackNum :: Cdio -> IO (Maybe Track)
lastTrackNum :: Cdio -> IO (Maybe Track)
trackAt :: Cdio -> Lsn -> IO (Maybe Track)
trackLba :: Cdio -> Track -> IO (Maybe Lba)
trackLsn :: Cdio -> Track -> IO (Maybe Lsn)
trackMsf :: Cdio -> Track -> IO (Maybe Msf)
trackLastLsn :: Cdio -> Track -> IO (Maybe Lsn)
pregapLba :: Cdio -> Track -> IO (Maybe Lba)
pregapLsn :: Cdio -> Track -> IO (Maybe Lsn)
sectorCount :: Cdio -> Track -> IO (Maybe Word)
trackFormat :: Cdio -> Track -> IO (Maybe TrackFormat)
isGreen :: Cdio -> Track -> IO (Maybe Bool)
hasPreemphasis :: Cdio -> Track -> IO (Maybe Bool)
copyPermit :: Cdio -> Track -> IO (Maybe Bool)
numChannels :: Cdio -> Track -> IO (Maybe Word)
trackIsrc :: Cdio -> Track -> IO (Maybe String)
isrcLength :: Word

Types

data Track #

An index into the segmentation within a write session on a disc.

Constructors

DiscPregap	The (usually buffer) data located before the first track on a disc.
Track TrackNum	The common understanding of a CD track: a segment of the data on the disc containing (usually) a single song.
DiscLeadout	Any (usually buffer) data located after the end of the last track on a disc.

Instances

Instances details

Bounded Track #
Instance details Defined in Foreign.Libcdio.Types.Internal Methods minBound :: Track # maxBound :: Track #
Enum Track #	Note that `fromEnum DiscLeadout` uses a value (== 100) chosen to be contiguous to the rest of the datatype rather than that used internally (== 0xAA). `toEnum` accepts both values.
Instance details Defined in Foreign.Libcdio.Types.Internal Methods succ :: Track -> Track # pred :: Track -> Track # toEnum :: Int -> Track # fromEnum :: Track -> Int # enumFrom :: Track -> [Track] # enumFromThen :: Track -> Track -> [Track] # enumFromTo :: Track -> Track -> [Track] # enumFromThenTo :: Track -> Track -> Track -> [Track] #
Eq Track #
Instance details Defined in Foreign.Libcdio.Types.Internal Methods (==) :: Track -> Track -> Bool # (/=) :: Track -> Track -> Bool #
Num Track #
Instance details Defined in Foreign.Libcdio.Types.Internal Methods (+) :: Track -> Track -> Track # (-) :: Track -> Track -> Track # (*) :: Track -> Track -> Track # negate :: Track -> Track # abs :: Track -> Track # signum :: Track -> Track # fromInteger :: Integer -> Track #
Ord Track #
Instance details Defined in Foreign.Libcdio.Types.Internal Methods compare :: Track -> Track -> Ordering # (<) :: Track -> Track -> Bool # (<=) :: Track -> Track -> Bool # (>) :: Track -> Track -> Bool # (>=) :: Track -> Track -> Bool # max :: Track -> Track -> Track # min :: Track -> Track -> Track #
Read Track #
Instance details Defined in Foreign.Libcdio.Types.Internal Methods readsPrec :: Int -> ReadS Track # readList :: ReadS [Track] # readPrec :: ReadPrec Track # readListPrec :: ReadPrec [Track] #
Show Track #
Instance details Defined in Foreign.Libcdio.Types.Internal Methods showsPrec :: Int -> Track -> ShowS # show :: Track -> String # showList :: [Track] -> ShowS #
Ix Track #
Instance details Defined in Foreign.Libcdio.Types.Internal Methods range :: (Track, Track) -> [Track] # index :: (Track, Track) -> Track -> Int # unsafeIndex :: (Track, Track) -> Track -> Int # inRange :: (Track, Track) -> Track -> Bool # rangeSize :: (Track, Track) -> Int # unsafeRangeSize :: (Track, Track) -> Int #
PrintfArg Track #
Instance details Defined in Foreign.Libcdio.Types.Internal Methods formatArg :: Track -> FieldFormatter # parseFormat :: Track -> ModifierParser #
Storable Track #	Note that `poke` uses the official representation of `DiscLeadout` (`CDIO_CDROM_LEADOUT_TRACK == 0xAA`, as used by libcdio) rather than the hscdio `fromEnum DiscLeadout` (== 100), as the latter was chosen for proximity to the other constructors.
Instance details Defined in Foreign.Libcdio.Types.Internal Methods sizeOf :: Track -> Int # alignment :: Track -> Int # peekElemOff :: Ptr Track -> Int -> IO Track # pokeElemOff :: Ptr Track -> Int -> Track -> IO () # peekByteOff :: Ptr b -> Int -> IO Track # pokeByteOff :: Ptr b -> Int -> Track -> IO () # peek :: Ptr Track -> IO Track # poke :: Ptr Track -> Track -> IO () #

data TrackNum #

Opaque newtype representing the numeric index of a Track, while enforcing the invariants inherant to the specification. Of very limited utility outside that context.

Instances

Instances details

Bounded TrackNum #
Instance details Defined in Foreign.Libcdio.Types.Internal Methods minBound :: TrackNum # maxBound :: TrackNum #
Eq TrackNum #
Instance details Defined in Foreign.Libcdio.Types.Internal Methods (==) :: TrackNum -> TrackNum -> Bool # (/=) :: TrackNum -> TrackNum -> Bool #
Ord TrackNum #
Instance details Defined in Foreign.Libcdio.Types.Internal Methods compare :: TrackNum -> TrackNum -> Ordering # (<) :: TrackNum -> TrackNum -> Bool # (<=) :: TrackNum -> TrackNum -> Bool # (>) :: TrackNum -> TrackNum -> Bool # (>=) :: TrackNum -> TrackNum -> Bool # max :: TrackNum -> TrackNum -> TrackNum # min :: TrackNum -> TrackNum -> TrackNum #
Read TrackNum #
Instance details Defined in Foreign.Libcdio.Types.Internal Methods readsPrec :: Int -> ReadS TrackNum # readList :: ReadS [TrackNum] # readPrec :: ReadPrec TrackNum # readListPrec :: ReadPrec [TrackNum] #
Show TrackNum #
Instance details Defined in Foreign.Libcdio.Types.Internal Methods showsPrec :: Int -> TrackNum -> ShowS # show :: TrackNum -> String # showList :: [TrackNum] -> ShowS #

minTrack :: Track #

The first data track on a disc (i.e. Track 1).

maxTrack :: Track #

The highest data track allowed by the specifications (i.e. Track 99).

data TrackFormat #

The structure in which data is stored on a segment of a disc. The exact representation of these values is discussed in Foreign.Libcdio.Sector.

Constructors

FormatAudio
FormatCdI
FormatXa
FormatData
FormatPlaystation

Instances

Instances details

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

trackFormatString :: TrackFormat -> String #

Describe the data layout of a Track in a human-readable manner, as opposed to the machine representation returned by the Show instance.

Location

firstTrackNum :: Cdio -> IO (Maybe Track) #

The number of the first track on the disc. This will almost always be 1, but that is not strictly guaranteed; the (perhaps theoretical) example is of a multi-disc set, where later discs pick the numbering back up where the previous one left off.

Returns Nothing if the Cdio object has already been closed, or if the disc table of contents can't be read.

lastTrackNum :: Cdio -> IO (Maybe Track) #

The number of the last track on the disc.

Returns Nothing if the Cdio object has already been closed, or if the disc table of contents can't be read.

trackAt :: Cdio -> Lsn -> IO (Maybe Track) #

The track which contains the given address.

Returns Nothing if the Cdio object has already been closed, or if the address is beyond the written data on the disc. Note that DiscLeadout is treated as if it were a single sector long:

>>> Just endTrack <- lastTrackNum cdio
>>> Just endAddr <- trackLastLsn cdio endTrack
>>> trackAt cdio $ endAddr + 1
Just DiscLeadout
>>> trackAt cdio $ endAddr + 2
Nothing

trackLba :: Cdio -> Track -> IO (Maybe Lba) #

The address of the start of the given track.

trackLsn :: Cdio -> Track -> IO (Maybe Lsn) #

The address of the start of the given track.

trackMsf :: Cdio -> Track -> IO (Maybe Msf) #

The timestamp at which the given track begins.

trackLastLsn :: Cdio -> Track -> IO (Maybe Lsn) #

The address of the end of the given track.

pregapLba :: Cdio -> Track -> IO (Maybe Lba) #

The address of the start of any pregap before the given track.

pregapLsn :: Cdio -> Track -> IO (Maybe Lsn) #

The address of the start of any pregap before the given track.

sectorCount :: Cdio -> Track -> IO (Maybe Word) #

The number of sectors "assigned" to the specified track, including any in the pregap between it and the following one.

Data

trackFormat :: Cdio -> Track -> IO (Maybe TrackFormat) #

The raw data structure of a track.

isGreen :: Cdio -> Track -> IO (Maybe Bool) #

Whether the track data was stored using the Green Book (CD-i) standard.

hasPreemphasis :: Cdio -> Track -> IO (Maybe Bool) #

Whether preemphasis has been applied to the track for noise reduction.

copyPermit :: Cdio -> Track -> IO (Maybe Bool) #

Whether the track may be legally copied.

numChannels :: Cdio -> Track -> IO (Maybe Word) #

The number of channels in the given track; either 2 or 4 per the standard.

trackIsrc :: Cdio -> Track -> IO (Maybe String) #

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

isrcLength :: Word #

Number of ASCII characters in an International Standard Recording Code.