Home | History | Annotate | Download | only in libavutil
      1 /*
      2  * This file is part of FFmpeg.
      3  *
      4  * FFmpeg is free software; you can redistribute it and/or
      5  * modify it under the terms of the GNU Lesser General Public
      6  * License as published by the Free Software Foundation; either
      7  * version 2.1 of the License, or (at your option) any later version.
      8  *
      9  * FFmpeg is distributed in the hope that it will be useful,
     10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
     11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
     12  * Lesser General Public License for more details.
     13  *
     14  * You should have received a copy of the GNU Lesser General Public
     15  * License along with FFmpeg; if not, write to the Free Software
     16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
     17  */
     18 
     19 /**
     20  * @file
     21  * timestamp utils, mostly useful for debugging/logging purposes
     22  */
     23 
     24 #ifndef AVUTIL_TIMESTAMP_H
     25 #define AVUTIL_TIMESTAMP_H
     26 
     27 #include "common.h"
     28 
     29 #define AV_TS_MAX_STRING_SIZE 32
     30 
     31 /**
     32  * Fill the provided buffer with a string containing a timestamp
     33  * representation.
     34  *
     35  * @param buf a buffer with size in bytes of at least AV_TS_MAX_STRING_SIZE
     36  * @param ts the timestamp to represent
     37  * @return the buffer in input
     38  */
     39 static inline char *av_ts_make_string(char *buf, int64_t ts)
     40 {
     41     if (ts == AV_NOPTS_VALUE) snprintf(buf, AV_TS_MAX_STRING_SIZE, "NOPTS");
     42     else                      snprintf(buf, AV_TS_MAX_STRING_SIZE, "%"PRId64, ts);
     43     return buf;
     44 }
     45 
     46 /**
     47  * Convenience macro, the return value should be used only directly in
     48  * function arguments but never stand-alone.
     49  */
     50 #define av_ts2str(ts) av_ts_make_string((char[AV_TS_MAX_STRING_SIZE]){0}, ts)
     51 
     52 /**
     53  * Fill the provided buffer with a string containing a timestamp time
     54  * representation.
     55  *
     56  * @param buf a buffer with size in bytes of at least AV_TS_MAX_STRING_SIZE
     57  * @param ts the timestamp to represent
     58  * @param tb the timebase of the timestamp
     59  * @return the buffer in input
     60  */
     61 static inline char *av_ts_make_time_string(char *buf, int64_t ts, AVRational *tb)
     62 {
     63     if (ts == AV_NOPTS_VALUE) snprintf(buf, AV_TS_MAX_STRING_SIZE, "NOPTS");
     64     else                      snprintf(buf, AV_TS_MAX_STRING_SIZE, "%.6g", av_q2d(*tb) * ts);
     65     return buf;
     66 }
     67 
     68 /**
     69  * Convenience macro, the return value should be used only directly in
     70  * function arguments but never stand-alone.
     71  */
     72 #define av_ts2timestr(ts, tb) av_ts_make_time_string((char[AV_TS_MAX_STRING_SIZE]){0}, ts, tb)
     73 
     74 #endif /* AVUTIL_TIMESTAMP_H */
     75