History

Apply misc fixes spotted by Diego to indevs.texi and outdevs.texi.

Originally committed as revision 24724 to svn://svn.ffmpeg.org/ffmpeg/trunk

Stefano Sabatini committed 16 years ago

Commit 2f6bc4e1 parent c32ccf72 files · +32 −33Browse files

Unified · Split

2 files
  1. doc/indevs.texi +30 −31
  2. doc/outdevs.texi +2 −2
doc/indevs.texi+30−31
@@ -5,8 +5,8 @@ Input devices are configured elements in FFmpeg which allow to access · 4 unmodified lines
55 the data coming from a multimedia device attached to your system.
66
77 When you configure your FFmpeg build, all the supported input devices
8−are enabled by default. You can list them using the configure option
9−"--list-indevs".
8+are enabled by default. You can list all available ones using the
9+configure option "--list-indevs".
1010
1111 You can disable all the input devices using the configure option
1212 "--disable-indevs", and selectively enable an input device using the
@@ -25,7 +25,7 @@ ALSA (Advanced Linux Sound Architecture) input device. · 12 unmodified lines
2525 To enable this input device during configuration you need libasound
2626 installed on your system.
2727
28−This device allows to capture from an ALSA device. The name of the
28+This device allows capturing from an ALSA device. The name of the
2929 device to capture has to be an ALSA card identifier.
3030
3131 An ALSA identifier has the syntax:
@@ -42,7 +42,7 @@ specify card number or identifier, device number and subdevice number · 10 unmodified lines
4242 To see the list of cards currently recognized by your system check the
4343 files @file{/proc/asound/cards} and @file{/proc/asound/devices}.
4444
45−For example to capture with @file{ffmpeg} from an alsa device with
45+For example to capture with @file{ffmpeg} from an ALSA device with
4646 card id 0, you may run the command:
4747 @example
4848 ffmpeg -f alsa -i hw:0 alsaout.wav
@@ -65,38 +65,38 @@ Linux DV 1394 input device. · 16 unmodified lines
6565
6666 @section jack
6767
68−Jack input device.
68+JACK input device.
6969
7070 To enable this input device during configuration you need libjack
7171 installed on your system.
7272
73−A jack input device creates one or more jack writable clients, one for
73+A JACK input device creates one or more JACK writable clients, one for
7474 each audio channel, with name @var{client_name}:input_@var{N}, where
7575 @var{client_name} is the name provided by the application, and @var{N}
7676 is a number which identifies the channel.
7777 Each writable client will send the acquired data to the FFmpeg input
7878 device.
7979
80−Once you have created one or more jack readable clients, you need to
81−connect them to one or more jack writable clients.
80+Once you have created one or more JACK readable clients, you need to
81+connect them to one or more JACK writable clients.
8282
83−To connect or disconnect jack clients you can use the
83+To connect or disconnect JACK clients you can use the
8484 @file{jack_connect} and @file{jack_disconnect} programs, or do it
8585 through a graphical interface, for example with @file{qjackctl}.
8686
87−To list the jack clients and their properties you can invoke the command
87+To list the JACK clients and their properties you can invoke the command
8888 @file{jack_lsp}.
8989
90−Follows an example which shows how to capture a jack readable client
90+Follows an example which shows how to capture a JACK readable client
9191 with @file{ffmpeg}.
9292 @example
93−# create a jack writable client with name "ffmpeg"
93+# Create a JACK writable client with name "ffmpeg".
9494 $ ffmpeg -f jack -i ffmpeg -y out.wav
9595
96−# start the sample jack_metro readable client
96+# Start the sample jack_metro readable client.
9797 $ jack_metro -b 120 -d 0.2 -f 4000
9898
99−# list the current jack clients
99+# List the current JACK clients.
100100 $ jack_lsp -c
101101 system:capture_1
102102 system:capture_2
@@ -105,7 +105,7 @@ system:playback_2 · 2 unmodified lines
105105 ffmpeg:input_1
106106 metro:120_bpm
107107
108−# connect metro to the ffmpeg writable client
108+# Connect metro to the ffmpeg writable client.
109109 $ jack_connect metro:120_bpm ffmpeg:input_1
110110 @end example
111111
@@ -122,9 +122,9 @@ Open Sound System input device. · 10 unmodified lines
122122
123123 The filename to provide to the input device is the device node
124124 representing the OSS input device, and is usually set to
125−@file{/dev/dsp/}.
125+@file{/dev/dsp}.
126126
127−For example to grab from @file{/dev/dsp/} using @file{ffmpeg} use the
127+For example to grab from @file{/dev/dsp} using @file{ffmpeg} use the
128128 command:
129129 @example
130130 ffmpeg -f oss -i /dev/dsp /tmp/oss.wav
@@ -139,14 +139,14 @@ Video4Linux and Video4Linux2 input video devices. · 8 unmodified lines
139139
140140 The name of the device to grab is a file device node, usually Linux
141141 systems tend to automatically create such nodes when the device
142−(e.g. an USB webcam) is plugged to the system, and has a name of the
142+(e.g. an USB webcam) is plugged into the system, and has a name of the
143143 kind @file{/dev/video@var{N}}, where @var{N} is a number associated to
144144 the device.
145145
146146 Video4Linux and Video4Linux2 devices only support a limited set of
147147 @var{width}x@var{height} sizes and framerates. You can check which are
148−supported for example using the command @file{dov4l} for Video4Linux
149−devices, and the command @file{v4l-info} for Video4Linux2 devices.
148+supported for example with the command @file{dov4l} for Video4Linux
149+devices and the command @file{v4l-info} for Video4Linux2 devices.
150150
151151 If the size for the device is set to 0x0, the input device will
152152 try to autodetect the size to use.
@@ -157,19 +157,19 @@ dropped in later versions. · 4 unmodified lines
157157 Follow some usage examples of the video4linux devices with the ff*
158158 tools.
159159 @example
160−# grab and show the input of a video4linux device
160+# Grab and show the input of a video4linux device.
161161 ffplay -s 320x240 -f video4linux /dev/video0
162162
163−# grab and show the input of a video4linux2 device, autoadjust size
163+# Grab and show the input of a video4linux2 device, autoadjust size.
164164 ffplay -f video4linux2 /dev/video0
165165
166−# grab and record the input of a video4linux2 device, autoadjust size
166+# Grab and record the input of a video4linux2 device, autoadjust size.
167167 ffmpeg -f video4linux2 -i /dev/video0 out.mpeg
168168 @end example
169169
170170 @section vfwcap
171171
172−VFW (Video For Window) catpure input device.
172+VFW (Video For Windows) capture input device.
173173
174174 @section x11grab
175175
@@ -177,31 +177,30 @@ X11 video input device. · 1 unmodified line
177177
178178 This device allows to capture a region of an X11 display.
179179
180−The filename passed in input has the syntax:
180+The filename passed as input has the syntax:
181181 @example
182182 [@var{hostname}]:@var{display_number}.@var{screen_number}[+@var{x_offset},@var{y_offset}]
183183 @end example
184184
185185 @var{hostname}:@var{display_number}.@var{screen_number} specifies the
186−X11 display name of the screen to grab from. @var{hostname} can be not
187−specified, and defaults to "localhost". The environment variable
186+X11 display name of the screen to grab from. @var{hostname} can be
187+ommitted, and defaults to "localhost". The environment variable
188188 @env{DISPLAY} contains the default display name.
189189
190190 @var{x_offset} and @var{y_offset} specify the offsets of the grabbed
191−area with respect to the top/left border of the X11 screen image. They
191+area with respect to the top-left border of the X11 screen. They
192192 default to 0.
193193
194194 Check the X11 documentation (e.g. man X) for more detailed information.
195195
196196 Use the @file{dpyinfo} program for getting basic information about the
197−properties of your X11 display screen (e.g. grep for "name" or
198−"dimensions").
197+properties of your X11 display (e.g. grep for "name" or "dimensions").
199198
200199 For example to grab from @file{:0.0} using @file{ffmpeg}:
201200 @example
202201 ffmpeg -f x11grab -r 25 -s cif -i :0.0 out.mpg
203202
204−# grab at position 10,20
203+# Grab at position 10,20.
205204 ffmpeg -f x11grab -25 -s cif -i :0.0+10,20 out.mpg
206205 @end example
207206
doc/outdevs.texi+2−2
@@ -5,8 +5,8 @@ Output devices are configured elements in FFmpeg which allow to write · 4 unmodified lines
55 multimedia data to an output device attached to your system.
66
77 When you configure your FFmpeg build, all the supported output devices
8−are enabled by default. You can list them using the configure option
9−"--list-outdevs".
8+are enabled by default. You can list all available ones using the
9+configure option "--list-outdevs".
1010
1111 You can disable all the output devices using the configure option
1212 "--disable-outdevs", and selectively enable an output device using the

Keyboard shortcuts

General

Show keyboard shortcuts
?
Focus the current search
/

Issues and pull requests

Open filters
f

Issues, pull requests and Inbox

Select next item
j↓
Select previous item
k↑
Open selected item
Enter
Dismiss filters or clear selection
Esc

Repository code

Go to file
t