Information about the streams
[Decoding of multimedia streams]


Functions

const gavl_audio_format_tbgav_get_audio_format (bgav_t *bgav, int stream)
 Get the format of an audio stream.
const gavl_video_format_tbgav_get_video_format (bgav_t *bgav, int stream)
 Get the format of a video stream.
const gavl_video_format_tbgav_get_subtitle_format (bgav_t *bgav, int stream)
 Get the video format of a subtitle stream.
int bgav_subtitle_is_text (bgav_t *bgav, int stream)
 Check if a subtitle is text or graphics based.
const char * bgav_get_audio_description (bgav_t *bgav, int stream)
 Get the description of an audio stream.
const char * bgav_get_audio_info (bgav_t *bgav, int stream)
 Get additional info about an audio stream.
const char * bgav_get_video_description (bgav_t *bgav, int stream)
 Get the description of a video stream.
const char * bgav_get_subtitle_description (bgav_t *bgav, int stream)
 Get the description of a subtitle stream.
const char * bgav_get_subtitle_info (bgav_t *bgav, int stream)
 Get additional info about a subtitle stream.

Function Documentation

const gavl_audio_format_t* bgav_get_audio_format ( bgav_t bgav,
int  stream 
)

Get the format of an audio stream.

Parameters:
bgav A decoder instance
stream Stream index (starting with 0)
Returns:
The format
Note, that you can trust the return value of this function only, if you enabled the stream (see bgav_set_audio_stream) and started the decoders (see bgav_start).

const gavl_video_format_t* bgav_get_video_format ( bgav_t bgav,
int  stream 
)

Get the format of a video stream.

Parameters:
bgav A decoder instance
stream Stream index (starting with 0)
Returns:
The format
Note, that you can trust the return value of this function only, if you enabled the stream (see bgav_set_video_stream) and started the decoders (see bgav_start).

const gavl_video_format_t* bgav_get_subtitle_format ( bgav_t bgav,
int  stream 
)

Get the video format of a subtitle stream.

Parameters:
bgav A decoder instance
stream Stream index (starting with 0)
Returns:
The format
Note, that you can trust the return value of this function only, if you enabled the stream (see bgav_set_subtitle_stream) and started the decoders (see bgav_start). For overlay subtitles, this is the video format of the decoded overlays. For text subtitles, it's the format of the associated video stream. The timescale member is always the timescale of the subtitles (not the video frames).

int bgav_subtitle_is_text ( bgav_t bgav,
int  stream 
)

Check if a subtitle is text or graphics based.

Parameters:
bgav A decoder instance
stream Stream index (starting with 0)
Returns:
1 for text subtitles, 0 for graphic subtitles
If this function returns 1, you must use bgav_read_subtitle_text to decode subtitles, else use bgav_read_subtitle_overlay

const char* bgav_get_audio_description ( bgav_t bgav,
int  stream 
)

Get the description of an audio stream.

Parameters:
bgav A decoder instance
stream Stream index (starting with 0)
Returns:
A technical decription of the stream
Note, that you can trust the return value of this function only, if you enabled the stream (see bgav_set_audio_stream) and started the decoders (see bgav_start).

const char* bgav_get_audio_info ( bgav_t bgav,
int  stream 
)

Get additional info about an audio stream.

Parameters:
bgav A decoder instance
stream Stream index (starting with 0)
Returns:
An info string about the stream or NULL
This returns additional information about the audio stream e.g. if it contains directors comments, audio for the visually impaired or whatever.

Note, that you can trust the return value of this function only, if you enabled the stream (see bgav_set_audio_stream) and started the decoders (see bgav_start).

const char* bgav_get_video_description ( bgav_t bgav,
int  stream 
)

Get the description of a video stream.

Parameters:
bgav A decoder instance
stream Stream index (starting with 0)
Returns:
A technical decription of the stream
Note, that you can trust the return value of this function only, if you enabled the stream (see bgav_set_video_stream) and started the decoders (see bgav_start).

const char* bgav_get_subtitle_description ( bgav_t bgav,
int  stream 
)

Get the description of a subtitle stream.

Parameters:
bgav A decoder instance
stream Stream index (starting with 0)
Returns:
A technical decription of the stream
Note, that you can trust the return value of this function only, if you enabled the stream (see bgav_set_subtitle_stream) and started the decoders (see bgav_start).

const char* bgav_get_subtitle_info ( bgav_t bgav,
int  stream 
)

Get additional info about a subtitle stream.

Parameters:
bgav A decoder instance
stream Stream index (starting with 0)
Returns:
An info string about the stream or NULL
This returns additional information about the subtitle stream e.g. if it contains directors comments or whatever.

Note, that you can trust the return value of this function only, if you enabled the stream (see bgav_set_subtitle_stream) and started the decoders (see bgav_start).


Generated on Sun Aug 3 15:34:52 2008 for gmerlin-avdecoder by  doxygen 1.5.6