Clarify comment about parity nibble.
[libav.git] / libpostproc / postprocess.h
1 /*
2 * Copyright (C) 2001-2003 Michael Niedermayer (michaelni@gmx.at)
3 *
4 * This file is part of FFmpeg.
5 *
6 * FFmpeg is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (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
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * 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 FFMPEG_POSTPROCESS_H
22 #define FFMPEG_POSTPROCESS_H
23
24 /**
25 * @file postprocess.h
26 * @brief
27 * external postprocessing API
28 */
29
30 #include "libavutil/avutil.h"
31
32 #define LIBPOSTPROC_VERSION_MAJOR 51
33 #define LIBPOSTPROC_VERSION_MINOR 1
34 #define LIBPOSTPROC_VERSION_MICRO 0
35
36 #define LIBPOSTPROC_VERSION_INT AV_VERSION_INT(LIBPOSTPROC_VERSION_MAJOR, \
37 LIBPOSTPROC_VERSION_MINOR, \
38 LIBPOSTPROC_VERSION_MICRO)
39 #define LIBPOSTPROC_VERSION AV_VERSION(LIBPOSTPROC_VERSION_MAJOR, \
40 LIBPOSTPROC_VERSION_MINOR, \
41 LIBPOSTPROC_VERSION_MICRO)
42 #define LIBPOSTPROC_BUILD LIBPOSTPROC_VERSION_INT
43
44 #define LIBPOSTPROC_IDENT "postproc" AV_STRINGIFY(LIBPOSTPROC_VERSION)
45
46 #define PP_QUALITY_MAX 6
47
48 #define QP_STORE_T int8_t
49
50 #include <inttypes.h>
51
52 typedef void pp_context_t;
53 typedef void pp_mode_t;
54
55 #if LIBPOSTPROC_VERSION_INT < (52<<16)
56 extern const char *const pp_help; ///< a simple help text
57 #else
58 extern const char pp_help[]; ///< a simple help text
59 #endif
60
61 void pp_postprocess(const uint8_t * src[3], const int srcStride[3],
62 uint8_t * dst[3], const int dstStride[3],
63 int horizontalSize, int verticalSize,
64 const QP_STORE_T *QP_store, int QP_stride,
65 pp_mode_t *mode, pp_context_t *ppContext, int pict_type);
66
67
68 /**
69 * returns a pp_mode_t or NULL if an error occurred
70 * name is the string after "-pp" on the command line
71 * quality is a number from 0 to PP_QUALITY_MAX
72 */
73 pp_mode_t *pp_get_mode_by_name_and_quality(const char *name, int quality);
74 void pp_free_mode(pp_mode_t *mode);
75
76 pp_context_t *pp_get_context(int width, int height, int flags);
77 void pp_free_context(pp_context_t *ppContext);
78
79 #define PP_CPU_CAPS_MMX 0x80000000
80 #define PP_CPU_CAPS_MMX2 0x20000000
81 #define PP_CPU_CAPS_3DNOW 0x40000000
82 #define PP_CPU_CAPS_ALTIVEC 0x10000000
83
84 #define PP_FORMAT 0x00000008
85 #define PP_FORMAT_420 (0x00000011|PP_FORMAT)
86 #define PP_FORMAT_422 (0x00000001|PP_FORMAT)
87 #define PP_FORMAT_411 (0x00000002|PP_FORMAT)
88 #define PP_FORMAT_444 (0x00000000|PP_FORMAT)
89
90 #define PP_PICT_TYPE_QP2 0x00000010 ///< MPEG2 style QScale
91
92 #endif /* FFMPEG_POSTPROCESS_H */