OpenShot Library | libopenshot  0.1.2
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 <tr1/memory>
39 #include <QtCore/QString>
40 #include <QtGui/QImage>
41 #include <QtGui/QPainter>
42 #include "Cache.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  * tr1::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  tr1::shared_ptr<QImage> image;
74  bool is_open;
75 
76  public:
77 
78  /// Constructor for QtImageReader. This automatically opens the media file and loads
79  /// frame 1, or it throws one of the following exceptions.
80  QtImageReader(string path) throw(InvalidFile);
81 
82  /// Close File
83  void Close();
84 
85  /// Get the cache object used by this reader (always returns NULL for this object)
86  Cache* GetCache() { return NULL; };
87 
88  /// Get an openshot::Frame object for a specific frame number of this reader. All numbers
89  /// return the same Frame, since they all share the same image data.
90  ///
91  /// @returns The requested frame (containing the image)
92  /// @param requested_frame The frame number that is requested.
93  tr1::shared_ptr<Frame> GetFrame(long int requested_frame) throw(ReaderClosed);
94 
95  /// Determine if reader is open or closed
96  bool IsOpen() { return is_open; };
97 
98  /// Return the type name of the class
99  string Name() { return "QtImageReader"; };
100 
101  /// Get and Set JSON methods
102  string Json(); ///< Generate JSON string of this object
103  void SetJson(string value) throw(InvalidJSON); ///< Load JSON string into this object
104  Json::Value JsonValue(); ///< Generate Json::JsonValue for this object
105  void SetJsonValue(Json::Value root) throw(InvalidFile); ///< Load Json::JsonValue into this object
106 
107  /// Open File - which is called by the constructor automatically
108  void Open() throw(InvalidFile);
109  };
110 
111 }
112 
113 #endif
Cache * GetCache()
Get the cache object used by this reader (always returns NULL for this object)
Definition: QtImageReader.h:86
Header file for ReaderBase class.
This abstract class is the base class, used by all readers in libopenshot.
Definition: ReaderBase.h:95
Exception when a reader is closed, and a frame is requested.
Definition: Exceptions.h:234
Header file for all Exception classes.
Exception for files that can not be found or opened.
Definition: Exceptions.h:132
string Name()
Return the type name of the class.
Definition: QtImageReader.h:99
Header file for Cache class.
This class is a cache manager for Frame objects.
Definition: Cache.h:55
bool IsOpen()
Determine if reader is open or closed.
Definition: QtImageReader.h:96
This namespace is the default namespace for all code in the openshot library.
Exception for invalid JSON.
Definition: Exceptions.h:152
This class uses the Qt library, to open image files, and return openshot::Frame objects containing th...
Definition: QtImageReader.h:69