API - HAL

General XBOX Functionality

File Access

Function	Description
int XConvertDOSFilenameToXBOX(   char *dosFilename,   char *xboxFilename )	Converts a dos-style filename (c:/foo/bar.txt) into an XBOX-style path (\Device\Harddisk0\Partition2\foo\bar.txt). Parameter Description dosFilename The dos filename. Examples are c:\foo\bar.txt, .\foo\bar.txt, \foo\bar.txt xboxFilename The converted XBOX filename
int XCreateFile(   int *handle,   char *filename,   unsigned int desiredAccess,   unsigned int sharedMode,   unsigned int creationDisposition,   unsigned int flagsAndAttributes )	Opens a file. Note that the title of the function is slightly misleading in that this function may not actually create a file... it may just open an existing one (depending on the combination of the various parameters. For more information on the combinations of the various parameters, see the Microsoft CreateFile documentation. Parameter Description handle The handle to the opened file filename The file to open. Examples of supported filenames are: c:/blah.txt, blah.txt, d:\default.txt desiredAccess Bitwise OR of one or more of the following options: DELETE SYNCHRONIZE GENERIC_ALL GENERIC_EXECUTE GENERIC_WRITE GENERIC_READ sharedMode Bitwise OR of one or more of the following options: FILE_SHARE_READ FILE_SHARE_WRITE FILE_SHARE_DELETE creationDisposition Bitwise OR of one or more of the following options: CREATE_NEW CREATE_ALWAYS OPEN_EXISTING OPEN_ALWAYS TRUNCATE_EXISTING flagsAndAttributes Bitwise OR of one or more of the following options (normally, you would just use FILE_ATTRIBUTE_NORMAL): FILE_FLAG_OPEN_NO_RECALL FILE_FLAG_OPEN_REPARSE_POINT FILE_FLAG_POSIX_SEMANTICS FILE_FLAG_BACKUP_SEMANTICS FILE_FLAG_DELETE_ON_CLOSE FILE_FLAG_SEQUENTIAL_SCAN FILE_FLAG_RANDOM_ACCESS FILE_FLAG_NO_BUFFERING FILE_FLAG_OVERLAPPED FILE_FLAG_WRITE_THROUGH FILE_ATTRIBUTE_READONLY FILE_ATTRIBUTE_HIDDEN FILE_ATTRIBUTE_SYSTEM FILE_ATTRIBUTE_DIRECTORY FILE_ATTRIBUTE_ARCHIVE FILE_ATTRIBUTE_DEVICE FILE_ATTRIBUTE_NORMAL FILE_ATTRIBUTE_TEMPORARY FILE_ATTRIBUTE_SPARSE_FILE FILE_ATTRIBUTE_REPARSE_POINT FILE_ATTRIBUTE_COMPRESSED FILE_ATTRIBUTE_OFFLINE FILE_ATTRIBUTE_NOT_CONTENT_INDEXED FILE_ATTRIBUTE_ENCRYPTED FILE_ATTRIBUTE_VALID_FLAGS FILE_ATTRIBUTE_VALID_SET_FLAGS
int XReadFile(   int handle,   void *buffer,   unsigned int numberOfBytesToRead,   unsigned int *numberOfBytesRead )	Reads data from an already opened file. Parameter Description handle The handle to the opened file buffer The char buffer to put the data into numberOfBytesToRead How many bytes to read numberOfBytesRead How many bytes were actually read from the file
int XWriteFile(   int handle,   void *buffer,   unsigned int numberOfBytesToWrite,   unsigned int *numberOfBytesWritten )	Writes data to an already opened file. Parameter Description handle The handle to the opened file buffer The char buffer to get the data from numberOfBytesToWrite How many bytes to write numberOfBytesWritten How many bytes were actually written to the file
int XCloseHandle(   int handle )	Seems fairly obvious doesn't it? Closes the file. Parameter Description handle The handle to the opened file
int XGetFileSize(   int handle,   unsigned int *filesize )	Queries the file size of a given file. Parameter Description handle The handle to the opened file filesize This variable is updated with the file's size
int XSetFilePointer(   int handle,   int distanceToMove,   int *newFilePointer,   int moveMethod )	Seeks to a location within an open file. Parameter Description handle The handle to the opened file distanceToMove The distance to seek (can be negative). newFilePointer Updated with the new absolute offset within the file moveMethod One of the following options: FILE_BEGIN FILE_CURRENT FILE_END
int XRenameFile(   char *oldFilename,   char *newFilename )	Renames a file Parameter Description oldFilename The file to rename newFilename The new file name
int XCreateDirectory(   char *directoryName )	Create a new directory Parameter Description directoryName The directory name
int XDeleteFile(   char *filename )	Deletes a file. Parameter Description filename The name of the file to delete
int XDeleteDirectory(   char *directoryName )	Deletes a directory Parameter Description directoryName The name of the directory to delete
int XMountDrive(   char driveLetter,   char *directoryName )	Assigns the given drive letter to the directoryName. Parameter Description driveLetter The drive letter to assign. For example, 'd' directoryName The directory that will be referred to as driveLetter from now on (until next reboot). It should contain a trailing slash, but if you forget, one will be added for you.
unsigned int XFindFirstFile(   char *directoryName,   char *mask,   PXBOX_FIND_DATA findFileData )	Performs a very similar function to the Win32 FindFirstFile, in that it populates (for the first file within the directoryName directory) the findFileData data structure. Returns ERROR_INVALID_HANDLE if the directory is unable to be opened or is invalid, otherwise a valid file handle for the directory (which you should pass to XFindNextFile to get the next file in the list). The elements of the data structure are: typedef struct _XBOX_FIND_DATA {   unsigned int dwFileAttributes;   long long ftCreationTime;   long long ftLastAccessTime;   long long ftLastWriteTime;   unsigned int nFileSize;   char cFileName[0x100]; } XBOX_FIND_DATA, *PXBOX_FIND_DATA; Parameter Description directoryName The directory that contains the file you care about mask A mask for the files you want. For example, "*.xbe" for all XBE files or "*" for all files fileFileData The data structure that will be populated with the file details (name, size, etc)
int XFindNextFile(   unsigned int handle,   PXBOX_FIND_DATA findFileData )	Gets the next file from the directory that was opened using XFindFirstFile. Returns ERROR_NO_MORE_FILES if there are no more files, 0 otherwise. Parameter Description handle The handle that was returned from XFindFirstFile fileFileData The data structure that will be populated with the file details (name, size, etc)
int XFindClose(   unsigned int handle )	Closes the handle that was opened when calling XFindFirstFile Parameter Description handle The handle that was returned from XFindFirstFile

Controllers

typedef struct
{
  char reserved1;
  unsigned char structsize;

  char pad;       /* 1=up 2=down 4=left 8=right + bitwise OR combos */
  char reserved2;
  char keys[6];   /* A B X Y Black White */

  unsigned char trig_left;
  unsigned char trig_right;
  short stick_left_x;
  short stick_left_y;
  short stick_right_x;
  short stick_right_y;

  char padding[0x40];
} XPadState;

Function	Description
void XInitInput(   XUSBControl *xcontrol )	Initialises the XBOX controller USB subsystem. This function must be called before calling any of the other controller functions. Parameter Description xcontrol A pointer to a control structure that will be initialised. This control structure will be used in subsequent calls.
void XGetPadInput(   XPadState *padState,   XUSBControl *xcontrol,   int padNumber )	Reads the current state of the XBOX controllers Parameter Description padState A pointer to a XPadState structure that will contain the current state xcontrol The pointer to the control structure padNumber Which pad number are you querying?
void XSetPadInput(   XPadState *padState,   XUSBControl *xcontrol,   int padNumber )	Updates the current state of the XBOX controllers (sends a message). This function is a bit dodgy at the moment... use at your own risk! Parameter Description padState A pointer to a XPadState structure xcontrol The pointer to the control structure padNumber Which pad number are you updating?
void XReleaseInput(   XUSBControl *xcontrol )	Shuts down the XBOX controller subsystem. If you call this, you will need to call XInitInput again before you can interact with the controllers. Parameter Description xcontrol The pointer to the control structure

Video

Audio

However, it is not much good playing unless you have given it some data to play. To give data to the audio subsystem, you need to call XAudioProvideSamples(). There are two supported ways of calling this method:

1. Your application code can call XAudioProvideSamples() based on its own timing. It is your code's responsibility to make sure you are calling this function often enough.
2. You can register a callback when you initialise and the audio subsystem will invoke your callback function when it needs more data. This callback function provides the data using a call to XAudioProvideSamples().