xref: /third_party/ffmpeg/libavcodec/h274.h (revision cabdff1a)
1/*
2 * H.274 film grain synthesis
3 * Copyright (c) 2021 Niklas Haas <ffmpeg@haasn.xyz>
4 *
5 * This file is part of FFmpeg.
6 *
7 * FFmpeg is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2.1 of the License, or (at your option) any later version.
11 *
12 * FFmpeg is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15 * Lesser General Public License for more details.
16 *
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with FFmpeg; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20 */
21
22/**
23 * @file
24 * H.274 film grain synthesis.
25 * @author Niklas Haas <ffmpeg@haasn.xyz>
26 */
27
28#ifndef AVCODEC_H274_H
29#define AVCODEC_H274_H
30
31#include "libavutil/film_grain_params.h"
32
33// Must be initialized to {0} prior to first usage
34typedef struct H274FilmGrainDatabase {
35    // Database of film grain patterns, lazily computed as-needed
36    int8_t db[13 /* h */][13 /* v */][64][64];
37    uint16_t residency[13 /* h */]; // bit field of v
38
39    // Temporary buffer for slice generation
40    int16_t slice_tmp[64][64];
41} H274FilmGrainDatabase;
42
43// Synthesizes film grain on top of `in` and stores the result to `out`. `out`
44// must already have been allocated and set to the same size and format as
45// `in`.
46//
47// Returns a negative error code on error, such as invalid params.
48int ff_h274_apply_film_grain(AVFrame *out, const AVFrame *in,
49                             H274FilmGrainDatabase *db,
50                             const AVFilmGrainParams *params);
51
52#endif /* AVCODEC_H274_H */
53