This struct contains info about encoding a media file, such as height, width, frames per second, etc... More...

#include <WriterBase.h>

Collaboration diagram for openshot::WriterInfo:

Public Attributes
std::string	acodec
	The name of the audio codec used to encode / decode the video stream. More...

int	audio_bit_rate
	The bit rate of the audio stream (in bytes) More...

int	audio_stream_index
	The index of the audio stream. More...

openshot::Fraction	audio_timebase
	The audio timebase determines how long each audio packet should be played. More...

openshot::ChannelLayout	channel_layout
	The channel layout (mono, stereo, 5 point surround, etc...) More...

int	channels
	The number of audio channels used in the audio stream. More...

openshot::Fraction	display_ratio
	The ratio of width to height of the video stream (i.e. 640x480 has a ratio of 4/3) More...

float	duration
	Length of time (in seconds) More...

int64_t	file_size
	Size of file (in bytes) More...

openshot::Fraction	fps
	Frames per second, as a fraction (i.e. 24/1 = 24 fps) More...

bool	has_audio
	Determines if this file has an audio stream. More...

bool	has_single_image
	Determines if this file only contains a single image. More...

bool	has_video
	Determines if this file has a video stream. More...

int	height
	The height of the video (in pixels) More...

bool	interlaced_frame
	Are the contents of this frame interlaced. More...

std::map< std::string, std::string >	metadata
	An optional map/dictionary of video & audio metadata. More...

int	pixel_format
	The pixel format (i.e. YUV420P, RGB24, etc...) More...

openshot::Fraction	pixel_ratio
	The pixel ratio of the video stream as a fraction (i.e. some pixels are not square) More...

int	sample_rate
	The number of audio samples per second (44100 is a common sample rate) More...

bool	top_field_first
	Which interlaced field should be displayed first. More...

std::string	vcodec
	The name of the video codec used to encode / decode the video stream. More...

int	video_bit_rate
	The bit rate of the video stream (in bytes) More...

int64_t	video_length
	The number of frames in the video stream. More...

int	video_stream_index
	The index of the video stream. More...

openshot::Fraction	video_timebase
	The video timebase determines how long each frame stays on the screen. More...

int	width
	The width of the video (in pixels) More...

Detailed Description

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.

Definition at line 32 of file WriterBase.h.

Member Data Documentation

◆ acodec

std::string openshot::WriterInfo::acodec

The name of the audio codec used to encode / decode the video stream.

Definition at line 52 of file WriterBase.h.

Referenced by openshot::ChunkWriter::ChunkWriter(), openshot::WriterBase::CopyReaderInfo(), openshot::WriterBase::DisplayInfo(), openshot::WriterBase::JsonValue(), openshot::FFmpegWriter::SetAudioOptions(), openshot::WriterBase::SetJsonValue(), and openshot::WriterBase::WriterBase().

◆ audio_bit_rate

int openshot::WriterInfo::audio_bit_rate

The bit rate of the audio stream (in bytes)

Definition at line 53 of file WriterBase.h.

Referenced by openshot::WriterBase::CopyReaderInfo(), openshot::WriterBase::DisplayInfo(), openshot::WriterBase::JsonValue(), openshot::FFmpegWriter::SetAudioOptions(), openshot::WriterBase::SetJsonValue(), and openshot::WriterBase::WriterBase().

◆ audio_stream_index

int openshot::WriterInfo::audio_stream_index

The index of the audio stream.

Definition at line 57 of file WriterBase.h.

Referenced by openshot::WriterBase::CopyReaderInfo(), openshot::WriterBase::DisplayInfo(), openshot::WriterBase::JsonValue(), openshot::WriterBase::SetJsonValue(), and openshot::WriterBase::WriterBase().

◆ audio_timebase

openshot::Fraction openshot::WriterInfo::audio_timebase

The audio timebase determines how long each audio packet should be played.

Definition at line 58 of file WriterBase.h.

Referenced by openshot::WriterBase::CopyReaderInfo(), openshot::WriterBase::DisplayInfo(), openshot::WriterBase::JsonValue(), openshot::WriterBase::SetJsonValue(), and openshot::WriterBase::WriterBase().

◆ channel_layout

openshot::ChannelLayout openshot::WriterInfo::channel_layout

The channel layout (mono, stereo, 5 point surround, etc...)

Definition at line 56 of file WriterBase.h.

Referenced by openshot::WriterBase::CopyReaderInfo(), openshot::WriterBase::DisplayInfo(), openshot::WriterBase::JsonValue(), openshot::FFmpegWriter::SetAudioOptions(), openshot::WriterBase::SetJsonValue(), openshot::ChunkWriter::WriteFrame(), and openshot::WriterBase::WriterBase().

◆ channels

int openshot::WriterInfo::channels

The number of audio channels used in the audio stream.

Definition at line 55 of file WriterBase.h.

Referenced by openshot::WriterBase::CopyReaderInfo(), openshot::WriterBase::DisplayInfo(), openshot::WriterBase::JsonValue(), openshot::FFmpegWriter::SetAudioOptions(), openshot::WriterBase::SetJsonValue(), openshot::ChunkWriter::WriteFrame(), and openshot::WriterBase::WriterBase().

◆ display_ratio

openshot::Fraction openshot::WriterInfo::display_ratio

The ratio of width to height of the video stream (i.e. 640x480 has a ratio of 4/3)

Definition at line 45 of file WriterBase.h.

Referenced by openshot::WriterBase::CopyReaderInfo(), openshot::WriterBase::DisplayInfo(), openshot::WriterBase::JsonValue(), openshot::WriterBase::SetJsonValue(), openshot::ImageWriter::SetVideoOptions(), openshot::FFmpegWriter::SetVideoOptions(), and openshot::WriterBase::WriterBase().

◆ duration

float openshot::WriterInfo::duration

Length of time (in seconds)

Definition at line 37 of file WriterBase.h.

Referenced by openshot::WriterBase::CopyReaderInfo(), openshot::WriterBase::DisplayInfo(), openshot::WriterBase::JsonValue(), openshot::WriterBase::SetJsonValue(), and openshot::WriterBase::WriterBase().

◆ file_size

int64_t openshot::WriterInfo::file_size

Size of file (in bytes)

Definition at line 38 of file WriterBase.h.

Referenced by openshot::WriterBase::CopyReaderInfo(), openshot::WriterBase::DisplayInfo(), openshot::WriterBase::JsonValue(), openshot::WriterBase::SetJsonValue(), and openshot::WriterBase::WriterBase().

◆ fps

openshot::Fraction openshot::WriterInfo::fps

Frames per second, as a fraction (i.e. 24/1 = 24 fps)

Definition at line 42 of file WriterBase.h.

Referenced by openshot::WriterBase::CopyReaderInfo(), openshot::WriterBase::DisplayInfo(), openshot::WriterBase::JsonValue(), openshot::WriterBase::SetJsonValue(), openshot::ImageWriter::SetVideoOptions(), openshot::FFmpegWriter::SetVideoOptions(), openshot::ChunkWriter::WriteFrame(), and openshot::WriterBase::WriterBase().

◆ has_audio

bool openshot::WriterInfo::has_audio

Determines if this file has an audio stream.

Definition at line 35 of file WriterBase.h.

Referenced by openshot::WriterBase::CopyReaderInfo(), openshot::WriterBase::DisplayInfo(), openshot::FFmpegWriter::FFmpegWriter(), openshot::ImageWriter::ImageWriter(), openshot::WriterBase::JsonValue(), openshot::FFmpegWriter::Open(), openshot::FFmpegWriter::PrepareStreams(), openshot::FFmpegWriter::SetAudioOptions(), openshot::WriterBase::SetJsonValue(), openshot::FFmpegWriter::SetOption(), openshot::FFmpegWriter::WriteHeader(), openshot::WriterBase::WriterBase(), and openshot::FFmpegWriter::WriteTrailer().

◆ has_single_image

bool openshot::WriterInfo::has_single_image

Determines if this file only contains a single image.

Definition at line 36 of file WriterBase.h.

Referenced by openshot::WriterBase::CopyReaderInfo(), openshot::WriterBase::DisplayInfo(), openshot::WriterBase::JsonValue(), openshot::WriterBase::SetJsonValue(), and openshot::WriterBase::WriterBase().

◆ has_video

bool openshot::WriterInfo::has_video

Determines if this file has a video stream.

Definition at line 34 of file WriterBase.h.

Referenced by openshot::WriterBase::CopyReaderInfo(), openshot::WriterBase::DisplayInfo(), openshot::FFmpegWriter::FFmpegWriter(), openshot::ImageWriter::ImageWriter(), openshot::WriterBase::JsonValue(), openshot::FFmpegWriter::Open(), openshot::FFmpegWriter::PrepareStreams(), openshot::WriterBase::SetJsonValue(), openshot::FFmpegWriter::SetOption(), openshot::FFmpegWriter::SetVideoOptions(), openshot::FFmpegWriter::WriteHeader(), and openshot::WriterBase::WriterBase().

◆ height

int openshot::WriterInfo::height

The height of the video (in pixels)

Definition at line 39 of file WriterBase.h.

Referenced by openshot::WriterBase::CopyReaderInfo(), openshot::WriterBase::DisplayInfo(), openshot::WriterBase::JsonValue(), openshot::WriterBase::SetJsonValue(), openshot::ImageWriter::SetVideoOptions(), openshot::FFmpegWriter::SetVideoOptions(), openshot::ImageWriter::WriteFrame(), openshot::ChunkWriter::WriteFrame(), and openshot::WriterBase::WriterBase().

◆ interlaced_frame

bool openshot::WriterInfo::interlaced_frame

Are the contents of this frame interlaced.

Definition at line 50 of file WriterBase.h.

Referenced by openshot::WriterBase::CopyReaderInfo(), openshot::WriterBase::DisplayInfo(), openshot::WriterBase::JsonValue(), openshot::WriterBase::SetJsonValue(), openshot::FFmpegWriter::SetOption(), openshot::FFmpegWriter::SetVideoOptions(), and openshot::WriterBase::WriterBase().

◆ metadata

std::map<std::string, std::string> openshot::WriterInfo::metadata

An optional map/dictionary of video & audio metadata.

Definition at line 59 of file WriterBase.h.

Referenced by openshot::FFmpegWriter::WriteHeader().

◆ pixel_format

int openshot::WriterInfo::pixel_format

The pixel format (i.e. YUV420P, RGB24, etc...)

Definition at line 41 of file WriterBase.h.

Referenced by openshot::WriterBase::CopyReaderInfo(), openshot::WriterBase::DisplayInfo(), openshot::WriterBase::JsonValue(), openshot::WriterBase::SetJsonValue(), and openshot::WriterBase::WriterBase().

◆ pixel_ratio

openshot::Fraction openshot::WriterInfo::pixel_ratio

The pixel ratio of the video stream as a fraction (i.e. some pixels are not square)

Definition at line 44 of file WriterBase.h.

Referenced by openshot::WriterBase::CopyReaderInfo(), openshot::WriterBase::DisplayInfo(), openshot::WriterBase::JsonValue(), openshot::WriterBase::SetJsonValue(), openshot::ImageWriter::SetVideoOptions(), openshot::FFmpegWriter::SetVideoOptions(), openshot::ChunkWriter::WriteFrame(), and openshot::WriterBase::WriterBase().

◆ sample_rate

int openshot::WriterInfo::sample_rate

The number of audio samples per second (44100 is a common sample rate)

Definition at line 54 of file WriterBase.h.

Referenced by openshot::WriterBase::CopyReaderInfo(), openshot::WriterBase::DisplayInfo(), openshot::WriterBase::JsonValue(), openshot::FFmpegWriter::SetAudioOptions(), openshot::WriterBase::SetJsonValue(), openshot::ChunkWriter::WriteFrame(), and openshot::WriterBase::WriterBase().

◆ top_field_first

bool openshot::WriterInfo::top_field_first

Which interlaced field should be displayed first.

Definition at line 51 of file WriterBase.h.

Referenced by openshot::WriterBase::CopyReaderInfo(), openshot::WriterBase::DisplayInfo(), openshot::WriterBase::JsonValue(), openshot::WriterBase::SetJsonValue(), openshot::FFmpegWriter::SetOption(), openshot::FFmpegWriter::SetVideoOptions(), and openshot::WriterBase::WriterBase().

◆ vcodec

std::string openshot::WriterInfo::vcodec

The name of the video codec used to encode / decode the video stream.

Definition at line 46 of file WriterBase.h.

Referenced by openshot::ChunkWriter::ChunkWriter(), openshot::WriterBase::CopyReaderInfo(), openshot::WriterBase::DisplayInfo(), openshot::WriterBase::JsonValue(), openshot::WriterBase::SetJsonValue(), openshot::FFmpegWriter::SetOption(), openshot::ImageWriter::SetVideoOptions(), openshot::FFmpegWriter::SetVideoOptions(), openshot::ImageWriter::WriteFrame(), and openshot::WriterBase::WriterBase().

◆ video_bit_rate

int openshot::WriterInfo::video_bit_rate

The bit rate of the video stream (in bytes)

Definition at line 43 of file WriterBase.h.

Referenced by openshot::WriterBase::CopyReaderInfo(), openshot::WriterBase::DisplayInfo(), openshot::WriterBase::JsonValue(), openshot::WriterBase::SetJsonValue(), openshot::FFmpegWriter::SetOption(), openshot::ImageWriter::SetVideoOptions(), openshot::FFmpegWriter::SetVideoOptions(), openshot::ChunkWriter::WriteFrame(), and openshot::WriterBase::WriterBase().

◆ video_length

int64_t openshot::WriterInfo::video_length

The number of frames in the video stream.

Definition at line 47 of file WriterBase.h.

Referenced by openshot::WriterBase::CopyReaderInfo(), openshot::WriterBase::DisplayInfo(), openshot::WriterBase::JsonValue(), openshot::WriterBase::SetJsonValue(), and openshot::WriterBase::WriterBase().

◆ video_stream_index

int openshot::WriterInfo::video_stream_index

The index of the video stream.

Definition at line 48 of file WriterBase.h.

Referenced by openshot::WriterBase::CopyReaderInfo(), openshot::WriterBase::DisplayInfo(), openshot::WriterBase::JsonValue(), openshot::WriterBase::SetJsonValue(), and openshot::WriterBase::WriterBase().

◆ video_timebase

openshot::Fraction openshot::WriterInfo::video_timebase

The video timebase determines how long each frame stays on the screen.

Definition at line 49 of file WriterBase.h.

Referenced by openshot::WriterBase::CopyReaderInfo(), openshot::WriterBase::DisplayInfo(), openshot::WriterBase::JsonValue(), openshot::WriterBase::SetJsonValue(), openshot::ImageWriter::SetVideoOptions(), openshot::FFmpegWriter::SetVideoOptions(), openshot::ImageWriter::WriteFrame(), and openshot::WriterBase::WriterBase().

◆ width

int openshot::WriterInfo::width

The width of the video (in pixels)

Definition at line 40 of file WriterBase.h.

Referenced by openshot::WriterBase::CopyReaderInfo(), openshot::WriterBase::DisplayInfo(), openshot::WriterBase::JsonValue(), openshot::WriterBase::SetJsonValue(), openshot::ImageWriter::SetVideoOptions(), openshot::FFmpegWriter::SetVideoOptions(), openshot::ImageWriter::WriteFrame(), openshot::ChunkWriter::WriteFrame(), and openshot::WriterBase::WriterBase().

The documentation for this struct was generated from the following file:

WriterBase.h

Public Attributes

Detailed Description

Member Data Documentation

◆ acodec

◆ audio_bit_rate

◆ audio_stream_index

◆ audio_timebase

◆ channel_layout

◆ channels

◆ display_ratio

◆ duration

◆ file_size

◆ fps

◆ has_audio

◆ has_single_image

◆ has_video

◆ height

◆ interlaced_frame

◆ metadata

◆ pixel_format

◆ pixel_ratio

◆ sample_rate

◆ top_field_first

◆ vcodec

◆ video_bit_rate

◆ video_length

◆ video_stream_index

◆ video_timebase

◆ width