com.github.kokorin.jaffree.ffmpeg.FrameOutput Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jaffree Show documentation
Java ffmpeg command-line wrapper.
The newest version!
/*
 *    Copyright  2017-2021 Denis Kokorin
 *
 *    Licensed under the Apache License, Version 2.0 (the "License");
 *    you may not use this file except in compliance with the License.
 *    You may obtain a copy of the License at
 *
 *        http://www.apache.org/licenses/LICENSE-2.0
 *
 *    Unless required by applicable law or agreed to in writing, software
 *    distributed under the License is distributed on an "AS IS" BASIS,
 *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *    See the License for the specific language governing permissions and
 *    limitations under the License.
 *
 */

package com.github.kokorin.jaffree.ffmpeg;

import com.github.kokorin.jaffree.JaffreeException;
import com.github.kokorin.jaffree.StreamType;
import com.github.kokorin.jaffree.net.TcpNegotiator;

import java.io.IOException;
import java.io.InputStream;
import java.net.Socket;

/**
 * Allows to consume in Java audio & video frames produced by ffmpeg.
 */
public class FrameOutput extends TcpOutput implements Output {

    /**
     * Create {@link FrameOutput} for {@link FFmpeg}.
     *
     * @param frameReader frame reader
     * @param format      media format
     * @param videoCodec  video codec
     * @param pixelFormat pixel format
     * @param audioCodec  audio codec
     * @see NutFrameReader
     */
    protected FrameOutput(final FrameReader frameReader, final String format,
                          final String videoCodec, final String pixelFormat,
                          final String audioCodec) {
        super(new FrameOutputNegotiator(frameReader));
        super.setFormat(format);
        super.setCodec(StreamType.VIDEO.code(), videoCodec);
        super.setPixelFormat(null, pixelFormat);
        super.setCodec(StreamType.AUDIO.code(), audioCodec);
    }

    /**
     * Format change is prohibited after {@link FrameOutput} instantiation.
     *
     * @param format format
     * @return never returns
     * @throws JaffreeException always
     */
    @Override
    public final FrameOutput setFormat(final String format) {
        throw new JaffreeException("Format can't be changed");
    }

    /**
     * Codec change is prohibited after {@link FrameOutput} instantiation.
     *
     * @param streamSpecifier stream specifier
     * @param codec           codec name
     * @return never returns
     * @throws JaffreeException always
     */
    @Override
    public final FrameOutput setCodec(final String streamSpecifier, final String codec) {
        throw new JaffreeException("Codec can't be changed");
    }

    /**
     * Codec change is prohibited after {@link FrameOutput} instantiation.
     *
     * @param streamType stream type
     * @param codec      codec name
     * @return never returns
     * @throws JaffreeException always
     */
    @Override
    public final FrameOutput setCodec(final StreamType streamType, final String codec) {
        throw new JaffreeException("Codec can't be changed");
    }

    /**
     * Codec copying is impossible, every frame is raw frame.
     *
     * @return never returns
     * @throws JaffreeException always
     */
    @Override
    public final FrameOutput copyAllCodecs() {
        throw new JaffreeException("Codec can't be changed");
    }

    /**
     * Codec copying is impossible, every frame is raw frame.
     *
     * @param streamSpecifier stream specifier
     * @return never returns
     * @throws JaffreeException always
     */
    @Override
    public final FrameOutput copyCodec(final String streamSpecifier) {
        throw new JaffreeException("Codec can't be changed");
    }

    /**
     * Codec copying is impossible, every frame is raw frame.
     *
     * @param streamType stream type
     * @return never returns
     * @throws JaffreeException always
     */
    @Override
    public final FrameOutput copyCodec(final StreamType streamType) {
        throw new JaffreeException("Codec can't be changed");
    }

    /**
     * Pixel format change is prohibited after {@link FrameOutput} instantiation.
     *
     * @param streamSpecifier stream specifier
     * @param pixelFormat     pixel format
     * @return never returns
     * @throws JaffreeException always
     */
    @Override
    public final FrameOutput setPixelFormat(final String streamSpecifier,
                                            final String pixelFormat) {
        throw new JaffreeException("Pixel Format can't be changed");
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public FrameOutput disableStream(final StreamType streamType) {
        super.disableStream(streamType);

        // We have to reset codec and pixel format if video or audio output is disabled because
        // we set default values in constructor
        switch (streamType) {
            case VIDEO:
                super.setCodec(StreamType.VIDEO.code(), null);
                super.setPixelFormat(null, null);
                break;
            case AUDIO:
                super.setCodec(StreamType.AUDIO.code(), null);
                break;
            default:
        }

        return this;
    }

    /**
     * Creates {@link FrameOutput}.
     *
     * @param consumer frame consumer
     * @return FrameOutput
     */
    public static FrameOutput withConsumer(final FrameConsumer consumer) {
        return withConsumer(consumer, ImageFormats.BGR24);
    }

    /**
     * Creates {@link FrameOutput} with alpha channel.
     *
     * @param consumer frame consumer
     * @return FrameOutput
     */
    public static FrameOutput withConsumerAlpha(final FrameConsumer consumer) {
        return withConsumer(consumer, ImageFormats.ABGR);
    }

    protected static FrameOutput withConsumer(final FrameConsumer consumer,
                                              final ImageFormat imageFormat) {
        return new FrameOutput(
                new NutFrameReader(consumer, imageFormat),
                "nut", "rawvideo", imageFormat.getPixelFormat(), "pcm_s32be"
        );
    }

    protected interface FrameReader {
        void read(InputStream inputStream) throws IOException;
    }

    /**
     * {@link TcpNegotiator} implementation which uses {@link FrameReader} to receive bytes over
     * TCP connection.
     */
    protected static class FrameOutputNegotiator implements TcpNegotiator {
        private final FrameReader frameReader;

        public FrameOutputNegotiator(final FrameReader frameReader) {
            this.frameReader = frameReader;
        }

        /**
         * Receives media over TCP connection.
         *
         * @param socket TCP socket
         * @throws IOException if any IO error
         */
        @Override
        public synchronized void negotiate(final Socket socket) throws IOException {
            try (InputStream inputStream = socket.getInputStream()) {
                frameReader.read(inputStream);
            }
        }
    }
}