non/Timeline/Sequence_Widget.H

/*******************************************************************************/
/* Copyright (C) 2008 Jonathan Moore Liles                                     */
/*                                                                             */
/* This program 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.                                                  */
/*                                                                             */
/* This program 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 This program; see the file COPYING.  If not,write to the Free Software */
/* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  */
/*******************************************************************************/

#pragma once

#include "Sequence.H"
#include "Loggable.H"
#include "Timeline.H"
#include <list>
#include <algorithm>
using namespace std;

class Sequence_Widget;

struct Drag
{
    /* mouse coords at offset of drag */
    int x;
    int y;
    int state;

    nframes_t start;

    Drag( int X, int Y, nframes_t start=0 ) : x( X ), y( Y ), start( start ) { state = 0; }
};

/* most common position description. /offset/ is only used by Regions,
but it's more convenient to have it here  */
struct Range
{
    nframes_t start;                       /* where on the timeline */
    nframes_t offset;                      /* first sample from clip */
    nframes_t length;                      /* total number of samples */

    void
    trim_left ( long n )
        {
            start -= n;
            offset -= n;
            length += n;
        }

    void
    trim_right ( long n )
        {
            length += n;
        }

    Range ( ) : start( 0 ), offset( 0 ), length( 0 )
        {
        }
};

/* Used by time/tempo points or any other child of Sequence_Widget
 which must be locked to a point in musical time rather than wallclock
 time. Bar and beat start at 1. */
struct BBT
{
    unsigned short bar;
    unsigned char beat;
    unsigned short tick;

    BBT ( ) : bar( 0 ), beat( 0 ), tick( 0 )
        {
        }
};


/* FIXME: wrong place for this */
struct position_info
{
    nframes_t frame;

    float tempo;
    int beats_per_bar;
    int beat_type;

    BBT bbt;
};


/* Base class for virtual widget on a track */
class Sequence_Widget : public Loggable
{

    static list <Sequence_Widget *> _selection;                    /* all the widgets making up the selection */

    /* FIXME: is this not the same as /pushed/? */
    static Sequence_Widget * _current;                             /* the widget initiating events that affect the selection */

    /* these are actually managed in the Sequence classes */
    static Sequence_Widget * _pushed;                              /* the widget receiving drag events (a copy) */
    static Sequence_Widget * _original;                            /* the original of the /pushed/ widget */
    static Sequence_Widget * _belowmouse;                          /* the widget below the mouse cursor */


    static Fl_Color _selection_color;


protected:

    Sequence *_sequence;                                              /* track this region belongs to */

    Range _range;                                               /* range for playback */
    Range *_r;                                                  /* range for editing / display (points to the same thing as above, except for when dragging etc) */

    Fl_Color _color;                                            /* color of waveform */
    Fl_Color _box_color;                                        /* color of background (box) */

    Drag *_drag;

    virtual void get ( Log_Entry &e ) const;
    virtual void set ( Log_Entry &e );

    /* careful with this, it doesn't journal */
    Sequence_Widget ( const Sequence_Widget &rhs ) : Loggable( rhs )
        {
            _drag = NULL;

            _sequence = rhs._sequence;

            _range = rhs._range;
            _r = &_range;

            _color = rhs._color;
            _box_color = rhs._box_color;
        };

public:

    Sequence_Widget ( )
        {
            _sequence = NULL;

            _r = &_range;

            _r->start = _r->offset = _r->length = 0;

            _drag = NULL;

            _box_color = FL_BACKGROUND_COLOR;
            _color     = FL_FOREGROUND_COLOR;
        }

    virtual ~Sequence_Widget ( )
        {
            redraw();

            _sequence->remove( this );

            _selection.remove( this );
        }

    const Sequence_Widget &
    operator= ( const Sequence_Widget &rhs )
        {
            if ( this == &rhs )
                return *this;

            _r         = &_range;
            _range     = rhs._range;
            _sequence     = rhs._sequence;
            _box_color = rhs._box_color;
            _color     = rhs._color;

            return *this;
        }


/*     Sequence_Widget ( const Sequence_Widget &rhs ) */
/*         { */
/*             *this = rhs; */
/*         } */

#define SEQUENCE_WIDGET_CLONE_FUNC(class)                               \
    virtual Sequence_Widget *clone ( void ) const                       \
        {                                                               \
            return new class ( *this );                                 \
        }                                                               \
                                                                        \
//    virtual Sequence_Widget *clone ( const Sequence_Widget *r ) = 0;
    virtual Sequence_Widget *clone ( void ) const = 0;

    bool selected ( void ) const
        {
            return ::find( _selection.begin(), _selection.end(), this ) != _selection.end();
        }

    void select ( void )
        {
            if ( selected() )
                return;

            _selection.push_back( this );
            _selection.sort( sort_func );

            redraw();
        }

    void deselect ( void )
        {
            _selection.remove( this );
            redraw();
        }


    static void
    delete_selected ( void )
        {
            while ( _selection.size() )
                delete _selection.front();
        }

    static void
    select_none ( void )
        {
            while ( _selection.size() )
            {
                _selection.front()->redraw();
                _selection.pop_front();
            }
        }

    static Sequence_Widget *current    ( void ) { return Sequence_Widget::_current; }

    static Sequence_Widget *pushed     ( void ) { return Sequence_Widget::_pushed; }
    static Sequence_Widget *belowmouse ( void ) { return Sequence_Widget::_belowmouse; }

    static void pushed     ( Sequence_Widget *w ) { Sequence_Widget::_pushed     = w; }
    static void belowmouse ( Sequence_Widget *w ) { Sequence_Widget::_belowmouse = w; }

//    static void pushed ( Sequence_Widget *w ) { Sequence_Widget::_pushed = w; }

    void begin_drag ( const Drag &d )
        {
            _drag = new Drag( d );
            _r = new Range( _range );
        }

    void length_drag ( void )
        {
            _range = *_r;
            delete _r;
            _r = &_range;

            delete _drag;
            _drag = NULL;
        }

/*     void */
/*     start ( nframes_t where ) */
/*         { */

/*             if  ( ! selected() ) */
/*             { */
/*                 redraw(); */
/*                 _r->start = where; */
/*             } */
/*             else */
/*             { */
/*                 long d = where - _r->start; */

/*                 for ( list <Sequence_Widget *>::iterator i = _selection.begin(); i != _selection.end(); i++ ) */
/*                 { */
/*                     (*i)->redraw(); */

/*                     if ( d < 0 ) */
/*                         (*i)->_r->start -= 0 - d; */
/*                     else */
/*                         (*i)->_r->start += d; */

/*                 } */
/*             } */
/*         } */


    int dispatch ( int m );

    Fl_Widget * parent ( void ) const { return _sequence; }

    int scroll_x ( void ) const { return timeline->ts_to_x( timeline->xoffset ); }
    nframes_t scroll_ts ( void ) const { return timeline->xoffset; }

    virtual int y ( void ) const { return _sequence->y(); }
    virtual int h ( void ) const { return _sequence->h(); }

    /* used by regions */
    virtual int x ( void ) const
        {
            return  _r->start < timeline->xoffset ? _sequence->x() : min( _sequence->x() + _sequence->w(), _sequence->x() + timeline->ts_to_x( _r->start - timeline->xoffset ) );
        }

    /* use this as x() when you need to draw lines between widgets */
    int line_x ( void ) const
        {
            return _r->start < timeline->xoffset ? max( -32768, _sequence->x() -  timeline->ts_to_x( timeline->xoffset - _r->start )) : min( 32767, _sequence->x() + timeline->ts_to_x( _r->start - timeline->xoffset ) );
        }

    virtual int w ( void ) const
        {
            int tx = timeline->ts_to_x( _r->start );

            int rw;
            if ( tx < scroll_x() )
                rw = abs_w() - (scroll_x() - tx);
            else
                rw = abs_w();

            return min( rw, _sequence->w() );
        }

    int abs_x ( void ) const { return timeline->ts_to_x( _r->start ); }
    virtual int abs_w ( void ) const { return timeline->ts_to_x( _r->length ); }

    Fl_Color color ( void ) const { return _color; }
    void color ( Fl_Color v ) { _color = v; }
    Fl_Color box_color ( void ) const { return _box_color; }
    virtual Fl_Color selection_color ( void ) const { return _selection_color; }
    virtual void selection_color ( Fl_Color v ) { _selection_color = v; }

    Sequence * sequence ( void ) const { return _sequence; }
    void sequence ( Sequence *t ) { _sequence = t; }

    nframes_t start ( void ) const { return _r->start; }
    void start ( nframes_t o ) { _r->start = o; }

    void length ( nframes_t v ) { _r->length = v; }
    virtual nframes_t length ( void ) const { return _r->length; }
    void offset ( nframes_t v ) { _r->offset = v; }
    nframes_t offset ( void ) const { return _r->offset; }

    /** convert a screen x coord into an start into the region */
    nframes_t x_to_offset ( int X )
        {
            return timeline->x_to_ts( scroll_x() + ( X - _sequence->x() ) ) - _r->start;
        }

    int active_r ( void ) const { return _sequence->active_r(); }

    virtual Fl_Boxtype box ( void ) const { return FL_UP_BOX; }
    virtual Fl_Align align ( void ) const { return (Fl_Align)0; }

    virtual void
    redraw ( void )
        {
            if ( ! (align() & FL_ALIGN_INSIDE) )
            {
                // FIXME: to better..
                _sequence->redraw();
            }
            else
                _sequence->damage( FL_DAMAGE_EXPOSE, x(), y(), w(), h() );
        }

    /* just draw a simple box */
    virtual void
    draw_box ( void )
        {
            fl_draw_box( box(), x(), y(), w(), h(), selected() ? FL_MAGENTA : _box_color );
        }

    virtual void
    draw ( void )
        {
            draw_box();
        }

    bool
    operator< ( const Sequence_Widget & rhs )
        {
            return _r->start < rhs._r->start;
        }

    bool
    operator<=( const Sequence_Widget & rhs )
        {
            return _r->start <= rhs._r->start;
        }

    virtual void draw_label ( const char *label, Fl_Align align, Fl_Color color=(Fl_Color)0 );
    virtual int handle ( int m );

    static bool
    sort_func ( Sequence_Widget *lhs, Sequence_Widget *rhs )
        {
            return *lhs < *rhs;
        }

};