C4Record Class Reference

#include <C4Record.h>

Public Member Functions
	C4Record ()
	C4Record (const char *szPlaybackFile, const char *szRecordFile, const char *szTempRecFile)
	~C4Record ()
bool	IsRecording () const
unsigned int	GetStreamingPos () const
const StdBuf &	GetStreamingBuf () const
bool	Start (bool fInitial)
bool	Stop (StdStrBuf *pRecordName=nullptr, BYTE *pRecordSHA1=nullptr)
bool	Rec (const C4Control &Ctrl, int iFrame)
bool	Rec (C4PacketType eCtrlType, C4ControlPacket *pCtrl, int iFrame)
bool	Rec (int iFrame, const StdBuf &sBuf, C4RecordChunkType eType)
bool	AddFile (const char *szLocalFilename, const char *szAddAs, bool fDelete=false)
bool	StartStreaming (bool fInitial)
void	ClearStreamingBuf (unsigned int iAmount)
void	StopStreaming ()
CStdFile *	GetLogFile ()

Public Attributes
int	Index

Detailed Description

Definition at line 243 of file C4Record.h.

Constructor & Destructor Documentation

C4Record() [1/2]

C4Record::C4Record ( )

default

C4Record() [2/2]

C4Record::C4Record	(	const char *	szPlaybackFile,
		const char *	szRecordFile,
		const char *	szTempRecFile
	)

~C4Record()

C4Record::~C4Record ( )

default

Member Function Documentation

AddFile()

bool C4Record::AddFile	(	const char *	szLocalFilename,
		const char *	szAddAs,
		bool	fDelete = false
	)

Definition at line 266 of file C4Record.cpp.

{
    if (!fRecording) return false;
 
    // Streaming?
    if (fStreaming)
    {
 
        // Special stripping for streaming
        StdCopyStrBuf szFile(szLocalFilename);
        if (SEqualNoCase(GetExtension(szAddAs), "ocp"))
        {
            // Create a copy
            MakeTempFilename(&szFile);
            if (!CopyItem(szLocalFilename, szFile.getData()))
                return false;
            // Strip it
            if (!C4Player::Strip(szFile.getData(), true))
                return false;
        }
 
        // Add to stream
        if (!StreamFile(szFile.getData(), szAddAs))
            return false;
 
        // Remove temporary file
        if (szFile != szLocalFilename)
            EraseItem(szFile.getData());
    }
 
    // Add to record group
    if (fDelete)
    {
        if (!RecordGrp.Move(szLocalFilename, szAddAs))
            return false;
    }
    else
    {
        if (!RecordGrp.Add(szLocalFilename, szAddAs))
            return false;
    }
 
    return true;
}

References C4Group::Add(), CopyItem(), EraseItem(), StdStrBuf::getData(), GetExtension(), MakeTempFilename(), C4Group::Move(), SEqualNoCase(), and C4Player::Strip().

Referenced by C4ControlJoinPlayer::PreRec(), and C4GameControl::RecAddFile().

Here is the call graph for this function:

Here is the caller graph for this function:

ClearStreamingBuf()

void C4Record::ClearStreamingBuf

(

unsigned int

iAmount

)

Definition at line 339 of file C4Record.cpp.

{
    iStreamingPos += iAmount;
    if (iAmount == StreamingData.getSize())
        StreamingData.Clear();
    else
    {
        StreamingData.Move(iAmount, StreamingData.getSize() - iAmount);
        StreamingData.SetSize(StreamingData.getSize() - iAmount);
    }
}

References StdBuf::Clear(), StdBuf::getSize(), StdBuf::Move(), and StdBuf::SetSize().

Referenced by C4Network2::StreamIn().

Here is the call graph for this function:

Here is the caller graph for this function:

GetLogFile()

CStdFile* C4Record::GetLogFile ( )

inline

Definition at line 278 of file C4Record.h.

{ return &LogRec; }

Referenced by LogSilent().

Here is the caller graph for this function:

GetStreamingBuf()

const StdBuf& C4Record::GetStreamingBuf ( ) const

inline

Definition at line 263 of file C4Record.h.

{ return StreamingData; }

Referenced by C4Network2::DrawStatus(), and C4Network2::StreamIn().

Here is the caller graph for this function:

GetStreamingPos()

unsigned int C4Record::GetStreamingPos ( ) const

inline

Definition at line 262 of file C4Record.h.

{ return iStreamingPos; }

Referenced by C4Network2::DrawStatus().

Here is the caller graph for this function:

IsRecording()

bool C4Record::IsRecording ( ) const

inline

Definition at line 261 of file C4Record.h.

{ return fRecording; } // return whether Start() has been called

Rec() [1/3]

bool C4Record::Rec	(	C4PacketType	eCtrlType,
		C4ControlPacket *	pCtrl,
		int	iFrame
	)

Definition at line 224 of file C4Record.cpp.

{
    if (!fRecording) return false;
    // create copy
    C4IDPacket Pkt = C4IDPacket(eCtrlType, pCtrl, false); if (!Pkt.getPkt()) return false;
    C4ControlPacket *pCtrlCpy = static_cast<C4ControlPacket *>(Pkt.getPkt());
    // prepare for recording
    pCtrlCpy->PreRec(this);
    // record it
    return Rec(iFrame, DecompileToBuf<StdCompilerBinWrite>(Pkt), RCT_CtrlPkt);
}

References C4IDPacket::getPkt(), C4ControlPacket::PreRec(), RCT_CtrlPkt, and Rec().

Here is the call graph for this function:

Rec() [2/3]

bool C4Record::Rec	(	const C4Control &	Ctrl,
		int	iFrame
	)

Definition at line 211 of file C4Record.cpp.

{
    if (!fRecording) return false;
    // don't record empty control
    if (!Ctrl.firstPkt()) return true;
    // create copy
    C4Control Cpy; Cpy.Copy(Ctrl);
    // prepare it for record
    Cpy.PreRec(this);
    // record it
    return Rec(iFrame, DecompileToBuf<StdCompilerBinWrite>(Cpy), RCT_Ctrl);
}

References C4Control::Copy(), C4Control::firstPkt(), C4Control::PreRec(), and RCT_Ctrl.

Referenced by C4GameControl::DbgRec(), C4GameControl::ExecControl(), C4GameControl::ExecControlPacket(), C4GameControl::Execute(), Rec(), and C4GameControl::StartRecord().

Here is the call graph for this function:

Here is the caller graph for this function:

Rec() [3/3]

bool C4Record::Rec	(	int	iFrame,
		const StdBuf &	sBuf,
		C4RecordChunkType	eType
	)

Definition at line 236 of file C4Record.cpp.

{
    // filler chunks (this should never be necessary, though)
    while (iFrame > int(iLastFrame + 0xff))
        Rec(iLastFrame + 0xff, StdBuf(), RCT_Frame);
    // get frame difference
    uint8_t iFrameDiff = std::max<uint8_t>(0, iFrame - iLastFrame);
    iLastFrame += iFrameDiff;
    // create head
    C4RecordChunkHead Head = { iFrameDiff, uint8_t(eType) };
    // pack
    CtrlRec.Write(&Head, sizeof(Head));
    CtrlRec.Write(sBuf.getData(), sBuf.getSize());
#ifdef IMMEDIATEREC
    // immediate rec: always flush
    CtrlRec.Flush();
#endif
    // Stream
    if (fStreaming)
        Stream(Head, sBuf);
    return true;
}

References CStdFile::Flush(), StdBuf::getData(), StdBuf::getSize(), RCT_Frame, Rec(), and CStdFile::Write().

Here is the call graph for this function:

Start()

bool C4Record::Start

(

bool

fInitial

)

Definition at line 104 of file C4Record.cpp.

{
    // no double record
    if (fRecording) return false;
 
    // create demos folder
    if (!Config.General.CreateSaveFolder(Config.AtUserDataPath(C4CFN_Records), LoadResStr("IDS_GAME_RECORDSTITLE")))
        return false;
 
    // various infos
    StdStrBuf sDemoFolder(C4CFN_Records);
    char sScenName[_MAX_FNAME_LEN]; SCopy(GetFilenameOnly(Game.Parameters.Scenario.getFile()), sScenName, _MAX_FNAME);
 
    // remove trailing numbers from scenario name (e.g. from savegames) - could we perhaps use C4S.Head.Origin instead...?
    char *pScenNameEnd = sScenName + SLen(sScenName);
    while (Inside<char>(*--pScenNameEnd, '0', '9'))
        if (pScenNameEnd == sScenName)
            break;
    pScenNameEnd[1] = 0;
 
    // determine index (by total number of records)
    Index = 1;
    for (DirectoryIterator i(Config.AtUserDataPath(C4CFN_Records)); *i; ++i)
        if (WildcardMatch(C4CFN_ScenarioFiles, *i))
            Index++;
 
    // compose record filename
    sFilename.Format("%s" DirSep "%03i-%s.ocs", Config.AtUserDataPath(sDemoFolder.getData()), Index, sScenName);
 
    // log
    StdStrBuf sLog; sLog.Format(LoadResStr("IDS_PRC_RECORDINGTO"),sFilename.getData());
    if (Game.FrameCounter) sLog.AppendFormat(" (Frame %d)", Game.FrameCounter);
    Log(sLog.getData());
 
    // save game - this also saves player info list
    C4GameSaveRecord saveRec(fInitial, Index, Game.Parameters.isLeague());
    if (!saveRec.Save(sFilename.getData())) return false;
    saveRec.Close();
 
    // unpack group, if neccessary
    if ( !DirectoryExists(sFilename.getData()) &&
         !C4Group_UnpackDirectory(sFilename.getData()) )
        return false;
 
    // open control record file
    char szCtrlRecFilename[_MAX_PATH_LEN + _MAX_FNAME];
    sprintf(szCtrlRecFilename, "%s" DirSep C4CFN_CtrlRec, sFilename.getData());
    if (!CtrlRec.Create(szCtrlRecFilename)) return false;
 
    // open log file in record
    char szLogRecFilename[_MAX_PATH_LEN + _MAX_FNAME];
    sprintf(szLogRecFilename, "%s" DirSep C4CFN_LogRec, sFilename.getData());
    if (!LogRec.Create(szLogRecFilename)) return false;
 
    // open record group
    if (!RecordGrp.Open(sFilename.getData()))
        return false;
 
    // record go
    fStreaming = false;
    fRecording = true;
    iLastFrame = 0;
    return true;
}

References _MAX_FNAME, _MAX_FNAME_LEN, _MAX_PATH_LEN, StdStrBuf::AppendFormat(), C4Config::AtUserDataPath(), C4CFN_CtrlRec, C4CFN_LogRec, C4CFN_Records, C4CFN_ScenarioFiles, C4Group_UnpackDirectory(), C4GameSave::Close(), Config, CStdFile::Create(), C4ConfigGeneral::CreateSaveFolder(), DirectoryExists(), DirSep, StdStrBuf::Format(), C4Game::FrameCounter, Game, C4Config::General, StdStrBuf::getData(), C4GameRes::getFile(), GetFilenameOnly(), Index, C4GameParameters::isLeague(), LoadResStr(), Log(), C4Group::Open(), C4Game::Parameters, C4GameSave::Save(), C4GameParameters::Scenario, SCopy(), SLen(), sprintf, and WildcardMatch().

Referenced by C4GameControl::StartRecord().

Here is the call graph for this function:

Here is the caller graph for this function:

StartStreaming()

bool C4Record::StartStreaming

(

bool

fInitial

)

Definition at line 311 of file C4Record.cpp.

{
    if (!fRecording) return false;
    if (fStreaming) return false;
 
    // Get temporary file name
    StdCopyStrBuf sTempFilename(sFilename);
    MakeTempFilename(&sTempFilename);
 
    // Save start state (without copy of scenario!)
    C4GameSaveRecord saveRec(fInitial, Index, Game.Parameters.isLeague(), false);
    if (!saveRec.Save(sTempFilename.getData())) return false;
    saveRec.Close();
 
    // Add file into stream, delete file
    fStreaming = true;
    if (!StreamFile(sTempFilename.getData(), sFilename.getData()))
    {
        fStreaming = false;
        return false;
    }
 
    // Okay
    EraseFile(sTempFilename.getData());
    iStreamingPos = 0;
    return true;
}

References C4GameSave::Close(), EraseFile(), Game, StdStrBuf::getData(), Index, C4GameParameters::isLeague(), MakeTempFilename(), C4Game::Parameters, and C4GameSave::Save().

Referenced by C4GameControl::StartRecord().

Here is the call graph for this function:

Here is the caller graph for this function:

Stop()

bool C4Record::Stop	(	StdStrBuf *	pRecordName = nullptr,
		BYTE *	pRecordSHA1 = nullptr
	)

Definition at line 169 of file C4Record.cpp.

{
    // safety
    if (!fRecording) return false;
    if (!DirectoryExists(sFilename.getData())) return false;
 
    // streaming finished
    StopStreaming();
 
    // save desc into record group
    C4GameSaveRecord saveRec(false, Index, Game.Parameters.isLeague());
    saveRec.SaveDesc(RecordGrp);
 
    // save end player infos into record group
    Game.PlayerInfos.Save(RecordGrp, C4CFN_RecPlayerInfos);
    RecordGrp.Close();
 
    // write last entry and close
    C4RecordChunkHead Head;
    Head.iFrm = 37;
    Head.Type = RCT_End;
    CtrlRec.Write(&Head, sizeof(Head));
    CtrlRec.Close();
 
    LogRec.Close();
 
    // pack group
    if (!Config.General.DebugRec)
        if (!C4Group_PackDirectory(sFilename.getData())) return false;
 
    // return record data
    if (pRecordName)
        pRecordName->Copy(sFilename);
    if (pRecordSHA1)
        if (!GetFileSHA1(sFilename.getData(), pRecordSHA1))
            return false;
 
    // ok
    fRecording = false;
    return true;
}

References C4CFN_RecPlayerInfos, C4Group_PackDirectory(), C4Group::Close(), CStdFile::Close(), Config, StdStrBuf::Copy(), C4ConfigGeneral::DebugRec, DirectoryExists(), Game, C4Config::General, StdStrBuf::getData(), GetFileSHA1(), C4RecordChunkHead::iFrm, Index, C4GameParameters::isLeague(), C4Game::Parameters, C4Game::PlayerInfos, RCT_End, C4PlayerInfoList::Save(), C4GameSave::SaveDesc(), StopStreaming(), C4RecordChunkHead::Type, and CStdFile::Write().

Referenced by C4GameControl::StopRecord().

Here is the call graph for this function:

Here is the caller graph for this function:

StopStreaming()

void C4Record::StopStreaming

(

)

Definition at line 351 of file C4Record.cpp.

{
    fStreaming = false;
}

Referenced by Stop().

Here is the caller graph for this function:

Member Data Documentation

Index

int C4Record::Index

Definition at line 259 of file C4Record.h.

Referenced by Start(), StartStreaming(), and Stop().

---

The documentation for this class was generated from the following files:

• C4Record.h
• C4Record.cpp