Ryan Foster c8a81bba72 image-source: Reload file when timestamp has changed
This commit fixes the issue outlined in the following thread:
https://obsproject.com/forum/threads/50045/

When the image source file was replaced by an outside process, it would
only reload when the file's new timestamp was newer than the file's
previous timestamp.  This fixes that behavior.  Now an image source
will reload any time the file's new timestamp is different than its
previous timestamp.
2016-09-14 05:43:48 -04:00

281 lines
6.5 KiB
C

#include <obs-module.h>
#include <graphics/image-file.h>
#include <util/platform.h>
#include <util/dstr.h>
#include <sys/stat.h>
#define blog(log_level, format, ...) \
blog(log_level, "[image_source: '%s'] " format, \
obs_source_get_name(context->source), ##__VA_ARGS__)
#define debug(format, ...) \
blog(LOG_DEBUG, format, ##__VA_ARGS__)
#define info(format, ...) \
blog(LOG_INFO, format, ##__VA_ARGS__)
#define warn(format, ...) \
blog(LOG_WARNING, format, ##__VA_ARGS__)
struct image_source {
obs_source_t *source;
char *file;
bool persistent;
time_t file_timestamp;
float update_time_elapsed;
uint64_t last_time;
bool active;
gs_image_file_t image;
};
static time_t get_modified_timestamp(const char *filename)
{
struct stat stats;
if (os_stat(filename, &stats) != 0)
return -1;
return stats.st_mtime;
}
static const char *image_source_get_name(void *unused)
{
UNUSED_PARAMETER(unused);
return obs_module_text("ImageInput");
}
static void image_source_load(struct image_source *context)
{
char *file = context->file;
obs_enter_graphics();
gs_image_file_free(&context->image);
obs_leave_graphics();
if (file && *file) {
debug("loading texture '%s'", file);
context->file_timestamp = get_modified_timestamp(file);
gs_image_file_init(&context->image, file);
context->update_time_elapsed = 0;
obs_enter_graphics();
gs_image_file_init_texture(&context->image);
obs_leave_graphics();
if (!context->image.loaded)
warn("failed to load texture '%s'", file);
}
}
static void image_source_unload(struct image_source *context)
{
obs_enter_graphics();
gs_image_file_free(&context->image);
obs_leave_graphics();
}
static void image_source_update(void *data, obs_data_t *settings)
{
struct image_source *context = data;
const char *file = obs_data_get_string(settings, "file");
const bool unload = obs_data_get_bool(settings, "unload");
if (context->file)
bfree(context->file);
context->file = bstrdup(file);
context->persistent = !unload;
/* Load the image if the source is persistent or showing */
if (context->persistent || obs_source_showing(context->source))
image_source_load(data);
else
image_source_unload(data);
}
static void image_source_defaults(obs_data_t *settings)
{
obs_data_set_default_bool(settings, "unload", false);
}
static void image_source_show(void *data)
{
struct image_source *context = data;
if (!context->persistent)
image_source_load(context);
}
static void image_source_hide(void *data)
{
struct image_source *context = data;
if (!context->persistent)
image_source_unload(context);
}
static void *image_source_create(obs_data_t *settings, obs_source_t *source)
{
struct image_source *context = bzalloc(sizeof(struct image_source));
context->source = source;
image_source_update(context, settings);
return context;
}
static void image_source_destroy(void *data)
{
struct image_source *context = data;
image_source_unload(context);
if (context->file)
bfree(context->file);
bfree(context);
}
static uint32_t image_source_getwidth(void *data)
{
struct image_source *context = data;
return context->image.cx;
}
static uint32_t image_source_getheight(void *data)
{
struct image_source *context = data;
return context->image.cy;
}
static void image_source_render(void *data, gs_effect_t *effect)
{
struct image_source *context = data;
if (!context->image.texture)
return;
gs_reset_blend_state();
gs_effect_set_texture(gs_effect_get_param_by_name(effect, "image"),
context->image.texture);
gs_draw_sprite(context->image.texture, 0,
context->image.cx, context->image.cy);
}
static void image_source_tick(void *data, float seconds)
{
struct image_source *context = data;
uint64_t frame_time = obs_get_video_frame_time();
if (obs_source_active(context->source)) {
if (!context->active) {
if (context->image.is_animated_gif)
context->last_time = frame_time;
context->active = true;
}
} else {
if (context->active) {
if (context->image.is_animated_gif) {
context->image.cur_frame = 0;
context->image.cur_loop = 0;
context->image.cur_time = 0;
obs_enter_graphics();
gs_image_file_update_texture(&context->image);
obs_leave_graphics();
}
context->active = false;
}
return;
}
if (context->last_time && context->image.is_animated_gif) {
uint64_t elapsed = frame_time - context->last_time;
bool updated = gs_image_file_tick(&context->image, elapsed);
if (updated) {
obs_enter_graphics();
gs_image_file_update_texture(&context->image);
obs_leave_graphics();
}
}
context->last_time = frame_time;
context->update_time_elapsed += seconds;
if (context->update_time_elapsed >= 1.0f) {
time_t t = get_modified_timestamp(context->file);
context->update_time_elapsed = 0.0f;
if (context->file_timestamp != t) {
image_source_load(context);
}
}
}
static const char *image_filter =
"All formats (*.bmp *.tga *.png *.jpeg *.jpg *.gif);;"
"BMP Files (*.bmp);;"
"Targa Files (*.tga);;"
"PNG Files (*.png);;"
"JPEG Files (*.jpeg *.jpg);;"
"GIF Files (*.gif)";
static obs_properties_t *image_source_properties(void *data)
{
struct image_source *s = data;
struct dstr path = {0};
obs_properties_t *props = obs_properties_create();
if (s && s->file && *s->file) {
const char *slash;
dstr_copy(&path, s->file);
dstr_replace(&path, "\\", "/");
slash = strrchr(path.array, '/');
if (slash)
dstr_resize(&path, slash - path.array + 1);
}
obs_properties_add_path(props,
"file", obs_module_text("File"),
OBS_PATH_FILE, image_filter, path.array);
obs_properties_add_bool(props,
"unload", obs_module_text("UnloadWhenNotShowing"));
dstr_free(&path);
return props;
}
static struct obs_source_info image_source_info = {
.id = "image_source",
.type = OBS_SOURCE_TYPE_INPUT,
.output_flags = OBS_SOURCE_VIDEO,
.get_name = image_source_get_name,
.create = image_source_create,
.destroy = image_source_destroy,
.update = image_source_update,
.get_defaults = image_source_defaults,
.show = image_source_show,
.hide = image_source_hide,
.get_width = image_source_getwidth,
.get_height = image_source_getheight,
.video_render = image_source_render,
.video_tick = image_source_tick,
.get_properties = image_source_properties
};
OBS_DECLARE_MODULE()
OBS_MODULE_USE_DEFAULT_LOCALE("image-source", "en-US")
extern struct obs_source_info slideshow_info;
bool obs_module_load(void)
{
obs_register_source(&image_source_info);
obs_register_source(&slideshow_info);
return true;
}