OGMRip Reference Manual | ||||
---|---|---|---|---|
#include <ogmrip-video-codec.h> OGMRipVideoCodec; OGMRipVideoCodecClass; gboolean ogmrip_video_codec_analyze (OGMRipVideoCodec *video, guint nframes); gboolean ogmrip_video_codec_autocrop (OGMRipVideoCodec *video, guint nframes); void ogmrip_video_codec_autoscale (OGMRipVideoCodec *video); void ogmrip_video_codec_autobitrate (OGMRipVideoCodec *video, guint64 nonvideo_size, guint64 overhead_size, guint64 total_size); gboolean ogmrip_video_codec_get_4mv (OGMRipVideoCodec *video); void ogmrip_video_codec_set_4mv (OGMRipVideoCodec *video, gboolean v4mv); gint ogmrip_video_codec_get_angle (OGMRipVideoCodec *video); void ogmrip_video_codec_set_angle (OGMRipVideoCodec *video, guint angle); void ogmrip_video_codec_get_aspect_ratio (OGMRipVideoCodec *video, guint *num, guint *denom); void ogmrip_video_codec_set_aspect_ratio (OGMRipVideoCodec *video, guint num, guint denom); gint ogmrip_video_codec_get_bitrate (OGMRipVideoCodec *video); void ogmrip_video_codec_set_bitrate (OGMRipVideoCodec *video, guint bitrate); gdouble ogmrip_video_codec_get_bits_per_pixel (OGMRipVideoCodec *video); void ogmrip_video_codec_set_bits_per_pixel (OGMRipVideoCodec *video, gdouble bpp); gboolean ogmrip_video_codec_get_cartoon (OGMRipVideoCodec *video); void ogmrip_video_codec_set_cartoon (OGMRipVideoCodec *video, gboolean cartoon); gboolean ogmrip_video_codec_get_crop_size (OGMRipVideoCodec *video, guint *x, guint *y, guint *width, guint *height); void ogmrip_video_codec_set_crop_size (OGMRipVideoCodec *video, guint x, guint y, guint width, guint height); gboolean ogmrip_video_codec_get_deblock (OGMRipVideoCodec *video); void ogmrip_video_codec_set_deblock (OGMRipVideoCodec *video, gboolean deblock); gint ogmrip_video_codec_get_deinterlacer (OGMRipVideoCodec *video); void ogmrip_video_codec_set_deinterlacer (OGMRipVideoCodec *video, OGMRipDeintType deint); gboolean ogmrip_video_codec_get_denoise (OGMRipVideoCodec *video); void ogmrip_video_codec_set_denoise (OGMRipVideoCodec *video, gboolean denoise); gboolean ogmrip_video_codec_get_dering (OGMRipVideoCodec *video); void ogmrip_video_codec_set_dering (OGMRipVideoCodec *video, gboolean dering); OGMDvdAudioStream* ogmrip_video_codec_get_ensure_sync (OGMRipVideoCodec *video); void ogmrip_video_codec_set_ensure_sync (OGMRipVideoCodec *video, OGMDvdAudioStream *stream); gboolean ogmrip_video_codec_get_grayscale (OGMRipVideoCodec *video); void ogmrip_video_codec_set_grayscale (OGMRipVideoCodec *video, gboolean grayscale); OGMDvdSubpStream* ogmrip_video_codec_get_hard_subp (OGMRipVideoCodec *video, gboolean *forced); void ogmrip_video_codec_set_hard_subp (OGMRipVideoCodec *video, OGMDvdSubpStream *stream, gboolean forced); gint ogmrip_video_codec_get_max_b_frames (OGMRipVideoCodec *video); void ogmrip_video_codec_set_max_b_frames (OGMRipVideoCodec *video, guint max_b_frames); gboolean ogmrip_video_codec_get_max_size (OGMRipVideoCodec *video, guint *width, guint *height, gboolean *expand); void ogmrip_video_codec_set_max_size (OGMRipVideoCodec *video, guint width, guint height, gboolean expand); gint ogmrip_video_codec_get_passes (OGMRipVideoCodec *video); void ogmrip_video_codec_set_passes (OGMRipVideoCodec *video, guint pass); gboolean ogmrip_video_codec_get_qpel (OGMRipVideoCodec *video); void ogmrip_video_codec_set_qpel (OGMRipVideoCodec *video, gboolean qpel); gint ogmrip_video_codec_get_quality (OGMRipVideoCodec *video); void ogmrip_video_codec_set_quality (OGMRipVideoCodec *video, OGMRipQualityType quality); gdouble ogmrip_video_codec_get_quantizer (OGMRipVideoCodec *video); void ogmrip_video_codec_set_quantizer (OGMRipVideoCodec *video, gdouble quantizer); void ogmrip_video_codec_get_raw_size (OGMRipVideoCodec *video, guint *width, guint *height); gboolean ogmrip_video_codec_get_scale_size (OGMRipVideoCodec *video, guint *width, guint *height); void ogmrip_video_codec_set_scale_size (OGMRipVideoCodec *video, guint width, guint height); gint ogmrip_video_codec_get_scaler (OGMRipVideoCodec *video); void ogmrip_video_codec_set_scaler (OGMRipVideoCodec *video, OGMRipScalerType scaler); gint ogmrip_video_codec_get_threads (OGMRipVideoCodec *video); void ogmrip_video_codec_set_threads (OGMRipVideoCodec *video, guint threads); gboolean ogmrip_video_codec_get_trellis (OGMRipVideoCodec *video); void ogmrip_video_codec_set_trellis (OGMRipVideoCodec *video, gboolean trellis); gboolean ogmrip_video_codec_get_turbo (OGMRipVideoCodec *video); void ogmrip_video_codec_set_turbo (OGMRipVideoCodec *video, gboolean turbo); gint ogmrip_video_codec_get_start_delay (OGMRipVideoCodec *video);
GObject +----OGMJobSpawn +----OGMJobContainer +----OGMJobBin +----OGMRipCodec +----OGMRipVideoCodec
"angle" guint : Read / Write "bframes" guint : Read / Write "bitrate" guint : Read / Write "bpp" gdouble : Read / Write "cartoon" gboolean : Read / Write "deblock" gboolean : Read / Write "denoise" gboolean : Read / Write "dering" gboolean : Read / Write "grayscale" gboolean : Read / Write "passes" guint : Read / Write "qpel" gboolean : Read / Write "quantizer" gdouble : Read / Write "threads" guint : Read / Write "trellis" gboolean : Read / Write "turbo" gboolean : Read / Write "v4mv" gboolean : Read / Write
typedef struct { OGMRipCodecClass parent_class; /* signals */ void (* pass) (OGMRipVideoCodec *video, guint pass); /* vtable */ gint (* get_start_delay) (OGMRipVideoCodec *video); void (* set_quality) (OGMRipVideoCodec *video, OGMRipQualityType quality); } OGMRipVideoCodecClass;
gboolean ogmrip_video_codec_analyze (OGMRipVideoCodec *video, guint nframes);
Analyze the video stream to detect if the video is progressive, interlaced and/or telecine.
|
an OGMRipVideoCodec |
|
the number of frames |
Returns : |
FALSE , on error or cancel
|
gboolean ogmrip_video_codec_autocrop (OGMRipVideoCodec *video, guint nframes);
Autodetects the cropping parameters.
|
an OGMRipVideoCodec |
|
the number of frames |
Returns : |
FALSE , on error or cancel
|
void ogmrip_video_codec_autoscale (OGMRipVideoCodec *video);
Autodetects the scaling parameters.
|
an OGMRipVideoCodec |
void ogmrip_video_codec_autobitrate (OGMRipVideoCodec *video, guint64 nonvideo_size, guint64 overhead_size, guint64 total_size);
Autodetects the video bitrate.
|
an OGMRipVideoCodec |
|
the size of the non video streams |
|
the size of the overhead |
|
the total targetted size |
gboolean ogmrip_video_codec_get_4mv (OGMRipVideoCodec *video);
Gets whether 4 motion vectors per macroblock are allowed.
|
an OGMRipVideoCodec |
Returns : |
TRUE if 4 motion vectors per macroblock are allowed
|
void ogmrip_video_codec_set_4mv (OGMRipVideoCodec *video, gboolean v4mv);
Sets whether to allow 4 motion vectors per macroblock.
|
an OGMRipVideoCodec |
|
TRUE to allow 4 motion vectors per macroblock
|
gint ogmrip_video_codec_get_angle (OGMRipVideoCodec *video);
Gets the current angle.
|
an OGMRipVideoCodec |
Returns : |
the angle, or -1 |
void ogmrip_video_codec_set_angle (OGMRipVideoCodec *video, guint angle);
Sets the angle to encode.
|
an OGMRipVideoCodec |
|
the angle |
void ogmrip_video_codec_get_aspect_ratio (OGMRipVideoCodec *video, guint *num, guint *denom);
Gets the aspect ratio of the movie.
|
an OGMRipVideoCodec |
|
a pointer to store the numerator of the aspect ratio |
|
a pointer to store the denominator of the aspect ratio |
void ogmrip_video_codec_set_aspect_ratio (OGMRipVideoCodec *video, guint num, guint denom);
Sets the aspect ratio of the movie.
|
an OGMRipVideoCodec |
|
the numerator of the aspect ratio |
|
the denominator of the aspect ratio |
gint ogmrip_video_codec_get_bitrate (OGMRipVideoCodec *video);
Gets the video bitrate in bits/second.
|
an OGMRipVideoCodec |
Returns : |
the video bitrate, or -1 |
void ogmrip_video_codec_set_bitrate (OGMRipVideoCodec *video, guint bitrate);
Sets the video bitrate to be used in bits/second, 4000 being the lowest and 24000000 the highest available bitrates.
|
an OGMRipVideoCodec |
|
the video bitrate |
gdouble ogmrip_video_codec_get_bits_per_pixel (OGMRipVideoCodec *video);
Gets the number of bits per pixel.
|
an OGMRipVideoCodec |
Returns : |
the number of bits per pixel, or -1 |
void ogmrip_video_codec_set_bits_per_pixel (OGMRipVideoCodec *video, gdouble bpp);
Sets the number of bits per pixel to be used.
|
an OGMRipVideoCodec |
|
the number of bits per pixel |
gboolean ogmrip_video_codec_get_cartoon (OGMRipVideoCodec *video);
Gets whether the movie is a cartoon.
|
an OGMRipVideoCodec |
Returns : |
TRUE if movie is a cartoon
|
void ogmrip_video_codec_set_cartoon (OGMRipVideoCodec *video, gboolean cartoon);
Sets whether the movie is a cartoon.
|
an OGMRipVideoCodec |
|
TRUE if movie is a cartoon
|
gboolean ogmrip_video_codec_get_crop_size (OGMRipVideoCodec *video, guint *x, guint *y, guint *width, guint *height);
Gets whether the video will be cropped and the crop size.
|
an OGMRipVideoCodec |
|
a pointer to store the cropped x position |
|
a pointer to store the cropped y position |
|
a pointer to store the cropped width |
|
a pointer to store the cropped height |
Returns : |
TRUE if the video will be cropped
|
void ogmrip_video_codec_set_crop_size (OGMRipVideoCodec *video, guint x, guint y, guint width, guint height);
Sets the crop size of the movie.
|
an OGMRipVideoCodec |
|
the cropped x position |
|
the cropped y position |
|
the cropped width |
|
the cropped height |
gboolean ogmrip_video_codec_get_deblock (OGMRipVideoCodec *video);
Gets whether a deblocking filter will be applied.
|
an OGMRipVideoCodec |
Returns : |
TRUE if a deblocking filter will be applied
|
void ogmrip_video_codec_set_deblock (OGMRipVideoCodec *video, gboolean deblock);
Sets whether to apply a deblocking filter.
|
an OGMRipVideoCodec |
|
TRUE to apply a deblocking filter
|
gint ogmrip_video_codec_get_deinterlacer (OGMRipVideoCodec *video);
Gets the currnet deinterlacer.
|
an OGMRipVideoCodec |
Returns : |
the deinterlacer, or -1 |
void ogmrip_video_codec_set_deinterlacer (OGMRipVideoCodec *video, OGMRipDeintType deint);
Sets the deinterlacer to be used.
|
an OGMRipVideoCodec |
|
an OGMRipDeintType |
gboolean ogmrip_video_codec_get_denoise (OGMRipVideoCodec *video);
Gets whether to reduce image noise.
|
an OGMRipVideoCodec |
Returns : |
TRUE to reduce image noise
|
void ogmrip_video_codec_set_denoise (OGMRipVideoCodec *video, gboolean denoise);
Sets whether to reduce image noise.
|
an OGMRipVideoCodec |
|
TRUE to reduce image noise
|
gboolean ogmrip_video_codec_get_dering (OGMRipVideoCodec *video);
Gets whether a deringing filter will be applied.
|
an OGMRipVideoCodec |
Returns : |
TRUE if a deringing filter will be applied
|
void ogmrip_video_codec_set_dering (OGMRipVideoCodec *video, gboolean dering);
Sets whether to apply a deringing filter.
|
an OGMRipVideoCodec |
|
TRUE to apply a deringing filter
|
OGMDvdAudioStream* ogmrip_video_codec_get_ensure_sync (OGMRipVideoCodec *video);
Gets the audio stream that will be encoded along with the video to ensure the A/V synchronization.
|
an OGMRipVideoCodec |
Returns : |
the OGMDvdAudioStream, or NULL |
void ogmrip_video_codec_set_ensure_sync (OGMRipVideoCodec *video, OGMDvdAudioStream *stream);
Sets the audio stream that will be encoded along with the video to ensure the A/V synchronization.
|
an OGMRipVideoCodec |
|
an OGMDvdAudioStream |
gboolean ogmrip_video_codec_get_grayscale (OGMRipVideoCodec *video);
Gets whether the movie is grayscale.
|
an OGMRipVideoCodec |
Returns : |
TRUE if movie is grayscale
|
void ogmrip_video_codec_set_grayscale (OGMRipVideoCodec *video, gboolean grayscale);
Sets whether the movie is grayscale.
|
an OGMRipVideoCodec |
|
TRUE if movie is grayscale
|
OGMDvdSubpStream* ogmrip_video_codec_get_hard_subp (OGMRipVideoCodec *video, gboolean *forced);
Gets the subp stream that will be hardcoded in the video.
|
an OGMRipVideoCodec |
|
location to store whether to hardcode forced subs only |
Returns : |
the OGMDvdSubpStream, or NULL |
void ogmrip_video_codec_set_hard_subp (OGMRipVideoCodec *video, OGMDvdSubpStream *stream, gboolean forced);
Sets the subp stream that will be hardcoded in the video.
|
an OGMRipVideoCodec |
|
an OGMDvdSubpStream |
|
whether to hardcode forced subs only |
gint ogmrip_video_codec_get_max_b_frames (OGMRipVideoCodec *video);
Gets the maximum number of B-frames to put between I/P-frames.
|
an OGMRipVideoCodec |
Returns : |
the maximum number of B-frames, or -1 |
void ogmrip_video_codec_set_max_b_frames (OGMRipVideoCodec *video, guint max_b_frames);
Sets the maximum number of B-frames to put between I/P-frames.
|
an OGMRipVideoCodec |
|
the maximum number of B-frames |
gboolean ogmrip_video_codec_get_max_size (OGMRipVideoCodec *video, guint *width, guint *height, gboolean *expand);
Gets wether the video has a maximum size and the maximum size.
|
an OGMRipVideoCodec |
|
a pointer to store the maximum width |
|
a pointer to store the maximum height |
|
whether the video must be expanded |
Returns : |
TRUE if the video has a maximum size
|
void ogmrip_video_codec_set_max_size (OGMRipVideoCodec *video, guint width, guint height, gboolean expand);
Sets the maximum size of the movie.
|
an OGMRipVideoCodec |
|
the maximum width |
|
the maximum height |
|
wheter to expand the video |
gint ogmrip_video_codec_get_passes (OGMRipVideoCodec *video);
Gets the number of passes.
|
an OGMRipVideoCodec |
Returns : |
the pass number, or -1 |
void ogmrip_video_codec_set_passes (OGMRipVideoCodec *video, guint pass);
Sets the number of passes.
|
an OGMRipVideoCodec |
|
the pass number |
gboolean ogmrip_video_codec_get_qpel (OGMRipVideoCodec *video);
Sets whether quarter pel motion compensation is used.
|
an OGMRipVideoCodec |
Returns : |
TRUE if quarter pel motion compensation is used
|
void ogmrip_video_codec_set_qpel (OGMRipVideoCodec *video, gboolean qpel);
Sets whether to use quarter pel motion compensation.
|
an OGMRipVideoCodec |
|
TRUE to use quarter pel motion compensation
|
gint ogmrip_video_codec_get_quality (OGMRipVideoCodec *video);
Gets the quality of the encoding.
|
an OGMRipVideoCodec |
Returns : |
the OGMRipQualityType, or -1 |
void ogmrip_video_codec_set_quality (OGMRipVideoCodec *video, OGMRipQualityType quality);
Sets the quality of the encoding.
|
an OGMRipVideoCodec |
|
the OGMRipQualityType |
gdouble ogmrip_video_codec_get_quantizer (OGMRipVideoCodec *video);
Gets the video quantizer.
|
an OGMRipVideoCodec |
Returns : |
the video quantizer, or -1 |
void ogmrip_video_codec_set_quantizer (OGMRipVideoCodec *video, gdouble quantizer);
Sets the video quantizer to be used, 1 being the lowest and 31 the highest available quantizers.
|
an OGMRipVideoCodec |
|
the video quantizer |
void ogmrip_video_codec_get_raw_size (OGMRipVideoCodec *video, guint *width, guint *height);
Gets the raw size of the video.
|
an OGMRipVideoCodec |
|
a pointer to store the width |
|
a pointer to store the height |
gboolean ogmrip_video_codec_get_scale_size (OGMRipVideoCodec *video, guint *width, guint *height);
Gets whether the video will be scaled and the scale size.
|
an OGMRipVideoCodec |
|
a pointer to store the scaled width |
|
a pointer to store the scaled height |
Returns : |
TRUE if the video will be scaled
|
void ogmrip_video_codec_set_scale_size (OGMRipVideoCodec *video, guint width, guint height);
Sets the scaled size of the movie.
|
an OGMRipVideoCodec |
|
the scaled width |
|
the scaled height |
gint ogmrip_video_codec_get_scaler (OGMRipVideoCodec *video);
Gets the current software scaler.
|
an OGMRipVideoCodec |
Returns : |
the software scaler, or -1 |
void ogmrip_video_codec_set_scaler (OGMRipVideoCodec *video, OGMRipScalerType scaler);
Sets the software scaler to be used.
|
an OGMRipVideoCodec |
|
an OGMRipScalerType |
gint ogmrip_video_codec_get_threads (OGMRipVideoCodec *video);
Gets the number of threads.
|
an OGMRipVideoCodec |
Returns : |
the number of threads, or -1 |
void ogmrip_video_codec_set_threads (OGMRipVideoCodec *video, guint threads);
Sets the number of threads to be used.
|
an OGMRipVideoCodec |
|
the number of threads |
gboolean ogmrip_video_codec_get_trellis (OGMRipVideoCodec *video);
Gets whether trellis quantization is enabled.
|
an OGMRipVideoCodec |
Returns : |
TRUE if trellis quantization is enabled
|
void ogmrip_video_codec_set_trellis (OGMRipVideoCodec *video, gboolean trellis);
Sets whether trellis quantization will be enabled.
|
an OGMRipVideoCodec |
|
TRUE to enable trellis quantization
|
gboolean ogmrip_video_codec_get_turbo (OGMRipVideoCodec *video);
Gets whether turbo is enabled.
|
an OGMRipVideoCodec |
Returns : |
TRUE if turbo is enabled
|
void ogmrip_video_codec_set_turbo (OGMRipVideoCodec *video, gboolean turbo);
Sets whether to enable turbo.
|
an OGMRipVideoCodec |
|
TRUE to enable turbo
|
gint ogmrip_video_codec_get_start_delay (OGMRipVideoCodec *video);
Gets the start delay that must be applied to audio streams when merging.
|
an OGMRipVideoCodec |
Returns : |
the start delay, or -1 |
"bframes"
property"bframes" guint : Read / Write
Set b-frames.
Allowed values: <= 4
Default value: 2
"bitrate"
property"bitrate" guint : Read / Write
Set bitrate.
Allowed values: [4000,24000000]
Default value: 800000
"bpp"
property"bpp" gdouble : Read / Write
Set bits per pixel.
Allowed values: [0,1]
Default value: 0.25
"passes"
property"passes" guint : Read / Write
Set the number of passes.
Allowed values: >= 1
Default value: 1
"qpel"
property"qpel" gboolean : Read / Write
Set quarter pel motion compensation.
Default value: FALSE
"quantizer"
property"quantizer" gdouble : Read / Write
Set quantizer.
Allowed values: [-1,31]
Default value: -1
"v4mv"
property"v4mv" gboolean : Read / Write
Set 4 motion vectors per macroblock.
Default value: TRUE