git.sesse.net Git - vlc/blob - modules/audio_output/packet.c

   1 /*****************************************************************************
   2  * packet.c : helper for legacy audio output plugins
   3  *****************************************************************************
   4  * Copyright (C) 2002-2012 VLC authors and VideoLAN
   5  *
   6  * This program is free software; you can redistribute it and/or modify it
   7  * under the terms of the GNU Lesser General Public License as published by
   8  * the Free Software Foundation; either version 2.1 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14  * GNU Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public License
  17  * along with this program; if not, write to the Free Software Foundation,
  18  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  19  *****************************************************************************/
  20
  21 #ifdef HAVE_CONFIG_H
  22 # include <config.h>
  23 #endif
  24 #include <limits.h>
  25 #include <assert.h>
  26 #include <vlc_common.h>
  27 #include <vlc_aout.h>
  28
  29 /**
  30  * Initializes the members of a FIFO.
  31  */
  32 static void aout_FifoInit( aout_fifo_t *p_fifo, uint32_t i_rate )
  33 {
  34     assert( i_rate != 0);
  35     p_fifo->p_first = NULL;
  36     p_fifo->pp_last = &p_fifo->p_first;
  37     date_Init( &p_fifo->end_date, i_rate, 1 );
  38     date_Set( &p_fifo->end_date, VLC_TS_INVALID );
  39 }
  40
  41 /**
  42  * Pushes a packet into the FIFO.
  43  */
  44 static void aout_FifoPush( aout_fifo_t * p_fifo, block_t * p_buffer )
  45 {
  46     *p_fifo->pp_last = p_buffer;
  47     p_fifo->pp_last = &p_buffer->p_next;
  48     *p_fifo->pp_last = NULL;
  49     /* Enforce the continuity of the stream. */
  50     if( date_Get( &p_fifo->end_date ) != VLC_TS_INVALID )
  51     {
  52         p_buffer->i_pts = date_Get( &p_fifo->end_date );
  53         p_buffer->i_length = date_Increment( &p_fifo->end_date,
  54                                              p_buffer->i_nb_samples );
  55         p_buffer->i_length -= p_buffer->i_pts;
  56     }
  57     else
  58     {
  59         date_Set( &p_fifo->end_date, p_buffer->i_pts + p_buffer->i_length );
  60     }
  61 }
  62
  63 /**
  64  * Trashes all buffers.
  65  */
  66 static void aout_FifoReset( aout_fifo_t * p_fifo )
  67 {
  68     block_t * p_buffer;
  69
  70     date_Set( &p_fifo->end_date, VLC_TS_INVALID );
  71     p_buffer = p_fifo->p_first;
  72     while ( p_buffer != NULL )
  73     {
  74         block_t * p_next = p_buffer->p_next;
  75         block_Release( p_buffer );
  76         p_buffer = p_next;
  77     }
  78     p_fifo->p_first = NULL;
  79     p_fifo->pp_last = &p_fifo->p_first;
  80 }
  81
  82 /**
  83  * Move forwards or backwards all dates in the FIFO.
  84  */
  85 static void aout_FifoMoveDates( aout_fifo_t *fifo, mtime_t difference )
  86 {
  87     if( date_Get( &fifo->end_date ) == VLC_TS_INVALID )
  88     {
  89         assert( fifo->p_first == NULL );
  90         return;
  91     }
  92
  93     date_Move( &fifo->end_date, difference );
  94     for( block_t *block = fifo->p_first; block != NULL; block = block->p_next )
  95         block->i_pts += difference;
  96 }
  97
  98 /**
  99  * Gets the next buffer out of the FIFO
 100  */
 101 static block_t *aout_FifoPop( aout_fifo_t * p_fifo )
 102 {
 103     block_t *p_buffer = p_fifo->p_first;
 104     if( p_buffer != NULL )
 105     {
 106         p_fifo->p_first = p_buffer->p_next;
 107         if( p_fifo->p_first == NULL )
 108             p_fifo->pp_last = &p_fifo->p_first;
 109     }
 110     return p_buffer;
 111 }
 112
 113 /**
 114  * Destroys a FIFO and its buffers
 115  */
 116 static void aout_FifoDestroy( aout_fifo_t * p_fifo )
 117 {
 118     block_t * p_buffer;
 119
 120     p_buffer = p_fifo->p_first;
 121     while ( p_buffer != NULL )
 122     {
 123         block_t * p_next = p_buffer->p_next;
 124         block_Release( p_buffer );
 125         p_buffer = p_next;
 126     }
 127
 128     p_fifo->p_first = NULL;
 129     p_fifo->pp_last = &p_fifo->p_first;
 130 }
 131
 132 static inline aout_packet_t *aout_packet (audio_output_t *aout)
 133 {
 134     return (aout_packet_t *)(aout->sys);
 135 }
 136
 137 void aout_PacketInit (audio_output_t *aout, aout_packet_t *p, unsigned samples,
 138                       const audio_sample_format_t *fmt)
 139 {
 140     assert (p == aout_packet (aout));
 141
 142     vlc_mutex_init (&p->lock);
 143     p->format = *fmt;
 144     aout_FifoInit (&p->partial, p->format.i_rate);
 145     aout_FifoInit (&p->fifo, p->format.i_rate);
 146     p->pause_date = VLC_TS_INVALID;
 147     p->samples = samples;
 148     p->starving = true;
 149 }
 150
 151 void aout_PacketDestroy (audio_output_t *aout)
 152 {
 153     aout_packet_t *p = aout_packet (aout);
 154
 155     aout_FifoDestroy (&p->partial);
 156     aout_FifoDestroy (&p->fifo);
 157     vlc_mutex_destroy (&p->lock);
 158 }
 159
 160 int aout_PacketTimeGet (audio_output_t *aout, mtime_t *restrict delay)
 161 {
 162     aout_packet_t *p = aout_packet (aout);
 163     mtime_t time_report;
 164
 165     /* Problem: This measurement is imprecise and prone to jitter.
 166      * Solution: Do not use aout_Packet...(). */
 167     vlc_mutex_lock (&p->lock);
 168     time_report = date_Get (&p->fifo.end_date);
 169     vlc_mutex_unlock (&p->lock);
 170
 171     if (time_report == VLC_TS_INVALID)
 172         return -1;
 173     *delay = time_report - mdate ();
 174     return 0;
 175 }
 176
 177 static block_t *aout_OutputSlice (audio_output_t *);
 178
 179 void aout_PacketPlay (audio_output_t *aout, block_t *block)
 180 {
 181     aout_packet_t *p = aout_packet (aout);
 182
 183     vlc_mutex_lock (&p->lock);
 184     aout_FifoPush (&p->partial, block);
 185     while ((block = aout_OutputSlice (aout)) != NULL)
 186         aout_FifoPush (&p->fifo, block);
 187     vlc_mutex_unlock (&p->lock);
 188 }
 189
 190 void aout_PacketFlush (audio_output_t *aout, bool drain)
 191 {
 192     aout_packet_t *p = aout_packet (aout);
 193
 194     vlc_mutex_lock (&p->lock);
 195     if (drain)
 196     {
 197         mtime_t pts = date_Get (&p->fifo.end_date);
 198         vlc_mutex_unlock (&p->lock);
 199         if (pts != VLC_TS_INVALID)
 200             mwait (pts);
 201     }
 202     else
 203     {
 204         aout_FifoReset (&p->partial);
 205         aout_FifoReset (&p->fifo);
 206         vlc_mutex_unlock (&p->lock);
 207     }
 208 }
 209
 210
 211 /**
 212  * Rearranges audio blocks in correct number of samples.
 213  * @note (FIXME) This is left here for historical reasons. It belongs in the
 214  * output code. Besides, this operation should be avoided if possible.
 215  */
 216 static block_t *aout_OutputSlice (audio_output_t *p_aout)
 217 {
 218     aout_packet_t *p = aout_packet (p_aout);
 219     aout_fifo_t *p_fifo = &p->partial;
 220     const unsigned samples = p->samples;
 221     assert( samples > 0 );
 222
 223     /* Retrieve the date of the next buffer. */
 224     date_t exact_start_date = p->fifo.end_date;
 225     mtime_t start_date = date_Get( &exact_start_date );
 226
 227     /* Check if there is enough data to slice a new buffer. */
 228     block_t *p_buffer = p_fifo->p_first;
 229     if( p_buffer == NULL )
 230         return NULL;
 231
 232     /* Find the earliest start date available. */
 233     if ( start_date == VLC_TS_INVALID )
 234     {
 235         start_date = p_buffer->i_pts;
 236         date_Set( &exact_start_date, start_date );
 237     }
 238     /* Compute the end date for the new buffer. */
 239     mtime_t end_date = date_Increment( &exact_start_date, samples );
 240
 241     /* Check that we have enough samples (TODO merge with next loop). */
 242     for( unsigned available = 0; available < samples; )
 243     {
 244         p_buffer = p_buffer->p_next;
 245         if( p_buffer == NULL )
 246             return NULL;
 247
 248         available += p_buffer->i_nb_samples;
 249     }
 250
 251     if( AOUT_FMT_LINEAR( &p->format ) )
 252     {
 253         const unsigned framesize = p->format.i_bytes_per_frame;
 254         /* Build packet with adequate number of samples */
 255         unsigned needed = samples * framesize;
 256
 257         p_buffer = block_Alloc( needed );
 258         if( unlikely(p_buffer == NULL) )
 259             /* XXX: should free input buffers */
 260             return NULL;
 261         p_buffer->i_nb_samples = samples;
 262
 263         for( uint8_t *p_out = p_buffer->p_buffer; needed > 0; )
 264         {
 265             block_t *p_inbuf = p_fifo->p_first;
 266             if( unlikely(p_inbuf == NULL) )
 267             {
 268                 msg_Err( p_aout, "packetization error" );
 269                 memset( p_out, 0, needed );
 270                 break;
 271             }
 272
 273             const uint8_t *p_in = p_inbuf->p_buffer;
 274             size_t avail = p_inbuf->i_nb_samples * framesize;
 275             if( avail > needed )
 276             {
 277                 memcpy( p_out, p_in, needed );
 278                 p_fifo->p_first->p_buffer += needed;
 279                 p_fifo->p_first->i_buffer -= needed;
 280                 needed /= framesize;
 281                 p_fifo->p_first->i_nb_samples -= needed;
 282
 283                 mtime_t t = needed * CLOCK_FREQ / p->format.i_rate;
 284                 p_fifo->p_first->i_pts += t;
 285                 p_fifo->p_first->i_length -= t;
 286                 break;
 287             }
 288
 289             memcpy( p_out, p_in, avail );
 290             needed -= avail;
 291             p_out += avail;
 292             /* Next buffer */
 293             block_Release( aout_FifoPop( p_fifo ) );
 294         }
 295     }
 296     else
 297         p_buffer = aout_FifoPop( p_fifo );
 298
 299     p_buffer->i_pts = start_date;
 300     p_buffer->i_length = end_date - start_date;
 301
 302     return p_buffer;
 303 }
 304
 305 /**
 306  * Dequeues the next audio packet (a.k.a. audio fragment).
 307  * The audio output plugin must first call aout_PacketPlay() to queue the
 308  * decoded audio samples. Typically, audio_output_t.play is set to, or calls
 309  * aout_PacketPlay().
 310  * @note This function is considered legacy. Please do not use this function in
 311  * new audio output plugins.
 312  * @param p_aout audio output instance
 313  * @param start_date expected PTS of the audio packet
 314  */
 315 block_t *aout_PacketNext (audio_output_t *p_aout, mtime_t start_date)
 316 {
 317     aout_packet_t *p = aout_packet (p_aout);
 318     aout_fifo_t *p_fifo = &p->fifo;
 319     block_t *p_buffer;
 320     const bool b_can_sleek = !AOUT_FMT_LINEAR(&p->format);
 321     const mtime_t now = mdate ();
 322     const mtime_t threshold =
 323         (b_can_sleek ? start_date : now) - AOUT_MAX_PTS_DELAY;
 324
 325     vlc_mutex_lock( &p->lock );
 326     if( p->pause_date != VLC_TS_INVALID )
 327         goto out; /* paused: do not dequeue buffers */
 328
 329     for (;;)
 330     {
 331         p_buffer = p_fifo->p_first;
 332         if (p_buffer == NULL)
 333             goto out; /* nothing to play */
 334
 335         if (p_buffer->i_pts >= threshold)
 336             break;
 337
 338         /* Drop the audio sample if the audio output is really late.
 339          * In the case of b_can_sleek, we don't use a resampler so we need to
 340          * be a lot more severe. */
 341         msg_Dbg (p_aout, "audio output is too slow (%"PRId64" us): "
 342                  " trashing %"PRId64" us", threshold - p_buffer->i_pts,
 343                  p_buffer->i_length);
 344         block_Release (aout_FifoPop (p_fifo));
 345     }
 346
 347     mtime_t delta = start_date - p_buffer->i_pts;
 348     /* This assumes that all buffers have the same duration. This is true
 349      * since aout_PacketPlay() (aout_OutputSlice()) is used. */
 350     if (0 >= delta + p_buffer->i_length)
 351     {
 352         if (!p->starving)
 353         {
 354             msg_Dbg (p_aout, "audio output is starving (%"PRId64"), "
 355                      "playing silence", delta);
 356             p->starving = true;
 357         }
 358         goto out; /* nothing to play _yet_ */
 359     }
 360
 361     p->starving = false;
 362     p_buffer = aout_FifoPop( p_fifo );
 363
 364     if (!b_can_sleek
 365      && (delta < -AOUT_MAX_PTS_ADVANCE || AOUT_MAX_PTS_DELAY < delta))
 366     {
 367         msg_Warn (p_aout, "audio output out of sync, "
 368                           "adjusting dates (%"PRId64" us)", delta);
 369         aout_FifoMoveDates (&p->partial, delta);
 370         aout_FifoMoveDates (p_fifo, delta);
 371     }
 372     vlc_mutex_unlock( &p->lock );
 373     return p_buffer;
 374 out:
 375     vlc_mutex_unlock( &p->lock );
 376     return NULL;
 377 }