Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

WIP: add destructor to FFmpegWriter #429

Open
wants to merge 5 commits into
base: develop
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
72 changes: 60 additions & 12 deletions src/FFmpegWriter.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,10 @@ FFmpegWriter::FFmpegWriter(const std::string& path) :
auto_detect_format();
}

FFmpegWriter::~FFmpegWriter() {
free_resources();
}

// Open the writer
void FFmpegWriter::Open() {
if (!is_open) {
Expand Down Expand Up @@ -280,6 +284,7 @@ void FFmpegWriter::SetVideoOptions(bool has_video, std::string codec, Fraction f
info.display_ratio.den = size.den;

ZmqLogger::Instance()->AppendDebugMethod("FFmpegWriter::SetVideoOptions (" + codec + ")", "width", width, "height", height, "size.num", size.num, "size.den", size.den, "fps.num", fps.num, "fps.den", fps.den);
AV_FREE_CONTEXT(video_codec);

// Enable / Disable video
info.has_video = has_video;
Expand Down Expand Up @@ -1029,17 +1034,16 @@ void FFmpegWriter::close_audio(AVFormatContext *oc, AVStream *st)
}
}

// Close the writer
void FFmpegWriter::Close() {
// Write trailer (if needed)
if (!write_trailer)
WriteTrailer();

void FFmpegWriter::free_resources() {
// Close each codec
if (video_st)
if (video_st) {
close_video(oc, video_st);
if (audio_st)
video_st = NULL;
}
if (audio_st) {
close_audio(oc, audio_st);
audio_st = NULL;
}

// Deallocate image scalers
if (image_rescalers.size() > 0)
Expand All @@ -1050,14 +1054,57 @@ void FFmpegWriter::Close() {
avio_close(oc->pb);
}

// be sure to free any allocated AVFrames
for (auto pair : av_frames) {
AVFrame *frame = pair.second;
AV_FREE_FRAME(&frame);
}

spooled_audio_frames.clear();
spooled_video_frames.clear();
queued_audio_frames.clear();
queued_video_frames.clear();
processed_frames.clear();
deallocate_frames.clear();
av_frames.clear();

#if (LIBAVFORMAT_VERSION_MAJOR >= 58)
if (video_codec) {
AV_FREE_CONTEXT(video_codec);
video_codec = NULL;
}
if (audio_codec) {
AV_FREE_CONTEXT(audio_codec);
audio_codec = NULL;
}

#elif (LIBAVFORMAT_VERSION_MAJOR <= 55)
if (video_codec) {
AV_FREE_CONTEXT(video_codec);
video_codec = NULL;
}
if (audio_codec) {
AV_FREE_CONTEXT(audio_codec);
audio_codec = NULL;
}
#endif

if (oc) {
avformat_free_context(oc);
oc = NULL;
}
}

// Close the writer
void FFmpegWriter::Close() {
// Write trailer (if needed)
if (!write_trailer)
WriteTrailer();

// Reset frame counters
write_video_count = 0;
write_audio_count = 0;

// Free the context which frees the streams too
avformat_free_context(oc);
oc = NULL;

// Close writer
is_open = false;
prepare_streams = false;
Expand Down Expand Up @@ -2229,6 +2276,7 @@ void FFmpegWriter::InitScalers(int source_width, int source_height) {
scale_mode = SWS_BICUBIC;
}

SwsContext *img_convert_ctx;
// Init software rescalers vector (many of them, one for each thread)
for (int x = 0; x < num_of_rescalers; x++) {
// Init the software scaler from FFMpeg
Expand Down
3 changes: 3 additions & 0 deletions src/FFmpegWriter.h
Original file line number Diff line number Diff line change
Expand Up @@ -247,6 +247,7 @@ namespace openshot {
/// write all queued frames
void write_queued_frames();

void free_resources();
public:

/// @brief Constructor for FFmpegWriter.
Expand All @@ -255,6 +256,8 @@ namespace openshot {
/// @param path The file path of the video file you want to open and read
FFmpegWriter(const std::string& path);

~FFmpegWriter();

/// Close the writer
void Close();

Expand Down
76 changes: 73 additions & 3 deletions tests/FFmpegWriter_Tests.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ using namespace std;
using namespace openshot;

SUITE(FFMpegWriter) {

TEST(Webm)
{
// Reader
Expand All @@ -45,7 +46,7 @@ TEST(Webm)
FFmpegReader r(path.str());
r.Open();

/* WRITER ---------------- */
// Writer
FFmpegWriter w("output1.webm");

// Set options
Expand All @@ -65,7 +66,7 @@ TEST(Webm)
FFmpegReader r1("output1.webm");
r1.Open();

// Verify various settings on new MP4
// Verify various settings on new video
CHECK_EQUAL(2, r1.GetFrame(1)->GetAudioChannelsCount());
CHECK_EQUAL(24, r1.info.fps.num);
CHECK_EQUAL(1, r1.info.fps.den);
Expand All @@ -84,6 +85,28 @@ TEST(Webm)
CHECK_CLOSE(255, (int)pixels[pixel_index + 3], 5);
}

TEST(Destructor)
{
FFmpegWriter *w = new FFmpegWriter("output2.webm");

// Set video options (no audio)
w->SetVideoOptions(true, "libvpx", Fraction(24,1), 1280, 720, Fraction(1,1), false, false, 30000000);

// Dummy reader (30 FPS, 1280x720, 48kHz, 2-channel, 10.0 second duration)
DummyReader r(Fraction(30,1), 1280, 720, 48000, 2, 10.0);
r.Open();

// Open writer and write frames
w->Open();
w->WriteFrame(&r, 1, 25);

// Close and destroy writer
w->Close();
delete w;

CHECK(w == nullptr);
}

TEST(Options_Overloads)
{
// Reader
Expand All @@ -92,7 +115,7 @@ TEST(Options_Overloads)
FFmpegReader r(path.str());
r.Open();

/* WRITER ---------------- */
// Writer
FFmpegWriter w("output1.mp4");

// Set options
Expand Down Expand Up @@ -125,4 +148,51 @@ TEST(Options_Overloads)
CHECK_EQUAL(true, r1.info.top_field_first);
}

TEST(Close_and_reopen)
{
// Create a Reader source, to get some frames
stringstream path;
path << TEST_MEDIA_PATH << "sintel_trailer-720p.mp4";
FFmpegReader r(path.str());
r.Open();

// A Writer to dump the frames into
FFmpegWriter w("output2.mp4");

// Set options
w.SetAudioOptions("aac", 44100, 188000);
w.SetVideoOptions("libxvid", 720, 480, Fraction(30000, 1001), 5000000);

// Open writer
w.Open();

// Whoops, changed our mind
w.Close();

// Set different options
w.SetAudioOptions("aac", 48000, 192000);
w.SetVideoOptions("libx264", 1280, 720, Fraction(30, 1), 8000000);

// Reopen writer
w.Open();

// Write some frames
w.WriteFrame(&r, 45, 90);

// Close writer & reader
w.Close();
r.Close();

// Read back newly-written video
FFmpegReader r1("output2.mp4");
r1.Open();

// Verify new video's properties match the second Set___Options() calls
CHECK_EQUAL(48000, r1.GetFrame(1)->SampleRate());
CHECK_EQUAL(30, r1.info.fps.num);
CHECK_EQUAL(1, r1.info.fps.den);
CHECK_EQUAL(1280, r1.info.width);
CHECK_EQUAL(720, r1.info.height);
}

} // SUITE()