Definitions.h

/*
 * Copyright (C) 2016 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 
#ifndef OBOE_DEFINITIONS_H
#define OBOE_DEFINITIONS_H
 
#include <cstdint>
#include <type_traits>
 
// Oboe needs to be able to build on old NDKs so we use hard coded constants.
// The correctness of these constants is verified in "aaudio/AAudioLoader.cpp".
 
namespace oboe {
 
    constexpr int32_t kUnspecified = 0;
 
    // TODO: Investigate using std::chrono
    constexpr int64_t kNanosPerMicrosecond =    1000;
 
    constexpr int64_t kNanosPerMillisecond =    kNanosPerMicrosecond * 1000;
 
    constexpr int64_t kMillisPerSecond =        1000;
 
    constexpr int64_t kNanosPerSecond =         kNanosPerMillisecond * kMillisPerSecond;
 
    enum class StreamState : int32_t { // aaudio_stream_state_t
        Uninitialized = 0, // AAUDIO_STREAM_STATE_UNINITIALIZED,
        Unknown = 1, // AAUDIO_STREAM_STATE_UNKNOWN,
        Open = 2, // AAUDIO_STREAM_STATE_OPEN,
        Starting = 3, // AAUDIO_STREAM_STATE_STARTING,
        Started = 4, // AAUDIO_STREAM_STATE_STARTED,
        Pausing = 5, // AAUDIO_STREAM_STATE_PAUSING,
        Paused = 6, // AAUDIO_STREAM_STATE_PAUSED,
        Flushing = 7, // AAUDIO_STREAM_STATE_FLUSHING,
        Flushed = 8, // AAUDIO_STREAM_STATE_FLUSHED,
        Stopping = 9, // AAUDIO_STREAM_STATE_STOPPING,
        Stopped = 10, // AAUDIO_STREAM_STATE_STOPPED,
        Closing = 11, // AAUDIO_STREAM_STATE_CLOSING,
        Closed = 12, // AAUDIO_STREAM_STATE_CLOSED,
        Disconnected = 13, // AAUDIO_STREAM_STATE_DISCONNECTED,
    };
 
    enum class Direction : int32_t { // aaudio_direction_t
 
        Output = 0, // AAUDIO_DIRECTION_OUTPUT,
 
        Input = 1, // AAUDIO_DIRECTION_INPUT,
    };
 
    enum class AudioFormat : int32_t { // aaudio_format_t
        Invalid = -1, // AAUDIO_FORMAT_INVALID,
 
        Unspecified = 0, // AAUDIO_FORMAT_UNSPECIFIED,
 
        I16 = 1, // AAUDIO_FORMAT_PCM_I16,
 
        Float = 2, // AAUDIO_FORMAT_PCM_FLOAT,
 
        I24 = 3, // AAUDIO_FORMAT_PCM_I24_PACKED
 
        I32 = 4, // AAUDIO_FORMAT_PCM_I32
 
        IEC61937 = 5, // AAUDIO_FORMAT_IEC61937
    };
 
    enum class DataCallbackResult : int32_t { // aaudio_data_callback_result_t
        // Indicates to the caller that the callbacks should continue.
        Continue = 0, // AAUDIO_CALLBACK_RESULT_CONTINUE,
 
        // Indicates to the caller that the callbacks should stop immediately.
        Stop = 1, // AAUDIO_CALLBACK_RESULT_STOP,
    };
 
    enum class Result : int32_t { // aaudio_result_t
        OK = 0, // AAUDIO_OK
        ErrorBase = -900, // AAUDIO_ERROR_BASE,
        ErrorDisconnected = -899, // AAUDIO_ERROR_DISCONNECTED,
        ErrorIllegalArgument = -898, // AAUDIO_ERROR_ILLEGAL_ARGUMENT,
        ErrorInternal = -896, // AAUDIO_ERROR_INTERNAL,
        ErrorInvalidState = -895, // AAUDIO_ERROR_INVALID_STATE,
        ErrorInvalidHandle = -892, // AAUDIO_ERROR_INVALID_HANDLE,
        ErrorUnimplemented = -890, // AAUDIO_ERROR_UNIMPLEMENTED,
        ErrorUnavailable = -889, // AAUDIO_ERROR_UNAVAILABLE,
        ErrorNoFreeHandles = -888, // AAUDIO_ERROR_NO_FREE_HANDLES,
        ErrorNoMemory = -887, // AAUDIO_ERROR_NO_MEMORY,
        ErrorNull = -886, // AAUDIO_ERROR_NULL,
        ErrorTimeout = -885, // AAUDIO_ERROR_TIMEOUT,
        ErrorWouldBlock = -884, // AAUDIO_ERROR_WOULD_BLOCK,
        ErrorInvalidFormat = -883, // AAUDIO_ERROR_INVALID_FORMAT,
        ErrorOutOfRange = -882, // AAUDIO_ERROR_OUT_OF_RANGE,
        ErrorNoService = -881, // AAUDIO_ERROR_NO_SERVICE,
        ErrorInvalidRate = -880, // AAUDIO_ERROR_INVALID_RATE,
        // Reserved for future AAudio result types
        Reserved1,
        Reserved2,
        Reserved3,
        Reserved4,
        Reserved5,
        Reserved6,
        Reserved7,
        Reserved8,
        Reserved9,
        Reserved10,
        ErrorClosed = -869,
    };
 
    enum class SharingMode : int32_t { // aaudio_sharing_mode_t
 
        Exclusive = 0, // AAUDIO_SHARING_MODE_EXCLUSIVE,
 
        Shared = 1, // AAUDIO_SHARING_MODE_SHARED,
    };
 
    enum class PerformanceMode : int32_t { // aaudio_performance_mode_t
 
        None = 10, // AAUDIO_PERFORMANCE_MODE_NONE,
 
        PowerSaving = 11, // AAUDIO_PERFORMANCE_MODE_POWER_SAVING,
 
        LowLatency = 12, // AAUDIO_PERFORMANCE_MODE_LOW_LATENCY
    };
 
    enum class AudioApi : int32_t {
        Unspecified = kUnspecified,
 
        OpenSLES,
 
        AAudio
    };
 
    enum class SampleRateConversionQuality : int32_t {
        None,
        Fastest,
        Low,
        Medium,
        High,
        Best,
    };
 
    enum class Usage : int32_t { // aaudio_usage_t
        Media =  1, // AAUDIO_USAGE_MEDIA
 
        VoiceCommunication = 2, // AAUDIO_USAGE_VOICE_COMMUNICATION
 
        VoiceCommunicationSignalling = 3, // AAUDIO_USAGE_VOICE_COMMUNICATION_SIGNALLING
 
        Alarm = 4, // AAUDIO_USAGE_ALARM
 
        Notification = 5, // AAUDIO_USAGE_NOTIFICATION
 
        NotificationRingtone = 6, // AAUDIO_USAGE_NOTIFICATION_RINGTONE
 
        NotificationEvent = 10, // AAUDIO_USAGE_NOTIFICATION_EVENT
 
        AssistanceAccessibility = 11, // AAUDIO_USAGE_ASSISTANCE_ACCESSIBILITY
 
        AssistanceNavigationGuidance = 12, // AAUDIO_USAGE_ASSISTANCE_NAVIGATION_GUIDANCE
 
        AssistanceSonification = 13, // AAUDIO_USAGE_ASSISTANCE_SONIFICATION
 
        Game = 14, // AAUDIO_USAGE_GAME
 
        Assistant = 16, // AAUDIO_USAGE_ASSISTANT
    };
 
 
    enum ContentType : int32_t { // aaudio_content_type_t
 
        Speech = 1, // AAUDIO_CONTENT_TYPE_SPEECH
 
        Music = 2, // AAUDIO_CONTENT_TYPE_MUSIC
 
        Movie = 3, // AAUDIO_CONTENT_TYPE_MOVIE
 
        Sonification = 4, // AAUDIO_CONTENT_TYPE_SONIFICATION
    };
 
    enum InputPreset : int32_t { // aaudio_input_preset_t
        Generic = 1, // AAUDIO_INPUT_PRESET_GENERIC
 
        Camcorder = 5, // AAUDIO_INPUT_PRESET_CAMCORDER
 
        VoiceRecognition = 6, // AAUDIO_INPUT_PRESET_VOICE_RECOGNITION
 
        VoiceCommunication = 7, // AAUDIO_INPUT_PRESET_VOICE_COMMUNICATION
 
        Unprocessed = 9, // AAUDIO_INPUT_PRESET_UNPROCESSED
 
         VoicePerformance = 10, // AAUDIO_INPUT_PRESET_VOICE_PERFORMANCE
 
    };
 
    enum SessionId {
         None = -1, // AAUDIO_SESSION_ID_NONE
 
         Allocate = 0, // AAUDIO_SESSION_ID_ALLOCATE
    };
 
    enum ChannelCount : int32_t {
      Unspecified = kUnspecified,
 
      Mono = 1,
 
      Stereo = 2,
    };
 
    enum class ChannelMask : uint32_t { // aaudio_channel_mask_t
        Unspecified = kUnspecified,
        FrontLeft = 1 << 0,
        FrontRight = 1 << 1,
        FrontCenter = 1 << 2,
        LowFrequency = 1 << 3,
        BackLeft = 1 << 4,
        BackRight = 1 << 5,
        FrontLeftOfCenter = 1 << 6,
        FrontRightOfCenter = 1 << 7,
        BackCenter = 1 << 8,
        SideLeft = 1 << 9,
        SideRight = 1 << 10,
        TopCenter = 1 << 11,
        TopFrontLeft = 1 << 12,
        TopFrontCenter = 1 << 13,
        TopFrontRight = 1 << 14,
        TopBackLeft = 1 << 15,
        TopBackCenter = 1 << 16,
        TopBackRight = 1 << 17,
        TopSideLeft = 1 << 18,
        TopSideRight = 1 << 19,
        BottomFrontLeft = 1 << 20,
        BottomFrontCenter = 1 << 21,
        BottomFrontRight = 1 << 22,
        LowFrequency2 = 1 << 23,
        FrontWideLeft = 1 << 24,
        FrontWideRight = 1 << 25,
 
        Mono = FrontLeft,
 
        Stereo = FrontLeft |
                 FrontRight,
 
        CM2Point1 = FrontLeft |
                    FrontRight |
                    LowFrequency,
 
        Tri = FrontLeft |
              FrontRight |
              FrontCenter,
 
        TriBack = FrontLeft |
                  FrontRight |
                  BackCenter,
 
        CM3Point1 = FrontLeft |
                    FrontRight |
                    FrontCenter |
                    LowFrequency,
 
        CM2Point0Point2 = FrontLeft |
                          FrontRight |
                          TopSideLeft |
                          TopSideRight,
 
        CM2Point1Point2 = CM2Point0Point2 |
                          LowFrequency,
 
        CM3Point0Point2 = FrontLeft |
                          FrontRight |
                          FrontCenter |
                          TopSideLeft |
                          TopSideRight,
 
        CM3Point1Point2 = CM3Point0Point2 |
                          LowFrequency,
 
        Quad = FrontLeft |
               FrontRight |
               BackLeft |
               BackRight,
 
        QuadSide = FrontLeft |
                   FrontRight |
                   SideLeft |
                   SideRight,
 
        Surround = FrontLeft |
                   FrontRight |
                   FrontCenter |
                   BackCenter,
 
        Penta = Quad |
                FrontCenter,
 
        CM5Point1 = FrontLeft |
                    FrontRight |
                    FrontCenter |
                    LowFrequency |
                    BackLeft |
                    BackRight,
 
        CM5Point1Side = FrontLeft |
                        FrontRight |
                        FrontCenter |
                        LowFrequency |
                        SideLeft |
                        SideRight,
 
        CM6Point1 = FrontLeft |
                    FrontRight |
                    FrontCenter |
                    LowFrequency |
                    BackLeft |
                    BackRight |
                    BackCenter,
 
        CM7Point1 = CM5Point1 |
                    SideLeft |
                    SideRight,
 
        CM5Point1Point2 = CM5Point1 |
                          TopSideLeft |
                          TopSideRight,
 
        CM5Point1Point4 = CM5Point1 |
                          TopFrontLeft |
                          TopFrontRight |
                          TopBackLeft |
                          TopBackRight,
 
        CM7Point1Point2 = CM7Point1 |
                          TopSideLeft |
                          TopSideRight,
 
        CM7Point1Point4 = CM7Point1 |
                          TopFrontLeft |
                          TopFrontRight |
                          TopBackLeft |
                          TopBackRight,
 
        CM9Point1Point4 = CM7Point1Point4 |
                          FrontWideLeft |
                          FrontWideRight,
 
        CM9Point1Point6 = CM9Point1Point4 |
                          TopSideLeft |
                          TopSideRight,
 
        FrontBack = FrontCenter |
                    BackCenter,
    };
 
    enum class SpatializationBehavior : int32_t {
 
        Unspecified = kUnspecified,
 
        Auto = 1,
 
        Never = 2,
    };
 
    enum class PrivacySensitiveMode : int32_t {
 
        Unspecified = kUnspecified,
 
        Disabled = 1,
 
        Enabled = 2,
    };
 
    enum class AllowedCapturePolicy : int32_t {
        Unspecified = kUnspecified,
        All = 1,
        System = 2,
        None = 3,
    };
 
    class DefaultStreamValues {
 
    public:
 
        static int32_t SampleRate;
        static int32_t FramesPerBurst;
        static int32_t ChannelCount;
 
    };
 
    struct FrameTimestamp {
        int64_t position; // in frames
        int64_t timestamp; // in nanoseconds
    };
 
    class OboeGlobals {
    public:
 
        static bool areWorkaroundsEnabled() {
            return mWorkaroundsEnabled;
        }
 
        static void setWorkaroundsEnabled(bool enabled) {
            mWorkaroundsEnabled = enabled;
        }
 
    private:
        static bool mWorkaroundsEnabled;
    };
} // namespace oboe
 
#endif // OBOE_DEFINITIONS_H