IpatchDLS2Sample

IpatchDLS2Sample — DLS audio sample object

Stability Level

Stable, unless otherwise indicated

Functions

Properties

char * archive-location Read / Write
char * artist Read / Write
char * comment Read / Write
char * commissioned Read / Write
char * copyright Read / Write
char * date Read / Write
char * engineer Read / Write
int fine-tune Read / Write
IpatchDLS2SampleFlags flags Read / Write
int gain Read / Write
char * genre Read / Write
char * keywords Read / Write
guint loop-end Read / Write
guint loop-start Read / Write
IpatchSampleLoopType loop-type Read / Write
char * medium Read / Write
char * name Read / Write
char * product Read / Write
int root-note Read / Write
IpatchSampleData * sample-data Read / Write
int sample-rate Read / Write
char * software Read / Write
char * source Read / Write
char * source-form Read / Write
char * subject Read / Write
char * technician Read / Write

Types and Values

Object Hierarchy

    GBoxed
    ╰── IpatchDLS2SampleInfo
    GObject
    ╰── IpatchItem
        ╰── IpatchDLS2Sample
            ╰── IpatchGigSample

Description

Object which defines a DLS audio sample. These objects are contained in IpatchDLS objects and linked (referenced) from IpatchDLSRegion objects.

Functions

ipatch_dls2_sample_new ()

IpatchDLS2Sample *
ipatch_dls2_sample_new (void);

Create a new DLS sample object.

Returns

New DLS sample with a reference count of 1. Caller owns the reference and removing it will destroy the item, unless another reference is added (if its parented for example).


ipatch_dls2_sample_first ()

IpatchDLS2Sample *
ipatch_dls2_sample_first (IpatchIter *iter);

Gets the first item in a sample iterator. A convenience wrapper for ipatch_iter_first().

[skip]

Parameters

iter

Patch item iterator containing IpatchDLS2Sample items

 

Returns

The first sample in iter or NULL if empty.


ipatch_dls2_sample_next ()

IpatchDLS2Sample *
ipatch_dls2_sample_next (IpatchIter *iter);

Gets the next item in a sample iterator. A convenience wrapper for ipatch_iter_next().

[skip]

Parameters

iter

Patch item iterator containing IpatchDLS2Sample items

 

Returns

The next sample in iter or NULL if at the end of the list.


ipatch_dls2_sample_set_data ()

void
ipatch_dls2_sample_set_data (IpatchDLS2Sample *sample,
                             IpatchSampleData *sampledata);

Set a sample's sample data object.

Parameters

sample

Sample to set sample data of

 

sampledata

Sample data to set sample to. Should be NULL or a IpatchSampleData object

 

ipatch_dls2_sample_get_data ()

IpatchSampleData *
ipatch_dls2_sample_get_data (IpatchDLS2Sample *sample);

Get the IpatchSampleData item of a sample. Sample data item is referenced before returning and caller is responsible for unreferencing it with g_object_unref() when finished with it.

Parameters

sample

Sample to get sample data from

 

Returns

Sample data object of sample or NULL if none. Remember to unreference with g_object_unref() when finished with it.

[transfer full]


ipatch_dls2_sample_peek_data ()

IpatchSampleData *
ipatch_dls2_sample_peek_data (IpatchDLS2Sample *sample);

Get the IpatchSampleData item of a sample. Like ipatch_dls2_sample_get_data() but sample data object is not referenced. This function should only be used if a reference of the sample data object is ensured or only the pointer value is of importance.

[skip]

Parameters

sample

Sample to get sample data from

 

Returns

Sample data object of sample or NULL if none. Remember that a reference is NOT added.

[transfer none]


ipatch_dls2_sample_set_blank ()

void
ipatch_dls2_sample_set_blank (IpatchDLS2Sample *sample);

Set the sample data of a sample item to blank data.

Parameters

sample

Sample to set to blank sample data

 

ipatch_dls2_sample_info_new ()

IpatchDLS2SampleInfo *
ipatch_dls2_sample_info_new (void);

Allocates a new sample info structure.

Returns

New sample info structure, free it with ipatch_dls2_sample_info_free() when finished.

[transfer full]


ipatch_dls2_sample_info_free ()

void
ipatch_dls2_sample_info_free (IpatchDLS2SampleInfo *sample_info);

Free a sample info structure allocated with ipatch_dls2_sample_info_new().

Parameters

sample_info

Sample info structure

 

ipatch_dls2_sample_info_duplicate ()

IpatchDLS2SampleInfo *
ipatch_dls2_sample_info_duplicate (IpatchDLS2SampleInfo *sample_info);

Duplicate a sample info structure.

Parameters

sample_info

Sample info structure to duplicate

 

Returns

Newly allocated sample info structure which should be freed with ipatch_dls2_sample_info_free() when done with it.


ipatch_dls2_sample_info_init ()

void
ipatch_dls2_sample_info_init (IpatchDLS2SampleInfo *sample_info);

Initialize a sample info structure to defaults.

Parameters

sample_info

Sample info structure to initialize

 

ipatch_dls2_sample_info_install_class_properties ()

void
ipatch_dls2_sample_info_install_class_properties
                               (GObjectClass *obj_class);

Installs sample info properties for the given obj_class . Useful for objects that implement IpatchDLS2SampleInfo properties.

[skip]

Parameters

obj_class

GObjectClass to install properties for

 

ipatch_dls2_sample_info_is_property_id_valid ()

gboolean
ipatch_dls2_sample_info_is_property_id_valid
                               (guint property_id);

Check if a property ID is a valid sample info property ID.

[skip]

Parameters

property_id

Property ID to test

 

Returns

TRUE if property_id is a sample info property ID, FALSE otherwise.


ipatch_dls2_sample_info_set_property ()

gboolean
ipatch_dls2_sample_info_set_property (IpatchDLS2SampleInfo **sample_info,
                                      guint property_id,
                                      const GValue *value);

A function used by set_property methods that implement IpatchDLS2SampleInfo properties.

[skip]

Parameters

sample_info

Pointer to pointer to sample info

 

property_id

Property ID

 

value

Value for property

 

Returns

TRUE if property_id was handled, FALSE otherwise


ipatch_dls2_sample_info_get_property ()

gboolean
ipatch_dls2_sample_info_get_property (IpatchDLS2SampleInfo *sample_info,
                                      guint property_id,
                                      GValue *value);

A function used by get_property methods that implement IpatchDLS2SampleInfo properties.

[skip]

Parameters

sample_info

Pointer to sample info

 

property_id

Property ID

 

value

Value to set

 

Returns

TRUE if property_id was handled, FALSE otherwise


ipatch_dls2_sample_info_notify_changes ()

void
ipatch_dls2_sample_info_notify_changes
                               (IpatchItem *item,
                                IpatchDLS2SampleInfo *newinfo,
                                IpatchDLS2SampleInfo *oldinfo);

Sends IpatchItem property notifies for changed sample info parameters.

[skip]

Parameters

item

Item to send IpatchItem property notifies on

 

newinfo

New sample info values

 

oldinfo

Old sample info values

 

Types and Values

IPATCH_DLS2_SAMPLE_INFO_INIT

#define IPATCH_DLS2_SAMPLE_INFO_INIT  { 0, 60, 0, 0, 0, 0 }

IPATCH_DLS2_SAMPLE_INFO_FIRST_PROPERTY_ID

#define IPATCH_DLS2_SAMPLE_INFO_FIRST_PROPERTY_ID   256

IPATCH_DLS2_SAMPLE_INFO_PROPERTY_COUNT

#define IPATCH_DLS2_SAMPLE_INFO_PROPERTY_COUNT      7

enum IpatchDLS2SampleFlags

Members

IPATCH_DLS2_SAMPLE_NO_TRUNCATION

   

IPATCH_DLS2_SAMPLE_NO_COMPRESSION

   

IPATCH_DLS2_SAMPLE_LOOP_MASK

#define IPATCH_DLS2_SAMPLE_LOOP_MASK   0x03

IPATCH_DLS2_SAMPLE_FLAGS_MASK

#define IPATCH_DLS2_SAMPLE_FLAGS_MASK  0x0C0

Property Details

The “archive-location” property

  “archive-location”         char *

Location where subject is archived.

Owner: IpatchDLS2Sample

Flags: Read / Write

Default value: NULL


The “artist” property

  “artist”                   char *

Original artist.

Owner: IpatchDLS2Sample

Flags: Read / Write

Default value: NULL


The “comment” property

  “comment”                  char *

Comments.

Owner: IpatchDLS2Sample

Flags: Read / Write

Default value: NULL


The “commissioned” property

  “commissioned”             char *

Who commissioned the material.

Owner: IpatchDLS2Sample

Flags: Read / Write

Default value: NULL


The “copyright” property

  “copyright”                char *

Copyright.

Owner: IpatchDLS2Sample

Flags: Read / Write

Default value: NULL


The “date” property

  “date”                     char *

Creation date (YYYY-MM-DD).

Owner: IpatchDLS2Sample

Flags: Read / Write

Default value: NULL


The “engineer” property

  “engineer”                 char *

Engineers separated by "; ".

Owner: IpatchDLS2Sample

Flags: Read / Write

Default value: NULL


The “fine-tune” property

  “fine-tune”                int

Fine tuning in cents.

Owner: IpatchDLS2Sample

Flags: Read / Write

Allowed values: [-99,99]

Default value: 0


The “flags” property

  “flags”                    IpatchDLS2SampleFlags

Sample flags.

Owner: IpatchDLS2Sample

Flags: Read / Write


The “gain” property

  “gain”                     int

Gain in DLS relative gain units.

Owner: IpatchDLS2Sample

Flags: Read / Write

Default value: 0


The “genre” property

  “genre”                    char *

Genre.

Owner: IpatchDLS2Sample

Flags: Read / Write

Default value: NULL


The “keywords” property

  “keywords”                 char *

Keywords (separated by "; ").

Owner: IpatchDLS2Sample

Flags: Read / Write

Default value: NULL


The “loop-end” property

  “loop-end”                 guint

Loop end in frames (after loop).

Owner: IpatchDLS2Sample

Flags: Read / Write

Default value: 0


The “loop-start” property

  “loop-start”               guint

Start of loop in frames.

Owner: IpatchDLS2Sample

Flags: Read / Write

Default value: 0


The “loop-type” property

  “loop-type”                IpatchSampleLoopType

Loop method type.

Owner: IpatchDLS2Sample

Flags: Read / Write

Default value: IPATCH_SAMPLE_LOOP_NONE


The “medium” property

  “medium”                   char *

Original medium of the material (record, CD, etc).

Owner: IpatchDLS2Sample

Flags: Read / Write

Default value: NULL


The “name” property

  “name”                     char *

Name.

Owner: IpatchDLS2Sample

Flags: Read / Write

Default value: "untitled"


The “product” property

  “product”                  char *

Product intended for.

Owner: IpatchDLS2Sample

Flags: Read / Write

Default value: NULL


The “root-note” property

  “root-note”                int

Root MIDI note.

Owner: IpatchDLS2Sample

Flags: Read / Write

Allowed values: [0,127]

Default value: 60


The “sample-data” property

  “sample-data”              IpatchSampleData *

Sample data.

Owner: IpatchDLS2Sample

Flags: Read / Write


The “sample-rate” property

  “sample-rate”              int

Sampling rate in Hertz.

Owner: IpatchDLS2Sample

Flags: Read / Write

Allowed values: [100,192000]

Default value: 44100


The “software” property

  “software”                 char *

Editor software used.

Owner: IpatchDLS2Sample

Flags: Read / Write

Default value: NULL


The “source” property

  “source”                   char *

Source of the original material.

Owner: IpatchDLS2Sample

Flags: Read / Write

Default value: NULL


The “source-form” property

  “source-form”              char *

Original source that was digitized.

Owner: IpatchDLS2Sample

Flags: Read / Write

Default value: NULL


The “subject” property

  “subject”                  char *

Subject of the material.

Owner: IpatchDLS2Sample

Flags: Read / Write

Default value: NULL


The “technician” property

  “technician”               char *

Technician who sampled the material.

Owner: IpatchDLS2Sample

Flags: Read / Write

Default value: NULL

See Also

IpatchDLS, IpatchDLSRegion