2 * Copyright (c) 2013 The WebM project authors. All Rights Reserved.
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.
12 * SvcContext - input parameters and state to encode a multi-layered
16 #ifndef VPX_SVC_CONTEXT_H_
17 #define VPX_SVC_CONTEXT_H_
20 #include "./vpx_encoder.h"
26 typedef enum SVC_LOG_LEVEL {
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
43 int aqmode; // turns on aq-mode=3 (cyclic_refresh): 0=off, 1=on.
44 // private storage for vpx_svc_encode
48 #define OPTION_BUFFER_SIZE 1024
49 #define COMPONENTS 4 // psnr & sse statistics maintained for total, y, u, v
51 typedef struct SvcInternal {
52 char options[OPTION_BUFFER_SIZE]; // set by vpx_svc_set_options
54 // values extracted from option, quantizers
55 vpx_svc_extra_cfg_t svc_params;
56 int enable_auto_alt_ref[VPX_SS_MAX_LAYERS];
57 int bitrates[VPX_SS_MAX_LAYERS];
59 // accumulated statistics
60 double psnr_sum[VPX_SS_MAX_LAYERS][COMPONENTS]; // total/Y/U/V
61 uint64_t sse_sum[VPX_SS_MAX_LAYERS][COMPONENTS];
62 uint32_t bytes_sum[VPX_SS_MAX_LAYERS];
64 // codec encoding values
65 int width; // width of highest layer
66 int height; // height of highest layer
67 int kf_dist; // distance between keyframes
70 int psnr_pkt_received;
72 int use_multiple_frame_contexts;
74 char message_buffer[2048];
75 vpx_codec_ctx_t *codec_ctx;
80 * options are supplied as a single string separated by spaces
81 * Format: encoding-mode=<i|ip|alt-ip|gf>
82 * layers=<layer_count>
83 * scaling-factors=<n1>/<d1>,<n2>/<d2>,...
84 * quantizers=<q1>,<q2>,...
86 vpx_codec_err_t vpx_svc_set_options(SvcContext *svc_ctx, const char *options);
89 * initialize SVC encoding
91 vpx_codec_err_t vpx_svc_init(SvcContext *svc_ctx,
92 vpx_codec_ctx_t *codec_ctx,
93 vpx_codec_iface_t *iface,
94 vpx_codec_enc_cfg_t *cfg);
96 * encode a frame of video with multiple layers
98 vpx_codec_err_t vpx_svc_encode(SvcContext *svc_ctx,
99 vpx_codec_ctx_t *codec_ctx,
100 struct vpx_image *rawimg,
102 int64_t duration, int deadline);
105 * finished with svc encoding, release allocated resources
107 void vpx_svc_release(SvcContext *svc_ctx);
110 * dump accumulated statistics and reset accumulated values
112 const char *vpx_svc_dump_statistics(SvcContext *svc_ctx);
115 * get status message from previous encode
117 const char *vpx_svc_get_message(const SvcContext *svc_ctx);
123 #endif // VPX_SVC_CONTEXT_H_