videoinfo_c.h File Reference

C interface for retrieving informations of a clip. More...


Typedefs

typedef AVS_VideoInfo_ AVS_VideoInfo
 opaque declaration of a videoinfo

Functions

AVS_C_API void avs_videoinfo_delete (AVS_VideoInfo *p_vi)
 Delete an AVS_VideoInfo.
AVS_C_API int avs_videoinfo_has_video (const AVS_VideoInfo *p_vi)
 Check wether the clip has a video stream or not.
AVS_C_API AVS_ColorSpaceavs_videoinfo_colorspace_get (const AVS_VideoInfo *p_vi)
 Retrieve the colorspace of the video.
AVS_C_API int avs_videoinfo_width_get (const AVS_VideoInfo *p_vi)
 Retrieve the width of the video.
AVS_C_API int avs_videoinfo_height_get (const AVS_VideoInfo *p_vi)
 Retrieve the height of the video.
AVS_C_API int avs_videoinfo_framecount_get (const AVS_VideoInfo *p_vi)
 Retrieve the frame count of the video.
AVS_C_API int avs_videoinfo_fps_numerator_get (const AVS_VideoInfo *p_vi)
 Retrieve the numerator of the frame rate of the video.
AVS_C_API int avs_videoinfo_fps_denominator_get (const AVS_VideoInfo *p_vi)
 Retrieve the denominator of the frame rate of the video.
AVS_C_API float avs_videoinfo_fps_float_get (const AVS_VideoInfo *p_vi)
 Retrieve the frame rate of the video as a float.
AVS_C_API int avs_videoinfo_has_audio (const AVS_VideoInfo *p_vi)
 Check wether the clip has an audio stream or not.
AVS_C_API int avs_videoinfo_sample_rate_get (const AVS_VideoInfo *p_vi)
 Retrieve the sample rate of the audio.
AVS_C_API long long int avs_videoinfo_sample_count_get (const AVS_VideoInfo *p_vi)
 Retrieve the sample count of the audio.
AVS_C_API int avs_videoinfo_channel_count_get (const AVS_VideoInfo *p_vi)
 Retrieve the channel count of the audio.


Detailed Description

C interface for videoinfos. They are related to the clip they are retrieved from. The clip contains informations about the video stream and the adio stream.

For the video stream, you can get the size of the clip, its colorspace, its frame count or framerate. Before checking this, make sure that the clip has a video stream with avs_videoinfo_has_video().

For the audio stream, you can get the smaple rate, the sample count and the channel count. As with the video stream, be sure that the clip has an audio stream by using avs_videoinfo_has_audio().

Once you have finished with an AVS_VideoInfo, you delete it with avs_videoinfo_delete().


Function Documentation

AVS_C_API int avs_videoinfo_channel_count_get ( const AVS_VideoInfo p_vi  ) 

Parameters:
p_vi The videoinfo.
Returns:
The channel count of the audio.
Retrieve the channel count of the audio from the videoinfo p_vi. If p_vi is NULL, this function returns 0.

AVS_C_API AVS_ColorSpace* avs_videoinfo_colorspace_get ( const AVS_VideoInfo p_vi  ) 

Parameters:
p_vi The videoinfo.
Returns:
The colorspace of the video stream.
Retrieve the colorspace of the video from p_vi, as a AVS_ColorSpace, or NULL if an error occurred. The returned result must be freed with avs_colorspace_delete().

AVS_C_API void avs_videoinfo_delete ( AVS_VideoInfo p_vi  ) 

Parameters:
p_vi The videoinfo to delete.
Delete the videoinfo p_vi.

AVS_C_API int avs_videoinfo_fps_denominator_get ( const AVS_VideoInfo p_vi  ) 

Parameters:
p_vi The videoinfo.
Returns:
The denominator of the frame rate of the video.
Retrieve the denominator of the frame rate of the video from the videoinfo p_vi. If p_vi is NULL, this function returns 1.

AVS_C_API float avs_videoinfo_fps_float_get ( const AVS_VideoInfo p_vi  ) 

Parameters:
p_vi The videoinfo.
Returns:
The frame rate of the video.
Retrieve the frame rate of the video from the videoinfo p_vi as a float. If p_vi is NULL, this function returns 0.

AVS_C_API int avs_videoinfo_fps_numerator_get ( const AVS_VideoInfo p_vi  ) 

Parameters:
p_vi The videoinfo.
Returns:
The numerator of the frame rate of the video.
Retrieve the numerator of the frame rate of the video from the videoinfo p_vi. If p_vi is NULL, this function returns 0.

AVS_C_API int avs_videoinfo_framecount_get ( const AVS_VideoInfo p_vi  ) 

Parameters:
p_vi The videoinfo.
Returns:
The frame count of the video.
Retrieve the frame count of the video from the videoinfo p_vi. If p_vi is NULL, this function returns 0.

AVS_C_API int avs_videoinfo_has_audio ( const AVS_VideoInfo p_vi  ) 

Parameters:
p_vi The videoinfo to check.
Returns:
1 if the clip has a audio stream, 0 otherwise.
Check wether the clip has an audio stream or not. If p_vi has informations on audio, then the function returns 1, otherwise it returns 0.

AVS_C_API int avs_videoinfo_has_video ( const AVS_VideoInfo p_vi  ) 

Parameters:
p_vi The videoinfo to check.
Returns:
1 if the clip has a video stream, 0 otherwise.
Check wether the clip has a video stream or not. If p_vi has informations on video, then the function returns 1, otherwise it returns 0.

AVS_C_API int avs_videoinfo_height_get ( const AVS_VideoInfo p_vi  ) 

Parameters:
p_vi The videoinfo.
Returns:
The height of the video.
Retrieve the height of the video from the videoinfo p_vi. If p_vi is NULL, this function returns 0.

AVS_C_API long long int avs_videoinfo_sample_count_get ( const AVS_VideoInfo p_vi  ) 

Parameters:
p_vi The videoinfo.
Returns:
The sample count of the audio.
Retrieve the sample count of the audio from the videoinfo p_vi. If p_vi is NULL, this function returns 0.

AVS_C_API int avs_videoinfo_sample_rate_get ( const AVS_VideoInfo p_vi  ) 

Parameters:
p_vi The videoinfo.
Returns:
The sample rate of the audio.
Retrieve the sample rate of the audio from the videoinfo p_vi. If p_vi is NULL, this function returns 0.

AVS_C_API int avs_videoinfo_width_get ( const AVS_VideoInfo p_vi  ) 

Parameters:
p_vi The videoinfo.
Returns:
The width of the video.
Retrieve the width of the video from the videoinfo p_vi. If p_vi is NULL, this function returns 0.


Generated on Sun Jul 30 18:46:52 2006 for Avisynth by  doxygen 1.4.7