]> git.sesse.net Git - vlc/blobdiff - modules/codec/theora.c
Plugins: include vlc_common.h directly instead of vlc/vlc.h
[vlc] / modules / codec / theora.c
index ae8ab3bc8ebb4bc33b2f33900543dad01abfb49a..95f9a873702c51b35973803cfa7ace0fd8acbcc1 100644 (file)
@@ -1,7 +1,7 @@
 /*****************************************************************************
  * theora.c: theora decoder module making use of libtheora.
  *****************************************************************************
- * Copyright (C) 1999-2001 VideoLAN
+ * Copyright (C) 1999-2001 the VideoLAN team
  * $Id$
  *
  * Authors: Gildas Bazin <gbazin@videolan.org>
  *
  * 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.
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  *****************************************************************************/
 
 /*****************************************************************************
  * Preamble
  *****************************************************************************/
-#include <vlc/vlc.h>
-#include <vlc/decoder.h>
-#include <vlc/input.h>
-#include <vlc/sout.h>
-
+#ifdef HAVE_CONFIG_H
+# include "config.h"
+#endif
+
+#include <vlc_common.h>
+#include <vlc_plugin.h>
+#include <vlc_codec.h>
+#include <vlc_vout.h>
+#include <vlc_sout.h>
+#include <vlc_input.h>
 #include <ogg/ogg.h>
 
 #include <theora/theora.h>
@@ -39,7 +44,7 @@
 struct decoder_sys_t
 {
     /* Module mode */
-    vlc_bool_t b_packetizer;
+    bool b_packetizer;
 
     /*
      * Input properties
@@ -53,6 +58,11 @@ struct decoder_sys_t
     theora_comment   tc;                            /* theora comment header */
     theora_state     td;                   /* theora bitstream user comments */
 
+    /*
+     * Decoding properties
+     */
+    bool b_decoded_first_keyframe;
+
     /*
      * Common properties
      */
@@ -84,33 +94,34 @@ static block_t *Encode( encoder_t *p_enc, picture_t *p_pict );
  *****************************************************************************/
 #define ENC_QUALITY_TEXT N_("Encoding quality")
 #define ENC_QUALITY_LONGTEXT N_( \
-  "Allows you to specify a quality between 1 (low) and 10 (high), instead " \
+  "Enforce a quality between 1 (low) and 10 (high), instead " \
   "of specifying a particular bitrate. This will produce a VBR stream." )
 
 vlc_module_begin();
-    set_description( _("Theora video decoder") );
+    set_category( CAT_INPUT );
+    set_subcategory( SUBCAT_INPUT_VCODEC );
+    set_shortname( "Theora" );
+    set_description( N_("Theora video decoder") );
     set_capability( "decoder", 100 );
     set_callbacks( OpenDecoder, CloseDecoder );
     add_shortcut( "theora" );
 
     add_submodule();
-    set_description( _("Theora video packetizer") );
+    set_description( N_("Theora video packetizer") );
     set_capability( "packetizer", 100 );
     set_callbacks( OpenPacketizer, CloseDecoder );
-    add_shortcut( "theora" );
 
     add_submodule();
-    set_description( _("Theora video encoder") );
-    set_capability( "encoder", 100 );
+    set_description( N_("Theora video encoder") );
+    set_capability( "encoder", 150 );
     set_callbacks( OpenEncoder, CloseEncoder );
-    add_shortcut( "theora" );
 
 #   define ENC_CFG_PREFIX "sout-theora-"
     add_integer( ENC_CFG_PREFIX "quality", 2, NULL, ENC_QUALITY_TEXT,
-                 ENC_QUALITY_LONGTEXT, VLC_FALSE );
+                 ENC_QUALITY_LONGTEXT, false );
 vlc_module_end();
 
-static const char *ppsz_enc_options[] = {
+static const char *const ppsz_enc_options[] = {
     "quality", NULL
 };
 
@@ -130,13 +141,11 @@ static int OpenDecoder( vlc_object_t *p_this )
     /* Allocate the memory needed to store the decoder's structure */
     if( ( p_dec->p_sys = p_sys =
           (decoder_sys_t *)malloc(sizeof(decoder_sys_t)) ) == NULL )
-    {
-        msg_Err( p_dec, "out of memory" );
-        return VLC_EGENERIC;
-    }
-    p_dec->p_sys->b_packetizer = VLC_FALSE;
+        return VLC_ENOMEM;
+    p_dec->p_sys->b_packetizer = false;
 
     p_sys->i_pts = 0;
+    p_sys->b_decoded_first_keyframe = false;
 
     /* Set output properties */
     p_dec->fmt_out.i_cat = VIDEO_ES;
@@ -165,7 +174,7 @@ static int OpenPacketizer( vlc_object_t *p_this )
 
     if( i_ret == VLC_SUCCESS )
     {
-        p_dec->p_sys->b_packetizer = VLC_TRUE;
+        p_dec->p_sys->b_packetizer = true;
         p_dec->fmt_out.i_codec = VLC_FOURCC( 't', 'h', 'e', 'o' );
     }
 
@@ -209,7 +218,7 @@ static void *DecodeBlock( decoder_t *p_dec, block_t **pp_block )
         p_dec->fmt_in.p_extra =
             realloc( p_dec->fmt_in.p_extra, p_dec->fmt_in.i_extra +
                      oggpacket.bytes + 2 );
-        p_extra = p_dec->fmt_in.p_extra + p_dec->fmt_in.i_extra;
+        p_extra = ((uint8_t *)p_dec->fmt_in.p_extra) + p_dec->fmt_in.i_extra;
         *(p_extra++) = oggpacket.bytes >> 8;
         *(p_extra++) = oggpacket.bytes & 0xFF;
 
@@ -269,19 +278,24 @@ static int ProcessHeaders( decoder_t *p_dec )
 
     if( theora_decode_header( &p_sys->ti, &p_sys->tc, &oggpacket ) < 0 )
     {
-        msg_Err( p_dec, "This bitstream does not contain Theora video data" );
+        msg_Err( p_dec, "this bitstream does not contain Theora video data" );
         return VLC_EGENERIC;
     }
 
     /* Set output properties */
     p_dec->fmt_out.video.i_width = p_sys->ti.width;
     p_dec->fmt_out.video.i_height = p_sys->ti.height;
+    if( p_sys->ti.frame_width && p_sys->ti.frame_height )
+    {
+        p_dec->fmt_out.video.i_width = p_sys->ti.frame_width;
+        p_dec->fmt_out.video.i_height = p_sys->ti.frame_height;
+    }
 
     if( p_sys->ti.aspect_denominator && p_sys->ti.aspect_numerator )
     {
         p_dec->fmt_out.video.i_aspect = ((int64_t)VOUT_ASPECT_FACTOR) *
-            ( p_sys->ti.aspect_numerator * p_sys->ti.width ) /
-            ( p_sys->ti.aspect_denominator * p_sys->ti.height );
+            ( p_sys->ti.aspect_numerator * p_dec->fmt_out.video.i_width ) /
+            ( p_sys->ti.aspect_denominator * p_dec->fmt_out.video.i_height );
     }
     else
     {
@@ -289,6 +303,12 @@ static int ProcessHeaders( decoder_t *p_dec )
             p_sys->ti.frame_width / p_sys->ti.frame_height;
     }
 
+    if( p_sys->ti.fps_numerator > 0 && p_sys->ti.fps_denominator > 0 )
+    {
+        p_dec->fmt_out.video.i_frame_rate = p_sys->ti.fps_numerator;
+        p_dec->fmt_out.video.i_frame_rate_base = p_sys->ti.fps_denominator;
+    }
+
     msg_Dbg( p_dec, "%dx%d %.02f fps video, frame content "
              "is %dx%d with offset (%d,%d)",
              p_sys->ti.width, p_sys->ti.height,
@@ -296,6 +316,21 @@ static int ProcessHeaders( decoder_t *p_dec )
              p_sys->ti.frame_width, p_sys->ti.frame_height,
              p_sys->ti.offset_x, p_sys->ti.offset_y );
 
+    /* Sanity check that seems necessary for some corrupted files */
+    if( p_sys->ti.width < p_sys->ti.frame_width ||
+        p_sys->ti.height < p_sys->ti.frame_height )
+    {
+        msg_Warn( p_dec, "trying to correct invalid theora header "
+                  "(frame size (%dx%d) is smaller than frame content (%d,%d))",
+                  p_sys->ti.width, p_sys->ti.height,
+                  p_sys->ti.frame_width, p_sys->ti.frame_height );
+
+        if( p_sys->ti.width < p_sys->ti.frame_width )
+            p_sys->ti.width = p_sys->ti.frame_width;
+        if( p_sys->ti.height < p_sys->ti.frame_height )
+            p_sys->ti.height = p_sys->ti.frame_height;
+    }
+
     /* The next packet in order is the comments header */
     oggpacket.b_o_s = 0;
     oggpacket.bytes = *(p_extra++) << 8;
@@ -367,6 +402,14 @@ static void *ProcessPacket( decoder_t *p_dec, ogg_packet *p_oggpacket,
     block_t *p_block = *pp_block;
     void *p_buf;
 
+    if( ( p_block->i_flags&(BLOCK_FLAG_DISCONTINUITY|BLOCK_FLAG_CORRUPTED) ) != 0 )
+    {
+        /* Don't send the the first packet after a discontinuity to
+         * theora_decode, otherwise we get purple/green display artifacts
+         * appearing in the video output */
+        return NULL;
+    }
+
     /* Date management */
     if( p_block->i_pts > 0 && p_block->i_pts != p_sys->i_pts )
     {
@@ -398,7 +441,7 @@ static void *ProcessPacket( decoder_t *p_dec, ogg_packet *p_oggpacket,
     }
 
     /* Date management */
-    p_sys->i_pts += ( I64C(1000000) * p_sys->ti.fps_denominator /
+    p_sys->i_pts += ( INT64_C(1000000) * p_sys->ti.fps_denominator /
                       p_sys->ti.fps_numerator ); /* 1 frame per packet */
 
     return p_buf;
@@ -415,8 +458,20 @@ static picture_t *DecodePacket( decoder_t *p_dec, ogg_packet *p_oggpacket )
 
     theora_decode_packetin( &p_sys->td, p_oggpacket );
 
-    /* Decode */
-    theora_decode_YUVout( &p_sys->td, &yuv );
+    /* Check for keyframe */
+    if( !(p_oggpacket->packet[0] & 0x80) /* data packet */ &&
+        !(p_oggpacket->packet[0] & 0x40) /* intra frame */ )
+        p_sys->b_decoded_first_keyframe = true;
+
+    /* If we haven't seen a single keyframe yet, don't let Theora decode
+     * anything, otherwise we'll get display artifacts.  (This is impossible
+     * in the general case, but can happen if e.g. we play a network stream
+     * using a timed URL, such that the server doesn't start the video with a
+     * keyframe). */
+    if( p_sys->b_decoded_first_keyframe )
+        theora_decode_YUVout( &p_sys->td, &yuv );
+    else
+        return NULL;
 
     /* Get a new picture */
     p_pic = p_dec->pf_vout_buffer_new( p_dec );
@@ -455,7 +510,7 @@ static void ParseTheoraComments( decoder_t *p_dec )
             *psz_value = '\0';
             psz_value++;
             input_Control( p_input, INPUT_ADD_INFO, _("Theora comment"),
-                           psz_name, psz_value );
+                           psz_name, "%s", psz_value );
         }
         free( psz_comment );
         i++;
@@ -502,11 +557,12 @@ static void theora_CopyPicture( decoder_t *p_dec, picture_t *p_pic,
             i_src_yoffset /= 2;
         }
 
-        p_src += (i_src_yoffset * i_src_stride + i_src_yoffset);
+        p_src += (i_src_yoffset * i_src_stride + i_src_xoffset);
 
-        for( i_line = 0; i_line < p_pic->p[i_plane].i_lines; i_line++ )
+        for( i_line = 0; i_line < p_pic->p[i_plane].i_visible_lines; i_line++ )
         {
-            p_dec->p_vlc->pf_memcpy( p_dst, p_src, i_width );
+            vlc_memcpy( p_dst, p_src + i_src_xoffset,
+                        i_plane ? yuv->uv_width : yuv->y_width );
             p_src += i_src_stride;
             p_dst += i_dst_stride;
         }
@@ -521,7 +577,7 @@ struct encoder_sys_t
     /*
      * Input properties
      */
-    vlc_bool_t b_headers;
+    bool b_headers;
 
     /*
      * Theora properties
@@ -530,10 +586,7 @@ struct encoder_sys_t
     theora_comment   tc;                            /* theora comment header */
     theora_state     td;                   /* theora bitstream user comments */
 
-    /*
-     * Common properties
-     */
-    mtime_t i_pts;
+    int i_width, i_height;
 };
 
 /*****************************************************************************
@@ -554,28 +607,16 @@ static int OpenEncoder( vlc_object_t *p_this )
         return VLC_EGENERIC;
     }
 
-    if( p_enc->fmt_in.video.i_width % 16 ||
-        p_enc->fmt_in.video.i_height % 16 )
-    {
-        msg_Err( p_enc, "Theora video encoding requires dimensions which are "
-                 "multiples of 16. Which is not the case here (%dx%d).",
-                 p_enc->fmt_in.video.i_width, p_enc->fmt_in.video.i_height );
-        return VLC_EGENERIC;
-    }
-
     /* Allocate the memory needed to store the decoder's structure */
     if( ( p_sys = (encoder_sys_t *)malloc(sizeof(encoder_sys_t)) ) == NULL )
-    {
-        msg_Err( p_enc, "out of memory" );
-        return VLC_EGENERIC;
-    }
+        return VLC_ENOMEM;
     p_enc->p_sys = p_sys;
 
     p_enc->pf_encode_video = Encode;
     p_enc->fmt_in.i_codec = VLC_FOURCC('I','4','2','0');
     p_enc->fmt_out.i_codec = VLC_FOURCC('t','h','e','o');
 
-    sout_CfgParse( p_enc, ENC_CFG_PREFIX, ppsz_enc_options, p_enc->p_cfg );
+    config_ChainParse( p_enc, ENC_CFG_PREFIX, ppsz_enc_options, p_enc->p_cfg );
 
     var_Get( p_enc, ENC_CFG_PREFIX "quality", &val );
     i_quality = val.i_int;
@@ -586,10 +627,26 @@ static int OpenEncoder( vlc_object_t *p_this )
 
     p_sys->ti.width = p_enc->fmt_in.video.i_width;
     p_sys->ti.height = p_enc->fmt_in.video.i_height;
+
+    if( p_sys->ti.width % 16 || p_sys->ti.height % 16 )
+    {
+        /* Pictures from the transcoder should always have a pitch
+         * which is a multiple of 16 */
+        p_sys->ti.width = (p_sys->ti.width + 15) >> 4 << 4;
+        p_sys->ti.height = (p_sys->ti.height + 15) >> 4 << 4;
+
+        msg_Dbg( p_enc, "padding video from %dx%d to %dx%d",
+                 p_enc->fmt_in.video.i_width, p_enc->fmt_in.video.i_height,
+                 p_sys->ti.width, p_sys->ti.height );
+    }
+
     p_sys->ti.frame_width = p_enc->fmt_in.video.i_width;
     p_sys->ti.frame_height = p_enc->fmt_in.video.i_height;
     p_sys->ti.offset_x = 0 /*frame_x_offset*/;
-    p_sys->ti.offset_y = 0/*frame_y_offset*/;
+    p_sys->ti.offset_y = 0 /*frame_y_offset*/;
+
+    p_sys->i_width = p_sys->ti.width;
+    p_sys->i_height = p_sys->ti.height;
 
     if( !p_enc->fmt_in.video.i_frame_rate ||
         !p_enc->fmt_in.video.i_frame_rate_base )
@@ -605,9 +662,14 @@ static int OpenEncoder( vlc_object_t *p_this )
 
     if( p_enc->fmt_in.video.i_aspect )
     {
-        p_sys->ti.aspect_numerator =
-            p_enc->fmt_in.video.i_aspect * p_sys->ti.height / p_sys->ti.width;
-        p_sys->ti.aspect_denominator = VOUT_ASPECT_FACTOR;
+        uint64_t i_num, i_den;
+        unsigned i_dst_num, i_dst_den;
+
+        i_num = p_enc->fmt_in.video.i_aspect * (int64_t)p_sys->ti.height;
+        i_den = VOUT_ASPECT_FACTOR * p_sys->ti.width;
+        vlc_ureduce( &i_dst_num, &i_dst_den, i_num, i_den, 0 );
+        p_sys->ti.aspect_numerator = i_dst_num;
+        p_sys->ti.aspect_denominator = i_dst_den;
     }
     else
     {
@@ -667,16 +729,70 @@ static block_t *Encode( encoder_t *p_enc, picture_t *p_pict )
     ogg_packet oggpacket;
     block_t *p_block;
     yuv_buffer yuv;
+    int i;
+
+    /* Sanity check */
+    if( p_pict->p[0].i_pitch < (int)p_sys->i_width ||
+        p_pict->p[0].i_lines < (int)p_sys->i_height )
+    {
+        msg_Warn( p_enc, "frame is smaller than encoding size"
+                  "(%ix%i->%ix%i) -> dropping frame",
+                  p_pict->p[0].i_pitch, p_pict->p[0].i_lines,
+                  p_sys->i_width, p_sys->i_height );
+        return NULL;
+    }
+
+    /* Fill padding */
+    if( p_pict->p[0].i_visible_pitch < (int)p_sys->i_width )
+    {
+        for( i = 0; i < p_sys->i_height; i++ )
+        {
+            memset( p_pict->p[0].p_pixels + i * p_pict->p[0].i_pitch +
+                    p_pict->p[0].i_visible_pitch,
+                    *( p_pict->p[0].p_pixels + i * p_pict->p[0].i_pitch +
+                       p_pict->p[0].i_visible_pitch - 1 ),
+                    p_sys->i_width - p_pict->p[0].i_visible_pitch );
+        }
+        for( i = 0; i < p_sys->i_height / 2; i++ )
+        {
+            memset( p_pict->p[1].p_pixels + i * p_pict->p[1].i_pitch +
+                    p_pict->p[1].i_visible_pitch,
+                    *( p_pict->p[1].p_pixels + i * p_pict->p[1].i_pitch +
+                       p_pict->p[1].i_visible_pitch - 1 ),
+                    p_sys->i_width / 2 - p_pict->p[1].i_visible_pitch );
+            memset( p_pict->p[2].p_pixels + i * p_pict->p[2].i_pitch +
+                    p_pict->p[2].i_visible_pitch,
+                    *( p_pict->p[2].p_pixels + i * p_pict->p[2].i_pitch +
+                       p_pict->p[2].i_visible_pitch - 1 ),
+                    p_sys->i_width / 2 - p_pict->p[2].i_visible_pitch );
+        }
+    }
+
+    if( p_pict->p[0].i_visible_lines < (int)p_sys->i_height )
+    {
+        for( i = p_pict->p[0].i_visible_lines; i < p_sys->i_height; i++ )
+        {
+            memset( p_pict->p[0].p_pixels + i * p_pict->p[0].i_pitch, 0,
+                    p_sys->i_width );
+        }
+        for( i = p_pict->p[1].i_visible_lines; i < p_sys->i_height / 2; i++ )
+        {
+            memset( p_pict->p[1].p_pixels + i * p_pict->p[1].i_pitch, 0x80,
+                    p_sys->i_width / 2 );
+            memset( p_pict->p[2].p_pixels + i * p_pict->p[2].i_pitch, 0x80,
+                    p_sys->i_width / 2 );
+        }
+    }
 
     /* Theora is a one-frame-in, one-frame-out system. Submit a frame
      * for compression and pull out the packet. */
 
-    yuv.y_width  = p_pict->p[0].i_visible_pitch;
-    yuv.y_height = p_pict->p[0].i_lines;
+    yuv.y_width  = p_sys->i_width;
+    yuv.y_height = p_sys->i_height;
     yuv.y_stride = p_pict->p[0].i_pitch;
 
-    yuv.uv_width  = p_pict->p[1].i_visible_pitch;
-    yuv.uv_height = p_pict->p[1].i_lines;
+    yuv.uv_width  = p_sys->i_width / 2;
+    yuv.uv_height = p_sys->i_height / 2;
     yuv.uv_stride = p_pict->p[1].i_pitch;
 
     yuv.y = p_pict->p[0].p_pixels;