opn_interface

Header file containing the API for the libopn_driver library.
Includes: <CoreFoundation/CoreFoundation.h>

Version: EGFS0035 (0.0.3.5)

This API controls the OPN 2001 driver, a user-space driver in the form of a dynamically linked library. Note that this library must be loaded at load time, meaning it is a dependent library of any client code that uses it. You must include (and call the functions in) this header in your projects, and add the library to your projects, to use the library. The library's install location is "@executable_path/../ Frameworks" (although, the path may be changed with install_name_tool).

The libopn_driver library utilizes the Carbon Event Manager to signal client code of three possible events: 1) the OPN has been removed, 2) the OPN has been inserted, or 3) the OPN has data. The particulars of each event (its class and kind, which together, compose its type) can be accessed via API functions defined in this file. However, it is the responsibility of any client code utilizing this library to implement event handler functions, install these functions, and run the application event loop. Examples of how to do this are illustrated in the project "opn_test." More information about the Carbon Event Manager, and how to use it, can be found in the Apple Developer documentation. See the Carbon Event Manager Programming Guide for details.

Note that this library is dependent upon the Carbon, CoreFoundation, and IOKit frameworks. These are part of any normal OS X installation, and though it's probably impossible for OS X to run without them, it's noted here for completeness. This library should run on both x86 and PPC flavors of OS X.

This driver should only be used with OPN firmware version RBBV0120 and later.