#include "EmberCommonPch.h"
#include "EmberAnimate.h"
#include "JpegUtils.h"
using namespace EmberCommon;
///
/// The core of the EmberAnimate.exe program.
/// Template argument expected to be float or double.
///
/// A populated EmberOptions object which specifies all program options to be used
/// True if success, else false.
template
bool EmberAnimate(EmberOptions& opt)
{
auto info = OpenCLInfo::Instance();
std::cout.imbue(std::locale(""));
if (opt.DumpArgs())
cout << opt.GetValues(eOptionUse::OPT_USE_ANIMATE) << "\n";
if (opt.OpenCLInfo())
{
cout << "\nOpenCL Info: \n";
cout << info->DumpInfo();
return true;
}
VerbosePrint("Using " << (sizeof(T) == sizeof(float) ? "single" : "double") << " precision.");
//Regular variables.
Timing t;
bool unsorted = false;
uint channels;
streamsize padding;
size_t i, firstUnsortedIndex = 0;
string inputPath = GetPath(opt.Input());
vector> embers;
XmlToEmber parser;
EmberToXml emberToXml;
Interpolater interpolater;
EmberReport emberReport;
const vector> devices = Devices(opt.Devices());
std::atomic atomfTime;
vector threadVec;
auto progress = make_unique>();
vector>> renderers;
vector errorReport;
std::recursive_mutex verboseCs;
if (opt.EmberCL())
{
renderers = CreateRenderers(eRendererType::OPENCL_RENDERER, devices, false, 0, emberReport);
errorReport = emberReport.ErrorReport();
if (!errorReport.empty())
emberReport.DumpErrorReport();
if (!renderers.size() || renderers.size() != devices.size())
{
cout << "Only created " << renderers.size() << " renderers out of " << devices.size() << " requested, exiting.\n";
return false;
}
if (opt.DoProgress())
renderers[0]->Callback(progress.get());
cout << "Using OpenCL to render.\n";
if (opt.Verbose())
{
for (auto& device : devices)
{
cout << "Platform: " << info->PlatformName(device.first) << "\n";
cout << "Device: " << info->DeviceName(device.first, device.second) << "\n";
}
}
if (opt.ThreadCount() > 1)
cout << "Cannot specify threads with OpenCL, using 1 thread.\n";
opt.ThreadCount(1);
if (opt.IsaacSeed().empty())
{
for (auto& r : renderers)
r->ThreadCount(opt.ThreadCount(), nullptr);
}
else
{
for (i = 0; i < renderers.size(); i++)
{
string ns;
auto& is = opt.IsaacSeed();
ns.reserve(is.size());
for (auto& c : is)
ns.push_back(c + char(i * opt.ThreadCount()));
renderers[i]->ThreadCount(opt.ThreadCount(), ns.c_str());
}
}
if (opt.BitsPerChannel() != 8)
{
cout << "Bits per channel cannot be anything other than 8 with OpenCL, setting to 8.\n";
opt.BitsPerChannel(8);
}
}
else
{
unique_ptr> tempRenderer(CreateRenderer(eRendererType::CPU_RENDERER, devices, false, 0, emberReport));
errorReport = emberReport.ErrorReport();
if (!errorReport.empty())
emberReport.DumpErrorReport();
if (!tempRenderer.get())
{
cout << "Renderer creation failed, exiting.\n";
return false;
}
if (opt.DoProgress())
tempRenderer->Callback(progress.get());
if (opt.ThreadCount() == 0)
{
cout << "Using " << Timing::ProcessorCount() << " automatically detected threads.\n";
opt.ThreadCount(Timing::ProcessorCount());
}
else
{
cout << "Using " << opt.ThreadCount() << " manually specified threads.\n";
}
tempRenderer->ThreadCount(opt.ThreadCount(), opt.IsaacSeed() != "" ? opt.IsaacSeed().c_str() : nullptr);
renderers.push_back(std::move(tempRenderer));
}
if (!InitPaletteList(opt.PalettePath()))//For any modern flames, the palette isn't used. This is for legacy purposes and should be removed.
return false;
cout << "Parsing ember file " << opt.Input() << "\n";
if (!ParseEmberFile(parser, opt.Input(), embers))
return false;
cout << "Finished parsing.\n";
if (embers.size() <= 1)
{
cout << "Read " << embers.size() << " embers from file. At least 2 required to animate, exiting.\n";
return false;
}
if (opt.Format() != "jpg" &&
opt.Format() != "png" &&
opt.Format() != "bmp")
{
cout << "Format must be jpg, png, or bmp not " << opt.Format() << ". Setting to jpg.\n";
}
channels = opt.Format() == "png" ? 4 : 3;
if (opt.BitsPerChannel() == 16 && opt.Format() != "png")
{
cout << "Support for 16 bits per channel images is only present for the png format. Setting to 8.\n";
opt.BitsPerChannel(8);
}
else if (opt.BitsPerChannel() != 8 && opt.BitsPerChannel() != 16)
{
cout << "Unexpected bits per channel specified " << opt.BitsPerChannel() << ". Setting to 8.\n";
opt.BitsPerChannel(8);
}
if (opt.AspectRatio() < 0)
{
cout << "Invalid pixel aspect ratio " << opt.AspectRatio() << "\n. Must be positive, setting to 1.\n";
opt.AspectRatio(1);
}
if (opt.Dtime() < 1)
{
cout << "Warning: dtime must be positive, not " << opt.Dtime() << ". Setting to 1.\n";
opt.Dtime(1);
}
if (opt.Frame() != UINT_MAX)
{
if (opt.FirstFrame() != UINT_MAX || opt.LastFrame() != UINT_MAX)
{
cout << "Cannot specify both frame and begin or end.\n";
return false;
}
opt.FirstFrame(opt.Frame());
opt.LastFrame(opt.Frame() + 1);
}
//Prep all embers, by ensuring they:
//-Are sorted by time.
//-Do not have a dimension of 0.
//-Do not have a memory requirement greater than max uint.
//-Have quality and size scales applied, if present.
//-Have equal dimensions.
for (i = 0; i < embers.size(); i++)
{
if (i > 0 && embers[i].m_Time <= embers[i - 1].m_Time)
{
if (!unsorted)
firstUnsortedIndex = i;
unsorted = true;
}
if (i > 0 && embers[i].m_Time == embers[i - 1].m_Time)
{
cout << "Image " << i << " time of " << embers[i].m_Time << " equaled previous image time of " << embers[i - 1].m_Time << ". Adjusting up by 1.\n";
embers[i].m_Time++;
}
if (opt.Supersample() > 0)
embers[i].m_Supersample = opt.Supersample();
if (opt.TemporalSamples() > 0)
embers[i].m_TemporalSamples = opt.TemporalSamples();
if (opt.Quality() > 0)
embers[i].m_Quality = T(opt.Quality());
if (opt.DeMin() > -1)
embers[i].m_MinRadDE = T(opt.DeMin());
if (opt.DeMax() > -1)
embers[i].m_MaxRadDE = T(opt.DeMax());
embers[i].m_Quality *= T(opt.QualityScale());
embers[i].m_FinalRasW = size_t(T(embers[i].m_FinalRasW) * opt.SizeScale());
embers[i].m_FinalRasH = size_t(T(embers[i].m_FinalRasH) * opt.SizeScale());
embers[i].m_PixelsPerUnit *= T(opt.SizeScale());
//Cast to double in case the value exceeds 2^32.
double imageMem = double(channels) * double(embers[i].m_FinalRasW)
* double(embers[i].m_FinalRasH) * double(renderers[0]->BytesPerChannel());
double maxMem = pow(2.0, double((sizeof(void*) * 8) - 1));
if (imageMem > maxMem)//Ensure the max amount of memory for a process isn't exceeded.
{
cout << "Image " << i << " size > " << maxMem << ". Setting to 1920 x 1080.\n";
embers[i].m_FinalRasW = 1920;
embers[i].m_FinalRasH = 1080;
}
if (embers[i].m_FinalRasW == 0 || embers[i].m_FinalRasH == 0)
{
cout << "Warning: Output image " << i << " has dimension 0: " << embers[i].m_FinalRasW << ", " << embers[i].m_FinalRasH << ". Setting to 1920 x 1080.\n";
embers[i].m_FinalRasW = 1920;
embers[i].m_FinalRasH = 1080;
}
if ((embers[i].m_FinalRasW != embers[0].m_FinalRasW) ||
(embers[i].m_FinalRasH != embers[0].m_FinalRasH))
{
cout << "Warning: flame " << i << " at time " << embers[i].m_Time << " size mismatch. (" << embers[i].m_FinalRasW << ", " << embers[i].m_FinalRasH <<
") should be (" << embers[0].m_FinalRasW << ", " << embers[0].m_FinalRasH << "). Setting to " << embers[0].m_FinalRasW << ", " << embers[0].m_FinalRasH << ".\n";
embers[i].m_FinalRasW = embers[0].m_FinalRasW;
embers[i].m_FinalRasH = embers[0].m_FinalRasH;
}
}
if (unsorted)
{
cout << "Embers were unsorted by time. First out of order index was " << firstUnsortedIndex << ". Sorting.\n";
std::sort(embers.begin(), embers.end(), &CompareEmbers);
}
if (opt.Frame() == UINT_MAX)
{
if (opt.FirstFrame() == UINT_MAX)
opt.FirstFrame(size_t(embers[0].m_Time));
if (opt.LastFrame() == UINT_MAX)
opt.LastFrame(ClampGte(size_t(embers.back().m_Time),
opt.FirstFrame() + opt.Dtime()));//Make sure the final value is at least first frame + dtime.
}
//Final setup steps before running.
padding = uint(std::log10(double(embers.size()))) + 1;
for (auto& r : renderers)
{
r->SetExternalEmbersPointer(&embers);//All will share a pointer to the original vector to conserve memory with large files. Ok because the vec doesn't get modified.
r->EarlyClip(opt.EarlyClip());
r->YAxisUp(opt.YAxisUp());
r->LockAccum(opt.LockAccum());
r->PixelAspectRatio(T(opt.AspectRatio()));
r->Transparency(opt.Transparency());
r->NumChannels(channels);
r->BytesPerChannel(opt.BitsPerChannel() / 8);
r->Priority(eThreadPriority(Clamp(intmax_t(opt.Priority()), intmax_t(eThreadPriority::LOWEST), intmax_t(eThreadPriority::HIGHEST))));
}
std::function&, string, EmberImageComments, size_t, size_t, size_t)> saveFunc = [&](vector& finalImage,
string filename,//These are copies because this will be launched in a thread.
EmberImageComments comments,
size_t w,
size_t h,
size_t chan)
{
bool writeSuccess = false;
byte* finalImagep = finalImage.data();
if ((opt.Format() == "jpg" || opt.Format() == "bmp") && chan == 4)
RgbaToRgb(finalImage, finalImage, w, h);
if (opt.Format() == "png")
writeSuccess = WritePng(filename.c_str(), finalImagep, w, h, opt.BitsPerChannel() / 8, opt.PngComments(), comments, opt.Id(), opt.Url(), opt.Nick());
else if (opt.Format() == "jpg")
writeSuccess = WriteJpeg(filename.c_str(), finalImagep, w, h, int(opt.JpegQuality()), opt.JpegComments(), comments, opt.Id(), opt.Url(), opt.Nick());
else if (opt.Format() == "bmp")
writeSuccess = WriteBmp(filename.c_str(), finalImagep, w, h);
if (!writeSuccess)
cout << "Error writing " << filename << "\n";
};
atomfTime.store(opt.FirstFrame());
std::function iterFunc = [&](size_t index)
{
size_t ftime, finalImageIndex = 0;
string filename, flameName;
RendererBase* renderer = renderers[index].get();
ostringstream fnstream, os;
EmberStats stats;
EmberImageComments comments;
Ember centerEmber;
vector finalImages[2];
std::thread writeThread;
os.imbue(std::locale(""));
//The conditions of this loop use atomics to synchronize when running on multiple GPUs.
//The order is reversed from the usual loop: rather than compare and increment the counter,
//it's incremented, then compared. This is done to ensure the GPU on this thread "claims" this
//frame before working on it.
//The mechanism for incrementing is:
// Do an atomic add, which returns the previous value.
// Add the time increment Dtime() to the return value to mimic what the new atomic value should be.
// Assign the result to the ftime counter.
// Do a <= comparison to LastFrame().
// If true, enter the loop and immediately decrement the counter by Dtime() to make up for the fact
// that it was first incremented before comparing.
while ((ftime = (atomfTime.fetch_add(opt.Dtime()) + opt.Dtime())) <= opt.LastFrame())
{
T localTime = T(ftime) - opt.Dtime();
if (opt.Verbose() && ((opt.LastFrame() - opt.FirstFrame()) / opt.Dtime() >= 1))
{
rlg l(verboseCs);
cout << "Time = " << ftime << " / " << opt.LastFrame() << " / " << opt.Dtime() << "\n";
}
renderer->Reset();
if ((renderer->Run(finalImages[finalImageIndex], localTime) != eRenderStatus::RENDER_OK) || renderer->Aborted() || finalImages[finalImageIndex].empty())
{
cout << "Error: image rendering failed, aborting.\n";
renderer->DumpErrorReport();//Something went wrong, print errors.
atomfTime.store(opt.LastFrame() + 1);//Abort all threads if any of them encounter an error.
break;
}
fnstream << inputPath << opt.Prefix() << setfill('0') << setprecision(0) << fixed << setw(padding) << ftime << opt.Suffix() << "." << opt.Format();
filename = fnstream.str();
fnstream.str("");
if (opt.WriteGenome())
{
flameName = filename.substr(0, filename.find_last_of('.')) + ".flam3";
if (opt.Verbose())
{
rlg l(verboseCs);
cout << "Writing " << flameName << "\n";
}
interpolater.Interpolate(embers, localTime, 0, centerEmber);//Get center flame.
emberToXml.Save(flameName, centerEmber, opt.PrintEditDepth(), true, opt.HexPalette(), true, false, false);
centerEmber.Clear();
}
stats = renderer->Stats();
comments = renderer->ImageComments(stats, opt.PrintEditDepth(), true);
os.str("");
size_t iterCount = renderer->TotalIterCount(1);
os << comments.m_NumIters << " / " << iterCount << " (" << std::fixed << std::setprecision(2) << ((double(stats.m_Iters) / double(iterCount)) * 100) << "%)";
if (opt.Verbose())
{
rlg l(verboseCs);
cout << "\nIters ran/requested: " + os.str() << "\n";
if (!opt.EmberCL()) cout << "Bad values: " << stats.m_Badvals << "\n";
cout << "Render time: " << t.Format(stats.m_RenderMs) << "\n";
cout << "Pure iter time: " << t.Format(stats.m_IterMs) << "\n";
cout << "Iters/sec: " << size_t(stats.m_Iters / (stats.m_IterMs / 1000.0)) << "\n";
cout << "Writing " << filename << "\n\n";
}
//Run image writing in a thread. Although doing it this way duplicates the final output memory, it saves a lot of time
//when running with OpenCL. Call join() to ensure the previous thread call has completed.
Join(writeThread);
auto threadVecIndex = finalImageIndex;//Cache before launching thread.
if (opt.ThreadedWrite())//Copies are passed of all but the first parameter to saveFunc(), to avoid conflicting with those values changing when starting the render for the next image.
{
writeThread = std::thread(saveFunc, std::ref(finalImages[threadVecIndex]), filename, comments, renderer->FinalRasW(), renderer->FinalRasH(), renderer->NumChannels());
finalImageIndex ^= 1;//Toggle the index.
}
else
saveFunc(finalImages[threadVecIndex], filename, comments, renderer->FinalRasW(), renderer->FinalRasH(), renderer->NumChannels());//Will always use the first index, thereby not requiring more memory.
}
Join(writeThread);//One final check to make sure all writing is done before exiting this thread.
};
threadVec.reserve(renderers.size());
for (size_t r = 0; r < renderers.size(); r++)
{
threadVec.push_back(std::thread([&](size_t dev)
{
iterFunc(dev);
}, r));
}
Join(threadVec);
t.Toc("\nFinished in: ", true);
return true;
}
///
/// Main program entry point for EmberAnimate.exe.
///
/// The number of command line arguments passed
/// The command line arguments passed
/// 0 if successful, else 1.
int _tmain(int argc, _TCHAR* argv[])
{
bool b = false;
EmberOptions opt;
//Required for large allocs, else GPU memory usage will be severely limited to small sizes.
//This must be done in the application and not in the EmberCL DLL.
#ifdef _WIN32
_putenv_s("GPU_MAX_ALLOC_PERCENT", "100");
#else
putenv(const_cast("GPU_MAX_ALLOC_PERCENT=100"));
#endif
if (!opt.Populate(argc, argv, eOptionUse::OPT_USE_ANIMATE))
{
auto palf = PaletteList::Instance();
#ifdef DO_DOUBLE
if (!opt.Sp())
b = EmberAnimate(opt);
else
#endif
b = EmberAnimate(opt);
}
return b ? 0 : 1;
}