include/cinder/qtime/MovieWriter.h

Go to the documentation of this file.

/*
 Copyright (c) 2010, The Barbarian Group
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification, are permitted provided that
 the following conditions are met:
 
 * Redistributions of source code must retain the above copyright notice, this list of conditions and
 the following disclaimer.
 * 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.
 
 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.
 */

#pragma once

#include "cinder/Cinder.h"
#include "cinder/ImageIo.h"
#include "cinder/Stream.h"
#include "cinder/qtime/QuickTime.h"

#include <string>

// These forward declarations prevent us from having to bring all of QuickTime into the global namespace in MSW
#if defined( CINDER_MSW )
    typedef struct ComponentInstanceRecord      ComponentInstanceRecord;
    typedef ComponentInstanceRecord *           ComponentInstance;
    typedef ComponentInstance                   DataHandler;
    typedef struct TrackType**                  Track;
    typedef struct MediaType**                  Media;
    typedef struct OpaqueICMCompressionSession*         ICMCompressionSessionRef;
    typedef struct OpaqueICMCompressionSessionOptions*  ICMCompressionSessionOptionsRef;
    typedef const struct OpaqueICMEncodedFrame* ICMEncodedFrameRef;
    typedef signed long                         OSStatus;
    typedef unsigned long                       CodecType;
    typedef unsigned long                       ICMCompressionPassModeFlags;
#else
    #include <QuickTime/QuickTime.h>
    #include <QuickTime/ImageCompression.h>
#endif // defined( CINDER_MSW )


namespace cinder { namespace qtime {

class MovieWriter;
typedef std::shared_ptr<MovieWriter>    MovieWriterRef;

class MovieWriter {
    struct Obj;

  public:
    class Format {
      public:
        Format();
        Format( uint32_t codec, float quality );
        Format( const ICMCompressionSessionOptionsRef settings, uint32_t codec, float quality, float frameRate, bool enableMultiPass );
        Format( const Format &format );
        ~Format();

        const Format& operator=( const Format &format );

        uint32_t    getCodec() const { return mCodec; }
        Format&     setCodec( uint32_t codec ) { mCodec = codec; return *this; }
        float       getQuality() const { return mQualityFloat; }
        Format&     setQuality( float quality );
        float       getDefaultDuration() const { return mDefaultTime; }
        Format&     setDefaultDuration( float defaultDuration ) { mDefaultTime = defaultDuration; return *this; }
        long        getTimeScale() const { return mTimeBase; }
        Format&     setTimeScale( long timeScale ) { mTimeBase = timeScale; return *this; }
        float       getGamma() const { return mGamma; }
        Format&     setGamma( float gamma ) { mGamma = gamma; return *this; }
        bool        isTemporal() const;
        Format&     enableTemporal( bool enable = true );
        bool        isReordering() const;
        Format&     enableReordering( bool enable = true );
        int32_t     getMaxKeyFrameRate() const;
        Format&     setMaxKeyFrameRate( int32_t rate );
        bool        isFrameTimeChanges() const;
        Format&     enableFrameTimeChanges( bool enable = true );
        bool        isMultiPass() const { return mEnableMultiPass; }
        Format&     enableMultiPass( bool enable = true ) { mEnableMultiPass = enable; return *this; }

      private:
        void        initDefaults();

        uint32_t    mCodec;
        long        mTimeBase;
        float       mDefaultTime;
        float       mQualityFloat;
        float       mGamma;
        bool        mEnableMultiPass;

        ICMCompressionSessionOptionsRef     mOptions;

        friend class MovieWriter;
        friend struct Obj;
    };


    MovieWriter() {}
    MovieWriter( const fs::path &path, int32_t width, int32_t height, const Format &format = Format::Format() );

    static MovieWriterRef   create( const fs::path &path, int32_t width, int32_t height, const Format &format = Format::Format() )
        { return std::shared_ptr<MovieWriter>( new MovieWriter( path, width, height, format ) ); }

    float   getDefaultDuration() const { return mObj->mFormat.mDefaultTime; }
    int32_t getWidth() const { return mObj->mWidth; }
    int32_t getHeight() const { return mObj->mHeight; }
    Vec2i   getSize() const { return Vec2i( getWidth(), getHeight() ); }
    float   getAspectRatio() const { return getWidth() / (float)getHeight(); }
    Area    getBounds() const { return Area( 0, 0, getWidth(), getHeight() ); }

    const Format&   getFormat() const { return mObj->mFormat; }

    static bool     getUserCompressionSettings( Format *result, ImageSourceRef previewImage = ImageSourceRef() );

    void addFrame( const ImageSourceRef &imageSource, float duration = -1.0f ) { mObj->addFrame( imageSource, duration ); }
    
    uint32_t    getNumFrames() const { return mObj->mNumFrames; }

    void finish() { mObj->finish(); }
    
    enum { CODEC_H264 = 'avc1', CODEC_JPEG = 'jpeg', CODEC_MP4 = 'mp4v', CODEC_PNG = 'png ', CODEC_RAW = 'raw ', CODEC_ANIMATION = 'rle ' };

  private:
    struct Obj {
        Obj( const fs::path &path, int32_t width, int32_t height, const Format &format );
        ~Obj();
        
        void    addFrame( const ImageSourceRef &imageSource, float duration );
        void    createCompressionSession();
        void    finish();
        
        static OSStatus encodedFrameOutputCallback( void *refCon, ::ICMCompressionSessionRef session, OSStatus err, ICMEncodedFrameRef encodedFrame, void *reserved );

        ::Movie                         mMovie;
        ::DataHandler                   mDataHandler;
        ::Track                         mTrack;
        ::Media                         mMedia;
        ::ICMCompressionSessionRef      mCompressionSession;
        ::ICMCompressionPassModeFlags   mMultiPassModeFlags;        
        fs::path        mPath;
        uint32_t        mNumFrames;
        int64_t         mCurrentTimeValue;
        
        int32_t     mWidth, mHeight;
        Format      mFormat;
        bool        mRequestedMultiPass, mDoingMultiPass, mFinished;        

        IoStreamRef     mMultiPassFrameCache;

        std::vector<std::pair<int64_t,int64_t> >    mFrameTimes;
    };
    
    std::shared_ptr<Obj>        mObj;  

  public:

    typedef std::shared_ptr<Obj> MovieWriter::*unspecified_bool_type;
    operator unspecified_bool_type() const { return ( mObj.get() == 0 ) ? 0 : &MovieWriter::mObj; }
    void reset() { mObj.reset(); }
};

class MovieWriterExc : public Exception {
};
class MovieWriterExcInvalidPath : public MovieWriterExc {
};
class MovieWriterExcFrameEncode : public MovieWriterExc {
};
class MovieWriterExcAlreadyFinished : public MovieWriterExc {
};

} } // namespace cinder::qtime