Sample list

The sample list relates the sample IDs the test items use to the actual audio samples. The information about a sample contains at least the sample ID and the file name of the audio file. Depending on the type of sample, additional information may be also stored.

The list is currently a text file that contains the information needed to construct the java-objects used for playing samples. Here is an example of a sample list:


  # Samples file
  #
  pirr44.class=guinea.player.SoundSample
  pirr44.filename=samples/short/pirr44.aiff

  pirr32.class=guinea.player.SoundSample
  pirr32.filename=samples/short/pirr32.aiff

  pirr22.class=guinea.player.SoundSample
  pirr22.filename=samples/short/pirr22.aiff

  pirr16.class=guinea.player.SoundSample
  pirr16.filename=samples/short/pirr16.aiff

  pirr11.class=guinea.player.SoundSample
  pirr11.filename=samples/short/pirr11.aiff

  pirr8.class=guinea.player.SoundSample
  pirr8.filename=samples/short/pirr8.aiff

  mcll.class=guinea.player.SoundSample
  mcll.filename=samples/pink.aiff

Lets take a closer look at one sample's information:

  pirr44.class=guinea.player.SoundSample
  pirr44.filename=samples/short/pirr44.aiff

First in the start of every line is the sample ID. In this case it is pirr44. After the ID, there is a property name and its value if the form of 'name=value' or 'name: value'. For example, the line

  pirr44.filename=samples/short/pirr44.aiff

sets the property 'filename' of the sample pirr44 to value 'samples/short/pirr44.aiff'.

SoundSample sample class

The properties for sound samples are:

class=java class name (required): The java class name of the sample. For now only 'guinea.player.SoundSample' makes sense.
filename=file name of audio sample (required): The file name of the real audio file.
correctionVolume=correction (optional): A correction volume or calibration for sample's volume level. The correction is relative to the sample's normal level. It can be a level multiplier or it can be a dB level. Example: a value of '-6dB' is equivalent to about '0.5' multiplier.
name=sample ID (optional, should now be omitted): The sample ID of the sample, should be same as the ID in the beginning of line. This is now unnecessary as the sample ID is now automatically read from the initial part of the sample property. This should now be omitted. If used, it's value overrides the sample ID in the start of line.

Additional sample properties

Additional properties can be defined for each sample. They are freely selectable name=value properties for each sample. For example, to add some properties to samples in the example above:

  # ... other properties for sample 'pirr32' ...
  pirr32.property.filterType=lowpass
  pirr32.property.filterCutoff=32000

  # ... other properties for sample 'pirr22' ...
  pirr22.property.filterType=lowpass
  pirr22.property.filterCutoff=22050

The additional properties are specified with 'property' at the start followed by the a sample property name (in the one above: filterType and filterCutoff). Any number of properties can be used. The property values are strings.

The values of the sample parameters are readable from the sample object with the getProperty() method (See API doc for guinea.player.Sample class).

Changes in sample list format

Some changes in the samples-file's format:

Starting from GuineaPig 2.1, the sample's parameter name should not be used anymore. The sample ID is automatically got from the beginning of property name. It was required up to GuineaPig 2.05.
Starting from GuineaPig 2.1, sample properties can be added.

· Directory Structure · Document index ·

Last modified: Sat Jan 1 17:17:52 EET 2000