Documentation for the video magic (for Holger ;)

Small interface changes (better method names)

1 files changed, 58 insertions, 68 deletions

diff --git a/noncore/multimedia/opieplayer2/xinevideowidget.cpp b/noncore/multimedia/opieplayer2/xinevideowidget.cpp
index d06d62a..9b26d41 100644
--- a/noncore/multimedia/opieplayer2/xinevideowidget.cpp
+++ b/noncore/multimedia/opieplayer2/xinevideowidget.cpp
@@ -2,8 +2,7 @@
 /*
                             This file is part of the Opie Project
 
-                             Copyright (c)  2002 Max Reiss <harlekin@handhelds.org>
-                             Copyright (c)  2002 LJP <>
+                             Copyright (c)  2002 Robert Griebl <sandman@handhelds.org>
                              Copyright (c)  2002 Holger Freyther <zecke@handhelds.org>
               =.
             .=l.
@@ -45,6 +44,9 @@
 
 #include "xinevideowidget.h"
 
+// 0 deg rot: copy a line from src to dst (use libc memcpy)
+
+// 180 deg rot: copy a line from src to dst reversed
 
 static inline void memcpy_rev ( void *dst, void *src, size_t len )
 {
@@ -55,23 +57,27 @@ static inline void memcpy_rev ( void *dst, void *src, size_t len )
     *((short int *) dst )++ = *--((short int *) src );
 }
 
-static inline void memcpy_step ( void *dst, void *src, size_t len, size_t step )
+// 90 deg rot: copy a column from src to dst
+
+static inline void memcpy_step ( void *dst, void *src, size_t len, size_t linestep )
 {
   len >>= 1;
   while ( len-- ) {
     *((short int *) dst )++ = *((short int *) src );
-    ((char *) src ) += step;
+                ((char * ) src) += linestep;
   }
 }
 
-static inline void memcpy_step_rev ( void *dst, void *src, size_t len, size_t step )
+// 270 deg rot: copy a column from src to dst reversed
+
+static inline void memcpy_step_rev ( void *dst, void *src, size_t len, size_t linestep )
 {
   len >>= 1;
 
-  ((char *) src ) += ( len * step );
+        ((char *) src) += ( len * linestep );
 
   while ( len-- ) {
-    ((char *) src ) -= step;
+                ((char *) src) -= linestep;
     *((short int *) dst )++ = *((short int *) src );
   }
 }
@@ -82,7 +88,7 @@ XineVideoWidget::XineVideoWidget ( QWidget* parent, const char* name )
 {
   setBackgroundMode ( NoBackground );
 
-  m_image             = 0;
+        m_logo = 0;
   m_buff              = 0;
   m_bytes_per_line_fb = qt_screen-> linestep ( );
   m_bytes_per_pixel   = ( qt_screen->depth() + 7 ) / 8;
@@ -92,7 +98,7 @@ XineVideoWidget::XineVideoWidget ( QWidget* parent, const char* name )
 
 XineVideoWidget::~XineVideoWidget ( )
 {
-  delete m_image;
+        delete m_logo;
 }
 
 void XineVideoWidget::clear ( )
@@ -103,27 +109,25 @@ void XineVideoWidget::clear ( )
 
 void XineVideoWidget::paintEvent ( QPaintEvent * )
 {
-  //qWarning( "painting <<<" );
   if ( m_buff == 0 ) {
     QPainter p ( this );
     p. fillRect ( rect ( ), black );
-    if ( m_image )
-      p. drawImage ( 0, 0, *m_image );
-    //qWarning ( "logo\n" );
+                if ( m_logo )
+                        p. drawImage ( 0, 0, *m_logo );
   }
   else {
-//    qWarning ( "paintevent\n" );
-
+                // Qt needs to be notified which areas were really updated .. strange
     QArray <QRect> qt_bug_workaround_clip_rects;
 
     {
       QDirectPainter dp ( this );
 
-      int rot = dp. transformOrientation ( ) + m_rotation;
+                        int rot = dp. transformOrientation ( ) + m_rotation; // device rotation + custom rotation
 
       uchar *fb = dp. frameBuffer ( );
-      uchar *frame = m_buff;  // rot == 0 ? m_buff : m_buff + ( m_thisframe. height ( ) - 1 ) * m_bytes_per_line_frame;
+                        uchar *frame = m_buff;
 
+                        // where is the video frame in fb coordinates
       QRect framerect = qt_screen-> mapToDevice ( QRect ( mapToGlobal ( m_thisframe. topLeft ( )), m_thisframe. size ( )), QSize ( qt_screen-> width ( ), qt_screen-> height ( )));
 
       qt_bug_workaround_clip_rects. resize ( dp. numRects ( ));
@@ -133,9 +137,10 @@ void XineVideoWidget::paintEvent ( QPaintEvent * )
 
           qt_bug_workaround_clip_rects [i] = qt_screen-> mapFromDevice ( clip, QSize ( qt_screen-> width ( ), qt_screen-> height ( )));
 
-          uchar *dst = fb + ( clip. x ( ) * m_bytes_per_pixel ) + ( clip. y ( ) * m_bytes_per_line_fb );
+                                        uchar *dst = fb + ( clip. x ( ) * m_bytes_per_pixel ) + ( clip. y ( ) * m_bytes_per_line_fb ); // clip x/y in the fb
           uchar *src = frame;
 
+                                // Adjust the start the source data based on the rotation (xine frame)
           switch ( rot ) {
           case 0: src += ( (( clip. x ( ) - framerect. x ( )) * m_bytes_per_pixel ) + (( clip. y ( ) - framerect. y ( )) * m_bytes_per_line_frame ) ); break;
           case 1: src += ( (( clip. y ( ) - framerect. y ( )) * m_bytes_per_pixel ) + (( clip. x ( ) - framerect. x ( )) * m_bytes_per_line_frame ) + (( framerect. height ( ) - 1 ) * m_bytes_per_pixel ) ); break;
@@ -144,10 +149,12 @@ void XineVideoWidget::paintEvent ( QPaintEvent * )
           default: break;
           }
 
-          uint leftfill = 0;
-          uint framefill = 0;
-          uint rightfill = 0;
-          uint clipwidth = clip. width ( ) * m_bytes_per_pixel;
+                                // all of the following widths/heights are fb relative (0deg rotation)
+
+                                uint leftfill = 0;   // black border on the "left" side of the video frame
+                                uint framefill = 0;  // "width" of the video frame
+                                uint rightfill = 0;  // black border on the "right" side of the video frame
+                                uint clipwidth = clip. width ( ) * m_bytes_per_pixel;  // "width" of the current clip rect
 
           if ( clip. left ( ) < framerect. left ( ))
               leftfill = (( framerect. left ( ) - clip. left ( )) * m_bytes_per_pixel ) <? clipwidth;
@@ -158,13 +165,16 @@ void XineVideoWidget::paintEvent ( QPaintEvent * )
 
           for ( int y = clip. top ( ); y <= clip. bottom ( ); y++ ) {
               if (( y < framerect. top ( )) || ( y > framerect. bottom ( ))) {
+                                                // "above" or "below" the video -> black
                   memset ( dst, 0, clipwidth );
               }
           else {
               if ( leftfill )
-                  memset ( dst, 0, leftfill );
+                                                        memset ( dst, 0, leftfill ); // "left" border -> black
+
+                                                if ( framefill ) { // blit in the video frame
+                                                        // see above for an explanation of the different memcpys
 
-              if ( framefill ) {
                   switch ( rot ) {
                   case 0: memcpy ( dst + leftfill, src, framefill );                                  break;
                   case 1: memcpy_step ( dst + leftfill, src, framefill, m_bytes_per_line_frame );     break;
@@ -172,13 +182,13 @@ void XineVideoWidget::paintEvent ( QPaintEvent * )
                   case 3: memcpy_step_rev ( dst + leftfill, src, framefill, m_bytes_per_line_frame ); break;
                   default: break;
                   }
-              }
             if ( rightfill )
-                memset ( dst + leftfill + framefill, 0, rightfill );
+                                                                memset ( dst + leftfill + framefill, 0, rightfill ); // "right" border -> black
           }
 
-              dst += m_bytes_per_line_fb;
+                                                dst += m_bytes_per_line_fb; // advance one line in the framebuffer
 
+                                                // advance one "line" in the xine frame data
               switch ( rot ) {
               case 0: src += m_bytes_per_line_frame; break;
               case 1: src -= m_bytes_per_pixel;      break;
@@ -188,10 +198,11 @@ void XineVideoWidget::paintEvent ( QPaintEvent * )
               }
           }
       }
-    }
-    //qWarning ( " ||| painting |||" );
+
     {
-        // QVFB hack by MArtin Jones
+                                        // QVFB hack by Martin Jones
+                                        // We need to "touch" all affected clip rects with a normal QPainter in addition to the QDirectPainter
+
         QPainter p ( this );
 
         for ( int i = qt_bug_workaround_clip_rects. size ( ) - 1; i >= 0; i-- ) {
@@ -199,21 +210,21 @@ void XineVideoWidget::paintEvent ( QPaintEvent * )
         }
     }
   }
-  //qWarning( "painting >>>" );
 }
 
+                QImage *XineVideoWidget::logo ( ) const {
+                        return m_logo;
+                }
 
-void XineVideoWidget::setImage ( QImage* image )
-{
-  delete m_image;
-  m_image = image;
+                void XineVideoWidget::setLogo ( QImage * image ) {
+                        delete m_logo;
+                        m_logo = image;
 }
 
-void XineVideoWidget::setImage ( uchar* img, int w, int h, int bpl )
-{
+                void XineVideoWidget::setVideoFrame ( uchar * img, int w, int h, int bpl ) {
   bool rot90 = (( -m_rotation ) & 1 );
 
-  if ( rot90 ) {
+                        if ( rot90 ) { // if the rotation is 90 or 270 we have to swap width / height
     int d = w;
     w = h;
     h = d;
@@ -222,52 +233,31 @@ void XineVideoWidget::setImage ( uchar* img, int w, int h, int bpl )
   m_lastframe = m_thisframe;
   m_thisframe. setRect (( width ( ) - w ) / 2, ( height ( ) - h ) / 2, w , h );
 
-//  qDebug ( "Frame: %d,%d - %dx%d", ( width ( ) - w ) / 2, ( height ( ) - h ) / 2, w , h );
-
   m_buff                 = img;
   m_bytes_per_line_frame = bpl;
 
-  repaint ((( m_thisframe & m_lastframe ) != m_lastframe ) ? m_lastframe : m_thisframe, false );
+                        // only repaint the area that *really* needs to be repainted
+
+                        repaint ((
 }
 
-void XineVideoWidget::resizeEvent ( QResizeEvent * )
-{
+                void XineVideoWidget::resizeEvent ( QResizeEvent * ) {
   QSize s = size ( );
   bool fs = ( s == qApp-> desktop ( )-> size ( ));
 
+                        // if we are in fullscreen mode, do not rotate the video
+                        // (!! the paint routine uses m_rotation + qt_screen-> transformOrientation() !!)
+
   m_rotation = fs ? -qt_screen-> transformOrientation ( ) : 0;
 
-  if ( fs && qt_screen-> isTransformed ( )) {
+                        if ( fs && qt_screen-> isTransformed ( ))
     s = qt_screen-> mapToDevice ( s );
-  }
-
-//  qDebug ( "\n\nResize: %dx%d, Rot: %d", s.width(),s.height(),m_rotation );
 
   emit videoResized ( s );
 }
 
 
-void XineVideoWidget::mousePressEvent ( QMouseEvent * /*me*/ )
-{
-  QWidget *p = parentWidget ( );
-
-  if ( p ) {
-      // QMouseEvent pme ( QEvent::MouseButtonPress, mapToParent ( me-> pos ( )), me-> globalPos ( ), me-> button ( ), me-> state ( ));
-
-      // QApplication::sendEvent ( p, &pme );
-      //  emit clicked();
-  }
-}
-
-void XineVideoWidget::mouseReleaseEvent ( QMouseEvent * /*me*/ )
-{
-  QWidget *p = parentWidget ( );
-
-  if ( p ) {
-      //  QMouseEvent pme ( QEvent::MouseButtonRelease, mapToParent ( me-> pos ( )), me-> globalPos ( ), me-> button ( ), me-> state ( ));
-
-      // QApplication::sendEvent ( p, &pme );
+                void XineVideoWidget::mouseReleaseEvent ( QMouseEvent * ) {
      emit clicked();
   }
-}