[media] doc-rst: add meye documentation

Convert the meye documentation to rst and add it to the
media/v4l-drivers book.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
This commit is contained in:
Mauro Carvalho Chehab 2016-07-17 18:20:51 -03:00
parent 2a744b0d7b
commit c90495fe1e
2 changed files with 57 additions and 47 deletions

View File

@ -27,4 +27,5 @@ License".
davinci-vpbe davinci-vpbe
fimc fimc
ivtv ivtv
meye
zr364xx zr364xx

View File

@ -1,8 +1,13 @@
Vaio Picturebook Motion Eye Camera Driver Readme .. include:: <isonum.txt>
------------------------------------------------
Copyright (C) 2001-2004 Stelian Pop <stelian@popies.net> Vaio Picturebook Motion Eye Camera Driver
Copyright (C) 2001-2002 Alcôve <www.alcove.com> =========================================
Copyright (C) 2000 Andrew Tridgell <tridge@samba.org>
Copyright |copy| 2001-2004 Stelian Pop <stelian@popies.net>
Copyright |copy| 2001-2002 Alcôve <www.alcove.com>
Copyright |copy| 2000 Andrew Tridgell <tridge@samba.org>
This driver enable the use of video4linux compatible applications with the This driver enable the use of video4linux compatible applications with the
Motion Eye camera. This driver requires the "Sony Laptop Extras" driver (which Motion Eye camera. This driver requires the "Sony Laptop Extras" driver (which
@ -15,8 +20,8 @@ Grabbing is supported in packed YUV colorspace only.
MJPEG hardware grabbing is supported via a private API (see below). MJPEG hardware grabbing is supported via a private API (see below).
Hardware supported: Hardware supported
------------------- ------------------
This driver supports the 'second' version of the MotionEye camera :) This driver supports the 'second' version of the MotionEye camera :)
@ -37,26 +42,30 @@ This camera is not supported at all by the current driver, in fact
little information if any is available for this camera little information if any is available for this camera
(USB vendor/device is 0x054c/0x0107). (USB vendor/device is 0x054c/0x0107).
Driver options: Driver options
--------------- --------------
Several options can be passed to the meye driver using the standard Several options can be passed to the meye driver using the standard
module argument syntax (<param>=<value> when passing the option to the module argument syntax (<param>=<value> when passing the option to the
module or meye.<param>=<value> on the kernel boot line when meye is module or meye.<param>=<value> on the kernel boot line when meye is
statically linked into the kernel). Those options are: statically linked into the kernel). Those options are:
.. code-block:: none
gbuffers: number of capture buffers, default is 2 (32 max) gbuffers: number of capture buffers, default is 2 (32 max)
gbufsize: size of each capture buffer, default is 614400 gbufsize: size of each capture buffer, default is 614400
video_nr: video device to register (0 = /dev/video0, etc) video_nr: video device to register (0 = /dev/video0, etc)
Module use: Module use
----------- ----------
In order to automatically load the meye module on use, you can put those lines In order to automatically load the meye module on use, you can put those lines
in your /etc/modprobe.d/meye.conf file: in your /etc/modprobe.d/meye.conf file:
.. code-block:: none
alias char-major-81 videodev alias char-major-81 videodev
alias char-major-81-0 meye alias char-major-81-0 meye
options meye gbuffers=32 options meye gbuffers=32
@ -64,6 +73,8 @@ in your /etc/modprobe.d/meye.conf file:
Usage: Usage:
------ ------
.. code-block:: none
xawtv >= 3.49 (<http://bytesex.org/xawtv/>) xawtv >= 3.49 (<http://bytesex.org/xawtv/>)
for display and uncompressed video capture: for display and uncompressed video capture:
@ -74,8 +85,8 @@ Usage:
motioneye (<http://popies.net/meye/>) motioneye (<http://popies.net/meye/>)
for getting ppm or jpg snapshots, mjpeg video for getting ppm or jpg snapshots, mjpeg video
Private API: Private API
------------ -----------
The driver supports frame grabbing with the video4linux API, The driver supports frame grabbing with the video4linux API,
so all video4linux tools (like xawtv) should work with this driver. so all video4linux tools (like xawtv) should work with this driver.
@ -87,8 +98,7 @@ Private API:
This interface consists of several ioctls (prototypes and structures This interface consists of several ioctls (prototypes and structures
can be found in include/linux/meye.h): can be found in include/linux/meye.h):
MEYEIOC_G_PARAMS MEYEIOC_G_PARAMS and MEYEIOC_S_PARAMS
MEYEIOC_S_PARAMS
Get and set the extended parameters of the motion eye camera. Get and set the extended parameters of the motion eye camera.
The user should always query the current parameters with The user should always query the current parameters with
MEYEIOC_G_PARAMS, change what he likes and then issue the MEYEIOC_G_PARAMS, change what he likes and then issue the
@ -108,8 +118,7 @@ Private API:
This ioctl blocks until the buffer is filled and ready This ioctl blocks until the buffer is filled and ready
for the application to use. It returns the buffer size. for the application to use. It returns the buffer size.
MEYEIOC_STILLCAPT MEYEIOC_STILLCAPT and MEYEIOC_STILLJCAPT
MEYEIOC_STILLJCAPT
Takes a snapshot in an uncompressed or compressed jpeg format. Takes a snapshot in an uncompressed or compressed jpeg format.
This ioctl blocks until the snapshot is done and returns (for This ioctl blocks until the snapshot is done and returns (for
jpeg snapshot) the size of the image. The image data is jpeg snapshot) the size of the image. The image data is
@ -117,7 +126,7 @@ Private API:
Look at the 'motioneye' application code for an actual example. Look at the 'motioneye' application code for an actual example.
Bugs / Todo: Bugs / Todo
------------ -----------
- 'motioneye' still uses the meye private v4l1 API extensions. - 'motioneye' still uses the meye private v4l1 API extensions.