Frame Rate
[Video Filters]

Defines

#define FE2_FILTER_FRAMERATE
 Filter name for use with Flix2_AddFilter().
#define FE2_FRAMERATE_FPS
 Filter parameter name for frames per second value.
#define FE2_FRAMERATE_DECIMATE
 Filter parameter for the decimation interval.

Deprecated functions



on2sc video_options_GetVideoFramerate (const FLIX2HANDLE flix, int32_t *lpVideoFramerate)
 Get the current video framerate.
on2sc video_options_SetVideoFramerate (FLIX2HANDLE flix, const int32_t lVideoFramerate)
 Set the video framerate.
on2sc video_options_GetVideoFramerateAsDouble (const FLIX2HANDLE flix, double *p_fps)
 Get the current video framerate.
on2sc video_options_SetVideoFramerateAsDouble (FLIX2HANDLE flix, const double fps)
 Set the video framerate.
on2sc video_options_GetUseSourceFramerate (FLIX2HANDLE flix, on2bool *bpUseSourceFramerate)
 Determine if the source's framerate will be used instead of the modified framerate.
on2sc video_options_SetUseSourceFramerate (FLIX2HANDLE flix, const on2bool bUseSourceFramerate)
 Switch between source and scaled framerate.
on2sc video_options_GetDecimateValue (const FLIX2HANDLE flix, uint32_t *pValue)
 Get the current decimation of the video framerate.
on2sc video_options_SetDecimateValue (FLIX2HANDLE flix, const uint32_t value)
 Set the decimation of the video framerate.

Detailed Description

The frame rate filter modifies the source frame rate either by applying a specific frame rate (e.g. 12.0) or a decimation interval (e.g. 2 = 1/2 source frame rate).

Filter Parameters:

   Name                                |   Type   | Opt/Reqd |    Range
   ============================================================================
   FE2_FRAMERATE_FPS                   | Numeric  | Optional | [0.0,)
   FE2_FRAMERATE_DECIMATE              | Numeric  | Optional | [1,)

Example Usage:

   sc = Flix2_AddFilter(&filter, flix, FE2_FILTER_FRAMERATE);
   // decimate by 2. ex. 29.97fps becomes 14.985
   if(sc == ON2_OK)
       sc = Flix2_FilterSetParam(filter, FE2_FRAMERATE_DECIMATE, 2);

Define Documentation

#define FE2_FILTER_FRAMERATE

Filter name for use with Flix2_AddFilter().

Definition at line 49 of file framerate.h.

#define FE2_FRAMERATE_DECIMATE

Filter parameter for the decimation interval.

Decimation removes frames from the source video at regular intervals. This is useful for dropping the rate without introducing jerkiness due to uneven frame rate.

Note:
Must be a positive integer
Default: disabled

Definition at line 67 of file framerate.h.

#define FE2_FRAMERATE_FPS

Filter parameter name for frames per second value.

Allows the frame rate to be adjusted to a specific rate.

Note:
Default: disabled

Definition at line 56 of file framerate.h.


Function Documentation

on2sc video_options_GetDecimateValue ( const FLIX2HANDLE  flix,
uint32_t pValue 
)

Get the current decimation of the video framerate.

Parameters:
[in] flix Handle to the Flix Engine returned from Flix2_Create() or Flix2_CreateEx()
[out] pValue Decimate value
Return values:
ON2_OK Success.
ON2_INVALID_PARAMS Should one or more of the preconditions fail.
Precondition:
flix is not NULL
pValue is not NULL
Note:
If a value other than ON2_OK is returned, the output variables should not be considered valid.
Deprecated:
Use the Filter Interface along with FE2_FILTER_FRAMERATE and the FE2_FRAMERATE_DECIMATE parameter. This function will be removed in a future release.
on2sc video_options_GetUseSourceFramerate ( FLIX2HANDLE  flix,
on2bool bpUseSourceFramerate 
)

Determine if the source's framerate will be used instead of the modified framerate.

Parameters:
[in] flix Handle to the Flix Engine returned from Flix2_Create() or Flix2_CreateEx()
[out] bpUseSourceFramerate Variable to update with the current framerate selection
Return values:
ON2_OK The framerate status was successfully retrieved from the engine.
Note:
If a value other than ON2_OK is returned, the output variables should not be considered valid.
Deprecated:
Use the Filter Interface along with FE2_FILTER_FRAMERATE. Not adding FE2_FILTER_FRAMERATE with Flix2_AddFilter() implies use of the source frame rate. This function will be removed in a future release.
on2sc video_options_GetVideoFramerate ( const FLIX2HANDLE  flix,
int32_t lpVideoFramerate 
)

Get the current video framerate.

Parameters:
[in] flix Handle to the Flix Engine returned from Flix2_Create() or Flix2_CreateEx()
[out] lpVideoFramerate Frames per second
Return values:
ON2_OK The framerate was successfully retrieved from the engine.
Deprecated:
Please use video_options_GetVideoFramerateAsDouble() to allow for non integer framerates.
Note:
If a value other than ON2_OK is returned, the output variables should not be considered valid.
on2sc video_options_GetVideoFramerateAsDouble ( const FLIX2HANDLE  flix,
double *  p_fps 
)

Get the current video framerate.

Parameters:
[in] flix Handle to the Flix Engine returned from Flix2_Create() or Flix2_CreateEx()
[out] p_fps Frames per second
Return values:
ON2_OK The framerate was successfully retrieved from the engine.
Note:
If a value other than ON2_OK is returned, the output variables should not be considered valid.
Deprecated:
Use the Filter Interface along with FE2_FILTER_FRAMERATE and the FE2_FRAMERATE_FPS parameter. This function will be removed in a future release.
on2sc video_options_SetDecimateValue ( FLIX2HANDLE  flix,
const uint32_t  value 
)

Set the decimation of the video framerate.

This value will be used to drop frames according to the video framerate. For example if the framerate is 30fps and the decimate value is 3 then the encoded framerate will be 10fps.

Parameters:
[in] flix Handle to the Flix Engine returned from Flix2_Create() or Flix2_CreateEx()
[in] value Decimate value
Return values:
ON2_OK The target framerate was successfully set in the engine.
ON2_INVALID_PARAMS Should one or more of the preconditions fail.
Precondition:
flix is not NULL
Note:
Default value is 0.
A value of <= 1 means to not drop any frames.
Deprecated:
Use the Filter Interface along with FE2_FILTER_FRAMERATE and the FE2_FRAMERATE_DECIMATE parameter. This function will be removed in a future release.
on2sc video_options_SetUseSourceFramerate ( FLIX2HANDLE  flix,
const on2bool  bUseSourceFramerate 
)

Switch between source and scaled framerate.

Parameters:
[in] flix Handle to the Flix Engine returned from Flix2_Create() or Flix2_CreateEx()
[in] bUseSourceFramerate New framerate status. on2true to use source framerate, on2false to use scaled framerate.
Return values:
ON2_OK The framerate status was successfully set in the engine.
Note:
By default, the source framerate will be used, unless a call to video_options_SetVideoFramerate(), video_options_SetVideoFramerateAsDouble() or video_options_SetDecimateValue() has been made.
Deprecated:
Use the Filter Interface along with FE2_FILTER_FRAMERATE. Not adding FE2_FILTER_FRAMERATE with Flix2_AddFilter() implies use of the source frame rate. This function will be removed in a future release.
on2sc video_options_SetVideoFramerate ( FLIX2HANDLE  flix,
const int32_t  lVideoFramerate 
)

Set the video framerate.

Sets the framerate to be used when encoding the video. Frames will be duplicated or dropped as necessary to achieve the desired framerate.

Parameters:
[in] flix Handle to the Flix Engine returned from Flix2_Create() or Flix2_CreateEx()
[in] lVideoFramerate Framerate target (in frames per second)
Return values:
ON2_OK The target framerate was successfully set in the engine.
ON2_INVALID_PARAMS The value is out of range.
Deprecated:
Please use video_options_SetVideoFramerateAsDouble() to allow for non integer framerates.
Note:
The default is to use the source framerate.
on2sc video_options_SetVideoFramerateAsDouble ( FLIX2HANDLE  flix,
const double  fps 
)

Set the video framerate.

Sets the framerate to be used when encoding the video. Frames will be duplicated or dropped as necessary to achieve the desired framerate.

Parameters:
[in] flix Handle to the Flix Engine returned from Flix2_Create() or Flix2_CreateEx()
[in] fps Framerate target (in frames per second)
Return values:
ON2_OK The target framerate was successfully set in the engine.
ON2_INVALID_PARAMS The value is out of range.
Note:
The default is to use the source framerate.
Deprecated:
Use the Filter Interface along with FE2_FILTER_FRAMERATE and the FE2_FRAMERATE_FPS parameter. This function will be removed in a future release.

On2 Technologies, Inc Flix Engine Windows documentation, generated on Tue Nov 2 15:38:07 2010 by doxygen 1.6.1