pxmlw6n2f/Gazebo_Distributed_MPI/gazebo/common/AudioDecoder.hh

93 lines
2.7 KiB
C++
Raw Normal View History

2019-04-18 10:27:54 +08:00
/*
* Copyright (C) 2012 Open Source Robotics Foundation
*
* 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 _GAZEBO_AUDIO_DECODER_HH_
#define _GAZEBO_AUDIO_DECODER_HH_
#include <stdint.h>
#include <string>
#include "gazebo/util/system.hh"
struct AVFormatContext;
struct AVCodecContext;
struct AVCodec;
namespace gazebo
{
namespace common
{
/// \addtogroup gazebo_common Common
/// \brief Classes and functions used by multiple modules.
/// \{
/// \class AudioDecoder AudioDecoder.hh common/common.hh
/// \brief An audio decoder based on FFMPEG.
class GZ_COMMON_VISIBLE AudioDecoder
{
/// \brief Constructor.
public: AudioDecoder();
/// \brief Destructor.
public: virtual ~AudioDecoder();
/// \brief Set the file to decode.
/// \param[in] _filename Path to an audio file.
/// \return True if the file was successfull opened.
public: bool SetFile(const std::string &_filename);
/// \brief Get the audio filename that was set.
/// \return The name of the set audio file.
/// \sa AudioDecoder::SetFile
public: std::string GetFile() const;
/// \brief Decode the loaded audio file.
/// \sa AudioDecoder::SetFile
/// \param[out] _outBuffer Buffer that holds the decoded audio data.
/// \param[out] _outBufferSize Size of the _outBuffer.
/// \return True if decoding was succesful.
public: bool Decode(uint8_t **_outBuffer, unsigned int *_outBufferSize);
/// \brief Get the sample rate from the latest decoded file.
/// \return Integer sample rate, such as 44100.
public: int GetSampleRate();
/// \brief Free audio object, close files, streams.
private: void Cleanup();
/// \brief libav Format I/O context.
private: AVFormatContext *formatCtx;
/// \brief libav main external API structure.
private: AVCodecContext *codecCtx;
/// \brief libavcodec audio codec.
private: AVCodec *codec;
/// \brief Index of the audio stream.
private: int audioStream;
/// \brief True when initialized. We just want to initialize once..
private: static bool initialized;
/// \brief Audio file to decode.
private: std::string filename;
};
/// \}
}
}
#endif