source: vbox/trunk/src/VBox/Main/src-client/EbmlWriter.h@ 65224

/* $Id: EbmlWriter.h 65212 2017-01-09 15:57:02Z vboxsync $ */
/** @file
 * EbmlWriter.h - EBML writer + WebM container.
 */

/*
 * Copyright (C) 2013-2017 Oracle Corporation
 *
 * This file is part of VirtualBox Open Source Edition (OSE), as
 * available from http://www.virtualbox.org. This file is free software;
 * you can redistribute it and/or modify it under the terms of the GNU
 * General Public License (GPL) as published by the Free Software
 * Foundation, in version 2 as it comes in the "COPYING" file of the
 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
 */

#ifndef ____EBMLWRITER
#define ____EBMLWRITER

#ifdef _MSC_VER
# pragma warning(push)
# pragma warning(disable: 4668) /* vpx_codec.h(64) : warning C4668: '__GNUC__' is not defined as a preprocessor macro, replacing with '0' for '#if/#elif' */
#include <vpx/vpx_encoder.h>
# pragma warning(pop)
#else
# include <vpx/vpx_encoder.h>
#endif

#include <iprt/file.h>

class WebMWriter_Impl;

class WebMWriter
{

public:

    /**
     * Supported audio codecs.
     */
    enum AudioCodec
    {
        /** No audio codec specified. */
        AudioCodec_Unknown = 0,
        /** Opus. */
        AudioCodec_Opus    = 1
    };

    /**
     * Supported video codecs.
     */
    enum VideoCodec
    {
        /** No video codec specified. */
        VideoCodec_None = 0,
        /** VP8. */
        VideoCodec_VP8  = 1
    };

    struct BlockData
    {
        void  *pvData;
        size_t cbData;
    };

    /**
     * Operation mode -- this specifies what to write.
     */
    enum Mode
    {
        /** Unknown / invalid mode. */
        Mode_Unknown     = 0,
        /** Only writes audio. */
        Mode_Audio       = 1,
        /** Only writes video. */
        Mode_Video       = 2,
        /** Writes audio and video. */
        Mode_AudioVideo  = 3
    };

public:

    WebMWriter();
    virtual ~WebMWriter();

    /**
     * Creates output file.
     *
     * @param   a_pszFilename   Name of the file to create.
     * @param   a_fOpen         File open mode of type RTFILE_O_.
     * @param   a_enmMode       Operation mode.
     * @param   a_enmAudioCodec Audio codec to use.
     * @param   a_enmVideoCodec Video codec to use.
     *
     * @returns VBox status code. */
    int create(const char *a_pszFilename, uint64_t a_fOpen, WebMWriter::Mode a_enmMode,
               WebMWriter::AudioCodec a_enmAudioCodec, WebMWriter::VideoCodec a_enmVideoCodec);

    /** Closes output file. */
    void close();

    /**
     * Writes WebM header to file.
     * Should be called before any writeBlock call.
     *
     * @param a_pCfg Pointer to VPX Codec configuration structure.
     * @param a_pFps Framerate information (frames per second).
     *
     * @returns VBox status code.
     */
    int writeHeader(const vpx_codec_enc_cfg_t *a_pCfg, const vpx_rational *a_pFps);

    /**
     * Writes a block of compressed data.
     *
     * @param a_pCfg Pointer to VPX Codec configuration structure.
     * @param a_pPkt VPX data packet.
     *
     * @returns VBox status code.
     */
    int writeBlock(const vpx_codec_enc_cfg_t *a_pCfg, const vpx_codec_cx_pkt_t *a_pPkt);

    /**
     * Writes WebM footer.
     * No other write functions should be called after this one.
     *
     * @param a_u64Hash Hash value for the data written.
     *
     * @returns VBox status code.
     */
    int writeFooter(uint32_t a_u64Hash);

    /**
     * Gets current output file size.
     *
     * @returns File size in bytes.
     */
    uint64_t getFileSize(void);

    /**
     * Gets current free storage space available for the file.
     *
     * @returns Available storage free space.
     */
    uint64_t getAvailableSpace(void);

private:

    /** WebMWriter implementation.
     *  To isolate some include files. */
    WebMWriter_Impl *m_pImpl;

    DECLARE_CLS_COPY_CTOR_ASSIGN_NOOP(WebMWriter);
};

#endif /* ____EBMLWRITER */