1/*M///////////////////////////////////////////////////////////////////////////////////////
2//
3//  IMPORTANT: READ BEFORE DOWNLOADING, COPYING, INSTALLING OR USING.
4//
5//  By downloading, copying, installing or using the software you agree to this license.
6//  If you do not agree to this license, do not download, install,
7//  copy or use the software.
8//
9//
10//                           License Agreement
11//                For Open Source Computer Vision Library
12//
13// Copyright (C) 2000-2008, Intel Corporation, all rights reserved.
14// Copyright (C) 2009, Willow Garage Inc., all rights reserved.
15// Third party copyrights are property of their respective owners.
16//
17// Redistribution and use in source and binary forms, with or without modification,
18// are permitted provided that the following conditions are met:
19//
20//   * Redistribution's of source code must retain the above copyright notice,
21//     this list of conditions and the following disclaimer.
22//
23//   * Redistribution's in binary form must reproduce the above copyright notice,
24//     this list of conditions and the following disclaimer in the documentation
25//     and/or other materials provided with the distribution.
26//
27//   * The name of the copyright holders may not be used to endorse or promote products
28//     derived from this software without specific prior written permission.
29//
30// This software is provided by the copyright holders and contributors "as is" and
31// any express or implied warranties, including, but not limited to, the implied
32// warranties of merchantability and fitness for a particular purpose are disclaimed.
33// In no event shall the Intel Corporation or contributors be liable for any direct,
34// indirect, incidental, special, exemplary, or consequential damages
35// (including, but not limited to, procurement of substitute goods or services;
36// loss of use, data, or profits; or business interruption) however caused
37// and on any theory of liability, whether in contract, strict liability,
38// or tort (including negligence or otherwise) arising in any way out of
39// the use of this software, even if advised of the possibility of such damage.
40//
41//M*/
42
43#ifndef _GRFMT_BASE_H_
44#define _GRFMT_BASE_H_
45
46#include "utils.hpp"
47#include "bitstrm.hpp"
48
49namespace cv
50{
51
52class BaseImageDecoder;
53class BaseImageEncoder;
54typedef Ptr<BaseImageEncoder> ImageEncoder;
55typedef Ptr<BaseImageDecoder> ImageDecoder;
56
57///////////////////////////////// base class for decoders ////////////////////////
58class BaseImageDecoder
59{
60public:
61    BaseImageDecoder();
62    virtual ~BaseImageDecoder() {}
63
64    int width() const { return m_width; }
65    int height() const { return m_height; }
66    virtual int type() const { return m_type; }
67
68    virtual bool setSource( const String& filename );
69    virtual bool setSource( const Mat& buf );
70    virtual bool readHeader() = 0;
71    virtual bool readData( Mat& img ) = 0;
72
73    /// Called after readData to advance to the next page, if any.
74    virtual bool nextPage() { return false; }
75
76    virtual size_t signatureLength() const;
77    virtual bool checkSignature( const String& signature ) const;
78    virtual ImageDecoder newDecoder() const;
79
80protected:
81    int  m_width;  // width  of the image ( filled by readHeader )
82    int  m_height; // height of the image ( filled by readHeader )
83    int  m_type;
84    String m_filename;
85    String m_signature;
86    Mat m_buf;
87    bool m_buf_supported;
88};
89
90
91///////////////////////////// base class for encoders ////////////////////////////
92class BaseImageEncoder
93{
94public:
95    BaseImageEncoder();
96    virtual ~BaseImageEncoder() {}
97    virtual bool isFormatSupported( int depth ) const;
98
99    virtual bool setDestination( const String& filename );
100    virtual bool setDestination( std::vector<uchar>& buf );
101    virtual bool write( const Mat& img, const std::vector<int>& params ) = 0;
102
103    virtual String getDescription() const;
104    virtual ImageEncoder newEncoder() const;
105
106    virtual void throwOnEror() const;
107
108protected:
109    String m_description;
110
111    String m_filename;
112    std::vector<uchar>* m_buf;
113    bool m_buf_supported;
114
115    String m_last_error;
116};
117
118}
119
120#endif/*_GRFMT_BASE_H_*/
121