libmpcodecs/ve_xvid4.c

   1 /*****************************************************************************
   2  *
   3  *  - XviD 1.x export module for mplayer/mencoder -
   4  *
   5  *  Copyright(C) 2003      Marco Belli <elcabesa@inwind.it>
   6  *               2003-2004 Edouard Gomez <ed.gomez@free.fr>
   7  *
   8  *  This program is free software; you can redistribute it and/or modify
   9  *  it under the terms of the GNU General Public License as published by
  10  *  the Free Software Foundation; either version 2 of the License, or
  11  *  (at your option) any later version.
  12  *
  13  *  This program is distributed in the hope that it will be useful,
  14  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  *  GNU General Public License for more details.
  17  *
  18  *  You should have received a copy of the GNU General Public License
  19  *  along with this program; if not, write to the Free Software
  20  *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  21  *
  22  ****************************************************************************/
  23
  24 /*****************************************************************************
  25  * Includes
  26  ****************************************************************************/
  27
  28 #include <stdio.h>
  29 #include <stdlib.h>
  30 #include <string.h>
  31 #include <errno.h>
  32 #include <math.h>
  33 #include <limits.h>
  34 #include <time.h>
  35
  36 #include "config.h"
  37 #include "mp_msg.h"
  38
  39 #include "codec-cfg.h"
  40 #include "stream/stream.h"
  41 #include "libmpdemux/demuxer.h"
  42 #include "libmpdemux/stheader.h"
  43
  44 #include "stream/stream.h"
  45 #include "libmpdemux/muxer.h"
  46
  47 #include "img_format.h"
  48 #include "mp_image.h"
  49 #include "vf.h"
  50
  51 #include <xvid.h>
  52 #include <stdio.h>
  53 #include <stdarg.h>
  54 #include <limits.h>
  55 #include <assert.h>
  56
  57 #include "m_option.h"
  58
  59 #ifdef USE_LIBAVUTIL_SO
  60 #include <ffmpeg/avutil.h>
  61 #else
  62 #include "avutil.h"
  63 #endif
  64
  65 #define FINE (!0)
  66 #define BAD (!FINE)
  67
  68 #define MAX_ZONES   64
  69
  70 // Profile flag definitions
  71 #define PROFILE_ADAPTQUANT 0x00000001
  72 #define PROFILE_BVOP       0x00000002
  73 #define PROFILE_MPEGQUANT  0x00000004
  74 #define PROFILE_INTERLACE  0x00000008
  75 #define PROFILE_QPEL       0x00000010
  76 #define PROFILE_GMC        0x00000020
  77 #define PROFILE_4MV        0x00000040
  78 #define PROFILE_DXN        0x00000080
  79
  80 // Reduce code duplication in profiles[] array
  81 #define PROFILE_S   (PROFILE_4MV)
  82 #define PROFILE_AS  (PROFILE_4MV|PROFILE_ADAPTQUANT|PROFILE_BVOP|PROFILE_MPEGQUANT|PROFILE_INTERLACE|PROFILE_QPEL|PROFILE_GMC)
  83
  84 typedef const struct
  85 {
  86         char *name;                  ///< profile name
  87         int id;                      ///< mpeg-4 profile id; iso/iec 14496-2:2001 table G-1
  88         int width;                   ///< profile width restriction
  89         int height;                  ///< profile height restriction
  90         int fps;                     ///< profile frame rate restriction
  91         int max_objects;             ///< ??????
  92         int total_vmv_buffer_sz;     ///< macroblock memory; when BVOPS=false, vmv = 2*vcv; when BVOPS=true,  vmv = 3*vcv
  93         int max_vmv_buffer_sz;       ///< max macroblocks per vop
  94         int vcv_decoder_rate;        ///< macroblocks decoded per second
  95         int max_acpred_mbs;          ///< percentage
  96         int max_vbv_size;            ///< max vbv size (bits) 16368 bits
  97         int max_video_packet_length; ///< bits
  98         int max_bitrate;             ///< bits per second
  99         int vbv_peakrate;            ///< max bits over anyone second period; 0=don't care
 100         int dxn_max_bframes;         ///< dxn: max consecutive bframes
 101         unsigned int flags;          ///< flags for allowed options/dxn note the definitions for PROFILE_S and PROFILE_AS
 102 } profile_t;
 103
 104 // Code taken from XviD VfW source for profile support
 105
 106 /* default vbv_occupancy is (64/170)*vbv_buffer_size */
 107
 108 static profile_t profiles[] =
 109 {
 110         /*   name               p@l    w    h    fps  obj Tvmv  vmv     vcv  ac%   vbv        pkt     bps    vbv_peak dbf  flags */
 111         /* unrestricted profile (default) */
 112         { "unrestricted",  0x00,    0,   0,  0,  0,    0,    0,      0, 100,   0*16368,    -1,       0,        0, -1, 0xffffffff & ~PROFILE_DXN },
 113
 114         { "sp0",           0x08,  176, 144, 15,  1,  198,   99,   1485, 100,  10*16368,  2048,   64000,        0, -1, PROFILE_S },
 115         /* simple@l0: max f_code=1, intra_dc_vlc_threshold=0 */
 116         /* if ac preidition is used, adaptive quantization must not be used */
 117         /* <=qcif must be used */
 118         { "sp1",           0x01,  176, 144, 15,  4,  198,   99,   1485, 100,  10*16368,  2048,   64000,        0, -1, PROFILE_S|PROFILE_ADAPTQUANT },
 119         { "sp2",           0x02,  352, 288, 15,  4,  792,  396,   5940, 100,  40*16368,  4096,  128000,        0, -1, PROFILE_S|PROFILE_ADAPTQUANT },
 120         { "sp3",           0x03,  352, 288, 15,  4,  792,  396,  11880, 100,  40*16368,  8192,  384000,        0, -1, PROFILE_S|PROFILE_ADAPTQUANT },
 121
 122         { "asp0",          0xf0,  176, 144, 30,  1,  297,   99,   2970, 100,  10*16368,  2048,  128000,        0, -1, PROFILE_AS },
 123         { "asp1",          0xf1,  176, 144, 30,  4,  297,   99,   2970, 100,  10*16368,  2048,  128000,        0, -1, PROFILE_AS },
 124         { "asp2",          0xf2,  352, 288, 15,  4, 1188,  396,   5940, 100,  40*16368,  4096,  384000,        0, -1, PROFILE_AS },
 125         { "asp3",          0xf3,  352, 288, 30,  4, 1188,  396,  11880, 100,  40*16368,  4096,  768000,        0, -1, PROFILE_AS },
 126         /*  ISMA Profile 1, (ASP) @ L3b (CIF, 1.5 Mb/s) CIF(352x288), 30fps, 1.5Mbps max ??? */
 127         { "asp4",          0xf4,  352, 576, 30,  4, 2376,  792,  23760,  50,  80*16368,  8192, 3000000,        0, -1, PROFILE_AS },
 128         { "asp5",          0xf5,  720, 576, 30,  4, 4860, 1620,  48600,  25, 112*16368, 16384, 8000000,        0, -1, PROFILE_AS },
 129
 130         //      information provided by DivXNetworks, USA.
 131         //  "DivX Certified Profile Compatibility v1.1", February 2005
 132         { "dxnhandheld",   0x00,  176, 144, 15,  1,  198,   99,   1485, 100,   32*8192,    -1,  537600,   800000,  0, PROFILE_ADAPTQUANT|PROFILE_DXN },
 133         { "dxnportntsc",   0x00,  352, 240, 30,  1,  990,  330,  36000, 100,  384*8192,    -1, 4854000,  8000000,  1, PROFILE_4MV|PROFILE_ADAPTQUANT|PROFILE_BVOP|PROFILE_DXN },
 134         { "dxnportpal",    0x00,  352, 288, 25,  1, 1188,  396,  36000, 100,  384*8192,    -1, 4854000,  8000000,  1, PROFILE_4MV|PROFILE_ADAPTQUANT|PROFILE_BVOP|PROFILE_DXN },
 135         { "dxnhtntsc",     0x00,  720, 480, 30,  1, 4050, 1350,  40500, 100,  384*8192,    -1, 4854000,  8000000,  1, PROFILE_4MV|PROFILE_ADAPTQUANT|PROFILE_BVOP|PROFILE_INTERLACE|PROFILE_DXN },
 136         { "dxnhtpal",      0x00,  720, 576, 25,  1, 4860, 1620,  40500, 100,  384*8192,    -1, 4854000,  8000000,  1, PROFILE_4MV|PROFILE_ADAPTQUANT|PROFILE_BVOP|PROFILE_INTERLACE|PROFILE_DXN },
 137         { "dxnhdtv",       0x00, 1280, 720, 30,  1,10800, 3600, 108000, 100,  768*8192,    -1, 9708400, 16000000,  2, PROFILE_4MV|PROFILE_ADAPTQUANT|PROFILE_BVOP|PROFILE_INTERLACE|PROFILE_DXN },
 138
 139         { NULL,            0x00,    0,   0,  0,  0,    0,    0,      0,   0,         0,     0,       0,        0,  0, 0x00000000 },
 140 };
 141
 142 /**
 143  * \brief return the pointer to a chosen profile
 144  * \param str the profile name
 145  * \return pointer of the appropriate profiles array entry or NULL for a mistyped profile name
 146  */
 147 static profile_t *profileFromName(char *str)
 148 {
 149         profile_t *cur = profiles;
 150         while (cur->name && strcasecmp(cur->name, str)) cur++;
 151         if(!cur->name) return NULL;
 152         return cur;
 153 }
 154
 155 /*****************************************************************************
 156  * Configuration options
 157  ****************************************************************************/
 158
 159 extern char* passtmpfile;
 160
 161 static int xvidenc_bitrate = 0;
 162 static int xvidenc_pass = 0;
 163 static float xvidenc_quantizer = 0;
 164
 165 static int xvidenc_packed = 0;
 166 static int xvidenc_closed_gop = 1;
 167 static int xvidenc_interlaced = 0;
 168 static int xvidenc_quarterpel = 0;
 169 static int xvidenc_gmc = 0;
 170 static int xvidenc_trellis = 1;
 171 static int xvidenc_cartoon = 0;
 172 static int xvidenc_hqacpred = 1;
 173 static int xvidenc_chromame = 1;
 174 static int xvidenc_chroma_opt = 0;
 175 static int xvidenc_vhq = 1;
 176 static int xvidenc_bvhq = 1;
 177 static int xvidenc_motion = 6;
 178 static int xvidenc_turbo = 0;
 179 static int xvidenc_stats = 0;
 180 static int xvidenc_max_key_interval = 0; /* Let xvidcore set a 10s interval by default */
 181 static int xvidenc_frame_drop_ratio = 0;
 182 static int xvidenc_greyscale = 0;
 183 static int xvidenc_luminance_masking = 0;
 184 static int xvidenc_debug = 0;
 185 static int xvidenc_psnr = 0;
 186
 187 static int xvidenc_max_bframes = 2;
 188 static int xvidenc_num_threads = 0;
 189 static int xvidenc_bquant_ratio = 150;
 190 static int xvidenc_bquant_offset = 100;
 191 static int xvidenc_bframe_threshold = 0;
 192
 193 static int xvidenc_min_quant[3] = {2, 2, 2};
 194 static int xvidenc_max_quant[3] = {31, 31, 31};
 195 static char *xvidenc_intra_matrix_file = NULL;
 196 static char *xvidenc_inter_matrix_file = NULL;
 197 static char *xvidenc_quant_method = NULL;
 198
 199 static int xvidenc_cbr_reaction_delay_factor = 0;
 200 static int xvidenc_cbr_averaging_period = 0;
 201 static int xvidenc_cbr_buffer = 0;
 202
 203 static int xvidenc_vbr_keyframe_boost = 0;
 204 static int xvidenc_vbr_overflow_control_strength = 5;
 205 static int xvidenc_vbr_curve_compression_high = 0;
 206 static int xvidenc_vbr_curve_compression_low = 0;
 207 static int xvidenc_vbr_max_overflow_improvement = 5;
 208 static int xvidenc_vbr_max_overflow_degradation = 5;
 209 static int xvidenc_vbr_kfreduction = 0;
 210 static int xvidenc_vbr_kfthreshold = 0;
 211 static int xvidenc_vbr_container_frame_overhead = 24; /* mencoder uses AVI container */
 212
 213 // commandline profile option string - default to unrestricted
 214 static char *xvidenc_profile = "unrestricted";
 215
 216 static char *xvidenc_par = NULL;
 217 static int xvidenc_par_width = 0;
 218 static int xvidenc_par_height = 0;
 219 static float xvidenc_dar_aspect = 0.0f;
 220 static int xvidenc_autoaspect = 0;
 221
 222 static char *xvidenc_zones = NULL; // zones string
 223
 224 m_option_t xvidencopts_conf[] =
 225 {
 226         /* Standard things mencoder should be able to treat directly */
 227         {"bitrate", &xvidenc_bitrate, CONF_TYPE_INT, 0, 0, 0, NULL},
 228         {"pass", &xvidenc_pass, CONF_TYPE_INT, CONF_RANGE, 1, 2, NULL},
 229         {"fixed_quant", &xvidenc_quantizer, CONF_TYPE_FLOAT, CONF_RANGE, 1, 31, NULL},
 230
 231         /* Features */
 232         {"quant_type", &xvidenc_quant_method, CONF_TYPE_STRING, 0, 0, 0, NULL},
 233         {"me_quality", &xvidenc_motion, CONF_TYPE_INT, CONF_RANGE, 0, 6, NULL},
 234         {"chroma_me", &xvidenc_chromame, CONF_TYPE_FLAG, 0, 0, 1, NULL},
 235         {"nochroma_me", &xvidenc_chromame, CONF_TYPE_FLAG, 0, 1, 0, NULL},
 236         {"chroma_opt", &xvidenc_chroma_opt, CONF_TYPE_FLAG, 0, 0, 1, NULL},
 237         {"nochroma_opt", &xvidenc_chroma_opt, CONF_TYPE_FLAG, 0, 1, 0, NULL},
 238         {"vhq", &xvidenc_vhq, CONF_TYPE_INT, CONF_RANGE, 0, 4, NULL},
 239         {"bvhq", &xvidenc_bvhq, CONF_TYPE_INT, CONF_RANGE, 0, 1, NULL},
 240         {"max_bframes", &xvidenc_max_bframes, CONF_TYPE_INT, CONF_RANGE, 0, 20, NULL},
 241         {"threads", &xvidenc_num_threads, CONF_TYPE_INT, 0, 0, 0, NULL},
 242         {"bquant_ratio", &xvidenc_bquant_ratio, CONF_TYPE_INT, CONF_RANGE, 0, 200, NULL},
 243         {"bquant_offset", &xvidenc_bquant_offset, CONF_TYPE_INT, CONF_RANGE, 0, 200, NULL},
 244         {"bf_threshold", &xvidenc_bframe_threshold, CONF_TYPE_INT, CONF_RANGE, -255, 255, NULL},
 245         {"qpel", &xvidenc_quarterpel, CONF_TYPE_FLAG, 0, 0, 1, NULL},
 246         {"noqpel", &xvidenc_quarterpel, CONF_TYPE_FLAG, 0, 1, 0, NULL},
 247         {"gmc", &xvidenc_gmc, CONF_TYPE_FLAG, 0, 0, 1, NULL},
 248         {"nogmc", &xvidenc_gmc, CONF_TYPE_FLAG, 0, 1, 0, NULL},
 249         {"trellis", &xvidenc_trellis, CONF_TYPE_FLAG, 0, 0, 1, NULL},
 250         {"notrellis", &xvidenc_trellis, CONF_TYPE_FLAG, 0, 1, 0, NULL},
 251         {"packed", &xvidenc_packed, CONF_TYPE_FLAG, 0, 0, 1, NULL},
 252         {"nopacked", &xvidenc_packed, CONF_TYPE_FLAG, 0, 1, 0, NULL},
 253         {"closed_gop", &xvidenc_closed_gop, CONF_TYPE_FLAG, 0, 0, 1, NULL},
 254         {"noclosed_gop", &xvidenc_closed_gop, CONF_TYPE_FLAG, 0, 1, 0, NULL},
 255         {"interlacing", &xvidenc_interlaced, CONF_TYPE_FLAG, 0, 0, 1, NULL},
 256         {"nointerlacing", &xvidenc_interlaced, CONF_TYPE_FLAG, 0, 1, 0, NULL},
 257         {"cartoon", &xvidenc_cartoon, CONF_TYPE_FLAG, 0, 0, 1, NULL},
 258         {"nocartoon", &xvidenc_cartoon, CONF_TYPE_FLAG, 0, 1, 0, NULL},
 259         {"hq_ac", &xvidenc_hqacpred, CONF_TYPE_FLAG, 0, 0, 1, NULL},
 260         {"nohq_ac", &xvidenc_hqacpred, CONF_TYPE_FLAG, 0, 1, 0, NULL},
 261         {"frame_drop_ratio", &xvidenc_frame_drop_ratio, CONF_TYPE_INT, CONF_RANGE, 0, 100, NULL},
 262         {"max_key_interval", &xvidenc_max_key_interval, CONF_TYPE_INT, CONF_MIN, 0, 0, NULL},
 263         {"greyscale", &xvidenc_greyscale, CONF_TYPE_FLAG, 0, 0, 1, NULL}, /* kept for backward compatibility */
 264         {"grayscale", &xvidenc_greyscale, CONF_TYPE_FLAG, 0, 0, 1, NULL},
 265         {"nogreyscale", &xvidenc_greyscale, CONF_TYPE_FLAG, 0, 1, 0, NULL},
 266         {"lumi_mask", &xvidenc_luminance_masking, CONF_TYPE_FLAG, 0, 0, 1, NULL},
 267         {"nolumi_mask", &xvidenc_luminance_masking, CONF_TYPE_FLAG, 0, 1, 0, NULL},
 268         {"turbo", &xvidenc_turbo, CONF_TYPE_FLAG, 0, 0, 1, NULL},
 269         {"debug", &xvidenc_debug, CONF_TYPE_INT , 0 ,0,-1,NULL},
 270         {"stats", &xvidenc_stats, CONF_TYPE_FLAG, 0, 0, 1, NULL},
 271         {"psnr",  &xvidenc_psnr , CONF_TYPE_FLAG, 0, 0, 1, NULL},
 272
 273
 274         /* section [quantizer] */
 275         {"min_iquant", &xvidenc_min_quant[0], CONF_TYPE_INT, CONF_RANGE, 1, 31, NULL},
 276         {"max_iquant", &xvidenc_max_quant[0], CONF_TYPE_INT, CONF_RANGE, 1, 31, NULL},
 277         {"min_pquant", &xvidenc_min_quant[1], CONF_TYPE_INT, CONF_RANGE, 1, 31, NULL},
 278         {"max_pquant", &xvidenc_max_quant[1], CONF_TYPE_INT, CONF_RANGE, 1, 31, NULL},
 279         {"min_bquant", &xvidenc_min_quant[2], CONF_TYPE_INT, CONF_RANGE, 1, 31, NULL},
 280         {"max_bquant", &xvidenc_max_quant[2], CONF_TYPE_INT, CONF_RANGE, 1, 31, NULL},
 281         {"quant_intra_matrix", &xvidenc_intra_matrix_file, CONF_TYPE_STRING, 0, 0, 100, NULL},
 282         {"quant_inter_matrix", &xvidenc_inter_matrix_file, CONF_TYPE_STRING, 0, 0, 100, NULL},
 283
 284         /* section [cbr] */
 285         {"rc_reaction_delay_factor", &xvidenc_cbr_reaction_delay_factor, CONF_TYPE_INT, CONF_RANGE, 0, 100, NULL},
 286         {"rc_averaging_period", &xvidenc_cbr_averaging_period, CONF_TYPE_INT, CONF_MIN, 0, 0, NULL},
 287         {"rc_buffer", &xvidenc_cbr_buffer, CONF_TYPE_INT, CONF_MIN, 0, 0, NULL},
 288
 289         /* section [vbr] */
 290         {"keyframe_boost", &xvidenc_vbr_keyframe_boost, CONF_TYPE_INT, CONF_RANGE, 0, 100, NULL},
 291         {"curve_compression_high", &xvidenc_vbr_curve_compression_high, CONF_TYPE_INT, CONF_RANGE, 0, 100, NULL},
 292         {"curve_compression_low", &xvidenc_vbr_curve_compression_low, CONF_TYPE_INT, CONF_RANGE, 0, 100, NULL},
 293         {"overflow_control_strength", &xvidenc_vbr_overflow_control_strength, CONF_TYPE_INT, CONF_RANGE, 0, 100, NULL},
 294         {"max_overflow_improvement", &xvidenc_vbr_max_overflow_improvement, CONF_TYPE_INT, CONF_RANGE, 0, 100, NULL},
 295         {"max_overflow_degradation", &xvidenc_vbr_max_overflow_degradation, CONF_TYPE_INT, CONF_RANGE, 0, 100, NULL},
 296         {"kfreduction", &xvidenc_vbr_kfreduction, CONF_TYPE_INT, CONF_RANGE, 0, 100, NULL},
 297         {"kfthreshold", &xvidenc_vbr_kfthreshold, CONF_TYPE_INT, CONF_MIN, 0, 0, NULL},
 298         {"container_frame_overhead", &xvidenc_vbr_container_frame_overhead, CONF_TYPE_INT, CONF_MIN, 0, 0, NULL},
 299
 300         /* Section Aspect Ratio */
 301         {"par", &xvidenc_par, CONF_TYPE_STRING, 0, 0, 0, NULL},
 302         {"par_width", &xvidenc_par_width, CONF_TYPE_INT, CONF_RANGE, 0, 255, NULL},
 303         {"par_height", &xvidenc_par_height, CONF_TYPE_INT, CONF_RANGE, 0, 255, NULL},
 304         {"aspect", &xvidenc_dar_aspect, CONF_TYPE_FLOAT, CONF_RANGE, 0.1, 9.99, NULL},
 305         {"autoaspect", &xvidenc_autoaspect, CONF_TYPE_FLAG, 0, 0, 1, NULL},
 306         {"noautoaspect", &xvidenc_autoaspect, CONF_TYPE_FLAG, 0, 1, 0, NULL},
 307
 308         /* Section Zones */
 309         {"zones", &xvidenc_zones, CONF_TYPE_STRING, 0, 0, 0, NULL},
 310
 311         /* section profiles */
 312         {"profile", &xvidenc_profile, CONF_TYPE_STRING, 0, 0, 0, NULL},
 313
 314         /* End of the config array */
 315         {NULL, 0, 0, 0, 0, 0, NULL}
 316 };
 317
 318 /*****************************************************************************
 319  * Module private data
 320  ****************************************************************************/
 321
 322 typedef struct _xvid_mplayer_module_t
 323 {
 324         /* Instance related global vars */
 325         void *instance;
 326         xvid_gbl_init_t      init;
 327         xvid_enc_create_t    create;
 328         xvid_enc_frame_t     frame;
 329         xvid_plugin_single_t onepass;
 330         xvid_plugin_2pass1_t pass1;
 331         xvid_plugin_2pass2_t pass2;
 332
 333         /* This data must survive local block scope, so here it is */
 334         xvid_enc_plugin_t    plugins[7];
 335         xvid_enc_zone_t      zones[MAX_ZONES];
 336
 337         /* MPEG4 stream buffer */
 338         muxer_stream_t *mux;
 339
 340         /* Stats accumulators */
 341         int frames;
 342         long long sse_y;
 343         long long sse_u;
 344         long long sse_v;
 345
 346         /* Min & Max PSNR */
 347         int min_sse_y;
 348         int min_sse_u;
 349         int min_sse_v;
 350         int min_framenum;
 351         int max_sse_y;
 352         int max_sse_u;
 353         int max_sse_v;
 354         int max_framenum;
 355
 356         int pixels;
 357
 358         /* DAR/PAR and all that thingies */
 359         int d_width;
 360         int d_height;
 361         FILE *fvstats;
 362 } xvid_mplayer_module_t;
 363
 364 static int dispatch_settings(xvid_mplayer_module_t *mod);
 365 static int set_create_struct(xvid_mplayer_module_t *mod);
 366 static int set_frame_struct(xvid_mplayer_module_t *mod, mp_image_t *mpi);
 367 static void update_stats(xvid_mplayer_module_t *mod, xvid_enc_stats_t *stats);
 368 static void print_stats(xvid_mplayer_module_t *mod);
 369 static void flush_internal_buffers(xvid_mplayer_module_t *mod);
 370 static const char *par_string(int parcode);
 371 static const char *errorstring(int err);
 372
 373 /*****************************************************************************
 374  * Video Filter API function definitions
 375  ****************************************************************************/
 376
 377 /*============================================================================
 378  * config
 379  *==========================================================================*/
 380
 381 static int
 382 config(struct vf_instance_s* vf,
 383        int width, int height, int d_width, int d_height,
 384        unsigned int flags, unsigned int outfmt)
 385 {
 386         int err;
 387         xvid_mplayer_module_t *mod = (xvid_mplayer_module_t *)vf->priv;
 388
 389         /* Complete the muxer initialization */
 390         mod->mux->bih->biWidth = width;
 391         mod->mux->bih->biHeight = height;
 392         mod->mux->bih->biSizeImage =
 393                 mod->mux->bih->biWidth * mod->mux->bih->biHeight * 3 / 2;
 394         mod->mux->aspect = (float)d_width/d_height;
 395
 396         /* Message the FourCC type */
 397         mp_msg(MSGT_MENCODER, MSGL_INFO,
 398                "videocodec: XviD (%dx%d fourcc=%x [%.4s])\n",
 399                width, height, mod->mux->bih->biCompression,
 400                (char *)&mod->mux->bih->biCompression);
 401
 402         /* Total number of pixels per frame required for PSNR */
 403         mod->pixels = mod->mux->bih->biWidth*mod->mux->bih->biHeight;
 404
 405         /*--------------------------------------------------------------------
 406          * Dispatch all module settings to XviD structures
 407          *------------------------------------------------------------------*/
 408
 409         mod->d_width = d_width;
 410         mod->d_height = d_height;
 411
 412         if(dispatch_settings(mod) == BAD)
 413                 return(BAD);
 414
 415         /*--------------------------------------------------------------------
 416          * Set remaining information in the xvid_enc_create_t structure
 417          *------------------------------------------------------------------*/
 418
 419         if(set_create_struct(mod) == BAD)
 420                 return(BAD);
 421
 422         /*--------------------------------------------------------------------
 423          * Encoder instance creation
 424          *------------------------------------------------------------------*/
 425
 426         err = xvid_encore(NULL, XVID_ENC_CREATE, &mod->create, NULL);
 427
 428         if(err<0) {
 429                 mp_msg(MSGT_MENCODER, MSGL_ERR,
 430                        "xvid: xvidcore returned a '%s' error\n", errorstring(err));
 431                 return(BAD);
 432         }
 433
 434         /* Store the encoder instance into the private data */
 435         mod->instance = mod->create.handle;
 436
 437         mod->mux->decoder_delay = mod->create.max_bframes ? 1 : 0;
 438
 439         return(FINE);
 440 }
 441
 442 /*============================================================================
 443  * uninit
 444  *==========================================================================*/
 445
 446 static void
 447 uninit(struct vf_instance_s* vf)
 448 {
 449
 450         xvid_mplayer_module_t *mod = (xvid_mplayer_module_t *)vf->priv;
 451
 452         /* Destroy xvid instance */
 453         xvid_encore(mod->instance, XVID_ENC_DESTROY, NULL, NULL);
 454
 455         /* Display stats (if any) */
 456         print_stats(mod);
 457
 458         /* Close PSNR file if ever opened */
 459         if (mod->fvstats) {
 460                 fclose(mod->fvstats);
 461                 mod->fvstats = NULL;
 462         }
 463
 464         /* Free allocated memory */
 465         if(mod->frame.quant_intra_matrix)
 466             free(mod->frame.quant_intra_matrix);
 467
 468         if(mod->frame.quant_inter_matrix)
 469             free(mod->frame.quant_inter_matrix);
 470
 471         if(mod->mux->bih)
 472             free(mod->mux->bih);
 473
 474         free(vf->priv);
 475         vf->priv=NULL;
 476
 477         return;
 478 }
 479
 480 /*============================================================================
 481  * control
 482  *==========================================================================*/
 483
 484 static int
 485 control(struct vf_instance_s* vf, int request, void* data)
 486 {
 487 xvid_mplayer_module_t *mod = (xvid_mplayer_module_t *)vf->priv;
 488
 489         switch(request){
 490             case  VFCTRL_FLUSH_FRAMES:
 491             if(mod)/*paranoid*/
 492                 flush_internal_buffers(mod);
 493             break;
 494         }
 495         return(CONTROL_UNKNOWN);
 496 }
 497
 498 /*============================================================================
 499  * query_format
 500  *==========================================================================*/
 501
 502 static int
 503 query_format(struct vf_instance_s* vf, unsigned int fmt)
 504 {
 505         switch(fmt){
 506         case IMGFMT_YV12:
 507         case IMGFMT_IYUV:
 508         case IMGFMT_I420:
 509                 return(VFCAP_CSP_SUPPORTED | VFCAP_CSP_SUPPORTED_BY_HW);
 510         case IMGFMT_YUY2:
 511         case IMGFMT_UYVY:
 512                 return(VFCAP_CSP_SUPPORTED);
 513         }
 514         return(BAD);
 515 }
 516
 517 /*============================================================================
 518  * put_image
 519  *==========================================================================*/
 520
 521 static int
 522 put_image(struct vf_instance_s* vf, mp_image_t *mpi, double pts)
 523 {
 524         int size;
 525         xvid_enc_stats_t stats;
 526         xvid_mplayer_module_t *mod = (xvid_mplayer_module_t *)vf->priv;
 527
 528         /* Prepare the stats */
 529         memset(&stats,0,sizeof( xvid_enc_stats_t));
 530         stats.version = XVID_VERSION;
 531
 532         /* -------------------------------------------------------------------
 533          * Set remaining information in the xvid_enc_frame_t structure
 534          * NB: all the other struct members were initialized by
 535          *     dispatch_settings
 536          * -----------------------------------------------------------------*/
 537
 538         if(set_frame_struct(mod, mpi) == BAD)
 539                 return(BAD);
 540
 541         /* -------------------------------------------------------------------
 542          * Encode the frame
 543          * ---------------------------------------------------------------- */
 544
 545         size = xvid_encore(mod->instance, XVID_ENC_ENCODE, &mod->frame, &stats);
 546
 547         /* Analyse the returned value */
 548         if(size<0) {
 549                 mp_msg(MSGT_MENCODER, MSGL_ERR,
 550                        "xvid: xvidcore returned a '%s' error\n", errorstring(size));
 551                 return(BAD);
 552         }
 553
 554         /* If size is == 0, we're done with that frame */
 555         if(size == 0) {
 556                 ++mod->mux->encoder_delay;
 557                 return(FINE);
 558         }
 559
 560         /* xvidcore returns stats about encoded frame in an asynchronous way
 561          * accumulate these stats */
 562         update_stats(mod, &stats);
 563
 564         /* xvidcore outputed bitstream -- mux it */
 565         muxer_write_chunk(mod->mux,
 566                           size,
 567                           (mod->frame.out_flags & XVID_KEYFRAME)?0x10:0, MP_NOPTS_VALUE, MP_NOPTS_VALUE);
 568
 569         return(FINE);
 570 }
 571
 572 /*============================================================================
 573  * vf_open
 574  *==========================================================================*/
 575
 576 static int
 577 vf_open(vf_instance_t *vf, char* args)
 578 {
 579         xvid_mplayer_module_t *mod;
 580         xvid_gbl_init_t xvid_gbl_init;
 581         xvid_gbl_info_t xvid_gbl_info;
 582
 583         /* Setting libmpcodec module API pointers */
 584         vf->config       = config;
 585         vf->default_caps = VFCAP_CONSTANT;
 586         vf->control      = control;
 587         vf->uninit       = uninit;
 588         vf->query_format = query_format;
 589         vf->put_image    = put_image;
 590
 591         /* Allocate the private part of the codec module */
 592         vf->priv = malloc(sizeof(xvid_mplayer_module_t));
 593         mod = (xvid_mplayer_module_t*)vf->priv;
 594
 595         if(mod == NULL) {
 596                 mp_msg(MSGT_MENCODER,MSGL_ERR,
 597                        "xvid: memory allocation failure (private data)\n");
 598                 return(BAD);
 599         }
 600
 601         /* Initialize the module to zeros */
 602         memset(mod, 0, sizeof(xvid_mplayer_module_t));
 603         mod->min_sse_y = mod->min_sse_u = mod->min_sse_v = INT_MAX;
 604         mod->max_sse_y = mod->max_sse_u = mod->max_sse_v = INT_MIN;
 605
 606         /* Bind the Muxer */
 607         mod->mux = (muxer_stream_t*)args;
 608
 609         /* Initialize muxer BITMAP header */
 610         mod->mux->bih = calloc(1, sizeof(BITMAPINFOHEADER));
 611
 612         if(mod->mux->bih  == NULL) {
 613                 mp_msg(MSGT_MENCODER,MSGL_ERR,
 614                        "xvid: memory allocation failure (BITMAP header)\n");
 615                 return(BAD);
 616         }
 617
 618         mod->mux->bih->biSize = sizeof(BITMAPINFOHEADER);
 619         mod->mux->bih->biWidth = 0;
 620         mod->mux->bih->biHeight = 0;
 621         mod->mux->bih->biPlanes = 1;
 622         mod->mux->bih->biBitCount = 12;
 623         mod->mux->bih->biCompression = mmioFOURCC('X','V','I','D');
 624
 625         /* Retrieve information about the host XviD library */
 626         memset(&xvid_gbl_info, 0, sizeof(xvid_gbl_info_t));
 627         xvid_gbl_info.version = XVID_VERSION;
 628
 629         if (xvid_global(NULL, XVID_GBL_INFO, &xvid_gbl_info, NULL) < 0) {
 630                 mp_msg(MSGT_MENCODER,MSGL_WARN, "xvid: could not get information about the library\n");
 631         } else {
 632                 mp_msg(MSGT_MENCODER,MSGL_INFO, "xvid: using library version %d.%d.%d (build %s)\n",
 633                        XVID_VERSION_MAJOR(xvid_gbl_info.actual_version),
 634                        XVID_VERSION_MINOR(xvid_gbl_info.actual_version),
 635                        XVID_VERSION_PATCH(xvid_gbl_info.actual_version),
 636                        xvid_gbl_info.build);
 637         }
 638
 639         /* Initialize the xvid_gbl_init structure */
 640         memset(&xvid_gbl_init, 0, sizeof(xvid_gbl_init_t));
 641         xvid_gbl_init.version = XVID_VERSION;
 642         xvid_gbl_init.debug = xvidenc_debug;
 643
 644         /* Initialize the xvidcore library */
 645         if (xvid_global(NULL, XVID_GBL_INIT, &xvid_gbl_init, NULL) < 0) {
 646                 mp_msg(MSGT_MENCODER,MSGL_ERR, "xvid: initialisation failure\n");
 647                 return(BAD);
 648         }
 649
 650         return(FINE);
 651 }
 652
 653 /*****************************************************************************
 654  * Helper functions
 655  ****************************************************************************/
 656
 657 static void *read_matrix(unsigned char *filename);
 658
 659 static int dispatch_settings(xvid_mplayer_module_t *mod)
 660 {
 661         xvid_enc_create_t *create     = &mod->create;
 662         xvid_enc_frame_t  *frame      = &mod->frame;
 663         xvid_plugin_single_t *onepass = &mod->onepass;
 664         xvid_plugin_2pass2_t *pass2   = &mod->pass2;
 665         AVRational ar;
 666
 667         const int motion_presets[7] =
 668                 {
 669                         0,
 670                         0,
 671                         0,
 672                         0,
 673                         XVID_ME_HALFPELREFINE16,
 674                         XVID_ME_HALFPELREFINE16 | XVID_ME_ADVANCEDDIAMOND16,
 675                         XVID_ME_HALFPELREFINE16 | XVID_ME_EXTSEARCH16 |
 676                         XVID_ME_HALFPELREFINE8  | XVID_ME_USESQUARES16
 677                 };
 678
 679         //profile is unrestricted as default
 680         profile_t *selected_profile =  profileFromName("unrestricted");
 681         if(xvidenc_profile)
 682                 selected_profile = profileFromName(xvidenc_profile);
 683         if(!selected_profile)
 684         {
 685                 mp_msg(MSGT_MENCODER,MSGL_ERR,
 686                         "xvid:[ERROR] \"%s\" is an invalid profile name\n", xvidenc_profile);
 687                 return(BAD);
 688         }
 689
 690         /* -------------------------------------------------------------------
 691          * Dispatch all settings having an impact on the "create" structure
 692          * This includes plugins as they are passed to encore through the
 693          * create structure
 694          * -----------------------------------------------------------------*/
 695
 696         /* -------------------------------------------------------------------
 697          * The create structure
 698          * ---------------------------------------------------------------- */
 699
 700         create->global = 0;
 701
 702         if(xvidenc_psnr)
 703             xvidenc_stats = 1;
 704
 705         if(xvidenc_stats)
 706                 create->global |= XVID_GLOBAL_EXTRASTATS_ENABLE;
 707
 708         create->num_zones = 0;
 709         create->zones = NULL;
 710         create->num_plugins = 0;
 711         create->plugins = NULL;
 712         create->num_threads = xvidenc_num_threads;
 713
 714         if( (selected_profile->flags & PROFILE_BVOP) &&
 715                 /* dxn: prevent bframes usage if interlacing is selected */
 716                 !((selected_profile->flags & PROFILE_DXN) && xvidenc_interlaced) )
 717         {
 718         create->max_bframes = xvidenc_max_bframes;
 719         create->bquant_ratio = xvidenc_bquant_ratio;
 720         create->bquant_offset = xvidenc_bquant_offset;
 721                 if(xvidenc_packed)
 722                         create->global |= XVID_GLOBAL_PACKED;
 723                 if(xvidenc_closed_gop)
 724                         create->global |= XVID_GLOBAL_CLOSED_GOP;
 725
 726                 /* dxn: restrict max bframes, require closed gop
 727                         and require packed b-frames */
 728                 if(selected_profile->flags & PROFILE_DXN)
 729                 {
 730                         if(create->max_bframes > selected_profile->dxn_max_bframes)
 731                                 create->max_bframes = selected_profile->dxn_max_bframes;
 732                         create->global |= XVID_GLOBAL_CLOSED_GOP;
 733                         create->global |= XVID_GLOBAL_PACKED;
 734                 }
 735         }
 736         else
 737                 create->max_bframes = 0;
 738
 739 #if XVID_API >= XVID_MAKE_API(4,1)
 740         /* dxn: always write divx5 userdata */
 741         if(selected_profile->flags & PROFILE_DXN)
 742                 create->global |= XVID_GLOBAL_DIVX5_USERDATA;
 743 #endif
 744
 745         create->max_key_interval = xvidenc_max_key_interval;
 746         create->frame_drop_ratio = xvidenc_frame_drop_ratio;
 747         create->min_quant[0] = xvidenc_min_quant[0];
 748         create->min_quant[1] = xvidenc_min_quant[1];
 749         create->min_quant[2] = xvidenc_min_quant[2];
 750         create->max_quant[0] = xvidenc_max_quant[0];
 751         create->max_quant[1] = xvidenc_max_quant[1];
 752         create->max_quant[2] = xvidenc_max_quant[2];
 753
 754
 755         /* -------------------------------------------------------------------
 756          * The single pass plugin
 757          * ---------------------------------------------------------------- */
 758
 759         if (xvidenc_bitrate > 16000) onepass->bitrate = xvidenc_bitrate;
 760         else onepass->bitrate = xvidenc_bitrate*1000;
 761         onepass->reaction_delay_factor = xvidenc_cbr_reaction_delay_factor;
 762         onepass->averaging_period = xvidenc_cbr_averaging_period;
 763         onepass->buffer = xvidenc_cbr_buffer;
 764
 765         /* -------------------------------------------------------------------
 766          * The pass2 plugin
 767          * ---------------------------------------------------------------- */
 768
 769         pass2->keyframe_boost = xvidenc_vbr_keyframe_boost;
 770         pass2->overflow_control_strength = xvidenc_vbr_overflow_control_strength;
 771         pass2->curve_compression_high = xvidenc_vbr_curve_compression_high;
 772         pass2->curve_compression_low = xvidenc_vbr_curve_compression_low;
 773         pass2->max_overflow_improvement = xvidenc_vbr_max_overflow_improvement;
 774         pass2->max_overflow_degradation = xvidenc_vbr_max_overflow_degradation;
 775         pass2->kfreduction = xvidenc_vbr_kfreduction;
 776         pass2->kfthreshold = xvidenc_vbr_kfthreshold;
 777         pass2->container_frame_overhead = xvidenc_vbr_container_frame_overhead;
 778
 779         /* VBV */
 780
 781 #if XVID_API >= XVID_MAKE_API(4,1)
 782         pass2->vbv_size = selected_profile->max_vbv_size;
 783         pass2->vbv_initial = (selected_profile->max_vbv_size*3)>>2; /* 75% */
 784         pass2->vbv_maxrate = selected_profile->max_bitrate;
 785         pass2->vbv_peakrate = selected_profile->vbv_peakrate*3;
 786 #endif
 787 // XXX: xvidcore currently provides a "peak bits over 3 seconds" constraint.
 788 // according to the latest dxn literature, a 1 second constraint is now used
 789
 790         create->profile = selected_profile->id;
 791
 792         /* -------------------------------------------------------------------
 793          * The frame structure
 794          * ---------------------------------------------------------------- */
 795         frame->vol_flags = 0;
 796         frame->vop_flags = 0;
 797         frame->motion    = 0;
 798
 799         frame->vop_flags |= XVID_VOP_HALFPEL;
 800         frame->motion    |= motion_presets[xvidenc_motion];
 801
 802         if(xvidenc_stats)
 803                 frame->vol_flags |= XVID_VOL_EXTRASTATS;
 804
 805         if(xvidenc_greyscale)
 806                 frame->vop_flags |= XVID_VOP_GREYSCALE;
 807
 808         if(xvidenc_cartoon) {
 809                 frame->vop_flags |= XVID_VOP_CARTOON;
 810                 frame->motion |= XVID_ME_DETECT_STATIC_MOTION;
 811         }
 812
 813         // MPEG quantisation is only supported in ASP and unrestricted profiles
 814         if((selected_profile->flags & PROFILE_MPEGQUANT) &&
 815                 (xvidenc_quant_method != NULL) &&
 816                 !strcasecmp(xvidenc_quant_method, "mpeg"))
 817         {
 818                 frame->vol_flags |= XVID_VOL_MPEGQUANT;
 819         if(xvidenc_intra_matrix_file != NULL) {
 820                 frame->quant_intra_matrix = (unsigned char*)read_matrix(xvidenc_intra_matrix_file);
 821                 if(frame->quant_intra_matrix != NULL) {
 822                         mp_msg(MSGT_MENCODER, MSGL_INFO, "xvid: Loaded Intra matrix (switching to mpeg quantization type)\n");
 823                         if(xvidenc_quant_method) free(xvidenc_quant_method);
 824                         xvidenc_quant_method = strdup("mpeg");
 825                 }
 826         }
 827         if(xvidenc_inter_matrix_file != NULL) {
 828                 frame->quant_inter_matrix = read_matrix(xvidenc_inter_matrix_file);
 829                 if(frame->quant_inter_matrix) {
 830                         mp_msg(MSGT_MENCODER, MSGL_INFO, "\nxvid: Loaded Inter matrix (switching to mpeg quantization type)\n");
 831                         if(xvidenc_quant_method) free(xvidenc_quant_method);
 832                         xvidenc_quant_method = strdup("mpeg");
 833                 }
 834         }
 835         }
 836         if(xvidenc_quarterpel && (selected_profile->flags & PROFILE_QPEL)) {
 837                 frame->vol_flags |= XVID_VOL_QUARTERPEL;
 838                 frame->motion    |= XVID_ME_QUARTERPELREFINE16;
 839                 frame->motion    |= XVID_ME_QUARTERPELREFINE8;
 840         }
 841         if(xvidenc_gmc && (selected_profile->flags & PROFILE_GMC)) {
 842                 frame->vol_flags |= XVID_VOL_GMC;
 843                 frame->motion    |= XVID_ME_GME_REFINE;
 844         }
 845         if(xvidenc_interlaced && (selected_profile->flags & PROFILE_INTERLACE)) {
 846                 frame->vol_flags |= XVID_VOL_INTERLACING;
 847         }
 848         if(xvidenc_trellis) {
 849                 frame->vop_flags |= XVID_VOP_TRELLISQUANT;
 850         }
 851         if(xvidenc_hqacpred) {
 852                 frame->vop_flags |= XVID_VOP_HQACPRED;
 853         }
 854         if(xvidenc_chroma_opt) {
 855                 frame->vop_flags |= XVID_VOP_CHROMAOPT;
 856         }
 857         if((xvidenc_motion > 4) && (selected_profile->flags & PROFILE_4MV)) {
 858                 frame->vop_flags |= XVID_VOP_INTER4V;
 859         }
 860         if(xvidenc_chromame) {
 861                 frame->motion |= XVID_ME_CHROMA_PVOP;
 862                 frame->motion |= XVID_ME_CHROMA_BVOP;
 863         }
 864         if(xvidenc_vhq >= 1) {
 865                 frame->vop_flags |= XVID_VOP_MODEDECISION_RD;
 866         }
 867         if(xvidenc_vhq >= 2) {
 868                 frame->motion |= XVID_ME_HALFPELREFINE16_RD;
 869                 frame->motion |= XVID_ME_QUARTERPELREFINE16_RD;
 870         }
 871         if(xvidenc_vhq >= 3) {
 872                 frame->motion |= XVID_ME_HALFPELREFINE8_RD;
 873                 frame->motion |= XVID_ME_QUARTERPELREFINE8_RD;
 874                 frame->motion |= XVID_ME_CHECKPREDICTION_RD;
 875         }
 876         if(xvidenc_vhq >= 4) {
 877                 frame->motion |= XVID_ME_EXTSEARCH_RD;
 878         }
 879         if(xvidenc_bvhq >= 1) {
 880 #if XVID_API >= XVID_MAKE_API(4,1)
 881                 frame->vop_flags |= XVID_VOP_RD_BVOP;
 882 #endif
 883         }
 884         if(xvidenc_turbo) {
 885                 frame->motion |= XVID_ME_FASTREFINE16;
 886                 frame->motion |= XVID_ME_FASTREFINE8;
 887                 frame->motion |= XVID_ME_SKIP_DELTASEARCH;
 888                 frame->motion |= XVID_ME_FAST_MODEINTERPOLATE;
 889                 frame->motion |= XVID_ME_BFRAME_EARLYSTOP;
 890         }
 891
 892         /* motion level == 0 means no motion search which is equivalent to
 893          * intra coding only */
 894         if(xvidenc_motion == 0) {
 895                 frame->type = XVID_TYPE_IVOP;
 896         } else {
 897                 frame->type = XVID_TYPE_AUTO;
 898         }
 899
 900         frame->bframe_threshold = xvidenc_bframe_threshold;
 901
 902         /* PAR related initialization */
 903         frame->par = XVID_PAR_11_VGA; /* Default */
 904
 905         if( !(selected_profile->flags & PROFILE_DXN) )
 906         {
 907         if(xvidenc_dar_aspect > 0)
 908             ar = av_d2q(xvidenc_dar_aspect * mod->mux->bih->biHeight / mod->mux->bih->biWidth, 255);
 909         else if(xvidenc_autoaspect)
 910             ar = av_d2q((float)mod->d_width / mod->d_height * mod->mux->bih->biHeight / mod->mux->bih->biWidth, 255);
 911         else ar.num = ar.den = 0;
 912
 913         if(ar.den != 0) {
 914                 if(ar.num == 12 && ar.den == 11)
 915                     frame->par = XVID_PAR_43_PAL;
 916                 else if(ar.num == 10 && ar.den == 11)
 917                     frame->par = XVID_PAR_43_NTSC;
 918                 else if(ar.num == 16 && ar.den == 11)
 919                     frame->par = XVID_PAR_169_PAL;
 920                 else if(ar.num == 40 && ar.den == 33)
 921                     frame->par = XVID_PAR_169_NTSC;
 922                 else
 923                 {
 924                     frame->par = XVID_PAR_EXT;
 925                     frame->par_width = ar.num;
 926                     frame->par_height= ar.den;
 927                 }
 928
 929         } else if(xvidenc_par != NULL) {
 930                 if(strcasecmp(xvidenc_par, "pal43") == 0)
 931                         frame->par = XVID_PAR_43_PAL;
 932                 else if(strcasecmp(xvidenc_par, "pal169") == 0)
 933                         frame->par = XVID_PAR_169_PAL;
 934                 else if(strcasecmp(xvidenc_par, "ntsc43") == 0)
 935                         frame->par = XVID_PAR_43_NTSC;
 936                 else if(strcasecmp(xvidenc_par, "ntsc169") == 0)
 937                         frame->par = XVID_PAR_169_NTSC;
 938                 else if(strcasecmp(xvidenc_par, "ext") == 0)
 939                         frame->par = XVID_PAR_EXT;
 940
 941         if(frame->par == XVID_PAR_EXT) {
 942                 if(xvidenc_par_width)
 943                         frame->par_width = xvidenc_par_width;
 944                 else
 945                         frame->par_width = 1;
 946
 947                 if(xvidenc_par_height)
 948                         frame->par_height = xvidenc_par_height;
 949                 else
 950                         frame->par_height = 1;
 951         }
 952         }
 953
 954         /* Display par information */
 955         mp_msg(MSGT_MENCODER, MSGL_INFO, "xvid: par=%d/%d (%s), displayed=%dx%d, sampled=%dx%d\n",
 956                         ar.num, ar.den, par_string(frame->par),
 957                         mod->d_width, mod->d_height, mod->mux->bih->biWidth, mod->mux->bih->biHeight);
 958         }
 959         else
 960                 mp_msg(MSGT_MENCODER, MSGL_INFO,
 961                         "xvid: par=0/0 (vga11) forced by choosing a DXN profile\n");
 962         return(FINE);
 963 }
 964
 965 static int set_create_struct(xvid_mplayer_module_t *mod)
 966 {
 967         int pass;
 968         int doZones = 0;
 969         xvid_enc_create_t *create    = &mod->create;
 970
 971         // profile is unrestricted as default
 972         profile_t *selected_profile =  profileFromName("unrestricted");
 973         if(xvidenc_profile)
 974                 selected_profile = profileFromName(xvidenc_profile);
 975         if(!selected_profile)
 976                 return(BAD);
 977
 978         /* Most of the structure is initialized by dispatch settings, only a
 979          * few things are missing  */
 980         create->version = XVID_VERSION;
 981
 982         /* Width and Height */
 983         create->width  = mod->mux->bih->biWidth;
 984         create->height = mod->mux->bih->biHeight;
 985
 986         /* Check resolution of video to be coded is within profile width/height
 987            restrictions */
 988         if( ((selected_profile->width != 0) &&
 989                 (mod->mux->bih->biWidth > selected_profile->width)) ||
 990                 ((selected_profile->height != 0) &&
 991                 (mod->mux->bih->biHeight > selected_profile->height)) )
 992         {
 993                 mp_msg(MSGT_MENCODER,MSGL_ERR,
 994                         "xvid:[ERROR] resolution must be <= %dx%d for the chosen profile\n",
 995                         selected_profile->width, selected_profile->height);
 996                 return(BAD);
 997         }
 998
 999         /* FPS */
1000         create->fincr = mod->mux->h.dwScale;
1001         create->fbase = mod->mux->h.dwRate;
1002
1003         // Check frame rate is within profile restrictions
1004         if( ((float)mod->mux->h.dwRate/(float)mod->mux->h.dwScale > (float)selected_profile->fps) &&
1005                 (selected_profile->fps != 0))
1006         {
1007                 mp_msg(MSGT_MENCODER,MSGL_ERR,
1008                         "xvid:[ERROR] frame rate must be <= %d for the chosen profile\n",
1009                         selected_profile->fps);
1010                 return(BAD);
1011         }
1012
1013         /* Encodings zones */
1014         memset(mod->zones, 0, sizeof(mod->zones));
1015         create->zones     = mod->zones;
1016         create->num_zones = 0;
1017
1018         /* Plugins */
1019         memset(mod->plugins, 0, sizeof(mod->plugins));
1020         create->plugins     = mod->plugins;
1021         create->num_plugins = 0;
1022
1023         /* -------------------------------------------------------------------
1024          * Initialize and bind the right rate controller plugin
1025          * ---------------------------------------------------------------- */
1026
1027         /* First we try to sort out configuration conflicts */
1028         if(xvidenc_quantizer != 0 && (xvidenc_bitrate || xvidenc_pass)) {
1029                 mp_msg(MSGT_MENCODER, MSGL_ERR,
1030                        "xvid: you can't mix Fixed Quantizer Rate Control"
1031                        " with other Rate Control mechanisms\n");
1032                 return(BAD);
1033         }
1034
1035         if(xvidenc_bitrate != 0 && xvidenc_pass == 1) {
1036                 mp_msg(MSGT_MENCODER, MSGL_WARN,
1037                        "xvid: bitrate setting is ignored during first pass\n");
1038         }
1039
1040         /* Sort out which sort of pass we are supposed to do
1041          * pass == 1<<0 CBR
1042          * pass == 1<<1 Two pass first pass
1043          * pass == 1<<2 Two pass second pass
1044          * pass == 1<<3 Constant quantizer
1045          */
1046 #define MODE_CBR    (1<<0)
1047 #define MODE_2PASS1 (1<<1)
1048 #define MODE_2PASS2 (1<<2)
1049 #define MODE_QUANT  (1<<3)
1050
1051         pass = 0;
1052
1053         if(xvidenc_bitrate != 0 && xvidenc_pass == 0)
1054                 pass |= MODE_CBR;
1055
1056         if(xvidenc_pass == 1)
1057                 pass |= MODE_2PASS1;
1058
1059         if(xvidenc_bitrate != 0 && xvidenc_pass == 2)
1060                 pass |= MODE_2PASS2;
1061
1062         if(xvidenc_quantizer != 0  && xvidenc_pass == 0)
1063                 pass |= MODE_QUANT;
1064
1065         /* We must be in at least one RC mode */
1066         if(pass == 0) {
1067                 mp_msg(MSGT_MENCODER, MSGL_ERR,
1068                        "xvid: you must specify one or a valid combination of "
1069                        "'bitrate', 'pass', 'quantizer' settings\n");
1070                 return(BAD);
1071         }
1072
1073         /* Sanity checking */
1074         if(pass != MODE_CBR    && pass != MODE_QUANT &&
1075            pass != MODE_2PASS1 && pass != MODE_2PASS2) {
1076                 mp_msg(MSGT_MENCODER, MSGL_ERR,
1077                        "xvid: this code should not be reached - fill a bug "
1078                        "report\n");
1079                 return(BAD);
1080         }
1081
1082         /* This is a single pass encoding: either a CBR pass or a constant
1083          * quantizer pass */
1084         if(pass == MODE_CBR  || pass == MODE_QUANT) {
1085                 xvid_plugin_single_t *onepass = &mod->onepass;
1086
1087                 /* There is not much left to initialize after dispatch settings */
1088                 onepass->version = XVID_VERSION;
1089                 if (xvidenc_bitrate > 16000) onepass->bitrate = xvidenc_bitrate;
1090                 else onepass->bitrate = xvidenc_bitrate*1000;
1091
1092                 /* Quantizer mode uses the same plugin, we have only to define
1093                  * a constant quantizer zone beginning at frame 0 */
1094                 if(pass == MODE_QUANT) {
1095                         AVRational squant;
1096                         squant = av_d2q(xvidenc_quantizer,128);
1097
1098                         create->zones[create->num_zones].mode      = XVID_ZONE_QUANT;
1099                         create->zones[create->num_zones].frame     = 0;
1100                         create->zones[create->num_zones].increment = squant.num;
1101                         create->zones[create->num_zones].base      = squant.den;
1102                         create->num_zones++;
1103
1104                         mp_msg(MSGT_MENCODER, MSGL_INFO,
1105                                "xvid: Fixed Quant Rate Control -- quantizer=%d/%d=%2.2f\n",
1106                                squant.num,
1107                                squant.den,
1108                                (float)(squant.num)/(float)(squant.den));
1109
1110                 } else {
1111                         mp_msg(MSGT_MENCODER, MSGL_INFO,
1112                                "xvid: CBR Rate Control -- bitrate=%dkbit/s\n",
1113                                xvidenc_bitrate>16000?xvidenc_bitrate/1000:xvidenc_bitrate);
1114                         doZones = 1;
1115                 }
1116
1117                 create->plugins[create->num_plugins].func  = xvid_plugin_single;
1118                 create->plugins[create->num_plugins].param = onepass;
1119                 create->num_plugins++;
1120         }
1121
1122         /* This is the first pass of a Two pass process */
1123         if(pass == MODE_2PASS1) {
1124                 xvid_plugin_2pass1_t *pass1 = &mod->pass1;
1125
1126                 /* There is not much to initialize for this plugin */
1127                 pass1->version  = XVID_VERSION;
1128                 pass1->filename = passtmpfile;
1129
1130                 create->plugins[create->num_plugins].func  = xvid_plugin_2pass1;
1131                 create->plugins[create->num_plugins].param = pass1;
1132                 create->num_plugins++;
1133
1134                 mp_msg(MSGT_MENCODER, MSGL_INFO,
1135                        "xvid: 2Pass Rate Control -- 1st pass\n");
1136         }
1137
1138         /* This is the second pass of a Two pass process */
1139         if(pass == MODE_2PASS2) {
1140                 xvid_plugin_2pass2_t *pass2 = &mod->pass2;
1141
1142                 /* There is not much left to initialize after dispatch settings */
1143                 pass2->version  = XVID_VERSION;
1144                 pass2->filename =  passtmpfile;
1145
1146                 /* Positive bitrate values are bitrates as usual but if the
1147                  * value is negative it is considered as being a total size
1148                  * to reach (in kilobytes) */
1149                 if(xvidenc_bitrate > 0) {
1150                         if(xvidenc_bitrate > 16000) pass2->bitrate = xvidenc_bitrate;
1151                         else pass2->bitrate = xvidenc_bitrate*1000;
1152                         mp_msg(MSGT_MENCODER, MSGL_INFO,
1153                                "xvid: 2Pass Rate Control -- 2nd pass -- bitrate=%dkbit/s\n",
1154                                xvidenc_bitrate>16000?xvidenc_bitrate/1000:xvidenc_bitrate);
1155                 } else {
1156                         pass2->bitrate  = xvidenc_bitrate;
1157                         mp_msg(MSGT_MENCODER, MSGL_INFO,
1158                                "xvid: 2Pass Rate Control -- 2nd pass -- total size=%dkB\n",
1159                                -xvidenc_bitrate);
1160                 }
1161
1162                 create->plugins[create->num_plugins].func  = xvid_plugin_2pass2;
1163                 create->plugins[create->num_plugins].param = pass2;
1164                 create->num_plugins++;
1165                 doZones = 1;
1166         }
1167
1168         if(xvidenc_luminance_masking && (selected_profile->flags & PROFILE_ADAPTQUANT)) {
1169                 create->plugins[create->num_plugins].func = xvid_plugin_lumimasking;
1170                 create->plugins[create->num_plugins].param = NULL;
1171                 create->num_plugins++;
1172         }
1173
1174         // parse zones
1175         if (xvidenc_zones != NULL && doZones > 0) // do not apply zones in CQ, and first pass mode (xvid vfw doesn't allow them in those modes either)
1176         {
1177                 char *p;
1178                 int i;
1179                 p = xvidenc_zones;
1180                 create->num_zones = 0; // set the number of zones back to zero, this overwrites the zone defined for CQ - desired because each zone has to be specified on the commandline even in cq mode
1181                 for(i = 0; p; i++)
1182                 {
1183                         int start;
1184                         int q;
1185                         double value;
1186                         char mode;
1187                         int e = sscanf(p, "%d,%c,%lf", &start, &mode, &value); // start,mode(q = constant quant, w = weight),value
1188                         if(e != 3)
1189                         {
1190                                 mp_msg(MSGT_MENCODER,MSGL_ERR, "error parsing zones\n");
1191                         return(BAD);
1192                         }
1193                         q = (int)(value * 100);
1194                         if (mode == 'q')
1195                         {
1196                                 if (q < 200 || q > 3100) // make sure that quantizer is in allowable range
1197                                 {
1198                                         mp_msg(MSGT_MENCODER, MSGL_ERR, "zone quantizer must be between 2 and 31\n");
1199                                         return(BAD);
1200                                 }
1201                                 else
1202                                 {
1203                                         create->zones[create->num_zones].mode      = XVID_ZONE_QUANT;
1204                                 }
1205                         }
1206                         if (mode == 'w')
1207                         {
1208                                 if (q < 1 || q > 200)
1209                                 {
1210                                         mp_msg(MSGT_MENCODER, MSGL_ERR, "zone weight must be between 1 and 200\n");
1211                                         return(BAD);
1212                                 }
1213                                 else
1214                                 {
1215                                         create->zones[create->num_zones].mode      = XVID_ZONE_WEIGHT;
1216                                 }
1217                         }
1218                         create->zones[create->num_zones].frame     = start;
1219                         create->zones[create->num_zones].increment = q;
1220                         create->zones[create->num_zones].base      = 100; // increment is 100 times the actual value
1221                         create->num_zones++;
1222                         if (create->num_zones > MAX_ZONES) // show warning if we have too many zones
1223                         {
1224                                 mp_msg(MSGT_MENCODER, MSGL_ERR, "too many zones, zones will be ignored\n");
1225                         }
1226                         p = strchr(p, '/');
1227                         if(p) p++;
1228                 }
1229         }
1230         return(FINE);
1231 }
1232
1233 static int set_frame_struct(xvid_mplayer_module_t *mod, mp_image_t *mpi)
1234 {
1235         xvid_enc_frame_t *frame = &mod->frame;
1236
1237         /* Most of the initialization is done during dispatch_settings */
1238         frame->version = XVID_VERSION;
1239
1240         /* Bind output buffer */
1241         frame->bitstream = mod->mux->buffer;
1242         frame->length    = -1;
1243
1244         /* Frame format */
1245         switch(mpi->imgfmt) {
1246         case IMGFMT_YV12:
1247         case IMGFMT_IYUV:
1248         case IMGFMT_I420:
1249                 frame->input.csp = XVID_CSP_USER;
1250                 break;
1251         case IMGFMT_YUY2:
1252                 frame->input.csp = XVID_CSP_YUY2;
1253                 break;
1254         case IMGFMT_UYVY:
1255                 frame->input.csp = XVID_CSP_UYVY;
1256                 break;
1257         default:
1258                 mp_msg(MSGT_MENCODER, MSGL_ERR,
1259                        "xvid: unsupported picture format (%s)!\n",
1260                        vo_format_name(mpi->imgfmt));
1261                 return(BAD);
1262         }
1263
1264         /* Bind source frame */
1265         frame->input.plane[0]  = mpi->planes[0];
1266         frame->input.plane[1]  = mpi->planes[1];
1267         frame->input.plane[2]  = mpi->planes[2];
1268         frame->input.stride[0] = mpi->stride[0];
1269         frame->input.stride[1] = mpi->stride[1];
1270         frame->input.stride[2] = mpi->stride[2];
1271
1272         /* Force the right quantizer -- It is internally managed by RC
1273          * plugins */
1274         frame->quant = 0;
1275
1276         return(FINE);
1277 }
1278
1279 static void
1280 flush_internal_buffers(xvid_mplayer_module_t *mod)
1281 {
1282         int size;
1283         xvid_enc_frame_t *frame = &mod->frame;
1284
1285         if (mod->instance == NULL)
1286             return;/*encoder not inited*/
1287
1288         /* Init a fake frame to force flushing */
1289         frame->version = XVID_VERSION;
1290         frame->bitstream = mod->mux->buffer;
1291         frame->length    = -1;
1292         frame->input.csp = XVID_CSP_NULL;
1293         frame->input.plane[0] = NULL;
1294         frame->input.plane[1] = NULL;
1295         frame->input.plane[2] = NULL;
1296         frame->input.stride[0] = 0;
1297         frame->input.stride[1] = 0;
1298         frame->input.stride[2] = 0;
1299         frame->quant = 0;
1300
1301         /* Flush encoder buffers caused by bframes usage */
1302         do {
1303                 xvid_enc_stats_t stats;
1304                 memset(&stats, 0, sizeof(xvid_enc_stats_t));
1305                 stats.version = XVID_VERSION;
1306
1307                 /* Encode internal buffer */
1308                 size = xvid_encore(mod->instance, XVID_ENC_ENCODE, &mod->frame, &stats);
1309
1310                 if (size>0) {
1311                         /* Update stats */
1312                         update_stats(mod, &stats);
1313
1314                         /* xvidcore outputed bitstream -- mux it */
1315                         muxer_write_chunk(mod->mux, size,
1316                                         (mod->frame.out_flags & XVID_KEYFRAME)?0x10:0, MP_NOPTS_VALUE, MP_NOPTS_VALUE);
1317                 }
1318         } while (size>0);
1319 }
1320
1321 #define SSE2PSNR(sse, nbpixels) \
1322                 ((!(sse)) ? 99.99f : 48.131f - 10*(double)log10((double)(sse)/(double)((nbpixels))))
1323 static void
1324 update_stats(xvid_mplayer_module_t *mod, xvid_enc_stats_t *stats)
1325 {
1326         if(xvidenc_stats && stats->type > 0) {
1327                 mod->sse_y += stats->sse_y;
1328                 mod->sse_u += stats->sse_u;
1329                 mod->sse_v += stats->sse_v;
1330
1331                 if(mod->min_sse_y > stats->sse_y) {
1332                         mod->min_sse_y = stats->sse_y;
1333                         mod->min_sse_u = stats->sse_u;
1334                         mod->min_sse_v = stats->sse_v;
1335                         mod->min_framenum = mod->frames;
1336                 }
1337
1338                 if(mod->max_sse_y < stats->sse_y) {
1339                         mod->max_sse_y = stats->sse_y;
1340                         mod->max_sse_u = stats->sse_u;
1341                         mod->max_sse_v = stats->sse_v;
1342                         mod->max_framenum = mod->frames;
1343                 }
1344
1345                 if (xvidenc_psnr) {
1346                         if (!mod->fvstats) {
1347                                 char filename[20];
1348                                 time_t today2;
1349                                 struct tm *today;
1350                                 today2 = time (NULL);
1351                                 today = localtime (&today2);
1352                                 sprintf (filename, "psnr_%02d%02d%02d.log", today->tm_hour, today->tm_min, today->tm_sec);
1353                                 mod->fvstats = fopen (filename,"w");
1354                                 if (!mod->fvstats) {
1355                                         perror ("fopen");
1356                                         /* Disable PSNR file output so we don't get here again */
1357                                         xvidenc_psnr = 0;
1358                                 }
1359                         }
1360                         fprintf (mod->fvstats, "%6d, %2d, %6d, %2.2f, %2.2f, %2.2f, %2.2f %c\n",
1361                                         mod->frames,
1362                                         stats->quant,
1363                                         stats->length,
1364                                         SSE2PSNR (stats->sse_y, mod->pixels),
1365                                         SSE2PSNR (stats->sse_u, mod->pixels / 4),
1366                                         SSE2PSNR (stats->sse_v, mod->pixels / 4),
1367                                         SSE2PSNR (stats->sse_y + stats->sse_u + stats->sse_v,(double)mod->pixels * 1.5),
1368                                         stats->type==1?'I':stats->type==2?'P':stats->type==3?'B':stats->type?'S':'?'
1369                                 );
1370                 }
1371                 mod->frames++;
1372         }
1373 }
1374
1375 static void
1376 print_stats(xvid_mplayer_module_t *mod)
1377 {
1378         if (mod->frames) {
1379                 mod->sse_y /= mod->frames;
1380                 mod->sse_u /= mod->frames;
1381                 mod->sse_v /= mod->frames;
1382
1383                 mp_msg(MSGT_MENCODER, MSGL_INFO,
1384                                 "The value 99.99dB is a special value and represents "
1385                                 "the upper range limit\n");
1386                 mp_msg(MSGT_MENCODER, MSGL_INFO,
1387                                 "xvid:     Min PSNR Y:%.2f, Cb:%.2f, Cr:%.2f, All:%.2f in frame %d\n",
1388                                 SSE2PSNR(mod->max_sse_y, mod->pixels),
1389                                 SSE2PSNR(mod->max_sse_u, mod->pixels/4),
1390                                 SSE2PSNR(mod->max_sse_v, mod->pixels/4),
1391                                 SSE2PSNR(mod->max_sse_y + mod->max_sse_u + mod->max_sse_v, mod->pixels*1.5),
1392                                 mod->max_framenum);
1393                 mp_msg(MSGT_MENCODER, MSGL_INFO,
1394                                 "xvid: Average PSNR Y:%.2f, Cb:%.2f, Cr:%.2f, All:%.2f for %d frames\n",
1395                                 SSE2PSNR(mod->sse_y, mod->pixels),
1396                                 SSE2PSNR(mod->sse_u, mod->pixels/4),
1397                                 SSE2PSNR(mod->sse_v, mod->pixels/4),
1398                                 SSE2PSNR(mod->sse_y + mod->sse_u + mod->sse_v, mod->pixels*1.5),
1399                                 mod->frames);
1400                 mp_msg(MSGT_MENCODER, MSGL_INFO,
1401                                 "xvid:     Max PSNR Y:%.2f, Cb:%.2f, Cr:%.2f, All:%.2f in frame %d\n",
1402                                 SSE2PSNR(mod->min_sse_y, mod->pixels),
1403                                 SSE2PSNR(mod->min_sse_u, mod->pixels/4),
1404                                 SSE2PSNR(mod->min_sse_v, mod->pixels/4),
1405                                 SSE2PSNR(mod->min_sse_y + mod->min_sse_u + mod->min_sse_v, mod->pixels*1.5),
1406                                 mod->min_framenum);
1407         }
1408 }
1409 #undef SSE2PSNR
1410
1411 static void *read_matrix(unsigned char *filename)
1412 {
1413         int i;
1414         unsigned char *matrix;
1415         FILE *input;
1416
1417         /* Allocate matrix space */
1418         if((matrix = malloc(64*sizeof(unsigned char))) == NULL)
1419            return(NULL);
1420
1421         /* Open the matrix file */
1422         if((input = fopen(filename, "rb")) == NULL) {
1423                 mp_msg(MSGT_MENCODER, MSGL_ERR,
1424                         "xvid: Error opening the matrix file %s\n",
1425                         filename);
1426                 free(matrix);
1427                 return(NULL);
1428         }
1429
1430         /* Read the matrix */
1431         for(i=0; i<64; i++) {
1432
1433                 int value;
1434
1435                 /* If fscanf fails then get out of the loop */
1436                 if(fscanf(input, "%d", &value) != 1) {
1437                         mp_msg(MSGT_MENCODER, MSGL_ERR,
1438                                 "xvid: Error reading the matrix file %s\n",
1439                                 filename);
1440                         free(matrix);
1441                         fclose(input);
1442                         return(NULL);
1443                 }
1444
1445                 /* Clamp the value to safe range */
1446                 value     = (value<  1)?1  :value;
1447                 value     = (value>255)?255:value;
1448                 matrix[i] = value;
1449         }
1450
1451         /* Fills the rest with 1 */
1452         while(i<64) matrix[i++] = 1;
1453
1454         /* We're done */
1455         fclose(input);
1456
1457         return(matrix);
1458
1459 }
1460
1461
1462 static const char *
1463 par_string(int parcode)
1464 {
1465         const char *par_string;
1466         switch (parcode) {
1467         case XVID_PAR_11_VGA:
1468                 par_string = "vga11";
1469                 break;
1470         case XVID_PAR_43_PAL:
1471                 par_string = "pal43";
1472                 break;
1473         case XVID_PAR_43_NTSC:
1474                 par_string = "ntsc43";
1475                 break;
1476         case XVID_PAR_169_PAL:
1477                 par_string = "pal169";
1478                 break;
1479         case XVID_PAR_169_NTSC:
1480                 par_string = "ntsc69";
1481                 break;
1482         case XVID_PAR_EXT:
1483                 par_string = "ext";
1484                 break;
1485         default:
1486                 par_string = "unknown";
1487                 break;
1488         }
1489         return (par_string);
1490 }
1491
1492 static const char *errorstring(int err)
1493 {
1494         const char *error;
1495         switch(err) {
1496         case XVID_ERR_FAIL:
1497                 error = "General fault";
1498                 break;
1499         case XVID_ERR_MEMORY:
1500                 error =  "Memory allocation error";
1501                 break;
1502         case XVID_ERR_FORMAT:
1503                 error =  "File format error";
1504                 break;
1505         case XVID_ERR_VERSION:
1506                 error =  "Structure version not supported";
1507                 break;
1508         case XVID_ERR_END:
1509                 error =  "End of stream reached";
1510                 break;
1511         default:
1512                 error = "Unknown";
1513         }
1514
1515         return(error);
1516 }
1517
1518 /*****************************************************************************
1519  * Module structure definition
1520  ****************************************************************************/
1521
1522 vf_info_t ve_info_xvid = {
1523         "XviD 1.0 encoder",
1524         "xvid",
1525         "Marco Belli <elcabesa@inwind.it>, Edouard Gomez <ed.gomez@free.fr>",
1526         "No comment",
1527         vf_open
1528 };
1529
1530
1531 /* Please do not change that tag comment.
1532  * arch-tag: 42ccc257-0548-4a3e-9617-2876c4e8ac88 mplayer xvid encoder module */