blob: 514ce370e91384890bd7cc7cb913e8969c9e0e41
| 1 | |
| 2 | libzvbi - VBI capture and decoding library |
| 3 | |
| 4 | Copyright (C) 2000-2008 Michael H. Schimek |
| 5 | Copyright (C) 2000, 2001 Iñaki García Etxebarria |
| 6 | Copyright (C) 2003, 2004, 2007 Tom Zoerner |
| 7 | |
| 8 | Originally based on AleVT 1.5.1 by Edgar Toernig |
| 9 | |
| 10 | This library is free software; you can redistribute it and/or |
| 11 | modify it under the terms of the GNU Library General Public |
| 12 | License as published by the Free Software Foundation; either |
| 13 | version 2 of the License, or (at your option) any later version. |
| 14 | |
| 15 | This library is distributed in the hope that it will be useful, |
| 16 | but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 17 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 18 | file COPYING.LIB for more details. |
| 19 | |
| 20 | Software in this package which is not part of the library, |
| 21 | including code generators, programs in the test and contrib |
| 22 | directories, and the VBI proxy daemon, are licensed under the |
| 23 | terms of the GNU General Public License as published by the |
| 24 | Free Software Foundation; either version 2 of the License, or |
| 25 | (at your option) any later version. See the file COPYING |
| 26 | for more details. |
| 27 | |
| 28 | Programs in the examples directory are licensed under a 2-clause |
| 29 | BSD-style license. See the respective source files for details. |
| 30 | |
| 31 | -------------------------------------------------------------------------- |
| 32 | |
| 33 | Introduction |
| 34 | ============ |
| 35 | |
| 36 | The vertical blanking interval (VBI) is an interval in an analog |
| 37 | television signal that temporarily suspends transmission of the |
| 38 | signal for the electron gun to move back up to the first line of the |
| 39 | television screen to trace the next screen field. The vertical |
| 40 | blanking interval can be used to carry data, since anything sent |
| 41 | during the VBI would naturally not be displayed; various test |
| 42 | signals, closed captioning, and other digital data can be sent |
| 43 | during this time period. |
| 44 | |
| 45 | The ZVBI library provides functions to read from Linux V4L, V4L2 and |
| 46 | FreeBSD BKTR raw VBI capture devices, from Linux DVB devices and |
| 47 | from a VBI proxy to share V4L and V4L2 VBI devices between multiple |
| 48 | applications. |
| 49 | |
| 50 | It can demodulate raw to sliced VBI data in software, with support |
| 51 | for a wide range of formats, has functions to decode several popular |
| 52 | services including Teletext and Closed Caption, a Teletext cache |
| 53 | with search function, various text export and rendering functions. |
| 54 | |
| 55 | Basically ZVBI offers all functions needed by VBI applications |
| 56 | except for the user interface. The library was written for the |
| 57 | Zapping TV viewer http://zapping.sourceforge.net. |
| 58 | |
| 59 | For details on using the library see the documentation in doc/html |
| 60 | (built only if you have Doxygen http://www.doxygen.org/ installed) |
| 61 | and the files in the test and examples directories. |
| 62 | |
| 63 | |
| 64 | Bindings |
| 65 | ======== |
| 66 | |
| 67 | Tom Zoerner wrote a Perl interface to libzvbi. The ZVBI Perl module |
| 68 | covers all exported libzvbi functions. Most of the functions and |
| 69 | parameters are exposed nearly identical, or with minor adaptions for |
| 70 | the Perl idiom. |
| 71 | |
| 72 | Find out more at http://search.cpan.org/~TOMZO/Video-ZVBI |
| 73 | |
| 74 | |
| 75 | Download |
| 76 | ======== |
| 77 | |
| 78 | The latest version is available from http://zapping.sourceforge.net |
| 79 | as a tarball and publicly readable CVS. |
| 80 | |
| 81 | Christian Marillat maintains a Debian package: |
| 82 | http://packages.debian.org/source/zvbi |
| 83 | |
| 84 | Oliver Lehmann maintains a FreeBSD port: |
| 85 | http://www.freebsd.org/cgi/ports.cgi?query=libzvbi |
| 86 | |
| 87 | For RPMs please see the repository of your distribution. |
| 88 | |
| 89 | Sourceforge and Freshmeat can notify you about new releases by e-mail: |
| 90 | http://sourceforge.net/project/filemodule_monitor.php?filemodule_id=41356 |
| 91 | http://freshmeat.net/subscribe/?url=%2Fprojects%2Flibzvbi%2F |
| 92 | |
| 93 | |
| 94 | Installation |
| 95 | ============ |
| 96 | |
| 97 | If you checked out the sources from CVS, run "./autogen.sh" to create |
| 98 | missing configuration and make files. |
| 99 | |
| 100 | To build and install type "./configure", "make", "make check" if you |
| 101 | want to run some tests, and "make install". |
| 102 | |
| 103 | For additional instructions see the INSTALL file. |
| 104 | |
| 105 | The library has been tested on Linux and FreeBSD. |
| 106 | |
| 107 | |
| 108 | Questions, comments, concerns, complaints, irritations, aggravations, |
| 109 | insinuations, allegations, accusations, contemplations, consternations |
| 110 | ====================================================================== |
| 111 | |
| 112 | * You can post patches, feature requests and bug reports at |
| 113 | our Sourceforge tracker: |
| 114 | https://sourceforge.net/tracker/?group_id=2599 |
| 115 | |
| 116 | Please log in or leave an e-mail address for further inquiries and |
| 117 | progress notification. |
| 118 | |
| 119 | * Or you can send a message to the Zapping mailing list: |
| 120 | zapping-misc@lists.sourceforge.net |
| 121 | |
| 122 | You can subscribe or unsubscribe at: |
| 123 | http://lists.sourceforge.net/lists/listinfo/zapping-misc |
| 124 | |
| 125 | Subscription is not required, but non-member messages may be |
| 126 | delayed for spam filtering. This is a low volume list. |
| 127 | |
| 128 | You can browse the list archives at: |
| 129 | http://sourceforge.net/mailarchive/forum.php?forum_name=zapping-misc |
| 130 | |
| 131 | * Or you can try our IRC channel: |
| 132 | #zapping at irc.freenode.net |
| 133 | |
| 134 | Primary author and maintainer of this library is |
| 135 | |
| 136 | Michael H. Schimek <mschimek@users.sourceforge.net> |
| 137 | |
| 138 | Encrypted e-mail is welcome. You can find my PGP/GPG key in the |
| 139 | AUTHORS file, e.g. type "gpg --import <AUTHORS". Ich spreche deutsch. |
| 140 |