You've already forked libopenshot
mirror of
https://github.com/OpenShot/libopenshot.git
synced 2026-03-02 08:53:52 -08:00
59138ea3e4
* reuse-managed license/copyright headers reuse is a tool for compliance with the REUSE recommendations. See <https://reuse.software/> for more information, and <https://reuse.readthedocs.io/> for the online documentation. * Set jsoncpp license * Add MIT license for Decklink sources * Explicitly license examples/ - Add headers to source files - Change blanket licensing in .reuse/dep5 to only cover binary media - Import CC-BY-3.0 license and assign to sintel_trailer
130 lines
4.2 KiB
C++
130 lines
4.2 KiB
C++
/**
|
|
* @file
|
|
* @brief Header file for QtHtmlReader class
|
|
* @author Jonathan Thomas <jonathan@openshot.org>
|
|
* @author Sergei Kolesov (jediserg)
|
|
* @author Jeff Shillitto (jeffski)
|
|
*
|
|
* @ref License
|
|
*/
|
|
|
|
// Copyright (c) 2008-2019 OpenShot Studios, LLC
|
|
//
|
|
// SPDX-License-Identifier: LGPL-3.0-or-later
|
|
|
|
#ifndef OPENSHOT_QT_HTML_READER_H
|
|
#define OPENSHOT_QT_HTML_READER_H
|
|
|
|
#include "ReaderBase.h"
|
|
|
|
#include <cmath>
|
|
#include <ctime>
|
|
#include <iostream>
|
|
#include <omp.h>
|
|
#include <stdio.h>
|
|
#include <memory>
|
|
#include "CacheMemory.h"
|
|
#include "Enums.h"
|
|
|
|
|
|
class QImage;
|
|
|
|
namespace openshot
|
|
{
|
|
// Forward decls
|
|
class CacheBase;
|
|
|
|
/**
|
|
* @brief This class uses Qt libraries, to create frames with rendered HTML, and return
|
|
* openshot::Frame objects.
|
|
*
|
|
* Supports HTML/CSS subset available via Qt libraries, see: https://doc.qt.io/qt-5/richtext-html-subset.html
|
|
*
|
|
* @code
|
|
* // Any application using this class must instantiate either QGuiApplication or QApplication
|
|
* QApplication a(argc, argv);
|
|
*
|
|
* // Create a reader to generate an openshot::Frame containing text
|
|
* QtHtmlReader r(720, // width
|
|
* 480, // height
|
|
* 5, // x_offset
|
|
* 5, // y_offset
|
|
* GRAVITY_CENTER, // gravity
|
|
* "<b>Check out</b> this Text!", // html
|
|
* "b { color: #ff0000 }", // css
|
|
* "#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 QtHtmlReader : public ReaderBase
|
|
{
|
|
private:
|
|
int width;
|
|
int height;
|
|
int x_offset;
|
|
int y_offset;
|
|
std::string html;
|
|
std::string css;
|
|
std::string background_color;
|
|
std::shared_ptr<QImage> image;
|
|
bool is_open;
|
|
openshot::GravityType gravity;
|
|
public:
|
|
|
|
/// Default constructor (blank text)
|
|
QtHtmlReader();
|
|
|
|
/// @brief Constructor for QtHtmlReader 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 html The HTML you want to render / display
|
|
/// @param css The CSS you want to apply to style the HTML
|
|
/// @param background_color The background color of the frame image (valid values are a color string in \#RRGGBB or \#AARRGGBB notation, a CSS color name, or 'transparent')
|
|
QtHtmlReader(int width, int height, int x_offset, int y_offset, GravityType gravity, std::string html, std::string css, std::string background_color);
|
|
|
|
/// Close Reader
|
|
void Close() override;
|
|
|
|
/// Get the cache object used by this reader (always returns NULL for this object)
|
|
CacheBase* GetCache() override { 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<openshot::Frame> GetFrame(int64_t requested_frame) override;
|
|
|
|
/// Determine if reader is open or closed
|
|
bool IsOpen() override { return is_open; };
|
|
|
|
/// Return the type name of the class
|
|
std::string Name() override { return "QtHtmlReader"; };
|
|
|
|
// Get and Set JSON methods
|
|
std::string Json() const override; ///< Generate JSON string of this object
|
|
void SetJson(const std::string value) override; ///< Load JSON string into this object
|
|
Json::Value JsonValue() const override; ///< Generate Json::Value for this object
|
|
void SetJsonValue(const Json::Value root) override; ///< Load Json::Value into this object
|
|
|
|
/// Open Reader - which is called by the constructor automatically
|
|
void Open() override;
|
|
};
|
|
|
|
}
|
|
|
|
#endif
|