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   double framerate;
26   int avg_frame_size;
27   TWO_PASS twopass;
28   struct vpx_fixed_buf rc_twopass_stats_in;
29   unsigned int current_video_frame_in_layer;
30   int is_key_frame;
31   vpx_svc_parameters_t svc_params_received;
32   struct lookahead_entry  *alt_ref_source;
33   int alt_ref_idx;
34   int gold_ref_idx;
35   int has_alt_frame;
36   size_t layer_size;
37 } LAYER_CONTEXT;
38 
39 typedef struct {
40   int spatial_layer_id;
41   int temporal_layer_id;
42   int number_spatial_layers;
43   int number_temporal_layers;
44 
45   // Store scaled source frames to be used for temporal filter to generate
46   // a alt ref frame.
47   YV12_BUFFER_CONFIG scaled_frames[MAX_LAG_BUFFERS];
48 
49   // Layer context used for rate control in one pass temporal CBR mode or
50   // two pass spatial mode. Defined for temporal or spatial layers for now.
51   // Does not support temporal combined with spatial RC.
52   LAYER_CONTEXT layer_context[MAX(VPX_TS_MAX_LAYERS, VPX_SS_MAX_LAYERS)];
53 } SVC;
54 
55 struct VP9_COMP;
56 
57 // Initialize layer context data from init_config().
58 void vp9_init_layer_context(struct VP9_COMP *const cpi);
59 
60 // Update the layer context from a change_config() call.
61 void vp9_update_layer_context_change_config(struct VP9_COMP *const cpi,
62                                             const int target_bandwidth);
63 
64 // Prior to encoding the frame, update framerate-related quantities
65 // for the current temporal layer.
66 void vp9_update_temporal_layer_framerate(struct VP9_COMP *const cpi);
67 
68 // Update framerate-related quantities for the current spatial layer.
69 void vp9_update_spatial_layer_framerate(struct VP9_COMP *const cpi,
70                                         double framerate);
71 
72 // Prior to encoding the frame, set the layer context, for the current layer
73 // to be encoded, to the cpi struct.
74 void vp9_restore_layer_context(struct VP9_COMP *const cpi);
75 
76 // Save the layer context after encoding the frame.
77 void vp9_save_layer_context(struct VP9_COMP *const cpi);
78 
79 // Initialize second pass rc for spatial svc.
80 void vp9_init_second_pass_spatial_svc(struct VP9_COMP *cpi);
81 
82 // Increment number of video frames in layer
83 void vp9_inc_frame_in_layer(SVC *svc);
84 
85 // Check if current layer is key frame in spatial upper layer
86 int vp9_is_upper_layer_key_frame(const struct VP9_COMP *const cpi);
87 
88 // Copy the source image, flags and svc parameters into a new framebuffer
89 // with the expected stride/border
90 int vp9_svc_lookahead_push(const struct VP9_COMP *const cpi,
91                            struct lookahead_ctx *ctx, YV12_BUFFER_CONFIG *src,
92                            int64_t ts_start, int64_t ts_end,
93                            unsigned int flags);
94 
95 // Get the next source buffer to encode
96 struct lookahead_entry *vp9_svc_lookahead_pop(struct VP9_COMP *const cpi,
97                                               struct lookahead_ctx *ctx,
98                                               int drain);
99 
100 // Get a future source buffer to encode
101 struct lookahead_entry *vp9_svc_lookahead_peek(struct VP9_COMP *const cpi,
102                                                struct lookahead_ctx *ctx,
103                                                int index, int copy_params);
104 
105 #ifdef __cplusplus
106 }  // extern "C"
107 #endif
108 
109 #endif  // VP9_ENCODER_VP9_SVC_LAYERCONTEXT_
110