pixdesc.h File Reference
#include <inttypes.h>
#include "pixfmt.h"

Go to the source code of this file.

Data Structures

struct  AVComponentDescriptor
struct  AVPixFmtDescriptor
 Descriptor that unambiguously describes how the bits of a pixel are stored in the up to 4 data planes of an image. More...

Macros

#define PIX_FMT_BE   1
 Pixel format is big-endian.
#define PIX_FMT_PAL   2
 Pixel format has a palette in data[1], values are indexes in this palette.
#define PIX_FMT_BITSTREAM   4
 All values of a component are bit-wise packed end to end.
#define PIX_FMT_HWACCEL   8
 Pixel format is an HW accelerated format.
#define PIX_FMT_PLANAR   16
 At least one pixel component is not in the first data plane.
#define PIX_FMT_RGB   32
 The pixel format contains RGB-like data (as opposed to YUV/grayscale)

Typedefs

typedef struct
AVComponentDescriptor 
AVComponentDescriptor
typedef struct AVPixFmtDescriptor AVPixFmtDescriptor
 Descriptor that unambiguously describes how the bits of a pixel are stored in the up to 4 data planes of an image.

Functions

void av_read_image_line (uint16_t *dst, const uint8_t *data[4], const int linesize[4], const AVPixFmtDescriptor *desc, int x, int y, int c, int w, int read_pal_component)
 Read a line from an image, and write the values of the pixel format component c to dst.
void av_write_image_line (const uint16_t *src, uint8_t *data[4], const int linesize[4], const AVPixFmtDescriptor *desc, int x, int y, int c, int w)
 Write the values from src to the pixel format component c of an image line.
enum PixelFormat av_get_pix_fmt (const char *name)
 Return the pixel format corresponding to name.
const char * av_get_pix_fmt_name (enum PixelFormat pix_fmt)
 Return the short name for a pixel format, NULL in case pix_fmt is unknown.
char * av_get_pix_fmt_string (char *buf, int buf_size, enum PixelFormat pix_fmt)
 Print in buf the string corresponding to the pixel format with number pix_fmt, or an header if pix_fmt is negative.
int av_get_bits_per_pixel (const AVPixFmtDescriptor *pixdesc)
 Return the number of bits per pixel used by the pixel format described by pixdesc.

Variables

const AVPixFmtDescriptor av_pix_fmt_descriptors []
 The array of all the pixel format descriptors.

Macro Definition Documentation

#define PIX_FMT_BE   1

Pixel format is big-endian.

Definition at line 86 of file pixdesc.h.

Referenced by av_read_image_line(), and av_write_image_line().

#define PIX_FMT_BITSTREAM   4

All values of a component are bit-wise packed end to end.

Definition at line 88 of file pixdesc.h.

Referenced by av_image_fill_linesizes(), av_image_get_linesize(), av_read_image_line(), av_write_image_line(), query_formats(), and show_pix_fmts().

#define PIX_FMT_HWACCEL   8

Pixel format is an HW accelerated format.

Definition at line 89 of file pixdesc.h.

Referenced by av_image_copy(), av_image_fill_linesizes(), av_image_fill_pointers(), avfilter_all_formats(), ff_is_hwaccel_pix_fmt(), query_formats(), and show_pix_fmts().

#define PIX_FMT_PAL   2

Pixel format has a palette in data[1], values are indexes in this palette.

Definition at line 87 of file pixdesc.h.

Referenced by av_image_alloc(), av_image_copy(), av_image_fill_pointers(), avpicture_layout(), config_props(), raw_decode(), show_pix_fmts(), and start_frame().

#define PIX_FMT_PLANAR   16

At least one pixel component is not in the first data plane.

Definition at line 90 of file pixdesc.h.

#define PIX_FMT_RGB   32

The pixel format contains RGB-like data (as opposed to YUV/grayscale)

Definition at line 91 of file pixdesc.h.

Typedef Documentation

Descriptor that unambiguously describes how the bits of a pixel are stored in the up to 4 data planes of an image.

It also stores the subsampling factors and number of components.

Note
This is separate of the colorspace (RGB, YCbCr, YPbPr, JPEG-style YUV and all the YUV variants) AVPixFmtDescriptor just stores how values are stored not what these values represent.

Function Documentation

int av_get_bits_per_pixel ( const AVPixFmtDescriptor pixdesc)

Return the number of bits per pixel used by the pixel format described by pixdesc.

The returned number of bits refers to the number of bits actually used for storing the pixel information, that is padding bits are not counted.

Definition at line 1135 of file pixdesc.c.

Referenced by av_get_pix_fmt_string(), config_props(), ff_fill_line_with_color(), raw_init_encoder(), show_pix_fmts(), sws_init_context(), and sws_setColorspaceDetails().

enum PixelFormat av_get_pix_fmt ( const char *  name)

Return the pixel format corresponding to name.

If there is no pixel format with name name, then looks for a pixel format with the name corresponding to the native endian format of name. For example in a little-endian system, first looks for "gray16", then for "gray16le".

Finally if no pixel format has been found, returns PIX_FMT_NONE.

Definition at line 1116 of file pixdesc.c.

Referenced by dc1394_read_common(), ff_raw_read_header(), fileTest(), init(), main(), new_video_stream(), opt_frame_pix_fmt(), read_header(), and v4l2_read_header().

const char* av_get_pix_fmt_name ( enum PixelFormat  pix_fmt)

Return the short name for a pixel format, NULL in case pix_fmt is unknown.

See Also
av_get_pix_fmt(), av_get_pix_fmt_string()

Definition at line 1104 of file pixdesc.c.

Referenced by avcodec_string(), dc1394_read_common(), do_video_out(), do_video_resample(), dvvideo_init_encoder(), list_formats(), opt_input_file(), targa_encode_frame(), and transcode_video().

char* av_get_pix_fmt_string ( char *  buf,
int  buf_size,
enum PixelFormat  pix_fmt 
)

Print in buf the string corresponding to the pixel format with number pix_fmt, or an header if pix_fmt is negative.

Parameters
bufthe buffer where to write the string
buf_sizethe size of buf
pix_fmtthe number of the pixel format to print the corresponding info string, or a negative value to print the corresponding header.

Definition at line 1148 of file pixdesc.c.

void av_read_image_line ( uint16_t *  dst,
const uint8_t *  data[4],
const int  linesize[4],
const AVPixFmtDescriptor desc,
int  x,
int  y,
int  c,
int  w,
int  read_pal_component 
)

Read a line from an image, and write the values of the pixel format component c to dst.

Parameters
datathe array containing the pointers to the planes of the image
linesizethe array containing the linesizes of the image
descthe pixel format descriptor for the image
xthe horizontal coordinate of the first pixel to read
ythe vertical coordinate of the first pixel to read
wthe width of the line to read, that is the number of values to write to dst
read_pal_componentif not zero and the format is a paletted format writes the values corresponding to the palette component c in data[1] to dst, rather than the palette indexes in data[0]. The behavior is undefined if the format is not paletted.

Definition at line 29 of file pixdesc.c.

Referenced by draw_slice().

void av_write_image_line ( const uint16_t *  src,
uint8_t *  data[4],
const int  linesize[4],
const AVPixFmtDescriptor desc,
int  x,
int  y,
int  c,
int  w 
)

Write the values from src to the pixel format component c of an image line.

Parameters
srcarray containing the values to write
datathe array containing the pointers to the planes of the image to write into. It is supposed to be zeroed.
linesizethe array containing the linesizes of the image
descthe pixel format descriptor for the image
xthe horizontal coordinate of the first pixel to write
ythe vertical coordinate of the first pixel to write
wthe width of the line to write, that is the number of values to write to the image line

Definition at line 74 of file pixdesc.c.

Referenced by draw_slice().

Variable Documentation