]> git.sesse.net Git - vlc/blobdiff - modules/video_output/snapshot.c
Used VLC_CODEC_* and vlc_fourcc_GetCodec when suitable.
[vlc] / modules / video_output / snapshot.c
index 669689f669288d994879822e87d45bb6704c14b3..49bf815c372a191da54e66b1452a711546a5498f 100644 (file)
@@ -1,7 +1,7 @@
 /*****************************************************************************
  * snapshot.c : snapshot plugin for vlc
  *****************************************************************************
- * Copyright (C) 2002 VideoLAN
+ * Copyright (C) 2002 the VideoLAN team
  * $Id$
  *
  * Authors: Olivier Aubert <oaubert@lisi.univ-lyon1.fr>
  *
  * 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.
  *****************************************************************************/
 
 /*****************************************************************************
- * This module is a pseudo video output the offers the possibility to
+ * This module is a pseudo video output that offers the possibility to
  * keep a cache of low-res snapshots.
  * The snapshot structure is defined in include/snapshot.h
  * In order to access the current snapshot cache, object variables are used:
  *   snapshot-list-pointer : the pointer on the first element in the list
- *   snapshot-datasize     : size of a snapshot 
+ *   snapshot-datasize     : size of a snapshot
  *                           (also available in snapshot_t->i_datasize)
  *   snapshot-cache-size   : size of the cache list
  *
 /*****************************************************************************
  * Preamble
  *****************************************************************************/
-#include <stdlib.h>
 
-#include <vlc/vlc.h>
-#include <vlc/vout.h>
-#include <vlc/intf.h>
-#include <snapshot.h>
+#ifdef HAVE_CONFIG_H
+# include "config.h"
+#endif
+
+#include <vlc_common.h>
+#include <vlc_plugin.h>
+#include <vlc_vout.h>
+#include <vlc_interface.h>
+#include <vlc_input.h>
 
 /*****************************************************************************
  * Local prototypes
@@ -52,43 +56,55 @@ static int  Create    ( vlc_object_t * );
 static void Destroy   ( vlc_object_t * );
 
 static int  Init      ( vout_thread_t * );
+static void End       ( vout_thread_t * );
 static void Display   ( vout_thread_t *, picture_t * );
 
 /*****************************************************************************
  * Module descriptor
  *****************************************************************************/
-#define WIDTH_TEXT N_( "snapshot width" )
-#define WIDTH_LONGTEXT N_( "Set the width of the snapshot image." )
+#define WIDTH_TEXT N_( "Snapshot width" )
+#define WIDTH_LONGTEXT N_( "Width of the snapshot image." )
 
-#define HEIGHT_TEXT N_( "snapshot height" )
-#define HEIGHT_LONGTEXT N_( "Set the height of the snapshot image." )
+#define HEIGHT_TEXT N_( "Snapshot height" )
+#define HEIGHT_LONGTEXT N_( "Height of the snapshot image." )
 
-#define CHROMA_TEXT N_( "chroma" )
-#define CHROMA_LONGTEXT N_( "Set the desired chroma for the snapshot image (a 4 character string)." )
+#define CHROMA_TEXT N_( "Chroma" )
+#define CHROMA_LONGTEXT N_( "Output chroma for the snapshot image " \
+                            "(a 4 character string, like \"RV32\")." )
 
-#define CACHE_TEXT N_( "cache size (number of images)" )
-#define CACHE_LONGTEXT N_( "Set the cache size (number of images to keep)." )
+#define CACHE_TEXT N_( "Cache size (number of images)" )
+#define CACHE_LONGTEXT N_( "Snapshot cache size (number of images to keep)." )
 
 
-vlc_module_begin( );
-    set_description( _( "snapshot module" ) );
-    set_shortname( N_("Snapshot") );
+vlc_module_begin ()
+    set_description( N_( "Snapshot output" ) )
+    set_shortname( N_("Snapshot") )
 
-    set_category( CAT_VIDEO );
-    set_subcategory( SUBCAT_VIDEO_VOUT );
-    set_capability( "video output", 1 );
+    set_category( CAT_VIDEO )
+    set_subcategory( SUBCAT_VIDEO_VOUT )
+    set_capability( "video output", 1 )
 
-    add_integer( "snapshot-width", 320, NULL, WIDTH_TEXT, WIDTH_LONGTEXT, VLC_FALSE );
-    add_integer( "snapshot-height", 200, NULL, HEIGHT_TEXT, HEIGHT_LONGTEXT, VLC_FALSE );
-    add_string( "snapshot-chroma", "RV32", NULL, CHROMA_TEXT, CHROMA_LONGTEXT, VLC_TRUE );
-    add_integer( "snapshot-cache-size", 50, NULL, CACHE_TEXT, CACHE_LONGTEXT, VLC_TRUE );
+    add_integer( "snapshot-width", 320, NULL, WIDTH_TEXT, WIDTH_LONGTEXT, false )
+    add_integer( "snapshot-height", 200, NULL, HEIGHT_TEXT, HEIGHT_LONGTEXT, false )
+    add_string( "snapshot-chroma", "RV32", NULL, CHROMA_TEXT, CHROMA_LONGTEXT, true )
+    add_integer( "snapshot-cache-size", 50, NULL, CACHE_TEXT, CACHE_LONGTEXT, true )
 
-    set_callbacks( Create, Destroy );
-vlc_module_end();
+    set_callbacks( Create, Destroy )
+vlc_module_end ()
 
 /*****************************************************************************
  * vout_sys_t: video output descriptor
  *****************************************************************************/
+typedef struct snapshot_t
+{
+  uint8_t *p_data;   /* Data area */
+
+  int i_width;       /* In pixels */
+  int i_height;      /* In pixels */
+  int i_datasize;    /* In bytes */
+  mtime_t date;      /* Presentation time */
+} snapshot_t;
+
 struct vout_sys_t
 {
     snapshot_t **p_list;    /* List of available snapshots */
@@ -119,7 +135,7 @@ static int Create( vlc_object_t *p_this )
     var_Create( p_vout, "snapshot-list-pointer", VLC_VAR_ADDRESS );
 
     p_vout->pf_init = Init;
-    p_vout->pf_end = NULL;
+    p_vout->pf_end = End;
     p_vout->pf_manage = NULL;
     p_vout->pf_render = NULL;
     p_vout->pf_display = Display;
@@ -149,11 +165,12 @@ static int Init( vout_thread_t *p_vout )
     {
         if( strlen( psz_chroma ) < 4 )
         {
-            msg_Err( p_vout, "snapshot-chroma should be 4 characters long." );
+            msg_Err( p_vout, "snapshot-chroma should be 4 characters long" );
             return VLC_EGENERIC;
         }
-        i_chroma = VLC_FOURCC( psz_chroma[0], psz_chroma[1],
-                               psz_chroma[2], psz_chroma[3] );
+        i_chroma = vlc_fourcc_GetCodec( VIDEO_ES,
+                                        VLC_FOURCC( psz_chroma[0], psz_chroma[1],
+                                                    psz_chroma[2], psz_chroma[3] ) );
         free( psz_chroma );
     }
     else
@@ -176,25 +193,25 @@ static int Init( vout_thread_t *p_vout )
     /* Define the bitmasks */
     switch( i_chroma )
     {
-      case VLC_FOURCC( 'R','V','1','5' ):
+      case VLC_CODEC_RGB15;
         p_vout->output.i_rmask = 0x001f;
         p_vout->output.i_gmask = 0x03e0;
         p_vout->output.i_bmask = 0x7c00;
         break;
 
-      case VLC_FOURCC( 'R','V','1','6' ):
+      case VLC_CODEC_RGB16;
         p_vout->output.i_rmask = 0x001f;
         p_vout->output.i_gmask = 0x07e0;
         p_vout->output.i_bmask = 0xf800;
         break;
 
-      case VLC_FOURCC( 'R','V','2','4' ):
+      case VLC_CODEC_RGB24;
         p_vout->output.i_rmask = 0xff0000;
         p_vout->output.i_gmask = 0x00ff00;
         p_vout->output.i_bmask = 0x0000ff;
         break;
 
-      case VLC_FOURCC( 'R','V','3','2' ):
+      case VLC_CODEC_RGB32:
         p_vout->output.i_rmask = 0xff0000;
         p_vout->output.i_gmask = 0x00ff00;
         p_vout->output.i_bmask = 0x0000ff;
@@ -267,9 +284,12 @@ static int Init( vout_thread_t *p_vout )
         p_snapshot->i_height = i_height;
         p_snapshot->i_datasize = i_datasize;
         p_snapshot->date = 0;
-        p_snapshot->p_data = ( char* ) malloc( i_datasize );
+        p_snapshot->p_data = malloc( i_datasize );
         if( p_snapshot->p_data == NULL )
+        {
+            free( p_snapshot );
             return VLC_ENOMEM;
+        }
         p_vout->p_sys->p_list[i_index] = p_snapshot;
     }
 
@@ -295,24 +315,32 @@ static int Init( vout_thread_t *p_vout )
 
     if( var_Create( p_vout->p_sys->p_input, "snapshot-id", VLC_VAR_INTEGER ) )
     {
-        msg_Err( p_vout, "Cannot create snapshot-id variable in p_input (%d).",
-                 p_vout->p_sys->p_input->i_object_id );
+        msg_Err( p_vout, "Cannot create snapshot-id variable in p_input(%p).",
+                 p_vout->p_sys->p_input );
         return VLC_EGENERIC;
     }
 
     /* Register the snapshot vout module at the input level */
-    val.i_int = p_vout->i_object_id;
+    val.p_address = p_vout;
 
     if( var_Set( p_vout->p_sys->p_input, "snapshot-id", val ) )
     {
-        msg_Err( p_vout, "Cannot register snapshot-id in p_input (%d).",
-                 p_vout->p_sys->p_input->i_object_id );
+        msg_Err( p_vout, "Cannot register snapshot-id in p_input(%p).",
+                 p_vout->p_sys->p_input );
         return VLC_EGENERIC;
     }
 
     return VLC_SUCCESS;
 }
 
+/*****************************************************************************
+ * End: terminate video thread output method
+ *****************************************************************************/
+static void End( vout_thread_t *p_vout )
+{
+    (void)p_vout;
+}
+
 /*****************************************************************************
  * Destroy: destroy video thread
  *****************************************************************************
@@ -321,23 +349,15 @@ static int Init( vout_thread_t *p_vout )
 static void Destroy( vlc_object_t *p_this )
 {
     vout_thread_t *p_vout = ( vout_thread_t * )p_this;
-    vlc_object_t *p_vlc;
     int i_index;
 
+    var_Destroy( p_vout->p_sys->p_input, "snapshot-id" );
+
     vlc_object_release( p_vout->p_sys->p_input );
     var_Destroy( p_this, "snapshot-width" );
     var_Destroy( p_this, "snapshot-height" );
     var_Destroy( p_this, "snapshot-datasize" );
 
-    p_vlc = vlc_object_find( p_this, VLC_OBJECT_ROOT, FIND_PARENT );
-    if( p_vlc )
-    {
-        /* UnRegister the snapshot vout module at the root level */
-        /* var_Destroy (p_vlc, "snapshot-id"); */
-        var_Destroy( p_this->p_libvlc, "snapshot-id" );
-        vlc_object_release( p_vlc );
-    }
-
     for( i_index = 0 ; i_index < p_vout->p_sys->i_size ; i_index++ )
     {
         free( p_vout->p_sys->p_list[ i_index ]->p_data );
@@ -350,19 +370,11 @@ static void Destroy( vlc_object_t *p_this )
 /* Return the position in ms from the start of the movie */
 static mtime_t snapshot_GetMovietime( vout_thread_t *p_vout )
 {
-    input_thread_t* p_input;
-    vlc_value_t val;
-    mtime_t i_result;
-
-    p_input = p_vout->p_sys->p_input;
+    input_thread_t *p_input = p_vout->p_sys->p_input;
     if( !p_input )
         return 0;
 
-    var_Get( p_input, "time", &val );
-
-    i_result = val.i_time - p_input->i_pts_delay;
-
-    return( i_result / 1000 );
+    return var_GetTime( p_input, "time" ) / 1000;
 }
 
 /*****************************************************************************
@@ -377,9 +389,8 @@ static void Display( vout_thread_t *p_vout, picture_t *p_pic )
 
     i_index = p_vout->p_sys->i_index;
 
-    p_vout->p_vlc->pf_memcpy( p_vout->p_sys->p_list[i_index]->p_data,
-                              p_pic->p->p_pixels,
-                              p_vout->p_sys->i_datasize );
+    vlc_memcpy( p_vout->p_sys->p_list[i_index]->p_data, p_pic->p->p_pixels,
+                p_vout->p_sys->i_datasize );
 
     i_date = snapshot_GetMovietime( p_vout );