libs/ardour/ardour/smpte.h

   1 /*  Copyright (C) 2006 Paul Davis
   2
   3     This program is free software; you can redistribute it and/or modify it
   4     under the terms of the GNU General Public License as published by the
   5     Free Software Foundation; either version 2 of the License, or (at your
   6     option) any later version.
   7
   8     This program is distributed in the hope that it will be useful, but WITHOUT
   9     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  10     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  11     for more details.
  12
  13     You should have received a copy of the GNU General Public License along
  14     with this program; if not, write to the Free Software Foundation, Inc.,
  15     51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  16 */
  17
  18 #ifndef __ardour_smpte_h__
  19 #define __ardour_smpte_h__
  20
  21 #include <inttypes.h>
  22
  23 namespace SMPTE {
  24
  25 enum Wrap {
  26         NONE = 0,
  27         FRAMES,
  28         SECONDS,
  29         MINUTES,
  30         HOURS
  31 };
  32
  33 // FIXME: make this a float
  34 enum FPS {
  35     MTC_24_FPS = 0,
  36     MTC_25_FPS = 1,
  37     MTC_30_FPS_DROP = 2,
  38     MTC_30_FPS = 3
  39 };
  40
  41 struct Time {
  42         bool       negative;
  43         uint32_t   hours;
  44         uint32_t   minutes;
  45         uint32_t   seconds;
  46         uint32_t   frames;       ///< SMPTE frames (not audio samples)
  47         uint32_t   subframes;    ///< Typically unused
  48         FPS        rate;         ///< Frame rate of this Time
  49         static FPS default_rate; ///< Rate to use for default constructor
  50
  51         Time(FPS a_rate = default_rate) {
  52                 negative = false;
  53                 hours = 0;
  54                 minutes = 0;
  55                 seconds = 0;
  56                 frames = 0;
  57                 subframes = 0;
  58                 rate = a_rate;
  59         }
  60 };
  61
  62 Wrap increment( Time& smpte );
  63 Wrap decrement( Time& smpte );
  64 Wrap increment_subframes( Time& smpte );
  65 Wrap decrement_subframes( Time& smpte );
  66 Wrap increment_seconds( Time& smpte );
  67 Wrap increment_minutes( Time& smpte );
  68 Wrap increment_hours( Time& smpte );
  69 void frames_floor( Time& smpte );
  70 void seconds_floor( Time& smpte );
  71 void minutes_floor( Time& smpte );
  72 void hours_floor( Time& smpte );
  73
  74 } // namespace SMPTE
  75
  76 #endif  // __ardour_smpte_h__