TODO: add some ideas for minor enhancements
[libam7xxx.git] / doc / man / am7xxx-play.1.txt
1 AM7XXX-PLAY(1)
2 ==============
3 :doctype: manpage
4
5
6 NAME
7 ----
8 am7xxx-play - play stuff on an am7xxx device (e.g. Acer C110, PicoPix 1020)
9
10
11 SYNOPSIS
12 --------
13 *am7xxx-play* ['OPTIONS']
14
15
16 DESCRIPTION
17 -----------
18 am7xxx-play(1) uses libavdevice, libavformat, libavcodec and libswscale to
19 decode the input, encode it to jpeg and display it with libam7xxx.
20
21
22 OPTIONS
23 -------
24
25 *-d* '<index>'::
26     the device index (default is 0)
27
28 *-f* '<input format>'::
29     the input device format
30
31 *-i* '<input path>'::
32     the input path
33
34 *-o* '<options>'::
35     a comma separated list of input format options
36 +
37 EXAMPLE:
38 +
39   -o draw_mouse=1,framerate=100,video_size=800x480
40
41 *-s* '<scaling method>'::
42     the rescaling method (see swscale.h)
43
44 *-u*::
45     upscale the image if smaller than the display dimensions
46
47 *-F* '<format>'::
48     the image format to use (default is JPEG)
49 +
50 .SUPPORTED FORMATS:
51 * 1 - JPEG
52 * 2 - NV12
53
54 *-q* '<quality>'::
55     quality of jpeg sent to the device, between 1 and 100
56
57 *-l* '<log level>'::
58     the verbosity level of libam7xxx output (0-5)
59
60 *-p* '<power mode>'::
61     the power mode of device, between 0 (off) and 4 (turbo) +
62     WARNING: Level 2 and greater require the master AND
63              the slave connector to be plugged in.
64
65 *-z* '<zoom mode>'::
66     the display zoom mode, between 0 (original) and 4 (tele)
67
68 *-h*::
69     show the help message
70
71
72 EXAMPLES OF USE
73 ---------------
74
75    am7xxx-play -f x11grab -i :0.0 -o video_size=800x480
76    am7xxx-play -f fbdev -i /dev/fb0
77    am7xxx-play -f video4linux2 -i /dev/video0 -o video_size=320x240,frame_rate=100 -u -q 90
78    am7xxx-play -i http://download.blender.org/peach/bigbuckbunny_movies/BigBuckBunny_640x360.m4v
79
80
81 EXIT STATUS
82 -----------
83 *0*::
84     Success
85
86 *!0*::
87     Failure (libam7xxx error; libav error)
88
89
90 AUTHORS
91 -------
92 Antonio Ospite and Reto Schneider
93
94
95 RESOURCES
96 ---------
97 Main web site: <http://git.ao2.it/libam7xxx.git>
98
99
100 COPYING
101 -------
102 Copyright \(C) 2012-2014  Antonio Ospite <ao2@ao2.it>
103
104 This program is free software: you can redistribute it and/or modify
105 it under the terms of the GNU General Public License as published by
106 the Free Software Foundation, either version 3 of the License, or
107 (at your option) any later version.