BizHawk/BizHawk.Emulation.Common/Interfaces/ICoreFileProvider.cs

59 lines
2.0 KiB
C#

using System;
namespace BizHawk.Emulation.Common
{
/// <summary>
/// Defines the means by which firmware, bios and other necessary files are provided to a core that needs them
/// </summary>
public interface ICoreFileProvider
{
/// <summary>
/// Produces a path to the requested file, expected to be parallel to the running rom. for example: cue+bin files or SFC+PCM (MSU-1 games)
/// </summary>
[Obsolete]
string PathSubfile(string fname);
/// <summary>
/// produces a path that contains emulation related DLL and exe files
/// </summary>
string DllPath();
/// <summary>
/// produces a path that contains saveram... because libretro cores need it
/// </summary>
string GetRetroSaveRAMDirectory();
/// <summary>
/// produces a path for use as a libretro system path (different for each core)
/// </summary>
string GetRetroSystemPath();
string GetGameBasePath();
#region EmuLoadHelper api
/// <summary>
/// get path to a firmware
/// </summary>
/// <param name="sysId">The system id</param>
/// <param name="firmwareId">The firmware id</param>
/// <param name="required">if true, result is guaranteed to be valid; else null is possible if not found</param>
/// <param name="msg">message to show if fail to get</param>
[Obsolete]
string GetFirmwarePath(string sysId, string firmwareId, bool required, string msg = null);
/// <summary>
/// Get a firmware as a byte array
/// </summary>
/// <param name="sysId">the core systemID</param>
/// <param name="firmwareId">the firmware id</param>
/// <param name="required">if true, result is guaranteed to be valid; else null is possible if not found</param>
/// <param name="msg">message to show if fail to get</param>
byte[] GetFirmware(string sysId, string firmwareId, bool required, string msg = null);
byte[] GetFirmwareWithGameInfo(string sysId, string firmwareId, bool required, out GameInfo gi, string msg = null);
#endregion
}
}