root/gui/ScreenShotter.h

INCLUDED FROM

// 
//   Copyright (C) 2005, 2006, 2007, 2008, 2009, 2010,
//   2011 Free Software Foundation, Inc
// 
// 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 3 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 St, Fifth Floor, Boston, MA  02110-1301  USA

#ifndef GNASH_SCREENSHOT_H
#define GNASH_SCREENSHOT_H

#include <vector>
#include <string>
#include <boost/shared_ptr.hpp>
#include <set>
#include <algorithm>
#include <boost/lexical_cast.hpp>

#include "GnashEnums.h"

namespace gnash {
    class Renderer;
}

namespace gnash {

/// Handles screen dumps.
class ScreenShotter
{
public:

    typedef std::vector<size_t> FrameList;

    /// Create a ScreenShotter with output type selected from filename
    ScreenShotter(const std::string& fileName, int quality = 100);
    
    /// Create a ScreenShotter, specifying the output type.
    ScreenShotter(const std::string& fileName, FileType f, int quality = 100);

    ~ScreenShotter();

    /// Take a screenshot at the next possible moment.
    void now() {
        _immediate = true;
    }

    /// Take a screenshot when the last frame is reached.
    void lastFrame() {
        _last = true;
    }

    struct NoAction { void operator()() const {} };

    /// To be called on the last frame before exit.
    //
    /// @param r                The renderer to use to render the image.
    //
    /// Which frame is last depends on the execution path of the SWF, whether
    /// the SWF loops, whether a timeout was requested or a maximum number of
    /// advances set. Those conditions are not knowable in advance, so
    /// the last frame is a special case.
    void last(const Renderer& r) const {
        last<NoAction>(r);
    }

    /// To be called on the last frame before exit.
    //
    /// @tparam Action          The functor to call only when a screenshot is
    ///                         due. 
    /// @param r                The renderer to use to render the image.
    //
    /// Which frame is last depends on the execution path of the SWF, whether
    /// the SWF loops, whether a timeout was requested or a maximum number of
    /// advances set. Those conditions are not knowable in advance, so
    /// the last frame is a special case.
    template<typename Action>
    void last(const Renderer& r, Action* t = 0) const
    {
        if (_last) {
            if (t) (*t)();
            saveImage(r, "last");
        }
    }

    /// Takes a screenshot if required.
    //
    /// Called on each advance.
    //
    /// @param frameAdvance     used to check whether a screenshot is required
    ///                         as well as to construct the filename.
    /// @param r                The renderer to use to render the image.
    void screenShot(const Renderer& r, size_t frameAdvance) {
        screenShot<NoAction>(r, frameAdvance);
    }

    /// Takes a screenshot if required.
    //
    /// Called on each advance, invoking a functor before any screenshot is
    /// taken.
    //
    /// @tparam Action          The functor to call only when a screenshot is
    ///                         due. 
    /// @param frameAdvance     used to check whether a screenshot is required
    ///                         as well as to construct the filename.
    /// @param r                The renderer to use to render the image.
    template<typename Action>
    void screenShot(const Renderer& r, size_t frameAdvance, Action* t = 0) {
        // Save an image if a spontaneous screenshot was requested or the
        // frame is in the list of requested frames.
        if (_immediate || std::binary_search(_frames.begin(), _frames.end(),
                    frameAdvance)) {

            // Check whether we've rendered an image for this frame.
            if (_done.find(frameAdvance) != _done.end()) {
                return;
            }
            if (t) (*t)();
            _done.insert(frameAdvance);

            saveImage(r, boost::lexical_cast<std::string>(frameAdvance));
            _immediate = false;
        }
        
    }

    /// Request a list of frames to be rendered to image files.
    void setFrames(const FrameList& frames);

private:

    /// Take the screenshot.
    void saveImage(const Renderer& r, const std::string& filename) const;

    /// If true, the next call to screenshot will take a screenshot
    bool _immediate;

    /// Name used to generate output file.
    const std::string _fileName;

    /// Whether to take a screenshot on the last frame.
    bool _last;

    FrameList _frames;

    const FileType _type;

    const int _quality;

    std::set<int> _done;

};
 
} // end of gnash namespace

#endif

// Local Variables:
// mode: C++
// indent-tabs-mode: nil
// End: