viewmgr.hxx

Go to the documentation of this file.

// viewmgr.hxx -- class for managing all the views in the flightgear world.
//
// Written by Curtis Olson, started October 2000.
//
// Copyright (C) 2000  Curtis L. Olson  - http://www.flightgear.org/~curt
//
// 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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
//
// $Id$
 
 
#ifndef _VIEWMGR_HXX
#define _VIEWMGR_HXX
 
#include <vector>
 
#include <simgear/compiler.h>
#include <simgear/structure/subsystem_mgr.hxx>
#include <simgear/props/props.hxx>
#include <simgear/props/tiedpropertylist.hxx>
#include <simgear/math/SGMath.hxx>
#include <simgear/screen/video-encoder.hxx>
 
 
// forward decls
namespace flightgear
{
    class View;
    typedef SGSharedPtr<flightgear::View> ViewPtr;
}
 
// Define a structure containing view information
class FGViewMgr : public SGSubsystem
{
public:
    // Constructor
    FGViewMgr( void );
 
    // Destructor
    ~FGViewMgr( void );
 
    // Subsystem API.
    void bind() override;
    void init() override;
    void postinit() override;
    void reinit() override;
    void shutdown() override;
    void unbind() override;
    void update(double dt) override;
 
    // Subsystem identification.
    static const char* staticSubsystemClassId() { return "view-manager"; }
 
    // getters
    inline int size() const { return views.size(); }
 
    int getCurrentViewIndex() const;
 
    flightgear::View* get_current_view();
    const flightgear::View* get_current_view() const;
 
    flightgear::View* get_view( int i );
    const flightgear::View* get_view( int i ) const;
 
    flightgear::View* next_view();
    flightgear::View* prev_view();
 
    // Support for extra view windows. This only works if --compositer-viewer=1 was specified.
    //
    
    // Calls SviewPush().
    void view_push();
    
    // These all end up calling SviewCreate().
    void clone_current_view(const SGPropertyNode* config);
    void clone_last_pair(const SGPropertyNode* config);
    void clone_last_pair_double(const SGPropertyNode* config);
    void view_new(const SGPropertyNode* config);
 
    // setters
    void clear();
 
    void add_view( flightgear::View * v );
 
    // Start video encoding of main window.
    //
    //  name
    //      If "", we generate a name containing aircraft name, date and
    //      time and with suffix /sim/video/container, and we also create a
    //      softlink with the same name excluding date and time. Both names are
    //      converted into paths by prepending with /sim/video/directory.
    //
    //      Otherwise we prepend with /sim/video/directory, and do not create
    //      a softlink. In this case, <name> should end with a name that is a
    //      recognised video container, such as '.mp4'.
    //
    //      List of supported containers can be found with 'ffmpeg -formats'.
    //  codec_name
    //      Name of codec or "" to use /sim/video/codec. Passed to
    //      avcodec_find_encoder_by_name(). List of supported codecs can be
    //      found with 'ffmpeg -codecs'.
    //  quality
    //      Encoding quality in range 0..1 or -1 to use /sim/video/quality.
    //  speed:
    //      Encoding speed in range 0..1 or -1 to use /sim/video/speed.
    //    bitrate
    //      Target bitratae in bits/sec or -1 to use /sim/video/bitrate.
    //
    // We show popup warning if values are out of range - quality and speed
    // must be -1 or 0-1, bitrate must be >= 0.
    //
    // Returns false if we fail to start video encoding.
    //
    bool video_start(
            const std::string& name="",
            const std::string& codec="",
            double quality=-1,
            double speed=-1,
            int bitrate=0
            );
    
    // Stop video encoding of main window.
    //
    void video_stop();
 
private:
    simgear::TiedPropertyList _tiedProperties;
 
    void setCurrentViewIndex(int newview);
 
    bool _inited = false;
    std::vector<SGPropertyNode_ptr> config_list;
    SGPropertyNode_ptr _viewNumberProp;
    typedef std::vector<flightgear::ViewPtr> viewer_list;
    viewer_list views;
 
    int _current = 0;
 
    std::unique_ptr<simgear::VideoEncoder>  _video_encoder;
};
 
#endif // _VIEWMGR_HXX