Blame README

Packit 0bbbb1
libiec61883 README
Packit 0bbbb1
Copyright (C) 2004-2005 Kristian Hogsberg, Dan Dennedy, and Dan Maas.
Packit 0bbbb1
http://www.linux1394.org/
Packit 0bbbb1
Packit 0bbbb1
Overview
Packit 0bbbb1
--------
Packit 0bbbb1
This library is an implementation of IEC 61883, part 1 (CIP, plug registers,
Packit 0bbbb1
and CMP), part 2 (DV-SD), part 4 (MPEG2-TS), and part 6 (AMDTP). Outside of
Packit 0bbbb1
IIDC, nearly all FireWire multimedia devices use IEC 61883 protocols.
Packit 0bbbb1
Packit 0bbbb1
The libiec61883 library provides a higher level API for streaming DV,
Packit 0bbbb1
MPEG-2 and audio over Linux IEEE 1394. This includes both reception and
Packit 0bbbb1
transmission. It uses the new "rawiso" API of libraw1394, which transparently
Packit 0bbbb1
provides mmap-ed DMA for efficient data transfer. It also represents
Packit 0bbbb1
the third generation of I/O technology for Linux 1394 for these media types
Packit 0bbbb1
thereby removing the complexities of additional kernel modules, /dev nodes,
Packit 0bbbb1
and procfs. It also consolidates features for plug control registers and
Packit 0bbbb1
connection management that previously existed in experimental form in an
Packit 0bbbb1
unreleased version of libavc1394.
Packit 0bbbb1
Packit 0bbbb1
Packit 0bbbb1
Requirements
Packit 0bbbb1
------------
Packit 0bbbb1
Linux kernel 2.4.20 or newer
Packit 0bbbb1
libraw1394 1.2.0 or newer
Packit 0bbbb1
Packit 0bbbb1
Packit 0bbbb1
Documentation
Packit 0bbbb1
-------------
Packit 0bbbb1
Nearly everything is documented in the header file. The comments from the
Packit 0bbbb1
header can be extracted and formatted using the Linux kernel script, e.g.:
Packit 0bbbb1
Packit 0bbbb1
/usr/src/linux/scripts/kernel-doc -man src/iec61883.h | nroff -man | less
Packit 0bbbb1
Packit 0bbbb1
Packit 0bbbb1
Pkg-Config
Packit 0bbbb1
----------
Packit 0bbbb1
The library comes with a pkg-config .pc file, so you can check for
Packit 0bbbb1
libiec61883 and its version in your configure script. For example, here is how
Packit 0bbbb1
to use the autoconf macro:
Packit 0bbbb1
Packit 0bbbb1
PKG_CHECK_MODULES(LIBIEC61883, libiec61883 >= 1.0.0)
Packit 0bbbb1
Packit 0bbbb1
This macro sets the variables LIBIEC61883_CFLAGS and LIBIEC61883_LIBS. You
Packit 0bbbb1
have to include those into your build variables so that the build process
Packit 0bbbb1
correctly links with libraw1394.
Packit 0bbbb1
Packit 0bbbb1
Packit 0bbbb1
Maintainer
Packit 0bbbb1
----------
Packit 0bbbb1
Maintainer of libiec61883 is currently Dan Dennedy. Send suggestions, bug
Packit 0bbbb1
reports and fixes to linux1394-devel@lists.sourceforge.net. See the file
Packit 0bbbb1
AUTHORS for a complete list of contributors to libiec61883.
Packit 0bbbb1
Packit 0bbbb1
Visit http://www.linux1394.org/ for more information or to see what is new.