vpx/src/vpx_encoder.c

   1 /*
   2  *  Copyright (c) 2010 The WebM project authors. All Rights Reserved.
   3  *
   4  *  Use of this source code is governed by a BSD-style license
   5  *  that can be found in the LICENSE file in the root of the source
   6  *  tree. An additional intellectual property rights grant can be found
   7  *  in the file PATENTS.  All contributing project authors may
   8  *  be found in the AUTHORS file in the root of the source tree.
   9  */
  10
  11
  12 /*!\file
  13  * \brief Provides the high level interface to wrap encoder algorithms.
  14  *
  15  */
  16 #include <limits.h>
  17 #include <string.h>
  18 #include "vpx/internal/vpx_codec_internal.h"
  19 #include "vpx_config.h"
  20
  21 #define SAVE_STATUS(ctx,var) (ctx?(ctx->err = var):var)
  22
  23 vpx_codec_err_t vpx_codec_enc_init_ver(vpx_codec_ctx_t      *ctx,
  24                                        vpx_codec_iface_t    *iface,
  25                                        vpx_codec_enc_cfg_t  *cfg,
  26                                        vpx_codec_flags_t     flags,
  27                                        int                   ver)
  28 {
  29     vpx_codec_err_t res;
  30
  31     if (ver != VPX_ENCODER_ABI_VERSION)
  32         res = VPX_CODEC_ABI_MISMATCH;
  33     else if (!ctx || !iface || !cfg)
  34         res = VPX_CODEC_INVALID_PARAM;
  35     else if (iface->abi_version != VPX_CODEC_INTERNAL_ABI_VERSION)
  36         res = VPX_CODEC_ABI_MISMATCH;
  37     else if (!(iface->caps & VPX_CODEC_CAP_ENCODER))
  38         res = VPX_CODEC_INCAPABLE;
  39     else if ((flags & VPX_CODEC_USE_XMA) && !(iface->caps & VPX_CODEC_CAP_XMA))
  40         res = VPX_CODEC_INCAPABLE;
  41     else if ((flags & VPX_CODEC_USE_PSNR)
  42              && !(iface->caps & VPX_CODEC_CAP_PSNR))
  43         res = VPX_CODEC_INCAPABLE;
  44     else if ((flags & VPX_CODEC_USE_OUTPUT_PARTITION)
  45              && !(iface->caps & VPX_CODEC_CAP_OUTPUT_PARTITION))
  46         res = VPX_CODEC_INCAPABLE;
  47     else
  48     {
  49         ctx->iface = iface;
  50         ctx->name = iface->name;
  51         ctx->priv = NULL;
  52         ctx->init_flags = flags;
  53         ctx->config.enc = cfg;
  54         res = ctx->iface->init(ctx, NULL);
  55
  56         if (res)
  57         {
  58             ctx->err_detail = ctx->priv ? ctx->priv->err_detail : NULL;
  59             vpx_codec_destroy(ctx);
  60         }
  61
  62         if (ctx->priv)
  63             ctx->priv->iface = ctx->iface;
  64     }
  65
  66     return SAVE_STATUS(ctx, res);
  67 }
  68
  69 vpx_codec_err_t vpx_codec_enc_init_multi_ver(vpx_codec_ctx_t      *ctx,
  70                                              vpx_codec_iface_t    *iface,
  71                                              vpx_codec_enc_cfg_t  *cfg,
  72                                              int                   num_enc,
  73                                              vpx_codec_flags_t     flags,
  74                                              vpx_rational_t       *dsf,
  75                                              int                   ver)
  76 {
  77     vpx_codec_err_t res = 0;
  78
  79     if (ver != VPX_ENCODER_ABI_VERSION)
  80         res = VPX_CODEC_ABI_MISMATCH;
  81     else if (!ctx || !iface || !cfg || (num_enc > 16 || num_enc < 1))
  82         res = VPX_CODEC_INVALID_PARAM;
  83     else if (iface->abi_version != VPX_CODEC_INTERNAL_ABI_VERSION)
  84         res = VPX_CODEC_ABI_MISMATCH;
  85     else if (!(iface->caps & VPX_CODEC_CAP_ENCODER))
  86         res = VPX_CODEC_INCAPABLE;
  87     else if ((flags & VPX_CODEC_USE_XMA) && !(iface->caps & VPX_CODEC_CAP_XMA))
  88         res = VPX_CODEC_INCAPABLE;
  89     else if ((flags & VPX_CODEC_USE_PSNR)
  90              && !(iface->caps & VPX_CODEC_CAP_PSNR))
  91         res = VPX_CODEC_INCAPABLE;
  92     else if ((flags & VPX_CODEC_USE_OUTPUT_PARTITION)
  93              && !(iface->caps & VPX_CODEC_CAP_OUTPUT_PARTITION))
  94         res = VPX_CODEC_INCAPABLE;
  95     else
  96     {
  97         int i;
  98         void *mem_loc = NULL;
  99
 100         if(!(res = iface->enc.mr_get_mem_loc(cfg, &mem_loc)))
 101         {
 102             for (i = 0; i < num_enc; i++)
 103             {
 104                 vpx_codec_priv_enc_mr_cfg_t mr_cfg;
 105
 106                 /* Validate down-sampling factor. */
 107                 if(dsf->num < 1 || dsf->num > 4096 || dsf->den < 1 ||
 108                    dsf->den > dsf->num)
 109                 {
 110                     res = VPX_CODEC_INVALID_PARAM;
 111                     break;
 112                 }
 113
 114                 mr_cfg.mr_low_res_mode_info = mem_loc;
 115                 mr_cfg.mr_total_resolutions = num_enc;
 116                 mr_cfg.mr_encoder_id = num_enc-1-i;
 117                 mr_cfg.mr_down_sampling_factor.num = dsf->num;
 118                 mr_cfg.mr_down_sampling_factor.den = dsf->den;
 119
 120                 ctx->iface = iface;
 121                 ctx->name = iface->name;
 122                 ctx->priv = NULL;
 123                 ctx->init_flags = flags;
 124                 ctx->config.enc = cfg;
 125                 res = ctx->iface->init(ctx, &mr_cfg);
 126
 127                 if (res)
 128                 {
 129                     ctx->err_detail = ctx->priv ? ctx->priv->err_detail : NULL;
 130                     vpx_codec_destroy(ctx);
 131                 }
 132
 133                 if (ctx->priv)
 134                     ctx->priv->iface = ctx->iface;
 135
 136                 if (res)
 137                     break;
 138
 139                 ctx++;
 140                 cfg++;
 141                 dsf++;
 142             }
 143         }
 144     }
 145
 146     return SAVE_STATUS(ctx, res);
 147 }
 148
 149
 150 vpx_codec_err_t  vpx_codec_enc_config_default(vpx_codec_iface_t    *iface,
 151         vpx_codec_enc_cfg_t  *cfg,
 152         unsigned int          usage)
 153 {
 154     vpx_codec_err_t res;
 155     vpx_codec_enc_cfg_map_t *map;
 156
 157     if (!iface || !cfg || usage > INT_MAX)
 158         res = VPX_CODEC_INVALID_PARAM;
 159     else if (!(iface->caps & VPX_CODEC_CAP_ENCODER))
 160         res = VPX_CODEC_INCAPABLE;
 161     else
 162     {
 163         res = VPX_CODEC_INVALID_PARAM;
 164
 165         for (map = iface->enc.cfg_maps; map->usage >= 0; map++)
 166         {
 167             if (map->usage == (int)usage)
 168             {
 169                 *cfg = map->cfg;
 170                 cfg->g_usage = usage;
 171                 res = VPX_CODEC_OK;
 172                 break;
 173             }
 174         }
 175     }
 176
 177     return res;
 178 }
 179
 180
 181 #if ARCH_X86 || ARCH_X86_64
 182 /* On X86, disable the x87 unit's internal 80 bit precision for better
 183  * consistency with the SSE unit's 64 bit precision.
 184  */
 185 #include "vpx_ports/x86.h"
 186 #define FLOATING_POINT_INIT() do {\
 187         unsigned short x87_orig_mode = x87_set_double_precision();
 188 #define FLOATING_POINT_RESTORE() \
 189     x87_set_control_word(x87_orig_mode); }while(0)
 190
 191
 192 #else
 193 static void FLOATING_POINT_INIT() {}
 194 static void FLOATING_POINT_RESTORE() {}
 195 #endif
 196
 197
 198 vpx_codec_err_t  vpx_codec_encode(vpx_codec_ctx_t            *ctx,
 199                                   const vpx_image_t          *img,
 200                                   vpx_codec_pts_t             pts,
 201                                   unsigned long               duration,
 202                                   vpx_enc_frame_flags_t       flags,
 203                                   unsigned long               deadline)
 204 {
 205     vpx_codec_err_t res = 0;
 206
 207     if (!ctx || (img && !duration))
 208         res = VPX_CODEC_INVALID_PARAM;
 209     else if (!ctx->iface || !ctx->priv)
 210         res = VPX_CODEC_ERROR;
 211     else if (!(ctx->iface->caps & VPX_CODEC_CAP_ENCODER))
 212         res = VPX_CODEC_INCAPABLE;
 213     else
 214     {
 215         /* Execute in a normalized floating point environment, if the platform
 216          * requires it.
 217          */
 218         unsigned int num_enc =ctx->priv->enc.total_encoders;
 219
 220         FLOATING_POINT_INIT();
 221
 222         if (num_enc == 1)
 223             res = ctx->iface->enc.encode(ctx->priv->alg_priv, img, pts,
 224                                          duration, flags, deadline);
 225         else
 226         {
 227             /* Multi-resolution encoding:
 228              * Encode multi-levels in reverse order. For example,
 229              * if mr_total_resolutions = 3, first encode level 2,
 230              * then encode level 1, and finally encode level 0.
 231              */
 232             int i;
 233
 234             ctx += num_enc - 1;
 235             if (img) img += num_enc - 1;
 236
 237             for (i = num_enc-1; i >= 0; i--)
 238             {
 239                 if ((res = ctx->iface->enc.encode(ctx->priv->alg_priv, img, pts,
 240                                                   duration, flags, deadline)))
 241                     break;
 242
 243                 ctx--;
 244                 if (img) img--;
 245             }
 246         }
 247
 248         FLOATING_POINT_RESTORE();
 249     }
 250
 251     return SAVE_STATUS(ctx, res);
 252 }
 253
 254
 255 const vpx_codec_cx_pkt_t *vpx_codec_get_cx_data(vpx_codec_ctx_t   *ctx,
 256         vpx_codec_iter_t  *iter)
 257 {
 258     const vpx_codec_cx_pkt_t *pkt = NULL;
 259
 260     if (ctx)
 261     {
 262         if (!iter)
 263             ctx->err = VPX_CODEC_INVALID_PARAM;
 264         else if (!ctx->iface || !ctx->priv)
 265             ctx->err = VPX_CODEC_ERROR;
 266         else if (!(ctx->iface->caps & VPX_CODEC_CAP_ENCODER))
 267             ctx->err = VPX_CODEC_INCAPABLE;
 268         else
 269             pkt = ctx->iface->enc.get_cx_data(ctx->priv->alg_priv, iter);
 270     }
 271
 272     if (pkt && pkt->kind == VPX_CODEC_CX_FRAME_PKT)
 273     {
 274         /* If the application has specified a destination area for the
 275          * compressed data, and the codec has not placed the data there,
 276          * and it fits, copy it.
 277          */
 278         char *dst_buf = ctx->priv->enc.cx_data_dst_buf.buf;
 279
 280         if (dst_buf
 281             && pkt->data.raw.buf != dst_buf
 282             && pkt->data.raw.sz
 283             + ctx->priv->enc.cx_data_pad_before
 284             + ctx->priv->enc.cx_data_pad_after
 285             <= ctx->priv->enc.cx_data_dst_buf.sz)
 286         {
 287             vpx_codec_cx_pkt_t *modified_pkt = &ctx->priv->enc.cx_data_pkt;
 288
 289             memcpy(dst_buf + ctx->priv->enc.cx_data_pad_before,
 290                    pkt->data.raw.buf, pkt->data.raw.sz);
 291             *modified_pkt = *pkt;
 292             modified_pkt->data.raw.buf = dst_buf;
 293             modified_pkt->data.raw.sz += ctx->priv->enc.cx_data_pad_before
 294                                          + ctx->priv->enc.cx_data_pad_after;
 295             pkt = modified_pkt;
 296         }
 297
 298         if (dst_buf == pkt->data.raw.buf)
 299         {
 300             ctx->priv->enc.cx_data_dst_buf.buf = dst_buf + pkt->data.raw.sz;
 301             ctx->priv->enc.cx_data_dst_buf.sz -= pkt->data.raw.sz;
 302         }
 303     }
 304
 305     return pkt;
 306 }
 307
 308
 309 vpx_codec_err_t vpx_codec_set_cx_data_buf(vpx_codec_ctx_t       *ctx,
 310         const vpx_fixed_buf_t *buf,
 311         unsigned int           pad_before,
 312         unsigned int           pad_after)
 313 {
 314     if (!ctx || !ctx->priv)
 315         return VPX_CODEC_INVALID_PARAM;
 316
 317     if (buf)
 318     {
 319         ctx->priv->enc.cx_data_dst_buf = *buf;
 320         ctx->priv->enc.cx_data_pad_before = pad_before;
 321         ctx->priv->enc.cx_data_pad_after = pad_after;
 322     }
 323     else
 324     {
 325         ctx->priv->enc.cx_data_dst_buf.buf = NULL;
 326         ctx->priv->enc.cx_data_dst_buf.sz = 0;
 327         ctx->priv->enc.cx_data_pad_before = 0;
 328         ctx->priv->enc.cx_data_pad_after = 0;
 329     }
 330
 331     return VPX_CODEC_OK;
 332 }
 333
 334
 335 const vpx_image_t *vpx_codec_get_preview_frame(vpx_codec_ctx_t   *ctx)
 336 {
 337     vpx_image_t *img = NULL;
 338
 339     if (ctx)
 340     {
 341         if (!ctx->iface || !ctx->priv)
 342             ctx->err = VPX_CODEC_ERROR;
 343         else if (!(ctx->iface->caps & VPX_CODEC_CAP_ENCODER))
 344             ctx->err = VPX_CODEC_INCAPABLE;
 345         else if (!ctx->iface->enc.get_preview)
 346             ctx->err = VPX_CODEC_INCAPABLE;
 347         else
 348             img = ctx->iface->enc.get_preview(ctx->priv->alg_priv);
 349     }
 350
 351     return img;
 352 }
 353
 354
 355 vpx_fixed_buf_t *vpx_codec_get_global_headers(vpx_codec_ctx_t   *ctx)
 356 {
 357     vpx_fixed_buf_t *buf = NULL;
 358
 359     if (ctx)
 360     {
 361         if (!ctx->iface || !ctx->priv)
 362             ctx->err = VPX_CODEC_ERROR;
 363         else if (!(ctx->iface->caps & VPX_CODEC_CAP_ENCODER))
 364             ctx->err = VPX_CODEC_INCAPABLE;
 365         else if (!ctx->iface->enc.get_glob_hdrs)
 366             ctx->err = VPX_CODEC_INCAPABLE;
 367         else
 368             buf = ctx->iface->enc.get_glob_hdrs(ctx->priv->alg_priv);
 369     }
 370
 371     return buf;
 372 }
 373
 374
 375 vpx_codec_err_t  vpx_codec_enc_config_set(vpx_codec_ctx_t            *ctx,
 376         const vpx_codec_enc_cfg_t  *cfg)
 377 {
 378     vpx_codec_err_t res;
 379
 380     if (!ctx || !ctx->iface || !ctx->priv || !cfg)
 381         res = VPX_CODEC_INVALID_PARAM;
 382     else if (!(ctx->iface->caps & VPX_CODEC_CAP_ENCODER))
 383         res = VPX_CODEC_INCAPABLE;
 384     else
 385         res = ctx->iface->enc.cfg_set(ctx->priv->alg_priv, cfg);
 386
 387     return SAVE_STATUS(ctx, res);
 388 }
 389
 390
 391 int vpx_codec_pkt_list_add(struct vpx_codec_pkt_list *list,
 392                            const struct vpx_codec_cx_pkt *pkt)
 393 {
 394     if (list->cnt < list->max)
 395     {
 396         list->pkts[list->cnt++] = *pkt;
 397         return 0;
 398     }
 399
 400     return 1;
 401 }
 402
 403
 404 const vpx_codec_cx_pkt_t *vpx_codec_pkt_list_get(struct vpx_codec_pkt_list *list,
 405         vpx_codec_iter_t           *iter)
 406 {
 407     const vpx_codec_cx_pkt_t *pkt;
 408
 409     if (!(*iter))
 410     {
 411         *iter = list->pkts;
 412     }
 413
 414     pkt = (const void *) * iter;
 415
 416     if ((size_t)(pkt - list->pkts) < list->cnt)
 417         *iter = pkt + 1;
 418     else
 419         pkt = NULL;
 420
 421     return pkt;
 422 }