OpenShot Library | libopenshot
0.4.0
|
Go to the documentation of this file.
13 #ifndef OPENSHOT_WRITER_BASE_H
14 #define OPENSHOT_WRITER_BASE_H
86 virtual void WriteFrame(std::shared_ptr<openshot::Frame> frame) = 0;
92 std::string
Json()
const;
94 void SetJson(
const std::string value);
101 virtual void Open() = 0;
bool has_single_image
Determines if this file only contains a single image.
Header file for ChannelLayout class.
int64_t video_length
The number of frames in the video stream.
int video_bit_rate
The bit rate of the video stream (in bytes)
openshot::Fraction display_ratio
The ratio of width to height of the video stream (i.e. 640x480 has a ratio of 4/3)
Header file for Fraction class.
Json::Value JsonValue() const
Generate Json::Value for this object.
openshot::Fraction fps
Frames per second, as a fraction (i.e. 24/1 = 24 fps)
This namespace is the default namespace for all code in the openshot library.
virtual void Open()=0
Open the writer (and start initializing streams)
int audio_bit_rate
The bit rate of the audio stream (in bytes)
int channels
The number of audio channels used in the audio stream.
This class represents a fraction.
This struct contains info about encoding a media file, such as height, width, frames per second,...
int video_stream_index
The index of the video stream.
std::string Json() const
Generate JSON string of this object.
int width
The width of the video (in pixels)
std::string acodec
The name of the audio codec used to encode / decode the video stream.
virtual ~WriterBase()=default
openshot::Fraction video_timebase
The video timebase determines how long each frame stays on the screen.
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::Fraction pixel_ratio
The pixel ratio of the video stream as a fraction (i.e. some pixels are not square)
bool top_field_first
Which interlaced field should be displayed first.
int64_t file_size
Size of file (in bytes)
float duration
Length of time (in seconds)
openshot::ChannelLayout channel_layout
The channel layout (mono, stereo, 5 point surround, etc...)
std::map< std::string, std::string > metadata
An optional map/dictionary of video & audio metadata.
openshot::Fraction audio_timebase
The audio timebase determines how long each audio packet should be played.
int pixel_format
The pixel format (i.e. YUV420P, RGB24, etc...)
virtual bool IsOpen()=0
Determine if writer is open or closed.
bool has_video
Determines if this file has a video stream.
bool has_audio
Determines if this file has an audio stream.
int height
The height of the video (in pixels)
void CopyReaderInfo(openshot::ReaderBase *reader)
This method copy's the info struct of a reader, and sets the writer with the same info.
void SetJsonValue(const Json::Value root)
Load Json::Value into this object.
This abstract class is the base class, used by all readers in libopenshot.
bool interlaced_frame
Are the contents of this frame interlaced.
std::string vcodec
The name of the video codec used to encode / decode the video stream.
int sample_rate
The number of audio samples per second (44100 is a common sample rate)
ChannelLayout
This enumeration determines the audio channel layout (such as stereo, mono, 5 point surround,...
Header file for JSON class.
int audio_stream_index
The index of the audio stream.
WriterInfo info
Information about the current media file.
void SetJson(const std::string value)
Load JSON string into this object.
void DisplayInfo(std::ostream *out=&std::cout)
Display file information in the standard output stream (stdout)
WriterBase()
Constructor for WriterBase class, many things are initialized here.
This abstract class is the base class, used by writers. Writers are types of classes that encode vide...