* configure.ac.in, modules/codec/Modules.am, modules/codec/tarkin.c: added
authorGildas Bazin <gbazin@videolan.org>
Mon, 18 Nov 2002 13:28:09 +0000 (13:28 +0000)
committerGildas Bazin <gbazin@videolan.org>
Mon, 18 Nov 2002 13:28:09 +0000 (13:28 +0000)
   an experimental tarkin video decoder. You will need to specify the tarkin
   tree you want to use with --with-tarkin-tree=.

   Warning: Tarkin is still in very early development stage, so this plugin isn't
   actually usefull unless you intend to do some development on tarkin itself.

configure.ac.in
modules/codec/Modules.am
modules/codec/tarkin.c [new file with mode: 0644]

index 68849d3..0310b84 100644 (file)
@@ -1479,6 +1479,33 @@ then
    ],[])
 fi
 
+dnl
+dnl  tarkin decoder plugin
+dnl
+AC_ARG_ENABLE(tarkin,
+[  --enable-tarkin         experimental tarkin codec (default disabled)])
+if test "x${enable_tarkin}" = "xyes"
+then
+  AC_ARG_WITH(tarkin-tree,
+  [    --with-tarkin-tree=PATH tarkin tree for static linking])
+  if test "x${with_tarkin_tree}" != "x"
+  then
+    AC_MSG_CHECKING(for tarkin.o in ${with_tarkin_tree})
+    real_tarkin_tree="`cd ${with_tarkin_tree} 2>/dev/null && pwd`"
+    if test -f "${real_tarkin_tree}/tarkin.o"
+    then
+      BUILTINS="${BUILTINS} tarkin"
+      CPPFLAGS_tarkin="${CPPFLAGS_tarkin} -I${real_tarkin_tree}"
+      LDFLAGS_tarkin="${LDFLAGS_tarkin} ${real_tarkin_tree}/mem.o ${real_tarkin_tree}/pnm.o ${real_tarkin_tree}/wavelet.o ${real_tarkin_tree}/wavelet_xform.o ${real_tarkin_tree}/wavelet_coeff.o ${real_tarkin_tree}/yuv.o ${real_tarkin_tree}/tarkin.o ${real_tarkin_tree}/info.o -logg"
+    else
+      dnl  The given tarkin tree wasn't built
+      AC_MSG_RESULT(no)
+      AC_MSG_ERROR([cannot find ${real_tarkin_tree}/tarkin.o,
+                    make sure you compiled tarkin in ${with_tarkin_tree}])
+    fi
+  fi
+fi
+
 dnl
 dnl  Video plugins
 dnl
index aa309e8..084aa31 100644 (file)
@@ -2,5 +2,6 @@ SOURCES_a52 = modules/codec/a52.c
 SOURCES_lpcm = modules/codec/lpcm.c
 SOURCES_araw = modules/codec/araw.c
 SOURCES_vorbis = modules/codec/vorbis.c
+SOURCES_tarkin = modules/codec/tarkin.c
 SOURCES_dv = modules/codec/dv.c
 SOURCES_xvid = modules/codec/xvid.c
diff --git a/modules/codec/tarkin.c b/modules/codec/tarkin.c
new file mode 100644 (file)
index 0000000..3734399
--- /dev/null
@@ -0,0 +1,413 @@
+/*****************************************************************************
+ * tarkin.c: tarkin decoder module making use of libtarkin.
+ *****************************************************************************
+ * Copyright (C) 1999-2001 VideoLAN
+ * $Id: tarkin.c,v 1.1 2002/11/18 13:28:09 gbazin Exp $
+ *
+ * Authors: Gildas Bazin <gbazin@netcourrier.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, write to the Free Software
+ * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
+ *****************************************************************************/
+
+/*****************************************************************************
+ * Preamble
+ *****************************************************************************/
+#include <vlc/vlc.h>
+#include <vlc/vout.h>
+#include <vlc/input.h>
+#include <vlc/decoder.h>
+
+#include <stdlib.h>                                      /* malloc(), free() */
+#include <string.h>                                    /* memcpy(), memset() */
+
+#include <ogg/ogg.h>
+
+/* FIXME */
+// use 16 bit signed integers as wavelet coefficients
+#define TYPE int16_t
+// we'll actually use TYPE_BITS bits of type (e.g. 9 magnitude + 1 sign)
+#define TYPE_BITS 10
+// use the rle entropy coder
+#define RLECODER 1
+
+#include <tarkin.h>
+
+/*****************************************************************************
+ * dec_thread_t : vorbis decoder thread descriptor
+ *****************************************************************************/
+typedef struct dec_thread_t
+{
+    /*
+     * Thread properties
+     */
+    vlc_thread_t        thread_id;                /* id for thread functions */
+
+    /*
+     * Tarkin properties
+     */
+    TarkinStream *tarkin_stream;
+
+    TarkinInfo       ti; /* struct that stores all the static tarkin bitstream
+                            settings */
+    TarkinComment    tc; /* struct that stores all the bitstream user
+                          * comments */
+    TarkinTime           tarkdate;
+
+    /*
+     * Input properties
+     */
+    decoder_fifo_t         *p_fifo;            /* stores the PES stream data */
+    pes_packet_t           *p_pes;            /* current PES we are decoding */
+
+    /*
+     * Output properties
+     */
+    vout_thread_t *p_vout;
+
+} dec_thread_t;
+
+/*****************************************************************************
+ * Local prototypes
+ *****************************************************************************/
+static int  OpenDecoder  ( vlc_object_t * );
+static int  RunDecoder   ( decoder_fifo_t * );
+static void CloseDecoder ( dec_thread_t * );
+
+static void DecodePacket ( dec_thread_t * );
+static int  GetOggPacket ( dec_thread_t *, ogg_packet *, mtime_t * );
+
+static void tarkin_CopyPicture( dec_thread_t *, picture_t *, uint8_t * );
+static vout_thread_t *tarkin_SpawnVout( dec_thread_t *, int, int, int, int );
+/*****************************************************************************
+ * Module descriptor
+ *****************************************************************************/
+vlc_module_begin();
+    set_description( _("Tarkin decoder module") );
+    set_capability( "decoder", 100 );
+    set_callbacks( OpenDecoder, NULL );
+vlc_module_end();
+
+/*****************************************************************************
+ * OpenDecoder: probe the decoder and return score
+ *****************************************************************************/
+static int OpenDecoder( vlc_object_t *p_this )
+{
+    decoder_fifo_t *p_fifo = (decoder_fifo_t*) p_this;
+
+    if( p_fifo->i_fourcc != VLC_FOURCC('t','a','r','k') )
+    {
+        return VLC_EGENERIC;
+    }
+
+    p_fifo->pf_run = RunDecoder;
+    return VLC_SUCCESS;
+}
+
+/*****************************************************************************
+ * RunDecoder: the tarkin decoder
+ *****************************************************************************/
+static int RunDecoder( decoder_fifo_t *p_fifo )
+{
+    dec_thread_t *p_dec;
+    ogg_packet oggpacket;
+    mtime_t i_pts;
+
+    /* Allocate the memory needed to store the thread's structure */
+    if( (p_dec = (dec_thread_t *)malloc (sizeof(dec_thread_t)) )
+            == NULL)
+    {
+        msg_Err( p_fifo, "out of memory" );
+        goto error;
+    }
+
+    /* Initialize the thread properties */
+    memset( p_dec, 0, sizeof(dec_thread_t) );
+    p_dec->p_fifo = p_fifo;
+    p_dec->p_pes  = NULL;
+
+    /* Take care of the initial Tarkin header */
+    p_dec->tarkin_stream = tarkin_stream_new();
+    tarkin_info_init(&p_dec->ti);
+    tarkin_comment_init(&p_dec->tc);
+
+    if( GetOggPacket( p_dec, &oggpacket, &i_pts ) != VLC_SUCCESS )
+        goto error;
+
+    oggpacket.b_o_s = 1; /* yes this actually is a b_o_s packet :) */
+    if( tarkin_synthesis_headerin( &p_dec->ti, &p_dec->tc, &oggpacket ) < 0 )
+    {
+        msg_Err( p_dec->p_fifo, "This bitstream does not contain Tarkin "
+                 "vido data");
+        goto error;
+    }
+
+    /* The next two packets in order are the comment and codebook headers.
+       We need to watch out that these packets are not missing as a
+       missing or corrupted header is fatal. */
+    if( GetOggPacket( p_dec, &oggpacket, &i_pts ) != VLC_SUCCESS )
+        goto error;
+
+    if( tarkin_synthesis_headerin( &p_dec->ti, &p_dec->tc, &oggpacket ) < 0 )
+    {
+        msg_Err( p_dec->p_fifo, "2nd Tarkin header is corrupted" );
+        goto error;
+    }
+
+    if( GetOggPacket( p_dec, &oggpacket, &i_pts ) != VLC_SUCCESS )
+        goto error;
+
+    if( tarkin_synthesis_headerin( &p_dec->ti, &p_dec->tc, &oggpacket ) < 0 )
+    {
+        msg_Err( p_dec->p_fifo, "3rd Tarkin header is corrupted" );
+        goto error;
+    }
+
+    /* Initialize the tarkin decoder */
+    tarkin_synthesis_init( p_dec->tarkin_stream, &p_dec->ti );
+
+    /* vorbis decoder thread's main loop */
+    while( (!p_dec->p_fifo->b_die) && (!p_dec->p_fifo->b_error) )
+    {
+        DecodePacket( p_dec );
+    }
+
+    /* If b_error is set, the vorbis decoder thread enters the error loop */
+    if( p_dec->p_fifo->b_error )
+    {
+        DecoderError( p_dec->p_fifo );
+    }
+
+    /* End of the tarkin decoder thread */
+    CloseDecoder( p_dec );
+
+    return 0;
+
+ error:
+    DecoderError( p_fifo );
+    if( p_dec )
+    {
+        if( p_dec->p_fifo )
+            p_dec->p_fifo->b_error = 1;
+
+        /* End of the tarkin decoder thread */
+        CloseDecoder( p_dec );
+    }
+
+    return -1;
+}
+
+/*****************************************************************************
+ * DecodePacket: decodes a Tarkin packet.
+ *****************************************************************************/
+static void DecodePacket( dec_thread_t *p_dec )
+{
+    ogg_packet oggpacket;
+    picture_t *p_pic;
+    mtime_t i_pts;
+    int i_width, i_height, i_chroma, i_aspect;
+    uint32_t frame = 0;
+    uint8_t *rgb;
+
+    if( GetOggPacket( p_dec, &oggpacket, &i_pts ) != VLC_SUCCESS )
+    {
+        /* This should mean an eos */
+        return;
+    }
+
+    tarkin_synthesis_packetin( p_dec->tarkin_stream, &oggpacket );
+
+    while( tarkin_synthesis_frameout( p_dec->tarkin_stream,
+                                     &rgb, 0, &p_dec->tarkdate ) == 0 )
+    {
+
+       i_width = p_dec->tarkin_stream->layer->desc.width;
+       i_height = p_dec->tarkin_stream->layer->desc.height;
+       switch( p_dec->tarkin_stream->layer->desc.format )
+       {
+       case TARKIN_RGB24:
+            i_chroma = VLC_FOURCC('R','V','2','4');
+           break;
+       case TARKIN_RGB32:
+            i_chroma = VLC_FOURCC('R','V','3','2');
+           break;
+       case TARKIN_RGBA:
+            i_chroma = VLC_FOURCC('R','G','B','A');
+           break;
+       default:
+            i_chroma = VLC_FOURCC('Y','V','1','2');
+           break;
+       }
+        i_aspect = VOUT_ASPECT_FACTOR * i_width / i_height;
+        p_dec->p_vout = tarkin_SpawnVout( p_dec, i_width, i_height,
+                                         i_aspect, i_chroma );
+
+        /* Get a new picture */
+        while( !(p_pic = vout_CreatePicture( p_dec->p_vout, 0, 0, 0 ) ) )
+        {
+            if( p_dec->p_fifo->b_die || p_dec->p_fifo->b_error )
+            {
+                return;
+            }
+            msleep( VOUT_OUTMEM_SLEEP );
+        }
+        if( !p_pic )
+            break;
+
+        tarkin_CopyPicture( p_dec, p_pic, rgb );
+
+        tarkin_synthesis_freeframe( p_dec->tarkin_stream, rgb );
+
+        vout_DatePicture( p_dec->p_vout, p_pic, mdate()+DEFAULT_PTS_DELAY/*i_pts*/ );
+        vout_DisplayPicture( p_dec->p_vout, p_pic );
+
+    }
+}
+
+/*****************************************************************************
+ * GetOggPacket: get the following tarkin packet from the stream and send back
+ *               the result in an ogg packet (for easy decoding by libtarkin).
+ *****************************************************************************
+ * Returns VLC_EGENERIC in case of eof.
+ *****************************************************************************/
+static int GetOggPacket( dec_thread_t *p_dec, ogg_packet *p_oggpacket,
+                         mtime_t *p_pts )
+{
+    if( p_dec->p_pes ) input_DeletePES( p_dec->p_fifo->p_packets_mgt,
+                                        p_dec->p_pes );
+
+    input_ExtractPES( p_dec->p_fifo, &p_dec->p_pes );
+    if( !p_dec->p_pes ) return VLC_EGENERIC;
+
+    p_oggpacket->packet = p_dec->p_pes->p_first->p_payload_start;
+    p_oggpacket->bytes = p_dec->p_pes->i_pes_size;
+    p_oggpacket->granulepos = p_dec->p_pes->i_dts;
+    p_oggpacket->b_o_s = 0;
+    p_oggpacket->e_o_s = 0;
+    p_oggpacket->packetno = 0;
+
+    *p_pts = p_dec->p_pes->i_pts;
+
+    return VLC_SUCCESS;
+}
+
+/*****************************************************************************
+ * CloseDecoder: tarkin decoder destruction
+ *****************************************************************************/
+static void CloseDecoder( dec_thread_t * p_dec )
+{
+
+    if( p_dec )
+    {
+        if( p_dec->p_pes )
+            input_DeletePES( p_dec->p_fifo->p_packets_mgt, p_dec->p_pes );
+
+        if( p_dec->p_vout )
+       {
+            vlc_object_detach( p_dec->p_vout );
+            vout_DestroyThread( p_dec->p_vout );
+       }
+
+       if( p_dec->tarkin_stream )
+           tarkin_stream_destroy( p_dec->tarkin_stream );
+
+        free( p_dec );
+    }
+}
+
+/*****************************************************************************
+ * tarkin_SpawnVout: creates a new video output
+ *****************************************************************************/
+static vout_thread_t *tarkin_SpawnVout( dec_thread_t *p_dec,
+                                        int i_width,
+                                        int i_height,
+                                        int i_aspect,
+                                        int i_chroma )
+{
+    vout_thread_t *p_vout;
+
+    if( !i_width || !i_height )
+        return NULL;
+
+    if( !i_chroma )
+        return NULL;
+
+    /* Spawn a video output if there is none. First we look for our children,
+     * then we look for any other vout that might be available. */
+    p_vout = vlc_object_find( p_dec->p_fifo, VLC_OBJECT_VOUT,
+                                              FIND_CHILD );
+    if( !p_vout )
+    {
+        p_vout = vlc_object_find( p_dec->p_fifo, VLC_OBJECT_VOUT,
+                                                  FIND_ANYWHERE );
+    }
+
+    if( p_vout )
+    {
+        if( p_vout->render.i_width != i_width
+            || p_vout->render.i_height != i_height
+            || p_vout->render.i_chroma != i_chroma
+            || p_vout->render.i_aspect != i_aspect )
+        {
+            /* We are not interested in this format, close this vout */
+            vlc_object_detach( p_vout );
+            vlc_object_release( p_vout );
+            vout_DestroyThread( p_vout );
+            p_vout = NULL;
+        }
+        else
+        {
+            /* This video output is cool! Hijack it. */
+            vlc_object_detach( p_vout );
+            vlc_object_attach( p_vout, p_dec->p_fifo );
+            vlc_object_release( p_vout );
+        }
+    }
+
+    if( p_vout == NULL )
+    {
+        msg_Dbg( p_dec->p_fifo, "no vout present, spawning one" );
+
+        p_vout = vout_CreateThread( p_dec->p_fifo,
+                                    i_width, i_height,
+                                    i_chroma, i_aspect );
+    }
+
+    return( p_vout );
+}
+
+/*****************************************************************************
+ * tarkin_CopyPicture: copy a picture from tarkin internal buffers to a
+ *                     picture_t structure.
+ *****************************************************************************/
+static void tarkin_CopyPicture( dec_thread_t *p_dec, picture_t *p_pic,
+                               uint8_t *p_src )
+{
+    int i_plane, i_line, i_width, i_dst_stride;
+    u8  *p_dst;
+
+    for( i_plane = 0; i_plane < p_pic->i_planes; i_plane++ )
+    {
+       p_dst = p_pic->p[i_plane].p_pixels;
+       i_width = p_pic->p[i_plane].i_visible_pitch;
+       i_dst_stride = p_pic->p[i_plane].i_pitch;
+
+       for( i_line = 0; i_line < p_pic->p[i_plane].i_lines; i_line++ )
+       {
+           p_dec->p_fifo->p_vlc->pf_memcpy( p_dst, p_src, i_width );
+           p_src += i_width;
+           p_dst += i_dst_stride;
+       }
+    }
+}