Nut/OS  4.10.3
API Reference
Helix

Helix MP3 Decoder. More...

Collaboration diagram for Helix:

Data Structures

struct  _HXDCB
struct  _MP3PLAYERINFO

Defines

#define AUDIO_DAC_MIN_GAIN   -73
#define AUDIO_DAC_MAX_GAIN   6
#define AUDIO_SETWRITETIMEOUT   0x010d
#define AUDIO_GETWRITETIMEOUT   0x010e
#define AUDIO_PLAY   0x3001
 Immediately start playing.
#define AUDIO_CANCEL   0x3002
 Immediately stop playing and discard buffer.
#define AUDIO_GET_STATUS   0x3003
#define AUDIO_GET_PLAYGAIN   0x3004
#define AUDIO_SET_PLAYGAIN   0x3005
#define AUDIO_GET_PBSIZE   0x3006
#define AUDIO_SET_PBSIZE   0x3007
#define AUDIO_GET_PBLEVEL   0x3008
#define AUDIO_GET_PBWLOW   0x3009
#define AUDIO_SET_PBWLOW   0x300A
#define AUDIO_GET_PBWHIGH   0x300B
#define AUDIO_SET_PBWHIGH   0x300C
#define AUDIO_BEEP   0x300F
#define AUDIO_GET_DECINFO   0x3010
 Retrieve decoder information.
#define AUDIO_GET_DECCAPS   0x3011
 Retrieve decoder capabilities.
#define AUDIO_GET_DECFMTS   0x3012
 Retrieve decoder formats.
#define AUDIO_SET_DECFMTS   0x3013
 Enable or disable specific decoder formats.
#define AUDIO_GET_CODINFO   0x3014
 Retrieve encoder information.
#define AUDIO_GET_CODCAPS   0x3015
 Retrieve encoder capabilities.
#define AUDIO_GET_CODFMTS   0x3016
 Retrieve encoder formats.
#define AUDIO_SET_CODFMTS   0x3017
 Enable or disable specific encoder formats.
#define AUDIO_GET_MIDINFO   0x3018
 Retrieve midi information.
#define AUDIO_GET_MIDCAPS   0x3019
 Retrieve midi capabilities.
#define CODEC_STATUS_IDLE   0
#define CODEC_STATUS_PLAYING   1

Typedefs

typedef struct _HXDCB HXDCB
typedef struct _MP3PLAYERINFO MP3PLAYERINFO

Functions

void FeederThread (void *arg)

Variables

NUTDEVICE devHelixCodec
 Device information structure.
NUTDEVICE devHelixCodec
 Device information structure.

Detailed Description

Helix MP3 Decoder.


Define Documentation

#define AUDIO_DAC_MIN_GAIN   -73

Definition at line 54 of file hxcodec.h.

Referenced by VsDecoderSetVolume().

#define AUDIO_DAC_MAX_GAIN   6

Definition at line 57 of file hxcodec.h.

Referenced by VsDecoderSetVolume().

#define AUDIO_SETWRITETIMEOUT   0x010d

Definition at line 66 of file hxcodec.h.

Referenced by VsCodecIOCtl().

#define AUDIO_GETWRITETIMEOUT   0x010e

Definition at line 67 of file hxcodec.h.

Referenced by VsCodecIOCtl().

#define AUDIO_PLAY   0x3001

Immediately start playing.

Definition at line 70 of file hxcodec.h.

Referenced by VsCodecIOCtl().

#define AUDIO_CANCEL   0x3002

Immediately stop playing and discard buffer.

Definition at line 72 of file hxcodec.h.

Referenced by VsCodecIOCtl().

#define AUDIO_GET_STATUS   0x3003

Definition at line 73 of file hxcodec.h.

Referenced by VsCodecIOCtl().

#define AUDIO_GET_PLAYGAIN   0x3004

Definition at line 74 of file hxcodec.h.

Referenced by VsCodecIOCtl().

#define AUDIO_SET_PLAYGAIN   0x3005

Definition at line 75 of file hxcodec.h.

Referenced by VsCodecIOCtl().

#define AUDIO_GET_PBSIZE   0x3006

Definition at line 76 of file hxcodec.h.

Referenced by VsCodecIOCtl().

#define AUDIO_SET_PBSIZE   0x3007

Definition at line 77 of file hxcodec.h.

Referenced by VsCodecIOCtl().

#define AUDIO_GET_PBLEVEL   0x3008

Definition at line 78 of file hxcodec.h.

Referenced by VsCodecIOCtl().

#define AUDIO_GET_PBWLOW   0x3009

Definition at line 79 of file hxcodec.h.

Referenced by VsCodecIOCtl().

#define AUDIO_SET_PBWLOW   0x300A

Definition at line 80 of file hxcodec.h.

Referenced by VsCodecIOCtl().

#define AUDIO_GET_PBWHIGH   0x300B

Definition at line 81 of file hxcodec.h.

Referenced by VsCodecIOCtl().

#define AUDIO_SET_PBWHIGH   0x300C

Definition at line 82 of file hxcodec.h.

Referenced by VsCodecIOCtl().

#define AUDIO_BEEP   0x300F

Definition at line 83 of file hxcodec.h.

Referenced by VsCodecIOCtl().

#define AUDIO_GET_DECINFO   0x3010

Retrieve decoder information.

Definition at line 85 of file hxcodec.h.

Referenced by VsCodecIOCtl().

#define AUDIO_GET_DECCAPS   0x3011

Retrieve decoder capabilities.

Definition at line 87 of file hxcodec.h.

Referenced by VsCodecIOCtl().

#define AUDIO_GET_DECFMTS   0x3012

Retrieve decoder formats.

Definition at line 89 of file hxcodec.h.

#define AUDIO_SET_DECFMTS   0x3013

Enable or disable specific decoder formats.

Definition at line 91 of file hxcodec.h.

#define AUDIO_GET_CODINFO   0x3014

Retrieve encoder information.

Definition at line 93 of file hxcodec.h.

Referenced by VsCodecIOCtl().

#define AUDIO_GET_CODCAPS   0x3015

Retrieve encoder capabilities.

Definition at line 95 of file hxcodec.h.

Referenced by VsCodecIOCtl().

#define AUDIO_GET_CODFMTS   0x3016

Retrieve encoder formats.

Definition at line 97 of file hxcodec.h.

#define AUDIO_SET_CODFMTS   0x3017

Enable or disable specific encoder formats.

Definition at line 99 of file hxcodec.h.

#define AUDIO_GET_MIDINFO   0x3018

Retrieve midi information.

Definition at line 101 of file hxcodec.h.

Referenced by VsCodecIOCtl().

#define AUDIO_GET_MIDCAPS   0x3019

Retrieve midi capabilities.

Definition at line 103 of file hxcodec.h.

Referenced by VsCodecIOCtl().

#define CODEC_STATUS_IDLE   0

Definition at line 109 of file hxcodec.h.

Referenced by FeederThread(), VsCodecIOCtl(), VsCodecRead(), and VsDecoderBufferInit().

#define CODEC_STATUS_PLAYING   1

Definition at line 110 of file hxcodec.h.

Referenced by FeederThread(), VsCodecIOCtl(), and VsCodecRead().


Typedef Documentation

typedef struct _HXDCB HXDCB
typedef struct _MP3PLAYERINFO MP3PLAYERINFO

Function Documentation


Variable Documentation

Device information structure.

An application must pass a pointer to this structure to NutRegisterDevice() before using this driver.

The device is named audio0.

Definition at line 643 of file hxcodec.c.

Initial value:
 {
    0,              
    {'a', 'u', 'd', 'i', 'o', '0', 0, 0, 0},    
    IFTYP_CHAR,     
    0,              
    0,              
    0,              
    &dcb,           
    HelixInit,         
    HelixIOCtl,        
    NULL,           
    HelixWrite,        

    HelixWrite_P,      

    HelixOpen,         
    HelixClose,        
    NULL            
}

Device information structure.

An application must pass a pointer to this structure to NutRegisterDevice() before using this driver.

The device is named audio0.

Definition at line 643 of file hxcodec.c.