ffserver.texi 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907
  1. \input texinfo @c -*- texinfo -*-
  2. @settitle ffserver Documentation
  3. @titlepage
  4. @center @titlefont{ffserver Documentation}
  5. @end titlepage
  6. @top
  7. @contents
  8. @chapter Synopsis
  9. ffserver [@var{options}]
  10. @chapter Description
  11. @c man begin DESCRIPTION
  12. @command{ffserver} is a streaming server for both audio and video.
  13. It supports several live feeds, streaming from files and time shifting
  14. on live feeds. You can seek to positions in the past on each live
  15. feed, provided you specify a big enough feed storage.
  16. @command{ffserver} is configured through a configuration file, which
  17. is read at startup. If not explicitly specified, it will read from
  18. @file{/etc/ffserver.conf}.
  19. @command{ffserver} receives prerecorded files or FFM streams from some
  20. @command{ffmpeg} instance as input, then streams them over
  21. RTP/RTSP/HTTP.
  22. An @command{ffserver} instance will listen on some port as specified
  23. in the configuration file. You can launch one or more instances of
  24. @command{ffmpeg} and send one or more FFM streams to the port where
  25. ffserver is expecting to receive them. Alternately, you can make
  26. @command{ffserver} launch such @command{ffmpeg} instances at startup.
  27. Input streams are called feeds, and each one is specified by a
  28. @code{<Feed>} section in the configuration file.
  29. For each feed you can have different output streams in various
  30. formats, each one specified by a @code{<Stream>} section in the
  31. configuration file.
  32. @chapter Detailed description
  33. @command{ffserver} works by forwarding streams encoded by
  34. @command{ffmpeg}, or pre-recorded streams which are read from disk.
  35. Precisely, @command{ffserver} acts as an HTTP server, accepting POST
  36. requests from @command{ffmpeg} to acquire the stream to publish, and
  37. serving RTSP clients or HTTP clients GET requests with the stream
  38. media content.
  39. A feed is an @ref{FFM} stream created by @command{ffmpeg}, and sent to
  40. a port where @command{ffserver} is listening.
  41. Each feed is identified by a unique name, corresponding to the name
  42. of the resource published on @command{ffserver}, and is configured by
  43. a dedicated @code{Feed} section in the configuration file.
  44. The feed publish URL is given by:
  45. @example
  46. http://@var{ffserver_ip_address}:@var{http_port}/@var{feed_name}
  47. @end example
  48. where @var{ffserver_ip_address} is the IP address of the machine where
  49. @command{ffserver} is installed, @var{http_port} is the port number of
  50. the HTTP server (configured through the @option{HTTPPort} option), and
  51. @var{feed_name} is the name of the corresponding feed defined in the
  52. configuration file.
  53. Each feed is associated to a file which is stored on disk. This stored
  54. file is used to send pre-recorded data to a player as fast as
  55. possible when new content is added in real-time to the stream.
  56. A "live-stream" or "stream" is a resource published by
  57. @command{ffserver}, and made accessible through the HTTP protocol to
  58. clients.
  59. A stream can be connected to a feed, or to a file. In the first case,
  60. the published stream is forwarded from the corresponding feed
  61. generated by a running instance of @command{ffmpeg}, in the second
  62. case the stream is read from a pre-recorded file.
  63. Each stream is identified by a unique name, corresponding to the name
  64. of the resource served by @command{ffserver}, and is configured by
  65. a dedicated @code{Stream} section in the configuration file.
  66. The stream access HTTP URL is given by:
  67. @example
  68. http://@var{ffserver_ip_address}:@var{http_port}/@var{stream_name}[@var{options}]
  69. @end example
  70. The stream access RTSP URL is given by:
  71. @example
  72. http://@var{ffserver_ip_address}:@var{rtsp_port}/@var{stream_name}[@var{options}]
  73. @end example
  74. @var{stream_name} is the name of the corresponding stream defined in
  75. the configuration file. @var{options} is a list of options specified
  76. after the URL which affects how the stream is served by
  77. @command{ffserver}. @var{http_port} and @var{rtsp_port} are the HTTP
  78. and RTSP ports configured with the options @var{HTTPPort} and
  79. @var{RTSPPort} respectively.
  80. In case the stream is associated to a feed, the encoding parameters
  81. must be configured in the stream configuration. They are sent to
  82. @command{ffmpeg} when setting up the encoding. This allows
  83. @command{ffserver} to define the encoding parameters used by
  84. the @command{ffmpeg} encoders.
  85. The @command{ffmpeg} @option{override_ffserver} commandline option
  86. allows one to override the encoding parameters set by the server.
  87. Multiple streams can be connected to the same feed.
  88. For example, you can have a situation described by the following
  89. graph:
  90. @example
  91. _________ __________
  92. | | | |
  93. ffmpeg 1 -----| feed 1 |-----| stream 1 |
  94. \ |_________|\ |__________|
  95. \ \
  96. \ \ __________
  97. \ \ | |
  98. \ \| stream 2 |
  99. \ |__________|
  100. \
  101. \ _________ __________
  102. \ | | | |
  103. \| feed 2 |-----| stream 3 |
  104. |_________| |__________|
  105. _________ __________
  106. | | | |
  107. ffmpeg 2 -----| feed 3 |-----| stream 4 |
  108. |_________| |__________|
  109. _________ __________
  110. | | | |
  111. | file 1 |-----| stream 5 |
  112. |_________| |__________|
  113. @end example
  114. @anchor{FFM}
  115. @section FFM, FFM2 formats
  116. FFM and FFM2 are formats used by ffserver. They allow storing a wide variety of
  117. video and audio streams and encoding options, and can store a moving time segment
  118. of an infinite movie or a whole movie.
  119. FFM is version specific, and there is limited compatibility of FFM files
  120. generated by one version of ffmpeg/ffserver and another version of
  121. ffmpeg/ffserver. It may work but it is not guaranteed to work.
  122. FFM2 is extensible while maintaining compatibility and should work between
  123. differing versions of tools. FFM2 is the default.
  124. @section Status stream
  125. @command{ffserver} supports an HTTP interface which exposes the
  126. current status of the server.
  127. Simply point your browser to the address of the special status stream
  128. specified in the configuration file.
  129. For example if you have:
  130. @example
  131. <Stream status.html>
  132. Format status
  133. # Only allow local people to get the status
  134. ACL allow localhost
  135. ACL allow 192.168.0.0 192.168.255.255
  136. </Stream>
  137. @end example
  138. then the server will post a page with the status information when
  139. the special stream @file{status.html} is requested.
  140. @section How do I make it work?
  141. As a simple test, just run the following two command lines where INPUTFILE
  142. is some file which you can decode with ffmpeg:
  143. @example
  144. ffserver -f doc/ffserver.conf &
  145. ffmpeg -i INPUTFILE http://localhost:8090/feed1.ffm
  146. @end example
  147. At this point you should be able to go to your Windows machine and fire up
  148. Windows Media Player (WMP). Go to Open URL and enter
  149. @example
  150. http://<linuxbox>:8090/test.asf
  151. @end example
  152. You should (after a short delay) see video and hear audio.
  153. WARNING: trying to stream test1.mpg doesn't work with WMP as it tries to
  154. transfer the entire file before starting to play.
  155. The same is true of AVI files.
  156. You should edit the @file{ffserver.conf} file to suit your needs (in
  157. terms of frame rates etc). Then install @command{ffserver} and
  158. @command{ffmpeg}, write a script to start them up, and off you go.
  159. @section What else can it do?
  160. You can replay video from .ffm files that was recorded earlier.
  161. However, there are a number of caveats, including the fact that the
  162. ffserver parameters must match the original parameters used to record the
  163. file. If they do not, then ffserver deletes the file before recording into it.
  164. (Now that I write this, it seems broken).
  165. You can fiddle with many of the codec choices and encoding parameters, and
  166. there are a bunch more parameters that you cannot control. Post a message
  167. to the mailing list if there are some 'must have' parameters. Look in
  168. ffserver.conf for a list of the currently available controls.
  169. It will automatically generate the ASX or RAM files that are often used
  170. in browsers. These files are actually redirections to the underlying ASF
  171. or RM file. The reason for this is that the browser often fetches the
  172. entire file before starting up the external viewer. The redirection files
  173. are very small and can be transferred quickly. [The stream itself is
  174. often 'infinite' and thus the browser tries to download it and never
  175. finishes.]
  176. @section Tips
  177. * When you connect to a live stream, most players (WMP, RA, etc) want to
  178. buffer a certain number of seconds of material so that they can display the
  179. signal continuously. However, ffserver (by default) starts sending data
  180. in realtime. This means that there is a pause of a few seconds while the
  181. buffering is being done by the player. The good news is that this can be
  182. cured by adding a '?buffer=5' to the end of the URL. This means that the
  183. stream should start 5 seconds in the past -- and so the first 5 seconds
  184. of the stream are sent as fast as the network will allow. It will then
  185. slow down to real time. This noticeably improves the startup experience.
  186. You can also add a 'Preroll 15' statement into the ffserver.conf that will
  187. add the 15 second prebuffering on all requests that do not otherwise
  188. specify a time. In addition, ffserver will skip frames until a key_frame
  189. is found. This further reduces the startup delay by not transferring data
  190. that will be discarded.
  191. @section Why does the ?buffer / Preroll stop working after a time?
  192. It turns out that (on my machine at least) the number of frames successfully
  193. grabbed is marginally less than the number that ought to be grabbed. This
  194. means that the timestamp in the encoded data stream gets behind realtime.
  195. This means that if you say 'Preroll 10', then when the stream gets 10
  196. or more seconds behind, there is no Preroll left.
  197. Fixing this requires a change in the internals of how timestamps are
  198. handled.
  199. @section Does the @code{?date=} stuff work.
  200. Yes (subject to the limitation outlined above). Also note that whenever you
  201. start ffserver, it deletes the ffm file (if any parameters have changed),
  202. thus wiping out what you had recorded before.
  203. The format of the @code{?date=xxxxxx} is fairly flexible. You should use one
  204. of the following formats (the 'T' is literal):
  205. @example
  206. * YYYY-MM-DDTHH:MM:SS (localtime)
  207. * YYYY-MM-DDTHH:MM:SSZ (UTC)
  208. @end example
  209. You can omit the YYYY-MM-DD, and then it refers to the current day. However
  210. note that @samp{?date=16:00:00} refers to 16:00 on the current day -- this
  211. may be in the future and so is unlikely to be useful.
  212. You use this by adding the ?date= to the end of the URL for the stream.
  213. For example: @samp{http://localhost:8080/test.asf?date=2002-07-26T23:05:00}.
  214. @c man end
  215. @chapter Options
  216. @c man begin OPTIONS
  217. @include fftools-common-opts.texi
  218. @section Main options
  219. @table @option
  220. @item -f @var{configfile}
  221. Read configuration file @file{configfile}. If not specified it will
  222. read by default from @file{/etc/ffserver.conf}.
  223. @item -n
  224. Enable no-launch mode. This option disables all the @code{Launch}
  225. directives within the various @code{<Feed>} sections. Since
  226. @command{ffserver} will not launch any @command{ffmpeg} instances, you
  227. will have to launch them manually.
  228. @item -d
  229. Enable debug mode. This option increases log verbosity, and directs
  230. log messages to stdout. When specified, the @option{CustomLog} option
  231. is ignored.
  232. @end table
  233. @chapter Configuration file syntax
  234. @command{ffserver} reads a configuration file containing global
  235. options and settings for each stream and feed.
  236. The configuration file consists of global options and dedicated
  237. sections, which must be introduced by "<@var{SECTION_NAME}
  238. @var{ARGS}>" on a separate line and must be terminated by a line in
  239. the form "</@var{SECTION_NAME}>". @var{ARGS} is optional.
  240. Currently the following sections are recognized: @samp{Feed},
  241. @samp{Stream}, @samp{Redirect}.
  242. A line starting with @code{#} is ignored and treated as a comment.
  243. Name of options and sections are case-insensitive.
  244. @section ACL syntax
  245. An ACL (Access Control List) specifies the address which are allowed
  246. to access a given stream, or to write a given feed.
  247. It accepts the folling forms
  248. @itemize
  249. @item
  250. Allow/deny access to @var{address}.
  251. @example
  252. ACL ALLOW <address>
  253. ACL DENY <address>
  254. @end example
  255. @item
  256. Allow/deny access to ranges of addresses from @var{first_address} to
  257. @var{last_address}.
  258. @example
  259. ACL ALLOW <first_address> <last_address>
  260. ACL DENY <first_address> <last_address>
  261. @end example
  262. @end itemize
  263. You can repeat the ACL allow/deny as often as you like. It is on a per
  264. stream basis. The first match defines the action. If there are no matches,
  265. then the default is the inverse of the last ACL statement.
  266. Thus 'ACL allow localhost' only allows access from localhost.
  267. 'ACL deny 1.0.0.0 1.255.255.255' would deny the whole of network 1 and
  268. allow everybody else.
  269. @section Global options
  270. @table @option
  271. @item HTTPPort @var{port_number}
  272. @item Port @var{port_number}
  273. @item RTSPPort @var{port_number}
  274. @var{HTTPPort} sets the HTTP server listening TCP port number,
  275. @var{RTSPPort} sets the RTSP server listening TCP port number.
  276. @var{Port} is the equivalent of @var{HTTPPort} and is deprecated.
  277. You must select a different port from your standard HTTP web server if
  278. it is running on the same computer.
  279. If not specified, no corresponding server will be created.
  280. @item HTTPBindAddress @var{ip_address}
  281. @item BindAddress @var{ip_address}
  282. @item RTSPBindAddress @var{ip_address}
  283. Set address on which the HTTP/RTSP server is bound. Only useful if you
  284. have several network interfaces.
  285. @var{BindAddress} is the equivalent of @var{HTTPBindAddress} and is
  286. deprecated.
  287. @item MaxHTTPConnections @var{n}
  288. Set number of simultaneous HTTP connections that can be handled. It
  289. has to be defined @emph{before} the @option{MaxClients} parameter,
  290. since it defines the @option{MaxClients} maximum limit.
  291. Default value is 2000.
  292. @item MaxClients @var{n}
  293. Set number of simultaneous requests that can be handled. Since
  294. @command{ffserver} is very fast, it is more likely that you will want
  295. to leave this high and use @option{MaxBandwidth}.
  296. Default value is 5.
  297. @item MaxBandwidth @var{kbps}
  298. Set the maximum amount of kbit/sec that you are prepared to consume
  299. when streaming to clients.
  300. Default value is 1000.
  301. @item CustomLog @var{filename}
  302. Set access log file (uses standard Apache log file format). '-' is the
  303. standard output.
  304. If not specified @command{ffserver} will produce no log.
  305. In case the commandline option @option{-d} is specified this option is
  306. ignored, and the log is written to standard output.
  307. @item NoDaemon
  308. Set no-daemon mode. This option is currently ignored since now
  309. @command{ffserver} will always work in no-daemon mode, and is
  310. deprecated.
  311. @end table
  312. @section Feed section
  313. A Feed section defines a feed provided to @command{ffserver}.
  314. Each live feed contains one video and/or audio sequence coming from an
  315. @command{ffmpeg} encoder or another @command{ffserver}. This sequence
  316. may be encoded simultaneously with several codecs at several
  317. resolutions.
  318. A feed instance specification is introduced by a line in the form:
  319. @example
  320. <Feed FEED_FILENAME>
  321. @end example
  322. where @var{FEED_FILENAME} specifies the unique name of the FFM stream.
  323. The following options are recognized within a Feed section.
  324. @table @option
  325. @item File @var{filename}
  326. @item ReadOnlyFile @var{filename}
  327. Set the path where the feed file is stored on disk.
  328. If not specified, the @file{/tmp/FEED.ffm} is assumed, where
  329. @var{FEED} is the feed name.
  330. If @option{ReadOnlyFile} is used the file is marked as read-only and
  331. it will not be deleted or updated.
  332. @item Truncate
  333. Truncate the feed file, rather than appending to it. By default
  334. @command{ffserver} will append data to the file, until the maximum
  335. file size value is reached (see @option{FileMaxSize} option).
  336. @item FileMaxSize @var{size}
  337. Set maximum size of the feed file in bytes. 0 means unlimited. The
  338. postfixes @code{K} (2^10), @code{M} (2^20), and @code{G} (2^30) are
  339. recognized.
  340. Default value is 5M.
  341. @item Launch @var{args}
  342. Launch an @command{ffmpeg} command when creating @command{ffserver}.
  343. @var{args} must be a sequence of arguments to be provided to an
  344. @command{ffmpeg} instance. The first provided argument is ignored, and
  345. it is replaced by a path with the same dirname of the @command{ffserver}
  346. instance, followed by the remaining argument and terminated with a
  347. path corresponding to the feed.
  348. When the launched process exits, @command{ffserver} will launch
  349. another program instance.
  350. In case you need a more complex @command{ffmpeg} configuration,
  351. e.g. if you need to generate multiple FFM feeds with a single
  352. @command{ffmpeg} instance, you should launch @command{ffmpeg} by hand.
  353. This option is ignored in case the commandline option @option{-n} is
  354. specified.
  355. @item ACL @var{spec}
  356. Specify the list of IP address which are allowed or denied to write
  357. the feed. Multiple ACL options can be specified.
  358. @end table
  359. @section Stream section
  360. A Stream section defines a stream provided by @command{ffserver}, and
  361. identified by a single name.
  362. The stream is sent when answering a request containing the stream
  363. name.
  364. A stream section must be introduced by the line:
  365. @example
  366. <Stream STREAM_NAME>
  367. @end example
  368. where @var{STREAM_NAME} specifies the unique name of the stream.
  369. The following options are recognized within a Stream section.
  370. Encoding options are marked with the @emph{encoding} tag, and they are
  371. used to set the encoding parameters, and are mapped to libavcodec
  372. encoding options. Not all encoding options are supported, in
  373. particular it is not possible to set encoder private options. In order
  374. to override the encoding options specified by @command{ffserver}, you
  375. can use the @command{ffmpeg} @option{override_ffserver} commandline
  376. option.
  377. Only one of the @option{Feed} and @option{File} options should be set.
  378. @table @option
  379. @item Feed @var{feed_name}
  380. Set the input feed. @var{feed_name} must correspond to an existing
  381. feed defined in a @code{Feed} section.
  382. When this option is set, encoding options are used to setup the
  383. encoding operated by the remote @command{ffmpeg} process.
  384. @item File @var{filename}
  385. Set the filename of the pre-recorded input file to stream.
  386. When this option is set, encoding options are ignored and the input
  387. file content is re-streamed as is.
  388. @item Format @var{format_name}
  389. Set the format of the output stream.
  390. Must be the name of a format recognized by FFmpeg. If set to
  391. @samp{status}, it is treated as a status stream.
  392. @item InputFormat @var{format_name}
  393. Set input format. If not specified, it is automatically guessed.
  394. @item Preroll @var{n}
  395. Set this to the number of seconds backwards in time to start. Note that
  396. most players will buffer 5-10 seconds of video, and also you need to allow
  397. for a keyframe to appear in the data stream.
  398. Default value is 0.
  399. @item StartSendOnKey
  400. Do not send stream until it gets the first key frame. By default
  401. @command{ffserver} will send data immediately.
  402. @item MaxTime @var{n}
  403. Set the number of seconds to run. This value set the maximum duration
  404. of the stream a client will be able to receive.
  405. A value of 0 means that no limit is set on the stream duration.
  406. @item ACL @var{spec}
  407. Set ACL for the stream.
  408. @item DynamicACL @var{spec}
  409. @item RTSPOption @var{option}
  410. @item MulticastAddress @var{address}
  411. @item MulticastPort @var{port}
  412. @item MulticastTTL @var{integer}
  413. @item NoLoop
  414. @item FaviconURL @var{url}
  415. Set favicon (favourite icon) for the server status page. It is ignored
  416. for regular streams.
  417. @item Author @var{value}
  418. @item Comment @var{value}
  419. @item Copyright @var{value}
  420. @item Title @var{value}
  421. Set metadata corresponding to the option. All these options are
  422. deprecated in favor of @option{Metadata}.
  423. @item Metadata @var{key} @var{value}
  424. Set metadata value on the output stream.
  425. @item NoAudio
  426. @item NoVideo
  427. Suppress audio/video.
  428. @item AudioCodec @var{codec_name} (@emph{encoding,audio})
  429. Set audio codec.
  430. @item AudioBitRate @var{rate} (@emph{encoding,audio})
  431. Set bitrate for the audio stream in kbits per second.
  432. @item AudioChannels @var{n} (@emph{encoding,audio})
  433. Set number of audio channels.
  434. @item AudioSampleRate @var{n} (@emph{encoding,audio})
  435. Set sampling frequency for audio. When using low bitrates, you should
  436. lower this frequency to 22050 or 11025. The supported frequencies
  437. depend on the selected audio codec.
  438. @item AVOptionAudio @var{option} @var{value} (@emph{encoding,audio})
  439. Set generic option for audio stream.
  440. @item AVPresetAudio @var{preset} (@emph{encoding,audio})
  441. Set preset for audio stream.
  442. @item VideoCodec @var{codec_name} (@emph{encoding,video})
  443. Set video codec.
  444. @item VideoBitRate @var{n} (@emph{encoding,video})
  445. Set bitrate for the video stream in kbits per second.
  446. @item VideoBitRateRange @var{range} (@emph{encoding,video})
  447. Set video bitrate range.
  448. A range must be specified in the form @var{minrate}-@var{maxrate}, and
  449. specifies the @option{minrate} and @option{maxrate} encoding options
  450. expressed in kbits per second.
  451. @item VideoBitRateRangeTolerance @var{n} (@emph{encoding,video})
  452. Set video bitrate tolerance in kbits per second.
  453. @item PixelFormat @var{pixel_format} (@emph{encoding,video})
  454. Set video pixel format.
  455. @item Debug @var{integer} (@emph{encoding,video})
  456. Set video @option{debug} encoding option.
  457. @item Strict @var{integer} (@emph{encoding,video})
  458. Set video @option{strict} encoding option.
  459. @item VideoBufferSize @var{n} (@emph{encoding,video})
  460. Set ratecontrol buffer size, expressed in KB.
  461. @item VideoFrameRate @var{n} (@emph{encoding,video})
  462. Set number of video frames per second.
  463. @item VideoSize (@emph{encoding,video})
  464. Set size of the video frame, must be an abbreviation or in the form
  465. @var{W}x@var{H}. See @ref{video size syntax,,the Video size section
  466. in the ffmpeg-utils(1) manual,ffmpeg-utils}.
  467. Default value is @code{160x128}.
  468. @item VideoIntraOnly (@emph{encoding,video})
  469. Transmit only intra frames (useful for low bitrates, but kills frame rate).
  470. @item VideoGopSize @var{n} (@emph{encoding,video})
  471. If non-intra only, an intra frame is transmitted every VideoGopSize
  472. frames. Video synchronization can only begin at an intra frame.
  473. @item VideoTag @var{tag} (@emph{encoding,video})
  474. Set video tag.
  475. @item VideoHighQuality (@emph{encoding,video})
  476. @item Video4MotionVector (@emph{encoding,video})
  477. @item BitExact (@emph{encoding,video})
  478. Set bitexact encoding flag.
  479. @item IdctSimple (@emph{encoding,video})
  480. Set simple IDCT algorithm.
  481. @item Qscale @var{n} (@emph{encoding,video})
  482. Enable constant quality encoding, and set video qscale (quantization
  483. scale) value, expressed in @var{n} QP units.
  484. @item VideoQMin @var{n} (@emph{encoding,video})
  485. @item VideoQMax @var{n} (@emph{encoding,video})
  486. Set video qmin/qmax.
  487. @item VideoQDiff @var{integer} (@emph{encoding,video})
  488. Set video @option{qdiff} encoding option.
  489. @item LumiMask @var{float} (@emph{encoding,video})
  490. @item DarkMask @var{float} (@emph{encoding,video})
  491. Set @option{lumi_mask}/@option{dark_mask} encoding options.
  492. @item AVOptionVideo @var{option} @var{value} (@emph{encoding,video})
  493. Set generic option for video stream.
  494. @item AVPresetVideo @var{preset} (@emph{encoding,video})
  495. Set preset for video stream.
  496. @var{preset} must be the path of a preset file.
  497. @end table
  498. @subsection Server status stream
  499. A server status stream is a special stream which is used to show
  500. statistics about the @command{ffserver} operations.
  501. It must be specified setting the option @option{Format} to
  502. @samp{status}.
  503. @section Redirect section
  504. A redirect section specifies where to redirect the requested URL to
  505. another page.
  506. A redirect section must be introduced by the line:
  507. @example
  508. <Redirect NAME>
  509. @end example
  510. where @var{NAME} is the name of the page which should be redirected.
  511. It only accepts the option @option{URL}, which specify the redirection
  512. URL.
  513. @chapter Stream examples
  514. @itemize
  515. @item
  516. Multipart JPEG
  517. @example
  518. <Stream test.mjpg>
  519. Feed feed1.ffm
  520. Format mpjpeg
  521. VideoFrameRate 2
  522. VideoIntraOnly
  523. NoAudio
  524. Strict -1
  525. </Stream>
  526. @end example
  527. @item
  528. Single JPEG
  529. @example
  530. <Stream test.jpg>
  531. Feed feed1.ffm
  532. Format jpeg
  533. VideoFrameRate 2
  534. VideoIntraOnly
  535. VideoSize 352x240
  536. NoAudio
  537. Strict -1
  538. </Stream>
  539. @end example
  540. @item
  541. Flash
  542. @example
  543. <Stream test.swf>
  544. Feed feed1.ffm
  545. Format swf
  546. VideoFrameRate 2
  547. VideoIntraOnly
  548. NoAudio
  549. </Stream>
  550. @end example
  551. @item
  552. ASF compatible
  553. @example
  554. <Stream test.asf>
  555. Feed feed1.ffm
  556. Format asf
  557. VideoFrameRate 15
  558. VideoSize 352x240
  559. VideoBitRate 256
  560. VideoBufferSize 40
  561. VideoGopSize 30
  562. AudioBitRate 64
  563. StartSendOnKey
  564. </Stream>
  565. @end example
  566. @item
  567. MP3 audio
  568. @example
  569. <Stream test.mp3>
  570. Feed feed1.ffm
  571. Format mp2
  572. AudioCodec mp3
  573. AudioBitRate 64
  574. AudioChannels 1
  575. AudioSampleRate 44100
  576. NoVideo
  577. </Stream>
  578. @end example
  579. @item
  580. Ogg Vorbis audio
  581. @example
  582. <Stream test.ogg>
  583. Feed feed1.ffm
  584. Metadata title "Stream title"
  585. AudioBitRate 64
  586. AudioChannels 2
  587. AudioSampleRate 44100
  588. NoVideo
  589. </Stream>
  590. @end example
  591. @item
  592. Real with audio only at 32 kbits
  593. @example
  594. <Stream test.ra>
  595. Feed feed1.ffm
  596. Format rm
  597. AudioBitRate 32
  598. NoVideo
  599. </Stream>
  600. @end example
  601. @item
  602. Real with audio and video at 64 kbits
  603. @example
  604. <Stream test.rm>
  605. Feed feed1.ffm
  606. Format rm
  607. AudioBitRate 32
  608. VideoBitRate 128
  609. VideoFrameRate 25
  610. VideoGopSize 25
  611. </Stream>
  612. @end example
  613. @item
  614. For stream coming from a file: you only need to set the input filename
  615. and optionally a new format.
  616. @example
  617. <Stream file.rm>
  618. File "/usr/local/httpd/htdocs/tlive.rm"
  619. NoAudio
  620. </Stream>
  621. @end example
  622. @example
  623. <Stream file.asf>
  624. File "/usr/local/httpd/htdocs/test.asf"
  625. NoAudio
  626. Metadata author "Me"
  627. Metadata copyright "Super MegaCorp"
  628. Metadata title "Test stream from disk"
  629. Metadata comment "Test comment"
  630. </Stream>
  631. @end example
  632. @end itemize
  633. @c man end
  634. @include config.texi
  635. @ifset config-all
  636. @ifset config-avutil
  637. @include utils.texi
  638. @end ifset
  639. @ifset config-avcodec
  640. @include codecs.texi
  641. @include bitstream_filters.texi
  642. @end ifset
  643. @ifset config-avformat
  644. @include formats.texi
  645. @include protocols.texi
  646. @end ifset
  647. @ifset config-avdevice
  648. @include devices.texi
  649. @end ifset
  650. @ifset config-swresample
  651. @include resampler.texi
  652. @end ifset
  653. @ifset config-swscale
  654. @include scaler.texi
  655. @end ifset
  656. @ifset config-avfilter
  657. @include filters.texi
  658. @end ifset
  659. @end ifset
  660. @chapter See Also
  661. @ifhtml
  662. @ifset config-all
  663. @url{ffserver.html,ffserver},
  664. @end ifset
  665. @ifset config-not-all
  666. @url{ffserver-all.html,ffserver-all},
  667. @end ifset
  668. the @file{doc/ffserver.conf} example,
  669. @url{ffmpeg.html,ffmpeg}, @url{ffplay.html,ffplay}, @url{ffprobe.html,ffprobe},
  670. @url{ffmpeg-utils.html,ffmpeg-utils},
  671. @url{ffmpeg-scaler.html,ffmpeg-scaler},
  672. @url{ffmpeg-resampler.html,ffmpeg-resampler},
  673. @url{ffmpeg-codecs.html,ffmpeg-codecs},
  674. @url{ffmpeg-bitstream-filters.html,ffmpeg-bitstream-filters},
  675. @url{ffmpeg-formats.html,ffmpeg-formats},
  676. @url{ffmpeg-devices.html,ffmpeg-devices},
  677. @url{ffmpeg-protocols.html,ffmpeg-protocols},
  678. @url{ffmpeg-filters.html,ffmpeg-filters}
  679. @end ifhtml
  680. @ifnothtml
  681. @ifset config-all
  682. ffserver(1),
  683. @end ifset
  684. @ifset config-not-all
  685. ffserver-all(1),
  686. @end ifset
  687. the @file{doc/ffserver.conf} example, ffmpeg(1), ffplay(1), ffprobe(1),
  688. ffmpeg-utils(1), ffmpeg-scaler(1), ffmpeg-resampler(1),
  689. ffmpeg-codecs(1), ffmpeg-bitstream-filters(1), ffmpeg-formats(1),
  690. ffmpeg-devices(1), ffmpeg-protocols(1), ffmpeg-filters(1)
  691. @end ifnothtml
  692. @include authors.texi
  693. @ignore
  694. @setfilename ffserver
  695. @settitle ffserver video server
  696. @end ignore
  697. @bye