doc: use ${DOC_OUTPUT_PATH} in the targets once we have it defined
[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 *-f* '<input format>'::
25     the input device format
26
27 *-i* '<input path>'::
28     the input path
29
30 *-o* '<options>'::
31     a comma separated list of input format options
32 +
33 EXAMPLE:
34 +
35   -o draw_mouse=1,framerate=100,video_size=800x480
36
37 *-s* '<scaling method>'::
38     the rescaling method (see swscale.h)
39
40 *-u*::
41     upscale the image if smaller than the display dimensions
42
43 *-F* '<format>'::
44     the image format to use (default is JPEG)
45 +
46 .SUPPORTED FORMATS:
47 * 1 - JPEG
48 * 2 - NV12
49
50 *-q* '<quality>'::
51     quality of jpeg sent to the device, between 1 and 100
52
53 *-l* '<log level>'::
54     the verbosity level of libam7xxx output (0-5)
55
56 *-p* '<power level>'::
57     power level of device, between 0 (off) and 4 (maximum) +
58     WARNING: Level 2 and greater require the master AND
59              the slave connector to be plugged in.
60
61 *-h*::
62     this help message
63
64
65 EXAMPLES OF USE
66 ---------------
67
68    am7xxx-play -f x11grab -i :0.0 -o video_size=800x480
69    am7xxx-play -f fbdev -i /dev/fb0
70    am7xxx-play -f video4linux2 -i /dev/video0 -o video_size=320x240,frame_rate=100 -u -q 90
71    am7xxx-play -i http://download.blender.org/peach/bigbuckbunny_movies/BigBuckBunny_640x360.m4v
72
73
74 EXIT STATUS
75 -----------
76 *0*::
77     Success
78
79 *!0*::
80     Failure (libam7xxx error; libav error)
81
82
83 AUTHORS
84 -------
85 Antonio Ospite and Reto Schneider
86
87
88 RESOURCES
89 ---------
90 Main web site: <http://git.ao2.it/libam7xxx.git>
91
92
93 COPYING
94 -------
95 Copyright \(C) 2012  Antonio Ospite <ospite@studenti.unina.it>
96
97 This program is free software: you can redistribute it and/or modify
98 it under the terms of the GNU General Public License as published by
99 the Free Software Foundation, either version 3 of the License, or
100 (at your option) any later version.