OpenShot Library | libopenshot  0.1.9
QtImageReader.h
Go to the documentation of this file.
1 /**
2  * @file
3  * @brief Header file for QtImageReader class
4  * @author Jonathan Thomas <jonathan@openshot.org>
5  *
6  * @section LICENSE
7  *
8  * Copyright (c) 2008-2014 OpenShot Studios, LLC
9  * <http://www.openshotstudios.com/>. This file is part of
10  * OpenShot Library (libopenshot), an open-source project dedicated to
11  * delivering high quality video editing and animation solutions to the
12  * world. For more information visit <http://www.openshot.org/>.
13  *
14  * OpenShot Library (libopenshot) is free software: you can redistribute it
15  * and/or modify it under the terms of the GNU Lesser General Public License
16  * as published by the Free Software Foundation, either version 3 of the
17  * License, or (at your option) any later version.
18  *
19  * OpenShot Library (libopenshot) is distributed in the hope that it will be
20  * useful, 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 Lesser General Public License
25  * along with OpenShot Library. If not, see <http://www.gnu.org/licenses/>.
26  */
27 
28 #ifndef OPENSHOT_QIMAGE_READER_H
29 #define OPENSHOT_QIMAGE_READER_H
30 
31 #include "ReaderBase.h"
32 
33 #include <cmath>
34 #include <ctime>
35 #include <iostream>
36 #include <omp.h>
37 #include <stdio.h>
38 #include <memory>
39 #include <QtCore/QString>
40 #include <QtGui/QImage>
41 #include <QtGui/QPainter>
42 #include "CacheMemory.h"
43 #include "Exceptions.h"
44 
45 using namespace std;
46 
47 namespace openshot
48 {
49 
50  /**
51  * @brief This class uses the Qt library, to open image files, and return
52  * openshot::Frame objects containing the image.
53  *
54  * @code
55  * // Create a reader for a video
56  * QtImageReader r("MyAwesomeImage.jpeg");
57  * r.Open(); // Open the reader
58  *
59  * // Get frame number 1 from the video
60  * std::shared_ptr<Frame> f = r.GetFrame(1);
61  *
62  * // Now that we have an openshot::Frame object, lets have some fun!
63  * f->Display(); // Display the frame on the screen
64  *
65  * // Close the reader
66  * r.Close();
67  * @endcode
68  */
69  class QtImageReader : public ReaderBase
70  {
71  private:
72  string path;
73  std::shared_ptr<QImage> image; ///> Original image (full quality)
74  std::shared_ptr<QImage> cached_image; ///> Scaled for performance
75  bool is_open;
76 
77  public:
78 
79  /// Constructor for QtImageReader. This automatically opens the media file and loads
80  /// frame 1, or it throws one of the following exceptions.
81  QtImageReader(string path);
82 
83  /// Constructor for QtImageReader. This only opens the media file to inspect it's properties
84  /// if inspect_reader=true. When not inspecting the media file, it's much faster, and useful
85  /// when you are inflating the object using JSON after instantiating it.
86  QtImageReader(string path, bool inspect_reader);
87 
88  /// Close File
89  void Close();
90 
91  /// Get the cache object used by this reader (always returns NULL for this object)
92  CacheMemory* GetCache() { return NULL; };
93 
94  /// Get an openshot::Frame object for a specific frame number of this reader. All numbers
95  /// return the same Frame, since they all share the same image data.
96  ///
97  /// @returns The requested frame (containing the image)
98  /// @param requested_frame The frame number that is requested.
99  std::shared_ptr<Frame> GetFrame(int64_t requested_frame);
100 
101  /// Determine if reader is open or closed
102  bool IsOpen() { return is_open; };
103 
104  /// Return the type name of the class
105  string Name() { return "QtImageReader"; };
106 
107  /// Get and Set JSON methods
108  string Json(); ///< Generate JSON string of this object
109  void SetJson(string value); ///< Load JSON string into this object
110  Json::Value JsonValue(); ///< Generate Json::JsonValue for this object
111  void SetJsonValue(Json::Value root); ///< Load Json::JsonValue into this object
112 
113  /// Set Max Image Size (used for performance optimization)
114  void SetMaxSize(int width, int height);
115 
116  /// Open File - which is called by the constructor automatically
117  void Open();
118  };
119 
120 }
121 
122 #endif
Header file for ReaderBase class.
CacheMemory * GetCache()
Get the cache object used by this reader (always returns NULL for this object)
Definition: QtImageReader.h:92
This abstract class is the base class, used by all readers in libopenshot.
Definition: ReaderBase.h:95
Header file for CacheMemory class.
Header file for all Exception classes.
string Name()
Return the type name of the class.
bool IsOpen()
Determine if reader is open or closed.
This namespace is the default namespace for all code in the openshot library.
This class uses the Qt library, to open image files, and return openshot::Frame objects containing th...
Definition: QtImageReader.h:69
This class is a memory-based cache manager for Frame objects.
Definition: CacheMemory.h:48