• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  *  Copyright (c) 2011 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_LOOKAHEAD_H_
12 #define VP9_ENCODER_VP9_LOOKAHEAD_H_
13 
14 #include "vpx_scale/yv12config.h"
15 #include "vpx/vpx_encoder.h"
16 #include "vpx/vpx_integer.h"
17 
18 #if CONFIG_SPATIAL_SVC
19 #include "vpx/vp8cx.h"
20 #endif
21 
22 #ifdef __cplusplus
23 extern "C" {
24 #endif
25 
26 #define MAX_LAG_BUFFERS 25
27 
28 struct lookahead_entry {
29   YV12_BUFFER_CONFIG img;
30   int64_t ts_start;
31   int64_t ts_end;
32   vpx_enc_frame_flags_t flags;
33 };
34 
35 // The max of past frames we want to keep in the queue.
36 #define MAX_PRE_FRAMES 1
37 
38 struct lookahead_ctx {
39   int max_sz;                  /* Absolute size of the queue */
40   int sz;                      /* Number of buffers currently in the queue */
41   int read_idx;                /* Read index */
42   int write_idx;               /* Write index */
43   struct lookahead_entry *buf; /* Buffer list */
44 };
45 
46 /**\brief Initializes the lookahead stage
47  *
48  * The lookahead stage is a queue of frame buffers on which some analysis
49  * may be done when buffers are enqueued.
50  */
51 struct lookahead_ctx *vp9_lookahead_init(unsigned int width,
52                                          unsigned int height,
53                                          unsigned int subsampling_x,
54                                          unsigned int subsampling_y,
55 #if CONFIG_VP9_HIGHBITDEPTH
56                                          int use_highbitdepth,
57 #endif
58                                          unsigned int depth);
59 
60 /**\brief Destroys the lookahead stage
61  */
62 void vp9_lookahead_destroy(struct lookahead_ctx *ctx);
63 
64 /**\brief Enqueue a source buffer
65  *
66  * This function will copy the source image into a new framebuffer with
67  * the expected stride/border.
68  *
69  * If active_map is non-NULL and there is only one frame in the queue, then copy
70  * only active macroblocks.
71  *
72  * \param[in] ctx         Pointer to the lookahead context
73  * \param[in] src         Pointer to the image to enqueue
74  * \param[in] ts_start    Timestamp for the start of this frame
75  * \param[in] ts_end      Timestamp for the end of this frame
76  * \param[in] flags       Flags set on this frame
77  * \param[in] active_map  Map that specifies which macroblock is active
78  */
79 int vp9_lookahead_push(struct lookahead_ctx *ctx, YV12_BUFFER_CONFIG *src,
80                        int64_t ts_start, int64_t ts_end,
81 #if CONFIG_VP9_HIGHBITDEPTH
82                        int use_highbitdepth,
83 #endif
84                        vpx_enc_frame_flags_t flags);
85 
86 /**\brief Get the next source buffer to encode
87  *
88  *
89  * \param[in] ctx       Pointer to the lookahead context
90  * \param[in] drain     Flag indicating the buffer should be drained
91  *                      (return a buffer regardless of the current queue depth)
92  *
93  * \retval NULL, if drain set and queue is empty
94  * \retval NULL, if drain not set and queue not of the configured depth
95  */
96 struct lookahead_entry *vp9_lookahead_pop(struct lookahead_ctx *ctx, int drain);
97 
98 /**\brief Get a future source buffer to encode
99  *
100  * \param[in] ctx       Pointer to the lookahead context
101  * \param[in] index     Index of the frame to be returned, 0 == next frame
102  *
103  * \retval NULL, if no buffer exists at the specified index
104  */
105 struct lookahead_entry *vp9_lookahead_peek(struct lookahead_ctx *ctx,
106                                            int index);
107 
108 /**\brief Get the number of frames currently in the lookahead queue
109  *
110  * \param[in] ctx       Pointer to the lookahead context
111  */
112 unsigned int vp9_lookahead_depth(struct lookahead_ctx *ctx);
113 
114 #ifdef __cplusplus
115 }  // extern "C"
116 #endif
117 
118 #endif  // VP9_ENCODER_VP9_LOOKAHEAD_H_
119