Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

ch.laoe.clip
Class AClip  view AClip download AClip.java

java.lang.Object
  extended bych.laoe.clip.AObject
      extended bych.laoe.clip.AModel
          extended bych.laoe.clip.AContainerModel
              extended bych.laoe.clip.AClip

public class AClip
extends AContainerModel

This file is part of LAoE. LAoE is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. LAoE is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with LAoE; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA Class: AClip Autor: olivier gäumann, neuchâtel (switzerland) JDK: 1.3 Desctription: clip model. History: Date: Description: Autor: 04.08.00 erster Entwurf oli4 10.11.00 attach undostack to AClip oli4 19.12.00 float audio samples oli4 28.12.00 stream-based oli4 24.01.01 array-based again... oli4 02.03.02 channel mask introduced oli4


Field Summary
private  ch.laoe.audio.Audio audio
           
private  boolean bigEndian
           
private  java.lang.String comments
           
private static float DEFAULT_SAMPLE_RATE
           
private static int DEFAULT_SAMPLE_WIDTH
           
private  AClipHistory history
           
private static int nameCounter
           
private  float sampleRate
           
private  int sampleWidth
           
private  java.lang.String uniqueId
           
private static int uniqueIdIndex
          unique clip-ID: this ID is not used by the clip.
 
Fields inherited from class ch.laoe.clip.AContainerModel
selectedIndex
 
Fields inherited from class ch.laoe.clip.AModel
parent, plotter, selection
 
Fields inherited from class ch.laoe.clip.AObject
name
 
Constructor Summary
AClip()
          default constructor
AClip(AClip c)
          copy-constructor
AClip(java.io.File fileName)
          open file constructor
AClip(int layers, int channels)
          easy constructor
AClip(int layers, int channels, int samples)
          easy constructor
 
Method Summary
 void changeId()
          change the unique clip-ID, e.g.
 void copyAllAttributes(AClip c)
          copies all attributes except the samples
 ALayer createFlattenedLayer(ALayer layer)
          create a flattened layer, respecting layer superposing, layer types.
 void destroy()
          destroys the clip.
 ch.laoe.audio.Audio getAudio()
           
 AClipPlotter getClipPlotter()
          get view
 AClipSelection getClipSelection()
          get selection
 java.lang.String getComments()
          get the comment of this clip
 AClipHistory getHistory()
          get history
 java.lang.String getId()
          get the current channel-ID
 ALayer getLayer(int index)
           
 int getMaxNumberOfChannels()
           
 int getMaxSampleLength()
          return the biggest channel size of the whole clip
 float getMaxSampleValue()
          returns the biggest sample value (absolute value) of this clip
 float getMaxSampleValue(int offset, int length)
          returns the biggest sample value (absolute value) of this clip in the given x-range
 int getNumberOfLayers()
           
 float getSampleRate()
           
 int getSampleWidth()
           
 ALayer getSelectedLayer()
           
 boolean isBigEndian()
           
 void mergeAllLayers()
           
 void mergeDownLayer(int index)
           
 void setBigEndian(boolean b)
           
 void setComments(java.lang.String n)
          set the comment of this clip
 void setDefaultName()
          set the default name of the layer
 void setId(java.lang.String id)
          set any new channel-ID
 void setPlotType(int type)
           
 void setSampleRate(float s)
           
 void setSampleWidth(int sw)
           
 
Methods inherited from class ch.laoe.clip.AContainerModel
add, contains, get, getBottom, getMaxNumberOfSubElements, getNumberOfElements, getSelected, getSelectedIndex, getTop, insert, link, moveDown, moveUp, remove, removeAll, replace, setSelectedIndex
 
Methods inherited from class ch.laoe.clip.AModel
getCookies, getParent, getPlotter, getSelection, setParent
 
Methods inherited from class ch.laoe.clip.AObject
getName, setDefaultName, setName, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

audio

private ch.laoe.audio.Audio audio

uniqueIdIndex

private static int uniqueIdIndex
unique clip-ID: this ID is not used by the clip.


uniqueId

private java.lang.String uniqueId

history

private AClipHistory history

nameCounter

private static int nameCounter

comments

private java.lang.String comments

sampleRate

private float sampleRate

DEFAULT_SAMPLE_RATE

private static final float DEFAULT_SAMPLE_RATE
See Also:
Constant Field Values

sampleWidth

private int sampleWidth

DEFAULT_SAMPLE_WIDTH

private static final int DEFAULT_SAMPLE_WIDTH
See Also:
Constant Field Values

bigEndian

private boolean bigEndian
Constructor Detail

AClip

public AClip()
default constructor


AClip

public AClip(int layers,
             int channels)
easy constructor


AClip

public AClip(int layers,
             int channels,
             int samples)
easy constructor


AClip

public AClip(AClip c)
copy-constructor


AClip

public AClip(java.io.File fileName)
      throws ch.laoe.audio.AudioException
open file constructor

Method Detail

destroy

public void destroy()
destroys the clip.


copyAllAttributes

public void copyAllAttributes(AClip c)
copies all attributes except the samples


getAudio

public ch.laoe.audio.Audio getAudio()

changeId

public void changeId()
change the unique clip-ID, e.g. to give a new reference, when data have been changed (history-tracing... etc.).


getId

public java.lang.String getId()
get the current channel-ID


setId

public void setId(java.lang.String id)
set any new channel-ID


getHistory

public AClipHistory getHistory()
get history


getClipSelection

public AClipSelection getClipSelection()
get selection


getClipPlotter

public AClipPlotter getClipPlotter()
get view


setPlotType

public void setPlotType(int type)

setDefaultName

public void setDefaultName()
set the default name of the layer

Specified by:
setDefaultName in class AObject

getComments

public java.lang.String getComments()
get the comment of this clip


setComments

public void setComments(java.lang.String n)
set the comment of this clip


getLayer

public ALayer getLayer(int index)

mergeDownLayer

public void mergeDownLayer(int index)

mergeAllLayers

public void mergeAllLayers()

getSelectedLayer

public ALayer getSelectedLayer()

getNumberOfLayers

public int getNumberOfLayers()

getMaxNumberOfChannels

public int getMaxNumberOfChannels()

getMaxSampleLength

public int getMaxSampleLength()
return the biggest channel size of the whole clip


getMaxSampleValue

public float getMaxSampleValue()
returns the biggest sample value (absolute value) of this clip


getMaxSampleValue

public float getMaxSampleValue(int offset,
                               int length)
returns the biggest sample value (absolute value) of this clip in the given x-range


createFlattenedLayer

public ALayer createFlattenedLayer(ALayer layer)
create a flattened layer, respecting layer superposing, layer types. if the given layer has the required size, no new memory needs to be allocated. masking and audible is considered. a maximum of optimisations has been introduced here, to as fast as possible and memory-safe when possible.


getSampleRate

public float getSampleRate()

setSampleRate

public void setSampleRate(float s)

getSampleWidth

public int getSampleWidth()

setSampleWidth

public void setSampleWidth(int sw)

isBigEndian

public boolean isBigEndian()

setBigEndian

public void setBigEndian(boolean b)