timeline/src/Engine/Disk_Stream.H

   1
   2 /*******************************************************************************/
   3 /* Copyright (C) 2008 Jonathan Moore Liles                                     */
   4 /*                                                                             */
   5 /* This program is free software; you can redistribute it and/or modify it     */
   6 /* under the terms of the GNU General Public License as published by the       */
   7 /* Free Software Foundation; either version 2 of the License, or (at your      */
   8 /* option) any later version.                                                  */
   9 /*                                                                             */
  10 /* This program is distributed in the hope that it will be useful, but WITHOUT */
  11 /* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or       */
  12 /* FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for   */
  13 /* more details.                                                               */
  14 /*                                                                             */
  15 /* You should have received a copy of the GNU General Public License along     */
  16 /* with This program; see the file COPYING.  If not,write to the Free Software */
  17 /* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  */
  18 /*******************************************************************************/
  19
  20 #pragma once
  21
  22
  23 #include <jack/ringbuffer.h>
  24 #include <semaphore.h>
  25 #include <errno.h>
  26
  27 #include <vector>
  28
  29 #include "types.h"
  30 #include "Mutex.H"
  31 #include "const.h"
  32 #include "debug.h"
  33 #include "Thread.H"
  34
  35 class Track;
  36 class Audio_Sequence;
  37
  38 class Disk_Stream : public Mutex
  39 {
  40
  41     /* not permitted */
  42     Disk_Stream ( const Disk_Stream &rhs );
  43     Disk_Stream & operator = ( const Disk_Stream &rhs );
  44
  45
  46 protected:
  47
  48     Thread _thread;                                    /* io thread */
  49
  50     Track *_track;                               /* Track we belong to */
  51
  52     nframes_t _nframes;                              /* buffer size */
  53
  54
  55     std::vector < jack_ringbuffer_t * >_rb; /* one ringbuffer for each channel */
  56
  57     sem_t _blocks;          /* semaphore to wake the IO thread with */
  58
  59     int _total_blocks; /* total number of blocks that we can  buffer */
  60     int _disk_io_blocks; /* the number of blocks to read/write to/from disk at once */
  61
  62
  63     nframes_t _frame_rate;      /* used for buffer size calculations */
  64
  65     volatile nframes_t _frame;             /* location of disk read */
  66     volatile nframes_t _pending_seek; /* absolute transport position to seek to */
  67     volatile int _terminate;
  68
  69     volatile int _xruns;
  70
  71     int channels ( void ) const { return _rb.size(); }
  72
  73     Audio_Sequence * sequence ( void ) const;
  74     Track * track ( void ) const;
  75
  76     static void *disk_thread ( void *arg );
  77
  78     void _resize_buffers ( nframes_t nframes, int channels );
  79
  80 protected:
  81
  82     void block_processed ( void ) { sem_post( &_blocks ); }
  83     bool wait_for_block ( void )
  84         {
  85             while ( ! sem_wait( &_blocks ) && errno == EINTR )
  86             {}
  87
  88             return ! _terminate;
  89         }
  90
  91     virtual void disk_thread ( void ) = 0;
  92
  93     void base_flush ( bool is_output );
  94     virtual void flush ( void ) = 0;
  95
  96     void run ( void );
  97     void detach ( void );
  98
  99 public:
 100
 101     void shutdown ( void );
 102
 103     /* must be set before any Disk_Streams are created */
 104     static float seconds_to_buffer;
 105     static size_t disk_io_kbytes;
 106
 107     int xruns ( void ) { return _xruns; }
 108
 109     Disk_Stream ( Track *th, float frame_rate, nframes_t nframes, int channels );
 110
 111     virtual ~Disk_Stream ( );
 112
 113     void resize_buffers ( nframes_t nframes );
 114
 115 /*     void seek ( nframes_t frame ); */
 116 /*     bool seek_pending ( void ); */
 117
 118     virtual nframes_t process ( nframes_t nframes ) = 0;
 119
 120     int buffer_percent ( void );
 121
 122 };