Line data    Source code

       1              : /*
       2              :  * SPDX-License-Identifier: GPL-3.0-only
       3              :  * MuseScore-CLA-applies
       4              :  *
       5              :  * MuseScore Studio
       6              :  * Music Composition & Notation
       7              :  *
       8              :  * Copyright (C) 2026 MuseScore Limited and others
       9              :  *
      10              :  * This program is free software: you can redistribute it and/or modify
      11              :  * it under the terms of the GNU General Public License version 3 as
      12              :  * published by the Free Software Foundation.
      13              :  *
      14              :  * This program is distributed in the hope that it will be useful,
      15              :  * but WITHOUT ANY WARRANTY; without even the implied warranty of
      16              :  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
      17              :  * GNU General Public License for more details.
      18              :  *
      19              :  * You should have received a copy of the GNU General Public License
      20              :  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
      21              :  */
      22              : 
      23              :  #pragma once
      24              : 
      25              :  #include "audiotypes.h"
      26              : 
      27              : namespace muse::audio {
      28              : struct TimePosition {
      29            0 :     inline samples_t samples() const { return m_samples; }
      30            0 :     inline sample_rate_t sampleRate() const { return m_sampleRate; }
      31            0 :     inline secs_t time() const { return m_time; }
      32              : 
      33            0 :     TimePosition() = default;
      34              :     TimePosition(const TimePosition& other) = default;
      35              :     TimePosition& operator=(const TimePosition& other) = default;
      36              : 
      37            0 :     inline bool operator==(const TimePosition& other) const
      38              :     {
      39            0 :         return m_samples == other.m_samples && m_sampleRate == other.m_sampleRate;
      40              :     }
      41              : 
      42              :     inline bool operator!=(const TimePosition& other) const { return !this->operator==(other); }
      43              : 
      44            0 :     inline bool isValid() const { return m_sampleRate > 0; }
      45              : 
      46            0 :     inline void forward(samples_t delta)
      47              :     {
      48            0 :         IF_ASSERT_FAILED(m_sampleRate > 0) {
      49            0 :             return;
      50              :         }
      51            0 :         m_samples += delta;
      52            0 :         m_time += static_cast<double>(delta) / m_sampleRate;
      53              :     }
      54              : 
      55              :     inline void forward(const TimePosition& delta)
      56              :     {
      57              :         IF_ASSERT_FAILED(delta.sampleRate() == m_sampleRate) {
      58              :             return;
      59              :         }
      60              :         forward(delta.samples());
      61              :     }
      62              : 
      63            0 :     inline TimePosition forwarded(samples_t delta) const
      64              :     {
      65            0 :         IF_ASSERT_FAILED(m_sampleRate > 0) {
      66            0 :             return TimePosition();
      67              :         }
      68            0 :         return TimePosition(m_samples + delta, m_sampleRate);
      69              :     }
      70              : 
      71            0 :     inline TimePosition forwarded(const TimePosition& delta) const
      72              :     {
      73            0 :         IF_ASSERT_FAILED(delta.sampleRate() == m_sampleRate) {
      74            0 :             return TimePosition();
      75              :         }
      76            0 :         return forwarded(delta.samples());
      77              :     }
      78              : 
      79            0 :     static inline TimePosition zero(sample_rate_t sampleRate)
      80              :     {
      81            0 :         IF_ASSERT_FAILED(sampleRate > 0) {
      82            0 :             return TimePosition();
      83              :         }
      84            0 :         return TimePosition(0, sampleRate);
      85              :     }
      86              : 
      87            0 :     static inline TimePosition fromSamples(samples_t samples, sample_rate_t sampleRate)
      88              :     {
      89            0 :         IF_ASSERT_FAILED(sampleRate > 0) {
      90            0 :             return TimePosition();
      91              :         }
      92              : 
      93            0 :         return TimePosition(samples, sampleRate);
      94              :     }
      95              : 
      96            0 :     static inline TimePosition fromTime(secs_t time, sample_rate_t sampleRate)
      97              :     {
      98            0 :         IF_ASSERT_FAILED(sampleRate > 0) {
      99            0 :             return TimePosition();
     100              :         }
     101              : 
     102            0 :         IF_ASSERT_FAILED(time >= 0.0) {
     103            0 :             return TimePosition();
     104              :         }
     105              : 
     106            0 :         return TimePosition(static_cast<samples_t>(std::llround(time.raw() * sampleRate)), sampleRate);
     107              :     }
     108              : 
     109              : private:
     110            0 :     inline TimePosition(samples_t samples, sample_rate_t sampleRate)
     111            0 :         : m_samples(samples)
     112            0 :         , m_sampleRate(sampleRate)
     113            0 :         , m_time(sampleRate > 0 ? static_cast<double>(samples) / sampleRate : 0.0)
     114            0 :     {}
     115              : 
     116              :     samples_t m_samples = 0;
     117              :     sample_rate_t m_sampleRate = 0;
     118              :     secs_t m_time = 0.0;     // cache
     119              : };
     120              : }