Tidied up and checked in a patch from genete to allow importing of lipsynced voice...
[synfig.git] / synfig-core / trunk / src / synfig / listimporter.cpp
1 /* === S Y N F I G ========================================================= */
2 /*!     \file listimporter.cpp
3 **      \brief Template File
4 **
5 **      $Id$
6 **
7 **      \legal
8 **      Copyright (c) 2002-2005 Robert B. Quattlebaum Jr., Adrian Bentley
9 **
10 **      This package is free software; you can redistribute it and/or
11 **      modify it under the terms of the GNU General Public License as
12 **      published by the Free Software Foundation; either version 2 of
13 **      the License, or (at your option) any later version.
14 **
15 **      This package is distributed in the hope that it will be useful,
16 **      but WITHOUT ANY WARRANTY; without even the implied warranty of
17 **      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 **      General Public License for more details.
19 **      \endlegal
20 */
21 /* ========================================================================= */
22
23 /* === H E A D E R S ======================================================= */
24
25 #ifdef USING_PCH
26 #       include "pch.h"
27 #else
28 #ifdef HAVE_CONFIG_H
29 #       include <config.h>
30 #endif
31
32 #include "listimporter.h"
33 #include "general.h"
34 #include <fstream>
35
36 #endif
37
38 /* === U S I N G =========================================================== */
39
40 using namespace std;
41 using namespace etl;
42 using namespace synfig;
43
44 /* === M A C R O S ========================================================= */
45
46 #define LIST_IMPORTER_CACHE_SIZE        20
47
48 /* === G L O B A L S ======================================================= */
49
50 /* === P R O C E D U R E S ================================================= */
51
52 /* === M E T H O D S ======================================================= */
53
54 ListImporter::ListImporter(const String &filename)
55 {
56         fps=15;
57
58         ifstream stream(filename.c_str());
59
60         if(!stream)
61         {
62                 synfig::error("Unable to open "+filename);
63                 return;
64         }
65         String line;
66         String prefix=etl::dirname(filename)+ETL_DIRECTORY_SEPARATOR;
67         getline(stream,line);           // read first line and check whether it is a Papagayo lip sync file
68
69         if (line == "MohoSwitch1")      // it is a Papagayo lipsync file
70         {
71                 String phoneme, prevphoneme, prevext, ext(".jpg"); // default image format
72                 int frame, prevframe = -1; // it means that the previous phoneme is not known
73
74                 while(!stream.eof())
75                 {
76                         getline(stream,line);
77
78                         if(line.find(String("FPS ")) == 0)
79                         {
80                                 float f = atof(String(line.begin()+4,line.end()).c_str());
81                                 if (f) fps = f;
82                                 continue;
83                         }
84
85                         if (line == "bmp"  ||
86                                 line == "jpg"  ||
87                                 line == "png"  ||
88                                 line == "ppm"  ||
89                                 line == "tiff" )
90                         {
91                                 ext = String(".") + line;
92                                 continue;
93                         }
94
95                         size_t pos = line.find(String(" ")); // find space position. The format is "frame phoneme-name".
96                         if(pos != String::npos)
97                         {
98                                 frame = atoi(String(line.begin(),line.begin()+pos).c_str());
99                                 phoneme = String(line.begin()+pos+1, line.end());
100
101                                 if (prevframe != -1)
102                                         while (prevframe < frame)
103                                         {
104                                                 filename_list.push_back(prefix + prevphoneme + prevext);
105                                                 synfig::info("frame %d, phoneme = %s, path = '%s'", prevframe, prevphoneme.c_str(), (prefix + prevphoneme + prevext).c_str());
106                                                 prevframe++;
107                                         }
108
109                                 prevext = ext;
110                                 prevframe = frame;
111                                 prevphoneme = phoneme;
112                         }
113                 }
114
115                 filename_list.push_back(prefix + prevphoneme + prevext);        // do it one more time for the last phoneme
116                 synfig::info("finally, frame %d, phoneme = %s, path = '%s'", prevframe, prevphoneme.c_str(), (prefix + prevphoneme + prevext).c_str());
117
118                 return;
119         }
120
121         stream.seekg(ios_base::beg);
122         while(!stream.eof())
123         {
124                 getline(stream,line);
125                 if(line.empty())
126                         continue;
127                 // If we have a framerate, then use it
128                 if(line.find(String("FPS "))==0)
129                 {
130                         fps=atof(String(line.begin()+4,line.end()).c_str());
131                         //synfig::warning("FPS=%f",fps);
132                         if(!fps)
133                                 fps=15;
134                         continue;
135                 }
136                 filename_list.push_back(prefix+line);
137         }
138 }
139
140 Importer*
141 ListImporter::create(const char *filename)
142 {
143         return new ListImporter(filename);
144 }
145
146 ListImporter::~ListImporter()
147 {
148 }
149
150 bool
151 ListImporter::get_frame(Surface &surface,Time time, ProgressCallback *cb)
152 {
153         int frame=round_to_int(time*fps);
154
155         if(!filename_list.size())
156         {
157                 if(cb)cb->error(_("No images in list"));
158                 else synfig::error(_("No images in list"));
159                 return false;
160         }
161
162         if(frame<0)frame=0;
163         if(frame>=(signed)filename_list.size())frame=filename_list.size()-1;
164
165         // See if that frame is cached
166         std::list<std::pair<String,Surface> >::iterator iter;
167         for(iter=frame_cache.begin();iter!=frame_cache.end();++iter)
168         {
169                 if(iter->first==filename_list[frame])
170                 {
171                         surface.mirror(iter->second);
172                         return static_cast<bool>(surface);
173                 }
174         }
175
176         Importer::Handle importer(Importer::open(filename_list[frame]));
177
178         if(!importer)
179         {
180                 if(cb)cb->error(_("Unable to open ")+filename_list[frame]);
181                 else synfig::error(_("Unable to open ")+filename_list[frame]);
182                 return false;
183         }
184
185         if(!importer->get_frame(surface,0,cb))
186         {
187                 if(cb)cb->error(_("Unable to get frame from ")+filename_list[frame]);
188                 else synfig::error(_("Unable to get frame from ")+filename_list[frame]);
189                 return false;
190         }
191
192         if(frame_cache.size()>=LIST_IMPORTER_CACHE_SIZE)
193                 frame_cache.pop_front();
194
195         frame_cache.push_back(std::pair<String,Surface>(filename_list[frame],surface));
196
197         surface.mirror(frame_cache.back().second);
198
199         return static_cast<bool>(surface);
200 }
201
202 bool
203 ListImporter::is_animated()
204 {
205         return true;
206 }