Documentation for the video magic (for Holger ;)

Small interface changes (better method names)

3 files changed, 68 insertions, 79 deletions

diff --git a/noncore/multimedia/opieplayer2/lib.cpp b/noncore/multimedia/opieplayer2/lib.cpp
index 748ae1f..d8a0694 100644
--- a/noncore/multimedia/opieplayer2/lib.cpp
+++ b/noncore/multimedia/opieplayer2/lib.cpp
@@ -95,3 +95,3 @@ Lib::Lib(XineVideoWidget* widget) {
         ::null_set_mode( m_videoOutput, qt_screen->depth(), qt_screen->pixelType() );
-        m_wid-> setImage ( new QImage ( Resource::loadImage("") ) );
+        m_wid-> setLogo ( new QImage ( Resource::loadImage("")));
         m_wid->repaint();
@@ -230,5 +230,3 @@ void Lib::drawFrame( uint8_t* frame,  int width,  int height,  int bytes ) {
 
-    m_wid->setImage( frame, width, height, bytes );
-//    m_wid->repaint(false);
-
+    m_wid-> setVideoFrame ( frame, width, height, bytes );
 }
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
@@ -4,4 +4,3 @@
 
-                             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>
@@ -47,2 +46,5 @@
 
+// 0 deg rot: copy a line from src to dst (use libc memcpy)
+
+// 180 deg rot: copy a line from src to dst reversed
 
@@ -57,3 +59,5 @@ static inline void memcpy_rev ( void *dst, void *src, size_t len )
 
-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 )
 {
@@ -62,3 +66,3 @@ static inline void memcpy_step ( void *dst, void *src, size_t len, size_t step )
     *((short int *) dst )++ = *((short int *) src );
-    ((char *) src ) += step;
+                ((char * ) src) += linestep;
   }
@@ -66,3 +70,5 @@ static inline void memcpy_step ( void *dst, void *src, size_t len, size_t step )
 
-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 )
 {
@@ -70,6 +76,6 @@ static inline void memcpy_step_rev ( void *dst, void *src, size_t len, size_t st
 
-  ((char *) src ) += ( len * step );
+        ((char *) src) += ( len * linestep );
 
   while ( len-- ) {
-    ((char *) src ) -= step;
+                ((char *) src) -= linestep;
     *((short int *) dst )++ = *((short int *) src );
@@ -84,3 +90,3 @@ XineVideoWidget::XineVideoWidget ( QWidget* parent, const char* name )
 
-  m_image             = 0;
+        m_logo = 0;
   m_buff              = 0;
@@ -94,3 +100,3 @@ XineVideoWidget::~XineVideoWidget ( )
 {
-  delete m_image;
+        delete m_logo;
 }
@@ -105,3 +111,2 @@ void XineVideoWidget::paintEvent ( QPaintEvent * )
 {
-  //qWarning( "painting <<<" );
   if ( m_buff == 0 ) {
@@ -109,9 +114,7 @@ void XineVideoWidget::paintEvent ( QPaintEvent * )
     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;
@@ -121,7 +124,8 @@ void XineVideoWidget::paintEvent ( QPaintEvent * )
 
-      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 ( )));
@@ -135,5 +139,6 @@ void XineVideoWidget::paintEvent ( QPaintEvent * )
 
-          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 ) {
@@ -146,6 +151,8 @@ void XineVideoWidget::paintEvent ( QPaintEvent * )
 
-          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
 
@@ -160,2 +167,3 @@ void XineVideoWidget::paintEvent ( QPaintEvent * )
               if (( y < framerect. top ( )) || ( y > framerect. bottom ( ))) {
+                                                // "above" or "below" the video -> black
                   memset ( dst, 0, clipwidth );
@@ -164,5 +172,7 @@ void XineVideoWidget::paintEvent ( QPaintEvent * )
               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 ) {
@@ -174,9 +184,9 @@ void XineVideoWidget::paintEvent ( QPaintEvent * )
                   }
-              }
             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 ) {
@@ -190,6 +200,7 @@ 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 );
@@ -201,17 +212,17 @@ 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;
@@ -224,4 +235,2 @@ void XineVideoWidget::setImage ( uchar* img, int w, int h, int bpl )
 
-//  qDebug ( "Frame: %d,%d - %dx%d", ( width ( ) - w ) / 2, ( height ( ) - h ) / 2, w , h );
-
   m_buff                 = img;
@@ -229,7 +238,8 @@ void XineVideoWidget::setImage ( uchar* img, int w, int h, int 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 ( );
@@ -237,9 +247,9 @@ void XineVideoWidget::resizeEvent ( QResizeEvent * )
 
+                        // 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 );
 
@@ -249,25 +259,5 @@ void XineVideoWidget::resizeEvent ( QResizeEvent * )
 
-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();
   }
-}
 
diff --git a/noncore/multimedia/opieplayer2/xinevideowidget.h b/noncore/multimedia/opieplayer2/xinevideowidget.h
index c5101da..33f1470 100644
--- a/noncore/multimedia/opieplayer2/xinevideowidget.h
+++ b/noncore/multimedia/opieplayer2/xinevideowidget.h
@@ -3,4 +3,3 @@
 
-                             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>
@@ -40,4 +39,7 @@
 class QImage;
+
+
 class XineVideoWidget : public QWidget {
     Q_OBJECT
+    
 public:
@@ -45,5 +47,5 @@ public:
     ~XineVideoWidget();
-    QImage *image() { return m_image; };
-    void setImage( QImage* image );
-    void setImage( uchar* image, int width, int height, int linestep);
+    QImage *logo ( ) const;
+    void setLogo ( QImage *image );
+    void setVideoFrame ( uchar *image, int width, int height, int linestep );
     void clear() ;
@@ -54,3 +56,2 @@ protected:
 
-    void mousePressEvent ( QMouseEvent *e );
     void mouseReleaseEvent ( QMouseEvent *e );
@@ -69,3 +70,3 @@ private:
     int m_bytes_per_pixel;
-    QImage* m_image;
+    QImage *m_logo;
     int m_rotation;