comparison imgutils.h @ 22:0899fc09d43c libavcore

Adopt a hierarchical name scheme for the imgutils.h API. Simplify grepping and somewhat more consistent with the scheme adopted by other FFmpeg modules API.
author stefano
date Tue, 07 Sep 2010 19:15:17 +0000
parents 3b8eec1cfdaa
children 478992775cf8
comparison
equal deleted inserted replaced
21:3b8eec1cfdaa 22:0899fc09d43c
41 * components, the computed max_pixsteps[plane] is relative to the 41 * components, the computed max_pixsteps[plane] is relative to the
42 * component in the plane with the max pixel step. 42 * component in the plane with the max pixel step.
43 * @param max_pixstep_comps an array which is filled with the component 43 * @param max_pixstep_comps an array which is filled with the component
44 * for each plane which has the max pixel step. May be NULL. 44 * for each plane which has the max pixel step. May be NULL.
45 */ 45 */
46 void av_fill_image_max_pixsteps(int max_pixsteps[4], int max_pixstep_comps[4], 46 void av_image_fill_max_pixsteps(int max_pixsteps[4], int max_pixstep_comps[4],
47 const AVPixFmtDescriptor *pixdesc); 47 const AVPixFmtDescriptor *pixdesc);
48 48
49 /** 49 /**
50 * Compute the size of an image line with format pix_fmt and width 50 * Compute the size of an image line with format pix_fmt and width
51 * width for the plane plane. 51 * width for the plane plane.
52 * 52 *
53 * @return the computed size in bytes 53 * @return the computed size in bytes
54 */ 54 */
55 int av_get_image_linesize(enum PixelFormat pix_fmt, int width, int plane); 55 int av_image_get_linesize(enum PixelFormat pix_fmt, int width, int plane);
56 56
57 /** 57 /**
58 * Fill plane linesizes for an image with pixel format pix_fmt and 58 * Fill plane linesizes for an image with pixel format pix_fmt and
59 * width width. 59 * width width.
60 * 60 *
61 * @param linesizes array to be filled with the linesize for each plane 61 * @param linesizes array to be filled with the linesize for each plane
62 * @return >= 0 in case of success, a negative error code otherwise 62 * @return >= 0 in case of success, a negative error code otherwise
63 */ 63 */
64 int av_fill_image_linesizes(int linesizes[4], enum PixelFormat pix_fmt, int width); 64 int av_image_fill_linesizes(int linesizes[4], enum PixelFormat pix_fmt, int width);
65 65
66 /** 66 /**
67 * Fill plane data pointers for an image with pixel format pix_fmt and 67 * Fill plane data pointers for an image with pixel format pix_fmt and
68 * height height. 68 * height height.
69 * 69 *
72 * @param linesizes[4] the array containing the linesize for each 72 * @param linesizes[4] the array containing the linesize for each
73 * plane, should be filled by av_fill_image_linesizes() 73 * plane, should be filled by av_fill_image_linesizes()
74 * @return the size in bytes required for the image buffer, a negative 74 * @return the size in bytes required for the image buffer, a negative
75 * error code in case of failure 75 * error code in case of failure
76 */ 76 */
77 int av_fill_image_pointers(uint8_t *data[4], enum PixelFormat pix_fmt, int height, 77 int av_image_fill_pointers(uint8_t *data[4], enum PixelFormat pix_fmt, int height,
78 uint8_t *ptr, const int linesizes[4]); 78 uint8_t *ptr, const int linesizes[4]);
79 79
80 /** 80 /**
81 * Check if the given dimension of an image is valid, meaning that all 81 * Check if the given dimension of an image is valid, meaning that all
82 * bytes of the image can be addressed with a signed int. 82 * bytes of the image can be addressed with a signed int.
85 * @param h the height of the picture 85 * @param h the height of the picture
86 * @param log_offset the offset to sum to the log level for logging with log_ctx 86 * @param log_offset the offset to sum to the log level for logging with log_ctx
87 * @param log_ctx the parent logging context, it may be NULL 87 * @param log_ctx the parent logging context, it may be NULL
88 * @return >= 0 if valid, a negative error code otherwise 88 * @return >= 0 if valid, a negative error code otherwise
89 */ 89 */
90 int av_image_check_size(unsigned int w, unsigned int h, int log_offset, void *log_ctx);
91
92 #if FF_API_OLD_IMAGE_NAMES
93 attribute_deprecated
94 void av_fill_image_max_pixsteps(int max_pixsteps[4], int max_pixstep_comps[4],
95 const AVPixFmtDescriptor *pixdesc);
96
97 attribute_deprecated
98 int av_get_image_linesize(enum PixelFormat pix_fmt, int width, int plane);
99
100 attribute_deprecated
101 int av_fill_image_linesizes(int linesizes[4], enum PixelFormat pix_fmt, int width);
102
103 attribute_deprecated
104 int av_fill_image_pointers(uint8_t *data[4], enum PixelFormat pix_fmt, int height,
105 uint8_t *ptr, const int linesizes[4]);
106
107 attribute_deprecated
90 int av_check_image_size(unsigned int w, unsigned int h, int log_offset, void *log_ctx); 108 int av_check_image_size(unsigned int w, unsigned int h, int log_offset, void *log_ctx);
109 #endif
91 110
92 #endif /* AVCORE_IMGUTILS_H */ 111 #endif /* AVCORE_IMGUTILS_H */