ndicapi_serial.h

Go to the documentation of this file.

/*=======================================================================

  Program:   NDI Combined API C Interface Library
  Module:    $RCSfile: ndicapi_serial.h,v $
  Creator:   David Gobbi <dgobbi@atamai.com>
  Language:  C
  Author:    $Author: kcharbon $
  Date:      $Date: 2008/06/18 15:33:20 $
  Version:   $Revision: 1.6 $

==========================================================================

Copyright (c) 2000-2005 Atamai, Inc.

Use, modification and redistribution of the software, in source or
binary forms, are permitted provided that the following terms and
conditions are met:

1) Redistribution of the source code, in verbatim or modified
   form, must retain the above copyright notice, this license,
   the following disclaimer, and any notices that refer to this
   license and/or the following disclaimer.  

2) Redistribution in binary form must include the above copyright
   notice, a copy of this license and the following disclaimer
   in the documentation or with other materials provided with the
   distribution.

3) Modified copies of the source code must be clearly marked as such,
   and must not be misrepresented as verbatim copies of the source code.

THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS"
WITHOUT EXPRESSED OR IMPLIED WARRANTY INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE.  IN NO EVENT SHALL ANY COPYRIGHT HOLDER OR OTHER PARTY WHO MAY
MODIFY AND/OR REDISTRIBUTE THE SOFTWARE UNDER THE TERMS OF THIS LICENSE
BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, LOSS OF DATA OR DATA BECOMING INACCURATE
OR LOSS OF PROFIT OR BUSINESS INTERRUPTION) ARISING IN ANY WAY OUT OF
THE USE OR INABILITY TO USE THE SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGES.

=======================================================================*/

#ifndef NDICAPI_SERIAL_H
#define NDICAPI_SERIAL_H 1

#ifdef __cplusplus
extern "C" {
#endif

/*=====================================================================*/
#ifdef _WIN32

#include <windows.h>
typedef HANDLE NDIFileHandle;
#define NDI_INVALID_HANDLE INVALID_HANDLE_VALUE

#elif defined(unix) || defined(__unix__) || defined(__APPLE__)

typedef int NDIFileHandle;
#define NDI_INVALID_HANDLE -1

#if defined(linux) || defined(__linux__)
#define NDI_NUMBER_OF_DEVICES 7
#define NDI_DEVICE0    "/dev/ttyS0"
#define NDI_DEVICE1    "/dev/ttyS1"
#define NDI_DEVICE2    "/dev/ttyUSB0"
#define NDI_DEVICE3    "/dev/ttyUSB1"
#define NDI_DEVICE4    "/dev/ttyUSB2"
#define NDI_DEVICE5    "/dev/ttyUSB3"
#define NDI_DEVICE6     "/dev/ttyUSB4"
#define NDI_DEVICE7    "/dev/ttyUSB5"

#elif defined(__APPLE__)
#define NDI_NUMBER_OF_DEVICES 0
#elif defined(sgi)
#define NDI_NUMBER_OF_DEVICES 4
#define NDI_DEVICE0    "/dev/ttyd1"
#define NDI_DEVICE1    "/dev/ttyd2"
#define NDI_DEVICE2    "/dev/ttyd3"
#define NDI_DEVICE3    "/dev/ttyd4"
#define NDI_DEVICE4    "/dev/ttyd5"
#define NDI_DEVICE5    "/dev/ttyd6"
#define NDI_DEVICE6    "/dev/ttyd7"
#define NDI_DEVICE7    "/dev/ttyd8"
#else
#define NDI_NUMBER_OF_DEVICES 2
#define NDI_DEVICE0    "/dev/ttya"
#define NDI_DEVICE1    "/dev/ttyb"
#endif

#elif defined(macintosh)

typedef long NDIFileHandle;
#define NDI_INVALID_HANDLE -1
/* macros to extract input and output file handles */
#define output_file(serial_port) ((short)((serial_port & 0xff00) >> 16));
#define input_file(serial_port) ((short)((serial_port & 0x00ff) >> 0));

#define NDI_NUMBER_OF_DEVICES 2
#define NDI_DEVICE0    "\p.A"
#define NDI_DEVICE1    "\p.B"

#endif

NDIFileHandle ndiSerialOpen(const char *device);

void ndiSerialClose(NDIFileHandle serial_port);

int ndiSerialCheckDSR(NDIFileHandle serial_port);

int ndiSerialBreak(NDIFileHandle serial_port);

int ndiSerialFlush(NDIFileHandle serial_port, int flushtype);

#define  NDI_IFLUSH  0x1
#define  NDI_OFLUSH  0x2
#define  NDI_IOFLUSH 0x3

int ndiSerialComm(NDIFileHandle serial_port, int baud, const char *mode,
                  int handshake);

int ndiSerialTimeout(NDIFileHandle serial_port, int milliseconds);

int ndiSerialWrite(NDIFileHandle serial_port, const char *text, int n);

int ndiSerialRead(NDIFileHandle serial_port, char *reply, int n);

int ndiSerialSleep(NDIFileHandle serial_port, int milliseconds);

#ifdef __cplusplus
}
#endif

#endif /* NDICAPI_SERIAL_H */