mame/src/tools/image_handler.cpp
AJR 25976be0ac image_handler.cpp: Floppy fixes
- Refilter list of specific floppy formats using the known form factor and variant before trying to mount a filesystem on an image
- Sort identify results by decreasing score (code already expects the best format to be first)

* formats/ap_dsk35.cpp: Remove temporary hack
2024-02-15 15:24:35 -05:00

398 lines
11 KiB
C++

// license:BSD-3-Clause
// copyright-holders:Olivier Galibert
// Image generic handler class and helpers
#include "image_handler.h"
#include "formats/all.h"
#include "formats/fsblk_vec.h"
#include "formats/fs_unformatted.h"
#include "ioprocs.h"
#include "ioprocsfill.h"
#include "ioprocsvec.h"
#include "multibyte.h"
#include "strformat.h"
#include <algorithm>
// Format enumeration
namespace {
struct enumerator : public mame_formats_enumerator {
formats_table *m_table;
std::string m_category;
enumerator(formats_table *table) : mame_formats_enumerator(), m_table(table), m_category("None") {}
virtual ~enumerator() = default;
virtual void add(const cassette_image::Format *const *formats) {}
virtual void category(const char *name) {
m_category = name;
}
virtual void add(const floppy_image_format_t &format) {
m_table->floppy_format_infos.emplace_back(std::make_unique<floppy_format_info>(&format, m_category));
}
virtual void add(const fs::manager_t &fs) {
m_table->filesystem_formats.emplace_back(std::make_unique<filesystem_format>(&fs, m_category));
}
};
struct fs_enum : public fs::manager_t::floppy_enumerator {
filesystem_format *m_format;
fs_enum(filesystem_format *format, u32 form_factor, const std::vector<u32> &variants) : fs::manager_t::floppy_enumerator(form_factor, variants), m_format(format) {}
virtual void add_format(const floppy_image_format_t &type, u32 image_size, const char *name, const char *description) override {
m_format->m_floppy = true;
m_format->m_floppy_create.emplace_back(std::make_unique<floppy_create_info>(m_format->m_manager, &type, image_size, name, description));
}
virtual void add_raw(const char *name, u32 key, const char *description) override {
m_format->m_floppy_raw = true;
m_format->m_floppy_create.emplace_back(std::make_unique<floppy_create_info>(name, key, description));
}
};
}
void formats_table::init()
{
std::vector<uint32_t> variants;
enumerator en(this);
mame_formats_full_list(en);
for(auto &f : filesystem_formats) {
fs_enum fen(f.get(), floppy_image::FF_UNKNOWN, variants);
f->m_manager->enumerate_f(fen);
}
for(auto &f : floppy_format_infos) {
auto *ff = f.get();
std::string key = ff->m_format->name();
auto i = floppy_format_info_by_key.find(key);
if(i != floppy_format_info_by_key.end()) {
fprintf(stderr, "Collision on floppy format name %s between \"%s\" and \"%s\".\n",
ff->m_format->name(),
ff->m_format->description(),
i->second->m_format->description());
exit(1);
}
floppy_format_info_by_key[key] = ff;
floppy_format_info_by_category[ff->m_category].push_back(ff);
}
for(auto &f : filesystem_formats) {
auto *ff = f.get();
std::string key = ff->m_manager->name();
auto i = filesystem_format_by_key.find(key);
if(i != filesystem_format_by_key.end()) {
fprintf(stderr, "Collision on filesystem name %s between \"%s\" and \"%s\".\n",
ff->m_manager->name(),
ff->m_manager->description(),
i->second->m_manager->description());
exit(1);
}
filesystem_format_by_key[key] = ff;
filesystem_format_by_category[ff->m_category].push_back(ff);
for(auto &f2 : ff->m_floppy_create) {
auto *ff2 = f2.get();
key = ff2->m_name;
auto i = floppy_create_info_by_key.find(key);
if(i != floppy_create_info_by_key.end()) {
fprintf(stderr, "Collision on floppy create name %s between \"%s\" and \"%s\".\n",
ff2->m_name,
ff2->m_description,
i->second->m_description);
exit(1);
}
floppy_create_info_by_key[key] = ff2;
}
}
}
const floppy_format_info *formats_table::find_floppy_format_info_by_key(const std::string &key) const
{
auto i = floppy_format_info_by_key.find(key);
return i == floppy_format_info_by_key.end() ? nullptr : i->second;
}
const filesystem_format *formats_table::find_filesystem_format_by_key(const std::string &key) const
{
auto i = filesystem_format_by_key.find(key);
return i == filesystem_format_by_key.end() ? nullptr : i->second;
}
const floppy_create_info *formats_table::find_floppy_create_info_by_key(const std::string &key) const
{
auto i = floppy_create_info_by_key.find(key);
return i == floppy_create_info_by_key.end() ? nullptr : i->second;
}
// Image handling
std::vector<u8> image_handler::fload(std::string path)
{
auto fi = fopen(path.c_str(), "rb");
if(!fi) {
perror(util::string_format("Error opening %s for reading", path).c_str());
exit(1);
}
fseek(fi, 0, SEEK_END);
long size = ftell(fi);
std::vector<u8> filedata(size);
fseek(fi, 0, SEEK_SET);
fread(filedata.data(), filedata.size(), 1, fi);
fclose(fi);
return filedata;
}
std::vector<u8> image_handler::fload_rsrc(std::string path)
{
auto filedata = fload(path);
const u8 *head = filedata.data();
if(get_u32be(head+0x00) == 0x00051607 &&
get_u32be(head+0x04) == 0x00020000) {
u16 nent = get_u16be(head+0x18);
for(u16 i=0; i != nent; i++) {
const u8 *e = head + 12*i;
if(get_u32be(e+0) == 2) {
u32 start = get_u32be(e+4);
u32 len = get_u32be(e+8);
filedata.erase(filedata.begin(), filedata.begin() + start);
filedata.erase(filedata.begin() + len, filedata.end());
return filedata;
}
}
}
filedata.clear();
return filedata;
}
void image_handler::fsave(std::string path, const std::vector<u8> &data)
{
auto fo = fopen(path.c_str(), "wb");
if(!fo) {
perror(util::string_format("Error opening %s for writing", path).c_str());
exit(1);
}
fwrite(data.data(), data.size(), 1, fo);
fclose(fo);
}
void image_handler::fsave_rsrc(std::string path, const std::vector<u8> &data)
{
u8 head[0x2a];
put_u32be(head+0x00, 0x00051607); // Magic
put_u32be(head+0x04, 0x00020000); // Version
memset(head+0x08, 0, 16); // Filler
put_u16be(head+0x18, 1); // Number of entries
put_u32be(head+0x1a, 2); // Resource fork
put_u32be(head+0x22, 0x2a); // Offset in the file
put_u32be(head+0x26, data.size()); // Length
auto fo = fopen(path.c_str(), "wb");
if(!fo) {
perror(util::string_format("Error opening %s for writing", path).c_str());
exit(1);
}
fwrite(head, sizeof(head), 1, fo);
fwrite(data.data(), data.size(), 1, fo);
fclose(fo);
}
image_handler::image_handler() : m_floppy_image(84, 2, floppy_image::FF_UNKNOWN)
{
}
void image_handler::set_on_disk_path(std::string path)
{
m_on_disk_path = path;
}
std::vector<std::pair<u8, const floppy_format_info *>> image_handler::identify(const formats_table &formats)
{
std::vector<std::pair<u8, const floppy_format_info *>> res;
std::vector<uint32_t> variants;
FILE *f = fopen(m_on_disk_path.c_str(), "rb");
if (!f) {
std::string msg = util::string_format("Error opening %s for reading", m_on_disk_path);
perror(msg.c_str());
return res;
}
auto io = util::stdio_read(f, 0xff);
for(const auto &e : formats.floppy_format_info_by_key) {
u8 score = e.second->m_format->identify(*io, floppy_image::FF_UNKNOWN, variants);
if(score && e.second->m_format->extension_matches(m_on_disk_path.c_str()))
score |= floppy_image_format_t::FIFID_EXT;
if(score)
res.emplace_back(std::make_pair(score, e.second));
}
// Sort results by decreasing score
std::stable_sort(res.begin(), res.end(), [](const auto &a, const auto &b) { return a.first > b.first; });
return res;
}
bool image_handler::floppy_load(const floppy_format_info &format)
{
std::vector<uint32_t> variants;
FILE *f = fopen(m_on_disk_path.c_str(), "rb");
if (!f) {
std::string msg = util::string_format("Error opening %s for reading", m_on_disk_path);
perror(msg.c_str());
return true;
}
auto io = util::stdio_read(f, 0xff);
return !format.m_format->load(*io, floppy_image::FF_UNKNOWN, variants, m_floppy_image);
}
bool image_handler::floppy_save(const floppy_format_info &format) const
{
std::vector<uint32_t> variants;
FILE *f = fopen(m_on_disk_path.c_str(), "wb");
if (!f) {
auto msg = util::string_format("Error opening %s for writing", m_on_disk_path);
perror(msg.c_str());
return true;
}
auto io = util::stdio_read_write(f, 0xff);
return !format.m_format->save(*io, variants, m_floppy_image);
}
void image_handler::floppy_create(const floppy_create_info &format, fs::meta_data meta)
{
if(format.m_type) {
std::vector<uint32_t> variants;
std::vector<u8> img(format.m_image_size);
fs::fsblk_vec_t blockdev(img);
auto fs = format.m_manager->mount(blockdev);
fs->format(meta);
auto io = util::ram_read(img.data(), img.size(), 0xff);
format.m_type->load(*io, floppy_image::FF_UNKNOWN, variants, m_floppy_image);
} else {
fs::unformatted_image::format(format.m_key, &m_floppy_image);
}
}
bool image_handler::floppy_mount_fs(const filesystem_format &format)
{
// Create a restricted copy of the format list based on the known form factor and variant
filesystem_format fmtcopy(format.m_manager, format.m_category);
std::vector<u32> const var(1, m_floppy_image.get_variant());
fs_enum fen(&fmtcopy, m_floppy_image.get_form_factor(), var);
format.m_manager->enumerate_f(fen);
m_floppy_fs_converter = nullptr;
for(const auto &ci : fmtcopy.m_floppy_create) {
if(ci->m_type != m_floppy_fs_converter) {
std::vector<uint32_t> variants;
m_floppy_fs_converter = ci->m_type;
m_sector_image.clear();
util::random_read_write_fill_wrapper<util::vector_read_write_adapter<u8>, 0xff> io(m_sector_image);
m_floppy_fs_converter->save(io, variants, m_floppy_image);
}
if(ci->m_image_size == m_sector_image.size())
goto success;
}
m_floppy_fs_converter = nullptr;
m_sector_image.clear();
return true;
success:
m_fsblk.reset(new fs::fsblk_vec_t(m_sector_image));
m_fsm = format.m_manager;
m_fs = m_fsm->mount(*m_fsblk);
return false;
}
bool image_handler::hd_mount_fs(const filesystem_format &format)
{
// Should use the chd mechanisms, one thing at a time...
m_sector_image = fload(m_on_disk_path);
m_fsblk.reset(new fs::fsblk_vec_t(m_sector_image));
m_fsm = format.m_manager;
m_fs = m_fsm->mount(*m_fsblk);
return false;
}
void image_handler::fs_to_floppy()
{
std::vector<uint32_t> variants;
auto io = util::ram_read(m_sector_image.data(), m_sector_image.size(), 0xff);
m_floppy_fs_converter->load(*io, floppy_image::FF_UNKNOWN, variants, m_floppy_image);
}
std::vector<std::string> image_handler::path_split(std::string path) const
{
std::string opath = path;
std::vector<std::string> rpath;
if(m_fsm->has_subdirectories()) {
std::string element;
char sep = m_fsm->directory_separator();
for(char c : opath) {
if(c == sep) {
if(!element.empty()) {
rpath.push_back(element);
element.clear();
}
} else
element += c;
}
if(!element.empty())
rpath.push_back(element);
} else
rpath.push_back(opath);
return rpath;
}
bool image_handler::fexists(std::string path)
{
auto f = fopen(path.c_str(), "rb");
if(f != nullptr) {
fclose(f);
return true;
}
return false;
}
std::string image_handler::path_make_rsrc(std::string path)
{
auto p = path.end();
while(p != path.begin() && p[-1] != '/')
p--;
std::string rpath(path.begin(), p);
rpath += "._";
rpath += std::string(p, path.end());
return rpath;
}