lumiera_/src/gui/panels/timeline-panel.cpp

/*
  timeline-panel.cpp  -  Implementation of the timeline panel
 
  Copyright (C)         Lumiera.org
    2008,               Joel Holdsworth <joel@airwebreathe.org.uk>
 
  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; if not, write to the Free Software
  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 
* *****************************************************/

#include <boost/foreach.hpp>

#include "../gtk-lumiera.hpp"
#include "timeline-panel.hpp"

#include "../workspace/workspace-window.hpp"
#include "../model/project.hpp"
#include "../controller/controller.hpp"

extern "C" {
#include "../../lib/time.h"
}

using namespace Gtk;
using namespace sigc;
using namespace std;
using namespace boost;
using namespace gui::widgets;
using namespace gui::model;

namespace gui {
namespace panels {
  
const int TimelinePanel::ZoomToolSteps = 2; // 2 seems comfortable

TimelinePanel::TimelinePanel(workspace::WorkspaceWindow
    &workspace_window) :
  Panel(workspace_window, "timeline", _("Timeline"), "panel_timeline"),
  timeIndicator(),
  previousButton(Stock::MEDIA_PREVIOUS),
  rewindButton(Stock::MEDIA_REWIND),
  playPauseButton(Stock::MEDIA_PLAY),
  stopButton(Stock::MEDIA_STOP),
  forwardButton(Stock::MEDIA_FORWARD),
  nextButton(Stock::MEDIA_NEXT),
  arrowTool(Gtk::StockID("tool_arrow")),
  iBeamTool(Gtk::StockID("tool_i_beam")),
  zoomIn(Stock::ZOOM_IN),
  zoomOut(Stock::ZOOM_OUT),
  updatingToolbar(false),
  currentTool(timeline::IBeam)
{  
  //timelineWidget.mouse_hover_signal().connect(
  //  mem_fun(this, &TimelinePanel::on_mouse_hover));
  //timelineWidget.playback_period_drag_released_signal().connect(
  //  mem_fun(this, &TimelinePanel::on_playback_period_drag_released));
  
  // Hook up notifications
  workspace.get_project().get_sequences().signal_changed().connect(
    mem_fun(this, &TimelinePanel::on_sequence_list_changed));
  
  // Setup the notebook  
  notebook.signal_switch_page().connect(
    mem_fun(this, &TimelinePanel::on_page_switched));
  notebook.popup_enable();

  // Setup the toolbar
  timeIndicatorButton.set_label_widget(timeIndicator);
  
  //toolbar.append(timeIndicatorButton);
  
  toolbar.append(previousButton);
  toolbar.append(rewindButton);
  toolbar.append(playPauseButton,
    mem_fun(this, &TimelinePanel::on_play_pause));
  toolbar.append(stopButton,
    mem_fun(this, &TimelinePanel::on_stop));
  toolbar.append(forwardButton);
  toolbar.append(nextButton);
  
  toolbar.append(seperator1);
  
  toolbar.append(arrowTool,
    mem_fun(this, &TimelinePanel::on_arrow_tool));
  toolbar.append(iBeamTool,
    mem_fun(this, &TimelinePanel::on_ibeam_tool));
    
  toolbar.append(seperator2);
  
  toolbar.append(zoomIn, mem_fun(this, &TimelinePanel::on_zoom_in));
  toolbar.append(zoomOut, mem_fun(this, &TimelinePanel::on_zoom_out));
  
  toolbar.show_all();
  panelBar.pack_start(toolbar, PACK_EXPAND_WIDGET);
  
  // Add the notebook
  pack_start(notebook, PACK_EXPAND_WIDGET);
  
  // Set the initial UI state
  update_notebook();
  update_tool_buttons();
  update_zoom_buttons();
  show_time(0);
}

TimelinePanel::~TimelinePanel()
{

}

void
TimelinePanel::on_play_pause()
{
  if(!is_playing())
    {
      play();
    }
  else
    {
      pause();
    }
  
  update_playback_buttons();
}

void
TimelinePanel::on_stop()
{
  workspace.get_controller().get_playback_controller().stop();  
  update_playback_buttons();
}

void
TimelinePanel::on_arrow_tool()
{
  set_tool(timeline::Arrow);
}

void
TimelinePanel::on_ibeam_tool()
{  
  set_tool(timeline::IBeam);
}

void
TimelinePanel::on_zoom_in()
{
  TimelineWidget *const  widget = get_current_page();
  REQUIRE(widget != NULL);
  
  widget->zoom_view(ZoomToolSteps);
  update_zoom_buttons();
}

void
TimelinePanel::on_zoom_out()
{
  TimelineWidget *const  widget = get_current_page();
  REQUIRE(widget != NULL);
  
  widget->zoom_view(-ZoomToolSteps);
  update_zoom_buttons();
}

void
TimelinePanel::on_page_switched(GtkNotebookPage*, guint)
{
  // The page has changed. Update the UI for this new page
  
  // Set the tool in the new page to be the same as the tool in the last
  // page
  set_tool(currentTool); 

  update_zoom_buttons();
}

void
TimelinePanel::on_mouse_hover(gavl_time_t time)
{
  (void)time;
}

void
TimelinePanel::on_playback_period_drag_released()
{
  //----- TEST CODE - this needs to set the playback point via the
  // real backend
  
  TimelineWidget *const  widget = get_current_page();
  REQUIRE(widget != NULL);
    
  widget->get_state()->set_playback_point(
    widget->get_state()->get_playback_period_start());
  //----- END TEST CODE
  
  play();
}

void
TimelinePanel::on_sequence_list_changed()
{
  update_notebook();
}

void
TimelinePanel::update_notebook()
{
  std::map<const model::Sequence*, shared_ptr<TimelineWidget> >
    old_pages;
  old_pages.swap(notebook_pages);

  BOOST_FOREACH( shared_ptr< model::Sequence > sequence,
    workspace.get_project().get_sequences() )
    {
      std::map<const model::Sequence*, shared_ptr<TimelineWidget> >::
        iterator iterator = old_pages.find(sequence.get());
      if(iterator != old_pages.end())
        {
          // This sequence has not been changed
          // leave it in the new list
          notebook_pages[iterator->first] = iterator->second;
          old_pages.erase(iterator->first);
        }
      else
        {
          // This is a new sequence, add it in
          shared_ptr< timeline::TimelineState > state(
            new timeline::TimelineState(sequence));
          shared_ptr< TimelineWidget > widget(
            new TimelineWidget(state));
          notebook_pages[sequence.get()] = widget;
          notebook.append_page(*widget.get(), sequence->get_name());
          notebook.set_tab_reorderable(*widget.get());
        }
    }
    
  notebook.show_all_children();
}

void
TimelinePanel::update_playback_buttons()
{
  playPauseButton.set_stock_id(is_playing() ?
    Stock::MEDIA_PAUSE : Stock::MEDIA_PLAY);  
}

void
TimelinePanel::update_tool_buttons()
{    
  if(!updatingToolbar)
    {
      updatingToolbar = true;
      arrowTool.set_active(currentTool == timeline::Arrow);
      iBeamTool.set_active(currentTool == timeline::IBeam);
      updatingToolbar = false;
    }
}

void
TimelinePanel::update_zoom_buttons()
{
  TimelineWidget *const widget = get_current_page();
  
  if(widget != NULL)
    {
      timeline::TimelineViewWindow &viewWindow = 
        widget->get_state()->get_view_window();
      
      zoomIn.set_sensitive(viewWindow.get_time_scale() != 1);
      zoomOut.set_sensitive(viewWindow.get_time_scale()
        != TimelineWidget::MaxScale);
    }
}

void
TimelinePanel::play()
{   
  workspace.get_controller().get_playback_controller().play();
}

void
TimelinePanel::pause()
{
  workspace.get_controller().get_playback_controller().pause();
}

bool
TimelinePanel::is_playing() const
{
  return workspace.get_controller().get_playback_controller().
    is_playing();
}

void
TimelinePanel::set_tool(timeline::ToolType tool)
{
  if(updatingToolbar) return;
  
  TimelineWidget *const widget = get_current_page();
  if(widget != NULL)
    {
      currentTool = tool;
      widget->set_tool(tool);
      update_tool_buttons();
    }
}

void
TimelinePanel::show_time(gavl_time_t time)
{
  timeIndicator.set_text(lumiera_tmpbuf_print_time(time));
}

TimelineWidget*
TimelinePanel::get_current_page()
{
  Notebook::PageList::iterator page_iterator = notebook.get_current();
  if(!page_iterator) return NULL;  
  
  Widget* const widget = (*page_iterator).get_child();
  REQUIRE(widget != NULL);
  return (TimelineWidget*)widget;
}

bool
TimelinePanel::on_frame()
{
  // TEST CODE!  
  /*const gavl_time_t point = timelineWidget.get_playback_point()
    + GAVL_TIME_SCALE / 25;
  if(point < timelineWidget.get_playback_period_end())
    {
      show_time(point);
      timelineWidget.set_playback_point(point);
      
      
    }
  else
    on_stop();*/
    
  return true;
}

}   // namespace panels
}   // namespace gui