mpv/video/img_format.h

343 lines
12 KiB
C

/*
* This file is part of mpv.
*
* mpv is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* mpv is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with mpv. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef MPLAYER_IMG_FORMAT_H
#define MPLAYER_IMG_FORMAT_H
#include <inttypes.h>
#include "config.h"
#include "osdep/endian.h"
#include "misc/bstr.h"
#include "video/csputils.h"
#define MP_MAX_PLANES 4
#define MP_NUM_COMPONENTS 4
// mp_imgfmt_desc.comps[] is set to useful values. Some types of formats will
// use comps[], but not set this flag, because it doesn't cover all requirements
// (for example MP_IMGFLAG_PACKED_SS_YUV).
#define MP_IMGFLAG_HAS_COMPS (1 << 0)
// all components start on byte boundaries
#define MP_IMGFLAG_BYTES (1 << 1)
// all pixels start in byte boundaries
#define MP_IMGFLAG_BYTE_ALIGNED (1 << 2)
// set if in little endian, or endian independent
#define MP_IMGFLAG_LE (1 << 3)
// set if in big endian, or endian independent
#define MP_IMGFLAG_BE (1 << 4)
// set if in native (host) endian, or endian independent
#define MP_IMGFLAG_NE MP_SELECT_LE_BE(MP_IMGFLAG_LE, MP_IMGFLAG_BE)
// set if an alpha component is included
#define MP_IMGFLAG_ALPHA (1 << 5)
// color class flags - can use via bit tests, or use the mask and compare
#define MP_IMGFLAG_COLOR_MASK (15 << 6)
#define MP_IMGFLAG_COLOR_YUV (1 << 6)
#define MP_IMGFLAG_COLOR_RGB (2 << 6)
#define MP_IMGFLAG_COLOR_XYZ (4 << 6)
// component type flags (same access conventions as MP_IMGFLAG_COLOR_*)
#define MP_IMGFLAG_TYPE_MASK (15 << 10)
#define MP_IMGFLAG_TYPE_UINT (1 << 10)
#define MP_IMGFLAG_TYPE_FLOAT (2 << 10)
#define MP_IMGFLAG_TYPE_PAL8 (4 << 10)
#define MP_IMGFLAG_TYPE_HW (8 << 10)
#define MP_IMGFLAG_YUV MP_IMGFLAG_COLOR_YUV
#define MP_IMGFLAG_RGB MP_IMGFLAG_COLOR_RGB
#define MP_IMGFLAG_PAL MP_IMGFLAG_TYPE_PAL8
#define MP_IMGFLAG_HWACCEL MP_IMGFLAG_TYPE_HW
// 1 component format (or 2 components if MP_IMGFLAG_ALPHA is set).
// This should probably be a separate MP_IMGFLAG_COLOR_GRAY, but for now it
// is too much of a mess.
#define MP_IMGFLAG_GRAY (1 << 14)
// Packed, sub-sampled YUV format. Does not apply to packed non-subsampled YUV.
// These formats pack multiple pixels into one sample with strange organization.
// In this specific case, mp_imgfmt_desc.align_x gives the size of a "full"
// pixel, which has align_x luma samples, and 1 chroma sample of each Cb and Cr.
// mp_imgfmt_desc.comps describes the chroma samples, and the first luma sample.
// All luma samples have the same configuration as the first one, and you can
// get their offsets with mp_imgfmt_get_packed_yuv_locations(). Note that the
// component offsets can be >= bpp[0]; the actual range is bpp[0]*align_x.
// These formats have no alpha.
#define MP_IMGFLAG_PACKED_SS_YUV (1 << 15)
// set if the format is in a standard YUV format:
// - planar and yuv colorspace
// - chroma shift 0-2
// - 1-4 planes (1: gray, 2: gray/alpha, 3: yuv, 4: yuv/alpha)
// - 8-16 bit per pixel/plane, all planes have same depth,
// each plane has exactly one component
#define MP_IMGFLAG_YUV_P (1 << 16)
// Like MP_IMGFLAG_YUV_P, but RGB. This can be e.g. AV_PIX_FMT_GBRP. The planes
// are always shuffled (G - B - R [- A]).
#define MP_IMGFLAG_RGB_P (1 << 17)
// Semi-planar YUV formats, like AV_PIX_FMT_NV12.
#define MP_IMGFLAG_YUV_NV (1 << 18)
struct mp_imgfmt_comp_desc {
// Plane on which this component is.
uint8_t plane;
// Bit offset of first sample, from start of the pixel group (little endian).
uint8_t offset : 6;
// Number of bits used by each sample.
uint8_t size : 6;
// Internal padding. See mp_regular_imgfmt.component_pad.
int8_t pad : 4;
};
struct mp_imgfmt_desc {
int id; // IMGFMT_*
int flags; // MP_IMGFLAG_* bitfield
int8_t num_planes;
int8_t chroma_xs, chroma_ys; // chroma shift (i.e. log2 of chroma pixel size)
int8_t align_x, align_y; // pixel count to get byte alignment and to get
// to a pixel pos where luma & chroma aligns
// always power of 2
int8_t bpp[MP_MAX_PLANES]; // bits per pixel (may be "average"; the real
// byte value is determined by align_x*bpp/8
// for align_x pixels)
// chroma shifts per plane (provided for convenience with planar formats)
// Packed YUV always uses xs[0]=ys[0]=0, because plane 0 contains luma in
// addition to chroma, and thus is not sub-sampled (uses align_x=2 instead).
int8_t xs[MP_MAX_PLANES];
int8_t ys[MP_MAX_PLANES];
// Description for each component. Generally valid only if flags has
// MP_IMGFLAG_HAS_COMPS set.
// This is indexed by component_type-1 (so 0=R, 1=G, etc.), see
// mp_regular_imgfmt_plane.components[x] for component_type. Components not
// present use size=0. Bits not covered by any component are random and not
// interpreted by any software.
// In particular, don't make the mistake to index this by plane.
struct mp_imgfmt_comp_desc comps[MP_NUM_COMPONENTS];
// log(2) of the word size in bytes for endian swapping that needs to be
// performed for converting to native endian. This is performed before any
// other unpacking steps, and for all data covered by bits.
// Always 0 if IMGFLAG_NE is set.
uint8_t endian_shift : 2;
};
struct mp_imgfmt_desc mp_imgfmt_get_desc(int imgfmt);
// Return the number of component types, or 0 if unknown.
int mp_imgfmt_desc_get_num_comps(struct mp_imgfmt_desc *desc);
// For MP_IMGFLAG_PACKED_SS_YUV formats (packed sub-sampled YUV): positions of
// further luma samples. luma_offsets must be an array of align_x size, and the
// function will return the offset (like in mp_imgfmt_comp_desc.offset) of each
// luma pixel. luma_offsets[0] == mp_imgfmt_desc.comps[0].offset.
bool mp_imgfmt_get_packed_yuv_locations(int imgfmt, uint8_t *luma_offsets);
// PL_COLOR_SYSTEM_UNKNOWN for YUV, PL_COLOR_SYSTEM_RGB or PL_COLOR_SYSTEM_XYZ otherwise.
// (Because IMGFMT/AV_PIX_FMT conflate format and csp for RGB and XYZ.)
enum pl_color_system mp_imgfmt_get_forced_csp(int imgfmt);
enum mp_component_type {
MP_COMPONENT_TYPE_UNKNOWN = 0,
MP_COMPONENT_TYPE_UINT,
MP_COMPONENT_TYPE_FLOAT,
};
enum mp_component_type mp_imgfmt_get_component_type(int imgfmt);
struct mp_regular_imgfmt_plane {
uint8_t num_components;
// 1 is red/luminance/gray, 2 is green/Cb, 3 is blue/Cr, 4 is alpha.
// 0 is used for padding (undefined contents).
// It is guaranteed that non-0 values occur only once in the whole format.
uint8_t components[MP_NUM_COMPONENTS];
};
// This describes pixel formats that are byte aligned, have byte aligned
// components, native endian, etc.
struct mp_regular_imgfmt {
// Type of each component.
enum mp_component_type component_type;
// See mp_imgfmt_get_forced_csp(). Normally code should use
// mp_image_params.colors. This field is only needed to map the format
// unambiguously to FFmpeg formats.
enum pl_color_system forced_csp;
// Size of each component in bytes.
uint8_t component_size;
// If >0, LSB padding, if <0, MSB padding. The padding bits are always 0.
// This applies: bit_depth = component_size * 8 - abs(component_pad)
// bit_size = component_size * 8 + MPMIN(0, component_pad)
// E.g. P010: component_pad=6 (LSB always implied 0, all data in MSB)
// => has a "depth" of 10 bit, but usually treated as 16 bit value
// yuv420p10: component_pad=-6 (like a 10 bit value 0-extended to 16)
// => has depth of 10 bit, needs <<6 to get a 16 bit value
int8_t component_pad;
uint8_t num_planes;
struct mp_regular_imgfmt_plane planes[MP_MAX_PLANES];
// Chroma shifts for chroma planes. 0/0 is 4:4:4 YUV or RGB. If not 0/0,
// then this is always a yuv format, with components 2/3 on separate planes
// (reduced by the shift), and planes for components 1/4 are full sized.
uint8_t chroma_xs, chroma_ys;
};
bool mp_get_regular_imgfmt(struct mp_regular_imgfmt *dst, int imgfmt);
int mp_find_regular_imgfmt(struct mp_regular_imgfmt *src);
// If imgfmt is valid, and there exists a format that is exactly the same, but
// has inverse endianness, return this other format. Otherwise return 0.
int mp_find_other_endian(int imgfmt);
enum mp_imgfmt {
IMGFMT_NONE = 0,
// Offset to make confusing with ffmpeg formats harder
IMGFMT_START = 1000,
// Planar YUV formats
IMGFMT_444P, // 1x1
IMGFMT_420P, // 2x2
// Gray
IMGFMT_Y8,
IMGFMT_Y16,
// Packed YUV formats (components are byte-accessed)
IMGFMT_UYVY, // U Y0 V Y1
// Y plane + packed plane for chroma
IMGFMT_NV12,
// Like IMGFMT_NV12, but with 10 bits per component (and 6 bits of padding)
IMGFMT_P010,
// RGB/BGR Formats
// Byte accessed (low address to high address)
IMGFMT_ARGB,
IMGFMT_BGRA,
IMGFMT_ABGR,
IMGFMT_RGBA,
IMGFMT_BGR24, // 3 bytes per pixel
IMGFMT_RGB24,
// Like e.g. IMGFMT_ARGB, but has a padding byte instead of alpha
IMGFMT_0RGB,
IMGFMT_BGR0,
IMGFMT_0BGR,
IMGFMT_RGB0,
// Like IMGFMT_RGBA, but 2 bytes per component.
IMGFMT_RGBA64,
// Accessed with bit-shifts after endian-swapping the uint16_t pixel
IMGFMT_RGB565, // 5r 6g 5b (MSB to LSB)
// AV_PIX_FMT_PAL8
IMGFMT_PAL8,
// Hardware accelerated formats. Plane data points to special data
// structures, instead of pixel data.
IMGFMT_VDPAU, // VdpVideoSurface
// plane 0: ID3D11Texture2D
// plane 1: slice index casted to pointer
IMGFMT_D3D11,
IMGFMT_DXVA2, // IDirect3DSurface9 (NV12/P010/P016)
IMGFMT_MMAL, // MMAL_BUFFER_HEADER_T
IMGFMT_MEDIACODEC, // AVMediaCodecBuffer
IMGFMT_CUDA, // CUDA Buffer
// Not an actual format; base for mpv-specific descriptor table.
// Some may still map to AV_PIX_FMT_*.
IMGFMT_CUST_BASE,
// Planar gray/alpha.
IMGFMT_YAP8,
IMGFMT_YAP16,
// Planar YUV/alpha formats. Sometimes useful for internal processing. There
// should be one for each subsampling factor, with and without alpha, gray.
IMGFMT_YAPF, // Note: non-alpha version exists in ffmpeg
IMGFMT_444PF,
IMGFMT_444APF,
IMGFMT_420PF,
IMGFMT_420APF,
IMGFMT_422PF,
IMGFMT_422APF,
IMGFMT_440PF,
IMGFMT_440APF,
IMGFMT_410PF,
IMGFMT_410APF,
IMGFMT_411PF,
IMGFMT_411APF,
// Accessed with bit-shifts, uint32_t units.
IMGFMT_RGB30, // 2pad 10r 10g 10b (MSB to LSB)
// Fringe formats for fringe RGB format repacking.
IMGFMT_Y1, // gray with 1 bit per pixel
IMGFMT_GBRP1, // planar RGB with N bits per color component
IMGFMT_GBRP2,
IMGFMT_GBRP3,
IMGFMT_GBRP4,
IMGFMT_GBRP5,
IMGFMT_GBRP6,
// Hardware accelerated formats (again).
IMGFMT_VDPAU_OUTPUT, // VdpOutputSurface
IMGFMT_VAAPI,
IMGFMT_VIDEOTOOLBOX, // CVPixelBufferRef
#if HAVE_VULKAN_INTEROP
IMGFMT_VULKAN, // VKImage
#endif
IMGFMT_DRMPRIME, // AVDRMFrameDescriptor
// Generic pass-through of AV_PIX_FMT_*. Used for formats which don't have
// a corresponding IMGFMT_ value.
IMGFMT_AVPIXFMT_START,
IMGFMT_AVPIXFMT_END = IMGFMT_AVPIXFMT_START + 500,
IMGFMT_END,
};
#define IMGFMT_IS_HWACCEL(fmt) (!!(mp_imgfmt_get_desc(fmt).flags & MP_IMGFLAG_HWACCEL))
int mp_imgfmt_from_name(bstr name);
char *mp_imgfmt_to_name_buf(char *buf, size_t buf_size, int fmt);
#define mp_imgfmt_to_name(fmt) mp_imgfmt_to_name_buf((char[16]){0}, 16, (fmt))
char **mp_imgfmt_name_list(void);
#define vo_format_name mp_imgfmt_to_name
int mp_imgfmt_select_best(int dst1, int dst2, int src);
int mp_imgfmt_select_best_list(int *dst, int num_dst, int src);
#endif /* MPLAYER_IMG_FORMAT_H */