Make pp_help a constant array of characters to move it to .rodata.
[ffmpeg.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 api for the pp stuff
28  */
29
30 #define LIBPOSTPROC_VERSION_INT ((51<<16)+(1<<8)+0)
31 #define LIBPOSTPROC_VERSION     51.1.0
32 #define LIBPOSTPROC_BUILD       LIBPOSTPROC_VERSION_INT
33
34 #define LIBPOSTPROC_IDENT       "postproc" AV_STRINGIFY(LIBPOSTPROC_VERSION)
35
36 #define PP_QUALITY_MAX 6
37
38 #define QP_STORE_T int8_t
39
40 #include <inttypes.h>
41
42 typedef void pp_context_t;
43 typedef void pp_mode_t;
44
45 #if LIBPOSTPROC_VERSION_INT < (52<<16)
46 extern const char *const pp_help; ///< a simple help text
47 #else
48 extern const char pp_help[]; ///< a simple help text
49 #endif
50
51 void  pp_postprocess(uint8_t * src[3], int srcStride[3],
52                  uint8_t * dst[3], int dstStride[3],
53                  int horizontalSize, int verticalSize,
54                  QP_STORE_T *QP_store,  int QP_stride,
55                  pp_mode_t *mode, pp_context_t *ppContext, int pict_type);
56
57
58 /**
59  * returns a pp_mode_t or NULL if an error occured
60  * name is the string after "-pp" on the command line
61  * quality is a number from 0 to PP_QUALITY_MAX
62  */
63 pp_mode_t *pp_get_mode_by_name_and_quality(const char *name, int quality);
64 void pp_free_mode(pp_mode_t *mode);
65
66 pp_context_t *pp_get_context(int width, int height, int flags);
67 void pp_free_context(pp_context_t *ppContext);
68
69 #define PP_CPU_CAPS_MMX   0x80000000
70 #define PP_CPU_CAPS_MMX2  0x20000000
71 #define PP_CPU_CAPS_3DNOW 0x40000000
72 #define PP_CPU_CAPS_ALTIVEC 0x10000000
73
74 #define PP_FORMAT         0x00000008
75 #define PP_FORMAT_420    (0x00000011|PP_FORMAT)
76 #define PP_FORMAT_422    (0x00000001|PP_FORMAT)
77 #define PP_FORMAT_411    (0x00000002|PP_FORMAT)
78 #define PP_FORMAT_444    (0x00000000|PP_FORMAT)
79
80 #define PP_PICT_TYPE_QP2  0x00000010 ///< MPEG2 style QScale
81
82 #endif /* FFMPEG_POSTPROCESS_H */