diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/APIchanges | 9 | ||||
| -rw-r--r-- | doc/developer.texi | 22 | ||||
| -rw-r--r-- | doc/faq.texi | 8 | ||||
| -rw-r--r-- | doc/ffserver.conf | 2 | ||||
| -rw-r--r-- | doc/filters.texi | 156 | ||||
| -rw-r--r-- | doc/git-howto.txt | 8 | ||||
| -rw-r--r-- | doc/indevs.texi | 25 | ||||
| -rw-r--r-- | doc/libavfilter.texi | 2 | ||||
| -rw-r--r-- | doc/optimization.txt | 6 |
9 files changed, 211 insertions, 27 deletions
diff --git a/doc/APIchanges b/doc/APIchanges index f9ae6c1..883258d 100644 --- a/doc/APIchanges +++ b/doc/APIchanges @@ -12,6 +12,9 @@ libavutil: 2009-03-08 API changes, most recent first: +2011-XX-XX - XXXXXXX - lavu XX.XXX.X - pixfmt.h + Add PIX_FMT_BGR48LE and PIX_FMT_BGR48BE pixel formats + 2011-03-02 - 863c471 - lavf 52.103.0 - av_pkt_dump2, av_pkt_dump_log2 Add new functions av_pkt_dump2, av_pkt_dump_log2 that uses the source stream timebase for outputting timestamps. Deprecate @@ -78,6 +81,12 @@ API changes, most recent first: 2011-02-02 - dfd2a00 - lavu 50.37.0 - log.h Make av_dlog public. +2011-01-31 - X - lavfi 1.76.0 - vsrc_buffer + Add sample_aspect_ratio fields to vsrc_buffer arguments + +2011-01-31 - X - lavfi 1.75.0 - AVFilterLink sample_aspect_ratio + Add sample_aspect_ratio field to AVFilterLink. + 2011-01-15 - r26374 - lavfi 1.74.0 - AVFilterBufferRefAudioProps Rename AVFilterBufferRefAudioProps.samples_nb to nb_samples. diff --git a/doc/developer.texi b/doc/developer.texi index 379f6b2..8a0655e 100644 --- a/doc/developer.texi +++ b/doc/developer.texi @@ -151,7 +151,7 @@ should also be avoided if they don't make the code easier to understand. ask/discuss it on the developer mailing list. @item Do not change behavior of the programs (renaming options etc) or public - API or ABI without first discussing it on the libav-devel mailing list. + API or ABI without first discussing it on the ffmpeg-devel mailing list. Do not remove functionality from the code. Just improve! Note: Redundant code can be removed. @@ -160,7 +160,7 @@ should also be avoided if they don't make the code easier to understand. which change behavior, defaults etc, without asking first. The same applies to compiler warning fixes, trivial looking fixes and to code maintained by other developers. We usually have a reason for doing things - the way we do. Send your changes as patches to the libav-devel mailing + the way we do. Send your changes as patches to the ffmpeg-devel mailing list, and if the code maintainers say OK, you may commit. This does not apply to files you wrote and/or maintain. @item @@ -182,27 +182,27 @@ should also be avoided if they don't make the code easier to understand. particular bug. Comments such as "fixed!" or "Changed it." are unacceptable. @item If you apply a patch by someone else, include the name and email address in - the log message. Since the libav-commits mailing list is publicly + the log message. Since the ffmpeg-cvslog mailing list is publicly archived you should add some SPAM protection to the email address. Send an - answer to libav-devel (or wherever you got the patch from) saying that + answer to ffmpeg-devel (or wherever you got the patch from) saying that you applied the patch. @item When applying patches that have been discussed (at length) on the mailing list, reference the thread in the log message. @item Do NOT commit to code actively maintained by others without permission. - Send a patch to libav-devel instead. If no one answers within a reasonable + Send a patch to ffmpeg-devel instead. If no one answers within a reasonable timeframe (12h for build failures and security fixes, 3 days small changes, 1 week for big patches) then commit your patch if you think it is OK. Also note, the maintainer can simply ask for more time to review! @item - Subscribe to the libav-commits mailing list. The diffs of all commits + Subscribe to the ffmpeg-cvslog mailing list. The diffs of all commits are sent there and reviewed by all the other developers. Bugs and possible improvements or general questions regarding commits are discussed there. We expect you to react if problems with your code are uncovered. @item Update the documentation if you change behavior or add features. If you are - unsure how best to do this, send a patch to libav-devel, the documentation + unsure how best to do this, send a patch to ffmpeg-devel, the documentation maintainer(s) will review and commit your stuff. @item Try to keep important discussions and requests (also) on the public @@ -261,8 +261,8 @@ verify that there are no big problems. Patches should be posted as base64 encoded attachments (or any other encoding which ensures that the patch will not be trashed during -transmission) to the libav-devel mailing list, see -@url{https://lists.libav.org/mailman/listinfo/libav-devel} +transmission) to the ffmpeg-devel mailing list, see +@url{http://lists.mplayerhq.hu/mailman/listinfo/ffmpeg-devel} It also helps quite a bit if you tell us what the patch does (for example 'replaces lrint by lrintf'), and why (for example '*BSD isn't C99 compliant @@ -361,7 +361,7 @@ send a reminder by email. Your patch should eventually be dealt with. If the patch fixes a bug, did you provide enough information, including a sample, so the bug can be reproduced and the fix can be verified? Note please do not attach samples >100k to mails but rather provide a - URL, you can upload to ftp://upload.libav.org + URL, you can upload to ftp://upload.ffmpeg.org @item Did you provide a verbose summary about what the patch does change? @item @@ -387,7 +387,7 @@ send a reminder by email. Your patch should eventually be dealt with. @section Patch review process -All patches posted to libav-devel will be reviewed, unless they contain a +All patches posted to ffmpeg-devel will be reviewed, unless they contain a clear note that the patch is not for the git master branch. Reviews and comments will be posted as replies to the patch on the mailing list. The patch submitter then has to take care of every comment, diff --git a/doc/faq.texi b/doc/faq.texi index a07254a..5612ae8 100644 --- a/doc/faq.texi +++ b/doc/faq.texi @@ -25,7 +25,7 @@ Nowhere. We do not support old Libav versions in any way, we simply lack the time, motivation and manpower to do so. If you have a problem with an old version of Libav, upgrade to the latest Subversion snapshot. If you still experience the problem, then you can report it according to the -guidelines in @url{http://libav.org/bugreports.html}. +guidelines in @url{http://ffmpeg.org/bugreports.html}. @section Why doesn't Libav support feature [xyz]? @@ -40,13 +40,13 @@ No. Windows DLLs are not portable, bloated and often slow. Moreover Libav strives to support all codecs natively. A DLL loader is not conducive to that goal. -@section My bug report/mail to libav-devel/user has not received any replies. +@section My bug report/mail to ffmpeg-devel/user has not received any replies. Likely reasons @itemize @item We are busy and haven't had time yet to read your report or investigate the issue. -@item You didn't follow @url{http://libav.org/bugreports.html}. +@item You didn't follow @url{http://ffmpeg.org/bugreports.html}. @item You didn't use Subversion HEAD. @item You reported a segmentation fault without gdb output. @item You describe a problem but not how to reproduce it. @@ -124,7 +124,7 @@ problem and an NP-hard problem... @section ffmpeg does not work; what is wrong? Try a @code{make distclean} in the ffmpeg source directory before the build. If this does not help see -(@url{http://libav.org/bugreports.html}). +(@url{http://ffmpeg.org/bugreports.html}). @section How do I encode single pictures into movies? diff --git a/doc/ffserver.conf b/doc/ffserver.conf index 62728b0..2171170 100644 --- a/doc/ffserver.conf +++ b/doc/ffserver.conf @@ -371,7 +371,7 @@ ACL allow 192.168.0.0 192.168.255.255 # Redirect index.html to the appropriate site <Redirect index.html> -URL http://www.libav.org/ +URL http://www.ffmpeg.org/ </Redirect> diff --git a/doc/filters.texi b/doc/filters.texi index 2bd7bf5..0744fb7 100644 --- a/doc/filters.texi +++ b/doc/filters.texi @@ -353,6 +353,151 @@ drawbox drawbox=10:20:200:60:red@@0.5" @end example +@section fade + +Apply fade-in/out effect to input video. + +It accepts the parameters: +@var{type}:@var{start_frame}:@var{nb_frames} + +@var{type} specifies if the effect type, can be either "in" for +fade-in, or "out" for a fade-out effect. + +@var{start_frame} specifies the number of the start frame for starting +to apply the fade effect. + +@var{nb_frames} specifies the number of frames for which the fade +effect has to last. At the end of the fade-in effect the output video +will have the same intensity as the input video, at the end of the +fade-out transition the output video will be completely black. + +A few usage examples follow, usable too as test scenarios. +@example +# fade in first 30 frames of video +fade=in:0:30 + +# fade out last 45 frames of a 200-frame video +fade=out:155:45 + +# fade in first 25 frames and fade out last 25 frames of a 1000-frame video +fade=in:0:25, fade=out:975:25 + +# make first 5 frames black, then fade in from frame 5-24 +fade=in:5:20 +@end example + +@section drawtext + +Draw text string or text from specified file on top of video using the +libfreetype library. + +To enable compilation of this filter you need to configure FFmpeg with +@code{--enable-libfreetype}. + +The filter also recognizes strftime() sequences in the provided text +and expands them accordingly. Check the documentation of strftime(). + +The filter accepts parameters as a list of @var{key}=@var{value} pairs, +separated by ":". + +The description of the accepted parameters follows. + +@table @option + +@item fontfile +The font file to be used for drawing text. Path must be included. +This parameter is mandatory. + +@item text +The text string to be drawn. The text must be a sequence of UTF-8 +encoded characters. +This parameter is mandatory if no file is specified. + +@item textfile +A text file containing text to be drawn. The text must be a sequence +of UTF-8 encoded characters + +This parameter is mandatory if no text string is specified. + +If both text and textfile are specified, an error is thrown. + +@item x, y +The offsets where text will be drawn within the video frame. +Relative to the top/left border of the output image. + +The default value of @var{x} and @var{y} is 0. + +@item fontsize +The font size to be used for drawing text. +The default value of @var{size} is 16. + +@item fontcolor +The color to be used for drawing fonts. +Either a string (e.g. "red") or in 0xRRGGBB[AA] format +(e.g. "0xff000033"), possibly followed by an alpha specifier. +The default value of @var{fontcolor} is "black". + +@item boxcolor +The color to be used for drawing box around text. +Either a string (e.g. "yellow") or in 0xRRGGBB[AA] format +(e.g. "0xff00ff"), possibly followed by an alpha specifier. + +The default value of @var{bgcolor} is "white". + +@item box +Used to draw a box around text using background color. +Value should be either 1 (enable) or 0 (disable). +The default value of @var{box} is 0. + +@item ft_load_flags +Flags to be used for loading the fonts. + +The flags map the corresponding flags supported by libfreetype, and are +a combination of the following values: +@table @var +@item default +@item no_scale +@item no_hinting +@item render +@item no_bitmap +@item vertical_layout +@item force_autohint +@item crop_bitmap +@item pedantic +@item ignore_global_advance_width +@item no_recurse +@item ignore_transform +@item monochrome +@item linear_design +@item no_autohint +@item end table +@end table + +Default value is "render". + +For more information consult the documentation for the FT_LOAD_* +libfreetype flags. + +@item tabsize +The size in number of spaces to use for rendering the tab. +Default value is 4. +@end table + +For example the command: +@example +drawtext=fontfile=FreeSerif.ttf: text='Test Text': x=100: y=50: fontsize=24: fontcolor=yellow@@0.2: boxcolor=red@@0.2: box=1" +@end example + +will draw 'Test Text' with font FreeSerif of size 24 at position +(100,50), text color is yellow, and draw a red box around text. Both +the text and the box have an opacity of 20%. + +Note that the double quotes are not necessary if spaces are not used +within the parameter list. + +For more information about libfreetype, check: +@url{http://www.freetype.org/} + @section fifo Buffer input images and send them when they are requested. @@ -1014,7 +1159,7 @@ This source is mainly intended for a programmatic use, in particular through the interface defined in @file{libavfilter/vsrc_buffer.h}. It accepts the following parameters: -@var{width}:@var{height}:@var{pix_fmt_string}:@var{timebase_num}:@var{timebase_den} +@var{width}:@var{height}:@var{pix_fmt_string}:@var{timebase_num}:@var{timebase_den}:@var{sample_aspect_ratio_num}:@var{sample_aspect_ratio.den} All the parameters need to be explicitely defined. @@ -1033,15 +1178,20 @@ name. @item timebase_num, timebase_den Specify numerator and denomitor of the timebase assumed by the timestamps of the buffered frames. + +@item sample_aspect_ratio.num, sample_aspect_ratio.den +Specify numerator and denominator of the sample aspect ratio assumed +by the video frames. @end table For example: @example -buffer=320:240:yuv410p:1:24 +buffer=320:240:yuv410p:1:24:1:1 @end example will instruct the source to accept video frames with size 320x240 and -with format "yuv410p" and assuming 1/24 as the timestamps timebase. +with format "yuv410p", assuming 1/24 as the timestamps timebase and +square pixels (1:1 sample aspect ratio). Since the pixel format with name "yuv410p" corresponds to the number 6 (check the enum PixelFormat definition in @file{libavutil/pixfmt.h}), this example corresponds to: diff --git a/doc/git-howto.txt b/doc/git-howto.txt index 3ac21c8..65eed42 100644 --- a/doc/git-howto.txt +++ b/doc/git-howto.txt @@ -44,11 +44,11 @@ I. BASICS: 1. Cloning the source tree: - git clone git://git.libav.org/libav.git <target> + git clone git://git.videolan.org/ffmpeg <target> This will put the Libav sources into the directory <target>. - git clone git@git.libav.org:libav.git <target> + git clone git@git.videolan.org:ffmpeg <target> This will put the Libav sources into the directory <target> and let you push back your changes to the remote repository. @@ -97,7 +97,7 @@ I. BASICS: git log <filename(s)> You may also use the graphical tools like gitview or gitk or the web - interface available at http://git.libav.org/ + interface available at http://git.videolan.org 6. Checking source tree status: @@ -255,5 +255,5 @@ I. BASICS: where $SHA1 is the commit SHA1 from the 'git log' output. -Contact the project admins <git at libav dot org> if you have technical +Contact the project admins <root at ffmpeg dot org> if you have technical problems with the GIT server. diff --git a/doc/indevs.texi b/doc/indevs.texi index 6533284..f1d69f7 100644 --- a/doc/indevs.texi +++ b/doc/indevs.texi @@ -59,6 +59,31 @@ BSD video input device. Linux DV 1394 input device. +@section fbdev + +Linux framebuffer input device. + +The Linux framebuffer is a graphic hardware-independent abstraction +layer to show graphics on a computer monitor, typically on the +console. It is accessed through a file device node, usually +@file{/dev/fb0}. + +For more detailed information read the file +Documentation/fb/framebuffer.txt included in the Linux source tree. + +For example, to record from the framebuffer device @file{/dev/fb0} with +@file{ffmpeg}: +@example +ffmpeg -f fbdev -r 10 -i /dev/fb0 out.avi +@end example + +You can take a single screenshot image with the command: +@example +ffmpeg -f fbdev -vframes 1 -r 1 -i /dev/fb0 screenshot.jpeg +@end example + +See also @url{http://linux-fbdev.sourceforge.net/}, and fbset(1). + @section jack JACK input device. diff --git a/doc/libavfilter.texi b/doc/libavfilter.texi index 1c12205..6d5698b 100644 --- a/doc/libavfilter.texi +++ b/doc/libavfilter.texi @@ -20,7 +20,7 @@ libavfilter then check it out from the libavfilter repository into some directory of your choice by: @example - svn checkout svn://svn.libav.org/soc/libavfilter + svn checkout svn://svn.ffmpeg.org/soc/libavfilter @end example And then read the README file in the top directory to learn how to diff --git a/doc/optimization.txt b/doc/optimization.txt index 78e0077..70df5f0 100644 --- a/doc/optimization.txt +++ b/doc/optimization.txt @@ -17,15 +17,15 @@ Understanding these overoptimized functions: As many functions tend to be a bit difficult to understand because of optimizations, it can be hard to optimize them further, or write architecture-specific versions. It is recommended to look at older -revisions of the interesting files (web frontends for the various Libav -branches are listed at http://libav.org/download.html). +revisions of the interesting files (web frontends for the various FFmpeg +branches are listed at http://ffmpeg.org/download.html). Alternatively, look into the other architecture-specific versions in the x86/, ppc/, alpha/ subdirectories. Even if you don't exactly comprehend the instructions, it could help understanding the functions and how they can be optimized. NOTE: If you still don't understand some function, ask at our mailing list!!! -(https://lists.libav.org/mailman/listinfo/libav-devel) +(http://lists.mplayerhq.hu/mailman/listinfo/ffmpeg-devel) When is an optimization justified? |
