vpx/svc_context.h

   1 /*
   2  *  Copyright (c) 2013 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  * SvcContext - input parameters and state to encode a multi-layered
  13  * spatial SVC frame
  14  */
  15
  16 #ifndef VPX_SVC_CONTEXT_H_
  17 #define VPX_SVC_CONTEXT_H_
  18
  19 #include "./vp8cx.h"
  20 #include "./vpx_encoder.h"
  21
  22 #ifdef __cplusplus
  23 extern "C" {
  24 #endif
  25
  26 typedef enum SVC_LOG_LEVEL {
  27   SVC_LOG_ERROR,
  28   SVC_LOG_INFO,
  29   SVC_LOG_DEBUG
  30 } SVC_LOG_LEVEL;
  31
  32 typedef struct {
  33   // public interface to svc_command options
  34   int spatial_layers;               // number of spatial layers
  35   int temporal_layers;               // number of temporal layers
  36   int temporal_layering_mode;
  37   SVC_LOG_LEVEL log_level;  // amount of information to display
  38   int log_print;  // when set, printf log messages instead of returning the
  39                   // message with svc_get_message
  40   int output_rc_stat;  // for outputting rc stats
  41   int speed;  // speed setting for codec
  42   int threads;
  43   // private storage for vpx_svc_encode
  44   void *internal;
  45 } SvcContext;
  46
  47 #define OPTION_BUFFER_SIZE 1024
  48 #define COMPONENTS 4  // psnr & sse statistics maintained for total, y, u, v
  49
  50 typedef struct SvcInternal {
  51   char options[OPTION_BUFFER_SIZE];        // set by vpx_svc_set_options
  52
  53   // values extracted from option, quantizers
  54   vpx_svc_extra_cfg_t svc_params;
  55   int enable_auto_alt_ref[VPX_SS_MAX_LAYERS];
  56   int bitrates[VPX_SS_MAX_LAYERS];
  57
  58   // accumulated statistics
  59   double psnr_sum[VPX_SS_MAX_LAYERS][COMPONENTS];   // total/Y/U/V
  60   uint64_t sse_sum[VPX_SS_MAX_LAYERS][COMPONENTS];
  61   uint32_t bytes_sum[VPX_SS_MAX_LAYERS];
  62
  63   // codec encoding values
  64   int width;    // width of highest layer
  65   int height;   // height of highest layer
  66   int kf_dist;  // distance between keyframes
  67
  68   // state variables
  69   int psnr_pkt_received;
  70   int layer;
  71   int use_multiple_frame_contexts;
  72
  73   char message_buffer[2048];
  74   vpx_codec_ctx_t *codec_ctx;
  75 } SvcInternal_t;
  76
  77 /**
  78  * Set SVC options
  79  * options are supplied as a single string separated by spaces
  80  * Format: encoding-mode=<i|ip|alt-ip|gf>
  81  *         layers=<layer_count>
  82  *         scaling-factors=<n1>/<d1>,<n2>/<d2>,...
  83  *         quantizers=<q1>,<q2>,...
  84  */
  85 vpx_codec_err_t vpx_svc_set_options(SvcContext *svc_ctx, const char *options);
  86
  87 /**
  88  * initialize SVC encoding
  89  */
  90 vpx_codec_err_t vpx_svc_init(SvcContext *svc_ctx,
  91                              vpx_codec_ctx_t *codec_ctx,
  92                              vpx_codec_iface_t *iface,
  93                              vpx_codec_enc_cfg_t *cfg);
  94 /**
  95  * encode a frame of video with multiple layers
  96  */
  97 vpx_codec_err_t vpx_svc_encode(SvcContext *svc_ctx,
  98                                vpx_codec_ctx_t *codec_ctx,
  99                                struct vpx_image *rawimg,
 100                                vpx_codec_pts_t pts,
 101                                int64_t duration, int deadline);
 102
 103 /**
 104  * finished with svc encoding, release allocated resources
 105  */
 106 void vpx_svc_release(SvcContext *svc_ctx);
 107
 108 /**
 109  * dump accumulated statistics and reset accumulated values
 110  */
 111 const char *vpx_svc_dump_statistics(SvcContext *svc_ctx);
 112
 113 /**
 114  *  get status message from previous encode
 115  */
 116 const char *vpx_svc_get_message(const SvcContext *svc_ctx);
 117
 118 #ifdef __cplusplus
 119 }  // extern "C"
 120 #endif
 121
 122 #endif  // VPX_SVC_CONTEXT_H_