*  DocumentFrame.java

*  Eisenkraut

*

*  Copyright (c) 2004-2014 Hanns Holger Rutz. All rights reserved.

*

*  This software is published under the GNU General Public License v3+

*

*

*  For further information, please contact Hanns Holger Rutz at

*  contact@sciss.de

*

*

*  Changelog:

*      25-Jan-05  created from de.sciss.meloncillo.timeline.TimelineFrame

*    22-Mar-05  fixed but in vertical zoom

*    15-Jul-05  lot's of. removed some exclusive locks (fixes overview update in catch mode)

*          ; overview loading loads one more sample frame, so display

*          is in coherence with timeline selection and TimelineAxis

*    02-Aug-05  renamed to DocumentFrame ; conforms to new document handler

*    23-Sep-05  correctly disposes overview display images ; abandons backing store

*          image approach in TimelineViewport (seems to fix memory leak)

*/

*  @author    Hanns Holger Rutz

*  @version  0.70, 28-Jun-08

*/

       ClipboardOwner, ToolActionListener,

       DecimatedWaveTrail.AsyncListener,

       TransportListener, PreferenceChangeListener,

       SwingConstants

  protected final Session          doc;

 

    private final TimelineAxis        timeAxis;

    protected final MarkerAxis        markAxis;

    protected final TrackRowHeader      markAxisHeader;

  protected final TimelineScroll      scroll;

  protected final Transport        transport;

 

  protected Span              timelineSel;

  protected Span              timelineVis;

  protected long              timelinePos;

  protected long              timelineLen;

  protected double            timelineRate;

  private final JPanel          ggTrackPanel;

  protected final WaveformView      waveView;

  protected final ComponentHost      wavePanel;

  private final JPanel          waveHeaderPanel;

  protected final JPanel          channelHeaderPanel;

  private final JPanel          flagsPanel;

  private final JPanel          rulersPanel;

  private final JPanel          metersPanel;

  private final List            collChannelHeaders    = new ArrayList();

  protected final List          collChannelRulers    = new ArrayList();

  private PeakMeter[]            channelMeters      = new PeakMeter[ 0 ];

 

  private final JLabel          lbSRC;

  protected final TreeExpanderButton    ggTreeExp;

 

  private DecimatedTrail          asyncTrail        = null;

  // --- tools ---

 

  private final   Map            tools          = new HashMap();

  private      AbstractTool      activeTool        = null;

  private final  TimelinePointerTool    pointerTool;

  // --- actions ---

  private final static String        plugInPackage      = "de.sciss.eisenkraut.render.";

  private final static String        fscapePackage      = "de.sciss.fscape.render.";

  private final ActionRevealFile      actionRevealFile;

  private final ActionNewFromSel      actionNewFromSel;

  protected final ActionClose        actionClose;

  protected final ActionSave        actionSave;

  protected final ActionSaveAs      actionSaveAs;

  private final ActionSaveAs        actionSaveCopyAs;

  private final ActionSaveAs        actionSaveSelectionAs;

  private final ActionSelectAll      actionSelectAll;

  private final MenuAction        actionProcess, actionFadeIn, actionFadeOut, actionGain,

                      actionInvert, // actionMix,

                      actionReverse, actionRotateChannels, // actionSilence,

                      actionFScNeedlehole,

                      actionDebugDump, actionDebugVerify, actionInsertRec;

  protected final ActionProcessAgain    actionProcessAgain;

  private final ActionSpanWidth      actionIncHoriz, actionDecHoriz;

  protected final ActionScroll      actionZoomAllOut;

  private final AbstractAction      actionIncVertMax, actionDecVertMax;

  private final AbstractAction      actionIncVertMin, actionDecVertMin;

  private final AbstractWindow.Adapter  winListener;

  private final JLabel          lbWriteProtected;

  private boolean              writeProtected      = false;

  protected boolean            wpHaveWarned      = false;

 

  private final ShowWindowAction      actionShowWindow;

   

  private static final String smpPtrn      = "ch.{3} @ {0,number,0}";

  private static final String timePtrn    = "ch.{3} @ {1,number,integer}:{2,number,00.000}";

  protected final MessageFormat msgCsr1    = new MessageFormat( timePtrn, Locale.US );

  protected final MessageFormat msgCsr2PCMFloat = new MessageFormat( "{4,number,0.000} ({5,number,0.00} dBFS)", Locale.US );

  protected final MessageFormat msgCsr3PCMInt  = new MessageFormat( "= {6,number,0} @ {7,number,integer}-bit int", Locale.US );

  protected final MessageFormat msgCsr2Peak  = new MessageFormat( "peak {4,number,0.000} ({5,number,0.00} dBFS)", Locale.US );

  protected final MessageFormat msgCsr3RMS  = new MessageFormat( "eff {6,number,0.000} ({7,number,0.00} dBFS)", Locale.US );

  protected int          csrInfoBits;

  protected boolean        csrInfoIsInt;

  protected static final double TWENTYDIVLOG10 = 20 / Math.log( 10 );

  private final Color colrClear        = new Color( 0xA0, 0xA0, 0xA0, 0x00 );

 

  // --------- former viewport ---------

  // --- painting ---

  private final Color colrSelection      = GraphicsUtil.colrSelection;

  private final Color colrSelection2      = new Color( 0x00, 0x00, 0x00, 0x20 );  // selected timeline span over unselected trns

  protected final Color colrPosition      = new Color( 0xFF, 0x00, 0x00, 0x7F );

  protected final Color colrZoom        = new Color( 0xA0, 0xA0, 0xA0, 0x7F );

  protected Rectangle  vpRecentRect      = new Rectangle();

  protected int    vpPosition        = -1;

  private Rectangle   vpPositionRect      = new Rectangle();

  protected final ArrayList vpSelections    = new ArrayList();

  protected final ArrayList vpSelectionColors  = new ArrayList();

  protected Rectangle  vpSelectionRect      = new Rectangle();

 

  private Rectangle   vpUpdateRect      = new Rectangle();

  protected Rectangle  vpZoomRect        = null;

  private float[]    vpDash          = { 3.0f, 5.0f };

  private float    vpScale;

  protected final Stroke[] vpZoomStroke      = {

    new BasicStroke( 2f, BasicStroke.CAP_ROUND, BasicStroke.JOIN_MITER, 1.0f, vpDash, 0.0f ),

    new BasicStroke( 2f, BasicStroke.CAP_ROUND, BasicStroke.JOIN_MITER, 1.0f, vpDash, 4.0f ),

    new BasicStroke( 2f, BasicStroke.CAP_ROUND, BasicStroke.JOIN_MITER, 1.0f, vpDash, 6.0f ),

  };

  protected int    vpZoomStrokeIdx      = 0;

  protected boolean  waveExpanded      = true;  // XXX should keep that in some prefs

  protected boolean  viewMarkers;

  protected boolean  markVisible;

  private boolean    chanMeters        = false;

  private boolean    forceMeters        = false;

 

  protected final TimelineToolBar      timeTB;

  private final TransportToolBar      transTB;

  // --- progress bar ---

 

  private final JLabel /* JTextField */ ggAudioFileDescr;

  private final ProgressPanel        pProgress;

  private final CrossfadePanel      pOverlay;

  private final boolean          internalFrames;

  protected final BasicApplication    app;

  private final SuperColliderClient    superCollider;

  private final PeakMeterManager      lmm;

  protected boolean            disposed    = false;