WriterBase.h
Go to the documentation of this file.
/**
* @file
* @brief Header file for WriterBase class
* @author Jonathan Thomas <jonathan@openshot.org>
*
* @ref License
*/
/* LICENSE
*
* Copyright (c) 2008-2019 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_WRITER_BASE_H
#define OPENSHOT_WRITER_BASE_H
#include <iostream>
#include <iomanip>
#include "ChannelLayouts.h"
#include "Fraction.h"
#include "Frame.h"
#include "ReaderBase.h"
#include "ZmqLogger.h"
namespace openshot
{
/**
* @brief This struct contains info about encoding a media file, such as height, width, frames per second, etc...
*
* Each derived class of WriterBase is responsible for updating this struct to reflect accurate information
* about the streams.
*/
struct WriterInfo
{
bool has_video; ///< Determines if this file has a video stream
bool has_audio; ///< Determines if this file has an audio stream
bool has_single_image; ///< Determines if this file only contains a single image
float duration; ///< Length of time (in seconds)
int64_t file_size; ///< Size of file (in bytes)
int height; ///< The height of the video (in pixels)
int width; ///< The width of the video (in pixels)
int pixel_format; ///< The pixel format (i.e. YUV420P, RGB24, etc...)
openshot::Fraction fps; ///< Frames per second, as a fraction (i.e. 24/1 = 24 fps)
int video_bit_rate; ///< The bit rate of the video stream (in bytes)
openshot::Fraction pixel_ratio; ///< The pixel ratio of the video stream as a fraction (i.e. some pixels are not square)
openshot::Fraction display_ratio; ///< The ratio of width to height of the video stream (i.e. 640x480 has a ratio of 4/3)
std::string vcodec; ///< The name of the video codec used to encode / decode the video stream
int64_t video_length; ///< The number of frames in the video stream
int video_stream_index; ///< The index of the video stream
openshot::Fraction video_timebase; ///< The video timebase determines how long each frame stays on the screen
bool interlaced_frame; ///< Are the contents of this frame interlaced
bool top_field_first; ///< Which interlaced field should be displayed first
std::string acodec; ///< The name of the audio codec used to encode / decode the video stream
int audio_bit_rate; ///< The bit rate of the audio stream (in bytes)
int sample_rate; ///< The number of audio samples per second (44100 is a common sample rate)
int channels; ///< The number of audio channels used in the audio stream
openshot::ChannelLayout channel_layout; ///< The channel layout (mono, stereo, 5 point surround, etc...)
int audio_stream_index; ///< The index of the audio stream
openshot::Fraction audio_timebase; ///< The audio timebase determines how long each audio packet should be played
std::map<std::string, std::string> metadata; ///< An optional map/dictionary of video & audio metadata
};
/**
* @brief This abstract class is the base class, used by writers. Writers are types of classes that encode
* video, audio, and image files.
*
* The only requirements for a 'writer', are to derive from this base class, and implement the
* WriteFrame method.
*/
class WriterBase
{
public:
/// Constructor for WriterBase class, many things are initialized here
WriterBase();
/// Information about the current media file
WriterInfo info;
/// @brief This method copy's the info struct of a reader, and sets the writer with the same info
/// @param reader The source reader to copy
void CopyReaderInfo(openshot::ReaderBase* reader);
/// Determine if writer is open or closed
virtual bool IsOpen() = 0;
/// This method is required for all derived classes of WriterBase. Write a Frame to the video file.
virtual void WriteFrame(std::shared_ptr<openshot::Frame> frame) = 0;
/// This method is required for all derived classes of WriterBase. Write a block of frames from a reader.
virtual void WriteFrame(openshot::ReaderBase* reader, int64_t start, int64_t length) = 0;
/// Get and Set JSON methods
std::string Json() const; ///< Generate JSON string of this object
Json::Value JsonValue() const; ///< Generate Json::Value for this object
void SetJson(const std::string value); ///< Load JSON string into this object
void SetJsonValue(const Json::Value root); ///< Load Json::Value into this object
/// Display file information in the standard output stream (stdout)
void DisplayInfo();
/// Open the writer (and start initializing streams)
virtual void Open() = 0;
virtual ~WriterBase() = default;
};
}
#endif
ChannelLayouts.h
Header file for ChannelLayout class.
Fraction.h
Header file for Fraction class.
Frame.h
Header file for Frame class.
ReaderBase.h
Header file for ReaderBase class.
ZmqLogger.h
Header file for ZeroMQ-based Logger class.
openshot::Fraction
This class represents a fraction.
Definition: Fraction.h:45
openshot::ReaderBase
This abstract class is the base class, used by all readers in libopenshot.
Definition: ReaderBase.h:98
openshot::WriterBase
This abstract class is the base class, used by writers. Writers are types of classes that encode vide...
Definition: WriterBase.h:88
openshot::WriterBase::CopyReaderInfo
void CopyReaderInfo(openshot::ReaderBase *reader)
This method copy's the info struct of a reader, and sets the writer with the same info.
Definition: WriterBase.cpp:67
openshot::WriterBase::~WriterBase
virtual ~WriterBase()=default
openshot::WriterBase::Json
std::string Json() const
Get and Set JSON methods.
Definition: WriterBase.cpp:142
openshot::WriterBase::DisplayInfo
void DisplayInfo()
Display file information in the standard output stream (stdout)
Definition: WriterBase.cpp:102
openshot::WriterBase::WriteFrame
virtual void WriteFrame(std::shared_ptr< openshot::Frame > frame)=0
This method is required for all derived classes of WriterBase. Write a Frame to the video file.
openshot::WriterBase::WriteFrame
virtual void WriteFrame(openshot::ReaderBase *reader, int64_t start, int64_t length)=0
This method is required for all derived classes of WriterBase. Write a block of frames from a reader.
openshot::WriterBase::Open
virtual void Open()=0
Open the writer (and start initializing streams)
openshot::WriterBase::SetJsonValue
void SetJsonValue(const Json::Value root)
Load Json::Value into this object.
Definition: WriterBase.cpp:215
openshot::WriterBase::JsonValue
Json::Value JsonValue() const
Generate Json::Value for this object.
Definition: WriterBase.cpp:149
openshot::WriterBase::IsOpen
virtual bool IsOpen()=0
Determine if writer is open or closed.
openshot::WriterBase::info
WriterInfo info
Information about the current media file.
Definition: WriterBase.h:94
openshot::WriterBase::SetJson
void SetJson(const std::string value)
Load JSON string into this object.
Definition: WriterBase.cpp:198
openshot::WriterBase::WriterBase
WriterBase()
Constructor for WriterBase class, many things are initialized here.
Definition: WriterBase.cpp:36
openshot
This namespace is the default namespace for all code in the openshot library.
Definition: AudioBufferSource.h:39
openshot::ChannelLayout
ChannelLayout
This enumeration determines the audio channel layout (such as stereo, mono, 5 point surround,...
Definition: ChannelLayouts.h:47
openshot::WriterInfo
This struct contains info about encoding a media file, such as height, width, frames per second,...
Definition: WriterBase.h:51
openshot::WriterInfo::height
int height
The height of the video (in pixels)
Definition: WriterBase.h:57
openshot::WriterInfo::audio_bit_rate
int audio_bit_rate
The bit rate of the audio stream (in bytes)
Definition: WriterBase.h:71
openshot::WriterInfo::video_bit_rate
int video_bit_rate
The bit rate of the video stream (in bytes)
Definition: WriterBase.h:61
openshot::WriterInfo::has_audio
bool has_audio
Determines if this file has an audio stream.
Definition: WriterBase.h:53
openshot::WriterInfo::video_length
int64_t video_length
The number of frames in the video stream.
Definition: WriterBase.h:65
openshot::WriterInfo::pixel_format
int pixel_format
The pixel format (i.e. YUV420P, RGB24, etc...)
Definition: WriterBase.h:59
openshot::WriterInfo::top_field_first
bool top_field_first
Which interlaced field should be displayed first.
Definition: WriterBase.h:69
openshot::WriterInfo::duration
float duration
Length of time (in seconds)
Definition: WriterBase.h:55
openshot::WriterInfo::channels
int channels
The number of audio channels used in the audio stream.
Definition: WriterBase.h:73
openshot::WriterInfo::vcodec
std::string vcodec
The name of the video codec used to encode / decode the video stream.
Definition: WriterBase.h:64
openshot::WriterInfo::has_video
bool has_video
Determines if this file has a video stream.
Definition: WriterBase.h:52
openshot::WriterInfo::audio_stream_index
int audio_stream_index
The index of the audio stream.
Definition: WriterBase.h:75
openshot::WriterInfo::metadata
std::map< std::string, std::string > metadata
An optional map/dictionary of video & audio metadata.
Definition: WriterBase.h:77
openshot::WriterInfo::fps
openshot::Fraction fps
Frames per second, as a fraction (i.e. 24/1 = 24 fps)
Definition: WriterBase.h:60
openshot::WriterInfo::acodec
std::string acodec
The name of the audio codec used to encode / decode the video stream.
Definition: WriterBase.h:70
openshot::WriterInfo::audio_timebase
openshot::Fraction audio_timebase
The audio timebase determines how long each audio packet should be played.
Definition: WriterBase.h:76
openshot::WriterInfo::video_timebase
openshot::Fraction video_timebase
The video timebase determines how long each frame stays on the screen.
Definition: WriterBase.h:67
openshot::WriterInfo::video_stream_index
int video_stream_index
The index of the video stream.
Definition: WriterBase.h:66
openshot::WriterInfo::channel_layout
openshot::ChannelLayout channel_layout
The channel layout (mono, stereo, 5 point surround, etc...)
Definition: WriterBase.h:74
openshot::WriterInfo::display_ratio
openshot::Fraction display_ratio
The ratio of width to height of the video stream (i.e. 640x480 has a ratio of 4/3)
Definition: WriterBase.h:63
openshot::WriterInfo::width
int width
The width of the video (in pixels)
Definition: WriterBase.h:58
openshot::WriterInfo::pixel_ratio
openshot::Fraction pixel_ratio
The pixel ratio of the video stream as a fraction (i.e. some pixels are not square)
Definition: WriterBase.h:62
openshot::WriterInfo::has_single_image
bool has_single_image
Determines if this file only contains a single image.
Definition: WriterBase.h:54
openshot::WriterInfo::sample_rate
int sample_rate
The number of audio samples per second (44100 is a common sample rate)
Definition: WriterBase.h:72
openshot::WriterInfo::interlaced_frame
bool interlaced_frame
Are the contents of this frame interlaced.
Definition: WriterBase.h:68
openshot::WriterInfo::file_size
int64_t file_size
Size of file (in bytes)
Definition: WriterBase.h:56