driver.cpp

Go to the documentation of this file.

/*
 * This file is part of OpenTTD.
 * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
 * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
 */
 
#include "stdafx.h"
#include "core/string_consumer.hpp"
#include "debug.h"
#include "error.h"
#include "error_func.h"
#include "sound/sound_driver.hpp"
#include "music/music_driver.hpp"
#include "strings_func.h"
#include "video/video_driver.hpp"
#include "string_func.h"
#include "fileio_func.h"
#include "core/string_consumer.hpp"
 
#include "table/strings.h"
 
#include "safeguards.h"
 
std::string _ini_videodriver;        
std::vector<Dimension> _resolutions; 
Dimension _cur_resolution;           
bool _rightclick_emulate;            
 
std::string _ini_sounddriver;        
 
std::string _ini_musicdriver;        
 
std::string _ini_blitter;            
bool _blitter_autodetected;          
 
static const std::string HWACCELERATION_TEST_FILE = "hwaccel.dat"; 
 
std::optional<std::string_view> GetDriverParam(const StringList &parm, std::string_view name)
{
  if (parm.empty()) return std::nullopt;
 
  for (auto &p : parm) {
    StringConsumer consumer{p};
    if (consumer.ReadIf(name)) {
      if (!consumer.AnyBytesLeft()) return "";
      if (consumer.ReadIf("=")) return consumer.GetLeftData();
    }
  }
  return std::nullopt;
}
 
bool GetDriverParamBool(const StringList &parm, std::string_view name)
{
  return GetDriverParam(parm, name).has_value();
}
 
int GetDriverParamInt(const StringList &parm, std::string_view name, int def)
{
  auto p = GetDriverParam(parm, name);
  if (!p.has_value()) return def;
  auto value = ParseInteger<int>(*p);
  if (value.has_value()) return *value;
  UserError("Invalid value for driver parameter {}: {}", name, *p);
}
 
void DriverFactoryBase::SelectDriver(const std::string &name, Driver::Type type)
{
  if (!DriverFactoryBase::SelectDriverImpl(name, type)) {
    name.empty() ?
      UserError("Failed to autoprobe {} driver", GetDriverTypeName(type)) :
      UserError("Failed to select requested {} driver '{}'", GetDriverTypeName(type), name);
  }
}
 
bool DriverFactoryBase::SelectDriverImpl(const std::string &name, Driver::Type type)
{
  if (GetDrivers().empty()) return false;
 
  if (name.empty()) {
    /* Probe for this driver, but do not fall back to dedicated/null! */
    for (int priority = 10; priority > 0; priority--) {
      for (auto &it : GetDrivers()) {
        DriverFactoryBase *d = it.second;
 
        /* Check driver type */
        if (d->type != type) continue;
        if (d->priority != priority) continue;
 
        if (type == Driver::DT_VIDEO && !_video_hw_accel && d->UsesHardwareAcceleration()) continue;
 
        if (type == Driver::DT_VIDEO && _video_hw_accel && d->UsesHardwareAcceleration()) {
          /* Check if we have already tried this driver in last run.
           * If it is here, it most likely means we crashed. So skip
           * hardware acceleration. */
          auto filename = FioFindFullPath(BASE_DIR, HWACCELERATION_TEST_FILE);
          if (!filename.empty()) {
            FioRemove(filename);
 
            Debug(driver, 1, "Probing {} driver '{}' skipped due to earlier crash", GetDriverTypeName(type), d->name);
 
            _video_hw_accel = false;
            ErrorMessageData msg(GetEncodedString(STR_VIDEO_DRIVER_ERROR), GetEncodedString(STR_VIDEO_DRIVER_ERROR_HARDWARE_ACCELERATION_CRASH), true);
            ScheduleErrorMessage(std::move(msg));
            continue;
          }
 
          /* Write empty file to note we are attempting hardware acceleration. */
          FioFOpenFile(HWACCELERATION_TEST_FILE, "w", BASE_DIR);
        }
 
        /* Keep old driver in case we need to switch back, or may still need to process an OS callback. */
        auto oldd = std::move(GetActiveDriver(type));
        auto newd = d->CreateInstance();
 
        auto err = newd->Start({});
        if (!err) {
          Debug(driver, 1, "Successfully probed {} driver '{}'", GetDriverTypeName(type), d->name);
          GetActiveDriver(type) = std::move(newd);
          return true;
        }
 
        GetActiveDriver(type) = std::move(oldd);
        Debug(driver, 1, "Probing {} driver '{}' failed with error: {}", GetDriverTypeName(type), d->name, *err);
 
        if (type == Driver::DT_VIDEO && _video_hw_accel && d->UsesHardwareAcceleration()) {
          _video_hw_accel = false;
          ErrorMessageData msg(GetEncodedString(STR_VIDEO_DRIVER_ERROR), GetEncodedString(STR_VIDEO_DRIVER_ERROR_NO_HARDWARE_ACCELERATION), true);
          ScheduleErrorMessage(std::move(msg));
        }
      }
    }
    UserError("Couldn't find any suitable {} driver", GetDriverTypeName(type));
  } else {
    /* Extract the driver name and put parameter list in parm */
    std::istringstream buffer(name);
    std::string dname;
    std::getline(buffer, dname, ':');
 
    std::string param;
    std::vector<std::string> parms;
    while (std::getline(buffer, param, ',')) {
      parms.push_back(param);
    }
 
    /* Find this driver */
    for (auto &it : GetDrivers()) {
      DriverFactoryBase *d = it.second;
 
      /* Check driver type */
      if (d->type != type) continue;
 
      /* Check driver name */
      if (!StrEqualsIgnoreCase(dname, d->name)) continue;
 
      /* Found our driver, let's try it */
      auto newd = d->CreateInstance();
      auto err = newd->Start(parms);
      if (err) {
        UserError("Unable to load driver '{}'. The error was: {}", d->name, *err);
      }
 
      Debug(driver, 1, "Successfully loaded {} driver '{}'", GetDriverTypeName(type), d->name);
      GetActiveDriver(type) = std::move(newd);
      return true;
    }
    UserError("No such {} driver: {}\n", GetDriverTypeName(type), dname);
  }
}
 
void DriverFactoryBase::MarkVideoDriverOperational()
{
  /* As part of the detection whether the GPU driver crashes the game,
   * and as we are operational now, remove the hardware acceleration
   * test-file. */
  auto filename = FioFindFullPath(BASE_DIR, HWACCELERATION_TEST_FILE);
  if (!filename.empty()) FioRemove(filename);
}
 
void DriverFactoryBase::GetDriversInfo(std::back_insert_iterator<std::string> &output_iterator)
{
  for (Driver::Type type = Driver::DT_BEGIN; type != Driver::DT_END; type++) {
    fmt::format_to(output_iterator, "List of {} drivers:\n", GetDriverTypeName(type));
 
    for (int priority = 10; priority >= 0; priority--) {
      for (auto &it : GetDrivers()) {
        DriverFactoryBase *d = it.second;
        if (d->type != type) continue;
        if (d->priority != priority) continue;
        fmt::format_to(output_iterator, "{:>18}: {}\n", d->name, d->GetDescription());
      }
    }
 
    fmt::format_to(output_iterator, "\n");
  }
}
 
DriverFactoryBase::DriverFactoryBase(Driver::Type type, int priority, std::string_view name, std::string_view description) :
  type(type), priority(priority), name(name), description(description)
{
  /* Prefix the name with driver type to make it unique */
  std::string typed_name = fmt::format("{}{}", GetDriverTypeName(type), name);
 
  Drivers &drivers = GetDrivers();
  assert(drivers.find(typed_name) == drivers.end());
  drivers.insert(Drivers::value_type(typed_name, this));
}
 
DriverFactoryBase::~DriverFactoryBase()
{
  /* Prefix the name with driver type to make it unique */
  std::string typed_name = fmt::format("{}{}", GetDriverTypeName(type), name);
 
  Drivers::iterator it = GetDrivers().find(typed_name);
  assert(it != GetDrivers().end());
 
  GetDrivers().erase(it);
  if (GetDrivers().empty()) delete &GetDrivers();
}