deBaseVideoModule Class Reference

Base Video Module. More...

#include <deBaseVideoModule.h>

Inheritance diagram for deBaseVideoModule:
deBaseModule

List of all members.

Public Member Functions

Constructors and Destructors
 deBaseVideoModule (deLoadableModule *loadableModule)
 Creates a new module.
virtual ~deBaseVideoModule ()
 Cleans up the module.
Management
virtual deBaseVideoInfoInitLoadVideo (decBaseFileReader *file)=0
 Do a quick check if the given file can be loaded by this video module.
virtual void LoadVideo (decBaseFileReader *file, deVideo *video, deBaseVideoInfo *infos)=0
 Load the video into the provided storage.
virtual void SaveVideo (decBaseFileWriter *file, deVideo *video)=0
 Save the video in the provided storage into file.
virtual deBaseVideoDecoderCreateDecoder (decBaseFileReader *file)=0
 Creates a video decoder object for the given file.

Detailed Description

Base Video Module.

Video modules allow to load and save videos.

Author:
Plüss Roland
Version:
1.0
Date:
2010

Constructor & Destructor Documentation

deBaseVideoModule::deBaseVideoModule ( deLoadableModule loadableModule )

Creates a new module.

virtual deBaseVideoModule::~deBaseVideoModule (  ) [virtual]

Cleans up the module.


Member Function Documentation

virtual deBaseVideoDecoder* deBaseVideoModule::CreateDecoder ( decBaseFileReader file ) [pure virtual]

Creates a video decoder object for the given file.

virtual deBaseVideoInfo* deBaseVideoModule::InitLoadVideo ( decBaseFileReader file ) [pure virtual]

Do a quick check if the given file can be loaded by this video module.

This is usually a header check and is used to detect with what video module a file could be possibly loaded if it does not match any patterns. If the video can be loaded store the necessary informations into an VideoInfo object and return it. Otherwise return NULL. The returned VideoInfo object is used to create the video and as parameter to LoadVideo. You can be sure that the file pointer is located at the beginning of the file.

virtual void deBaseVideoModule::LoadVideo ( decBaseFileReader file,
deVideo video,
deBaseVideoInfo infos 
) [pure virtual]

Load the video into the provided storage.

You can be sure that the file pointer is at the same place left off after the prior call of CheckLoadVideo on the same file and module. You can be sure that the video object specified in the function call has been created with the information stored in the infos parameter obtained from a prior call to the CheckLoadVideo function.

virtual void deBaseVideoModule::SaveVideo ( decBaseFileWriter file,
deVideo video 
) [pure virtual]

Save the video in the provided storage into file.

You can be sure that the file provided has been rewinded prior to this function call.


The documentation for this class was generated from the following file: