view gui/interface.h @ 34697:ac6b38cd0d45

Rename sub window video window. It was a bad idea to name the video window "sub window" at the time the GUI was written. The term "sub window" does make sense from the programmer's point of view, but it doesn't make any sense at all from the user's point of view, because the sub window simply is the window where the video will be displayed. Moreover, since the term "sub" is generally short for "subtitles", the renaming makes the code much easier to understand.

/*
 * This file is part of MPlayer.
 *
 * MPlayer 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.
 *
 * MPlayer 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 MPlayer; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

#ifndef MPLAYER_GUI_INTERFACE_H
#define MPLAYER_GUI_INTERFACE_H

#include "config.h"
#include "libaf/af.h"
#include "libmpdemux/stheader.h"
#include "m_config.h"
#include "mp_core.h"
#include "playtree.h"
#include "stream/stream.h"

// These are in support of the non-GUI files that interact with
// the GUI and that only need to include interface.h for this.
// ------------------------------------------------------------
#include "cfg.h"

extern int use_gui;             // this is defined in mplayer.c
// ------------------------------------------------------------

#define GMPlayer "gmplayer"

/// gui() instructions
enum {
    GUI_END_FILE,
    GUI_HANDLE_EVENTS,
    GUI_HANDLE_X_EVENT,
    GUI_PREPARE,
    GUI_REDRAW,
    GUI_RUN_COMMAND,
    GUI_RUN_MESSAGE,
    GUI_SETUP_VIDEO_WINDOW,
    GUI_SET_AFILTER,
    GUI_SET_AUDIO,
    GUI_SET_CONTEXT,
    GUI_SET_MIXER,
    GUI_SET_STATE,
    GUI_SET_STREAM,
    GUI_SET_VIDEO
};

//@{
/// Playing state
#define GUI_STOP  0
#define GUI_PLAY  1
#define GUI_PAUSE 2
//@}

//@{
/// NewPlay reason
#define GUI_FILE_SAME 1
#define GUI_FILE_NEW  2
//@}

/// mplayer() instructions
enum {
    MPLAYER_EXIT_GUI,
    MPLAYER_SET_AUTO_QUALITY,
    MPLAYER_SET_BRIGHTNESS,
    MPLAYER_SET_CONTRAST,
    MPLAYER_SET_EQUALIZER,
    MPLAYER_SET_EXTRA_STEREO,
    MPLAYER_SET_FONT_AUTOSCALE,
    MPLAYER_SET_FONT_BLUR,
    MPLAYER_SET_FONT_ENCODING,
    MPLAYER_SET_FONT_FACTOR,
    MPLAYER_SET_FONT_OSDSCALE,
    MPLAYER_SET_FONT_OUTLINE,
    MPLAYER_SET_FONT_TEXTSCALE,
    MPLAYER_SET_HUE,
    MPLAYER_SET_PANSCAN,
    MPLAYER_SET_SATURATION,
    MPLAYER_SET_SUB_ENCODING
};

typedef struct {
    MPContext *mpcontext;
    sh_video_t *sh_video;
    af_stream_t *afilter;

    int VideoWindow;
    int VideoWidth;
    int VideoHeight;

    int StreamType;
    int AudioChannels;

    int AudioStreams;
    stream_language_t AudioStream[32];

    int Subtitles;
    stream_language_t Subtitle[32];

    char *Filename;           // public, read access by MPlayer
    char *AudioFilename;
    char *SubtitleFilename;

    int Tracks;
    int Track;                // public, read access by MPlayer
    int Chapters;
    int Chapter;              // public, write access by MPlayer
    int Angles;
    int Angle;

    int Playing;              // public, read access by MPlayer

    int RunningTime;          // public, write access by MPlayer
    int ElapsedTime;          // public, write access by MPlayer
    float Position;           // public, write access by MPlayer

    float Volume;
    float Balance;

    int NewPlay;              // public, read access by MPlayer
} guiInterface_t;

extern guiInterface_t guiInfo;

/// @name MPlayer -> GUI
//@{
int gui(int what, void *data);
void guiDone(void);
void guiInit(void);
int guiPlaylistAdd(play_tree_t *my_playtree, m_config_t *config);
int guiPlaylistInitialize(play_tree_t *my_playtree, m_config_t *config, int enqueue);
//@}

/// @name GUI -> MPlayer
//@{
void mplayer(int what, float value, void *data);
void mplayerLoadFont(void);
void mplayerLoadSubtitle(const char *name);
void gmp_msg(int mod, int lev, const char *format, ...);
//@}

#endif /* MPLAYER_GUI_INTERFACE_H */