Files
FlaxEngine/Source/Engine/ContentImporters/ImportAudio.h
2022-01-14 13:31:12 +01:00

98 lines
2.6 KiB
C++

// Copyright (c) 2012-2022 Wojciech Figat. All rights reserved.
#pragma once
#include "Types.h"
#include "Engine/Tools/AudioTool/AudioDecoder.h"
#include "Engine/Serialization/ISerializable.h"
#include "Engine/Audio/Config.h"
#if COMPILE_WITH_ASSETS_IMPORTER
/// <summary>
/// Enable/disable caching audio import options
/// </summary>
#define IMPORT_AUDIO_CACHE_OPTIONS 1
/// <summary>
/// Importing audio utility
/// </summary>
class ImportAudio
{
public:
/// <summary>
/// Importing audio options
/// </summary>
struct Options : public ISerializable
{
AudioFormat Format;
bool DisableStreaming;
bool Is3D;
int32 BitDepth;
float Quality;
/// <summary>
/// Initializes a new instance of the <see cref="Options"/> struct.
/// </summary>
Options();
/// <summary>
/// Gets string that contains information about options
/// </summary>
/// <returns>String</returns>
String ToString() const;
public:
// [ISerializable]
void Serialize(SerializeStream& stream, const void* otherObj) override;
void Deserialize(DeserializeStream& stream, ISerializeModifier* modifier) override;
};
public:
/// <summary>
/// Tries the get audio import options from the target location asset.
/// </summary>
/// <param name="path">The asset path.</param>
/// <param name="options">The options.</param>
/// <returns>True if success, otherwise false.</returns>
static bool TryGetImportOptions(String path, Options& options);
/// <summary>
/// Imports the audio data (with given audio decoder).
/// </summary>
/// <param name="context">The importing context.</param>
/// <param name="decoder">The audio decoder.</param>
/// <returns>Result.</returns>
static CreateAssetResult Import(CreateAssetContext& context, AudioDecoder& decoder);
/// <summary>
/// Imports the .wav audio file.
/// </summary>
/// <param name="context">The importing context.</param>
/// <returns>Result.</returns>
static CreateAssetResult ImportWav(CreateAssetContext& context);
/// <summary>
/// Imports the .mp3 audio file.
/// </summary>
/// <param name="context">The importing context.</param>
/// <returns>Result.</returns>
static CreateAssetResult ImportMp3(CreateAssetContext& context);
#if COMPILE_WITH_OGG_VORBIS
/// <summary>
/// Imports the .ogg audio file.
/// </summary>
/// <param name="context">The importing context.</param>
/// <returns>Result.</returns>
static CreateAssetResult ImportOgg(CreateAssetContext& context);
#endif
};
#endif