VLSI Solution Oy / MegaLib Documentation

Codec Struct Reference

#include <codec.h>

Collaboration diagram for Codec:

Collaboration graph
[legend]

Data Fields

u_int16 version
Codec *(* Create )(void)
enum CodecError(* Decode )(struct Codec *cod, struct CodecServices *cs, const char **errorString)
void(* Delete )(struct Codec *cod)
CodecServicescs

Detailed Description

Standard Codec wrap-up structure

Definition at line 154 of file codec.h.


Field Documentation

struct Codec*(* Codec::Create)(void)
 

Create and allocate space for codec.

struct CodecServices* Codec::cs
 

A pointer that the codec may or may not fill or use.

Definition at line 168 of file codec.h.

enum CodecError(* Codec::Decode)(struct Codec *cod, struct CodecServices *cs, const char **errorString)
 

Decode file. Upon success or a negative number, Codec has succeeded. With a positive number, there has been an error. Upon return, an error string is also returned.

void(* Codec::Delete)(struct Codec *cod)
 

Free all resources allocated for codec.

u_int16 Codec::version
 

Version number. 8 MSBs contain version number, 8 LSBs size of the structure in words.

Definition at line 157 of file codec.h.


The documentation for this struct was generated from the following file:
All software copyright 2005-2006 VLSI Solution OY. Redistribution of this software is strictly forbidden.