Osprey Programming Interface (OPI)
Software Developers Kit
Release_Version 2.x


1.  Introduction

The Osprey Programming Interface (OPI) Software Developers Kit
consists of a programming manual, libraries, and include files
that allow developers to write software to access Osprey 
Video Capture devices.

OPI programs are OS independent. OPI versions exists for WinNT ( both
Intel x86 and Digital alpha processor) UNIX (Dec UNIX or Solaris), as
well as various application specific OS's such as PharLap's embedded
OS.  Additional platforms are being considered for future development.

OPI provides access to two classes of Osprey Video capture boards:
Osprey 1x00, and Osprey 1x0.  The Osprey 1x00 provides uncompressed
video and compressed video ( such as h261 ), as well as audio.  The
Osprey 1x0 only provides uncompressed video.

Programs can be written such that they are hardware independent also.
Various example programs, included in this SDK, will work with both
the Osprey video cards.  

There are currently two versions of OPI: native OPI which is based
on C++, and a OPI_C which provides a c interface.  Additional 
platforms, such as java, are being considered as well.

Further information is included in an manual document file located 
at /usr/opt/OSPDEV<version>/doc/opi/opi.doc, where version is the
version.

2.  Contents

This kit has the following items:

README.txt - This file

opidev.pdf - OPI developers toolkit formated using Adobe Acrobat.

OPI include files ( opi.h, opi_c.h ) - Defines the OPI API.

OPI examples:

   OPI_C - Example programs based on the c interface to opi:
      opic_capture - Captures video data and writes the file to disk. 

   OPI:
      playraw - playback recorded video from a disk file.
      rawdisplay - plays live video.
      loopback - plays live video.
      opi_vidrec - Captures video data and writes file to disk.
      opi_viddsp - Captures video data and displays to screen.
      opi_play -  Plays an catptured video file.
      opi_vidcapdsp - plays live video and records to disk
      cpanel - access board settings.

The development kit relies on the following kits:

   OSPOPI - provides access to OPI
   OSPO1C - provides access to the o1c OPI device
   OSPD1C - provides o1c board driver access
   OSPU1C - provides o1c board access

These kits should be included with the purchase of an Osprey video
card.

Instructions to install these kits is included in their README.


3.  Installation points

The kit is installed to /usr/opt/OSPDEV<version>.  Examples are
symlinked to /usr/examples/opi.  Includes are symlinked to /usr/include.
The opi.doc is symlinked to /usr/doc/opi/opi.doc.