Overhauled frame number handling in animation status messages.

Animation status messages now consistently display a running frame count and the total number of frames actually to be rendered, properly taking into account the Frame_Step setting.
Additionally, the status messages now also show the nominal frame number as used in the `frame_number` variable and the output filename.

Author: c-lipka

changes.txt

@@ -23,6 +23,7 @@ Detailed changelog information is available in the file `revision.txt`, which
 should be located in the same directory as this file is.
 ------------------------------------------------------------------------------
 
+
 Changes between 3.7.0 and 3.7.1-TBD
 ===================================
 
@@ -45,8 +46,8 @@ Prior to the release of 3.7.1, the following items still need urgent attention:
 
 - The Windows version's inbuilt help index needs to be fixed.
 
-New Features and Improvements
------------------------------
+New Features
+------------
 
 - A new inbuilt constant, `tau`, has been added as shorthand for `2*pi`, in
   support of the world-wide initiative to obsolete pi in favour of the new,
@@ -67,8 +68,6 @@ New Features and Improvements
 
 - The macro syntax has been extended to allow for optional parameters.
 
-- POV-Ray for Windows now reports file names and line numbers of warnings.
-
 - Light sources' distance-based fading can now be set to obey an inverse-power
   law at all distances.
 
@@ -88,14 +87,10 @@ New Features and Improvements
 - Fresnel angle-dependent attenuation can now also be applied to highlights
   and the diffuse component for more physical realism.
 
-- Colour maps, pigment maps and the like are no longer limited to 256 entries.
-
 - The creation of a log for the `+C` render abort-continue feature can now be
   suppressed using `-CC` to save disk space.
 
-- The number of components ber blob is no longer artificially limited.
-
-For more details on the new features, see the documentation.
+For more details on the above new features, see the documentation.
 
 Changed Behaviour
 -----------------
@@ -110,7 +105,7 @@ Changed Behaviour
   `#version 3.7` (or later) directive anywhere in the main scene file.
 
 - Using `ambient` with a suspiciously high value in a non-legacy scene will
-  now prompt a warning, unless an `emission` is also specified.
+  now prompt a warning, unless `emission` is also specified.
 
 - POV-Ray will now try to auto-detect whether an input TIFF file with alpha
   channel uses premultiplied or non-premultiplied alpha mode, rather than
@@ -158,6 +153,14 @@ Compatibility Improvements
 - Thread stack size has been increased to avoid problems on some platforms.
   (requires boost 1.50 or later)
 
+Miscellaneous Improvements
+--------------------------
+
+- Animation status messages now include the nominal frame number.
+- POV-Ray for Windows now reports file names and line numbers of warnings.
+- Colour maps, pigment maps and the like are no longer limited to 256 entries.
+- The number of components ber blob is no longer artificially limited.
+
 Fixed or Mitigated Bugs Reported by Static Code Analysis
 --------------------------------------------------------
 
@@ -256,6 +259,9 @@ Reported via Windows Crash Reports:
 
 Miscellaneous:
 
+- Animation status messages now consistently display a running frame count and
+  the total number of frames actually to be rendered, properly taking into
+  account the Frame_Step setting.
 - Fixed mesh_camera-related flaws in the parser.
 - Fixed a family of bugs that could cause problems when using focal blur with
   some camera types if the camera is very close to the surface of a media
@@ -284,6 +290,7 @@ Other Noteworthy
 - The Visual Studio 2010 project for a console-only Windows version has been
   revived.
 
+
 ---------------------------------
 Changes between 3.7.RC7 and 3.7.0
 ---------------------------------

source/base/version.h

@@ -45,7 +45,7 @@
 #define OFFICIAL_VERSION_STRING "3.7.1"
 #define OFFICIAL_VERSION_NUMBER 371
 
-#define POV_RAY_PRERELEASE "alpha.8581629"
+#define POV_RAY_PRERELEASE "alpha.8586521"
 
 #if (POV_RAY_IS_AUTOBUILD == 1) && ((POV_RAY_IS_OFFICIAL == 1) || (POV_RAY_IS_SEMI_OFFICIAL == 1))
 #ifdef POV_RAY_PRERELEASE

source/frontend/animationprocessing.cpp

@@ -8,7 +8,7 @@
 /// @parblock
 ///
 /// Persistence of Vision Ray Tracer ('POV-Ray') version 3.7.
-/// Copyright 1991-2015 Persistence of Vision Raytracer Pty. Ltd.
+/// Copyright 1991-2016 Persistence of Vision Raytracer Pty. Ltd.
 ///
 /// POV-Ray is free software: you can redistribute it and/or modify
 /// it under the terms of the GNU Affero General Public License as
@@ -101,7 +101,8 @@ AnimationProcessing::AnimationProcessing(POVMS_Object& options) :
     oddFieldFlag = renderOptions.TryGetBool(kPOVAttrib_OddField, false);
 
     clockDelta = double(finalClock - initialClock) / double(finalFrame - initialFrame);
-    frameNumber = subsetStartFrame;
+    runningFrameNumber = 1;
+    nominalFrameNumber = subsetStartFrame;
     clockValue = POVMSFloat(double(clockDelta * double(subsetStartFrame - initialFrame)) + double(initialClock));
 
     frameNumberDigits = 1;
@@ -116,7 +117,7 @@ POVMS_Object AnimationProcessing::GetFrameRenderOptions()
     opts.SetFloat(kPOVAttrib_Clock, clockValue);
 
     // append to console files if not first frame (user can set this for first frame via command line to append all data to existing files, so don't set it to false)
-    if(frameNumber > subsetStartFrame)
+    if(nominalFrameNumber > subsetStartFrame)
         opts.SetBool(kPOVAttrib_AppendConsoleFiles, true);
 
     POVMS_List declares;
@@ -140,7 +141,7 @@ POVMS_Object AnimationProcessing::GetFrameRenderOptions()
 
     POVMS_Object frame_number(kPOVMSType_WildCard);
     frame_number.SetString(kPOVAttrib_Identifier, "frame_number");
-    frame_number.SetFloat(kPOVAttrib_Value, frameNumber);
+    frame_number.SetFloat(kPOVAttrib_Value, nominalFrameNumber);
     declares.Append(frame_number);
 
     POVMS_Object initial_clock(kPOVMSType_WildCard);
@@ -163,33 +164,39 @@ POVMS_Object AnimationProcessing::GetFrameRenderOptions()
 
 void AnimationProcessing::ComputeNextFrame()
 {
-    frameNumber+= frameStep;
-    clockValue = POVMSFloat(double(clockDelta * double(frameNumber - initialFrame)) + double(initialClock));
+    nominalFrameNumber+= frameStep;
+    ++runningFrameNumber;
+    clockValue = POVMSFloat(double(clockDelta * double(nominalFrameNumber - initialFrame)) + double(initialClock));
 }
 
 bool AnimationProcessing::MoreFrames()
 {
-    return (frameNumber+frameStep <= subsetEndFrame);
+    return (nominalFrameNumber+frameStep <= subsetEndFrame);
 }
 
-POVMSInt AnimationProcessing::GetFrameNumber()
+POVMSInt AnimationProcessing::GetNominalFrameNumber()
 {
-    return frameNumber;
+    return nominalFrameNumber;
 }
 
-POVMSInt AnimationProcessing::GetStartFrame()
+POVMSInt AnimationProcessing::GetRunningFrameNumber()
+{
+    return runningFrameNumber;
+}
+
+POVMSInt AnimationProcessing::GetSubsetStartFrame()
 {
     return subsetStartFrame;
 }
 
-POVMSInt AnimationProcessing::GetEndFrame()
+POVMSInt AnimationProcessing::GetSubsetEndFrame()
 {
     return subsetEndFrame;
 }
 
-POVMSInt AnimationProcessing::GetTotalFrames()
+POVMSInt AnimationProcessing::GetTotalFramesToRender()
 {
-    return subsetEndFrame - subsetStartFrame + 1;
+    return (subsetEndFrame - subsetStartFrame) / frameStep + 1;
 }
 
 POVMSFloat AnimationProcessing::GetClockValue()

source/frontend/animationprocessing.h

@@ -8,7 +8,7 @@
 /// @parblock
 ///
 /// Persistence of Vision Ray Tracer ('POV-Ray') version 3.7.
-/// Copyright 1991-2015 Persistence of Vision Raytracer Pty. Ltd.
+/// Copyright 1991-2016 Persistence of Vision Raytracer Pty. Ltd.
 ///
 /// POV-Ray is free software: you can redistribute it and/or modify
 /// it under the terms of the GNU Affero General Public License as
@@ -57,10 +57,21 @@ class AnimationProcessing
         void ComputeNextFrame();
         bool MoreFrames();
 
-        POVMSInt GetFrameNumber();
-        POVMSInt GetStartFrame();
-        POVMSInt GetEndFrame();
-        POVMSInt GetTotalFrames();
+        /// Get nominal frame number.
+        POVMSInt GetNominalFrameNumber();
+
+        /// Get running frame number.
+        POVMSInt GetRunningFrameNumber();
+
+        /// Get subset start frame number.
+        POVMSInt GetSubsetStartFrame();
+
+        /// Get subset end frame number.
+        POVMSInt GetSubsetEndFrame();
+
+        /// Get the total number of frames to actually render.
+        POVMSInt GetTotalFramesToRender();
+
         POVMSFloat GetClockValue();
         int GetFrameNumberDigits();
     private:
@@ -79,7 +90,8 @@ class AnimationProcessing
         POVMSBool oddFieldFlag;
 
         POVMSFloat clockValue;
-        POVMSInt frameNumber;
+        POVMSInt runningFrameNumber;
+        POVMSInt nominalFrameNumber;
 
         POVMSInt frameStep;
 

source/frontend/simplefrontend.h

@@ -8,7 +8,7 @@
 /// @parblock
 ///
 /// Persistence of Vision Ray Tracer ('POV-Ray') version 3.7.
-/// Copyright 1991-2015 Persistence of Vision Raytracer Pty. Ltd.
+/// Copyright 1991-2016 Persistence of Vision Raytracer Pty. Ltd.
 ///
 /// POV-Ray is free software: you can redistribute it and/or modify
 /// it under the terms of the GNU Affero General Public License as
@@ -271,7 +271,7 @@ State SimpleFrontend<PARSER_MH, FILE_MH, RENDER_MH, IMAGE_MH>::Process()
                 {
                     options = animationProcessing->GetFrameRenderOptions();
                     if (imageProcessing != NULL)
-                        options.SetUCS2String(kPOVAttrib_OutputFile, imageProcessing->GetOutputFilename(options, animationProcessing->GetFrameNumber(), animationProcessing->GetFrameNumberDigits()).c_str());
+                        options.SetUCS2String(kPOVAttrib_OutputFile, imageProcessing->GetOutputFilename(options, animationProcessing->GetNominalFrameNumber(), animationProcessing->GetFrameNumberDigits()).c_str());
                 }
                 else
                     if (imageProcessing != NULL)
@@ -374,7 +374,7 @@ State SimpleFrontend<PARSER_MH, FILE_MH, RENDER_MH, IMAGE_MH>::Process()
                         try
                         {
                             if(animationProcessing != NULL)
-                                imageProcessing->WriteImage(options, animationProcessing->GetFrameNumber(), animationProcessing->GetFrameNumberDigits());
+                                imageProcessing->WriteImage(options, animationProcessing->GetNominalFrameNumber(), animationProcessing->GetFrameNumberDigits());
                             else
                                 imageProcessing->WriteImage(options);
                         }

unix/VERSION

@@ -1 +1 @@
-3.7.1-alpha.8581629
+3.7.1-alpha.8586521

vfe/unix/unixconsole.cpp

@@ -8,7 +8,7 @@
 /// @parblock
 ///
 /// Persistence of Vision Ray Tracer ('POV-Ray') version 3.7.
-/// Copyright 1991-2014 Persistence of Vision Raytracer Pty. Ltd.
+/// Copyright 1991-2016 Persistence of Vision Raytracer Pty. Ltd.
 ///
 /// POV-Ray is free software: you can redistribute it and/or modify
 /// it under the terms of the GNU Affero General Public License as
@@ -515,7 +515,7 @@ int main (int argc, char **argv)
         }
 
         if (flags & stAnimationStatus)
-            fprintf(stderr, "\nRendering frame %d of %d\n", session->GetCurrentFrame(), session->GetTotalFrames());
+            fprintf(stderr, "\nRendering frame %d of %d (#%d)\n", session->GetCurrentFrame(), session->GetTotalFrames(), session->GetCurrentFrameId());
         if (flags & stAnyMessage)
             PrintStatus (session);
         if (flags & stBackendStateChanged)

vfe/vfe.cpp

@@ -10,7 +10,7 @@
 /// @parblock
 ///
 /// Persistence of Vision Ray Tracer ('POV-Ray') version 3.7.
-/// Copyright 1991-2015 Persistence of Vision Raytracer Pty. Ltd.
+/// Copyright 1991-2016 Persistence of Vision Raytracer Pty. Ltd.
 ///
 /// POV-Ray is free software: you can redistribute it and/or modify
 /// it under the terms of the GNU Affero General Public License as
@@ -920,30 +920,31 @@ State VirtualFrontEnd::Process()
         m_Session->SetSucceeded (false);
         if (animationProcessing != NULL)
         {
-          shelloutProcessing->SetFrameClock(animationProcessing->GetFrameNumber(), animationProcessing->GetClockValue());
+          shelloutProcessing->SetFrameClock(animationProcessing->GetNominalFrameNumber(), animationProcessing->GetClockValue());
           if (shelloutProcessing->SkipNextFrame() == false)
           {
             UCS2String filename;
-            int frame = animationProcessing->GetFrameNumber() - animationProcessing->GetStartFrame() ;
+            int frameId = animationProcessing->GetNominalFrameNumber();
+            int frame = animationProcessing->GetRunningFrameNumber();
             options = animationProcessing->GetFrameRenderOptions ();
             if (m_Session->OutputToFileSet())
             {
-              filename = imageProcessing->GetOutputFilename (options, animationProcessing->GetFrameNumber(), animationProcessing->GetFrameNumberDigits());
+              filename = imageProcessing->GetOutputFilename (options, frameId, animationProcessing->GetFrameNumberDigits());
               options.SetUCS2String (kPOVAttrib_OutputFile, filename.c_str());
 
               // test access permission now to avoid surprise later after waiting for
               // the render to complete.
               if (m_Session->TestAccessAllowed(filename, true) == false)
               {
-                string str ("IO Restrictions prohibit write access to '") ;
+                string str ("IO Restrictions prohibit write access to '");
                 str += UCS2toASCIIString(filename);
                 str += "'";
                 throw POV_EXCEPTION(kCannotOpenFileErr, str);
               }
               shelloutProcessing->SetOutputFile(UCS2toASCIIString(filename));
               m_Session->AdviseOutputFilename (filename);
             }
-            m_Session->AppendAnimationStatus (frame + 1, animationProcessing->GetTotalFrames(), filename) ;
+            m_Session->AppendAnimationStatus (frameId, frame, animationProcessing->GetTotalFramesToRender(), filename);
           }
         }
 
@@ -1163,7 +1164,7 @@ State VirtualFrontEnd::Process()
             if (animationProcessing != NULL)
             {
               if (m_Session->OutputToFileSet())
-                m_Session->AdviseOutputFilename (imageProcessing->WriteImage(options, animationProcessing->GetFrameNumber(), animationProcessing->GetFrameNumberDigits()));
+                m_Session->AdviseOutputFilename (imageProcessing->WriteImage(options, animationProcessing->GetNominalFrameNumber(), animationProcessing->GetFrameNumberDigits()));
               m_Session->AdviseFrameCompleted();
             }
             else

vfe/vfesession.cpp

@@ -10,7 +10,7 @@
 /// @parblock
 ///
 /// Persistence of Vision Ray Tracer ('POV-Ray') version 3.7.
-/// Copyright 1991-2015 Persistence of Vision Raytracer Pty. Ltd.
+/// Copyright 1991-2016 Persistence of Vision Raytracer Pty. Ltd.
 ///
 /// POV-Ray is free software: you can redistribute it and/or modify
 /// it under the terms of the GNU Affero General Public License as
@@ -109,6 +109,7 @@ void vfeSession::Clear(bool Notify)
   m_PercentComplete = 0;
   m_PixelsRendered = 0;
   m_TotalPixels = 0;
+  m_CurrentFrameId = 0;
   m_CurrentFrame = 0;
   m_TotalFrames = 0;
   if (Notify)
@@ -296,14 +297,15 @@ void vfeSession::AppendStatusMessage (const boost::format& fmt, int RecommendedP
   NotifyEvent(stStatusMessage);
 }
 
-void vfeSession::AppendAnimationStatus (int Frame, int Total, const UCS2String& Filename)
+void vfeSession::AppendAnimationStatus (int FrameId, int SubsetFrame, int SubsetTotal, const UCS2String& Filename)
 {
   boost::mutex::scoped_lock lock(m_MessageMutex);
 
-  m_CurrentFrame = Frame;
-  m_TotalFrames = Total;
-  m_StatusQueue.push (StatusMessage (*this, Filename, Frame, Total));
-  m_StatusLineMessage = (boost::format("Rendering frame %d of %d") % Frame % Total).str();
+  m_CurrentFrameId = FrameId;
+  m_CurrentFrame = SubsetFrame;
+  m_TotalFrames = SubsetTotal;
+  m_StatusQueue.push (StatusMessage (*this, Filename, SubsetFrame, SubsetTotal, FrameId));
+  m_StatusLineMessage = (boost::format("Rendering frame %d of %d (#%d)") % SubsetFrame % SubsetTotal % FrameId).str();
   if (m_MaxStatusMessages != -1)
     while (m_StatusQueue.size() > m_MaxStatusMessages)
       m_StatusQueue.pop();