export.h

Go to the documentation of this file.

/*
* export.h Export Mode Base Object
* Copyright (C) 2002 Mads Bondo Dydensborg <madsdyd@challenge.dk>
* Copyright (C) 2001-2007 Dan Dennedy <dan@dennedy.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 _EXPORT_H
#define _EXPORT_H

#ifdef HAVE_CONFIG_H
#include <config.h>
#endif
#include <sys/time.h>

#include <gtk/gtk.h>
#include "page_export.h"
#include "kino_common.h"

extern "C"
{
#include "support.h"
}

typedef enum export_mode {
    EXPORT_MODE_1394,
    EXPORT_MODE_AVI,
    EXPORT_MODE_STILLS,
    EXPORT_MODE_AUDIO,
    EXPORT_MODE_MJPEG,
    EXPORT_MODE_PIPE
};

typedef enum export_result {
    EXPORT_RESULT_FAILURE,
    EXPORT_RESULT_SUCCESS,
    EXPORT_RESULT_ABORT
};

typedef enum export_component_enum {
    EXPORT_SCENE_LIST = 2,
    /* I guess the compiler will barf if we choose SCENE_LIST again */
    EXPORT_PREVIEW = 0x01000000,
    EXPORT_EXPORT = 0x02000000,
    EXPORT_PAUSE = 0x04000000
                   /* Note, stop is supported by all - no need to
                      have it in here... */
};

class Export
{
protected:
    /* What we support. This is updated on each activate */
    gulong actions;

    /* Perhaps the following variables should be made static,
       as they really need not be allocated by each page. 
       OTOH: KISS */
    /* Pointers to the page and KinoCommon */
    PageExport *exportPage;
    KinoCommon *common;

    /* Pointers to range control elements */
    GtkOptionMenu   *menuRange;
    GtkSpinButton   *startSpin;
    GtkEntry        *startEntry;
    GtkSpinButton   *endSpin;
    GtkEntry        *endEntry;
    GtkSpinButton   *everySpin;

    /* The common buttons - all export pages
       should support these buttons */
    GtkToggleButton *previewButton;
    GtkToggleButton *exportButton;
    GtkToggleButton *stopButton;
    GtkToggleButton *pauseButton;

    double startTime;
    double pauseTime;
    double nextUpdateTime;

    void innerLoopUpdate( int progress, int begin, int end, int every,
        int currentFrame = -1, const char* activity = _("Exporting") );

    double calculateAdjustedRate( PlayList* playlist, double outputRate, int begin,
        int end, int every );

    /* Override this, if you need behaviour different from sleeping
       and checking the "isPausing" flag (every 20 millisecond). 
       Please remember to also maintain the time used in pause.
    */
    virtual void doPause();

    virtual enum export_result
    doExport( PlayList * playlist, int begin, int end, int every, bool preview ) = 0;

    /* Override these to indicate what to support, what not */
    virtual gulong onActivate();
    virtual gulong onDeactivate();

public:
    /* Format a number of seconds into HH:MM:SS notation
       \param buf buffer to format into
       \param size max size of buffer
       \param seconds passed as double
       \return pointer to buf 
    */
    static char * formatSecs( char * buf, int size, double seconds );

public:
    Export( PageExport *_exportPage, KinoCommon *_common );
    virtual ~Export( ) { }

    /* Children should return a bitfield for the actions supported,
       when activate is called.
       Note, these methods are not declared virtual, as childrens should
       override "onActivate" and "onDeactivate" instead.
       This is because we maintain our on set of commands in here... */
    gulong activate();
    gulong deactivate();
    virtual void start();
    virtual void clean();
    /* Called when the start button is toggled
       A wrapper for doExport - does some setup, then runs
       doExport and finally tears down some stuff again 
       \param preview optional, is passed to doExport
    */

    void startExport( bool preview = false ); // { }
    /* Called when the stop button is toggled
       All children should honor the "isExporting" flag, and 
       stop exporting when this flag is set to false. */
    virtual void stopExport();
    /* Called when the pause button is toggled
       All children should call "checkPause" in their mainloop. 
       checkPause will call doPause if needed.
       default doPause just sleeps - if you need to do something else,
       then overwrite doPause.
    */
    virtual void pauseExport();

    virtual void selectScene( int );

    virtual void selectSection( int );

    void onRangeChange( GtkSpinButton *widget );
};

#endif

---