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 {
32 typedef struct SvcContext {
33 // public interface to svc_command options
34 int spatial_layers; // number of spatial layers
35 int temporal_layers; // number of temporal layers
36 SVC_LOG_LEVEL log_level; // amount of information to display
37 int log_print; // when set, printf log messages instead of returning the
38 // message with svc_get_message
40 // private storage for vpx_svc_encode
44 #define OPTION_BUFFER_SIZE 1024
45 #define COMPONENTS 4 // psnr & sse statistics maintained for total, y, u, v
47 typedef struct SvcInternal {
48 char options[OPTION_BUFFER_SIZE]; // set by vpx_svc_set_options
50 // values extracted from option, quantizers
51 vpx_svc_extra_cfg_t svc_params;
52 int enable_auto_alt_ref[VPX_SS_MAX_LAYERS];
53 int bitrates[VPX_SS_MAX_LAYERS];
55 // accumulated statistics
56 double psnr_sum[VPX_SS_MAX_LAYERS][COMPONENTS]; // total/Y/U/V
57 uint64_t sse_sum[VPX_SS_MAX_LAYERS][COMPONENTS];
58 uint32_t bytes_sum[VPX_SS_MAX_LAYERS];
60 // codec encoding values
61 int width; // width of highest layer
62 int height; // height of highest layer
63 int kf_dist; // distance between keyframes
66 int psnr_pkt_received;
68 int use_multiple_frame_contexts;
70 char message_buffer[2048];
71 vpx_codec_ctx_t *codec_ctx;
76 * options are supplied as a single string separated by spaces
77 * Format: encoding-mode=<i|ip|alt-ip|gf>
78 * layers=<layer_count>
79 * scaling-factors=<n1>/<d1>,<n2>/<d2>,...
80 * quantizers=<q1>,<q2>,...
82 vpx_codec_err_t vpx_svc_set_options(SvcContext_t *svc_ctx, const char *options);
85 * initialize SVC encoding
87 vpx_codec_err_t vpx_svc_init(SvcContext_t *svc_ctx,
88 vpx_codec_ctx_t *codec_ctx,
89 vpx_codec_iface_t *iface,
90 vpx_codec_enc_cfg_t *cfg);
92 * encode a frame of video with multiple layers
94 vpx_codec_err_t vpx_svc_encode(SvcContext_t *svc_ctx,
95 vpx_codec_ctx_t *codec_ctx,
96 struct vpx_image *rawimg,
98 int64_t duration, int deadline);
101 * finished with svc encoding, release allocated resources
103 void vpx_svc_release(SvcContext_t *svc_ctx);
106 * dump accumulated statistics and reset accumulated values
108 const char *vpx_svc_dump_statistics(SvcContext_t *svc_ctx);
111 * get status message from previous encode
113 const char *vpx_svc_get_message(const SvcContext_t *svc_ctx);
119 #endif // VPX_SVC_CONTEXT_H_