com.github.kokorin.jaffree.ffprobe.FFprobeResult 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 2018-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.ffprobe;

import com.github.kokorin.jaffree.StreamType;
import com.github.kokorin.jaffree.ffprobe.data.ProbeData;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.util.List;

/**
 * {@link FFprobeResult} contains information about ffprobe execution result.
 */
public class FFprobeResult {
    private final ProbeData probeData;

    private static final Logger LOGGER = LoggerFactory.getLogger(FFprobeResult.class);

    /**
     * Constructs {@link FFprobeResult} from parsed {@link ProbeData}.
     *
     * @param probeData parsed ffprobe output
     */
    public FFprobeResult(final ProbeData probeData) {
        this.probeData = probeData;
    }

    /**
     * This method allows direct access to parsed ffprobe output.
     * 
     * It can be used if {@link FFprobeResult} doesn't provide corresponding getter
     *
     * @return parsed ffprobe output
     */
    public ProbeData getData() {
        return probeData;
    }

    /**
     * @return format-related data
     * @see FFprobe#setShowFormat(boolean)
     */
    public Format getFormat() {
        return probeData.getSubData("format", Format::new);
    }

    /**
     * @return parsed packets
     * @see FFprobe#setShowPackets(boolean)
     */
    public List getPackets() {
        return probeData.getSubDataList("packets", Packet::new);
    }

    /**
     * @return parsed frames and subtitles
     * @see FFprobe#setShowFrames(boolean)
     * @see Frame
     * @see Subtitle
     */
    public List getFrames() {
        return probeData.getSubDataList("frames", subData -> {
            StreamType streamType = subData.getStreamType("media_type");
            if (streamType == StreamType.SUBTITLE) {
                return new Subtitle(subData);
            }
            return new Frame(subData);
        });
    }

    /**
     * @return parsed packets, frames and subtitles
     * @see FFprobe#setShowPackets(boolean)
     * @see FFprobe#setShowFrames(boolean)
     * @see Packet
     * @see Frame
     * @see Subtitle
     */
    public List getPacketsAndFrames() {
        return probeData.getSubDataList("packets_and_frames", subData -> {
            String type = subData.getString("type");
            if (type == null) {
                LOGGER.error("No type property found");
                return null;
            }

            switch (type) {
                case "packet":
                    return new Packet(subData);
                case "frame":
                    return new Frame(subData);
                case "subtitle":
                    return new Subtitle(subData);
                default:
                    LOGGER.error("Unknown type: " + type);
                    return null;
            }
        });
    }

    /**
     * @return parsed programs
     * @see FFprobe#setShowPrograms(boolean)
     */
    public List getPrograms() {
        return probeData.getSubDataList("programs", Program::new);
    }

    /**
     * @return parsed streams
     * @see FFprobe#setShowStreams(boolean)
     */
    public List getStreams() {
        return probeData.getSubDataList("streams", Stream::new);
    }

    /**
     * @return parsed chapters
     * @see FFprobe#setShowChapters(boolean)
     */
    public List getChapters() {
        return probeData.getSubDataList("chapters", Chapter::new);
    }
}