xref: /aosp_15_r20/external/oboe/src/common/AudioClock.h (revision 05767d913155b055644481607e6fa1e35e2fe72c)
1*05767d91SRobert Wu /*
2*05767d91SRobert Wu  * Copyright (C) 2016 The Android Open Source Project
3*05767d91SRobert Wu  *
4*05767d91SRobert Wu  * Licensed under the Apache License, Version 2.0 (the "License");
5*05767d91SRobert Wu  * you may not use this file except in compliance with the License.
6*05767d91SRobert Wu  * You may obtain a copy of the License at
7*05767d91SRobert Wu  *
8*05767d91SRobert Wu  *      http://www.apache.org/licenses/LICENSE-2.0
9*05767d91SRobert Wu  *
10*05767d91SRobert Wu  * Unless required by applicable law or agreed to in writing, software
11*05767d91SRobert Wu  * distributed under the License is distributed on an "AS IS" BASIS,
12*05767d91SRobert Wu  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13*05767d91SRobert Wu  * See the License for the specific language governing permissions and
14*05767d91SRobert Wu  * limitations under the License.
15*05767d91SRobert Wu  */
16*05767d91SRobert Wu 
17*05767d91SRobert Wu #ifndef OBOE_AUDIO_CLOCK_H
18*05767d91SRobert Wu #define OBOE_AUDIO_CLOCK_H
19*05767d91SRobert Wu 
20*05767d91SRobert Wu #include <sys/types.h>
21*05767d91SRobert Wu #include <ctime>
22*05767d91SRobert Wu #include "oboe/Definitions.h"
23*05767d91SRobert Wu 
24*05767d91SRobert Wu namespace oboe {
25*05767d91SRobert Wu 
26*05767d91SRobert Wu // TODO: Move this class into the public headers because it is useful when calculating stream latency
27*05767d91SRobert Wu class AudioClock {
28*05767d91SRobert Wu public:
29*05767d91SRobert Wu     static int64_t getNanoseconds(clockid_t clockId = CLOCK_MONOTONIC) {
30*05767d91SRobert Wu         struct timespec time;
31*05767d91SRobert Wu         int result = clock_gettime(clockId, &time);
32*05767d91SRobert Wu         if (result < 0) {
33*05767d91SRobert Wu             return result;
34*05767d91SRobert Wu         }
35*05767d91SRobert Wu         return (time.tv_sec * kNanosPerSecond) + time.tv_nsec;
36*05767d91SRobert Wu     }
37*05767d91SRobert Wu 
38*05767d91SRobert Wu     /**
39*05767d91SRobert Wu      * Sleep until the specified time.
40*05767d91SRobert Wu      *
41*05767d91SRobert Wu      * @param nanoTime time to wake up
42*05767d91SRobert Wu      * @param clockId CLOCK_MONOTONIC is default
43*05767d91SRobert Wu      * @return 0 or a negative error, eg. -EINTR
44*05767d91SRobert Wu      */
45*05767d91SRobert Wu 
46*05767d91SRobert Wu     static int sleepUntilNanoTime(int64_t nanoTime, clockid_t clockId = CLOCK_MONOTONIC) {
47*05767d91SRobert Wu         struct timespec time;
48*05767d91SRobert Wu         time.tv_sec = nanoTime / kNanosPerSecond;
49*05767d91SRobert Wu         time.tv_nsec = nanoTime - (time.tv_sec * kNanosPerSecond);
50*05767d91SRobert Wu         return 0 - clock_nanosleep(clockId, TIMER_ABSTIME, &time, NULL);
51*05767d91SRobert Wu     }
52*05767d91SRobert Wu 
53*05767d91SRobert Wu     /**
54*05767d91SRobert Wu      * Sleep for the specified number of nanoseconds in real-time.
55*05767d91SRobert Wu      * Return immediately with 0 if a negative nanoseconds is specified.
56*05767d91SRobert Wu      *
57*05767d91SRobert Wu      * @param nanoseconds time to sleep
58*05767d91SRobert Wu      * @param clockId CLOCK_REALTIME is default
59*05767d91SRobert Wu      * @return 0 or a negative error, eg. -EINTR
60*05767d91SRobert Wu      */
61*05767d91SRobert Wu 
62*05767d91SRobert Wu     static int sleepForNanos(int64_t nanoseconds, clockid_t clockId = CLOCK_REALTIME) {
63*05767d91SRobert Wu         if (nanoseconds > 0) {
64*05767d91SRobert Wu             struct timespec time;
65*05767d91SRobert Wu             time.tv_sec = nanoseconds / kNanosPerSecond;
66*05767d91SRobert Wu             time.tv_nsec = nanoseconds - (time.tv_sec * kNanosPerSecond);
67*05767d91SRobert Wu             return 0 - clock_nanosleep(clockId, 0, &time, NULL);
68*05767d91SRobert Wu         }
69*05767d91SRobert Wu         return 0;
70*05767d91SRobert Wu     }
71*05767d91SRobert Wu };
72*05767d91SRobert Wu 
73*05767d91SRobert Wu } // namespace oboe
74*05767d91SRobert Wu 
75*05767d91SRobert Wu #endif //OBOE_AUDIO_CLOCK_H
76