basegui.h

/*  smplayer2, GUI front-end for mplayer2.
    Copyright (C) 2006-2010 Ricardo Villalba <rvm@escomposlinux.org>

    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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
*/

#ifndef _BASEGUI_H_
#define _BASEGUI_H_

#include <QMainWindow>
#include <QNetworkProxy>
#include "mediadata.h"
#include "mediasettings.h"
#include "preferences.h"
#include "core.h"
#include "config.h"
#include "guiconfig.h"

#ifdef Q_OS_WIN
/* Disable screensaver by event */
#include <windows.h>
#endif

class QWidget;
class QMenu;
class LogWindow;
class MplayerWindow;

class QLabel;
class FilePropertiesDialog;
class VideoEqualizer;
class AudioEqualizer;
class FindSubtitlesWindow;
class Playlist;

class MyAction;
class MyActionGroup;

class PreferencesDialog;
class MyServer;

class Favorites;
class TVList;

class BaseGui : public QMainWindow
{
    Q_OBJECT

public:
    BaseGui(bool use_server, QWidget *parent = 0, Qt::WindowFlags flags = 0);
    ~BaseGui();

    /* Return true if the window shouldn't show on startup */
    virtual bool startHidden() {
        return false;
    };

    //! Execute all actions in \a actions. The actions should be
    //! separated by spaces. Checkable actions could have a parameter:
    //! true or false.
    void runActions(QString actions);

    //! Execute all the actions after the video has started to play
    void runActionsLater(QString actions) {
        pending_actions_to_run = actions;
    };

    //! Saves the line from the smplayer2 output
    void recordSmplayerLog(QString line);

public slots:
    virtual void open(QString file); // Generic open, autodetect type.
    virtual void openFile();
    virtual void openFile(QString file);
    virtual void openFiles(QStringList files);
    virtual void openFavorite(QString file);
    virtual void openURL();
    virtual void openURL(QString url);
    virtual void openVCD();
    virtual void openAudioCD();
    virtual void openDVD();
    virtual void openDVDFromFolder();
    virtual void openDVDFromFolder(QString directory);
    virtual void openDirectory();
    virtual void openDirectory(QString directory);

    virtual void helpCLOptions();
    virtual void helpAbout();
    virtual void helpAboutQt();

    virtual void loadSub();
    virtual void loadAudioFile(); // Load external audio file

    void setInitialSubtitle(const QString &subtitle_file);

    virtual void showFindSubtitlesDialog();
    virtual void openUploadSubtitlesPage(); //turbos

    virtual void showPlaylist();
    virtual void showPlaylist(bool b);
    virtual void showVideoEqualizer();
    virtual void showVideoEqualizer(bool b);
    virtual void showAudioEqualizer();
    virtual void showAudioEqualizer(bool b);
    virtual void showMplayerLog();
    virtual void showLog();
    virtual void showPreferencesDialog();
    virtual void showFilePropertiesDialog();

    virtual void showGotoDialog();
    virtual void showSubDelayDialog();
    virtual void showAudioDelayDialog();

    virtual void exitFullscreen();
    virtual void toggleFullscreen();
    virtual void toggleFullscreen(bool);

    virtual void toggleCompactMode();
    virtual void toggleCompactMode(bool);

    void setStayOnTop(bool b);
    virtual void changeStayOnTop(int);
    virtual void checkStayOnTop(Core::State);
    void toggleStayOnTop();

    void setForceCloseOnFinish(int n) {
        arg_close_on_finish = n;
    };
    int forceCloseOnFinish() {
        return arg_close_on_finish;
    };

    void setForceStartInFullscreen(int n) {
        arg_start_in_fullscreen = n;
    };
    int forceStartInFullscreen() {
        return arg_start_in_fullscreen;
    };


protected slots:
    virtual void closeWindow();

    virtual void setJumpTexts();

    // Replace for setCaption (in Qt 4 it's not virtual)
    virtual void setWindowCaption(const QString &title);

    //virtual void openRecent(int item);
    virtual void openRecent();
    virtual void enterFullscreenOnPlay();
    virtual void exitFullscreenOnStop();
    virtual void exitFullscreenIfNeeded();
    virtual void playlistHasFinished();

    virtual void displayState(Core::State state);
    virtual void displayMessage(QString message);
    virtual void gotCurrentTime(double);

    virtual void initializeMenus();
    virtual void updateWidgets();
    virtual void updateVideoEqualizer();
    virtual void updateAudioEqualizer();

    virtual void newMediaLoaded();
    virtual void updateMediaInfo();

    void checkPendingActionsToRun();

#if AUTODISABLE_ACTIONS
    virtual void enableActionsOnPlaying();
    virtual void disableActionsOnStop();
    virtual void togglePlayAction(Core::State);
#endif

    virtual void resizeWindow(int w, int h, bool force);
    virtual void hidePanel();

    /* virtual void playlistVisibilityChanged(); */

    virtual void displayGotoTime(int);
    //! You can call this slot to jump to the specified percentage in the video, while dragging the slider.
    virtual void goToPosOnDragging(int);

    virtual void showPopupMenu();
    virtual void showPopupMenu(QPoint p);
    /*
    virtual void mouseReleaseEvent( QMouseEvent * e );
    virtual void mouseDoubleClickEvent( QMouseEvent * e );
    */

    virtual void leftClickFunction();
    virtual void rightClickFunction();
    virtual void doubleClickFunction();
    virtual void middleClickFunction();
    virtual void xbutton1ClickFunction();
    virtual void xbutton2ClickFunction();
    virtual void processFunction(QString function);

    virtual void dragEnterEvent(QDragEnterEvent *) ;
    virtual void dropEvent(QDropEvent *);

    virtual void applyNewPreferences();
    virtual void applyFileProperties();

    virtual void clearRecentsList();

    virtual void loadActions();
    virtual void saveActions();

    // Check the mouse pos in fullscreen mode, to
    // show the controlwidget if it's moved to
    // the bottom area.
    virtual void checkMousePos(QPoint);

    // Single instance stuff
    // Another instance request open a file
    virtual void remoteOpen(QString);
    virtual void remoteOpenFiles(QStringList);
    virtual void remoteAddFiles(QStringList);
    virtual void remoteLoadSubtitle(QString);
    virtual void remotePlayItem(int);
    virtual void remoteRemoveItem(int);
    virtual void remoteMoveItem(int, int);
    virtual void remoteViewPlaylist(QString *);
    virtual void remoteViewStatus(QString *);
    virtual void remoteViewClipInfo(QString *);
    virtual void remoteSeek(double);
    virtual void remoteGetChecked(QString, QString *);
    virtual void remoteGetVolume(int *);

    void showExitCodeFromMplayer(int exit_code);
    void showErrorFromMplayer(QProcess::ProcessError);

    // stylesheet
#if ALLOW_CHANGE_STYLESHEET
    virtual void loadQss(QString filename);
    virtual void changeStyleSheet(QString style);
#endif

#ifdef Q_OS_WIN
    /* Disable screensaver by event */
    void clear_just_stopped();
#endif

    //! Clears the mplayer log
    void clearMplayerLog();

    //! Saves the line from the mplayer output
    void recordMplayerLog(QString line);

    //! Saves the mplayer log to a file every time a file is loaded
    void autosaveMplayerLog();

signals:
    void frameChanged(int);
    void ABMarkersChanged(int secs_a, int secs_b);
    void videoInfoChanged(int width, int height, double fps);
    void timeChanged(QString time_ready_to_print);

    void cursorNearTop(QPoint);
    void cursorNearBottom(QPoint);
    void cursorFarEdges();

    void wheelUp();
    void wheelDown();
    /*
    void doubleClicked();
    void leftClicked();
    void middleClicked();
    */

    //! Sent when the user wants to close the main window
    void quitSolicited();

protected:
    virtual void retranslateStrings();
    virtual void changeEvent(QEvent *event);
    virtual void hideEvent(QHideEvent *);
    virtual void showEvent(QShowEvent *);
#ifdef Q_OS_WIN
    /* Disable screensaver by event */
    virtual bool winEvent(MSG *m, long *result);
#endif

    virtual void aboutToEnterFullscreen();
    virtual void aboutToExitFullscreen();
    virtual void aboutToEnterCompactMode();
    virtual void aboutToExitCompactMode();

protected:
    void createCore();
    void createMplayerWindow();
    void createVideoEqualizer();
    void createAudioEqualizer();
    void createPlaylist();
    void createPanel();
    void createPreferencesDialog();
    void createFilePropertiesDialog();
    void setDataToFileProperties();
    void initializeGui();
    void createActions();
#if AUTODISABLE_ACTIONS
    void setActionsEnabled(bool);
#endif
    void createMenus();
    void updateRecents();
    void configureDiscDevices();
    /* virtual void closeEvent( QCloseEvent * e ); */

protected:
    virtual void wheelEvent(QWheelEvent *e) ;

protected:
    QWidget *panel;

    // Menu File
    MyAction *openFileAct;
    MyAction *openDirectoryAct;
    MyAction *openPlaylistAct;
    MyAction *openVCDAct;
    MyAction *openAudioCDAct;
    MyAction *openDVDAct;
    MyAction *openDVDFolderAct;
    MyAction *openURLAct;
    MyAction *exitAct;
    MyAction *clearRecentsAct;

    // Menu Play
    MyAction *playAct;
    MyAction *playOrPauseAct;
    MyAction *pauseAct;
    MyAction *pauseAndStepAct;
    MyAction *stopAct;
    MyAction *frameStepAct;
    MyAction *rewind1Act;
    MyAction *rewind2Act;
    MyAction *rewind3Act;
    MyAction *forward1Act;
    MyAction *forward2Act;
    MyAction *forward3Act;
    MyAction *repeatAct;
    MyAction *setAMarkerAct;
    MyAction *setBMarkerAct;
    MyAction *clearABMarkersAct;
    MyAction *gotoAct;

    // Menu Speed
    MyAction *normalSpeedAct;
    MyAction *halveSpeedAct;
    MyAction *doubleSpeedAct;
    MyAction *decSpeed10Act;
    MyAction *incSpeed10Act;
    MyAction *decSpeed4Act;
    MyAction *incSpeed4Act;
    MyAction *decSpeed1Act;
    MyAction *incSpeed1Act;

    // Menu Video
    MyAction *fullscreenAct;
    MyAction *compactAct;
    MyAction *videoEqualizerAct;
    MyAction *screenshotAct;
    MyAction *screenshotallAct;
    MyAction *screenshotsAct;
    MyAction *flipAct;
    MyAction *mirrorAct;
    MyAction *postProcessingAct;
    MyAction *phaseAct;
    MyAction *deblockAct;
    MyAction *deringAct;
    MyAction *addNoiseAct;
    MyAction *addLetterboxAct;
    MyAction *upscaleAct;

    // Menu Audio
    MyAction *audioEqualizerAct;
    MyAction *muteAct;
    MyAction *decVolumeAct;
    MyAction *incVolumeAct;
    MyAction *decAudioDelayAct;
    MyAction *incAudioDelayAct;
    MyAction *audioDelayAct;  // Ask for delay
    MyAction *extrastereoAct;
    MyAction *karaokeAct;
    MyAction *volnormAct;
    MyAction *loadAudioAct;
    MyAction *unloadAudioAct;

    // Menu Subtitles
    MyAction *loadSubsAct;
    MyAction *unloadSubsAct;
    MyAction *decSubDelayAct;
    MyAction *incSubDelayAct;
    MyAction *subDelayAct;  // Ask for delay
    MyAction *decSubPosAct;
    MyAction *incSubPosAct;
    MyAction *incSubStepAct;
    MyAction *decSubStepAct;
    MyAction *incSubScaleAct;
    MyAction *decSubScaleAct;
    MyAction *subUseMplayer2DefaultsAct;
    MyAction *useAssAct;
    MyAction *useForcedSubsOnlyAct;
    MyAction *subVisibilityAct;
    MyAction *showFindSubtitlesDialogAct;
    MyAction *openUploadSubtitlesPageAct; //turbos

    // Menu Options
    MyAction *showPlaylistAct;
    MyAction *showPropertiesAct;
    MyAction *motionVectorsAct;
    MyAction *showPreferencesAct;
    MyAction *showLogMplayerAct;
    MyAction *showLogSmplayerAct;

    // Menu Help
    MyAction *showCLOptionsAct;  // Command line options
    MyAction *aboutQtAct;
    MyAction *aboutThisAct;

    // Playlist
    MyAction *playPrevAct;
    MyAction *playNextAct;

    // Actions not in menus
#if !USE_MULTIPLE_SHORTCUTS
    MyAction *decVolume2Act;
    MyAction *incVolume2Act;
#endif
    MyAction *exitFullscreenAct;
    MyAction *nextOSDAct;
    MyAction *decContrastAct;
    MyAction *incContrastAct;
    MyAction *decBrightnessAct;
    MyAction *incBrightnessAct;
    MyAction *decHueAct;
    MyAction *incHueAct;
    MyAction *decSaturationAct;
    MyAction *incSaturationAct;
    MyAction *decGammaAct;
    MyAction *incGammaAct;
    MyAction *nextVideoAct;
    MyAction *nextAudioAct;
    MyAction *nextSubtitleAct;
    MyAction *nextChapterAct;
    MyAction *prevChapterAct;
    MyAction *doubleSizeAct;
    MyAction *resetVideoEqualizerAct;
    MyAction *resetAudioEqualizerAct;
    MyAction *showContextMenuAct;
    MyAction *nextAspectAct;
    MyAction *nextWheelFunctionAct;

    MyAction *showFilenameAct;
    MyAction *toggleDeinterlaceAct;

    // Moving and zoom
    MyAction *moveUpAct;
    MyAction *moveDownAct;
    MyAction *moveLeftAct;
    MyAction *moveRightAct;
    MyAction *incZoomAct;
    MyAction *decZoomAct;
    MyAction *resetZoomAct;
    MyAction *autoZoomAct;
    MyAction *autoZoom169Act;
    MyAction *autoZoom235Act;

    MyAction *incPanscanAct;
    MyAction *decPanscanAct;

    // OSD Action Group
    MyActionGroup *osdGroup;
    MyAction *osdNoneAct;
    MyAction *osdSeekAct;
    MyAction *osdTimerAct;
    MyAction *osdTotalAct;

    // Denoise Action Group
    MyActionGroup *denoiseGroup;
    MyAction *denoiseNoneAct;
    MyAction *denoiseNormalAct;
    MyAction *denoiseSoftAct;

    // Window Size Action Group
    MyActionGroup *sizeGroup;
    MyAction *size50;
    MyAction *size75;
    MyAction *size100;
    MyAction *size125;
    MyAction *size150;
    MyAction *size175;
    MyAction *size200;
    MyAction *size300;
    MyAction *size400;

    // Deinterlace Action Group
    MyActionGroup *deinterlaceGroup;
    MyAction *deinterlaceNoneAct;
    MyAction *deinterlaceL5Act;
    MyAction *deinterlaceYadif0Act;
    MyAction *deinterlaceYadif1Act;
    MyAction *deinterlaceLBAct;
    MyAction *deinterlaceKernAct;

    // Aspect Action Group
    MyActionGroup *aspectGroup;
    MyAction *aspectDetectAct;
    MyAction *aspectNoneAct;
    MyAction *aspect11Act;		// 1:1
    MyAction *aspect32Act;		// 3:2
    MyAction *aspect43Act;		// 4:3
    MyAction *aspect54Act;		// 5:4
    MyAction *aspect149Act;	// 14:9
    MyAction *aspect1410Act;	// 14:10
    MyAction *aspect169Act;	// 16:9
    MyAction *aspect1610Act;	// 16:10
    MyAction *aspect235Act;	// 2.35:1

    // Rotate Group
    MyActionGroup *rotateGroup;
    MyAction *rotateNoneAct;
    MyAction *rotateClockwiseFlipAct;
    MyAction *rotateClockwiseAct;
    MyAction *rotateCounterclockwiseAct;
    MyAction *rotateCounterclockwiseFlipAct;

    // Menu StayOnTop
    MyActionGroup *onTopActionGroup;
    MyAction *onTopAlwaysAct;
    MyAction *onTopNeverAct;
    MyAction *onTopWhilePlayingAct;
    MyAction *toggleStayOnTopAct;

#if USE_ADAPTER
    // Screen Group
    MyActionGroup *screenGroup;
    MyAction *screenDefaultAct;
#endif

    // Closed Captions Group
    MyActionGroup *ccGroup;
    MyAction *ccNoneAct;
    MyAction *ccChannel1Act;
    MyAction *ccChannel2Act;
    MyAction *ccChannel3Act;
    MyAction *ccChannel4Act;


    // Audio Channels Action Group
    MyActionGroup *channelsGroup;
    /* MyAction * channelsDefaultAct; */
    MyAction *channelsStereoAct;
    MyAction *channelsQuadAct;
    MyAction *channels51Act;
    MyAction *channels71Act;

    // Stereo Mode Action Group
    MyActionGroup *stereoGroup;
    MyAction *stereoAct;
    MyAction *leftChannelAct;
    MyAction *rightChannelAct;

    // Other groups
#if PROGRAM_SWITCH
    MyActionGroup *programTrackGroup;
#endif
    MyActionGroup *videoTrackGroup;
    MyActionGroup *audioTrackGroup;
    MyActionGroup *subtitleTrackGroup;
    MyActionGroup *titleGroup;
    MyActionGroup *angleGroup;
    MyActionGroup *chapterGroup;
    MyActionGroup *editionGroup;

#if DVDNAV_SUPPORT
    MyAction *dvdnavUpAct;
    MyAction *dvdnavDownAct;
    MyAction *dvdnavLeftAct;
    MyAction *dvdnavRightAct;
    MyAction *dvdnavMenuAct;
    MyAction *dvdnavSelectAct;
    MyAction *dvdnavPrevAct;
    MyAction *dvdnavMouseAct;
#endif

    // MENUS
    QMenu *openMenu;
    QMenu *playMenu;
    QMenu *videoMenu;
    QMenu *audioMenu;
    QMenu *subtitlesMenu;
    QMenu *browseMenu;
    QMenu *optionsMenu;
    QMenu *helpMenu;

    QMenu *disc_menu;
    QMenu *subtitlestrack_menu;
#if PROGRAM_SWITCH
    QMenu *programtrack_menu;
#endif
    QMenu *videotrack_menu;
    QMenu *audiotrack_menu;
    QMenu *titles_menu;
    QMenu *chapters_menu;
    QMenu *editions_menu;
    QMenu *angles_menu;
    QMenu *aspect_menu;
    QMenu *osd_menu;
    QMenu *deinterlace_menu;
    //QMenu * denoise_menu;
    QMenu *videosize_menu;
    QMenu *audiochannels_menu;
    QMenu *stereomode_menu;

    QMenu *speed_menu;
    QMenu *ab_menu;  // A-B menu
    QMenu *videofilter_menu;
    QMenu *audiofilter_menu;
    QMenu *logs_menu;
    QMenu *zoom_menu;
    QMenu *rotate_menu;
    QMenu *ontop_menu;
#if USE_ADAPTER
    QMenu *screen_menu;
#endif
    QMenu *closed_captions_menu;

    QMenu *popup;
    QMenu *recentfiles_menu;

    LogWindow *mplayer_log_window;
    LogWindow *smplayer2_log_window;
    LogWindow *clhelp_window;

    PreferencesDialog *pref_dialog;
    FilePropertiesDialog *file_dialog;
    Playlist *playlist;
    VideoEqualizer *video_equalizer;
    AudioEqualizer *audio_equalizer;
    FindSubtitlesWindow *find_subs_dialog;

    Core *core;
    MplayerWindow *mplayerwindow;

    MyServer *server;

    Favorites *favorites;

    TVList *tvlist;
    TVList *radiolist;

    QStringList actions_list;

    QString pending_actions_to_run;

    // Force settings from command line
    int arg_close_on_finish; // -1 = not set, 1 = true, 0 = false
    int arg_start_in_fullscreen; // -1 = not set, 1 = true, 0 = false
    bool use_control_server;

private:
    QString default_style;

    bool near_top;
    bool near_bottom;

    // Variables to restore pos and size of the window
    // when exiting from fullscreen mode.
    QPoint win_pos;
    QSize win_size;
    bool was_maximized;

#ifdef Q_OS_WIN
    /* Disable screensaver by event */
    bool just_stopped;
#endif

    QString mplayer_log;
    QString smplayer2_log;

    bool ignore_show_hide_events;
};

#endif