Filled in the parameter names in the prototype of get_frame() to keep doxygen quiet...
[synfig.git] / synfig-core / trunk / src / modules / mod_ffmpeg / mptr_ffmpeg.h
1 /* === S Y N F I G ========================================================= */
2 /*!     \file mptr_ffmpeg.h
3 **      \brief Template Header
4 **
5 **      \legal
6 **      Copyright (c) 2002-2005 Robert B. Quattlebaum Jr., Adrian Bentley
7 **
8 **      This package is free software; you can redistribute it and/or
9 **      modify it under the terms of the GNU General Public License as
10 **      published by the Free Software Foundation; either version 2 of
11 **      the License, or (at your option) any later version.
12 **
13 **      This package is distributed in the hope that it will be useful,
14 **      but WITHOUT ANY WARRANTY; without even the implied warranty of
15 **      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 **      General Public License for more details.
17 **      \endlegal
18 **
19 ** === N O T E S ===========================================================
20 **
21 ** ========================================================================= */
22
23 /* === S T A R T =========================================================== */
24
25 #ifndef __SYNFIG_MPTR_FFMPEG_H
26 #define __SYNFIG_MPTR_FFMPEG_H
27
28 /* === H E A D E R S ======================================================= */
29
30 #include <synfig/importer.h>
31 #include <stdio.h>
32 #include "string.h"
33 #ifdef HAVE_TERMIOS_H
34 #include <termios.h>
35
36 #endif
37
38 #include <synfig/surface.h>
39 /* === M A C R O S ========================================================= */
40
41 /* === T Y P E D E F S ===================================================== */
42
43 /* === C L A S S E S & S T R U C T S ======================================= */
44
45 class ffmpeg_mptr : public synfig::Importer
46 {
47         SYNFIG_IMPORTER_MODULE_EXT
48 public:
49 private:
50         synfig::String filename;
51         FILE *file;
52         int cur_frame;
53         synfig::Surface frame;
54         float fps;
55 #ifdef HAVE_TERMIOS_H
56         struct termios oldtty;
57 #endif
58
59         bool seek_to(int frame);
60         bool grab_frame(void);
61
62 public:
63         ffmpeg_mptr(const char *filename);
64         ~ffmpeg_mptr();
65
66
67         virtual bool get_frame(synfig::Surface &surface,synfig::Time time, synfig::ProgressCallback *callback);
68 };
69
70 /* === E N D =============================================================== */
71
72 #endif