Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 116 lines (93 sloc) 4.414 kb
5881dcb umläute updated README
authored
1 v4l2loopback - a kernel module to create V4L2 loopback devices
2 ==============================================================
3
4 this module allows you to create "virtual video devices"
5 normal (v4l2) applications will read these devices as if they were ordinary
6 video devices, but the video will not be read from e.g. a capture card but
7 instead it is generated by another application.
8 this allows you for instance to apply apply some nifty video effects on your
cf0cb48 umläute added ChangeLog and NEWS
authored
9 Skype video...
10 it also allows some more serious things (e.g. I've been using it to add
11 streaming capabilities to an application by the means of hooking GStreamer into
12 the loopback devices).
5881dcb umläute updated README
authored
13
cf0cb48 umläute added ChangeLog and NEWS
authored
14 --- NEWS ---
15 to get the main features of each new release, see the NEWS file.
16 you could also have a look at the ChangeLog (which gets automatically generated and might
17 only be of limited use...
5881dcb umläute updated README
authored
18
cca7a41 umläute Bumped to 0.4.1
authored
19
20 --- ISSUES ---
21 for current issues, checkout https://github.com/umlaeute/v4l2loopback/issues
22 please use the issue-tracker for reporting any problems
23
5881dcb umläute updated README
authored
24 --- BUILD ---
25 to build the kernel module run "make".
26 this should give you a file named "v4l2loopback.ko", which is the kernel module
27
01a209f initial
gorinich.zmey authored
28 --- INSTALL ---
916a459 umläute README, COPYING, AUTHORS
authored
29 to install the module run "make install" (you might have to be 'root' to have
cf0cb48 umläute added ChangeLog and NEWS
authored
30 all necessary permissions to install the module).
916a459 umläute README, COPYING, AUTHORS
authored
31
32 if your system has "sudo", do:
33 $ make && sudo make install
34
35 if your system lacks "sudo", do:
36 $ make
37 $ su
38 (enter root password)
39 # make install
40 # exit
01a209f initial
gorinich.zmey authored
41
42 --- RUN ---
916a459 umläute README, COPYING, AUTHORS
authored
43 Load the v4l2loopback module as root :
44 # modprobe v4l2loopback
45
46 using sudo use:
47 $ sudo modprobe v4l2loopback
48
49 this will create an additional video-device, e.g. /dev/video0 (the number
50 depends on whether you already had video devices on your system), which can be
51 fed by various programs.
52 tested feeders:
cf0cb48 umläute added ChangeLog and NEWS
authored
53 GStreamer: using the "v4l2sink" element
916a459 umläute README, COPYING, AUTHORS
authored
54 Gem(>=0.93) using the "recordV4L2" plugin
55 in theory most programs capable of _writing to_ a v4l2 device should work
56
57 the data sent to the v4l2loopback device can then be read by any v4l2-capable
58 application
59
60 --- OPTIONS ---
61 if you need several independent loopback devices, you can pass the "devices"
62 option, when loading the module; e.g.
63 # modprobe v4l2loopback devices=4
64 will give you 4 loopback devices (e.g. /dev/video1 ... /dev/video5)
65
66 --- KERNELs ---
67 the original module has been developed for linux-2.6.28;
2bf8dbe umläute added notes about supported kernel versions
authored
68 i don't have a system with such an old kernel anymore, so i don't know whether
69 it still works.
70 further development has been done mainly on linux-2.6.32 and linux-2.6.35, with
71 newer kernels being continually tested as they enter debian.
72 support:
73 <= 2.6.27 definitely will NOT work
74 2.6.28 - 2.6.31 may work (seems to compile but i cannot test)
75 >= 2.6.32 should work
76 >= 3.0.0 should work as well
916a459 umläute README, COPYING, AUTHORS
authored
77
520ae2d umläute updated README to mention Debian packages
authored
78 --- DISTRIBUTIONS ---
79 v4l2loopack is now (2010-10-13) available as a Debian-package.
80 This means, that it is also part of Debian-derived distributions, including
81 Ubuntu (starting with natty).
2bf8dbe umläute added notes about supported kernel versions
authored
82 The most convenient way is to install the package "v4l2loopback-dkms".
83 This should automatically build and install the module for your current kernel
84 (provided you have the matching kernel-headers installed).
85 Another option is to install the "v4l2loopback-source" package.
86 In this case you should be able to simply do (as root):
520ae2d umläute updated README to mention Debian packages
authored
87 # aptitude install v4l2loopback-source module-assistant
88 # module-assistant auto-install v4l2loopback-source
89
5881dcb umläute updated README
authored
90 --- DOWNLOAD ---
cf0cb48 umläute added ChangeLog and NEWS
authored
91 the most up-to-date version of this module can be found at
5881dcb umläute updated README
authored
92 http://github.com/umlaeute/v4l2loopback/.
93 the original code for the v4l2loopback module can be found at
94 http://code.google.com/p/v4l2loopback/.
916a459 umläute README, COPYING, AUTHORS
authored
95
5881dcb umläute updated README
authored
96 --- LICENSE/COPYING ---
ae76204 umläute updated copyright
authored
97 Copyright (c) 2010-2011 IOhannes m zmoelnig <zmoelnig@iem.at>
916a459 umläute README, COPYING, AUTHORS
authored
98 Copyright (c) 2010 Scott Maines <smaines@alaya.com>
99 Copyright (c) 2009 Gorinich Zmey
ae76204 umläute updated copyright
authored
100 Copyright (c) 2005-2009 Vasily Levin
916a459 umläute README, COPYING, AUTHORS
authored
101
102 This package is free software; you can redistribute it and/or modify
103 it under the terms of the GNU General Public License as published by
c68bc6f umläute license issues: this module is GPLv2
authored
104 the Free Software Foundation; either version 2 of the License, or
916a459 umläute README, COPYING, AUTHORS
authored
105 (at your option) any later version.
106
107 This package is distributed in the hope that it will be useful,
108 but WITHOUT ANY WARRANTY; without even the implied warranty of
109 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
110 GNU General Public License for more details.
01a209f initial
gorinich.zmey authored
111
916a459 umläute README, COPYING, AUTHORS
authored
112 You should have received a copy of the GNU General Public License
ae76204 umläute updated copyright
authored
113 along with this program. If not, see <http://www.gnu.org/licenses/>.
2f38675 readme add
gorinich.zmey authored
114
5881dcb umläute updated README
authored
115
Something went wrong with that request. Please try again.