noobs 0.0.6

package/include/obs-encoder.h

@@ -0,0 +1,361 @@
+/******************************************************************************
+    Copyright (C) 2023 by Lain Bailey <lain@obsproject.com>
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 2 of the License, or
+    (at your option) any later version.
+
+    This program 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 General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+******************************************************************************/
+
+#pragma once
+
+/**
+ * @file
+ * @brief header for modules implementing encoders.
+ *
+ * Encoders are modules that implement some codec that can be used by libobs
+ * to process output data.
+ */
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+struct obs_encoder;
+typedef struct obs_encoder obs_encoder_t;
+
+#define OBS_ENCODER_CAP_DEPRECATED (1 << 0)
+#define OBS_ENCODER_CAP_PASS_TEXTURE (1 << 1)
+#define OBS_ENCODER_CAP_DYN_BITRATE (1 << 2)
+#define OBS_ENCODER_CAP_INTERNAL (1 << 3)
+#define OBS_ENCODER_CAP_ROI (1 << 4)
+#define OBS_ENCODER_CAP_SCALING (1 << 5)
+
+/** Specifies the encoder type */
+enum obs_encoder_type {
+	OBS_ENCODER_AUDIO, /**< The encoder provides an audio codec */
+	OBS_ENCODER_VIDEO  /**< The encoder provides a video codec */
+};
+
+/* encoder_packet_time is used for timestamping events associated
+ * with each video frame. This is useful for deriving absolute
+ * timestamps (i.e. wall-clock based formats) and measuring latency.
+ *
+ * For each frame, there are four events of interest, described in
+ * the encoder_packet_time struct, namely cts, fer, ferc, and pir.
+ * The timebase of these four events is os_gettime_ns(), which provides
+ * very high resolution timestamping, and the ability to convert the
+ * timing to any other time format.
+ *
+ * Each frame follows a timeline in the following temporal order:
+ *   CTS, FER, FERC, PIR
+ *
+ * PTS is the integer-based monotonically increasing value that is used
+ * to associate an encoder_packet_time entry with a specific encoder_packet.
+ */
+struct encoder_packet_time {
+	/* PTS used to associate uncompressed frames with encoded packets. */
+	int64_t pts;
+
+	/* Composition timestamp is when the frame was rendered,
+	 * captured via os_gettime_ns().
+	 */
+	uint64_t cts;
+
+	/* FERC (Frame Encode Request) is when the frame was
+	 * submitted to the encoder for encoding via the encode
+	 * callback (e.g. encode_texture2()), captured via os_gettime_ns().
+	 */
+	uint64_t fer;
+
+	/* FERC (Frame Encode Request Complete) is when
+	 * the associated FER event completed. If the encode
+	 * is synchronous with the call, this means FERC - FEC
+	 * measures the actual encode time, otherwise if the
+	 * encode is asynchronous, it measures the pipeline
+	 * delay between encode request and encode complete.
+	 * FERC is also captured via os_gettime_ns().
+	 */
+	uint64_t ferc;
+
+	/* PIR (Packet Interleave Request) is when the encoded packet
+	 * is interleaved with the stream. PIR is captured via
+	 * os_gettime_ns(). The difference between PIR and CTS gives
+	 * the total latency between frame rendering
+	 * and packet interleaving.
+	 */
+	uint64_t pir;
+};
+
+/** Encoder output packet */
+struct encoder_packet {
+	uint8_t *data; /**< Packet data */
+	size_t size;   /**< Packet size */
+
+	int64_t pts; /**< Presentation timestamp */
+	int64_t dts; /**< Decode timestamp */
+
+	int32_t timebase_num; /**< Timebase numerator */
+	int32_t timebase_den; /**< Timebase denominator */
+
+	enum obs_encoder_type type; /**< Encoder type */
+
+	bool keyframe; /**< Is a keyframe */
+
+	/* ---------------------------------------------------------------- */
+	/* Internal video variables (will be parsed automatically) */
+
+	/* DTS in microseconds */
+	int64_t dts_usec;
+
+	/* System DTS in microseconds */
+	int64_t sys_dts_usec;
+
+	/**
+	 * Packet priority
+	 *
+	 * This is generally use by video encoders to specify the priority
+	 * of the packet.
+	 */
+	int priority;
+
+	/**
+	 * Dropped packet priority
+	 *
+	 * If this packet needs to be dropped, the next packet must be of this
+	 * priority or higher to continue transmission.
+	 */
+	int drop_priority;
+
+	/** Audio track index (used with outputs) */
+	size_t track_idx;
+
+	/** Encoder from which the track originated from */
+	obs_encoder_t *encoder;
+};
+
+/** Encoder input frame */
+struct encoder_frame {
+	/** Data for the frame/audio */
+	uint8_t *data[MAX_AV_PLANES];
+
+	/** size of each plane */
+	uint32_t linesize[MAX_AV_PLANES];
+
+	/** Number of frames (audio only) */
+	uint32_t frames;
+
+	/** Presentation timestamp */
+	int64_t pts;
+};
+
+/** Encoder region of interest */
+struct obs_encoder_roi {
+	/* The rectangle edges of the region are specified as number of pixels
+	 * from the input video's top and left edges (i.e. row/column 0). */
+	uint32_t top;
+	uint32_t bottom;
+	uint32_t left;
+	uint32_t right;
+
+	/* Priority is specified as a float value between -1 and 1.
+	 * These are converted to encoder-specific values by the encoder.
+	 * Values above 0 tell the encoder to increase quality for that region,
+	 * values below tell it to worsen it.
+	 * Not all encoders support negative values and they may be ignored. */
+	float priority;
+};
+
+struct gs_texture;
+
+/** Encoder input texture */
+struct encoder_texture {
+	/** Shared texture handle, only set on Windows */
+	uint32_t handle;
+	/** Textures, length determined by format */
+	struct gs_texture *tex[4];
+};
+
+/**
+ * Encoder interface
+ *
+ * Encoders have a limited usage with OBS.  You are not generally supposed to
+ * implement every encoder out there.  Generally, these are limited or specific
+ * encoders for h264/aac for streaming and recording.  It doesn't have to be
+ * *just* h264 or aac of course, but generally those are the expected encoders.
+ *
+ * That being said, other encoders will be kept in mind for future use.
+ */
+struct obs_encoder_info {
+	/* ----------------------------------------------------------------- */
+	/* Required implementation*/
+
+	/** Specifies the named identifier of this encoder */
+	const char *id;
+
+	/** Specifies the encoder type (video or audio) */
+	enum obs_encoder_type type;
+
+	/** Specifies the codec */
+	const char *codec;
+
+	/**
+	 * Gets the full translated name of this encoder
+	 *
+	 * @param  type_data  The type_data variable of this structure
+	 * @return            Translated name of the encoder
+	 */
+	const char *(*get_name)(void *type_data);
+
+	/**
+	 * Creates the encoder with the specified settings
+	 *
+	 * @param  settings  Settings for the encoder
+	 * @param  encoder   OBS encoder context
+	 * @return           Data associated with this encoder context, or
+	 *                   NULL if initialization failed.
+	 */
+	void *(*create)(obs_data_t *settings, obs_encoder_t *encoder);
+
+	/**
+	 * Destroys the encoder data
+	 *
+	 * @param  data  Data associated with this encoder context
+	 */
+	void (*destroy)(void *data);
+
+	/**
+	 * Encodes frame(s), and outputs encoded packets as they become
+	 * available.
+	 *
+	 * @param       data             Data associated with this encoder
+	 *                               context
+	 * @param[in]   frame            Raw audio/video data to encode
+	 * @param[out]  packet           Encoder packet output, if any
+	 * @param[out]  received_packet  Set to true if a packet was received,
+	 *                               false otherwise
+	 * @return                       true if successful, false otherwise.
+	 */
+	bool (*encode)(void *data, struct encoder_frame *frame, struct encoder_packet *packet, bool *received_packet);
+
+	/** Audio encoder only:  Returns the frame size for this encoder */
+	size_t (*get_frame_size)(void *data);
+
+	/* ----------------------------------------------------------------- */
+	/* Optional implementation */
+
+	/**
+	 * Gets the default settings for this encoder
+	 *
+	 * @param[out]  settings  Data to assign default settings to
+	 */
+	void (*get_defaults)(obs_data_t *settings);
+
+	/**
+	 * Gets the property information of this encoder
+	 *
+	 * @return         The properties data
+	 */
+	obs_properties_t *(*get_properties)(void *data);
+
+	/**
+	 * Updates the settings for this encoder (usually used for things like
+	 * changing bitrate while active)
+	 *
+	 * @param  data      Data associated with this encoder context
+	 * @param  settings  New settings for this encoder
+	 * @return           true if successful, false otherwise
+	 */
+	bool (*update)(void *data, obs_data_t *settings);
+
+	/**
+	 * Returns extra data associated with this encoder (usually header)
+	 *
+	 * @param  data             Data associated with this encoder context
+	 * @param[out]  extra_data  Pointer to receive the extra data
+	 * @param[out]  size        Pointer to receive the size of the extra
+	 *                          data
+	 * @return                  true if extra data available, false
+	 *                          otherwise
+	 */
+	bool (*get_extra_data)(void *data, uint8_t **extra_data, size_t *size);
+
+	/**
+	 * Gets the SEI data, if any
+	 *
+	 * @param       data      Data associated with this encoder context
+	 * @param[out]  sei_data  Pointer to receive the SEI data
+	 * @param[out]  size      Pointer to receive the SEI data size
+	 * @return                true if SEI data available, false otherwise
+	 */
+	bool (*get_sei_data)(void *data, uint8_t **sei_data, size_t *size);
+
+	/**
+	 * Returns desired audio format and sample information
+	 *
+	 * @param          data  Data associated with this encoder context
+	 * @param[in/out]  info  Audio format information
+	 */
+	void (*get_audio_info)(void *data, struct audio_convert_info *info);
+
+	/**
+	 * Returns desired video format information
+	 *
+	 * @param          data  Data associated with this encoder context
+	 * @param[in/out]  info  Video format information
+	 */
+	void (*get_video_info)(void *data, struct video_scale_info *info);
+
+	void *type_data;
+	void (*free_type_data)(void *type_data);
+
+	uint32_t caps;
+
+	/**
+	 * Gets the default settings for this encoder
+	 *
+	 * If get_defaults is also defined both will be called, and the first
+	 * call will be to get_defaults, then to get_defaults2.
+	 *
+	 * @param[out]  settings  Data to assign default settings to
+	 * @param[in]   typedata  Type Data
+	 */
+	void (*get_defaults2)(obs_data_t *settings, void *type_data);
+
+	/**
+	 * Gets the property information of this encoder
+	 *
+	 * @param[in]   data      Pointer from create (or null)
+	 * @param[in]   typedata  Type Data
+	 * @return                The properties data
+	 */
+	obs_properties_t *(*get_properties2)(void *data, void *type_data);
+
+	bool (*encode_texture)(void *data, uint32_t handle, int64_t pts, uint64_t lock_key, uint64_t *next_key,
+			       struct encoder_packet *packet, bool *received_packet);
+
+	bool (*encode_texture2)(void *data, struct encoder_texture *texture, int64_t pts, uint64_t lock_key,
+				uint64_t *next_key, struct encoder_packet *packet, bool *received_packet);
+};
+
+EXPORT void obs_register_encoder_s(const struct obs_encoder_info *info, size_t size);
+
+/**
+ * Register an encoder definition to the current obs context.  This should be
+ * used in obs_module_load.
+ *
+ * @param  info  Pointer to the source definition structure.
+ */
+#define obs_register_encoder(info) obs_register_encoder_s(info, sizeof(struct obs_encoder_info))
+
+#ifdef __cplusplus
+}
+#endif

package/include/obs-ffmpeg-compat.h

@@ -0,0 +1,13 @@
+#pragma once
+
+#include <libavcodec/avcodec.h>
+
+/* LIBAVCODEC_VERSION_CHECK checks for the right version of libav and FFmpeg
+ * a is the major version
+ * b and c the minor and micro versions of libav
+ * d and e the minor and micro versions of FFmpeg */
+#define LIBAVCODEC_VERSION_CHECK(a, b, c, d, e)                                                   \
+	((LIBAVCODEC_VERSION_MICRO < 100 && LIBAVCODEC_VERSION_INT >= AV_VERSION_INT(a, b, c)) || \
+	 (LIBAVCODEC_VERSION_MICRO >= 100 && LIBAVCODEC_VERSION_INT >= AV_VERSION_INT(a, d, e)))
+
+#define INPUT_BUFFER_PADDING_SIZE AV_INPUT_BUFFER_PADDING_SIZE

package/include/obs-hevc.h

@@ -0,0 +1,81 @@
+/******************************************************************************
+    Copyright (C) 2023 by Lain Bailey <lain@obsproject.com>
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 2 of the License, or
+    (at your option) any later version.
+
+    This program 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 General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+******************************************************************************/
+
+#pragma once
+
+#include "util/c99defs.h"
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+struct encoder_packet;
+
+enum {
+	OBS_HEVC_NAL_TRAIL_N = 0,
+	OBS_HEVC_NAL_TRAIL_R = 1,
+	OBS_HEVC_NAL_TSA_N = 2,
+	OBS_HEVC_NAL_TSA_R = 3,
+	OBS_HEVC_NAL_STSA_N = 4,
+	OBS_HEVC_NAL_STSA_R = 5,
+	OBS_HEVC_NAL_RADL_N = 6,
+	OBS_HEVC_NAL_RADL_R = 7,
+	OBS_HEVC_NAL_RASL_N = 8,
+	OBS_HEVC_NAL_RASL_R = 9,
+	OBS_HEVC_NAL_VCL_N10 = 10,
+	OBS_HEVC_NAL_VCL_R11 = 11,
+	OBS_HEVC_NAL_VCL_N12 = 12,
+	OBS_HEVC_NAL_VCL_R13 = 13,
+	OBS_HEVC_NAL_VCL_N14 = 14,
+	OBS_HEVC_NAL_VCL_R15 = 15,
+	OBS_HEVC_NAL_BLA_W_LP = 16,
+	OBS_HEVC_NAL_BLA_W_RADL = 17,
+	OBS_HEVC_NAL_BLA_N_LP = 18,
+	OBS_HEVC_NAL_IDR_W_RADL = 19,
+	OBS_HEVC_NAL_IDR_N_LP = 20,
+	OBS_HEVC_NAL_CRA_NUT = 21,
+	OBS_HEVC_NAL_RSV_IRAP_VCL22 = 22,
+	OBS_HEVC_NAL_RSV_IRAP_VCL23 = 23,
+	OBS_HEVC_NAL_RSV_VCL24 = 24,
+	OBS_HEVC_NAL_RSV_VCL25 = 25,
+	OBS_HEVC_NAL_RSV_VCL26 = 26,
+	OBS_HEVC_NAL_RSV_VCL27 = 27,
+	OBS_HEVC_NAL_RSV_VCL28 = 28,
+	OBS_HEVC_NAL_RSV_VCL29 = 29,
+	OBS_HEVC_NAL_RSV_VCL30 = 30,
+	OBS_HEVC_NAL_RSV_VCL31 = 31,
+	OBS_HEVC_NAL_VPS = 32,
+	OBS_HEVC_NAL_SPS = 33,
+	OBS_HEVC_NAL_PPS = 34,
+	OBS_HEVC_NAL_AUD = 35,
+	OBS_HEVC_NAL_EOS_NUT = 36,
+	OBS_HEVC_NAL_EOB_NUT = 37,
+	OBS_HEVC_NAL_FD_NUT = 38,
+	OBS_HEVC_NAL_SEI_PREFIX = 39,
+	OBS_HEVC_NAL_SEI_SUFFIX = 40,
+};
+
+EXPORT bool obs_hevc_keyframe(const uint8_t *data, size_t size);
+EXPORT void obs_parse_hevc_packet(struct encoder_packet *hevc_packet, const struct encoder_packet *src);
+EXPORT int obs_parse_hevc_packet_priority(const struct encoder_packet *packet);
+EXPORT void obs_extract_hevc_headers(const uint8_t *packet, size_t size, uint8_t **new_packet_data,
+				     size_t *new_packet_size, uint8_t **header_data, size_t *header_size,
+				     uint8_t **sei_data, size_t *sei_size);
+
+#ifdef __cplusplus
+}
+#endif