aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorHans de Goede <hdegoede@redhat.com>2010-02-26 16:06:40 +0100
committerHans de Goede <hdegoede@redhat.com>2010-02-26 16:06:40 +0100
commit5c0683ae428128656b963beda7b44d1b3af39cc7 (patch)
tree72ffc7bd2dee0fb3b19379fac05e5a9a5ce069b7
parent2ade2c7612d656093d56eecb2d7a8536bec6ac25 (diff)
Update docs for the new v4l-utils as a separate project situation
Signed-off-by: Hans de Goede <hdegoede@redhat.com>
-rw-r--r--COPYING15
-rw-r--r--ChangeLog11
-rw-r--r--INSTALL30
-rw-r--r--KNOWN_ISSUES17
-rw-r--r--README64
-rw-r--r--TODO7
-rw-r--r--contrib/cx25821/audioplayback (renamed from utils/cx25821/audioplayback)0
-rw-r--r--contrib/cx25821/audiorecord (renamed from utils/cx25821/audiorecord)0
-rw-r--r--contrib/cx25821/cx25821-medusa-decoder.c (renamed from utils/cx25821/cx25821-medusa-decoder.c)0
-rw-r--r--contrib/cx25821/medusaReadWrite.c (renamed from utils/cx25821/medusaReadWrite.c)0
-rw-r--r--contrib/cx25821/mencode_av (renamed from utils/cx25821/mencode_av)0
-rw-r--r--contrib/cx25821/mencode_video (renamed from utils/cx25821/mencode_video)0
-rw-r--r--contrib/cx25821/mplay_av (renamed from utils/cx25821/mplay_av)0
-rw-r--r--contrib/cx25821/mplay_cifNTSC (renamed from utils/cx25821/mplay_cifNTSC)0
-rw-r--r--contrib/cx25821/mplay_cifPAL (renamed from utils/cx25821/mplay_cifPAL)0
-rw-r--r--contrib/cx25821/mplay_video (renamed from utils/cx25821/mplay_video)0
-rw-r--r--contrib/cx25821/regReadWrite.c (renamed from utils/cx25821/regReadWrite.c)0
-rw-r--r--contrib/cx25821/setAlsaVolume (renamed from utils/cx25821/setAlsaVolume)0
-rw-r--r--contrib/cx25821/setvideosetting.c (renamed from utils/cx25821/setvideosetting.c)0
-rw-r--r--contrib/cx25821/upstream_app.c (renamed from utils/cx25821/upstream_app.c)0
-rwxr-xr-xcontrib/em28xx/parse_em28xx.pl (renamed from utils/em28xx/parse_em28xx.pl)0
-rw-r--r--contrib/em28xx/rewrite_eeprom.pl (renamed from utils/em28xx/rewrite_eeprom.pl)0
22 files changed, 98 insertions, 46 deletions
diff --git a/COPYING b/COPYING
index 21ae0cda..3c94e7c4 100644
--- a/COPYING
+++ b/COPYING
@@ -1,19 +1,4 @@
- NOTE! This copyright does *not* cover user programs that use kernel
- services by normal system calls - this is merely considered normal use
- of the kernel, and does *not* fall under the heading of "derived work".
- Also note that the GPL below is copyrighted by the Free Software
- Foundation, but the instance of code that it refers to (the Linux
- kernel) is copyrighted by me and others who actually wrote it.
-
- Also note that the only valid version of the GPL as far as the kernel
- is concerned is _this_ particular version of the license (ie v2, not
- v2.2 or v3.x or whatever), unless explicitly otherwise stated.
-
- Linus Torvalds
-
-----------------------------------------
-
GNU GENERAL PUBLIC LICENSE
Version 2, June 1991
diff --git a/ChangeLog b/ChangeLog
index 4d7e5ad0..5fa93b05 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,14 @@
+v4l-utils-0.7.90
+----------------
+* This is the first release of v4l-utils, v4l-utils is the combination
+ of various v4l and dvb utilities which used to be part of v4l-dvb
+ mercurial kernel tree and libv4l.
+* This first version is 0.7.90, as the version numbers continue were libv4l
+ as a standalone source archive stops.
+
+Note all history below this line only applies to libv4l and not to the utils
+----------------------------------------------------------------------------
+
libv4l-0.6.5
------------
* Add more laptop models to the upside down devices table
diff --git a/INSTALL b/INSTALL
index 0645a076..25a10e8b 100644
--- a/INSTALL
+++ b/INSTALL
@@ -1,12 +1,30 @@
+Requirements:
+-------------
+* make and a c and c++ compiler
+* optionally qt3 ot qt4 for building qv4l2
+* optionally libsysfs for building v4l2-sysfs-path
+
+
Building:
+---------
+
+Before building decide under which PREFIX you wish to install
+(the default is /usr/local), and if you want the libraries to be installed
+under a different directory then $PREFIX/lib for example $PREFIX/lib64.
+
+To build execute "make" specifying the desired installation prefix
+and (optionally) the desired libdir, for example:
+make PREFIX=/usr LIBDIR=/usr/lib64
-simply type
-$ make
Installing:
+-----------
-$ make install
-installs libraries and utils to /usr/[bin,include,lib]
+To install do "make install", and again specify the desired PREFIX and
+LIBDIR, note that it is important to specify the same PREFIX and LIBDIR
+as used when building, for example:
+make install PREFIX=/usr LIBDIR=/usr/lib64
-$ make install prefix=<path>
-installs libraries and utils to <path>/[bin,include,lib]
+Note that v4l-utils' "make install" supports DESTDIR for installing into
+a build root for example:
+make install PREFIX=/usr LIBDIR=/usr/lib64 DESTDIR=/mnt/sysimage
diff --git a/KNOWN_ISSUES b/KNOWN_ISSUES
deleted file mode 100644
index ea45c783..00000000
--- a/KNOWN_ISSUES
+++ /dev/null
@@ -1,17 +0,0 @@
-There are some known issues when compiling the V4L2 Applications.
-
- - It doesn't check/warn if you don't have all the dependencies:
- qv4l2 requires qt3 development packages;
- v4l2-sysfs-path requires libsysfs development packages;
-
- - qv4l2 doesn't compile with qt4 libraries;
-
- - make only works fine if called first from /v4l2-apps, since
- several subdirs require that /v4l2-apps/include to be created,
- and only the main Makefile forces its creation before building
- the other files;
-
- - libv4l doesn't use the in-tree videodev2.h. So, in order to
- compile, it needs to be installed at /usr/include/linux.
-
-Patches are welcome to improve the building system.
diff --git a/README b/README
index d8af644d..6052896a 100644
--- a/README
+++ b/README
@@ -1,14 +1,62 @@
-linuxtv-v4l2-apps-0.0.1
-=======================
+v4l-utils
+---------
-Linux V4L2 API test/demo applications, utilities and library.
+Linux V4L2 and DVB API utilities and v4l libraries (libv4l).
-You find a README in each subdirectory explaining what the code there does.
-The v4l2 library uses the GNU Lesser General Public License, all other code is
+v4l libraries (libv4l)
+----------------------
+
+See README.lib for more information on libv4l, libv4l is released
+under the GNU Lesser General Public License.
+
+
+v4l-utils
+---------
+The (for now for v4l-utils private use only) libv4l2util library is
+released under the GNU Lesser General Public License, all other code is
released under the GNU General Public License.
-This code is still in its infancy and is not yet suitable for general
-use. However, it is a start.
+v4l-utils includes the following utilities:
+
+decode_tm6000:
+Decodes tm6000 proprietary format streams.
+Installed by make install under <prefix>/bin.
+
+v4l-keytable:
+Dump, Load or Modify ir receiver input tables.
+The ir tables for remotes which are known by the kernel
+(and loaded by default depending on dvb card type) can be found
+under utils/keytable/keycodes.
+v4l-keytable does not get installed by make install.
+
+qv4l2:
+QT v4l2 control panel application.
+Installed by make install under <prefix>/bin.
+
+rds-saa6588:
+Poll i2c RDS receiver [Philips saa6588].
+rds-saa6588 does not get installed by make install.
+
+v4l2-compliance:
+Tool to test v4l2 API compliance of drivers.
+Installed by make install under <prefix>/bin.
+
+v4l2-ctl:
+Tool to control v4l2 controls from the cmdline.
+Installed by make install under <prefix>/bin.
+
+v4l2-dbg:
+Tool to directly get and set registers of v4l2 devices,
+this requires a kernel >= 2.6.29 with the ADV_DEBUG option
+enabled. This tool can only be used by root and is meant
+for development purposes only!
+Installed by make install under <prefix>/sbin.
+
+v4l2-sysfs-path:
+FIXME add description.
+Installed by make install under <prefix>/bin.
-Hans Verkuil <hverkuil@xs4all.nl>
+xc3028-firmware:
+Xceive XC2028/3028 tuner module firmware manipulation tool.
+xc3028-firmware does not get installed by make install.
diff --git a/TODO b/TODO
index 8f774433..20de6bf3 100644
--- a/TODO
+++ b/TODO
@@ -1,3 +1,6 @@
+libv4l todo:
+------------
+
-add support for setting / getting the number of read buffers
-add code to v4l2_read to not return frames more then say 5 seconds old
@@ -13,3 +16,7 @@
frames
-get standardized CID for AUTOGAIN_TARGET upstream and switch to that
+
+
+utils todo:
+-----------
diff --git a/utils/cx25821/audioplayback b/contrib/cx25821/audioplayback
index 1b09da91..1b09da91 100644
--- a/utils/cx25821/audioplayback
+++ b/contrib/cx25821/audioplayback
diff --git a/utils/cx25821/audiorecord b/contrib/cx25821/audiorecord
index ee2c4665..ee2c4665 100644
--- a/utils/cx25821/audiorecord
+++ b/contrib/cx25821/audiorecord
diff --git a/utils/cx25821/cx25821-medusa-decoder.c b/contrib/cx25821/cx25821-medusa-decoder.c
index 7bd35ed4..7bd35ed4 100644
--- a/utils/cx25821/cx25821-medusa-decoder.c
+++ b/contrib/cx25821/cx25821-medusa-decoder.c
diff --git a/utils/cx25821/medusaReadWrite.c b/contrib/cx25821/medusaReadWrite.c
index cf4a1a5e..cf4a1a5e 100644
--- a/utils/cx25821/medusaReadWrite.c
+++ b/contrib/cx25821/medusaReadWrite.c
diff --git a/utils/cx25821/mencode_av b/contrib/cx25821/mencode_av
index 6533cb4d..6533cb4d 100644
--- a/utils/cx25821/mencode_av
+++ b/contrib/cx25821/mencode_av
diff --git a/utils/cx25821/mencode_video b/contrib/cx25821/mencode_video
index 9f0c29eb..9f0c29eb 100644
--- a/utils/cx25821/mencode_video
+++ b/contrib/cx25821/mencode_video
diff --git a/utils/cx25821/mplay_av b/contrib/cx25821/mplay_av
index 0b11e7af..0b11e7af 100644
--- a/utils/cx25821/mplay_av
+++ b/contrib/cx25821/mplay_av
diff --git a/utils/cx25821/mplay_cifNTSC b/contrib/cx25821/mplay_cifNTSC
index ba3c34ec..ba3c34ec 100644
--- a/utils/cx25821/mplay_cifNTSC
+++ b/contrib/cx25821/mplay_cifNTSC
diff --git a/utils/cx25821/mplay_cifPAL b/contrib/cx25821/mplay_cifPAL
index 2139ffb0..2139ffb0 100644
--- a/utils/cx25821/mplay_cifPAL
+++ b/contrib/cx25821/mplay_cifPAL
diff --git a/utils/cx25821/mplay_video b/contrib/cx25821/mplay_video
index 7d956766..7d956766 100644
--- a/utils/cx25821/mplay_video
+++ b/contrib/cx25821/mplay_video
diff --git a/utils/cx25821/regReadWrite.c b/contrib/cx25821/regReadWrite.c
index 2d506183..2d506183 100644
--- a/utils/cx25821/regReadWrite.c
+++ b/contrib/cx25821/regReadWrite.c
diff --git a/utils/cx25821/setAlsaVolume b/contrib/cx25821/setAlsaVolume
index 55dd3dc8..55dd3dc8 100644
--- a/utils/cx25821/setAlsaVolume
+++ b/contrib/cx25821/setAlsaVolume
diff --git a/utils/cx25821/setvideosetting.c b/contrib/cx25821/setvideosetting.c
index 87e36045..87e36045 100644
--- a/utils/cx25821/setvideosetting.c
+++ b/contrib/cx25821/setvideosetting.c
diff --git a/utils/cx25821/upstream_app.c b/contrib/cx25821/upstream_app.c
index 97f7b84a..97f7b84a 100644
--- a/utils/cx25821/upstream_app.c
+++ b/contrib/cx25821/upstream_app.c
diff --git a/utils/em28xx/parse_em28xx.pl b/contrib/em28xx/parse_em28xx.pl
index 05e12dbe..05e12dbe 100755
--- a/utils/em28xx/parse_em28xx.pl
+++ b/contrib/em28xx/parse_em28xx.pl
diff --git a/utils/em28xx/rewrite_eeprom.pl b/contrib/em28xx/rewrite_eeprom.pl
index 495c4717..495c4717 100644
--- a/utils/em28xx/rewrite_eeprom.pl
+++ b/contrib/em28xx/rewrite_eeprom.pl

Privacy Policy