vidl_vil1_codec Class Reference

#include <vidl_vil1_codec.h>

Inheritance diagram for vidl_vil1_codec:

Detailed Description

Base for video coder/decoder.

A vidl_vil1_codec is a pure virtual class defining the codecs of video. See also vidl_vil1_io and vidl_vil1_image_list_codec and vidl_vil1_avicodec See also vidl_codec for use with vil instead of vil1.

Definition at line 27 of file vidl_vil1_codec.h.

Public Member Functions

vidl_vil1_codec ()

virtual ~vidl_vil1_codec ()

virtual vidl_vil1_image_list_codec * castto_vidl_vil1_image_list_codec ()

virtual vidl_vil1_mpegcodec * castto_vidl_vil1_mpegcodec ()

virtual vidl_vil1_avicodec * castto_vidl_vil1_avicodec ()

void set_number_frames (int n=0)

void set_name (vcl_string n="")

void set_description (vcl_string d="")

void set_format (char f= '\0')

void set_image_class (char t= 'M')

void set_bits_pixel (int d=0)

void set_width (int x=0)

void set_height (int y=0)

void set_size_z (int z=1)

void set_size_t (int t=1)

int length () const

vcl_string get_name () const

vcl_string get_description () const

char get_image_class () const

char get_format () const

int width () const

int height () const

int get_bits_pixel () const

int get_bytes_pixel () const

virtual bool get_section (int position, void *ib, int x0, int y0, int width, int height) const =0

virtual int put_section (int position, void *ib, int x0, int y0, int xs, int ys)=0

virtual vcl_string type () const =0

virtual vidl_vil1_codec_sptr load (vcl_string const &fname, char mode= 'r')=0

Try to load fname, and if successful, return the codec that did it.

virtual bool save (vidl_vil1_movie *movie, vcl_string const &fname)=0

Take a vidl_vil1_movie, and save in the format of this codec.

virtual bool probe (vcl_string const &fname)=0

Return true if fname looks like something we can read.

virtual void close ()

Perform any operations required to close down the codec.

void ref ()

void unref ()

int get_references () const

bool is_referenced () const

Private Member Functions

vidl_vil1_codec (vidl_vil1_codec const &)

void clear_strings ()

Private Attributes

vcl_string name

Video Name.

vcl_string description

Video Descriptor.

vcl_string date_time

Date/Time Stamp.

char format

Video format.

char Class

Video class.

int B

Pixel Precision.

int X

int Y

int Z

int T

Frame Size (width,height,up,time).

int numberframes

Length of the sequence.

Constructor & Destructor Documentation

vidl_vil1_codec::vidl_vil1_codec ( vidl_vil1_codec const & ) [inline, private]

Definition at line 29 of file vidl_vil1_codec.h.

vidl_vil1_codec::vidl_vil1_codec ( ) [inline]

Definition at line 33 of file vidl_vil1_codec.h.

virtual vidl_vil1_codec::~vidl_vil1_codec ( ) [inline, virtual]

Definition at line 34 of file vidl_vil1_codec.h.

Member Function Documentation

virtual vidl_vil1_avicodec* vidl_vil1_codec::castto_vidl_vil1_avicodec ( ) [inline, virtual]

Reimplemented in vidl_vil1_avicodec.
Definition at line 41 of file vidl_vil1_codec.h.

virtual vidl_vil1_image_list_codec* vidl_vil1_codec::castto_vidl_vil1_image_list_codec ( ) [inline, virtual]

Definition at line 39 of file vidl_vil1_codec.h.

virtual vidl_vil1_mpegcodec* vidl_vil1_codec::castto_vidl_vil1_mpegcodec ( ) [inline, virtual]

Reimplemented in vidl_vil1_mpegcodec.
Definition at line 40 of file vidl_vil1_codec.h.

void vidl_vil1_codec::clear_strings ( ) [inline, private]

Definition at line 101 of file vidl_vil1_codec.h.

virtual void vidl_vil1_codec::close ( ) [inline, virtual]

Perform any operations required to close down the codec.
This will typically be called just before program exit.
Definition at line 97 of file vidl_vil1_codec.h.

int vidl_vil1_codec::get_bits_pixel ( ) const [inline]

Definition at line 65 of file vidl_vil1_codec.h.

int vidl_vil1_codec::get_bytes_pixel ( ) const [inline]

Definition at line 66 of file vidl_vil1_codec.h.

vcl_string vidl_vil1_codec::get_description ( ) const [inline]

Definition at line 59 of file vidl_vil1_codec.h.

char vidl_vil1_codec::get_format ( ) const [inline]

Definition at line 62 of file vidl_vil1_codec.h.

char vidl_vil1_codec::get_image_class ( ) const [inline]

Definition at line 61 of file vidl_vil1_codec.h.

vcl_string vidl_vil1_codec::get_name ( ) const [inline]

Definition at line 58 of file vidl_vil1_codec.h.

virtual bool vidl_vil1_codec::get_section ( int position,

void * ib,

int x0,

int y0,

int width,

int height

) const [pure virtual]

Implemented in vidl_vil1_avicodec, vidl_vil1_image_list_codec, and vidl_vil1_mpegcodec.

int vidl_vil1_codec::height ( ) const [inline]

Definition at line 64 of file vidl_vil1_codec.h.

int vidl_vil1_codec::length ( ) const [inline]

Definition at line 57 of file vidl_vil1_codec.h.

virtual vidl_vil1_codec_sptr vidl_vil1_codec::load ( vcl_string const & fname,

char mode = 'r'

) [pure virtual]

Try to load fname, and if successful, return the codec that did it.

Implemented in vidl_vil1_avicodec, vidl_vil1_image_list_codec, and vidl_vil1_mpegcodec.

virtual bool vidl_vil1_codec::probe ( vcl_string const & fname ) [pure virtual]

Return true if fname looks like something we can read.

Implemented in vidl_vil1_avicodec, vidl_vil1_image_list_codec, and vidl_vil1_mpegcodec.

virtual int vidl_vil1_codec::put_section ( int position,

void * ib,

int x0,

int y0,

int xs,

int ys

) [pure virtual]

Implemented in vidl_vil1_avicodec, vidl_vil1_image_list_codec, and vidl_vil1_mpegcodec.

virtual bool vidl_vil1_codec::save ( vidl_vil1_movie * movie,

vcl_string const & fname

) [pure virtual]

Take a vidl_vil1_movie, and save in the format of this codec.

Implemented in vidl_vil1_avicodec, vidl_vil1_image_list_codec, and vidl_vil1_mpegcodec.

void vidl_vil1_codec::set_bits_pixel ( int d = 0 ) [inline]

Definition at line 49 of file vidl_vil1_codec.h.

void vidl_vil1_codec::set_description ( vcl_string d = "" ) [inline]

Definition at line 46 of file vidl_vil1_codec.h.

void vidl_vil1_codec::set_format ( char f = '\0' ) [inline]

Definition at line 47 of file vidl_vil1_codec.h.

void vidl_vil1_codec::set_height ( int y = 0 ) [inline]

Definition at line 51 of file vidl_vil1_codec.h.

void vidl_vil1_codec::set_image_class ( char t = 'M' ) [inline]

Definition at line 48 of file vidl_vil1_codec.h.

void vidl_vil1_codec::set_name ( vcl_string n = "" ) [inline]

Definition at line 45 of file vidl_vil1_codec.h.

void vidl_vil1_codec::set_number_frames ( int n = 0 ) [inline]

Definition at line 44 of file vidl_vil1_codec.h.

void vidl_vil1_codec::set_size_t ( int t = 1 ) [inline]

Definition at line 53 of file vidl_vil1_codec.h.

void vidl_vil1_codec::set_size_z ( int z = 1 ) [inline]

Definition at line 52 of file vidl_vil1_codec.h.

void vidl_vil1_codec::set_width ( int x = 0 ) [inline]

Definition at line 50 of file vidl_vil1_codec.h.

virtual vcl_string vidl_vil1_codec::type ( ) const [pure virtual]

Implemented in vidl_vil1_avicodec, vidl_vil1_image_list_codec, and vidl_vil1_mpegcodec.

int vidl_vil1_codec::width ( ) const [inline]

Definition at line 63 of file vidl_vil1_codec.h.

Member Data Documentation

int vidl_vil1_codec::B [private]

Pixel Precision.

Definition at line 108 of file vidl_vil1_codec.h.

char vidl_vil1_codec::Class [private]

Video class.

Definition at line 107 of file vidl_vil1_codec.h.

vcl_string vidl_vil1_codec::date_time [private]

Date/Time Stamp.

Definition at line 105 of file vidl_vil1_codec.h.

vcl_string vidl_vil1_codec::description [private]

Video Descriptor.

Definition at line 104 of file vidl_vil1_codec.h.

char vidl_vil1_codec::format [private]

Video format.

Definition at line 106 of file vidl_vil1_codec.h.

vcl_string vidl_vil1_codec::name [private]

Video Name.

Definition at line 103 of file vidl_vil1_codec.h.

int vidl_vil1_codec::numberframes [private]

Length of the sequence.

Definition at line 110 of file vidl_vil1_codec.h.

int vidl_vil1_codec::T [private]

Frame Size (width,height,up,time).

Definition at line 109 of file vidl_vil1_codec.h.

int vidl_vil1_codec::X [private]

Definition at line 109 of file vidl_vil1_codec.h.

int vidl_vil1_codec::Y [private]

Definition at line 109 of file vidl_vil1_codec.h.

int vidl_vil1_codec::Z [private]

Definition at line 109 of file vidl_vil1_codec.h.

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

core/vidl_vil1/vidl_vil1_codec.h

Generated on Thu Jan 10 14:41:18 2008 for core/vidl_vil1 by

1.4.4


Public Member Functions
	vidl_vil1_codec ()
virtual	~vidl_vil1_codec ()
virtual vidl_vil1_image_list_codec *	castto_vidl_vil1_image_list_codec ()
virtual vidl_vil1_mpegcodec *	castto_vidl_vil1_mpegcodec ()
virtual vidl_vil1_avicodec *	castto_vidl_vil1_avicodec ()
void	set_number_frames (int n=0)
void	set_name (vcl_string n="")
void	set_description (vcl_string d="")
void	set_format (char f= '\0')
void	set_image_class (char t= 'M')
void	set_bits_pixel (int d=0)
void	set_width (int x=0)
void	set_height (int y=0)
void	set_size_z (int z=1)
void	set_size_t (int t=1)
int	length () const
vcl_string	get_name () const
vcl_string	get_description () const
char	get_image_class () const
char	get_format () const
int	width () const
int	height () const
int	get_bits_pixel () const
int	get_bytes_pixel () const
virtual bool	get_section (int position, void *ib, int x0, int y0, int width, int height) const =0
virtual int	put_section (int position, void *ib, int x0, int y0, int xs, int ys)=0
virtual vcl_string	type () const =0
virtual vidl_vil1_codec_sptr	load (vcl_string const &fname, char mode= 'r')=0
	Try to load fname, and if successful, return the codec that did it.
virtual bool	save (vidl_vil1_movie *movie, vcl_string const &fname)=0
	Take a vidl_vil1_movie, and save in the format of this codec.
virtual bool	probe (vcl_string const &fname)=0
	Return true if fname looks like something we can read.
virtual void	close ()
	Perform any operations required to close down the codec.
void	ref ()
void	unref ()
int	get_references () const
bool	is_referenced () const
Private Member Functions
	vidl_vil1_codec (vidl_vil1_codec const &)
void	clear_strings ()
Private Attributes
vcl_string	name
	Video Name.
vcl_string	description
	Video Descriptor.
vcl_string	date_time
	Date/Time Stamp.
char	format
	Video format.
char	Class
	Video class.
int	B
	Pixel Precision.
int	X
int	Y
int	Z
int	T
	Frame Size (width,height,up,time).
int	numberframes
	Length of the sequence.