vp9_lookahead.h 3.19 KB
Newer Older
John Koleszar's avatar
John Koleszar committed
1
2
3
4
5
6
7
8
9
/*
 *  Copyright (c) 2011 The WebM project authors. All Rights Reserved.
 *
 *  Use of this source code is governed by a BSD-style license
 *  that can be found in the LICENSE file in the root of the source
 *  tree. An additional intellectual property rights grant can be found
 *  in the file PATENTS.  All contributing project authors may
 *  be found in the AUTHORS file in the root of the source tree.
 */
10

11
12
#ifndef VP9_ENCODER_VP9_LOOKAHEAD_H_
#define VP9_ENCODER_VP9_LOOKAHEAD_H_
13

John Koleszar's avatar
John Koleszar committed
14
15
16
#include "vpx_scale/yv12config.h"
#include "vpx/vpx_integer.h"

John Koleszar's avatar
John Koleszar committed
17
18
19
20
21
struct lookahead_entry {
  YV12_BUFFER_CONFIG  img;
  int64_t             ts_start;
  int64_t             ts_end;
  unsigned int        flags;
John Koleszar's avatar
John Koleszar committed
22
23
24
25
26
27
28
29
30
31
32
33
};


struct lookahead_ctx;

/**\brief Initializes the lookahead stage
 *
 * The lookahead stage is a queue of frame buffers on which some analysis
 * may be done when buffers are enqueued.
 *
 *
 */
34
struct lookahead_ctx *vp9_lookahead_init(unsigned int width,
John Koleszar's avatar
John Koleszar committed
35
36
                                         unsigned int height,
                                         unsigned int depth
John Koleszar's avatar
John Koleszar committed
37
                                        );
John Koleszar's avatar
John Koleszar committed
38
39
40
41
42


/**\brief Destroys the lookahead stage
 *
 */
43
void vp9_lookahead_destroy(struct lookahead_ctx *ctx);
John Koleszar's avatar
John Koleszar committed
44
45
46
47
48
49
50


/**\brief Enqueue a source buffer
 *
 * This function will copy the source image into a new framebuffer with
 * the expected stride/border.
 *
51
52
53
54
55
56
57
58
59
 * If active_map is non-NULL and there is only one frame in the queue, then copy
 * only active macroblocks.
 *
 * \param[in] ctx         Pointer to the lookahead context
 * \param[in] src         Pointer to the image to enqueue
 * \param[in] ts_start    Timestamp for the start of this frame
 * \param[in] ts_end      Timestamp for the end of this frame
 * \param[in] flags       Flags set on this frame
 * \param[in] active_map  Map that specifies which macroblock is active
John Koleszar's avatar
John Koleszar committed
60
61
 */
int
62
vp9_lookahead_push(struct lookahead_ctx *ctx,
John Koleszar's avatar
John Koleszar committed
63
64
65
                   YV12_BUFFER_CONFIG   *src,
                   int64_t               ts_start,
                   int64_t               ts_end,
66
67
                   unsigned int          flags,
                   unsigned char        *active_map);
John Koleszar's avatar
John Koleszar committed
68
69
70
71
72
73
74
75
76
77
78
79
80


/**\brief Get the next source buffer to encode
 *
 *
 * \param[in] ctx       Pointer to the lookahead context
 * \param[in] drain     Flag indicating the buffer should be drained
 *                      (return a buffer regardless of the current queue depth)
 *
 * \retval NULL, if drain set and queue is empty
 * \retval NULL, if drain not set and queue not of the configured depth
 *
 */
John Koleszar's avatar
John Koleszar committed
81
struct lookahead_entry *
82
vp9_lookahead_pop(struct lookahead_ctx *ctx,
John Koleszar's avatar
John Koleszar committed
83
84
85
86
87
88
89
90
91
92
93
                  int                   drain);


/**\brief Get a future source buffer to encode
 *
 * \param[in] ctx       Pointer to the lookahead context
 * \param[in] index     Index of the frame to be returned, 0 == next frame
 *
 * \retval NULL, if no buffer exists at the specified index
 *
 */
John Koleszar's avatar
John Koleszar committed
94
struct lookahead_entry *
95
vp9_lookahead_peek(struct lookahead_ctx *ctx,
John Koleszar's avatar
John Koleszar committed
96
97
98
99
100
101
102
103
                   int                   index);


/**\brief Get the number of frames currently in the lookahead queue
 *
 * \param[in] ctx       Pointer to the lookahead context
 */
unsigned int
104
vp9_lookahead_depth(struct lookahead_ctx *ctx);
John Koleszar's avatar
John Koleszar committed
105

106
#endif  // VP9_ENCODER_VP9_LOOKAHEAD_H_