post/goom/xine_goom.c

/*
 * Copyright (C) 2000-2019 the xine project
 *
 * This file is part of xine, a free video player.
 *
 * xine 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.
 *
 * xine 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, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110, USA
 *
 * GOOM post plugin.
 *
 * first version by Mark Thomas
 * ported to post plugin architecture by Miguel Freitas
 * real work by goom author, JC Hoelt <jeko@free.fr>.
 */

#ifdef HAVE_CONFIG_H
#include "config.h"
#endif

#include <stdio.h>
#include <stdlib.h>
#include <time.h>

#define LOG_MODULE "goom"
#define LOG_VERBOSE
/*
#define LOG
*/

/* TJ. this is what my 32bit Linux running on a AMD Athlon II X2 240e (2 * 2800Mhz)
  performed @ 1280x720, 19 fps:
  goom: csc_method 0 min 8257 us avg 8308 us
  goom: csc_method 1 min 16312 us avg 16413 us
  goom: csc_method 2 min 5019 us avg 5134 us
  Seems gcc 4.5 has a very nice 64bit math emulation :-)
*/
#define BENCHMARK 1

#include <xine/xine_internal.h>
#include <xine/xineutils.h>
#include <xine/post.h>

#include "goom.h"

#define NUMSAMPLES  512 /* hardcoded into goom api */
#define FPS          14

#define GOOM_WIDTH  320
#define GOOM_HEIGHT 240

/* colorspace conversion methods */
static const char* const goom_csc_methods[]={
  "Fast but not photorealistic",
  "Slow but looks better",
  "Mostly fast and good quality",
  NULL
};

typedef struct post_plugin_goom_s post_plugin_goom_t;

typedef struct post_class_goom_s post_class_goom_t;

struct post_class_goom_s {
  post_class_t class;

  xine_t *xine;
  int width, height;
  int fps;
  int csc_method;
};

struct post_plugin_goom_s {
  post_plugin_t post;

  /* private data */
  xine_video_port_t *vo_port;
  post_out_t         video_output;

  post_class_goom_t *class;

  /* private metronom for syncing the video */
  metronom_t        *metronom;

  /* goom context */
  PluginInfo        *goom;

  int data_idx;
  gint16 data [2][NUMSAMPLES];
  audio_buffer_t buf;   /* dummy buffer just to hold a copy of audio data */

  int channels;
  int sample_rate;
  int samples_per_frame;
  int width_back, height_back;
  double ratio;
  int csc_method;


  int do_samples_skip; /* true = skipping samples, false reading samples*/
  int left_to_read; /* data to read before switching modes*/


  yuv_planes_t yuv;
  rgb2yuy2_t *rgb2yuy2;

  /* frame skipping */
  int skip_frame;

#ifdef BENCHMARK
  int benchmark_frames, benchmark_min, benchmark_time;
#endif
};


/* plugin class functions */
static post_plugin_t *goom_open_plugin(post_class_t *class_gen, int inputs,
					 xine_audio_port_t **audio_target,
					 xine_video_port_t **video_target);
static void           goom_class_dispose(post_class_t *class_gen);

/* plugin instance functions */
static void           goom_dispose(post_plugin_t *this_gen);

/* rewire function */
static int            goom_rewire_video(xine_post_out_t *output, void *data);

static int goom_port_open(xine_audio_port_t *this, xine_stream_t *stream,
		   uint32_t bits, uint32_t rate, int mode);

static void goom_port_close(xine_audio_port_t *this, xine_stream_t *stream );

static void goom_port_put_buffer (xine_audio_port_t *this, audio_buffer_t *buf, xine_stream_t *stream);

static void fps_changed_cb(void *data, xine_cfg_entry_t *cfg) {
  post_class_goom_t *class = (post_class_goom_t*) data;
  class->fps = cfg->num_value < 1 ? 1
             : cfg->num_value > 50 ? 50
             : cfg->num_value;
}

static void width_changed_cb(void *data, xine_cfg_entry_t *cfg) {
  post_class_goom_t *class = (post_class_goom_t*) data;
  class->width = cfg->num_value;
}

static void height_changed_cb(void *data, xine_cfg_entry_t *cfg) {
  post_class_goom_t *class = (post_class_goom_t*) data;
  class->height = cfg->num_value;
}

static void csc_method_changed_cb(void *data, xine_cfg_entry_t *cfg) {
  post_class_goom_t *class = (post_class_goom_t*) data;
  class->csc_method = cfg->num_value;
}

static void *goom_init_plugin (xine_t *xine, const void *data) {
  config_values_t   *cfg;
  post_class_goom_t *this = calloc (1, sizeof (*this));
  if (!this)
    return NULL;

  (void)data;

  this->class.open_plugin     = goom_open_plugin;
  this->class.identifier      = "goom";
  this->class.description     = N_("What a GOOM");
  this->class.dispose         = goom_class_dispose;
  this->xine                  = xine;

  cfg = xine->config;

  this->fps = cfg->register_num (cfg, "effects.goom.fps", FPS,
    _("frames per second to generate"),
    _("With more frames per second, the animation will get "
      "smoother and faster, but will also require more CPU power."),
    10, fps_changed_cb, this);
  this->fps = this->fps < 1 ? 1
            : this->fps > 50 ? 50
            : this->fps;

  this->width = cfg->register_num (cfg, "effects.goom.width", GOOM_WIDTH,
    _("goom image width"),
    _("The width in pixels of the image to be generated."),
    10, width_changed_cb, this);

  this->height = cfg->register_num (cfg, "effects.goom.height", GOOM_HEIGHT,
    _("goom image height"),
    _("The height in pixels of the image to be generated."),
    10, height_changed_cb, this);

  this->csc_method = cfg->register_enum (cfg, "effects.goom.csc_method", 0,
    (char **)goom_csc_methods,
    _("colour space conversion method"),
    _("You can choose the colour space conversion method used by goom.\n"
      "The available selections should be self-explaining."),
    20, csc_method_changed_cb, this);

  return &this->class;
}


static post_plugin_t *goom_open_plugin(post_class_t *class_gen, int inputs,
					 xine_audio_port_t **audio_target,
					 xine_video_port_t **video_target)
{
  post_plugin_goom_t *this  = calloc(1, sizeof(post_plugin_goom_t));
  post_class_goom_t  *class = (post_class_goom_t*) class_gen;
  post_in_t          *input;
  post_out_t         *output;
  post_out_t         *outputv;
  post_audio_port_t  *port;

  if (!this || !video_target || !video_target[0] || !audio_target || !audio_target[0]) {
    free(this);
    return NULL;
  }

  (void)inputs;

  _x_post_init(&this->post, 1, 0);

  this->class = class;
  this->vo_port = video_target[0];

  this->metronom = _x_metronom_init(1, 0, class->xine);

  lprintf("goom_open_plugin\n");

  this->width_back  = class->width;
  this->height_back = class->height;

  srand((unsigned int)time((time_t *)NULL));
  this->goom = goom_init (this->width_back, this->height_back);

  this->ratio = (double)this->width_back/(double)this->height_back;

  this->buf.mem = NULL;
  this->buf.mem_size = 0;

  port = _x_post_intercept_audio_port(&this->post, audio_target[0], &input, &output);
  port->new_port.open       = goom_port_open;
  port->new_port.close      = goom_port_close;
  port->new_port.put_buffer = goom_port_put_buffer;

  outputv                  = &this->video_output;
  outputv->xine_out.name   = "generated video";
  outputv->xine_out.type   = XINE_POST_DATA_VIDEO;
  outputv->xine_out.data   = (xine_video_port_t **)&this->vo_port;
  outputv->xine_out.rewire = goom_rewire_video;
  outputv->post            = &this->post;
  xine_list_push_back(this->post.output, outputv);

  this->post.xine_post.audio_input[0] = &port->new_port;

  this->post.dispose = goom_dispose;

#ifdef __BIG_ENDIAN__
  this->rgb2yuy2 = rgb2yuy2_alloc (10, "argb");
#else
  this->rgb2yuy2 = rgb2yuy2_alloc (10, "bgra");
#endif
#ifdef BENCHMARK
  this->benchmark_frames = 200 - 1;
  this->benchmark_min = 10000000;
  this->benchmark_time = 0;
#endif

  return &this->post;
}

static void goom_class_dispose(post_class_t *class_gen)
{
  post_class_goom_t  *this = (post_class_goom_t*) class_gen;

  this->xine->config->unregister_callbacks (this->xine->config, NULL, NULL, this, sizeof (*this));

  free(class_gen);
}


static void goom_dispose(post_plugin_t *this_gen)
{
  post_plugin_goom_t *this   = (post_plugin_goom_t *)this_gen;

  if (_x_post_dispose(this_gen)) {

    rgb2yuy2_free (this->rgb2yuy2);

    goom_close(this->goom);

    this->metronom->exit(this->metronom);

    if(this->buf.mem)
      free(this->buf.mem);
    free(this);
  }
}


static int goom_rewire_video(xine_post_out_t *output_gen, void *data)
{
  post_out_t *output = (post_out_t *)output_gen;
  xine_video_port_t *old_port = *(xine_video_port_t **)output_gen->data;
  xine_video_port_t *new_port = (xine_video_port_t *)data;
  post_plugin_goom_t *this = (post_plugin_goom_t *)output->post;

  if (!data)
    return 0;
  /* register our stream at the new output port */
  old_port->close(old_port, XINE_ANON_STREAM);
  (new_port->open) (new_port, XINE_ANON_STREAM);
  /* reconnect ourselves */
  this->vo_port = new_port;
  return 1;
}

static int goom_port_open(xine_audio_port_t *port_gen, xine_stream_t *stream,
		   uint32_t bits, uint32_t rate, int mode) {

  post_audio_port_t  *port = (post_audio_port_t *)port_gen;
  post_plugin_goom_t *this = (post_plugin_goom_t *)port->post;

  _x_post_rewire(&this->post);
  _x_post_inc_usage(port);

  port->stream = stream;
  port->bits = bits;
  port->rate = rate;
  port->mode = mode;

  this->channels = _x_ao_mode2channels(mode);
  this->sample_rate = rate;
  this->samples_per_frame = rate / this->class->fps;
  this->data_idx = 0;
  init_yuv_planes(&this->yuv, this->width_back, this->height_back);
  this->skip_frame = 0;

  this->do_samples_skip = 0;
  this->left_to_read = NUMSAMPLES;

  (this->vo_port->open) (this->vo_port, XINE_ANON_STREAM);
  this->metronom->set_master(this->metronom, stream->metronom);

#ifdef BENCHMARK
  this->benchmark_frames = 200 - 1;
  this->benchmark_min = 10000000;
  this->benchmark_time = 0;
#endif

  return (port->original_port->open) (port->original_port, stream, bits, rate, mode );
}

static void goom_port_close(xine_audio_port_t *port_gen, xine_stream_t *stream ) {

  post_audio_port_t  *port = (post_audio_port_t *)port_gen;
  post_plugin_goom_t *this = (post_plugin_goom_t *)port->post;

  free_yuv_planes(&this->yuv);

  port->stream = NULL;

  this->vo_port->close(this->vo_port, XINE_ANON_STREAM);
  this->metronom->set_master(this->metronom, NULL);

  port->original_port->close(port->original_port, stream );

  _x_post_dec_usage(port);
}

#ifdef BENCHMARK
static int now (void) {
  struct timeval tv;
  gettimeofday (&tv, NULL);
  return tv.tv_sec * 1000000 + tv.tv_usec;
}
#endif

static void goom_port_put_buffer (xine_audio_port_t *port_gen,
                             audio_buffer_t *buf, xine_stream_t *stream) {

  post_audio_port_t  *port = (post_audio_port_t *)port_gen;
  post_plugin_goom_t *this = (post_plugin_goom_t *)port->post;
  vo_frame_t         *frame;
  uint8_t *goom_frame, *goom_frame_end;
  int16_t *data;
  int8_t *data8;
  int64_t pts = buf->vpts;
  int i, j;
  uint8_t *dest_ptr;
  int width, height;

  int current_sample = 0;

  /* make a copy of buf data for private use */
  if( this->buf.mem_size < buf->mem_size ) {
    this->buf.mem = realloc(this->buf.mem, buf->mem_size);
    this->buf.mem_size = buf->mem_size;
  }
  memcpy(this->buf.mem, buf->mem,
         buf->num_frames*this->channels*((port->bits == 8)?1:2));
  this->buf.num_frames = buf->num_frames;

  /* pass data to original port */
  port->original_port->put_buffer(port->original_port, buf, stream);

  /* we must not use original data anymore, it should have already being moved
   * to the fifo of free audio buffers. just use our private copy instead.
   */
  buf = &this->buf;
  j = (this->channels >= 2) ? 1 : 0;


  while (current_sample < buf->num_frames) {

  if (this->do_samples_skip) {
    if (current_sample + this->left_to_read > buf->num_frames) {
      this->left_to_read -= (buf->num_frames-current_sample);
      break;
    } else {
      current_sample+=this->left_to_read;
      this->left_to_read = NUMSAMPLES;
      this->do_samples_skip = 0;

    }
  } else {

    if( port->bits == 8 ) {
      data8 = (int8_t *)buf->mem;
      data8 += current_sample * this->channels;

      /* scale 8 bit data to 16 bits and convert to signed as well */
      for ( i=current_sample ; this->data_idx < NUMSAMPLES && i < buf->num_frames;
        i++, this->data_idx++,data8 += this->channels) {

        this->data[0][this->data_idx] = ((int16_t)data8[0] << 8) - 0x8000;
        this->data[1][this->data_idx] = ((int16_t)data8[j] << 8) - 0x8000;
      }
    } else {
      data = buf->mem;
      data += current_sample * this->channels;

      for ( i=current_sample ; this->data_idx < NUMSAMPLES && i < buf->num_frames;
        i++, this->data_idx++,data += this->channels) {

        this->data[0][this->data_idx] = data[0];
        this->data[1][this->data_idx] = data[j];
      }
    }

    if (this->data_idx < NUMSAMPLES) {
      this->left_to_read = NUMSAMPLES - this->data_idx;
      break;
    } else {
      _x_assert(this->data_idx == NUMSAMPLES);
      this->data_idx = 0;

      if (this->samples_per_frame > NUMSAMPLES) {
        current_sample += NUMSAMPLES;
        this->do_samples_skip = 1;
        this->left_to_read = this->samples_per_frame - NUMSAMPLES;
      } else {
        current_sample += this->samples_per_frame;
        this->left_to_read = NUMSAMPLES;
      }

      frame = this->vo_port->get_frame (this->vo_port, this->width_back, this->height_back,
                this->ratio, XINE_IMGFMT_YUY2,
                VO_BOTH_FIELDS);

      frame->extra_info->invalid = 1;

      frame->duration = 90000 * this->samples_per_frame / this->sample_rate;
      frame->pts = pts;
      this->metronom->got_video_frame(this->metronom, frame);

      if (!this->skip_frame) {
#ifdef BENCHMARK
        int elapsed = 0;
#endif
        /* Try to be fast */
        goom_frame = (uint8_t *)goom_update (this->goom, this->data, 0, 0, NULL, NULL);

        dest_ptr = frame -> base[0];
        goom_frame_end = goom_frame + 4 * (this->width_back * this->height_back);

#ifdef BENCHMARK
        if (this->benchmark_frames >= 0)
          elapsed = -now ();
#endif

        this->csc_method = this->class->csc_method;
        if (this->csc_method == 2) {

          if (!frame->proc_slice || (frame->height & 15)) {
            /* do all at once */
            rgb2yuy2_slice (this->rgb2yuy2, goom_frame, 4 * this->width_back,
              frame->base[0], frame->pitches[0], this->width_back, this->height_back);
          } else {
            /* sliced. This is a double edged sword.
               On one hand, it is faster by using cache more effective.
               On the flipside, when vo loop drops this frame, all this goes in vain */
            uint8_t *sptr[1];
            int     y, h = 16, p = 4 * this->width_back;
            for (y = 0; y < this->height_back; y += 16) {
              if (y + 16 > this->height_back)
                h = this->height_back & 15;
              sptr[0] = frame->base[0] + y * frame->pitches[0];
              rgb2yuy2_slice (this->rgb2yuy2, goom_frame + y * p, p,
                sptr[0], frame->pitches[0], this->width_back, h);
              frame->proc_slice (frame, sptr);
            }
          }
        }
#if defined(ARCH_X86)
        else if ((this->csc_method == 1) &&
            (xine_mm_accel() & MM_ACCEL_X86_MMX)) {
          int plane_ptr = 0;

          while (goom_frame < goom_frame_end) {
            uint8_t r, g, b;

            /* don't take endianness into account since MMX is only available
             * on Intel processors */
            b = *goom_frame; goom_frame++;
            g = *goom_frame; goom_frame++;
            r = *goom_frame; goom_frame += 2;

            this->yuv.y[plane_ptr] = COMPUTE_Y(r, g, b);
            this->yuv.u[plane_ptr] = COMPUTE_U(r, g, b);
            this->yuv.v[plane_ptr] = COMPUTE_V(r, g, b);
            plane_ptr++;
          }

          yuv444_to_yuy2(&this->yuv, frame->base[0], frame->pitches[0]);
        }
#endif /* ARCH_X86 */
        else {

          while (goom_frame < goom_frame_end) {
            uint8_t r1, g1, b1, r2, g2, b2;

#ifdef __BIG_ENDIAN__
            goom_frame ++;
            r1 = *goom_frame; goom_frame++;
            g1 = *goom_frame; goom_frame++;
            b1 = *goom_frame; goom_frame += 2;
            r2 = *goom_frame; goom_frame++;
            g2 = *goom_frame; goom_frame++;
            b2 = *goom_frame; goom_frame++;
#else
            b1 = *goom_frame; goom_frame++;
            g1 = *goom_frame; goom_frame++;
            r1 = *goom_frame; goom_frame += 2;
            b2 = *goom_frame; goom_frame++;
            g2 = *goom_frame; goom_frame++;
            r2 = *goom_frame; goom_frame += 2;
#endif

            *dest_ptr = COMPUTE_Y(r1, g1, b1);
            dest_ptr++;
            *dest_ptr = COMPUTE_U(r1, g1, b1);
            dest_ptr++;
            *dest_ptr = COMPUTE_Y(r2, g2, b2);
            dest_ptr++;
            *dest_ptr = COMPUTE_V(r2, g2, b2);
            dest_ptr++;
          }
        }

#ifdef BENCHMARK
        if (this->benchmark_frames >= 0) {
          elapsed += now ();
          this->benchmark_time += elapsed;
          if (elapsed < this->benchmark_min)
            this->benchmark_min = elapsed;
          if (--this->benchmark_frames < 0) {
            xprintf (this->class->xine, XINE_VERBOSITY_DEBUG,
              "goom: csc_method %d min %d us avg %d us\n",
              this->csc_method, this->benchmark_min, this->benchmark_time / 200);
          }
        }
#endif

        this->skip_frame = frame->draw(frame, XINE_ANON_STREAM);
      } else {
        frame->bad_frame = 1;
        frame->draw(frame, XINE_ANON_STREAM);

        _x_assert(this->skip_frame>0);
        this->skip_frame--;
      }

      frame->free(frame);

      width  = this->class->width;
      height = this->class->height;
      if ((width != this->width_back) || (height != this->height_back)) {
        goom_close(this->goom);
        this->goom = goom_init (width, height);
        this->width_back = width;
        this->height_back = height;
        this->ratio = (double)width/(double)height;
        free_yuv_planes(&this->yuv);
        init_yuv_planes(&this->yuv, width, height);
      }
    }
  }
  }
}

/* plugin catalog information */
static const post_info_t goom_special_info = {
  .type = XINE_POST_TYPE_AUDIO_VISUALIZATION,
};

const plugin_info_t xine_plugin_info[] EXPORTED = {
  /* type, API, "name", version, special_info, init_function */
  { PLUGIN_POST | PLUGIN_MUST_PRELOAD, 10, "goom", XINE_VERSION_CODE, &goom_special_info, &goom_init_plugin },
  { PLUGIN_NONE, 0, NULL, 0, NULL, NULL }
};