AviRecorder.cc

Go to the documentation of this file.

#include "AviRecorder.hh"
#include "AviWriter.hh"
#include "WavWriter.hh"
#include "Reactor.hh"
#include "MSXMotherBoard.hh"
#include "FileContext.hh"
#include "CommandException.hh"
#include "Display.hh"
#include "PostProcessor.hh"
#include "Math.hh"
#include "MSXMixer.hh"
#include "Filename.hh"
#include "CliComm.hh"
#include "FileOperations.hh"
#include "TclArgParser.hh"
#include "TclObject.hh"
#include "outer.hh"
#include "view.hh"
#include "vla.hh"
#include <cassert>
#include <memory>

using std::string;
using std::vector;

namespace openmsx {

AviRecorder::AviRecorder(Reactor& reactor_)
        : reactor(reactor_)
        , recordCommand(reactor.getCommandController())
        , mixer(nullptr)
        , duration(EmuDuration::infinity())
        , prevTime(EmuTime::infinity())
        , frameHeight(0)
{
}

AviRecorder::~AviRecorder()
{
        assert(!aviWriter);
        assert(!wavWriter);
}

void AviRecorder::start(bool recordAudio, bool recordVideo, bool recordMono,
                        bool recordStereo, const Filename& filename)
{
        stop();
        MSXMotherBoard* motherBoard = reactor.getMotherBoard();
        if (!motherBoard) {
                throw CommandException("No active MSX machine.");
        }
        if (recordAudio) {
                mixer = &motherBoard->getMSXMixer();
                warnedStereo = false;
                if (recordStereo) {
                        stereo = true;
                } else if (recordMono) {
                        stereo = false;
                        warnedStereo = true; // no warning if data is actually stereo
                } else {
                        stereo = mixer->needStereoRecording();
                }
                sampleRate = mixer->getSampleRate();
                warnedSampleRate = false;
        }
        if (recordVideo) {
                // Set V99x8, V9990, Laserdisc, ... in record mode (when
                // present). Only the active one will actually send frames to
                // the video. This also works for Video9000.
                postProcessors.clear();
                for (auto* l : reactor.getDisplay().getAllLayers()) {
                        if (auto* pp = dynamic_cast<PostProcessor*>(l)) {
                                postProcessors.push_back(pp);
                        }
                }
                if (postProcessors.empty()) {
                        throw CommandException(
                                "Current renderer doesn't support video recording.");
                }
                // any source is fine because they all have the same bpp
                unsigned bpp = postProcessors.front()->getBpp();
                warnedFps = false;
                duration = EmuDuration::infinity();
                prevTime = EmuTime::infinity();

                try {
                        aviWriter = std::make_unique<AviWriter>(
                                filename, frameWidth, frameHeight, bpp,
                                (recordAudio && stereo) ? 2 : 1, sampleRate);
                } catch (MSXException& e) {
                        throw CommandException("Can't start recording: ",
                                               e.getMessage());
                }
        } else {
                assert(recordAudio);
                wavWriter = std::make_unique<Wav16Writer>(
                        filename, stereo ? 2 : 1, sampleRate);
        }
        // only set recorders when all errors are checked for
        for (auto* pp : postProcessors) {
                pp->setRecorder(this);
        }
        if (mixer) mixer->setRecorder(this);
}

void AviRecorder::stop()
{
        for (auto* pp : postProcessors) {
                pp->setRecorder(nullptr);
        }
        postProcessors.clear();
        if (mixer) {
                mixer->setRecorder(nullptr);
                mixer = nullptr;
        }
        sampleRate = 0;
        aviWriter.reset();
        wavWriter.reset();
}

static int16_t float2int16(float f)
{
        return Math::clipIntToShort(lrintf(32768.0f * f));
}

void AviRecorder::addWave(unsigned num, float* fdata)
{
        if (!warnedSampleRate && (mixer->getSampleRate() != sampleRate)) {
                warnedSampleRate = true;
                reactor.getCliComm().printWarning(
                        "Detected audio sample frequency change during "
                        "avi recording. Audio/video might get out of sync "
                        "because of this.");
        }
        if (stereo) {
                VLA(int16_t, buf, 2 * num);
                for (unsigned i = 0; i < 2 * num; ++i) {
                        buf[i] = float2int16(fdata[i]);
                }
                if (wavWriter) {
                        wavWriter->write(buf, 2, num);
                } else {
                        assert(aviWriter);
                        audioBuf.insert(end(audioBuf), buf, buf + 2 * num);
                }
        } else {
                VLA(int16_t, buf, num);
                unsigned i = 0;
                for (; !warnedStereo && i < num; ++i) {
                        if (fdata[2 * i + 0] != fdata[2 * i + 1]) {
                                reactor.getCliComm().printWarning(
                                    "Detected stereo sound during mono recording. "
                                    "Channels will be mixed down to mono. To "
                                    "avoid this warning you can explicity pass the "
                                    "-mono or -stereo flag to the record command.");
                                warnedStereo = true;
                                break;
                        }
                        buf[i] = float2int16(fdata[2 * i]);
                }
                for (; i < num; ++i) {
                        buf[i] = float2int16((fdata[2 * i + 0] + fdata[2 * i + 1]) * 0.5f);
                }

                if (wavWriter) {
                        wavWriter->write(buf, 1, num);
                } else {
                        assert(aviWriter);
                        audioBuf.insert(end(audioBuf), buf, buf + num);
                }
        }
}

void AviRecorder::addImage(FrameSource* frame, EmuTime::param time)
{
        assert(!wavWriter);
        if (duration != EmuDuration::infinity()) {
                if (!warnedFps && ((time - prevTime) != duration)) {
                        warnedFps = true;
                        reactor.getCliComm().printWarning(
                                "Detected frame rate change (PAL/NTSC or frameskip) "
                                "during avi recording. Audio/video might get out of "
                                "sync because of this.");
                }
        } else if (prevTime != EmuTime::infinity()) {
                duration = time - prevTime;
                aviWriter->setFps(1.0 / duration.toDouble());
        }
        prevTime = time;

        if (mixer) {
                mixer->updateStream(time);
        }
        aviWriter->addFrame(frame, unsigned(audioBuf.size()), audioBuf.data());
        audioBuf.clear();
}

// TODO: Can this be dropped?
unsigned AviRecorder::getFrameHeight() const {
        assert (frameHeight != 0); // someone uses the getter too early?
        return frameHeight;
}

void AviRecorder::processStart(Interpreter& interp, span<const TclObject> tokens, TclObject& result)
{
        std::string_view prefix = "openmsx";
        bool audioOnly    = false;
        bool videoOnly    = false;
        bool recordMono   = false;
        bool recordStereo = false;
        bool doubleSize   = false;
        bool tripleSize   = false;
        ArgsInfo info[] = {
                valueArg("-prefix", prefix),
                flagArg("-audioonly", audioOnly),
                flagArg("-videoonly", videoOnly),
                flagArg("-mono",      recordMono),
                flagArg("-stereo",    recordStereo),
                flagArg("-doublesize", doubleSize),
                flagArg("-triplesize", tripleSize),
        };
        auto arguments = parseTclArgs(interp, tokens.subspan(2), info);

        if (audioOnly && videoOnly) {
                throw CommandException("Can't have both -videoonly and -audioonly.");
        }
        if (recordStereo && recordMono) {
                throw CommandException("Can't have both -mono and -stereo.");
        }
        if (doubleSize && tripleSize) {
                throw CommandException("Can't have both -doublesize and -triplesize.");
        }
        if (videoOnly && (recordStereo || recordMono)) {
                throw CommandException("Can't have both -videoonly and -stereo or -mono.");
        }
        std::string_view filenameArg;
        switch (arguments.size()) {
        case 0:
                // nothing
                break;
        case 1:
                filenameArg = arguments[0].getString();
                break;
        default:
                throw SyntaxError();
        }

        frameWidth = 320;
        frameHeight = 240;
        if (doubleSize) {
                frameWidth  *= 2;
                frameHeight *= 2;
        } else if (tripleSize) {
                frameWidth  *= 3;
                frameHeight *= 3;
        }
        bool recordAudio = !videoOnly;
        bool recordVideo = !audioOnly;
        string directory = recordVideo ? "videos" : "soundlogs";
        string extension = recordVideo ? ".avi"   : ".wav";
        string filename = FileOperations::parseCommandFileArgument(
                filenameArg, directory, prefix, extension);

        if (aviWriter || wavWriter) {
                result = "Already recording.";
        } else {
                start(recordAudio, recordVideo, recordMono, recordStereo,
                                Filename(filename));
                result = "Recording to " + filename;
        }
}

void AviRecorder::processStop(span<const TclObject> /*tokens*/)
{
        stop();
}

void AviRecorder::processToggle(Interpreter& interp, span<const TclObject> tokens, TclObject& result)
{
        if (aviWriter || wavWriter) {
                // drop extra tokens
                processStop(tokens.first<2>());
        } else {
                processStart(interp, tokens, result);
        }
}

void AviRecorder::status(span<const TclObject> /*tokens*/, TclObject& result) const
{
        result.addDictKeyValue("status", (aviWriter || wavWriter) ? "recording" : "idle");
}

// class AviRecorder::Cmd

AviRecorder::Cmd::Cmd(CommandController& commandController_)
        : Command(commandController_, "record")
{
}

void AviRecorder::Cmd::execute(span<const TclObject> tokens, TclObject& result)
{
        if (tokens.size() < 2) {
                throw CommandException("Missing argument");
        }
        auto& recorder = OUTER(AviRecorder, recordCommand);
        executeSubCommand(tokens[1].getString(),
                "start",  [&]{ recorder.processStart(getInterpreter(), tokens, result); },
                "stop",   [&]{
                        checkNumArgs(tokens, 2, Prefix{2}, nullptr);
                        recorder.processStop(tokens); },
                "toggle", [&]{ recorder.processToggle(getInterpreter(), tokens, result); },
                "status", [&]{
                        checkNumArgs(tokens, 2, Prefix{2}, nullptr);
                        recorder.status(tokens, result); });
}

string AviRecorder::Cmd::help(const vector<string>& /*tokens*/) const
{
        return "Controls video recording: Write openMSX audio/video to a .avi file.\n"
               "record start              Record to file 'openmsxNNNN.avi'\n"
               "record start <filename>   Record to given file\n"
               "record start -prefix foo  Record to file 'fooNNNN.avi'\n"
               "record stop               Stop recording\n"
               "record toggle             Toggle recording (useful as keybinding)\n"
               "record status             Query recording state\n"
               "\n"
               "The start subcommand also accepts an optional -audioonly, -videoonly, "
               " -mono, -stereo, -doublesize, -triplesize flag.\n"
               "Videos are recorded in a 320x240 size by default, at 640x480 when the "
               "-doublesize flag is used and at 960x720 when the -triplesize flag is used.";
}

void AviRecorder::Cmd::tabCompletion(vector<string>& tokens) const
{
        if (tokens.size() == 2) {
                static constexpr const char* const cmds[] = {
                        "start", "stop", "toggle", "status",
                };
                completeString(tokens, cmds);
        } else if ((tokens.size() >= 3) && (tokens[1] == "start")) {
                static constexpr const char* const options[] = {
                        "-prefix", "-videoonly", "-audioonly", "-doublesize", "-triplesize",
                        "-mono", "-stereo",
                };
                completeFileName(tokens, userFileContext(), options);
        }
}

} // namespace openmsx