/usr/include/libopenshot/TextReader.h is in libopenshot-dev 0.1.9+dfsg1-3build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 | /**
* @file
* @brief Header file for TextReader class
* @author Jonathan Thomas <jonathan@openshot.org>
*
* @section LICENSE
*
* Copyright (c) 2008-2014 OpenShot Studios, LLC
* <http://www.openshotstudios.com/>. This file is part of
* OpenShot Library (libopenshot), an open-source project dedicated to
* delivering high quality video editing and animation solutions to the
* world. For more information visit <http://www.openshot.org/>.
*
* OpenShot Library (libopenshot) is free software: you can redistribute it
* and/or modify it under the terms of the GNU Lesser General Public License
* as published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* OpenShot Library (libopenshot) is distributed in the hope that it will be
* useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with OpenShot Library. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef OPENSHOT_TEXT_READER_H
#define OPENSHOT_TEXT_READER_H
#include "ReaderBase.h"
#include <cmath>
#include <ctime>
#include <iostream>
#include <omp.h>
#include <stdio.h>
#include <memory>
#include "Magick++.h"
#include "CacheMemory.h"
#include "Enums.h"
#include "Exceptions.h"
using namespace std;
namespace openshot
{
/**
* @brief This class uses the ImageMagick++ libraries, to create frames with "Text", and return
* openshot::Frame objects.
*
* All system fonts are supported, including many different font properties, such as size, color,
* alignment, padding, etc...
*
* @code
* // Create a reader to generate an openshot::Frame containing text
* TextReader r(720, // width
* 480, // height
* 5, // x_offset
* 5, // y_offset
* GRAVITY_CENTER, // gravity
* "Check out this Text!", // text
* "Arial", // font
* 15.0, // size
* "#fff000", // text_color
* "#000000" // background_color
* );
* r.Open(); // Open the reader
*
* // Get frame number 1 from the video (in fact, any frame # you request will return the same frame)
* std::shared_ptr<Frame> f = r.GetFrame(1);
*
* // Now that we have an openshot::Frame object, lets have some fun!
* f->Display(); // Display the frame on the screen
*
* // Close the reader
* r.Close();
* @endcode
*/
class TextReader : public ReaderBase
{
private:
int width;
int height;
int x_offset;
int y_offset;
string text;
string font;
double size;
string text_color;
string background_color;
std::shared_ptr<Magick::Image> image;
list<Magick::Drawable> lines;
bool is_open;
GravityType gravity;
public:
/// Default constructor (blank text)
TextReader();
/// @brief Constructor for TextReader with all parameters.
/// @param width The width of the requested openshot::Frame (not the size of the text)
/// @param height The height of the requested openshot::Frame (not the size of the text)
/// @param x_offset The number of pixels to offset the text on the X axis (horizontal)
/// @param y_offset The number of pixels to offset the text on the Y axis (vertical)
/// @param gravity The alignment / gravity of the text
/// @param text The text you want to generate / display
/// @param font The font of the text
/// @param size The size of the text
/// @param text_color The color of the text
/// @param background_color The background color of the text (also supports Transparent)
TextReader(int width, int height, int x_offset, int y_offset, GravityType gravity, string text, string font, double size, string text_color, string background_color);
/// Close Reader
void Close();
/// Get the cache object used by this reader (always returns NULL for this object)
CacheMemory* GetCache() { return NULL; };
/// Get an openshot::Frame object for a specific frame number of this reader. All numbers
/// return the same Frame, since they all share the same image data.
///
/// @returns The requested frame (containing the image)
/// @param requested_frame The frame number that is requested.
std::shared_ptr<Frame> GetFrame(int64_t requested_frame);
/// Determine if reader is open or closed
bool IsOpen() { return is_open; };
/// Return the type name of the class
string Name() { return "TextReader"; };
/// Get and Set JSON methods
string Json(); ///< Generate JSON string of this object
void SetJson(string value); ///< Load JSON string into this object
Json::Value JsonValue(); ///< Generate Json::JsonValue for this object
void SetJsonValue(Json::Value root); ///< Load Json::JsonValue into this object
/// Open Reader - which is called by the constructor automatically
void Open();
};
}
#endif
|