File indexing completed on 2024-05-12 16:23:36

0001 /***************************************************************************
0002  *   Copyright (C) 2005-2014 by Linuxstopmotion contributors;              *
0003  *   see the AUTHORS file for details.                                     *
0004  *                                                                         *
0005  *   This program is free software; you can redistribute it and/or modify  *
0006  *   it under the terms of the GNU General Public License as published by  *
0007  *   the Free Software Foundation; either version 2 of the License, or     *
0008  *   (at your option) any later version.                                   *
0009  *                                                                         *
0010  *   This program is distributed in the hope that it will be useful,       *
0011  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
0012  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
0013  *   GNU General Public License for more details.                          *
0014  *                                                                         *
0015  *   You should have received a copy of the GNU General Public License     *
0016  *   along with this program; if not, write to the                         *
0017  *   Free Software Foundation, Inc.,                                       *
0018  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
0019  ***************************************************************************/
0020 
0021 #ifndef VIDEOFACTORY_H
0022 #define VIDEOFACTORY_H
0023 
0024 class VideoEncoder;
0025 class AnimationImpl;
0026 
0027 /**
0028  * Class for exporting a stopmotion project ccntaining images and sounds to
0029  * to a video file.
0030  * @author Bjoern Erik Nilsen & Fredrik Berg Kjoelstad
0031  */
0032 class VideoFactory {
0033 public:
0034     /**
0035      * Objects of this class make a video file.
0036      * @param animation The animation to be turned into a video
0037      */
0038     VideoFactory(const AnimationImpl *animation);
0039     ~VideoFactory();
0040 
0041     /**
0042      * Creates the video file based on the passed encoder. The encoder holds
0043      * information needed to complete the export.
0044      * @param encoder The encoder to be used for video export
0045      * @param playbackSpeed The frame rate (in frames per second) at which
0046      * the video should be encoded, assuming the video encoder supports
0047      * this adjustment.
0048      * @return path to the created video file
0049      */
0050     const char* createVideoFile(VideoEncoder *encoder, int playbackSpeed);
0051 
0052 private:
0053     const AnimationImpl *anim;
0054 };
0055 
0056 #endif