Read/write functions
[Reading/writing images]

---

Detailed Description

All read/write functions

• read_* functions read specified frame/field from file.
• write_* functions write specified frame/field to file.
• *field* functions only operate on interlaced formats (these functions are not supported for progressive formats).
• *frame* functions operate on both interlaced and progressive formats (for interlaced formats two fields are combined within one frame).
• *_planar functions operate on formats with three components (rgb & planar yuv files).
• *_16 functions operate on buffers of type unsigned short.

See also Definition of images

Parameters:

	filename	name of file to read/write.
	header	header (for read functions: first read with p_read_header; for write functions: written with p_write_header).
	frame	frame number to read/write (1,2,3,...).
	field	field number to read/write (1 or 2).
	y_fld	address of Y buffer.
	y_or_s_frm	address of Y or S buffer.
	y_or_r_fld/y_or_r_frm	address of Y or R buffer.
	uv_fld/uv_frm	address of U/V buffer.
	u_or_g_fld/u_or_g_frm	address of U or G buffer.
	v_or_b_fld/v_or_b_frm	address of V or B buffer.
	read_mode	= component_mode | mem_data_fmt, also see Reading/writing images.
	write_mode	= mem_data_fmt, also see mem_data_fmt.
	width	width of field/frame in memory.
	fld_height	height of field in memory.
	frm_height	height of frame in memory.
	stride	stride of field/frame in memory.
	uv_stride	U & V buffer stride of field/frame in memory: if set to zero the Y buffer stride is taken. don't care for RGB files.

Functions
pT_status	p_read_field (const char *filename, pT_header *header, int frame, int field, unsigned char *y_fld, unsigned char *uv_fld, int read_mode, int width, int fld_height, int stride)
pT_status	p_read_frame (const char *filename, pT_header *header, int frame, unsigned char *y_or_s_frm, unsigned char *uv_frm, int read_mode, int width, int frm_height, int stride)
pT_status	p_write_field (const char *filename, pT_header *header, int frame, int field, const unsigned char *y_fld, const unsigned char *uv_fld, int width, int fld_height, int stride)
pT_status	p_write_frame (const char *filename, pT_header *header, int frame, const unsigned char *y_or_s_frm, const unsigned char *uv_frm, int width, int frm_height, int stride)
pT_status	p_read_field_16 (const char *filename, pT_header *header, int frame, int field, unsigned short *y_fld, unsigned short *uv_fld, int read_mode, int width, int fld_height, int stride)
pT_status	p_read_frame_16 (const char *filename, pT_header *header, int frame, unsigned short *y_or_s_frm, unsigned short *uv_frm, int read_mode, int width, int frm_height, int stride)
pT_status	p_write_field_16 (const char *filename, pT_header *header, int frame, int field, const unsigned short *y_fld, const unsigned short *uv_fld, int write_mode, int width, int fld_height, int stride)
pT_status	p_write_frame_16 (const char *filename, pT_header *header, int frame, const unsigned short *y_or_s_frm, const unsigned short *uv_frm, int write_mode, int width, int frm_height, int stride)
pT_status	p_read_field_planar (const char *filename, pT_header *header, int frame, int field, unsigned char *y_or_r_fld, unsigned char *u_or_g_fld, unsigned char *v_or_b_fld, int read_mode, int width, int fld_height, int stride, int uv_stride)
pT_status	p_read_frame_planar (const char *filename, pT_header *header, int frame, unsigned char *y_or_r_frm, unsigned char *u_or_g_frm, unsigned char *v_or_b_frm, int read_mode, int width, int frm_height, int stride, int uv_stride)
pT_status	p_write_field_planar (const char *filename, pT_header *header, int frame, int field, const unsigned char *y_or_r_fld, const unsigned char *u_or_g_fld, const unsigned char *v_or_b_fld, int width, int fld_height, int stride, int uv_stride)
pT_status	p_write_frame_planar (const char *filename, pT_header *header, int frame, const unsigned char *y_or_r_frm, const unsigned char *u_or_g_frm, const unsigned char *v_or_b_frm, int width, int frm_height, int stride, int uv_stride)
pT_status	p_read_field_planar_16 (const char *filename, pT_header *header, int frame, int field, unsigned short *y_or_r_fld, unsigned short *u_or_g_fld, unsigned short *v_or_b_fld, int read_mode, int width, int fld_height, int stride, int uv_stride)
pT_status	p_read_frame_planar_16 (const char *filename, pT_header *header, int frame, unsigned short *y_or_r_frm, unsigned short *u_or_g_frm, unsigned short *v_or_b_frm, int read_mode, int width, int frm_height, int stride, int uv_stride)
pT_status	p_write_field_planar_16 (const char *filename, pT_header *header, int frame, int field, const unsigned short *y_or_r_fld, const unsigned short *u_or_g_fld, const unsigned short *v_or_b_fld, int write_mode, int width, int fld_height, int stride, int uv_stride)
pT_status	p_write_frame_planar_16 (const char *filename, pT_header *header, int frame, const unsigned short *y_or_r_frm, const unsigned short *u_or_g_frm, const unsigned short *v_or_b_frm, int write_mode, int width, int frm_height, int stride, int uv_stride)

---

Function Documentation

pT_status p_read_field (  const char *  filename, pT_header *  header, int  frame, int  field, unsigned char *  y_fld, unsigned char *  uv_fld, int  read_mode, int  width, int  fld_height, int  stride )

pT_status p_read_frame (  const char *  filename, pT_header *  header, int  frame, unsigned char *  y_or_s_frm, unsigned char *  uv_frm, int  read_mode, int  width, int  frm_height, int  stride )

pT_status p_write_field (  const char *  filename, pT_header *  header, int  frame, int  field, const unsigned char *  y_fld, const unsigned char *  uv_fld, int  width, int  fld_height, int  stride )

pT_status p_write_frame (  const char *  filename, pT_header *  header, int  frame, const unsigned char *  y_or_s_frm, const unsigned char *  uv_frm, int  width, int  frm_height, int  stride )

pT_status p_read_field_16 (  const char *  filename, pT_header *  header, int  frame, int  field, unsigned short *  y_fld, unsigned short *  uv_fld, int  read_mode, int  width, int  fld_height, int  stride )

pT_status p_read_frame_16 (  const char *  filename, pT_header *  header, int  frame, unsigned short *  y_or_s_frm, unsigned short *  uv_frm, int  read_mode, int  width, int  frm_height, int  stride )

pT_status p_write_field_16 (  const char *  filename, pT_header *  header, int  frame, int  field, const unsigned short *  y_fld, const unsigned short *  uv_fld, int  write_mode, int  width, int  fld_height, int  stride )

pT_status p_write_frame_16 (  const char *  filename, pT_header *  header, int  frame, const unsigned short *  y_or_s_frm, const unsigned short *  uv_frm, int  write_mode, int  width, int  frm_height, int  stride )

pT_status p_read_field_planar (  const char *  filename, pT_header *  header, int  frame, int  field, unsigned char *  y_or_r_fld, unsigned char *  u_or_g_fld, unsigned char *  v_or_b_fld, int  read_mode, int  width, int  fld_height, int  stride, int  uv_stride )

pT_status p_read_frame_planar (  const char *  filename, pT_header *  header, int  frame, unsigned char *  y_or_r_frm, unsigned char *  u_or_g_frm, unsigned char *  v_or_b_frm, int  read_mode, int  width, int  frm_height, int  stride, int  uv_stride )

pT_status p_write_field_planar (  const char *  filename, pT_header *  header, int  frame, int  field, const unsigned char *  y_or_r_fld, const unsigned char *  u_or_g_fld, const unsigned char *  v_or_b_fld, int  width, int  fld_height, int  stride, int  uv_stride )

pT_status p_write_frame_planar (  const char *  filename, pT_header *  header, int  frame, const unsigned char *  y_or_r_frm, const unsigned char *  u_or_g_frm, const unsigned char *  v_or_b_frm, int  width, int  frm_height, int  stride, int  uv_stride )

pT_status p_read_field_planar_16 (  const char *  filename, pT_header *  header, int  frame, int  field, unsigned short *  y_or_r_fld, unsigned short *  u_or_g_fld, unsigned short *  v_or_b_fld, int  read_mode, int  width, int  fld_height, int  stride, int  uv_stride )

pT_status p_read_frame_planar_16 (  const char *  filename, pT_header *  header, int  frame, unsigned short *  y_or_r_frm, unsigned short *  u_or_g_frm, unsigned short *  v_or_b_frm, int  read_mode, int  width, int  frm_height, int  stride, int  uv_stride )

pT_status p_write_field_planar_16 (  const char *  filename, pT_header *  header, int  frame, int  field, const unsigned short *  y_or_r_fld, const unsigned short *  u_or_g_fld, const unsigned short *  v_or_b_fld, int  write_mode, int  width, int  fld_height, int  stride, int  uv_stride )

pT_status p_write_frame_planar_16 (  const char *  filename, pT_header *  header, int  frame, const unsigned short *  y_or_r_frm, const unsigned short *  u_or_g_frm, const unsigned short *  v_or_b_frm, int  write_mode, int  width, int  frm_height, int  stride, int  uv_stride )

---