IEEE1394Reader Class Reference

#include <ieee1394io.h>

Collaboration diagram for IEEE1394Reader:

[legend]List of all members.

Public Member Functions
	IEEE1394Reader (int chn=63, int frames=50)
	Initializes the IEEE1394Reader object.
virtual	~IEEE1394Reader ()
	Destroys the IEEE1394Reader object.
virtual bool	StartThread (int port=0)=0
virtual void	StopThread (void)=0
Frame *	GetFrame (void)
	Fetches the next frame from the output queue.
void	DoneWithFrame (Frame *)
	Put back a frame to the queue of available frames.
int	GetDroppedFrames (void)
	Return the number of dropped frames since last call.
int	GetOutQueueSize (void)
int	GetInQueueSize (void)
void	ResetDroppedFrames (void)
virtual bool	Open (int port=0)=0
virtual void	Close (void)=0
bool	WaitForAction (int seconds=0)
void	TriggerAction ()
virtual bool	StartReceive (void)=0
virtual void	StopReceive (void)=0
Protected Member Functions
void	Flush (void)
	Throw away all currently available frames.
Protected Attributes
int	droppedFrames
	the number of frames that had to be thrown away because our inFrames queue did not contain available frames
Frame *	currentFrame
	a pointer to the frame which is currently been transmitted
deque< Frame * >	inFrames
	a list of empty frames
deque< Frame * >	outFrames
	a list of already received frames
int	channel
	the iso channel we listen to (typically == 63)
pthread_t	thread
	contains information about our thread after calling StartThread
pthread_mutex_t	mutex
	this mutex protects capture related variables that could possibly accessed from two threads at the same time
pthread_mutex_t	condition_mutex
pthread_cond_t	condition
bool	isRunning
	A state variable for starting and stopping thread.

---

Constructor & Destructor Documentation

IEEE1394Reader::IEEE1394Reader (  int  c = 63, int  bufSize = 50 )

Initializes the IEEE1394Reader object. The object is initialized with port and channel number. These parameters define the interface card and the iso channel on which the camcorder sends its data. The object contains a list of empty frames, which are allocated here. 50 frames (2 seconds) should be enough in most cases. Parameters: c  the iso channel number to use bufSize  the number of frames to allocate for the frames buffer Definition at line 96 of file ieee1394io.cc. References condition, condition_mutex, GetFramePool(), inFrames, and mutex. : droppedFrames( 0 ), currentFrame( NULL ), channel( c ), isRunning( false ) { Frame * frame; /* Create empty frames and put them in our inFrames queue */ for ( int i = 0; i < bufSize; ++i ) { frame = GetFramePool( ) ->GetFrame( ); inFrames.push_back( frame ); } /* Initialize mutexes */ pthread_mutex_init( &mutex, NULL ); /* Initialise mutex and condition for action triggerring */ pthread_mutex_init( &condition_mutex, NULL ); pthread_cond_init( &condition, NULL ); }

IEEE1394Reader::~IEEE1394Reader (   )  [virtual]

Destroys the IEEE1394Reader object. In particular, it deletes all frames in the inFrames and outFrames queues, as well as the one currently in use. Note that one or more frames may have been taken out of the queues by a user of the IEEE1394Reader class. Definition at line 129 of file ieee1394io.cc. References condition, condition_mutex, currentFrame, GetFramePool(), inFrames, and outFrames. { Frame * frame; for ( int i = inFrames.size(); i > 0; --i ) { frame = inFrames[ 0 ]; inFrames.pop_front(); GetFramePool( ) ->DoneWithFrame( frame ); } for ( int i = outFrames.size(); i > 0; --i ) { frame = outFrames[ 0 ]; outFrames.pop_front(); GetFramePool( ) ->DoneWithFrame( frame ); } if ( currentFrame != NULL ) { GetFramePool( ) ->DoneWithFrame( currentFrame ); currentFrame = NULL; } pthread_mutex_destroy( &condition_mutex ); pthread_cond_destroy( &condition ); }

---

Member Function Documentation

virtual void IEEE1394Reader::Close (  void   )  [pure virtual]

void IEEE1394Reader::DoneWithFrame (  Frame *   )

Put back a frame to the queue of available frames. Definition at line 191 of file ieee1394io.cc. References inFrames, and mutex. Referenced by captureThread(). { pthread_mutex_lock( &mutex ); inFrames.push_back( frame ); pthread_mutex_unlock( &mutex ); }

void IEEE1394Reader::Flush (  void   )  [protected]

Throw away all currently available frames. All frames in the outFrames queue are put back to the inFrames queue. Also the currentFrame is put back too. Definition at line 218 of file ieee1394io.cc. References currentFrame, inFrames, mutex, and outFrames. { Frame * frame = NULL; pthread_mutex_lock( &mutex ); for ( int i = outFrames.size(); i > 0; --i ) { frame = outFrames[ 0 ]; outFrames.pop_front(); inFrames.push_back( frame ); } if ( currentFrame != NULL ) { inFrames.push_back( currentFrame ); currentFrame = NULL; } pthread_mutex_unlock( &mutex ); }

int IEEE1394Reader::GetDroppedFrames (  void   )

Return the number of dropped frames since last call. Definition at line 202 of file ieee1394io.cc. References droppedFrames, and mutex. Referenced by PageCapture::showFrameInfo(). { pthread_mutex_lock( &mutex ); int n = droppedFrames; droppedFrames = 0; pthread_mutex_unlock( &mutex ); return n; }

Frame * IEEE1394Reader::GetFrame (  void   )

Fetches the next frame from the output queue. The outFrames contains a list of frames to be processed (saved, displayed) by the user of this class. Copy the first frame (actually only a pointer to it) and remove it from the queue. Note: If this returns NULL, wait some time (1/25 sec.) before calling it again. Returns: a pointer to the current frame, or NULL if no frames are in the queue Definition at line 169 of file ieee1394io.cc. References mutex, and outFrames. Referenced by captureThread(). { Frame * frame = NULL; pthread_mutex_lock( &mutex ); if ( outFrames.size() > 0 ) { frame = outFrames[ 0 ]; outFrames.pop_front(); } pthread_mutex_unlock( &mutex ); if ( frame != NULL ) frame->ExtractHeader(); return frame; }

int IEEE1394Reader::GetInQueueSize (  void   )  [inline]

Definition at line 71 of file ieee1394io.h. References inFrames. Referenced by captureThread(). { return inFrames.size(); }

int IEEE1394Reader::GetOutQueueSize (  void   )  [inline]

Definition at line 67 of file ieee1394io.h. References outFrames. Referenced by captureThread(). { return outFrames.size(); }

virtual bool IEEE1394Reader::Open (  int  port = 0  )  [pure virtual]

void IEEE1394Reader::ResetDroppedFrames (  void   )  [inline]

Definition at line 75 of file ieee1394io.h. References droppedFrames. Referenced by PageCapture::startCapture(). { droppedFrames = 0; }

virtual bool IEEE1394Reader::StartReceive (  void   )  [pure virtual]

virtual bool IEEE1394Reader::StartThread (  int  port = 0  )  [pure virtual]

Referenced by PageCapture::CheckDevices().

virtual void IEEE1394Reader::StopReceive (  void   )  [pure virtual]

virtual void IEEE1394Reader::StopThread (  void   )  [pure virtual]

Referenced by PageCapture::CheckDevices(), and PageCapture::clean().

void IEEE1394Reader::TriggerAction (   )

Definition at line 279 of file ieee1394io.cc. References condition, and condition_mutex. Referenced by PageCapture::clean(). { pthread_mutex_lock( &condition_mutex ); pthread_cond_signal( &condition ); pthread_mutex_unlock( &condition_mutex ); }

bool IEEE1394Reader::WaitForAction (  int  seconds = 0  )

Definition at line 237 of file ieee1394io.cc. References condition, condition_mutex, mutex, and outFrames. Referenced by captureThread(). { pthread_mutex_lock( &mutex ); int size = outFrames.size( ); pthread_mutex_unlock( &mutex ); if ( size == 0 ) { pthread_mutex_lock( &condition_mutex ); if ( seconds == 0 ) { pthread_cond_wait( &condition, &condition_mutex ); pthread_mutex_unlock( &condition_mutex ); pthread_mutex_lock( &mutex ); size = outFrames.size( ); } else { struct timeval tp; struct timespec ts; int result; gettimeofday( &tp, NULL ); ts.tv_sec = tp.tv_sec + seconds; ts.tv_nsec = tp.tv_usec * 1000; result = pthread_cond_timedwait( &condition, &condition_mutex, &ts ); pthread_mutex_unlock( &condition_mutex ); pthread_mutex_lock( &mutex ); if ( result == ETIMEDOUT ) size = 0; else size = outFrames.size(); } pthread_mutex_unlock( &mutex ); } return size != 0; }

---

Member Data Documentation

int IEEE1394Reader::channel [protected]

the iso channel we listen to (typically == 63) Definition at line 92 of file ieee1394io.h.

pthread_cond_t IEEE1394Reader::condition [protected]

Definition at line 104 of file ieee1394io.h. Referenced by IEEE1394Reader(), TriggerAction(), WaitForAction(), and ~IEEE1394Reader().

pthread_mutex_t IEEE1394Reader::condition_mutex [protected]

Definition at line 103 of file ieee1394io.h. Referenced by IEEE1394Reader(), TriggerAction(), WaitForAction(), and ~IEEE1394Reader().

Frame* IEEE1394Reader::currentFrame [protected]

a pointer to the frame which is currently been transmitted Definition at line 48 of file ieee1394io.h. Referenced by Flush(), and ~IEEE1394Reader().

int IEEE1394Reader::droppedFrames [protected]

the number of frames that had to be thrown away because our inFrames queue did not contain available frames Definition at line 45 of file ieee1394io.h. Referenced by GetDroppedFrames(), and ResetDroppedFrames().

deque< Frame* > IEEE1394Reader::inFrames [protected]

a list of empty frames Definition at line 51 of file ieee1394io.h. Referenced by DoneWithFrame(), Flush(), GetInQueueSize(), IEEE1394Reader(), and ~IEEE1394Reader().

bool IEEE1394Reader::isRunning [protected]

A state variable for starting and stopping thread. Definition at line 107 of file ieee1394io.h.

pthread_mutex_t IEEE1394Reader::mutex [protected]

this mutex protects capture related variables that could possibly accessed from two threads at the same time Definition at line 99 of file ieee1394io.h. Referenced by DoneWithFrame(), Flush(), GetDroppedFrames(), GetFrame(), IEEE1394Reader(), and WaitForAction().

deque< Frame* > IEEE1394Reader::outFrames [protected]

a list of already received frames Definition at line 54 of file ieee1394io.h. Referenced by Flush(), GetFrame(), GetOutQueueSize(), WaitForAction(), and ~IEEE1394Reader().

pthread_t IEEE1394Reader::thread [protected]

contains information about our thread after calling StartThread Definition at line 95 of file ieee1394io.h.

---

The documentation for this class was generated from the following files:

• ieee1394io.h
• ieee1394io.cc

---