IPATCH_SAMPLE_MAX_TRANSFORM_FUNCS

#define IPATCH_SAMPLE_MAX_TRANSFORM_FUNCS 16

Maximum number of transform functions returned by ipatch_sample_get_transform_funcs(). Is larger than current actual maximum to allow for future backwards compatible expansion (8 is the real current maximum).

IPATCH_SAMPLE_FORMAT_MASK

#define IPATCH_SAMPLE_FORMAT_MASK   0x1FF

Mask for all fields of sample format integers (width, sign, endian, channel).

IPATCH_SAMPLE_FORMAT_BITCOUNT

#define IPATCH_SAMPLE_FORMAT_BITCOUNT  9

Number of bits used for sample format integers.

IPATCH_SAMPLE_WIDTH_MASK

#define IPATCH_SAMPLE_WIDTH_MASK    0x00F  /* total of 16 formats (8 reserved) */

IPATCH_SAMPLE_CHANNEL_MASK

#define IPATCH_SAMPLE_CHANNEL_MASK  0x070  /* channel count (8 channels max) */

IPATCH_SAMPLE_SIGN_MASK

#define IPATCH_SAMPLE_SIGN_MASK     0x080  /* sign or unsigned (for PCM formats) */

IPATCH_SAMPLE_ENDIAN_MASK

#define IPATCH_SAMPLE_ENDIAN_MASK   0x100  /* endian byte order */

IPATCH_SAMPLE_WIDTH_SHIFT

#define IPATCH_SAMPLE_WIDTH_SHIFT   0

IPATCH_SAMPLE_CHANNEL_SHIFT

#define IPATCH_SAMPLE_CHANNEL_SHIFT 4

IPATCH_SAMPLE_SIGN_SHIFT

#define IPATCH_SAMPLE_SIGN_SHIFT    7

IPATCH_SAMPLE_ENDIAN_SHIFT

#define IPATCH_SAMPLE_ENDIAN_SHIFT  8

enum IpatchSampleWidth

typedef enum
{
  IPATCH_SAMPLE_INVALID = 0,
  IPATCH_SAMPLE_8BIT  = 1,
  IPATCH_SAMPLE_16BIT = 2,
  IPATCH_SAMPLE_24BIT = 3,
  IPATCH_SAMPLE_32BIT = 4,
  IPATCH_SAMPLE_FLOAT = 5,
  IPATCH_SAMPLE_DOUBLE = 6,
  IPATCH_SAMPLE_REAL24BIT = 7
} IpatchSampleWidth;

Sample data widths/formats.

enum IpatchSampleChannel

typedef enum
{
  IPATCH_SAMPLE_MONO    = 0 << IPATCH_SAMPLE_CHANNEL_SHIFT,
  IPATCH_SAMPLE_STEREO  = 1 << IPATCH_SAMPLE_CHANNEL_SHIFT
} IpatchSampleChannel;

Descriptive enums for common audio channel configurations. These values are actually channel count - 1 (0 = mono, 1 = stereo, etc) and can be compared with the macro IPATCH_SAMPLE_FORMAT_GET_CHANNELS().

enum IpatchSampleChannelType

typedef enum
{
  IPATCH_SAMPLE_LEFT =  0,
  IPATCH_SAMPLE_RIGHT = 1
} IpatchSampleChannelType;

Channel designation. Currently there are only 2 designated channels, though the remaining 6 supported channels may be defined to be surround sound channels in the future.

IPATCH_SAMPLE_MAX_CHANNELS

#define IPATCH_SAMPLE_MAX_CHANNELS      8

Maximum number of audio channels handled by libInstPatch.

enum IpatchSampleSign

typedef enum
{
  IPATCH_SAMPLE_SIGNED   = 0 << IPATCH_SAMPLE_SIGN_SHIFT,
  IPATCH_SAMPLE_UNSIGNED = 1 << IPATCH_SAMPLE_SIGN_SHIFT
} IpatchSampleSign;

Defines the sign of PCM integer audio data.

enum IpatchSampleEndian

typedef enum
{
  IPATCH_SAMPLE_LENDIAN = 0 << IPATCH_SAMPLE_ENDIAN_SHIFT,
  IPATCH_SAMPLE_BENDIAN = 1 << IPATCH_SAMPLE_ENDIAN_SHIFT
} IpatchSampleEndian;

Defines the byte order of multi-byte audio data.

IPATCH_SAMPLE_ENDIAN_HOST

#define             IPATCH_SAMPLE_ENDIAN_HOST

Host byte order value (IPATCH_SAMPLE_LENDIAN or IPATCH_SAMPLE_BENDIAN).

IPATCH_SAMPLE_FORMAT_GET_WIDTH()

#define             IPATCH_SAMPLE_FORMAT_GET_WIDTH(format)

Get IpatchSampleWidth enum from a sample format integer.

IPATCH_SAMPLE_FORMAT_GET_CHANNELS()

#define             IPATCH_SAMPLE_FORMAT_GET_CHANNELS(format)

Get the channel field from a sample format integer.

IPATCH_SAMPLE_FORMAT_GET_CHANNEL_COUNT()

#define             IPATCH_SAMPLE_FORMAT_GET_CHANNEL_COUNT(format)

Get the channel count from a sample format integer.

IPATCH_SAMPLE_FORMAT_IS_SIGNED()

#define             IPATCH_SAMPLE_FORMAT_IS_SIGNED(format)

Check if a sample format integer defines signed audio.

IPATCH_SAMPLE_FORMAT_IS_UNSIGNED()

#define             IPATCH_SAMPLE_FORMAT_IS_UNSIGNED(format)

Check if a sample format integer defines unsigned audio.

IPATCH_SAMPLE_FORMAT_IS_LENDIAN()

#define             IPATCH_SAMPLE_FORMAT_IS_LENDIAN(format)

Check if a sample format integer defines little endian audio.

IPATCH_SAMPLE_FORMAT_IS_BENDIAN()

#define             IPATCH_SAMPLE_FORMAT_IS_BENDIAN(format)

Check if a sample format integer defines big endian audio.

ipatch_sample_format_size()

#define             ipatch_sample_format_size(format)

Get frame byte size for a given sample format (sample byte size * channels).

ipatch_sample_format_width()

#define             ipatch_sample_format_width(format)

Gets the number of bytes used for storing a single sample for format. Doesn't take into account channels. This is the number of bytes used to store the samples, not the effective bit width. For example: IPATCH_SAMPLE_24BIT uses 4 bytes for each sample.

IPATCH_SAMPLE_MAP_CHANNEL()

#define IPATCH_SAMPLE_MAP_CHANNEL(dest, src)   ((src) << (3 * (dest)))

Macro to calculate a channel mapping value for a given destination and source. A channel mapping is composed of up to 24 bits (3 bits * 8 channels = 24). Channel mappings are used for sample conversions to route channels from a source format to a destination format. Multiple channel map values should be OR'd together.

IPATCH_SAMPLE_MAP_GET_CHANNEL()

#define IPATCH_SAMPLE_MAP_GET_CHANNEL(map, dest)   (((map) >> ((dest) * 3)) & 0x07)

Macro to get a source channel value given a destination channel.

IPATCH_SAMPLE_UNITY_CHANNEL_MAP

#define IPATCH_SAMPLE_UNITY_CHANNEL_MAP   0xFAC688

Unity channel mapping which routes each input channel to the same output channel.

ipatch_sample_format_bit_width ()

int                 ipatch_sample_format_bit_width      (int format);

Like ipatch_sample_format_width() but gets the effective bit width of the format. Of note is this is not always equivelant to the format width * 8. For example: IPATCH_SAMPLE_FLOAT has an effective bit width of 23, IPATCH_SAMPLE_24BIT has an effective bit width of 24 but is stored in 32 bits. This function is really only useful for comparing the relative "quality" of formats, and the actual returned values may change in the future.

ipatch_sample_format_verify ()

gboolean            ipatch_sample_format_verify         (int format);

Verify a sample format integer.

ipatch_sample_format_transform_verify ()

gboolean            ipatch_sample_format_transform_verify
                                                        (int src_format,
                                                         int dest_format,
                                                         guint32 channel_map);

Verify source and destination sample formats and channel map for a sample transform operation.

ipatch_sample_get_transform_funcs ()

guint               ipatch_sample_get_transform_funcs   (int src_format,
                                                         int dest_format,
                                                         guint32 channel_map,
                                                         guint *buf1_max_frame,
                                                         guint *buf2_max_frame,
                                                         IpatchSampleTransformFunc *funcs);

Get transform function array for converting from src_format to dest_format.

func_count: Count of function pointers stored to funcs. Can be 0 if no transform is required.