Random access to the data track of a cue, raw, or ISO disc image.
More...
#include <sourceimage.h>
|
| std::expected< LocatedFile, Error > | find (const std::string &name) override |
| | Locate a file by name anywhere in the tree.
|
| std::expected< void, Error > | readSector (std::uint32_t lba, std::span< std::uint8_t, kSectorData > sector) override |
| | Read the data bytes of one sector.
|
| std::expected< std::size_t, Error > | readSectors (std::uint32_t lba, std::span< std::uint8_t > sectors) override |
| | Read the data bytes of consecutive sectors, stopping where the medium ends.
|
| std::uint32_t | volumeSectors () const override |
| | Report the sector count of the volume.
|
| virtual | ~Volume ()=default |
| | Release the medium.
|
| std::expected< std::string, Error > | bootExecutable () |
| | Read the name of the executable the disc boots.
|
|
| static std::expected< std::unique_ptr< SourceImage >, Error > | open (const std::filesystem::path &path) |
| | Open an image and verify its primary volume descriptor.
|
| static std::expected< std::string, Error > | parseBoot2 (std::span< const std::uint8_t > data) |
| | Read the executable name from the text of SYSTEM.CNF.
|
| static std::uint32_t | sectorsFor (std::uint64_t size) |
| | Count the sectors that a length in bytes occupies.
|
| static std::string | upperAscii (std::string_view text) |
| | Convert the ASCII letters of a text to upper case.
|
| static std::string | lowerAscii (std::string_view text) |
| | Convert the ASCII letters of a text to lower case.
|
| static std::unexpected< Error > | pastEnd (std::uint32_t lba) |
| | Report that a sector lies past the end of the medium.
|
|
| using | Sector = std::array<std::uint8_t, kSectorData> |
| | The data bytes of one sector.
|
| static constexpr std::size_t | kSectorData = 2048 |
| | Data bytes in one sector.
|
| static constexpr std::uint32_t | kPvdSector = 16 |
| | Sector of the primary volume descriptor.
|
| static constexpr std::string_view | kPvdMagic = "CD001" |
| | Identifier of an ISO9660 volume descriptor.
|
| static constexpr std::string_view | kSystemCnf = "SYSTEM.CNF" |
| | Name of the boot configuration file.
|
| static constexpr std::string_view | kPalExecutable = "SCES_507.91" |
| | Executable of the European release.
|
| static constexpr std::string_view | kNtscExecutable = "SCUS_971.25" |
| | Executable of the North American release.
|
Random access to the data track of a cue, raw, or ISO disc image.
◆ open()
| std::expected< std::unique_ptr< SourceImage >, Error > Tools::BuildImage::SourceImage::open |
( |
const std::filesystem::path & | path | ) |
|
|
static |
Open an image and verify its primary volume descriptor.
- Parameters
-
| path | Cue, raw, or ISO image path. |
- Returns
- The open image, or an error when the image cannot be opened, the layout is unknown, or sector sixteen lacks the descriptor.
◆ find()
| std::expected< LocatedFile, Error > Tools::BuildImage::SourceImage::find |
( |
const std::string & | name | ) |
|
|
overridevirtual |
Locate a file by name anywhere in the tree.
- Parameters
-
| name | File name without the version suffix. |
- Returns
- Extent and containing directory of the match, or an error when the file is missing or spans several extents.
Implements Tools::BuildImage::Volume.
◆ readSector()
| std::expected< void, Error > Tools::BuildImage::SourceImage::readSector |
( |
std::uint32_t | lba, |
|
|
std::span< std::uint8_t, kSectorData > | sector ) |
|
overridevirtual |
Read the data bytes of one sector.
- Parameters
-
| lba | Sector number relative to the track start. |
| sector | Destination of the 2048 data bytes. |
- Returns
- Nothing, or an error when the medium ends before the sector.
Implements Tools::BuildImage::Volume.
◆ readSectors()
| std::expected< std::size_t, Error > Tools::BuildImage::SourceImage::readSectors |
( |
std::uint32_t | lba, |
|
|
std::span< std::uint8_t > | sectors ) |
|
overridevirtual |
Read the data bytes of consecutive sectors, stopping where the medium ends.
- Parameters
-
| lba | First sector number relative to the track start. |
| sectors | Destination, a whole number of sectors long. |
- Returns
- Number of sectors read in full, or an error when a source file cannot be read.
Reimplemented from Tools::BuildImage::Volume.
◆ volumeSectors()
| std::uint32_t Tools::BuildImage::SourceImage::volumeSectors |
( |
| ) |
const |
|
nodiscardoverridevirtual |
Report the sector count of the volume.
- Returns
- Sectors described by the primary volume descriptor.
Implements Tools::BuildImage::Volume.
The documentation for this class was generated from the following file: