1 /*
2  *  Copyright (c) 2014 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 #ifndef VP9_ENCODER_VP9_SVC_LAYERCONTEXT_H_
12 #define VP9_ENCODER_VP9_SVC_LAYERCONTEXT_H_
13 
14 #include "vpx/vpx_encoder.h"
15 
16 #include "vp9/encoder/vp9_ratectrl.h"
17 
18 #ifdef __cplusplus
19 extern "C" {
20 #endif
21 
22 typedef struct {
23   RATE_CONTROL rc;
24   int target_bandwidth;
25   int spatial_layer_target_bandwidth;  // Target for the spatial layer.
26   double framerate;
27   int avg_frame_size;
28   int max_q;
29   int min_q;
30   int scaling_factor_num;
31   int scaling_factor_den;
32   TWO_PASS twopass;
33   vpx_fixed_buf_t rc_twopass_stats_in;
34   unsigned int current_video_frame_in_layer;
35   int is_key_frame;
36   int frames_from_key_frame;
37   FRAME_TYPE last_frame_type;
38   struct lookahead_entry  *alt_ref_source;
39   int alt_ref_idx;
40   int gold_ref_idx;
41   int has_alt_frame;
42   size_t layer_size;
43   struct vpx_psnr_pkt psnr_pkt;
44   // Cyclic refresh parameters (aq-mode=3), that need to be updated per-frame.
45   int sb_index;
46   signed char *map;
47   uint8_t *last_coded_q_map;
48   uint8_t *consec_zero_mv;
49 } LAYER_CONTEXT;
50 
51 typedef struct {
52   int spatial_layer_id;
53   int temporal_layer_id;
54   int number_spatial_layers;
55   int number_temporal_layers;
56 
57   int spatial_layer_to_encode;
58   int first_spatial_layer_to_encode;
59 
60   // Workaround for multiple frame contexts
61   enum {
62     ENCODED = 0,
63     ENCODING,
64     NEED_TO_ENCODE
65   }encode_empty_frame_state;
66   struct lookahead_entry empty_frame;
67   int encode_intra_empty_frame;
68 
69   // Store scaled source frames to be used for temporal filter to generate
70   // a alt ref frame.
71   YV12_BUFFER_CONFIG scaled_frames[MAX_LAG_BUFFERS];
72 
73   // Layer context used for rate control in one pass temporal CBR mode or
74   // two pass spatial mode.
75   LAYER_CONTEXT layer_context[VPX_MAX_LAYERS];
76   // Indicates what sort of temporal layering is used.
77   // Currently, this only works for CBR mode.
78   VP9E_TEMPORAL_LAYERING_MODE temporal_layering_mode;
79   // Frame flags and buffer indexes for each spatial layer, set by the
80   // application (external settings).
81   int ext_frame_flags[VPX_MAX_LAYERS];
82   int ext_lst_fb_idx[VPX_MAX_LAYERS];
83   int ext_gld_fb_idx[VPX_MAX_LAYERS];
84   int ext_alt_fb_idx[VPX_MAX_LAYERS];
85 } SVC;
86 
87 struct VP9_COMP;
88 
89 // Initialize layer context data from init_config().
90 void vp9_init_layer_context(struct VP9_COMP *const cpi);
91 
92 // Update the layer context from a change_config() call.
93 void vp9_update_layer_context_change_config(struct VP9_COMP *const cpi,
94                                             const int target_bandwidth);
95 
96 // Prior to encoding the frame, update framerate-related quantities
97 // for the current temporal layer.
98 void vp9_update_temporal_layer_framerate(struct VP9_COMP *const cpi);
99 
100 // Update framerate-related quantities for the current spatial layer.
101 void vp9_update_spatial_layer_framerate(struct VP9_COMP *const cpi,
102                                         double framerate);
103 
104 // Prior to encoding the frame, set the layer context, for the current layer
105 // to be encoded, to the cpi struct.
106 void vp9_restore_layer_context(struct VP9_COMP *const cpi);
107 
108 // Save the layer context after encoding the frame.
109 void vp9_save_layer_context(struct VP9_COMP *const cpi);
110 
111 // Initialize second pass rc for spatial svc.
112 void vp9_init_second_pass_spatial_svc(struct VP9_COMP *cpi);
113 
114 // Increment number of video frames in layer
115 void vp9_inc_frame_in_layer(struct VP9_COMP *const cpi);
116 
117 // Check if current layer is key frame in spatial upper layer
118 int vp9_is_upper_layer_key_frame(const struct VP9_COMP *const cpi);
119 
120 // Get the next source buffer to encode
121 struct lookahead_entry *vp9_svc_lookahead_pop(struct VP9_COMP *const cpi,
122                                               struct lookahead_ctx *ctx,
123                                               int drain);
124 
125 // Start a frame and initialize svc parameters
126 int vp9_svc_start_frame(struct VP9_COMP *const cpi);
127 
128 int vp9_one_pass_cbr_svc_start_layer(struct VP9_COMP *const cpi);
129 
130 void vp9_free_svc_cyclic_refresh(struct VP9_COMP *const cpi);
131 
132 #ifdef __cplusplus
133 }  // extern "C"
134 #endif
135 
136 #endif  // VP9_ENCODER_VP9_SVC_LAYERCONTEXT_
137