FFmpeg
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Data Structures | Macros | Functions | Variables
libxvid.c File Reference

Interface to xvidcore for MPEG-4 compliant encoding. More...

#include <stdio.h>
#include <string.h>
#include <xvid.h>
#include "libavutil/avassert.h"
#include "libavutil/cpu.h"
#include "libavutil/file.h"
#include "libavutil/internal.h"
#include "libavutil/intreadwrite.h"
#include "libavutil/mathematics.h"
#include "libavutil/mem.h"
#include "libavutil/opt.h"
#include "avcodec.h"
#include "internal.h"
#include "libxvid.h"
#include "mpegutils.h"

Go to the source code of this file.

Data Structures

struct  xvid_context
 Structure for the private Xvid context. More...
 
struct  xvid_ff_pass1
 Structure for the private first-pass plugin. More...
 

Macros

#define BUFFER_SIZE   1024
 Buffer management macros. More...
 
#define BUFFER_REMAINING(x)   (BUFFER_SIZE - strlen(x))
 
#define BUFFER_CAT(x)   (&((x)[strlen(x)]))
 
#define OFFSET(x)   offsetof(struct xvid_context, x)
 
#define VE   AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_ENCODING_PARAM
 

Functions

static int xvid_encode_close (AVCodecContext *avctx)
 
static int xvid_encode_frame (AVCodecContext *avctx, AVPacket *pkt, const AVFrame *picture, int *got_packet)
 
static int xvid_ff_2pass_create (xvid_plg_create_t *param, void **handle)
 Initialize the two-pass plugin and context. More...
 
static int xvid_ff_2pass_destroy (struct xvid_context *ref, xvid_plg_destroy_t *param)
 Destroy the two-pass plugin context. More...
 
static int xvid_ff_2pass_before (struct xvid_context *ref, xvid_plg_data_t *param)
 Enable fast encode mode during the first pass. More...
 
static int xvid_ff_2pass_after (struct xvid_context *ref, xvid_plg_data_t *param)
 Capture statistic data and write it during first pass. More...
 
static int xvid_ff_2pass (void *ref, int cmd, void *p1, void *p2)
 Dispatch function for our custom plugin. More...
 
static int xvid_strip_vol_header (AVCodecContext *avctx, AVPacket *pkt, unsigned int header_len, unsigned int frame_len)
 Routine to create a global VO/VOL header for MP4 container. More...
 
static void xvid_correct_framerate (AVCodecContext *avctx)
 Routine to correct a possibly erroneous framerate being fed to us. More...
 
static av_cold int xvid_encode_init (AVCodecContext *avctx)
 

Variables

static const AVOption options []
 
static const AVClass xvid_class
 
AVCodec ff_libxvid_encoder
 

Detailed Description

Interface to xvidcore for MPEG-4 compliant encoding.

Author
Adam Thayer (krevn.nosp@m.ik@c.nosp@m.omcas.nosp@m.t.ne.nosp@m.t)

Definition in file libxvid.c.

Macro Definition Documentation

#define BUFFER_SIZE   1024

Buffer management macros.

Definition at line 57 of file libxvid.c.

Referenced by xvid_encode_init().

#define BUFFER_REMAINING (   x)    (BUFFER_SIZE - strlen(x))

Definition at line 58 of file libxvid.c.

Referenced by xvid_ff_2pass_after(), and xvid_ff_2pass_create().

#define BUFFER_CAT (   x)    (&((x)[strlen(x)]))

Definition at line 59 of file libxvid.c.

Referenced by xvid_ff_2pass_after(), and xvid_ff_2pass_create().

#define OFFSET (   x)    offsetof(struct xvid_context, x)

Definition at line 901 of file libxvid.c.

Definition at line 902 of file libxvid.c.

Function Documentation

static av_cold int xvid_encode_close ( AVCodecContext avctx)
static

Definition at line 874 of file libxvid.c.

static int xvid_encode_frame ( AVCodecContext avctx,
AVPacket pkt,
const AVFrame picture,
int got_packet 
)
static

Definition at line 733 of file libxvid.c.

Referenced by xvid_encode_init().

static int xvid_ff_2pass_create ( xvid_plg_create_t *  param,
void **  handle 
)
static

Initialize the two-pass plugin and context.

Parameters
paramInput construction parameter structure
handlePrivate context handle
Returns
Returns XVID_ERR_xxxx on failure, or 0 on success.

Definition at line 120 of file libxvid.c.

Referenced by xvid_ff_2pass().

static int xvid_ff_2pass_destroy ( struct xvid_context ref,
xvid_plg_destroy_t *  param 
)
static

Destroy the two-pass plugin context.

Parameters
refContext pointer for the plugin
paramDestroy context
Returns
Returns 0, success guaranteed

Definition at line 151 of file libxvid.c.

Referenced by xvid_ff_2pass().

static int xvid_ff_2pass_before ( struct xvid_context ref,
xvid_plg_data_t *  param 
)
static

Enable fast encode mode during the first pass.

Parameters
refContext pointer for the plugin
paramFrame data
Returns
Returns 0, success guaranteed

Definition at line 168 of file libxvid.c.

Referenced by xvid_ff_2pass().

static int xvid_ff_2pass_after ( struct xvid_context ref,
xvid_plg_data_t *  param 
)
static

Capture statistic data and write it during first pass.

Parameters
refContext pointer for the plugin
paramStatistic data
Returns
Returns XVID_ERR_xxxx on failure, or 0 on success

Definition at line 212 of file libxvid.c.

Referenced by xvid_ff_2pass().

static int xvid_ff_2pass ( void ref,
int  cmd,
void p1,
void p2 
)
static

Dispatch function for our custom plugin.

This handles the dispatch for the Xvid plugin. It passes data on to other functions for actual processing.

Parameters
refContext pointer for the plugin
cmdThe task given for us to complete
p1First parameter (varies)
p2Second parameter (varies)
Returns
Returns XVID_ERR_xxxx on failure, or 0 on success

Definition at line 249 of file libxvid.c.

Referenced by xvid_encode_init().

static int xvid_strip_vol_header ( AVCodecContext avctx,
AVPacket pkt,
unsigned int  header_len,
unsigned int  frame_len 
)
static

Routine to create a global VO/VOL header for MP4 container.

What we do here is extract the header from the Xvid bitstream as it is encoded. We also strip the repeated headers from the bitstream when a global header is requested for MPEG-4 ISO compliance.

Parameters
avctxAVCodecContext pointer to context
framePointer to encoded frame data
header_lenLength of header to search
frame_lenLength of encoded frame data
Returns
Returns new length of frame data

Definition at line 281 of file libxvid.c.

Referenced by xvid_encode_frame().

static void xvid_correct_framerate ( AVCodecContext avctx)
static

Routine to correct a possibly erroneous framerate being fed to us.

Xvid currently chokes on framerates where the ticks per frame is extremely large. This function works to correct problems in this area by estimating a new framerate and taking the simpler fraction of the two presented.

Parameters
avctxContext that contains the framerate to correct.

Definition at line 323 of file libxvid.c.

Referenced by xvid_encode_init().

static av_cold int xvid_encode_init ( AVCodecContext avctx)
static

Definition at line 373 of file libxvid.c.

Variable Documentation

const AVOption options[]
static
Initial value:
= {
{ "lumi_aq", "Luminance masking AQ", OFFSET(lumi_aq), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, 1, VE },
{ "variance_aq", "Variance AQ", OFFSET(variance_aq), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, 1, VE },
{ "ssim", "Show SSIM information to stdout", OFFSET(ssim), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, 2, VE, "ssim" },
{ "off", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = 0 }, INT_MIN, INT_MAX, VE, "ssim" },
{ "avg", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = 1 }, INT_MIN, INT_MAX, VE, "ssim" },
{ "frame", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = 2 }, INT_MIN, INT_MAX, VE, "ssim" },
{ "ssim_acc", "SSIM accuracy", OFFSET(ssim_acc), AV_OPT_TYPE_INT, { .i64 = 2 }, 0, 4, VE },
{ "gmc", "use GMC", OFFSET(gmc), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, 1, VE },
{ "me_quality", "Motion estimation quality", OFFSET(me_quality), AV_OPT_TYPE_INT, { .i64 = 4 }, 0, 6, VE },
{ "mpeg_quant", "Use MPEG quantizers instead of H.263", OFFSET(mpeg_quant), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, 1, VE },
{ NULL },
}
#define NULL
Definition: coverity.c:32
#define OFFSET(x)
Definition: libxvid.c:901
#define VE
Definition: libxvid.c:902

Definition at line 903 of file libxvid.c.

const AVClass xvid_class
static
Initial value:
= {
.class_name = "libxvid",
.item_name = av_default_item_name,
.option = options,
}
#define LIBAVUTIL_VERSION_INT
Definition: version.h:85
const char * av_default_item_name(void *ptr)
Return the context name.
Definition: log.c:191
static const AVOption options[]
Definition: libxvid.c:903

Definition at line 917 of file libxvid.c.

AVCodec ff_libxvid_encoder
Initial value:
= {
.name = "libxvid",
.long_name = NULL_IF_CONFIG_SMALL("libxvidcore MPEG-4 part 2"),
.priv_data_size = sizeof(struct xvid_context),
.encode2 = xvid_encode_frame,
.pix_fmts = (const enum AVPixelFormat[]) { AV_PIX_FMT_YUV420P, AV_PIX_FMT_NONE },
.priv_class = &xvid_class,
.caps_internal = FF_CODEC_CAP_INIT_THREADSAFE |
.wrapper_name = "libxvid",
}
#define FF_CODEC_CAP_INIT_CLEANUP
The codec allows calling the close function for deallocation even if the init function returned a fai...
Definition: internal.h:48
static av_cold int init(AVCodecContext *avctx)
Definition: avrndec.c:35
#define FF_CODEC_CAP_INIT_THREADSAFE
The codec does not modify any global variables in the init function, allowing to call the init functi...
Definition: internal.h:40
static int xvid_encode_frame(AVCodecContext *avctx, AVPacket *pkt, const AVFrame *picture, int *got_packet)
Definition: libxvid.c:733
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification. ...
Definition: internal.h:186
static int xvid_encode_close(AVCodecContext *avctx)
Definition: libxvid.c:874
Structure for the private Xvid context.
Definition: libxvid.c:65
static const AVClass xvid_class
Definition: libxvid.c:917
static av_cold int xvid_encode_init(AVCodecContext *avctx)
Definition: libxvid.c:373
planar YUV 4:2:0, 12bpp, (1 Cr & Cb sample per 2x2 Y samples)
Definition: pixfmt.h:62
AVPixelFormat
Pixel format.
Definition: pixfmt.h:60

Definition at line 924 of file libxvid.c.