The Fib multimedia system
Fib is a system for storing multimedia data (like images or films).
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
nConvertFromFib.h
Go to the documentation of this file.
1 /**
2  * @file nConvertFromFib
3  * file name: nConvertFromFib.h
4  * @author Betti Oesterholz
5  * @date 25.02.2010
6  * @mail webmaster@BioKom.info
7  *
8  * System: C++
9  *
10  * This header specifies functions with which multimediaobjects in the fib
11  * multimediaformats can be converted into other multimediaformats.
12  * Copyright (C) @c GPL3 2010 Betti Oesterholz
13  *
14  * This program is free software: you can redistribute it and/or modify
15  * it under the terms of the GNU General Public License (GPL) as
16  * published by the Free Software Foundation, either version 3 of the
17  * License, or any later version.
18  *
19  * This program is distributed in the hope that it will be useful,
20  * but WITHOUT ANY WARRANTY; without even the implied warranty of
21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22  * GNU Lesser General Public License for more details.
23  *
24  * You should have received a copy of the GNU General Public License
25  * along with this program. If not, see <http://www.gnu.org/licenses/>.
26  *
27  *
28  * This header specifies functions with which multimediaobjects in the fib
29  * multimediaformats can be converted into other multimediaformats.
30  *
31  */
32 /*
33 History:
34 25.02.2010 Oesterholz created
35 11.05.2010 Oesterholz max time for evaluation included
36 23.10.2012 Oesterholz changes to store intermediate result
37 */
38 
39 #ifndef ___N_CONVERT_FROM_FIB_H__
40 #define ___N_CONVERT_FROM_FIB_H__
41 
42 #include "version.h"
43 
44 #include "cFibElement.h"
45 
46 #ifdef FEATURE_OWN_FREE_IMAGE_WARPER
47  //no FreeImagePlus wraper for windows -> use own
48  #include "fipImage.h"
49 #else //WINDOWS
50  #include <FreeImagePlus.h>
51 #endif //WINDOWS
52 
53 
54 using namespace std;
55 using namespace fib;
56 
57 namespace nConvertFromFib{
58 
59  /**
60  * This function converts the given multimediaobject into a fib-object.
61  *
62  * @param multimediaObject the fib -multimedaobject to convert into fib
63  * @param ulMaxEvaluationTimeInSec the maximal time for evaluation in seconds;
64  * if 0 the evalue time is unbound
65  * @param pOutStatus the output status of this method
66  * possible values are:
67  * 0: everthing is ok
68  * 1: the ulMaxEvaluationTimeInSec was reached, the object was not
69  * fully evalued
70  * -1: an error occurrd
71  * @param pPathForFileToStoreImage a string to the path wher to store the
72  * actual picture, if the functionality for the file type exists, the
73  * current evalued picture data will be saved to the file every
74  * INTERVALL_TO_SAVE_CURRENT_PICTURE secounds
75  * @see cEvalueSimpleRGBA255Sec
76  * @return the created FreeImagePlus object (pleas delete it after usage)
77  * or NULL, if non could be created
78  */
79  fipImage * convertToFipImage( const cFibElement & fibMultimediaObject,
80  unsigned long ulMaxEvaluationTimeInSec = 0, int * pOutStatus = NULL,
81  const char * pPathForFileToStoreImage = NULL );
82 
83 
84 }//end namespace nConvertFromFib
85 
86 
87 #endif //___N_CONVERT_FROM_FIB_H__
88 
89 
90 
91 
92 
93 
94