Aegisub/aegisub/src/video_display.h

// Copyright (c) 2005-2007, Rodrigo Braz Monteiro
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
//   * Redistributions of source code must retain the above copyright notice,
//     this list of conditions and the following disclaimer.
//   * Redistributions in binary form must reproduce the above copyright notice,
//     this list of conditions and the following disclaimer in the documentation
//     and/or other materials provided with the distribution.
//   * Neither the name of the Aegisub Group nor the names of its contributors
//     may be used to endorse or promote products derived from this software
//     without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.
//
// Aegisub Project http://www.aegisub.org/
//
// $Id$

/// @file video_display.h
/// @see video_display.cpp
/// @ingroup video main_ui
///

#pragma once

#include <wx/wxprec.h>
#include <wx/glcanvas.h>
#include <wx/combobox.h>

// Prototypes
class VideoSlider;
class VisualTool;
class VideoBox;

/// DOCME
/// @class VideoDisplay
/// @brief DOCME
///
/// DOCME
class VideoDisplay: public wxGLCanvas {
private:
	/// The current visual typesetting mode
	int visualMode;

	/// The unscaled size of the displayed video
	wxSize origSize;

	/// The width of the display
	int w;
	/// The height of the display
	int h;

	/// The x-coordinate of the top left of the area containing video.
	/// Always zero unless the display is detatched and is wider than the video.
	int dx1;
	/// The x-coordinate of the bottom right of the area containing video.
	/// Always equal to the width of the video unless the display is detatched and is wider than the video.
	int dx2;
	/// The y-coordinate of the top left of the area containing video.
	/// Always zero unless the display is detatched and is taller than the video.
	int dy1;
	/// The y-coordinate of the bottom of the area containing video.
	/// Always equal to the height of the video unless the display is detatched and is taller than the video.
	int dy2;

	/// The x position of the mouse
	int mouse_x;
	/// The y position of the mouse
	int mouse_y;

	/// Lock to disable mouse updates during resize operations
	bool locked;

	void DrawTVEffects();
	void DrawOverscanMask(int sizeH,int sizeV,wxColour color,double alpha=0.5);

	void OnPaint(wxPaintEvent& event);
	void OnKey(wxKeyEvent &event);
	void OnMouseEvent(wxMouseEvent& event);

	/// @brief NOP event handler
	/// @param event Unused
	void OnEraseBackground(wxEraseEvent &event) {}
	void OnSizeEvent(wxSizeEvent &event);

	void OnCopyCoords(wxCommandEvent &event);
	void OnCopyToClipboard(wxCommandEvent &event);
	void OnSaveSnapshot(wxCommandEvent &event);
	void OnCopyToClipboardRaw(wxCommandEvent &event);
	void OnSaveSnapshotRaw(wxCommandEvent &event);

	/// The current zoom level, where 1.0 = 100%
	double zoomValue;

	/// The VideoBox this display is contained in
	VideoBox *box;

public:
	/// The current visual typesetting tool
	VisualTool *visual;

	/// Whether the display can be freely resized by the user
	bool freeSize;

	/// The video position slider; not used by VideoDisplay
	VideoSlider *ControlSlider;

	/// The dropdown box for selecting zoom levels
	wxComboBox *zoomBox;

	/// The display for the absolute time of the video position
	wxTextCtrl *PositionDisplay;

	/// The display for the the video position relative to the current subtitle line
	wxTextCtrl *SubsPosition;

	VideoDisplay(wxWindow* parent, wxWindowID id, VideoBox *box, const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize, long style = 0, const wxString& name = wxPanelNameStr);
	~VideoDisplay();
	void Reset();

	void Render();

	void ShowCursor(bool show);
	void ConvertMouseCoords(int &x,int &y);
	void UpdatePositionDisplay();
	void UpdateSize();
	void SetZoom(double value);
	void SetZoomPos(int pos);
	void UpdateSubsRelativeTime();
	void SetVisualMode(int mode);

	DECLARE_EVENT_TABLE()
};