libnjb global type definitions

The libnjb configuration API

The basic device management and information API

The track and tag (song ID metadata) manipulation API

The playlist manipulation API

The datafile tag (metadata) retrieveal API

The EAX (and volume) manipulation API

The time manipulation API

The track playback (listening) API

struct njb_struct

struct njb_songid_frame_struct

struct njb_songid_struct

struct njb_playlist_track_struct

struct njb_playlist_struct

struct njb_datafile_struct

struct njb_eax_struct

struct njb_time_struct

struct njb_keyval_struct

#define NJB_TURBO_OFF 0

#define NJB_TURBO_ON 1

#define OWNER_STRING_LENGTH 128

#define NJB_PL_NEW 0

#define NJB_PL_UNCHANGED 1

#define NJB_PL_CHNAME 2

#define NJB_PL_CHTRACKS 3

#define NJB_FILEFLAGS_REGULAR_FILE 0x80000000U

typedef unsigned char owner_string [OWNER_STRING_LENGTH+1]

typedef int NJB_Xfer_Callback (u_int64_t sent, u_int64_t total, const char *buf, unsigned len, void *data)

enum njb_eax_control_t { NJB_EAX_NO_CONTROL, NJB_EAX_SLIDER_CONTROL, NJB_EAX_FIXED_OPTION_CONTROL }

usb_dev_handle * njb_struct::dev

u_int8_t njb_struct::usb_config

u_int8_t njb_struct::usb_interface

u_int8_t njb_struct::usb_bulk_in_ep

u_int8_t njb_struct::usb_bulk_out_ep

int njb_struct::device_type

int njb_struct::updated

u_int32_t njb_struct::xfersize

void * njb_struct::protocol_state

void * njb_struct::error_stack

u_int8_t njb_songid_frame_struct::type

u_int8_t njb_songid_frame_struct::u_int8_val

u_int16_t njb_songid_frame_struct::u_int16_val

u_int32_t njb_songid_frame_struct::u_int32_val

u_int64_t njb_songid_frame_struct::u_int64_val

union {

char * strval

u_int8_t njb_songid_frame_struct::u_int8_val

u_int16_t njb_songid_frame_struct::u_int16_val

u_int32_t njb_songid_frame_struct::u_int32_val

u_int64_t njb_songid_frame_struct::u_int64_val

} njb_songid_frame_struct::data

njb_songid_frame_t * njb_songid_frame_struct::next

u_int16_t njb_songid_struct::nframes

njb_songid_frame_t * njb_songid_struct::first

njb_songid_frame_t * njb_songid_struct::last

njb_songid_frame_t * njb_songid_struct::cur

njb_songid_t * njb_songid_struct::next

njb_playlist_track_struct * njb_playlist_track_struct::prev

njb_playlist_track_struct * njb_playlist_track_struct::next

int njb_playlist_struct::_state

u_int32_t njb_playlist_struct::ntracks

u_int32_t njb_playlist_struct::plid

njb_playlist_track_t * njb_playlist_struct::first

njb_playlist_track_t * njb_playlist_struct::last

njb_playlist_track_t * njb_playlist_struct::cur

njb_playlist_t * njb_playlist_struct::nextpl

char * njb_datafile_struct::folder

u_int32_t njb_datafile_struct::timestamp

u_int32_t njb_datafile_struct::flags

u_int32_t njb_datafile_struct::dfid

u_int64_t njb_datafile_struct::filesize

njb_datafile_t * njb_datafile_struct::nextdf

char * njb_eax_struct::name

u_int8_t njb_eax_struct::exclusive

u_int8_t njb_eax_struct::group

njb_eax_control_t njb_eax_struct::type

int16_t njb_eax_struct::current_value

int16_t njb_eax_struct::min_value

int16_t njb_eax_struct::max_value

char ** njb_eax_struct::option_names

njb_eax_t * njb_eax_struct::next

int16_t njb_time_struct::month

int16_t njb_time_struct::day

int16_t njb_time_struct::weekday

int16_t njb_time_struct::hours

int16_t njb_time_struct::minutes

int16_t njb_time_struct::seconds

u_int32_t njb_keyval_struct::value1

u_int32_t njb_keyval_struct::value2

unsigned char njb_keyval_struct::deviceid [16]

njb_keyval_t * njb_keyval_struct::next

This definition corresponds to the standard file permissions set for most files transferred from Windows machines to the device 'file system' (file database). Can be used as a template to simplify things.

This playlist has changed name

This playlist has a new track listing

This playlist is new

This playlist has not changed

turbo mode is off for series 3 devices

turbo mode is on for series 3 devices

The fixed length of the owner string

The callback type

A type defined for owner strings

This is the EAX Control Type

The state of this playlist

Examples: pl.c, and playlists.c.

A pointer to the current track in this playlist

A pointer to the current frame

The current value of this effect. Notice that this value may be negative!

Examples: dumpeax.c.

This is a union of possible frame types

Examples: gettr.c, and tracks.c.

Day (0-31)

Examples: dumptime.c, and settime.c.

The libusb device handle for this jukebox

what kind of jukebox this is

Examples: handshake.c.

The SDMI compliant device ID associated with this key

The 32-bit unsigned file ID.

Examples: files.c, and getfile.c.

Error stack, used inside libnjb

0x00 = not exclusive, 0x01 = exclusive The 'exclusive' attribute signifies if this effect can be used in parallell with other EAX effects, GUI:s shall make sure all other effects are reset to default values when one effect is chosen.

Examples: dumpeax.c.

The file size as a 64-bit unsigned integer. The files on series 3 devices only have 32-bit signed length (and can only be 2GB in size) but the NJB1 supports 64-bit length.

Examples: files.c, and getfile.c.

A pointer to the first track in this playlist

A pointer to the first frame

These are ordinary windows file flags:

bit (from MSB) meaning ----------------------------- 31 Normal file (0x80000000U) 29 This file should be archived (0x20000000U) 28 Directory (0x10000000U) 26 System file (0x04000000U) 25 Hidden file (0x02000000U) 24 Read only file (0x01000000U) 22 Encrypted file (0x00400000U) 21 Normal file? (0x00200000U) 19 Compressed file (0x00080000U) 17 Sparse file (0x00020000U) 16 Temporary file (0x00010000U)

SAMBA maps the bits to Unix permissions thus:

owner group world r w x r w x r w x ^ ^ ^ ^ ^ | | | | | | | Archive System Hidden | | Read only

The meaning of bits 30, 27, 23, 20 and 15-0 is unknown.

Examples: files.c.

This is the name of the folder the file belongs in. All folder names are given with full hierarchy and leading and trailing backslash as in: '\foo\bar\fnord\'. If filename is '.' this is the name of the empty folder.

Examples: files.c.

The visual group for this effect - effects appearing after each other are grouped if their group numbers are identical

Examples: dumpeax.c.

Hours (24-hour notation)

Examples: dumptime.c, and settime.c.

A pointer to the last track in this playlist

A pointer to the last frame

The maximum value for this effect.

Examples: dumpeax.c.

The minumum value for this effect. Notice that this value may be negative!

Examples: dumpeax.c.

Minutes

Examples: dumptime.c, and settime.c.

Month (0-11)

Examples: dumptime.c, and settime.c.

The name of this effect

Examples: dumpeax.c.

A pointer to the next key/value pair

Only to be used inside of libnjb

The next track in the playlist

Used internally on series 3 devices for spanning lists of song IDs only

A pointer to the next frame following this one in the song ID

This is only to be used internally by libnjb.

Used internally for spanning lists of playlists on series 3 devices only

The number of frames in this song ID

The number of tracks in this playlist

Examples: pl.c, and playlists.c.

Array with names for the selections, if this is a fixed option control. It may not be dereferenced for slider controls.

Examples: dumpeax.c.

The playlist ID for this playlist, as used on the device

Examples: pl.c, and playlists.c.

The previous track in the playlist

dereferenced and maintained individually by protocol implementations

Seconds

Examples: dumptime.c, and settime.c.

A string value

This is an ordinary UNIX styled timestamp for the file.

NJB_EAX_NO_CONTROL, NJB_EAX_SLIDER_CONTROL, NJB_EAX_FIXED_OPTION_CONTROL

this replaces selectable, scalable with a single variable

Examples: dumpeax.c.

this tells us which subtype it is

Examples: tracks.c.

A 16 bit unsigned integer value

A 16 bit unsigned integer value

Examples: tracks.c.

A 32 bit unsigned integer value

A 32 bit unsigned integer value

Examples: gettr.c, and tracks.c.

A 64 bit unsigned integer value

A 64 bit unsigned integer value

An 8 bit unsigned integer value

An 8 bit unsigned integer value

If the device has been updated with some metadata

The BULK IN endpoint for this jukebox

The BULK OUT endpoint for this jukebox

The libusb config for this jukebox

The libusb interface for this jukebox

The first 32 bit unsigned integer of this key

The second 32 bit unsigned integer of this key

Day of the week 0=sunday, 6=saturday

Examples: dumptime.c, and settime.c.

The transfer size for endpoints