stream.h

Go to the documentation of this file.

#pragma once
 
#include <memory>
 
#include "averror.h"
#include "ffmpeg.h"
#include "rational.h"
#include "timestamp.h"
#include "codecparameters.h"
 
namespace av
{
 
enum class Direction
{
    Invalid = -1,
    Encoding,
    Decoding
};
 
 
class Stream : public FFWrapperPtr<AVStream>
{
private:
    friend class FormatContext;
    Stream(const std::shared_ptr<char> &monitor, AVStream *st = nullptr, Direction direction = Direction::Invalid);
 
public:
    Stream() = default;
 
    bool isValid() const;
 
    int index() const;
    int id() const;
 
    Rational    frameRate()          const;
    Rational    timeBase()           const;
    Rational    sampleAspectRatio()  const;
    Rational    averageFrameRate()   const;
    Timestamp   startTime()          const;
    Timestamp   duration()           const;
 
    [[deprecated("For FFmpeg 5.0+ return NO_PTS")]]
    Timestamp   currentDts()         const;
    AVMediaType mediaType()          const;
 
    bool isAudio()      const;
    bool isVideo()      const;
    bool isData()       const;
    bool isSubtitle()   const;
    bool isAttachment() const;
 
    Direction   direction() const { return m_direction; }
 
    void setTimeBase(const Rational &timeBase);
    void setFrameRate(const Rational &frameRate);
    void setSampleAspectRatio(const Rational &aspectRatio);
    void setAverageFrameRate(const Rational &frameRate);
 
    CodecParametersView codecParameters() const;
    void setCodecParameters(CodecParametersView codecpar, OptionalErrorCode ec = throws());
 
    int eventFlags() const noexcept;
    bool eventFlags(int flags) const noexcept;
    void eventFlagsClear(int flags) noexcept;
 
    void setupEncodingParameters(const class VideoEncoderContext& ctx, OptionalErrorCode ec = throws());
 
private:
    std::weak_ptr<char> m_parentMonitor;
    Direction           m_direction = Direction::Invalid;
};
 
} // ::av