IpatchSampleFile

IpatchSampleFile — Base class for audio sample files.

Synopsis




                    IpatchSampleFile;
                    IpatchSampleFileClass;
#define             IPATCH_SAMPLE_FILE_TYPE_RAW
#define             IPATCH_SAMPLE_FILE_TYPE_WAVE
const char**        ipatch_sample_file_get_save_types   (GType type);

Object Hierarchy


  GObject
   +----IpatchItem
         +----IpatchFile
               +----IpatchSampleFile

Implemented Interfaces

IpatchSampleFile implements IpatchSample.

Properties


  "channels"                 gint                  : Read / Write
  "fine-tune"                gint                  : Read / Write
  "format"                   gint                  : Read / Write
  "frame-size"               gint                  : Read
  "lil-endian"               gboolean              : Read / Write
  "loop-end"                 guint                 : Read / Write
  "loop-start"               guint                 : Read / Write
  "loop-type"                IpatchSampleLoopType  : Read / Write
  "root-note"                gint                  : Read / Write
  "sample-rate"              gint                  : Read / Write
  "signed"                   gboolean              : Read / Write
  "type"                     gchararray            : Read / Write
  "width"                    IpatchSampleWidth     : Read / Write

Description

This object provides a base class for audio sample files such as WAV, AIFF, etc. Its a sub class of IpatchFile and so therefore read/writing can be performed like it was a regular file (except for a few caveats). This object will often be subclassed for different sample library implementations such as libsndfile, audiofile or GStreamer.

Details

IpatchSampleFile

typedef struct _IpatchSampleFile IpatchSampleFile;


IpatchSampleFileClass

typedef struct {
  IpatchFileClass parent_class;

  G_CONST_RETURN char ** (*get_save_types)(void);
} IpatchSampleFileClass;


IPATCH_SAMPLE_FILE_TYPE_RAW

#define IPATCH_SAMPLE_FILE_TYPE_RAW   "raw" /* special type */


IPATCH_SAMPLE_FILE_TYPE_WAVE

#define IPATCH_SAMPLE_FILE_TYPE_WAVE  "wave" /* default type */


ipatch_sample_file_get_save_types ()

const char**        ipatch_sample_file_get_save_types   (GType type);

Gets a list of supported file types available for saving to for a given IpatchSampleFile derived type.

type : A IpatchSampleFile derived type
Returns : NULL terminated array of strings for each supported save type or NULL if no types supported or invalid IpatchSampleFile type.

Property Details

The "channels" property

  "channels"                 gint                  : Read / Write

Audio channels.

Allowed values: [1,2]

Default value: 1


The "fine-tune" property

  "fine-tune"                gint                  : Read / Write

Fine tuning in cents.

Allowed values: [-99,99]

Default value: 0


The "format" property

  "format"                   gint                  : Read / Write

Complete sample format integer.

Default value: 2


The "frame-size" property

  "frame-size"               gint                  : Read

Sample virtual frame size in bytes.

Allowed values: [1,16]

Default value: 2


The "lil-endian" property

  "lil-endian"               gboolean              : Read / Write

Little endian byte order.

Default value: TRUE


The "loop-end" property

  "loop-end"                 guint                 : Read / Write

Loop end in frames (after loop).

Default value: 0


The "loop-start" property

  "loop-start"               guint                 : Read / Write

Start of loop in frames.

Default value: 0


The "loop-type" property

  "loop-type"                IpatchSampleLoopType  : Read / Write

Loop method type.

Default value: IPATCH_SAMPLE_LOOP_NONE


The "root-note" property

  "root-note"                gint                  : Read / Write

Root MIDI note.

Allowed values: [0,127]

Default value: 60


The "sample-rate" property

  "sample-rate"              gint                  : Read / Write

Sampling rate in Hertz.

Allowed values: [8000,192000]

Default value: 44100


The "signed" property

  "signed"                   gboolean              : Read / Write

Signed data format.

Default value: TRUE


The "type" property

  "type"                     gchararray            : Read / Write

Sample file type.

Default value: NULL


The "width" property

  "width"                    IpatchSampleWidth     : Read / Write

Bit width data type.

Default value: IPATCH_SAMPLE_16BIT