org.freedesktop.gstreamer.lowlevel.GstAPI Maven / Gradle / Ivy

/* 
 * Copyright (c) 2009 Levente Farkas
 * Copyright (c) 2007, 2008 Wayne Meissner
 * 
 * This file is part of gstreamer-java.
 *
 * This code is free software: you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License version 3 only, as
 * published by the Free Software Foundation.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License
 * version 3 for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with this work.  If not, see .
 */

package org.freedesktop.gstreamer.lowlevel;

import org.freedesktop.gstreamer.Format;
import org.freedesktop.gstreamer.lowlevel.annotations.CallerOwnsReturn;

import com.sun.jna.Library;
import com.sun.jna.Pointer;
import com.sun.jna.ptr.IntByReference;
import com.sun.jna.ptr.PointerByReference;
import java.util.Arrays;
import java.util.List;

/**
 *
 */
public interface GstAPI extends Library {
    
    GstAPI GST_API = GstNative.load(GstAPI.class);
    
    int GST_PADDING = 4;
    int GST_PADDING_LARGE = 20;
        
    GType gst_type_find_get_type();
    @CallerOwnsReturn String gst_version_string();
    void gst_version(long[] major, long[] minor, long[] micro, long[] nano);
    boolean gst_init(IntByReference argc, PointerByReference argv);
    boolean gst_init_check(IntByReference argc, PointerByReference argv, Pointer[] err);
    boolean gst_init_check(IntByReference argc, PointerByReference argv, GErrorStruct[] err);
    boolean gst_segtrap_is_enabled();
    void gst_segtrap_set_enabled(boolean enabled);
    void gst_deinit();
    
    /**
    * @see https://cgit.freedesktop.org/gstreamer/gstreamer/tree/gst/gstsegment.h?h=1.8
    *
    * GstSegment:
    * @flags: flags for this segment
    * @rate: the playback rate of the segment
    * @applied_rate: the already applied rate to the segment
    * @format: the format of the segment values
    * @base: the running time (plus elapsed time, see offset) of the segment start
    * @offset: the amount (in buffer timestamps) that has already been elapsed in
    *     the segment
    * @start: the start of the segment in buffer timestamp time (PTS)
    * @stop: the stop of the segment in buffer timestamp time (PTS)
    * @time: the stream time of the segment start
    * @position: the buffer timestamp position in the segment (used internally by
    *     elements such as sources, demuxers or parsers to track progress)
    * @duration: the duration of the segment
    *
    * A helper structure that holds the configured region of
    * interest in a media file.
    */
    public static final class GstSegmentStruct extends com.sun.jna.Structure {

        public GstSegmentStruct() {
        }

        public GstSegmentStruct(Pointer p) {
            super(p);
        }

        public GstSegmentStruct(int flags, double rate, double applied_rate, Format format, long base, long offset, long start, long stop, long time, long position, long duration) {
            this.flags = flags;
            this.rate = rate;
            this.applied_rate = applied_rate;
            this.format = format;
            this.base = base;
            this.offset = offset;
            this.start = start;
            this.stop = stop;
            this.time = time;
            this.position = position;
            this.duration = duration;
        }
        
        /*< public >*/
        public int flags;
        
        public double rate;
        public double applied_rate;
        
        public Format format;
        public long base;
        public long offset;
        public long start;
        public long stop;
        public long time;

        public long position;
        public long duration;

        /*< private >*/
        public volatile Pointer[] _gst_reserved = new Pointer[GST_PADDING];

        @Override
        protected List getFieldOrder() {
            return Arrays.asList(new String[]{
                "flags", "rate", "applied_rate",
                "format", "base", "offset",
                "start", "stop", "time",
                "position", "duration", "_gst_reserved"
            });
        }
    };
    
    public static final class GErrorStruct extends com.sun.jna.Structure {
        public volatile int domain; /* GQuark */
        public volatile int code;
        public volatile String message;
        
        /** Creates a new instance of GError */
        public GErrorStruct() { clear(); }
        public GErrorStruct(Pointer ptr) {
            useMemory(ptr);
        }
        public int getCode() {
            return (Integer) readField("code");
        }
        public String getMessage() {
            return (String) readField("message");
        }

        @Override
        protected List getFieldOrder() {
            return Arrays.asList(new String[]{
                "domain", "code", "message"
            });
        }
    }
    // Do nothing, but provide a base Callback class that gets automatic type conversion
    public static interface GstCallback extends com.sun.jna.Callback {
        static final com.sun.jna.TypeMapper TYPE_MAPPER = new GTypeMapper();
    }
}