AAX_StringUtilities.h

Go to the documentation of this file.

/*================================================================================================*/
/*
 *
 *  Copyright 2014-2016, 2018, 2023-2024 Avid Technology, Inc.
 *  All rights reserved.
 *  
 *  This file is part of the Avid AAX SDK.
 *  
 *  The AAX SDK is subject to commercial or open-source licensing.
 *  
 *  By using the AAX SDK, you agree to the terms of both the Avid AAX SDK License
 *  Agreement and Avid Privacy Policy.
 *  
 *  AAX SDK License: https://developer.avid.com/aax
 *  Privacy Policy: https://www.avid.com/legal/privacy-policy-statement
 *  
 *  Or: You may also use this code under the terms of the GPL v3 (see
 *  www.gnu.org/licenses).
 *  
 *  THE AAX SDK IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL WARRANTIES, WHETHER
 *  EXPRESSED OR IMPLIED, INCLUDING MERCHANTABILITY AND FITNESS FOR PURPOSE, ARE
 *  DISCLAIMED.
 */
 
/*================================================================================================*/
#pragma once
 
#ifndef AAXLibrary_AAX_StringUtilities_h
#define AAXLibrary_AAX_StringUtilities_h
 
// AAX headers
#include "AAX.h"
#include "AAX_Enums.h"
 
// Standard Library headers
#include <string>
 
class AAX_IString;
 
 
//------------------------------------------------
#pragma mark Utility functions
 
namespace AAX
{
    inline void         GetCStringOfLength(char *stringOut, const char* stringIn, int32_t aMaxChars);
    inline int32_t      Caseless_strcmp(const char* cs, const char* ct);
    
    inline std::string  Binary2String(uint32_t binaryValue, int32_t numBits);
    inline uint32_t     String2Binary(const AAX_IString& s);
    
    inline bool         IsASCII(char inChar);
    inline bool         IsFourCharASCII(uint32_t inFourChar);
    
    inline std::string  AsStringFourChar(uint32_t inFourChar);
    inline std::string  AsStringPropertyValue(AAX_EProperty inProperty, AAX_CPropertyValue inPropertyValue);
    inline std::string  AsStringInt32(int32_t inInt32);
    inline std::string  AsStringUInt32(uint32_t inUInt32);
    inline std::string  AsStringIDTriad(const AAX_SPlugInIdentifierTriad& inIDTriad);
    inline std::string  AsStringStemFormat(AAX_EStemFormat inStemFormat, bool inAbbreviate = false);
    inline std::string  AsStringStemChannel(AAX_EStemFormat inStemFormat, uint32_t inChannelIndex, bool inAbbreviate);
    inline std::string  AsStringResult(AAX_Result inResult);
    inline std::string  AsStringSupportLevel(AAX_ESupportLevel inSupportLevel);
} // namespace AAX
 
 
//------------------------------------------------------
#pragma mark Implementation header
 
#include "AAX_StringUtilities.hpp"
 
 
#endif /* AAXLibrary_AAX_StringUtilities_h */