    MPEG SDK --> MpegDecoder

class MpegHeaderInfo

An info class for storing header information about an MPEG file.

It contains the information that can be read from the MPEG system headers without much interogation of the stream. Therefore reading this information is much faster then reading the complete MpegInfo information.

An MpegHeaderInfo object can be obtained using the static MpegDecoder::getMpegHeaderInfo() function.

Author:
  Kevin W. Moore

Source:
  MpegHeaderInfo.h:43

See Also:
  MpegDecoder, MpegInfo

##

MpegHeaderInfo
  [public] Construct an MpegHeaderInfo object for the given mpeg file.
MpegHeaderInfo
  [public] Construct an MpegHeaderInfo object for the given mpeg file.

##

_aspect_ratio_info
  [protected]
_audio_bit_rate
  [protected]
_audio_format
  [protected]
_audio_mode
  [protected]
_audio_sampling_freq
  [protected]
_chroma_format
  [protected]
_file_size
  [protected]
_frame_rate
  [protected]
_height
  [protected]
_mux_rate
  [protected]
_num_audio_channels
  [protected]
_pathname
  [protected]
_system_format
  [protected]
_video_bit_rate
  [protected]
_video_format
  [protected]
_width
  [protected]

##

getAspectRatioInfo
  [public] Get aspect ratio info.
getAudioBitRate
  [public] Get the audio bit rate.
getAudioFormat
  [public] Get the audio format.
getAudioMode
  [public] Get the audio mode.
getAudioSamplingFreq
  [public] Get the audio sampling frequency.
getChromaFormat
  [public] Get the chroma format.
getFilename
  [public] Get the complete pathname of the MPEG file.
getFileSize
  [public] Get the size of the MPEG file.
getFrameRate
  [public] Get the video frame rate.
getHeight
  [public] Get the Height of the video frames.
getMuxRate
  [public] Get the Multiplexed rate.
getNumAudioChannels
  [public] Get the number of audio channels.
getSystemFormat
  [public] Get the system format.
getVideoBitRate
  [public] Get the video bit rate.
getVideoFormat
  [public] Get the video format.
getWidth
  [public] Get the width of the video frames.
operator =
  [public] Assignment operator
operator ==
  [public] Whether the MpegHeaderInfo structure equals this one.
setAspectRatioInfo
  [public] Set aspect ratio info.
setAudioBitRate
  [public] Set the audio bit rate.
setAudioFormat
  [public] Set the audio format.
setAudioMode
  [public] Set the audio mode.
setAudioSamplingFreq
  [public] Set the audio sampling frequency.
setChromaFormat
  [public] Set the chroma format.
setFilename
  [public] Set the pathname of the MPEG file.
setFileSize
  [public] Set the file size attribute.
setFrameRate
  [public] Set the video frame rate.
setHeight
  [public] Set the Height of the video frames.
setMuxRate
  [public] Set the Multiplexed rate.
setNumAudioChannels
  [public] Set the number of audio channels.
setSystemFormat
  [public] Set the System format.
setVideoBitRate
  [public] Set the video bit rate.
setVideoFormat
  [public] Set the video format.
setWidth
  [public] Set the width of the video frames.
tostring
  [public] Return a string representation of the information contained in the MpegHeaderInfo object.

##

MpegHeaderInfo

    public MpegHeaderInfo ( const string & pathname ) ;

Construct an MpegHeaderInfo object for the given mpeg file.

MpegHeaderInfo

    public MpegHeaderInfo ( const string & pathname ,
                            fpos_t file_size ,
                            SystemsFormat system_format ,
                            int mux_rate ,
                            VideoFormat video_format ,
                            int width ,
                            int height ,
                            float frame_rate ,
                            int video_bit_rate ,
                            ChromaFormat chroma_format ,
                            AudioFormat audio_format ,
                            int num_audio_channels ,
                            AudioMode audio_mode ,
                            int audio_bit_rate ,
                            int audio_sampling_freq ) ;

Construct an MpegHeaderInfo object for the given mpeg file.

##

_pathname

    protected string _pathname

_file_size

    protected fpos_t _file_size

_system_format

    protected SystemsFormat _system_format

_mux_rate

    protected int _mux_rate

_video_format

    protected VideoFormat _video_format

_width

    protected int _width

_height

    protected int _height

_aspect_ratio_info

    protected int _aspect_ratio_info

_frame_rate

    protected float _frame_rate

_video_bit_rate

    protected int _video_bit_rate

_chroma_format

    protected ChromaFormat _chroma_format

_audio_format

    protected AudioFormat _audio_format

_num_audio_channels

    protected int _num_audio_channels

_audio_mode

    protected AudioMode _audio_mode

_audio_bit_rate

    protected int _audio_bit_rate

_audio_sampling_freq

    protected int _audio_sampling_freq

##

setFilename

    public void setFilename ( const string & filename ) ;

Set the pathname of the MPEG file.

getFilename

    public const string & getFilename ( ) const ;

Get the complete pathname of the MPEG file.

setFileSize

    public void setFileSize ( fpos_t file_size ) ;

Set the file size attribute.

getFileSize

    public fpos_t getFileSize ( ) const ;

Get the size of the MPEG file.

setSystemFormat

    public void setSystemFormat ( SystemsFormat system_format ) ;

Set the System format.

getSystemFormat

    public SystemsFormat getSystemFormat ( ) const ;

Get the system format.

setMuxRate

    public void setMuxRate ( int mux_rate ) ;

Set the Multiplexed rate.

getMuxRate

    public int getMuxRate ( ) const ;

Get the Multiplexed rate.

setVideoFormat

    public void setVideoFormat ( VideoFormat video_format ) ;

Set the video format.

getVideoFormat

    public VideoFormat getVideoFormat ( ) const ;

Get the video format.

setWidth

    public void setWidth ( int width ) ;

Set the width of the video frames.

getWidth

    public int getWidth ( ) const ;

Get the width of the video frames.

setHeight

    public void setHeight ( int height ) ;

Set the Height of the video frames.

getHeight

    public int getHeight ( ) const ;

Get the Height of the video frames.

setFrameRate

    public void setFrameRate ( float frame_rate ) ;

Set the video frame rate.

setAspectRatioInfo

    public void setAspectRatioInfo ( int asp ) ;

Set aspect ratio info.

getAspectRatioInfo

    public int getAspectRatioInfo ( ) const ;

Get aspect ratio info.

getFrameRate

    public float getFrameRate ( ) const ;

Get the video frame rate.

setVideoBitRate

    public void setVideoBitRate ( int video_bit_rate ) ;

Set the video bit rate.

getVideoBitRate

    public int getVideoBitRate ( ) const ;

Get the video bit rate.

setChromaFormat

    public void setChromaFormat ( ChromaFormat chroma_format ) ;

Set the chroma format.

getChromaFormat

    public ChromaFormat getChromaFormat ( ) const ;

Get the chroma format.

setAudioFormat

    public void setAudioFormat ( AudioFormat audio_format ) ;

Set the audio format.

getAudioFormat

    public AudioFormat getAudioFormat ( ) const ;

Get the audio format.

setNumAudioChannels

    public void setNumAudioChannels ( int nch ) ;

Set the number of audio channels.

getNumAudioChannels

    public int getNumAudioChannels ( ) const ;

Get the number of audio channels.

setAudioMode

    public void setAudioMode ( AudioMode audio_mode ) ;

Set the audio mode.

getAudioMode

    public AudioMode getAudioMode ( ) const ;

Get the audio mode.

setAudioBitRate

    public void setAudioBitRate ( int br ) ;

Set the audio bit rate.

getAudioBitRate

    public int getAudioBitRate ( ) const ;

Get the audio bit rate.

setAudioSamplingFreq

    public void setAudioSamplingFreq ( int sf ) ;

Set the audio sampling frequency.

getAudioSamplingFreq

    public int getAudioSamplingFreq ( ) const ;

Get the audio sampling frequency.

operator ==

    public bool operator == ( const MpegHeaderInfo & info ) const ;

Whether the MpegHeaderInfo structure equals this one.

It tests for complete equality between all of its structures.

operator =

    public MpegHeaderInfo & operator = ( const MpegHeaderInfo & x ) ;

Assignment operator

tostring

    public string tostring ( ) const ;

Return a string representation of the information contained in the MpegHeaderInfo object.

This documentation was generated automatically by the ccdoc tool (version 0.7a).
Click here to submit a bug report or feature request.

Click here to return to the top of the page.