VLSI Solution Oy / MegaLib Documentation

codec.h File Reference

#include <vstypes.h>

Include dependency graph for codec.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  CodecServices
struct  Codec

Defines

#define MAX_SOURCE_CHANNELS   6
#define CODEC_VERSION   0x0105
#define FS_CODEC_SERVICES_VERSION   0x0125
#define FS_CODSER_COMMENT_END_OF_LINE   0x4000U
#define FS_CODSER_COMMENT_END_OF_COMMENTS   ((u_int16)(0x8000U))
#define CS_VERSION_OFFSET   0
#define CS_READ_OFFSET   1
#define CS_SKIP_OFFSET   2
#define CS_SEEK_OFFSET   3
#define CS_TELL_OFFSET   4
#define CS_OUTPUT_OFFSET   5
#define CS_COMMENT_OFFSET   6
#define CS_SPECTRUM_OFFSET   7
#define CS_FILE_SIZE_OFFSET   8
#define CS_FILE_LEFT_OFFSET   10
#define CS_GO_TO_OFFSET   12
#define CS_CANCEL_OFFSET   13
#define CS_PLAY_TIME_SECONDS_OFFSET   14
#define CS_PLAY_TIME_SAMPLES_OFFSET   16
#define CS_PLAY_TIME_TOTAL_OFFSET   18
#define CS_SAMPLE_RATE_OFFSET   20
#define CS_CHANNELS_OFFSET   22
#define CS_MATRIX_OFFSET   23
#define CS_AVG_BIT_RATE_OFFSET   29
#define CS_CURR_BIT_RATE_OFFSET   31
#define CS_PEAK_BIT_RATE_OFFSET   33
#define CS_GAIN_OFFSET   35
#define CS_FAST_FORWARD_OFFSET   36
#define CODEC_VERSION_OFFSET   0
#define CODEC_CREATE_OFFSET   1
#define CODEC_DECODE_OFFSET   2
#define CODEC_DELETE_OFFSET   3
#define CODEC_CS_OFFSET   4

Enumerations

enum  CodecError {
  ceFastForward = -1, ceOk = 0, ceFormatNotFound, ceFormatNotSupported,
  ceUnexpectedFileEnd, ceCancelled, ceOtherError
}


Detailed Description

Codec interfaces.

Definition in file codec.h.


Define Documentation

#define CODEC_CREATE_OFFSET   1
 

Definition at line 198 of file codec.h.

#define CODEC_CS_OFFSET   4
 

Definition at line 201 of file codec.h.

#define CODEC_DECODE_OFFSET   2
 

Definition at line 199 of file codec.h.

#define CODEC_DELETE_OFFSET   3
 

Definition at line 200 of file codec.h.

#define CODEC_VERSION   0x0105
 

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

Version number history:

  1. 0x0105 First version

Definition at line 26 of file codec.h.

#define CODEC_VERSION_OFFSET   0
 

Definition at line 197 of file codec.h.

#define CS_AVG_BIT_RATE_OFFSET   29
 

Definition at line 191 of file codec.h.

#define CS_CANCEL_OFFSET   13
 

Definition at line 184 of file codec.h.

#define CS_CHANNELS_OFFSET   22
 

Definition at line 189 of file codec.h.

#define CS_COMMENT_OFFSET   6
 

Definition at line 179 of file codec.h.

#define CS_CURR_BIT_RATE_OFFSET   31
 

Definition at line 192 of file codec.h.

#define CS_FAST_FORWARD_OFFSET   36
 

Definition at line 195 of file codec.h.

#define CS_FILE_LEFT_OFFSET   10
 

Definition at line 182 of file codec.h.

#define CS_FILE_SIZE_OFFSET   8
 

Definition at line 181 of file codec.h.

#define CS_GAIN_OFFSET   35
 

Definition at line 194 of file codec.h.

#define CS_GO_TO_OFFSET   12
 

Definition at line 183 of file codec.h.

#define CS_MATRIX_OFFSET   23
 

Definition at line 190 of file codec.h.

#define CS_OUTPUT_OFFSET   5
 

Definition at line 178 of file codec.h.

#define CS_PEAK_BIT_RATE_OFFSET   33
 

Definition at line 193 of file codec.h.

#define CS_PLAY_TIME_SAMPLES_OFFSET   16
 

Definition at line 186 of file codec.h.

#define CS_PLAY_TIME_SECONDS_OFFSET   14
 

Definition at line 185 of file codec.h.

#define CS_PLAY_TIME_TOTAL_OFFSET   18
 

Definition at line 187 of file codec.h.

#define CS_READ_OFFSET   1
 

Definition at line 174 of file codec.h.

#define CS_SAMPLE_RATE_OFFSET   20
 

Definition at line 188 of file codec.h.

#define CS_SEEK_OFFSET   3
 

Definition at line 176 of file codec.h.

#define CS_SKIP_OFFSET   2
 

Definition at line 175 of file codec.h.

#define CS_SPECTRUM_OFFSET   7
 

Definition at line 180 of file codec.h.

#define CS_TELL_OFFSET   4
 

Definition at line 177 of file codec.h.

#define CS_VERSION_OFFSET   0
 

Definition at line 173 of file codec.h.

#define FS_CODEC_SERVICES_VERSION   0x0125
 

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

Version number history:

  1. 0x0125 First version

Definition at line 37 of file codec.h.

#define FS_CODSER_COMMENT_END_OF_COMMENTS   ((u_int16)(0x8000U))
 

Definition at line 41 of file codec.h.

#define FS_CODSER_COMMENT_END_OF_LINE   0x4000U
 

Definition at line 40 of file codec.h.

#define MAX_SOURCE_CHANNELS   6
 

Definition at line 13 of file codec.h.


Enumeration Type Documentation

enum CodecError
 

Codec error codes.

Enumerator:
ceFastForward  Fast forwarded through file end
ceOk  No errors.
ceFormatNotFound  Data file was not in known format for the codec
ceFormatNotSupported  Data file subformat is not supported.
ceUnexpectedFileEnd  Unexpectedly early end of file
ceCancelled  Playback cancel was requested
ceOtherError  Unspecific error

Definition at line 142 of file codec.h.

00142                 {
00143   ceFastForward = -1,   
00144   ceOk = 0,             
00145   ceFormatNotFound,     
00146   ceFormatNotSupported, 
00147   ceUnexpectedFileEnd,  
00148   ceCancelled,          
00149   ceOtherError          
00150 };


All software copyright 2005-2006 VLSI Solution OY. Redistribution of this software is strictly forbidden.