*  TimelineFrame.java

*  Meloncillo

*

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

*

*  This software 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, june 1991 of the License, or (at your option) any later version.

*

*  This software 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 (gpl.txt) along with this software; if not, write to the Free Software

*  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

*

*

*  For further information, please contact Hanns Holger Rutz at

*  contact@sciss.de

*

*

*  Changelog:

*    01-Aug-04   moved trns.listener registration from dyn.list to constructor

*    12-Aug-04   commented. some clean ups.

*      24-Dec-04   support for intruding-grow-box prefs

*    26-Mar-05  uses separate tools and tool bar; new keyboard shortcuts

*/

*  TO-DOs : remove all the 'root' variables and redesign window

*  registration and access

*/

*  One of the core GUI elements: The

*  horizontal timeline display with all

*  the transmitter trajectory tracks.

*  <p>

*  The frame contains a scroll pane with

*  instances of the transmitter's default

*  <code>TransmitterEditor</code>s.

*  left row header contains <code>TransmitterRowHeader</code>

*  objects, mainly labels for the transmitter's names, but

*  also means of selecting or deselecting transmitters.

*  The scroll pane's column header

*  (an element which never gets scrolled) is a <code>TimelineAxis</code>,

*  a ruler for displaying the timeline indices and allowing to position

*  and select the timeline.

*  <p>

*  Global keyboard commands (Ctrl+Cursor-Keys) are registered

*  to zoom into the selected tracks (vertically) or into the

*  timeline (horizontally), amongst others.

*  <p>

*  A special inner class view port object is installed in the scroll bar

*  to allow fast graphics display when the transport is running. In this

*  case the timeline frame installs a realtime consumer and listens to

*  the transport notification ticks. Because the timeline position hairline

*  has to be painted over all tracks, this is done in the view port's

*  <code>paintChildren</code> method. This requires the view port to be

*  set to <code>BACKINGSTORE_SCROLL_MODE</code> so the children's views

*  are recalled from a backing store image -- repainting the vector editors

*  all the time is much too slow. Unfortunately this produces some graphics

*  artefacts if the vertical scrollbar is smoothly dragged.

*  <p><pre>

*  keyb.shortcuts: 

*  </pre>

*

*  @author    Hanns Holger Rutz

*  @version  0.75, 19-Jun-08

*

*  @see  de.sciss.meloncillo.transmitter.TransmitterRowHeader

*  @see  de.sciss.meloncillo.transmitter.TransmitterEditor

*  @see  de.sciss.meloncillo.timeline.TimelineAxis

*  @see  de.sciss.meloncillo.timeline.TimelineScroll

*  @see  javax.swing.JViewport#setScrollMode( int )

*

*  @todo  the VM 1.4.2_05 introduces a new bug which causes

*      the timeline display in RT playback to flicker and besides

*      makes the whole graphics update really slow. We should think

*      about creating our own backing store image.

*  @todo  when resizing the window while transport is playing there's

*      a null pointer exception in the paintDirty method since the

*      backing store image seems to have been invalidated

*  @todo  deal with the viewport graphics artefacts.

*  @todo  Paste + Clear : use blending

*  @todo  pointer tool : ctrl+drag doesn't work.

*/

      DecimatedWaveTrail.AsyncListener,

      TransportListener, PreferenceChangeListener,

      DynamicListening, ClipboardOwner

  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 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 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 ActionVerticalZoom    actionIncVertMin, actionDecVertMin;

//  private final AbstractWindow.Adapter  winListener;

  private final JLabel          lbWriteProtected;

  protected boolean            wpHaveWarned      = false;

 

   

  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 );

 

  // --------- 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    forceMeters        = false;

 

  protected final TimelineToolBar      timeTB;

  // --- progress bar ---

 

//  private final JTextField        ggAudioFileDescr;

//  private final ProgressPanel        pProgress;

//  private final CrossfadePanel      pOverlay;

//  private final boolean          internalFrames;

  protected final BasicApplication    app;

//  private final PeakMeterManager      lmm;

  protected boolean            disposed    = false;

 

  private final Timer            playTimer;

  private double              playRate    = 1.0;

 

  protected final ComponentBoundsRestrictor cbr;

 

//  private static final String        KEY_TRACKSIZE  = "tracksize";

 

  private int                verticalScale;

 

  protected static final Cursor[]      zoomCsr;

 

  static {

    final Toolkit tk    = Toolkit.getDefaultToolkit();

    final Point   hotSpot  = new Point( 6, 6 );

    zoomCsr          = new Cursor[] {

      tk.createCustomCursor( tk.createImage(

          ToolAction.class.getResource( "zoomin.png" )), hotSpot, "zoom-in" ),

      tk.createCustomCursor( tk.createImage(

        ToolAction.class.getResource( "zoomout.png" )), hotSpot, "zoom-out" )

    };

  }

  /**

   *  Constructs a new timeline window with

   *  all the sub elements. Installs the

   *  global key commands. (a TimelineFrame

   *  should be created only once in the application).

   *

   *  @param  doc    session document

   */

  public TimelineFrame( final Session doc )

  {

    super( doc );

    app          = (BasicApplication) AbstractApplication.getApplication();

    setTitle( app.getResourceString( "frameTimeline" ));

   

    this.doc      = doc;

    transport      = doc.getTransport();

    timelinePos      = doc.timeline.getPosition();

    timelineSel      = doc.timeline.getSelectionSpan();

    timelineVis      = doc.timeline.getVisibleSpan();

    timelineRate    = doc.timeline.getRate();

    timelineLen      = doc.timeline.getLength();

   

//

//    lmm          = new PeakMeterManager( superCollider.getMeterManager() );

    final Container          cp      = getContentPane();

    final InputMap          imap    = getInputMap( JComponent.WHEN_IN_FOCUSED_WINDOW );

    final ActionMap          amap    = getActionMap();

    final int            myMeta    = BasicMenuFactory.MENU_SHORTCUT == InputEvent.CTRL_MASK ?

      InputEvent.CTRL_MASK | InputEvent.SHIFT_MASK : BasicMenuFactory.MENU_SHORTCUT;  // META on Mac, CTRL+SHIFT on PC

    final TopPainter        trackPainter;

    final MenuRoot          mr;

    final JPanel          topPane    = GUIUtil.createGradientPanel();

    final Trail.Listener      waveTrailListener;

    Box                box;

    timeTB    = new TimelineToolBar( doc );

    wavePanel      = new ComponentHost();

        timeAxis      = new TimelineAxis( doc, wavePanel );

    markAxis      = new MarkerAxis( doc, wavePanel );

    viewMarkers      = app.getUserPrefs().getBoolean( PrefsUtil.KEY_VIEWMARKERS, false );

    markVisible      = viewMarkers && waveExpanded;

    markAxisHeader    = new TrackRowHeader( doc.markerTrack, doc.getTracks(), doc.getMutableSelectedTracks(), doc.getUndoManager() );

    markAxisHeader.setPreferredSize( new Dimension( 63, markAxis.getPreferredSize().height ));  // XXX

    markAxisHeader.setMaximumSize( new Dimension( 128, markAxis.getMaximumSize().height ));    // XXX

    if( markVisible ) {

      markAxis.startListening();

    } else {

      markAxis.setVisible( false );

      markAxisHeader.setVisible( false );

    }

    flagsPanel      = new JPanel( new StretchedGridLayout( 0, 1, 1, 1 ));

    rulersPanel      = new JPanel( new StretchedGridLayout( 0, 1, 1, 1 ));

    waveHeaderPanel    = new JPanel( new BorderLayout() );

    channelHeaderPanel  = new JPanel();

    channelHeaderPanel.setLayout( new BoxLayout( channelHeaderPanel, BoxLayout.X_AXIS ));

gp.setBottomBorder( true );

gp.setLayout( null );

gp.setPreferredSize( new Dimension( 0, timeAxis.getPreferredSize().height ));

bbb.add( gp );

bbb.add( markAxisHeader );

    waveHeaderPanel.add( bbb, BorderLayout.NORTH );

    channelHeaderPanel.add( flagsPanel );

    channelHeaderPanel.add( rulersPanel );

    waveHeaderPanel.add( channelHeaderPanel, BorderLayout.CENTER );

    waveView      = new WaveformView( doc, wavePanel );

    wavePanel.setLayout( new BoxLayout( wavePanel, BoxLayout.Y_AXIS ));

    wavePanel.add( timeAxis );

    wavePanel.add( markAxis );

    wavePanel.add( waveView );

        scroll        = new TimelineScroll( doc );

    ggTrackPanel    = new JPanel( new BorderLayout() );

    ggTrackPanel.add( wavePanel, BorderLayout.CENTER );

    ggTrackPanel.add( waveHeaderPanel, BorderLayout.WEST );

    ggTrackPanel.add( scroll, BorderLayout.SOUTH );

    lbWriteProtected  = new JLabel();

//    ggAudioInfo      = new ModificationButton( ModificationButton.SHAPE_INFO );

//    ggAudioInfo.setAction( new ActionAudioInfo() );

//    ggRevealFile    = new ModificationButton( ModificationButton.SHAPE_REVEAL );

//    actionRevealFile  = new ActionRevealFile();

//    ggRevealFile.setAction( actionRevealFile );

//    ggAudioFileDescr  = new JTextField( 32 );

//    ggAudioFileDescr.setEditable( false );

//    ggAudioFileDescr.setFocusable( false );

//    ggAudioFileDescr.setBackground( null );

//    ggAudioFileDescr.setBorder( null );

//    lbSRC        = new JLabel( getResourceString( "buttonSRC" ));

//    lbSRC.setForeground( colrClear );

    box          = Box.createHorizontalBox();

    box.add( Box.createHorizontalStrut( 4 ));

    box.add( lbWriteProtected );

//    box.add( ggAudioInfo );

//    box.add( ggRevealFile );

//    box.add( Box.createHorizontalStrut( 4 ));

//

//    pProgress      = new ProgressPanel();

//    pOverlay      = new CrossfadePanel();

//    pOverlay.setComponentA( ggAudioFileDescr );

//    pOverlay.setComponentB( pProgress );

//    box.add( pOverlay );

//   

//    box.add( Box.createHorizontalStrut( 4 ));

//    box.add( lbSRC );

    box.add( CoverGrowBox.create( 2, 0 ));

//    updateAFDGadget();

//    updateCursorFormat();

//

// ----- afr export -----

//    final JButton ggExportAFR = new JButton( getResourceString( "buttonDragRegion" ), new ImageIcon( getClass().getResource( "dragicon.png" )));

//    ggExportAFR.setTransferHandler( new AFRTransferHandler() );

//    final MouseInputAdapter expAFRmia = new MouseInputAdapter() {

//      private MouseEvent dndInit = null;

//      private boolean dndStarted = false;

//

//      public void mousePressed( MouseEvent e )

//      {

//        dndInit    = e;

//        dndStarted  = false;

//      }

//     

//      public void mouseReleased( MouseEvent e )

//      {

//        dndInit    = null;

//        dndStarted  = false;

//      }

//     

//      public void mouseDragged( MouseEvent e )

//      {

//        if( !dndStarted && (dndInit != null) &&

//          ((Math.abs( e.getX() - dndInit.getX() ) > 5) ||

//           (Math.abs( e.getY() - dndInit.getY() ) > 5))) {

//     

//          JComponent c = (JComponent) e.getSource();

//          c.getTransferHandler().exportAsDrag( c, e, TransferHandler.COPY );

//          dndStarted = true;

//        }

//      }

//    };

//   

//    ggExportAFR.addMouseListener( expAFRmia );

//    ggExportAFR.addMouseMotionListener( expAFRmia );

//

//    timeTB.add( Box.createHorizontalStrut( 4 ));

//    timeTB.addButton( ggExportAFR );

// ----------

   

    topPane.setBorder( BorderFactory.createEmptyBorder( 2, 2, 2, 2 ));

    timeTB.setOpaque( false );

    topPane.add( timeTB );

//    topPane.add( transTB );

    topPane.add( Box.createHorizontalGlue() );

    cbr      = new ComponentBoundsRestrictor();

    ggTreeExp  = new TreeExpanderButton();

    ggTreeExp.setExpandedToolTip( getResourceString( "buttonExpWaveTT" ));

    ggTreeExp.setCollapsedToolTip( getResourceString( "buttonCollWaveTT" ));

    ggTreeExp.setExpanded( true );

    ggTreeExp.addActionListener( new ActionListener() {

      public void actionPerformed( ActionEvent e )

      {

        final Dimension d  = getSize();

       

        waveExpanded  = ggTreeExp.isExpanded();

        markVisible    = viewMarkers && waveExpanded;

       

        if( waveExpanded ) {

          cbr.remove( getWindow() );

          waveView.setVisible( true );

          channelHeaderPanel.setVisible( true );

          if( viewMarkers ) {

            markAxis.setVisible( true );

            markAxisHeader.setVisible( true );

          }

          scroll.setVisible( true );

          timeTB.setVisible( true );

          pack();

        } else {

          checkDecimatedTrails();

          setPreferredSize( getSize() );

          waveView.setVisible( false );

          channelHeaderPanel.setVisible( false );

          markAxis.setVisible( false );

          markAxisHeader.setVisible( false );

          scroll.setVisible( false );

          timeTB.setVisible( false );

          actionZoomAllOut.perform();

          final int h = d.height - (waveView.getHeight() + scroll.getHeight() +

             (viewMarkers ? markAxis.getHeight() : 0));

          setSize( new Dimension( d.width - timeTB.getWidth(), h ));

          cbr.setMinimumHeight( h );

          cbr.setMaximumHeight( h );

          cbr.add( getWindow() );

        }

      }

    });

    topPane.add( ggTreeExp );

   

    gp.setGradientShift( 0, topPane.getPreferredSize().height );

   

    cp.add( topPane, BorderLayout.NORTH );

    cp.add( ggTrackPanel, BorderLayout.CENTER );

    cp.add( box, BorderLayout.SOUTH );

   

    // --- Tools ---

   

    pointerTool = new TimelinePointerTool();

    tools.put( new Integer( ToolAction.POINTER ), pointerTool );

    tools.put( new Integer( ToolAction.ZOOM ), new TimelineZoomTool() );

    // ---- TopPainter ----

    trackPainter  = new TopPainter() {

      public void paintOnTop( Graphics2D g2 )

      {

        Rectangle r;

        r = new Rectangle( 0, 0, wavePanel.getWidth(), wavePanel.getHeight() ); // getViewRect();

        if( !vpRecentRect.equals( r )) {

          recalcTransforms( r );

        }

        for( int i = 0; i < vpSelections.size(); i++ ) {

          r = (Rectangle) vpSelections.get( i );