diff options
| author | Mark Nauwelaerts <mark.nauwelaerts@collabora.co.uk> | 2008-08-12 13:08:39 +0000 |
|---|---|---|
| committer | Mark Nauwelaerts <mark.nauwelaerts@collabora.co.uk> | 2008-08-12 13:08:39 +0000 |
| commit | edf32882a0eeb95168aa177a29e60dd5acbb9412 (patch) | |
| tree | 3de48e6af9313079a616406f38acb960fd519c13 /ext/x264/gstx264enc.c | |
| parent | be6a492ed50086a11caa0238aab3a237dc6ee715 (diff) | |
| download | gst-plugins-bad-edf32882a0eeb95168aa177a29e60dd5acbb9412.tar.gz gst-plugins-bad-edf32882a0eeb95168aa177a29e60dd5acbb9412.tar.bz2 gst-plugins-bad-edf32882a0eeb95168aa177a29e60dd5acbb9412.zip | |
Add documentation and unit test for x264enc.
Original commit message from CVS:
* docs/plugins/Makefile.am:
* docs/plugins/gst-plugins-bad-plugins-docs.sgml:
* docs/plugins/gst-plugins-bad-plugins-sections.txt:
* ext/x264/gstx264enc.c:
* tests/check/Makefile.am:
* tests/check/elements/x264enc.c: (setup_x264enc),
(cleanup_x264enc), (GST_START_TEST), (x264enc_suite), (main):
Add documentation and unit test for x264enc.
Diffstat (limited to 'ext/x264/gstx264enc.c')
| -rw-r--r-- | ext/x264/gstx264enc.c | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/ext/x264/gstx264enc.c b/ext/x264/gstx264enc.c index 5182e84e..1439d111 100644 --- a/ext/x264/gstx264enc.c +++ b/ext/x264/gstx264enc.c @@ -19,6 +19,36 @@ * Boston, MA 02111-1307, USA. */ +/** + * SECTION:element-x264enc + * @see_also: faac + * + * This element encodes raw video into a H264 compressed data, + * also otherwise known as MPEG-4 AVC (Advanced Video Codec). + * + * The #GstX264Enc:pass-new property controls the type of encoding. In case of Constant + * Bitrate Encoding (actually ABR), the #GstX264Enc:bitrate will determine the quality + * of the encoding. This will similarly be the case if this target bitrate + * is to obtained in multiple (2 or 3) pass encoding. + * Alternatively, one may choose to perform Constant Quantizer or Quality encoding, + * in which case the #GstX264Enc:quantizer property controls much of the outcome. + * + * <refsect2> + * <title>Example pipeline</title> + * |[ + * gst-launch -v videotestsrc num-buffers=1000 ! x264enc qp-min=18 ! \ + * avimux ! filesink location=videotestsrc.avi + * ]| This example pipeline will encode a test video source to H264 muxed in an + * AVI container, while ensuring a sane minimum quantization factor to avoid + * some (excessive) waste. + * |[ + * gst-launch -v videotestsrc num-buffers=1000 ! x264enc pass-new=quant ! \ + * matroskamux ! filesink location=videotestsrc.avi + * ]| This example pipeline will encode a test video source to H264 using fixed + * quantization, and muxes it in a Matroska container. + * </refsect2> + */ + #ifdef HAVE_CONFIG_H # include "config.h" #endif |