vidl_ffmpeg_ostream_params Struct Reference

A parameters struct for vidl_ffmpeg_ostream. More...

#include <vidl_ffmpeg_ostream_params.h>

List of all members.

Public Types
enum	encoder_type {   DEFAULT, MPEG4, MSMPEG4V2, MPEG2VIDEO,   DVVIDEO, LJPEG, RAWVIDEO, HUFFYUV,   ENCODER_END_MARKER }
	Available video encoders. More...
enum	file_format_type { GUESS }
	Supported video types. More...
Public Member Functions
	vidl_ffmpeg_ostream_params ()
	Construct to default values.
vidl_ffmpeg_ostream_params &	file_format (file_format_type t)
	Set the file format.
vidl_ffmpeg_ostream_params &	encoder (encoder_type t)
	Set the video encoder.
vidl_ffmpeg_ostream_params &	frame_rate (float r)
	Set the frame rate.
vidl_ffmpeg_ostream_params &	bit_rate (unsigned r)
	Set the bit rate.
vidl_ffmpeg_ostream_params &	size (unsigned ni, unsigned nj)
	Set the size of the frames.
Public Attributes
encoder_type	encoder_
	The type of encoder to use (default DEFAULT).
file_format_type	file_format_
	The file format to use (default GUESS).
float	frame_rate_
	Frame rate in frames/second. (default 25).
unsigned	bit_rate_
	Bit rate in bits/second. (Default 5000).
unsigned	ni_
	Width of a frame (default 640).
unsigned	nj_
	Height of a frame (default 480).
int	video_bit_rate_tolerance_
	static parameters from ffmpeg.c.
float	frame_aspect_ratio_
int	intra_only_
int	gop_size_
float	video_qscale_
int	same_quality_
int	mb_decision_
int	mb_cmp_
int	ildct_cmp_
int	sub_cmp_
int	cmp_
int	pre_cmp_
int	pre_me_
float	lumi_mask_
float	dark_mask_
float	scplx_mask_
float	tcplx_mask_
float	p_mask_
int	qns_
int	use_4mv_
int	use_obmc_
int	use_loop_
int	use_aic_
int	use_aiv_
int	use_umv_
int	use_ss_
int	use_alt_scan_
int	use_trell_
int	use_scan_offset_
int	use_part_
int	closed_gop_
int	use_qpel_
int	use_qprd_
int	use_cbprd_
int	b_frames_
int	do_interlace_dct_
int	do_interlace_me_
int	video_qmin_
int	video_qmax_
int	video_lmin_
int	video_lmax_
int	video_mb_qmin_
int	video_mb_qmax_
int	video_qdiff_
float	video_qblur_
float	video_qcomp_
vcl_string	video_rc_eq_
int	debug_
int	debug_mv_
int	video_rc_buffer_size_
float	video_rc_buffer_aggressivity_
int	video_rc_max_rate_
int	video_rc_min_rate_
float	video_rc_initial_cplx_
float	video_b_qfactor_
float	video_b_qoffset_
float	video_i_qfactor_
float	video_i_qoffset_
int	video_intra_quant_bias_
int	video_inter_quant_bias_
int	dct_algo_
int	idct_algo_
int	me_threshold_
int	mb_threshold_
int	intra_dc_precision_
int	strict_
int	error_rate_
int	noise_reduction_
int	sc_threshold_
int	coder_
int	context_
int	predictor_
int	me_range_
int	do_psnr_
int	packet_size_
int	me_method_
int	do_pass_

---

Detailed Description

A parameters struct for vidl_ffmpeg_ostream.

The setter functions are provided for convenience, so that the parameters can be set through an anonymous object.

   ostream.open( filename,
                 vidl_ffmpeg_ostream_params()
                 .encoder( vidl_ffmpeg_ostream_params::DVVIDEO )
                 .frame_rate( 29.95 ) );

Definition at line 31 of file vidl_ffmpeg_ostream_params.h.

---

Member Enumeration Documentation

enum vidl_ffmpeg_ostream_params::encoder_type

Available video encoders.

Enumerator:

DEFAULT
MPEG4
MSMPEG4V2
MPEG2VIDEO
DVVIDEO
LJPEG
RAWVIDEO
HUFFYUV
ENCODER_END_MARKER

Definition at line 34 of file vidl_ffmpeg_ostream_params.h.

enum vidl_ffmpeg_ostream_params::file_format_type

Supported video types.

Enumerator:

GUESS

Definition at line 45 of file vidl_ffmpeg_ostream_params.h.

---

Constructor & Destructor Documentation

vidl_ffmpeg_ostream_params::vidl_ffmpeg_ostream_params

(

)

Construct to default values.

Definition at line 127 of file vidl_ffmpeg_ostream_params.cxx.

---

Member Function Documentation

vidl_ffmpeg_ostream_params& vidl_ffmpeg_ostream_params::bit_rate

(

unsigned

r

)

[inline]

Set the bit rate.

Definition at line 171 of file vidl_ffmpeg_ostream_params.h.

vidl_ffmpeg_ostream_params& vidl_ffmpeg_ostream_params::encoder

(

encoder_type

t

)

[inline]

Set the video encoder.

Definition at line 163 of file vidl_ffmpeg_ostream_params.h.

vidl_ffmpeg_ostream_params& vidl_ffmpeg_ostream_params::file_format

(

file_format_type

t

)

[inline]

Set the file format.

Definition at line 159 of file vidl_ffmpeg_ostream_params.h.

vidl_ffmpeg_ostream_params& vidl_ffmpeg_ostream_params::frame_rate

(

float

r

)

[inline]

Set the frame rate.

Definition at line 167 of file vidl_ffmpeg_ostream_params.h.

vidl_ffmpeg_ostream_params& vidl_ffmpeg_ostream_params::size	(	unsigned	ni,
		unsigned	nj
	)		[inline]

Set the size of the frames.

Definition at line 175 of file vidl_ffmpeg_ostream_params.h.

---

Member Data Documentation

int vidl_ffmpeg_ostream_params::b_frames_

Definition at line 104 of file vidl_ffmpeg_ostream_params.h.

unsigned vidl_ffmpeg_ostream_params::bit_rate_

Bit rate in bits/second. (Default 5000).

Definition at line 58 of file vidl_ffmpeg_ostream_params.h.

int vidl_ffmpeg_ostream_params::closed_gop_

Definition at line 100 of file vidl_ffmpeg_ostream_params.h.

int vidl_ffmpeg_ostream_params::cmp_

Definition at line 80 of file vidl_ffmpeg_ostream_params.h.

int vidl_ffmpeg_ostream_params::coder_

Definition at line 139 of file vidl_ffmpeg_ostream_params.h.

int vidl_ffmpeg_ostream_params::context_

Definition at line 140 of file vidl_ffmpeg_ostream_params.h.

float vidl_ffmpeg_ostream_params::dark_mask_

Definition at line 84 of file vidl_ffmpeg_ostream_params.h.

int vidl_ffmpeg_ostream_params::dct_algo_

Definition at line 130 of file vidl_ffmpeg_ostream_params.h.

int vidl_ffmpeg_ostream_params::debug_

Definition at line 117 of file vidl_ffmpeg_ostream_params.h.

int vidl_ffmpeg_ostream_params::debug_mv_

Definition at line 118 of file vidl_ffmpeg_ostream_params.h.

int vidl_ffmpeg_ostream_params::do_interlace_dct_

Definition at line 105 of file vidl_ffmpeg_ostream_params.h.

int vidl_ffmpeg_ostream_params::do_interlace_me_

Definition at line 106 of file vidl_ffmpeg_ostream_params.h.

int vidl_ffmpeg_ostream_params::do_pass_

Definition at line 151 of file vidl_ffmpeg_ostream_params.h.

int vidl_ffmpeg_ostream_params::do_psnr_

Definition at line 148 of file vidl_ffmpeg_ostream_params.h.

encoder_type vidl_ffmpeg_ostream_params::encoder_

The type of encoder to use (default DEFAULT).

Definition at line 49 of file vidl_ffmpeg_ostream_params.h.

int vidl_ffmpeg_ostream_params::error_rate_

Definition at line 136 of file vidl_ffmpeg_ostream_params.h.

file_format_type vidl_ffmpeg_ostream_params::file_format_

The file format to use (default GUESS).

Definition at line 52 of file vidl_ffmpeg_ostream_params.h.

float vidl_ffmpeg_ostream_params::frame_aspect_ratio_

Definition at line 71 of file vidl_ffmpeg_ostream_params.h.

float vidl_ffmpeg_ostream_params::frame_rate_

Frame rate in frames/second. (default 25).

Definition at line 55 of file vidl_ffmpeg_ostream_params.h.

int vidl_ffmpeg_ostream_params::gop_size_

Definition at line 73 of file vidl_ffmpeg_ostream_params.h.

int vidl_ffmpeg_ostream_params::idct_algo_

Definition at line 131 of file vidl_ffmpeg_ostream_params.h.

int vidl_ffmpeg_ostream_params::ildct_cmp_

Definition at line 78 of file vidl_ffmpeg_ostream_params.h.

int vidl_ffmpeg_ostream_params::intra_dc_precision_

Definition at line 134 of file vidl_ffmpeg_ostream_params.h.

int vidl_ffmpeg_ostream_params::intra_only_

Definition at line 72 of file vidl_ffmpeg_ostream_params.h.

float vidl_ffmpeg_ostream_params::lumi_mask_

Definition at line 83 of file vidl_ffmpeg_ostream_params.h.

int vidl_ffmpeg_ostream_params::mb_cmp_

Definition at line 77 of file vidl_ffmpeg_ostream_params.h.

int vidl_ffmpeg_ostream_params::mb_decision_

Definition at line 76 of file vidl_ffmpeg_ostream_params.h.

int vidl_ffmpeg_ostream_params::mb_threshold_

Definition at line 133 of file vidl_ffmpeg_ostream_params.h.

int vidl_ffmpeg_ostream_params::me_method_

Definition at line 150 of file vidl_ffmpeg_ostream_params.h.

int vidl_ffmpeg_ostream_params::me_range_

Definition at line 147 of file vidl_ffmpeg_ostream_params.h.

int vidl_ffmpeg_ostream_params::me_threshold_

Definition at line 132 of file vidl_ffmpeg_ostream_params.h.

unsigned vidl_ffmpeg_ostream_params::ni_

Width of a frame (default 640).

Definition at line 61 of file vidl_ffmpeg_ostream_params.h.

unsigned vidl_ffmpeg_ostream_params::nj_

Height of a frame (default 480).

Definition at line 64 of file vidl_ffmpeg_ostream_params.h.

int vidl_ffmpeg_ostream_params::noise_reduction_

Definition at line 137 of file vidl_ffmpeg_ostream_params.h.

float vidl_ffmpeg_ostream_params::p_mask_

Definition at line 87 of file vidl_ffmpeg_ostream_params.h.

int vidl_ffmpeg_ostream_params::packet_size_

Definition at line 149 of file vidl_ffmpeg_ostream_params.h.

int vidl_ffmpeg_ostream_params::pre_cmp_

Definition at line 81 of file vidl_ffmpeg_ostream_params.h.

int vidl_ffmpeg_ostream_params::pre_me_

Definition at line 82 of file vidl_ffmpeg_ostream_params.h.

int vidl_ffmpeg_ostream_params::predictor_

Definition at line 141 of file vidl_ffmpeg_ostream_params.h.

int vidl_ffmpeg_ostream_params::qns_

Definition at line 88 of file vidl_ffmpeg_ostream_params.h.

int vidl_ffmpeg_ostream_params::same_quality_

Definition at line 75 of file vidl_ffmpeg_ostream_params.h.

int vidl_ffmpeg_ostream_params::sc_threshold_

Definition at line 138 of file vidl_ffmpeg_ostream_params.h.

float vidl_ffmpeg_ostream_params::scplx_mask_

Definition at line 85 of file vidl_ffmpeg_ostream_params.h.

int vidl_ffmpeg_ostream_params::strict_

Definition at line 135 of file vidl_ffmpeg_ostream_params.h.

int vidl_ffmpeg_ostream_params::sub_cmp_

Definition at line 79 of file vidl_ffmpeg_ostream_params.h.

float vidl_ffmpeg_ostream_params::tcplx_mask_

Definition at line 86 of file vidl_ffmpeg_ostream_params.h.

int vidl_ffmpeg_ostream_params::use_4mv_

Definition at line 89 of file vidl_ffmpeg_ostream_params.h.

int vidl_ffmpeg_ostream_params::use_aic_

Definition at line 92 of file vidl_ffmpeg_ostream_params.h.

int vidl_ffmpeg_ostream_params::use_aiv_

Definition at line 93 of file vidl_ffmpeg_ostream_params.h.

int vidl_ffmpeg_ostream_params::use_alt_scan_

Definition at line 96 of file vidl_ffmpeg_ostream_params.h.

int vidl_ffmpeg_ostream_params::use_cbprd_

Definition at line 103 of file vidl_ffmpeg_ostream_params.h.

int vidl_ffmpeg_ostream_params::use_loop_

Definition at line 91 of file vidl_ffmpeg_ostream_params.h.

int vidl_ffmpeg_ostream_params::use_obmc_

Definition at line 90 of file vidl_ffmpeg_ostream_params.h.

int vidl_ffmpeg_ostream_params::use_part_

Definition at line 99 of file vidl_ffmpeg_ostream_params.h.

int vidl_ffmpeg_ostream_params::use_qpel_

Definition at line 101 of file vidl_ffmpeg_ostream_params.h.

int vidl_ffmpeg_ostream_params::use_qprd_

Definition at line 102 of file vidl_ffmpeg_ostream_params.h.

int vidl_ffmpeg_ostream_params::use_scan_offset_

Definition at line 98 of file vidl_ffmpeg_ostream_params.h.

int vidl_ffmpeg_ostream_params::use_ss_

Definition at line 95 of file vidl_ffmpeg_ostream_params.h.

int vidl_ffmpeg_ostream_params::use_trell_

Definition at line 97 of file vidl_ffmpeg_ostream_params.h.

int vidl_ffmpeg_ostream_params::use_umv_

Definition at line 94 of file vidl_ffmpeg_ostream_params.h.

float vidl_ffmpeg_ostream_params::video_b_qfactor_

Definition at line 124 of file vidl_ffmpeg_ostream_params.h.

float vidl_ffmpeg_ostream_params::video_b_qoffset_

Definition at line 125 of file vidl_ffmpeg_ostream_params.h.

int vidl_ffmpeg_ostream_params::video_bit_rate_tolerance_

static parameters from ffmpeg.c.

There are many other FFMPEG parameters available I don't know what most of these do, but using the default values should work most of the time

Definition at line 70 of file vidl_ffmpeg_ostream_params.h.

float vidl_ffmpeg_ostream_params::video_i_qfactor_

Definition at line 126 of file vidl_ffmpeg_ostream_params.h.

float vidl_ffmpeg_ostream_params::video_i_qoffset_

Definition at line 127 of file vidl_ffmpeg_ostream_params.h.

int vidl_ffmpeg_ostream_params::video_inter_quant_bias_

Definition at line 129 of file vidl_ffmpeg_ostream_params.h.

int vidl_ffmpeg_ostream_params::video_intra_quant_bias_

Definition at line 128 of file vidl_ffmpeg_ostream_params.h.

int vidl_ffmpeg_ostream_params::video_lmax_

Definition at line 110 of file vidl_ffmpeg_ostream_params.h.

int vidl_ffmpeg_ostream_params::video_lmin_

Definition at line 109 of file vidl_ffmpeg_ostream_params.h.

int vidl_ffmpeg_ostream_params::video_mb_qmax_

Definition at line 112 of file vidl_ffmpeg_ostream_params.h.

int vidl_ffmpeg_ostream_params::video_mb_qmin_

Definition at line 111 of file vidl_ffmpeg_ostream_params.h.

float vidl_ffmpeg_ostream_params::video_qblur_

Definition at line 114 of file vidl_ffmpeg_ostream_params.h.

float vidl_ffmpeg_ostream_params::video_qcomp_

Definition at line 115 of file vidl_ffmpeg_ostream_params.h.

int vidl_ffmpeg_ostream_params::video_qdiff_

Definition at line 113 of file vidl_ffmpeg_ostream_params.h.

int vidl_ffmpeg_ostream_params::video_qmax_

Definition at line 108 of file vidl_ffmpeg_ostream_params.h.

int vidl_ffmpeg_ostream_params::video_qmin_

Definition at line 107 of file vidl_ffmpeg_ostream_params.h.

float vidl_ffmpeg_ostream_params::video_qscale_

Definition at line 74 of file vidl_ffmpeg_ostream_params.h.

float vidl_ffmpeg_ostream_params::video_rc_buffer_aggressivity_

Definition at line 120 of file vidl_ffmpeg_ostream_params.h.

int vidl_ffmpeg_ostream_params::video_rc_buffer_size_

Definition at line 119 of file vidl_ffmpeg_ostream_params.h.

vcl_string vidl_ffmpeg_ostream_params::video_rc_eq_

Definition at line 116 of file vidl_ffmpeg_ostream_params.h.

float vidl_ffmpeg_ostream_params::video_rc_initial_cplx_

Definition at line 123 of file vidl_ffmpeg_ostream_params.h.

int vidl_ffmpeg_ostream_params::video_rc_max_rate_

Definition at line 121 of file vidl_ffmpeg_ostream_params.h.

int vidl_ffmpeg_ostream_params::video_rc_min_rate_

Definition at line 122 of file vidl_ffmpeg_ostream_params.h.

---

The documentation for this struct was generated from the following files:

• core/vidl/vidl_ffmpeg_ostream_params.h
• core/vidl/vidl_ffmpeg_ostream_params.cxx