filmstro_ffmpeg_FFmpegVideoReader.h

Go to the documentation of this file.

/*
  ==============================================================================
  Copyright (c) 2017, Filmstro Ltd. - Daniel Walz
  All rights reserved.

  Redistribution and use in source and binary forms, with or without modification,
  are permitted provided that the following conditions are met:
  1. Redistributions of source code must retain the above copyright notice, this
     list of conditions and the following disclaimer.
  2. Redistributions in binary form must reproduce the above copyright notice,
     this list of conditions and the following disclaimer in the documentation
     and/or other materials provided with the distribution.
  3. Neither the name of the copyright holder nor the names of its contributors
     may be used to endorse or promote products derived from this software without
     specific prior written permission.

  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
  INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
  LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
  OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
  OF THE POSSIBILITY OF SUCH DAMAGE.
  ==============================================================================
  \class        FFmpegVideoReader
  \file         filmstro_ffmpeg_FFmpegVideoReader.h
  \brief        A component to view a video decoded by FFmpeg
 
  \author       Daniel Walz @ filmstro.com
  \date         August 31st 2016

  \description  This class will read a video file using ffmpeg

  ==============================================================================
 */


#ifndef FILMSTRO_FFMPEG_FFMPEGVIDEOREADER_H_INCLUDED
#define FILMSTRO_FFMPEG_FFMPEGVIDEOREADER_H_INCLUDED

#include <atomic>

class FFmpegVideoReader :   public juce::PositionableAudioSource
{
public:

    FFmpegVideoReader (const int audioFifoSize=192000, const int videoFifoSize=20);
    virtual ~FFmpegVideoReader();

    // ==============================================================================
    // video decoder thread
    // ==============================================================================
    class DecoderThread : public juce::Thread
    {
    public:
        DecoderThread (AudioBufferFIFO<float>& fifo, const int videoFifoSize);

        virtual ~DecoderThread ();

        bool loadMovieFile (const juce::File& inputFile);

        void closeMovieFile ();

        void addVideoListener (FFmpegVideoListener* listener);

        void removeVideoListener (FFmpegVideoListener* listener);

        void run() override;

        void setCurrentPTS (const double pts, bool seek = false);

        double getCurrentPTS () const;

        int getVideoWidth () const;

        int getVideoHeight () const;

        enum AVPixelFormat getPixelFormat () const;

        double getPixelAspect () const;

        enum AVSampleFormat getSampleFormat () const;

        double  getFramesPerSecond () const;

        AVRational getVideoTimeBase () const;

        AVFormatContext* getVideoReaderContext();

        double getSampleRate () const;

        double getDuration () const;

        int getNumChannels () const;

        AVCodecContext* getVideoContext () const;
        AVCodecContext* getAudioContext () const;
        AVCodecContext* getSubtitleContext () const;

    private:

        int openCodecContext (AVCodecContext** decoderContext,
                              enum AVMediaType type,
                              bool refCounted);

        int decodeAudioPacket (AVPacket packet);

        double decodeVideoPacket (AVPacket packet);


        // ==============================================================================


        AudioBufferFIFO<float>& audioFifo;
        
        juce::WaitableEvent waitForPacket;

        std::vector<std::pair<double, AVFrame*> > videoFrames;
        std::atomic<int>    videoFifoRead;
        std::atomic<int>    videoFifoWrite;

        AVFormatContext*    formatContext;
        AVCodecContext*     videoContext;
        AVCodecContext*     audioContext;
        AVCodecContext*     subtitleContext;

        int                 videoStreamIdx;
        int                 audioStreamIdx;
        int                 subtitleStreamIdx;

        AVFrame*            audioFrame;

        std::atomic<double> currentPTS;

        juce::ListenerList<FFmpegVideoListener> videoListeners;

        juce::AudioBuffer<float> buffer;

    };

    // ==============================================================================
    // video methods
    // ==============================================================================

    bool    loadMovieFile (const juce::File& inputFile);

    void    closeMovieFile ();

    juce::File getVideoFileName () const;

    double  getFramesPerSecond () const;

    double  getCurrentTimeStamp() const;

    double  getVideoDuration () const;

    int     getVideoSamplingRate () const;

    int     getVideoChannels () const;

    enum AVSampleFormat getSampleFormat () const;

    void addVideoListener (FFmpegVideoListener* listener);

    void removeVideoListener (FFmpegVideoListener* listener);

    double getLastVideoPTS () const;

    int getVideoWidth () const;

    int getVideoHeight () const;

    double getVideoAspectRatio () const;

    double getVideoPixelAspect () const;

    enum AVPixelFormat getPixelFormat () const;

    AVRational getVideoTimeBase () const;

    static juce::String formatTimeCode (const double tc);


    // ==============================================================================
    // from PositionableAudioSource
    // ==============================================================================

    void    prepareToPlay (int samplesPerBlockExpected, double sampleRate) override;

    void    releaseResources () override;

    void    getNextAudioBlock (const juce::AudioSourceChannelInfo &bufferToFill) override;

    bool    waitForNextAudioBlockReady (const juce::AudioSourceChannelInfo &bufferToFill, const int msecs) const;

    void    setNextReadPosition (juce::int64 newPosition) override;

    juce::int64     getNextReadPosition () const override;

    juce::int64     getTotalLength () const override;

    bool isLooping() const override;

    void setLooping (bool shouldLoop) override;

    // ==============================================================================
    // FFmpeg low level
    // ==============================================================================

    AVCodecContext* getVideoContext () const;
    AVCodecContext* getAudioContext () const;
    AVCodecContext* getSubtitleContext () const;


    // ==============================================================================
private:

    juce::File  videoFileName;

    bool        fileReadyToRead;

    bool        looping;

    int         sampleRate;

    double      framesPerSec;

    double      resampleFactor;

    double      currentTimeStamp;

    juce::int64                         nextReadPos;

    AudioBufferFIFO<float>              audioFifo;

    DecoderThread                       decoder;

    // use WeakReference so that removing a source doesn't lead to disaster
    juce::WeakReference<FFmpegVideoReader>::Master masterReference;
    friend class juce::WeakReference<FFmpegVideoReader>;

    JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (FFmpegVideoReader)
};

#endif /* FILMSTRO_FFMPEG_FFMPEGVIDEOREADER_H_INCLUDED */