1/*
2 * Mpeg video formats-related defines and utility functions
3 *
4 * This file is part of FFmpeg.
5 *
6 * FFmpeg is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
10 *
11 * FFmpeg is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14 * Lesser General Public License for more details.
15 *
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with FFmpeg; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19 */
20
21#ifndef AVCODEC_MPEGPICTURE_H
22#define AVCODEC_MPEGPICTURE_H
23
24#include <stdint.h>
25
26#include "libavutil/frame.h"
27
28#include "avcodec.h"
29#include "motion_est.h"
30#include "threadframe.h"
31
32#define MPEGVIDEO_MAX_PLANES 4
33#define MAX_PICTURE_COUNT 36
34#define EDGE_WIDTH 16
35
36typedef struct ScratchpadContext {
37    uint8_t *edge_emu_buffer;     ///< temporary buffer for if MVs point to out-of-frame data
38    uint8_t *rd_scratchpad;       ///< scratchpad for rate distortion mb decision
39    uint8_t *obmc_scratchpad;
40    uint8_t *b_scratchpad;        ///< scratchpad used for writing into write only buffers
41} ScratchpadContext;
42
43/**
44 * Picture.
45 */
46typedef struct Picture {
47    struct AVFrame *f;
48    ThreadFrame tf;
49
50    AVBufferRef *qscale_table_buf;
51    int8_t *qscale_table;
52
53    AVBufferRef *motion_val_buf[2];
54    int16_t (*motion_val[2])[2];
55
56    AVBufferRef *mb_type_buf;
57    uint32_t *mb_type;          ///< types and macros are defined in mpegutils.h
58
59    AVBufferRef *mbskip_table_buf;
60    uint8_t *mbskip_table;
61
62    AVBufferRef *ref_index_buf[2];
63    int8_t *ref_index[2];
64
65    AVBufferRef *mb_var_buf;
66    uint16_t *mb_var;           ///< Table for MB variances
67
68    AVBufferRef *mc_mb_var_buf;
69    uint16_t *mc_mb_var;        ///< Table for motion compensated MB variances
70
71    int alloc_mb_width;         ///< mb_width used to allocate tables
72    int alloc_mb_height;        ///< mb_height used to allocate tables
73    int alloc_mb_stride;        ///< mb_stride used to allocate tables
74
75    AVBufferRef *mb_mean_buf;
76    uint8_t *mb_mean;           ///< Table for MB luminance
77
78    AVBufferRef *hwaccel_priv_buf;
79    void *hwaccel_picture_private; ///< Hardware accelerator private data
80
81    int field_picture;          ///< whether or not the picture was encoded in separate fields
82
83    int64_t mb_var_sum;         ///< sum of MB variance for current frame
84    int64_t mc_mb_var_sum;      ///< motion compensated MB variance for current frame
85
86    int b_frame_score;
87    int needs_realloc;          ///< Picture needs to be reallocated (eg due to a frame size change)
88
89    int reference;
90    int shared;
91
92    uint64_t encoding_error[MPEGVIDEO_MAX_PLANES];
93} Picture;
94
95/**
96 * Allocate a Picture.
97 * The pixels are allocated/set by calling get_buffer() if shared = 0.
98 */
99int ff_alloc_picture(AVCodecContext *avctx, Picture *pic, MotionEstContext *me,
100                     ScratchpadContext *sc, int shared, int encoding,
101                     int chroma_x_shift, int chroma_y_shift, int out_format,
102                     int mb_stride, int mb_width, int mb_height, int b8_stride,
103                     ptrdiff_t *linesize, ptrdiff_t *uvlinesize);
104
105int ff_mpeg_framesize_alloc(AVCodecContext *avctx, MotionEstContext *me,
106                            ScratchpadContext *sc, int linesize);
107
108int ff_mpeg_ref_picture(AVCodecContext *avctx, Picture *dst, Picture *src);
109void ff_mpeg_unref_picture(AVCodecContext *avctx, Picture *picture);
110
111void ff_mpv_picture_free(AVCodecContext *avctx, Picture *pic);
112int ff_update_picture_tables(Picture *dst, const Picture *src);
113
114int ff_find_unused_picture(AVCodecContext *avctx, Picture *picture, int shared);
115
116#endif /* AVCODEC_MPEGPICTURE_H */
117