common.c 16 KB
Newer Older
1
/*****************************************************************************
2
 * common.c : audio output management of common data structures
3
 *****************************************************************************
4
 * Copyright (C) 2002 VideoLAN
5
 * $Id: common.c,v 1.9 2002/11/14 22:38:48 massiot Exp $
6
 *
7
 * Authors: Christophe Massiot <massiot@via.ecp.fr>
8
9
10
11
12
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
13
 * 
14
15
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16
17
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
18
 *
19
20
21
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
22
 *****************************************************************************/
Michel Kaempf's avatar
Michel Kaempf committed
23

24
/*****************************************************************************
Michel Kaempf's avatar
Michel Kaempf committed
25
 * Preamble
26
 *****************************************************************************/
Sam Hocevar's avatar
   
Sam Hocevar committed
27
28
29
#include <stdlib.h>                            /* calloc(), malloc(), free() */
#include <string.h>

30
#include <vlc/vlc.h>
31

Michel Kaempf's avatar
Michel Kaempf committed
32
#include "audio_output.h"
33
#include "aout_internal.h"
Sam Hocevar's avatar
   
Sam Hocevar committed
34

35

36
/*
37
 * Instances management (internal and external)
38
39
 */

40
/*****************************************************************************
41
 * aout_New: initialize aout structure
42
 *****************************************************************************/
43
aout_instance_t * __aout_New( vlc_object_t * p_parent )
Michel Kaempf's avatar
Michel Kaempf committed
44
{
45
    aout_instance_t * p_aout;
46

47
    /* Allocate descriptor. */
48
    p_aout = vlc_object_create( p_parent, VLC_OBJECT_AOUT );
Vincent Seguin's avatar
Vincent Seguin committed
49
    if( p_aout == NULL )
Michel Kaempf's avatar
Michel Kaempf committed
50
    {
51
        return NULL;
Michel Kaempf's avatar
Michel Kaempf committed
52
53
    }

54
    /* Initialize members. */
55
    vlc_mutex_init( p_parent, &p_aout->input_fifos_lock );
56
    vlc_mutex_init( p_parent, &p_aout->mixer_lock );
57
58
    vlc_mutex_init( p_parent, &p_aout->output_fifo_lock );
    p_aout->i_nb_inputs = 0;
59
    p_aout->mixer.f_multiplier = 1.0;
60
    p_aout->mixer.b_error = 1;
61
    p_aout->output.b_starving = 1;
Vincent Seguin's avatar
Vincent Seguin committed
62

63
64
    vlc_object_attach( p_aout, p_parent->p_vlc );

65
66
67
68
69
70
71
    var_Create( p_aout, "physical-channels", VLC_VAR_INTEGER );
    var_AddCallback( p_aout, "physical-channels", aout_ChannelsRestart,
                     NULL );
    var_Create( p_aout, "original-channels", VLC_VAR_INTEGER );
    var_AddCallback( p_aout, "original-channels", aout_ChannelsRestart,
                     NULL );

72
    return p_aout;
Michel Kaempf's avatar
Michel Kaempf committed
73
74
}

75
/*****************************************************************************
76
 * aout_Delete: destroy aout structure
77
 *****************************************************************************/
78
void aout_Delete( aout_instance_t * p_aout )
79
{
80
81
    var_Destroy( p_aout, "channels" );

82
    vlc_mutex_destroy( &p_aout->input_fifos_lock );
83
    vlc_mutex_destroy( &p_aout->mixer_lock );
84
    vlc_mutex_destroy( &p_aout->output_fifo_lock );
85
86
87
88
89

    /* Free structure. */
    vlc_object_destroy( p_aout );
}

90
91

/*
92
 * Formats management (internal and external)
93
94
 */

95
96
97
/*****************************************************************************
 * aout_FormatNbChannels : return the number of channels
 *****************************************************************************/
98
int aout_FormatNbChannels( const audio_sample_format_t * p_format )
99
{
100
101
102
103
104
    static const u32 pi_channels[] =
        { AOUT_CHAN_CENTER, AOUT_CHAN_LEFT, AOUT_CHAN_RIGHT,
          AOUT_CHAN_REARCENTER, AOUT_CHAN_REARLEFT, AOUT_CHAN_REARRIGHT,
          AOUT_CHAN_LFE };
    int i_nb = 0, i;
105

106
    for ( i = 0; i < sizeof(pi_channels)/sizeof(u32); i++ )
107
    {
108
        if ( p_format->i_physical_channels & pi_channels[i] ) i_nb++;
109
110
    }

111
    return i_nb;
112
113
}

114
/*****************************************************************************
115
 * aout_FormatPrepare : compute the number of bytes per frame & frame length
116
 *****************************************************************************/
117
void aout_FormatPrepare( audio_sample_format_t * p_format )
Michel Kaempf's avatar
Michel Kaempf committed
118
{
119
    int i_result;
120

121
    switch ( p_format->i_format )
Henri Fallon's avatar
   
Henri Fallon committed
122
    {
123
124
    case VLC_FOURCC('u','8',' ',' '):
    case VLC_FOURCC('s','8',' ',' '):
125
126
127
        i_result = 1;
        break;

128
129
130
131
    case VLC_FOURCC('u','1','6','l'):
    case VLC_FOURCC('s','1','6','l'):
    case VLC_FOURCC('u','1','6','b'):
    case VLC_FOURCC('s','1','6','b'):
132
133
134
        i_result = 2;
        break;

135
136
    case VLC_FOURCC('f','l','3','2'):
    case VLC_FOURCC('f','i','3','2'):
137
138
139
        i_result = 4;
        break;

140
141
142
143
    case VLC_FOURCC('s','p','d','i'):
    case VLC_FOURCC('a','5','2',' '):
    case VLC_FOURCC('d','t','s',' '):
    default:
144
145
146
        /* For these formats the caller has to indicate the parameters
         * by hand. */
        return;
Henri Fallon's avatar
   
Henri Fallon committed
147
    }
148

149
    p_format->i_bytes_per_frame = i_result * aout_FormatNbChannels( p_format );
150
    p_format->i_frame_length = 1;
Michel Kaempf's avatar
Michel Kaempf committed
151
152
}

153
/*****************************************************************************
154
 * aout_FormatPrintChannels : print a channel in a human-readable form
155
 *****************************************************************************/
156
const char * aout_FormatPrintChannels( const audio_sample_format_t * p_format )
157
{
158
    switch ( p_format->i_physical_channels & AOUT_CHAN_PHYSMASK )
159
    {
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
    case AOUT_CHAN_CENTER:
        if ( (p_format->i_original_channels & AOUT_CHAN_CENTER)
              || (p_format->i_original_channels
                   & (AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT)) )
            return "Mono";
        else if ( p_format->i_original_channels & AOUT_CHAN_LEFT )
            return "Left";
        return "Right";
    case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT:
        if ( p_format->i_original_channels & AOUT_CHAN_DOLBYSTEREO )
            return "Dolby";
        else if ( p_format->i_original_channels & AOUT_CHAN_DUALMONO )
            return "Dual-mono";
        else if ( !(p_format->i_original_channels & AOUT_CHAN_RIGHT) )
            return "Stereo/Left";
        else if ( !(p_format->i_original_channels & AOUT_CHAN_LEFT) )
            return "Stereo/Right";
        return "Stereo";
    case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER:
        return "3F";
    case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_REARCENTER:
        return "2F1R";
    case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER
          | AOUT_CHAN_REARCENTER:
        return "3F1R";
    case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT
          | AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT:
        return "2F2R";
    case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER
          | AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT:
        return "3F2R";

    case AOUT_CHAN_CENTER | AOUT_CHAN_LFE:
        if ( (p_format->i_original_channels & AOUT_CHAN_CENTER)
              || (p_format->i_original_channels
                   & (AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT)) )
            return "Mono/LFE";
        else if ( p_format->i_original_channels & AOUT_CHAN_LEFT )
            return "Left/LFE";
        return "Right/LFE";
    case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_LFE:
        if ( p_format->i_original_channels & AOUT_CHAN_DOLBYSTEREO )
            return "Dolby/LFE";
        else if ( p_format->i_original_channels & AOUT_CHAN_DUALMONO )
            return "Dual-mono/LFE";
        else if ( !(p_format->i_original_channels & AOUT_CHAN_RIGHT) )
            return "Stereo/Left/LFE";
        else if ( !(p_format->i_original_channels & AOUT_CHAN_LEFT) )
            return "Stereo/Right/LFE";
         return "Stereo/LFE";
    case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER | AOUT_CHAN_LFE:
        return "3F/LFE";
    case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_REARCENTER
          | AOUT_CHAN_LFE:
        return "2F1R/LFE";
    case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER
          | AOUT_CHAN_REARCENTER | AOUT_CHAN_LFE:
        return "3F1R/LFE";
    case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT
          | AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT | AOUT_CHAN_LFE:
        return "2F2R/LFE";
    case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER
          | AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT | AOUT_CHAN_LFE:
        return "3F2R/LFE";
224
225
226
227
228
229
230
231
232
    }

    return "ERROR";
}

/*****************************************************************************
 * aout_FormatPrint : print a format in a human-readable form
 *****************************************************************************/
void aout_FormatPrint( aout_instance_t * p_aout, const char * psz_text,
233
                       const audio_sample_format_t * p_format )
234
235
236
{
    msg_Dbg( p_aout, "%s format='%4.4s' rate=%d channels=%s", psz_text,
             (char *)&p_format->i_format, p_format->i_rate,
237
             aout_FormatPrintChannels( p_format ) );
238
239
240
241
242
243
}

/*****************************************************************************
 * aout_FormatsPrint : print two formats in a human-readable form
 *****************************************************************************/
void aout_FormatsPrint( aout_instance_t * p_aout, const char * psz_text,
244
245
                        const audio_sample_format_t * p_format1,
                        const audio_sample_format_t * p_format2 )
246
247
248
249
250
{
    msg_Dbg( p_aout, "%s format='%4.4s'->'%4.4s' rate=%d->%d channels=%s->%s",
             psz_text,
             (char *)&p_format1->i_format, (char *)&p_format2->i_format,
             p_format1->i_rate, p_format2->i_rate,
251
252
             aout_FormatPrintChannels( p_format1 ),
             aout_FormatPrintChannels( p_format2 ) );
253
254
}

255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341

/*
 * FIFO management (internal) - please understand that solving race conditions
 * is _your_ job, ie. in the audio output you should own the mixer lock
 * before calling any of these functions.
 */

/*****************************************************************************
 * aout_FifoInit : initialize the members of a FIFO
 *****************************************************************************/
void aout_FifoInit( aout_instance_t * p_aout, aout_fifo_t * p_fifo,
                    u32 i_rate )
{
    p_fifo->p_first = NULL;
    p_fifo->pp_last = &p_fifo->p_first;
    aout_DateInit( &p_fifo->end_date, i_rate );
}

/*****************************************************************************
 * aout_FifoPush : push a packet into the FIFO
 *****************************************************************************/
void aout_FifoPush( aout_instance_t * p_aout, aout_fifo_t * p_fifo,
                    aout_buffer_t * p_buffer )
{
    *p_fifo->pp_last = p_buffer;
    p_fifo->pp_last = &p_buffer->p_next;
    *p_fifo->pp_last = NULL;
    /* Enforce the continuity of the stream. */
    if ( aout_DateGet( &p_fifo->end_date ) )
    {
        p_buffer->start_date = aout_DateGet( &p_fifo->end_date );
        p_buffer->end_date = aout_DateIncrement( &p_fifo->end_date,
                                                 p_buffer->i_nb_samples ); 
    }
    else
    {
        aout_DateSet( &p_fifo->end_date, p_buffer->end_date );
    }
}

/*****************************************************************************
 * aout_FifoSet : set end_date and trash all buffers (because they aren't
 * properly dated)
 *****************************************************************************/
void aout_FifoSet( aout_instance_t * p_aout, aout_fifo_t * p_fifo,
                   mtime_t date )
{
    aout_buffer_t * p_buffer;

    aout_DateSet( &p_fifo->end_date, date );
    p_buffer = p_fifo->p_first;
    while ( p_buffer != NULL )
    {
        aout_buffer_t * p_next = p_buffer->p_next;
        aout_BufferFree( p_buffer );
        p_buffer = p_next;
    }
    p_fifo->p_first = NULL;
    p_fifo->pp_last = &p_fifo->p_first;
}

/*****************************************************************************
 * aout_FifoMoveDates : Move forwards or backwards all dates in the FIFO
 *****************************************************************************/
void aout_FifoMoveDates( aout_instance_t * p_aout, aout_fifo_t * p_fifo,
                         mtime_t difference )
{
    aout_buffer_t * p_buffer;

    aout_DateMove( &p_fifo->end_date, difference );
    p_buffer = p_fifo->p_first;
    while ( p_buffer != NULL )
    {
        p_buffer->start_date += difference;
        p_buffer->end_date += difference;
        p_buffer = p_buffer->p_next;
    }
}

/*****************************************************************************
 * aout_FifoNextStart : return the current end_date
 *****************************************************************************/
mtime_t aout_FifoNextStart( aout_instance_t * p_aout, aout_fifo_t * p_fifo )
{
    return aout_DateGet( &p_fifo->end_date );
}

gbazin's avatar
   
gbazin committed
342
343
344
345
346
347
/*****************************************************************************
 * aout_FifoFirstDate : return the playing date of the first buffer in the
 * FIFO
 *****************************************************************************/
mtime_t aout_FifoFirstDate( aout_instance_t * p_aout, aout_fifo_t * p_fifo )
{
348
    return p_fifo->p_first ?  p_fifo->p_first->start_date : 0;
gbazin's avatar
   
gbazin committed
349
350
}

351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
/*****************************************************************************
 * aout_FifoPop : get the next buffer out of the FIFO
 *****************************************************************************/
aout_buffer_t * aout_FifoPop( aout_instance_t * p_aout, aout_fifo_t * p_fifo )
{
    aout_buffer_t * p_buffer;
    p_buffer = p_fifo->p_first;
    if ( p_buffer == NULL ) return NULL;
    p_fifo->p_first = p_buffer->p_next;
    if ( p_fifo->p_first == NULL )
    {
        p_fifo->pp_last = &p_fifo->p_first;
    }

    return p_buffer;
}

/*****************************************************************************
 * aout_FifoDestroy : destroy a FIFO and its buffers
 *****************************************************************************/
void aout_FifoDestroy( aout_instance_t * p_aout, aout_fifo_t * p_fifo )
{
    aout_buffer_t * p_buffer;

    p_buffer = p_fifo->p_first;
    while ( p_buffer != NULL )
    {
        aout_buffer_t * p_next = p_buffer->p_next;
        aout_BufferFree( p_buffer );
        p_buffer = p_next;
    }
}


/*
 * Date management (internal and external)
 */

/*****************************************************************************
 * aout_DateInit : set the divider of an audio_date_t
 *****************************************************************************/
void aout_DateInit( audio_date_t * p_date, u32 i_divider )
{
    p_date->date = 0;
    p_date->i_divider = i_divider;
    p_date->i_remainder = 0;
}

/*****************************************************************************
 * aout_DateSet : set the date of an audio_date_t
 *****************************************************************************/
void aout_DateSet( audio_date_t * p_date, mtime_t new_date )
{
    p_date->date = new_date;
    p_date->i_remainder = 0;
}

/*****************************************************************************
 * aout_DateMove : move forwards or backwards the date of an audio_date_t
 *****************************************************************************/
void aout_DateMove( audio_date_t * p_date, mtime_t difference )
{
    p_date->date += difference;
}

/*****************************************************************************
 * aout_DateGet : get the date of an audio_date_t
 *****************************************************************************/
mtime_t aout_DateGet( const audio_date_t * p_date )
{
    return p_date->date;
}

/*****************************************************************************
 * aout_DateIncrement : increment the date and return the result, taking
 * into account rounding errors
 *****************************************************************************/
mtime_t aout_DateIncrement( audio_date_t * p_date, u32 i_nb_samples )
{
    mtime_t i_dividend = (mtime_t)i_nb_samples * 1000000;
    p_date->date += i_dividend / p_date->i_divider;
432
    p_date->i_remainder += (int)(i_dividend % p_date->i_divider);
433
434
435
436
437
438
439
440
441
    if ( p_date->i_remainder >= p_date->i_divider )
    {
        /* This is Bresenham algorithm. */
        p_date->date++;
        p_date->i_remainder -= p_date->i_divider;
    }
    return p_date->date;
}