/*

 * Copyright 2017 Google Inc.

 *

 * Use of this source code is governed by a BSD-style license that can be

 * found in the LICENSE file.

 */

#ifndef SkEncoder_DEFINED

#define SkEncoder_DEFINED

#include "include/core/SkPixmap.h"

#include "include/private/base/SkAPI.h"

#include "include/private/base/SkNoncopyable.h"

#include "include/private/base/SkTemplates.h"

#include <cstddef>

#include <cstdint>

class SK_API SkEncoder : SkNoncopyable {

public:

    /**

     * A single frame to be encoded into an animated image.

     *

     * If a frame does not fit in the canvas size, this is an error.

     * TODO(skia:13705): Add offsets when we have support for an encoder that supports using

     * offsets.

     */

    struct SK_API Frame {

        /**

         *  Pixmap of the frame.

         */

        SkPixmap pixmap;

        /**

         *  Duration of the frame in millseconds.

         */

        int duration;

    };

    /**

     *  Encode |numRows| rows of input.  If the caller requests more rows than are remaining

     *  in the src, this will encode all of the remaining rows.  |numRows| must be greater

     *  than zero.

     */

    bool encodeRows(int numRows);

    virtual ~SkEncoder() {}

protected:

    virtual bool onEncodeRows(int numRows) = 0;

    SkEncoder(const SkPixmap& src, size_t storageBytes)

        : fSrc(src)

        , fCurrRow(0)

        , fStorage(storageBytes)

    {}

    const SkPixmap&        fSrc;

    int                    fCurrRow;

    skia_private::AutoTMalloc<uint8_t> fStorage;

};

#endif