Campbell Barton
41f2ea4045
Event though in practice this wasn't causing problems as the fixed size
buffers are generally large enough not to truncate text.
Using the result from `snprint` or `BLI_snprintf` to step over a fixed
size buffer allows for buffer overruns as the returned value is the size
needed to copy the entire string, not the number of bytes copied.
Building strings using this convention with multiple calls:
ofs += BLI_snprintf(str + ofs, str_len_max - ofs);
.. caused the size argument to become negative,
wrapping it to a large value when cast to the unsigned argument.
257 lines
8.4 KiB
C
257 lines
8.4 KiB
C
/*
|
|
* This program is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU General Public License
|
|
* as published by the Free Software Foundation; either version 2
|
|
* of the License, or (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program; if not, write to the Free Software Foundation,
|
|
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
*
|
|
* The Original Code is Copyright (C) 2008 Blender Foundation.
|
|
* All rights reserved.
|
|
*/
|
|
|
|
/** \file
|
|
* \ingroup blendlib
|
|
*
|
|
* Time-Code string formatting
|
|
*/
|
|
|
|
#include <stdio.h>
|
|
|
|
#include "BLI_math.h"
|
|
#include "BLI_string.h"
|
|
#include "BLI_utildefines.h"
|
|
|
|
#include "BLI_timecode.h" /* own include */
|
|
|
|
#include "DNA_userdef_types.h" /* for eTimecodeStyles only */
|
|
|
|
#include "BLI_strict_flags.h"
|
|
|
|
/**
|
|
* Generate time-code/frame number string and store in \a str
|
|
*
|
|
* \param str: destination string
|
|
* \param maxncpy: maximum number of characters to copy ``sizeof(str)``
|
|
* \param brevity_level: special setting for #View2D grid drawing,
|
|
* used to specify how detailed we need to be
|
|
* \param time_seconds: time total time in seconds
|
|
* \param fps: frames per second, typically from the #FPS macro
|
|
* \param timecode_style: enum from #eTimecodeStyles
|
|
* \return length of \a str
|
|
*/
|
|
|
|
size_t BLI_timecode_string_from_time(char *str,
|
|
const size_t maxncpy,
|
|
const int brevity_level,
|
|
const float time_seconds,
|
|
const double fps,
|
|
const short timecode_style)
|
|
{
|
|
int hours = 0, minutes = 0, seconds = 0, frames = 0;
|
|
float time = time_seconds;
|
|
char neg[2] = {'\0'};
|
|
size_t rlen;
|
|
|
|
/* get cframes */
|
|
if (time < 0) {
|
|
/* correction for negative cfraues */
|
|
neg[0] = '-';
|
|
time = -time;
|
|
}
|
|
|
|
if (time >= 3600.0f) {
|
|
/* hours */
|
|
/* XXX should we only display a single digit for hours since clips are
|
|
* VERY UNLIKELY to be more than 1-2 hours max? However, that would
|
|
* go against conventions...
|
|
*/
|
|
hours = (int)time / 3600;
|
|
time = fmodf(time, 3600);
|
|
}
|
|
|
|
if (time >= 60.0f) {
|
|
/* minutes */
|
|
minutes = (int)time / 60;
|
|
time = fmodf(time, 60);
|
|
}
|
|
|
|
if (brevity_level <= 0) {
|
|
/* seconds + frames
|
|
* Frames are derived from 'fraction' of second. We need to perform some additional rounding
|
|
* to cope with 'half' frames, etc., which should be fine in most cases
|
|
*/
|
|
seconds = (int)time;
|
|
frames = round_fl_to_int((float)(((double)time - (double)seconds) * fps));
|
|
}
|
|
else {
|
|
/* seconds (with pixel offset rounding) */
|
|
seconds = round_fl_to_int(time);
|
|
}
|
|
|
|
switch (timecode_style) {
|
|
case USER_TIMECODE_MINIMAL: {
|
|
/* - In general, minutes and seconds should be shown, as most clips will be
|
|
* within this length. Hours will only be included if relevant.
|
|
* - Only show frames when zoomed in enough for them to be relevant
|
|
* (using separator of '+' for frames).
|
|
* When showing frames, use slightly different display to avoid confusion with mm:ss format
|
|
*/
|
|
if (brevity_level <= 0) {
|
|
/* include "frames" in display */
|
|
if (hours) {
|
|
rlen = BLI_snprintf_rlen(
|
|
str, maxncpy, "%s%02d:%02d:%02d+%02d", neg, hours, minutes, seconds, frames);
|
|
}
|
|
else if (minutes) {
|
|
rlen = BLI_snprintf_rlen(
|
|
str, maxncpy, "%s%02d:%02d+%02d", neg, minutes, seconds, frames);
|
|
}
|
|
else {
|
|
rlen = BLI_snprintf_rlen(str, maxncpy, "%s%d+%02d", neg, seconds, frames);
|
|
}
|
|
}
|
|
else {
|
|
/* don't include 'frames' in display */
|
|
if (hours) {
|
|
rlen = BLI_snprintf_rlen(str, maxncpy, "%s%02d:%02d:%02d", neg, hours, minutes, seconds);
|
|
}
|
|
else {
|
|
rlen = BLI_snprintf_rlen(str, maxncpy, "%s%02d:%02d", neg, minutes, seconds);
|
|
}
|
|
}
|
|
break;
|
|
}
|
|
case USER_TIMECODE_SMPTE_MSF: {
|
|
/* reduced SMPTE format that always shows minutes, seconds, frames.
|
|
* Hours only shown as needed. */
|
|
if (hours) {
|
|
rlen = BLI_snprintf_rlen(
|
|
str, maxncpy, "%s%02d:%02d:%02d:%02d", neg, hours, minutes, seconds, frames);
|
|
}
|
|
else {
|
|
rlen = BLI_snprintf_rlen(str, maxncpy, "%s%02d:%02d:%02d", neg, minutes, seconds, frames);
|
|
}
|
|
break;
|
|
}
|
|
case USER_TIMECODE_MILLISECONDS: {
|
|
/* reduced SMPTE. Instead of frames, milliseconds are shown */
|
|
|
|
/* precision of decimal part */
|
|
const int ms_dp = (brevity_level <= 0) ? (1 - brevity_level) : 1;
|
|
|
|
/* to get 2 digit whole-number part for seconds display
|
|
* (i.e. 3 is for 2 digits + radix, on top of full length) */
|
|
const int s_pad = ms_dp + 3;
|
|
|
|
if (hours) {
|
|
rlen = BLI_snprintf_rlen(
|
|
str, maxncpy, "%s%02d:%02d:%0*.*f", neg, hours, minutes, s_pad, ms_dp, time);
|
|
}
|
|
else {
|
|
rlen = BLI_snprintf_rlen(str, maxncpy, "%s%02d:%0*.*f", neg, minutes, s_pad, ms_dp, time);
|
|
}
|
|
break;
|
|
}
|
|
case USER_TIMECODE_SUBRIP: {
|
|
/* SubRip, like SMPTE milliseconds but seconds and milliseconds
|
|
* are separated by a comma, not a dot... */
|
|
|
|
/* precision of decimal part */
|
|
const int ms_dp = (brevity_level <= 0) ? (1 - brevity_level) : 1;
|
|
const int ms = round_fl_to_int((time - (float)seconds) * 1000.0f);
|
|
|
|
rlen = BLI_snprintf_rlen(
|
|
str, maxncpy, "%s%02d:%02d:%02d,%0*d", neg, hours, minutes, seconds, ms_dp, ms);
|
|
break;
|
|
}
|
|
case USER_TIMECODE_SECONDS_ONLY: {
|
|
/* only show the original seconds display */
|
|
/* round to whole numbers if brevity_level is >= 1 (i.e. scale is coarse) */
|
|
if (brevity_level <= 0) {
|
|
rlen = BLI_snprintf_rlen(str, maxncpy, "%.*f", 1 - brevity_level, time_seconds);
|
|
}
|
|
else {
|
|
rlen = BLI_snprintf_rlen(str, maxncpy, "%d", round_fl_to_int(time_seconds));
|
|
}
|
|
break;
|
|
}
|
|
case USER_TIMECODE_SMPTE_FULL:
|
|
default: {
|
|
/* full SMPTE format */
|
|
rlen = BLI_snprintf_rlen(
|
|
str, maxncpy, "%s%02d:%02d:%02d:%02d", neg, hours, minutes, seconds, frames);
|
|
break;
|
|
}
|
|
}
|
|
|
|
return rlen;
|
|
}
|
|
|
|
/**
|
|
* Generate time string and store in \a str
|
|
*
|
|
* \param str: destination string
|
|
* \param maxncpy: maximum number of characters to copy ``sizeof(str)``
|
|
* \param time_seconds: time total time in seconds
|
|
* \return length of \a str
|
|
*/
|
|
size_t BLI_timecode_string_from_time_simple(char *str,
|
|
const size_t maxncpy,
|
|
const double time_seconds)
|
|
{
|
|
size_t rlen;
|
|
|
|
/* format 00:00:00.00 (hr:min:sec) string has to be 12 long */
|
|
const int hr = ((int)time_seconds) / (60 * 60);
|
|
const int min = (((int)time_seconds) / 60) % 60;
|
|
const int sec = ((int)time_seconds) % 60;
|
|
const int hun = ((int)(fmod(time_seconds, 1.0) * 100));
|
|
|
|
if (hr) {
|
|
rlen = BLI_snprintf_rlen(str, maxncpy, "%.2d:%.2d:%.2d.%.2d", hr, min, sec, hun);
|
|
}
|
|
else {
|
|
rlen = BLI_snprintf_rlen(str, maxncpy, "%.2d:%.2d.%.2d", min, sec, hun);
|
|
}
|
|
|
|
return rlen;
|
|
}
|
|
|
|
/**
|
|
* Generate time string and store in \a str
|
|
*
|
|
* \param str: destination string
|
|
* \param maxncpy: maximum number of characters to copy ``sizeof(str)``
|
|
* \param brevity_level: special setting for #View2D grid drawing,
|
|
* used to specify how detailed we need to be
|
|
* \param time_seconds: time total time in seconds
|
|
* \return length of \a str
|
|
*
|
|
* \note in some cases this is used to print non-seconds values.
|
|
*/
|
|
size_t BLI_timecode_string_from_time_seconds(char *str,
|
|
const size_t maxncpy,
|
|
const int brevity_level,
|
|
const float time_seconds)
|
|
{
|
|
size_t rlen;
|
|
|
|
/* round to whole numbers if brevity_level is >= 1 (i.e. scale is coarse) */
|
|
if (brevity_level <= 0) {
|
|
rlen = BLI_snprintf_rlen(str, maxncpy, "%.*f", 1 - brevity_level, time_seconds);
|
|
}
|
|
else {
|
|
rlen = BLI_snprintf_rlen(str, maxncpy, "%d", round_fl_to_int(time_seconds));
|
|
}
|
|
|
|
return rlen;
|
|
}
|