non/Timeline/Timeline.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


/* FIXME: this class needs a lot of cleaning up. Too many public
 * members etc. */

/* #include "Audio_File.H" // just for nframes_t */

#include "types.h"

#include <math.h>
#include <assert.h>
#include <list>

class Fl_Scroll;
class Fl_Pack;
class Fl_Scrollbar;
class Fl_Widget;

class Fl_Menu_Button;

class Timeline;
extern Timeline *timeline;

struct BBT;
class Tempo_Sequence;
class Time_Sequence;
class Annotation_Sequence;
class Track;
class Scalebar;
class Sequence;
class Sequence_Widget;

// disables double-buffering to make unnecessary redrawing more apparent
// #define DEBUG_TIMELINE_DRAWING

#ifndef DEBUG_TIMELINE_DRAWING

#include <Fl/Fl_Overlay_Window.H>

#else

#include <FL/Fl_Single_Window.H>
#define Fl_Overlay_Window Fl_Single_Window
#define redraw_overlay()
#endif

struct position_info;

struct Rectangle
{
    int x;
    int y;
    int w;
    int h;

    Rectangle ( ) : x( 0 ), y( 0 ), w( 0 ), h( 0 ) {}
    Rectangle ( int X, int Y, int W, int H ) : x( X ), y( Y ), w( W ), h( H ) {}
};

#include "RWLock.H"

class Timeline : public Fl_Overlay_Window, public RWLock
{
    static void draw_clip ( void * v, int X, int Y, int W, int H );

    int _old_xposition;
    int _old_yposition;

    Rectangle _selection;

    Fl_Scroll    *scroll;
    Fl_Pack      *tracks;
    Fl_Pack      *rulers;
    Scalebar     *hscroll;
    Fl_Scrollbar *vscroll;

    void adjust_vscroll ( void );
    static void cb_scroll ( Fl_Widget *w, void *v );
    void cb_scroll ( Fl_Widget *w );
    static void menu_cb ( Fl_Widget *w, void *v );
    void menu_cb ( Fl_Widget *w );

    int _fpp;                                                 /* frames per pixel, power of two */
    nframes_t _length;


    nframes_t p1, p2;                                           /* cursors */

    /* not permitted */
    Timeline ( const Timeline &rhs );
    Timeline & operator = ( const Timeline &rhs );

    std::list <const Sequence_Widget*> _tempomap;

public:

    enum snap_e {
        Bars,
        Beats,
        None
    };

    static bool draw_with_measure_lines;
    static snap_e snap_to;
    static bool snap_magnetic;
    static bool follow_playhead;
    static bool center_playhead;

    Tempo_Sequence *tempo_track;
    Time_Sequence  *time_track;
    Annotation_Sequence *ruler_track;

    Fl_Menu_Button *menu;

    nframes_t xoffset;

    int _yposition;

    nframes_t _sample_rate;

    Timeline ( int X, int Y, int W, int H, const char *L=0 );

    void update_tempomap ( void );

    nframes_t fpp ( void ) const { return 1 << _fpp; }
    nframes_t length ( void ) const { return _length; }
    nframes_t sample_rate ( void ) const { return _sample_rate; }
    int ts_to_x( nframes_t ts ) const { return  ts >> _fpp; }
    nframes_t x_to_ts ( int x ) const { return x << _fpp; }
    nframes_t x_to_offset ( int x ) const;

    float beats_per_minute ( nframes_t when ) const;
    int beats_per_bar ( nframes_t when ) const;
    void beats_per_minute ( nframes_t when, float bpm );
    void time ( nframes_t when, int bpb, int beat_type );
    bool nearest_line ( nframes_t when, nframes_t *f ) const;

    typedef void (measure_line_callback)( nframes_t frame, const BBT & bbt, void *arg );

    position_info solve_tempomap ( nframes_t when ) const;
    void draw_measure_lines ( int X, int Y, int W, int H, Fl_Color color );
    void draw_measure_BBT ( int X, int Y, int W, int H, Fl_Color color );
    position_info render_tempomap ( nframes_t start, nframes_t length, measure_line_callback *cb, void *arg ) const;

    void xposition ( int X );
    void yposition ( int Y );
    void draw_cursor ( nframes_t frame, Fl_Color color, void (*symbol)(Fl_Color) );
    void draw_playhead ( void );
    void redraw_playhead ( void );
    void resize ( int X, int Y, int W, int H );

    void draw ( void );
    void draw_overlay ( void );
    int handle_scroll ( int m );
    int handle ( int m );
    static void update_cb ( void *arg );

    void select( const Rectangle &r );
    Track * track_under ( int Y );


    void delete_selected ( void );
    void select_none ( void );

    void add_track ( Track *track );
    void remove_track ( Track *track );


    void zoom ( float secs );
    void zoom_in ( void );
    void zoom_out ( void );
    void zoom_fit ( void );


    /* Engine */
    int  total_input_buffer_percent ( void );
    int  total_output_buffer_percent ( void );

    int total_playback_xruns ( void );
    int total_capture_xruns ( void );

    bool record ( void );
    void stop ( void );

    void wait_for_buffers ( void );

private:

    friend class Engine; // FIXME: only Engine::process() needs to be friended.x

    Track * track_by_name ( const char *name );
    char * get_unique_track_name ( const char *name );

    /* Engine */
    void resize_buffers ( nframes_t nframes );
    nframes_t process ( nframes_t nframes );
    void seek ( nframes_t frame );
    int seek_pending ( void );
};