libdvdcss.c 25.5 KB
Newer Older
1
/* libdvdcss.c: DVD reading library.
Sam Hocevar's avatar
 
Sam Hocevar committed
2
 *
3
 * Authors: Stéphane Borel <stef@via.ecp.fr>
4
 *          Sam Hocevar <sam@zoy.org>
5
 *          Håkan Hjort <d95hjort@dtek.chalmers.se>
Sam Hocevar's avatar
 
Sam Hocevar committed
6
 *
7
 * Copyright (C) 1998-2008 VideoLAN
Sam Hocevar's avatar
Sam Hocevar committed
8
 * $Id$
9
 *
10
 * This library is free software; you can redistribute it and/or modify
Sam Hocevar's avatar
 
Sam Hocevar committed
11
12
13
 * 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.
14
 *
15
 * This library is distributed in the hope that it will be useful,
Sam Hocevar's avatar
 
Sam Hocevar committed
16
17
18
19
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
Diego Biurrun's avatar
Diego Biurrun committed
20
 * You should have received a copy of the GNU General Public License along
21
 * with this library; if not, write to the Free Software Foundation, Inc.,
Diego Biurrun's avatar
Diego Biurrun committed
22
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
23
24
 */

25
/**
26
27
28
29
30
31
32
33
34
35
 * \mainpage libdvdcss developer documentation
 *
 * \section intro Introduction
 *
 * \e libdvdcss is a simple library designed for accessing DVDs like a block
 * device without having to bother about the decryption. The important features
 * are:
 * \li portability: currently supported platforms are GNU/Linux, FreeBSD,
 *     NetBSD, OpenBSD, BSD/OS, BeOS, Windows 95/98, Windows NT/2000, MacOS X,
 *     Solaris, HP-UX and OS/2.
36
37
38
 * \li adaptability: unlike most similar projects, libdvdcss doesn't require
 *     the region of your drive to be set and will try its best to read from
 *     the disc even in the case of a region mismatch.
39
40
41
 * \li simplicity: a DVD player can be built around the \e libdvdcss API using
 *     no more than 4 or 5 library calls.
 *
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 * \e libdvdcss is free software, released under the General Public License.
 * This ensures that \e libdvdcss remains free and used only with free
 * software.
 *
 * \section api The libdvdcss API
 *
 * The complete \e libdvdcss programming interface is documented in the
 * dvdcss.h file.
 *
 * \section env Environment variables
 *
 * Some environment variables can be used to change the behaviour of
 * \e libdvdcss without having to modify the program which uses it. These
 * variables are:
 *
 * \li \b DVDCSS_VERBOSE: sets the verbosity level.
 *     - \c 0 outputs no messages at all.
 *     - \c 1 outputs error messages to stderr.
 *     - \c 2 outputs error messages and debug messages to stderr.
 *
 * \li \b DVDCSS_METHOD: sets the authentication and decryption method
 *     that \e libdvdcss will use to read scrambled discs. Can be one
 *     of \c title, \c key or \c disc.
 *     - \c key is the default method. \e libdvdcss will use a set of
 *       calculated player keys to try and get the disc key. This can fail
 *       if the drive does not recognize any of the player keys.
 *     - \c disc is a fallback method when \c key has failed. Instead of
 *       using player keys, \e libdvdcss will crack the disc key using
 *       a brute force algorithm. This process is CPU intensive and requires
 *       64 MB of memory to store temporary data.
 *     - \c title is the fallback when all other methods have failed. It does
 *       not rely on a key exchange with the DVD drive, but rather uses a
 *       crypto attack to guess the title key. On rare cases this may fail
 *       because there is not enough encrypted data on the disc to perform
 *       a statistical attack, but in the other hand it is the only way to
 *       decrypt a DVD stored on a hard disc, or a DVD with the wrong region
 *       on an RPC2 drive.
 *
80
81
82
83
84
 * \li \b DVDCSS_RAW_DEVICE: specify the raw device to use. Exact usage will
 *     depend on your operating system, the Linux utility to set up raw devices
 *     is \c raw(8) for instance. Please note that on most operating systems,
 *     using a raw device requires highly aligned buffers: Linux requires a
 *     2048 bytes alignment (which is the size of a DVD sector).
85
 *
86
87
88
89
 * \li \b DVDCSS_CACHE: specify a directory in which to store title key
 *     values. This will speed up descrambling of DVDs which are in the
 *     cache. The DVDCSS_CACHE directory is created if it does not exist,
 *     and a subdirectory is created named after the DVD's title or
90
91
92
93
 *     manufacturing date. If DVDCSS_CACHE is not set or is empty, \e libdvdcss
 *     will use the default value which is "${HOME}/.dvdcss/" under Unix and
 *     "C:\Documents and Settings\$USER\Application Data\dvdcss\" under Win32.
 *     The special value "off" disables caching.
94
 */
Sam Hocevar's avatar
 
Sam Hocevar committed
95

96
/*
Sam Hocevar's avatar
 
Sam Hocevar committed
97
 * Preamble
98
 */
Sam Hocevar's avatar
 
Sam Hocevar committed
99
100
101
102
103
104
105
#include "config.h"

#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <sys/types.h>
#include <sys/stat.h>
106
107
108
#ifdef HAVE_SYS_PARAM_H
#   include <sys/param.h>
#endif
109
110
111
#ifdef HAVE_PWD_H
#   include <pwd.h>
#endif
Sam Hocevar's avatar
 
Sam Hocevar committed
112
#include <fcntl.h>
113
#include <errno.h>
Sam Hocevar's avatar
 
Sam Hocevar committed
114
115
116
117
118

#ifdef HAVE_UNISTD_H
#   include <unistd.h>
#endif

Christophe Massiot's avatar
Christophe Massiot committed
119
#ifdef HAVE_LIMITS_H
120
121
122
#   include <limits.h>
#endif

123
#ifdef HAVE_DIRECT_H
124
125
126
#   include <direct.h>
#endif

Sam Hocevar's avatar
   
Sam Hocevar committed
127
#include "dvdcss/dvdcss.h"
Sam Hocevar's avatar
 
Sam Hocevar committed
128
129
130
131
132

#include "common.h"
#include "css.h"
#include "libdvdcss.h"
#include "ioctl.h"
133
#include "device.h"
Sam Hocevar's avatar
 
Sam Hocevar committed
134

135
136
137
138
139
140
141
142
143
144
/**
 * \brief Symbol for version checks.
 *
 * The name of this symbol contains the library major number, which makes it
 * easy to check which \e libdvdcss development headers are installed on the
 * system with tools such as autoconf.
 *
 * The variable itself contains the exact version number of the library,
 * which can be useful for specific feature needs.
 */
145
char * dvdcss_interface_2 = VERSION;
Sam Hocevar's avatar
   
Sam Hocevar committed
146

147
148
149
150
151
152
153
154
155
156
157
158
/**
 * \brief Open a DVD device or directory and return a dvdcss instance.
 *
 * \param psz_target a string containing the target name, for instance
 *        "/dev/hdc" or "E:".
 * \return a handle to a dvdcss instance or NULL on error.
 *
 * Initialize the \e libdvdcss library and open the requested DVD device or
 * directory. \e libdvdcss checks whether ioctls can be performed on the disc,
 * and when possible, the disc key is retrieved.
 *
 * dvdcss_open() returns a handle to be used for all subsequent \e libdvdcss
159
 * calls. If an error occurred, NULL is returned.
160
 */
161
LIBDVDCSS_EXPORT dvdcss_t dvdcss_open ( char *psz_target )
Sam Hocevar's avatar
 
Sam Hocevar committed
162
{
163
    char psz_buffer[PATH_MAX];
Sam Hocevar's avatar
 
Sam Hocevar committed
164
165
166
167
    int i_ret;

    char *psz_method = getenv( "DVDCSS_METHOD" );
    char *psz_verbose = getenv( "DVDCSS_VERBOSE" );
168
    char *psz_cache = getenv( "DVDCSS_CACHE" );
KO Myung-Hun's avatar
KO Myung-Hun committed
169
#if !defined(WIN32) && !defined(SYS_OS2)
Sam Hocevar's avatar
 
Sam Hocevar committed
170
171
172
    char *psz_raw_device = getenv( "DVDCSS_RAW_DEVICE" );
#endif

173
    dvdcss_t dvdcss;
Sam Hocevar's avatar
 
Sam Hocevar committed
174

175
176
177
    /*
     *  Allocate the library structure
     */
Sam Hocevar's avatar
 
Sam Hocevar committed
178
179
180
181
182
183
    dvdcss = malloc( sizeof( struct dvdcss_s ) );
    if( dvdcss == NULL )
    {
        return NULL;
    }

184
185
186
    /*
     *  Initialize structure with default values
     */
KO Myung-Hun's avatar
KO Myung-Hun committed
187
#if !defined(WIN32) && !defined(SYS_OS2)
188
    dvdcss->i_raw_fd = -1;
189
#endif
Sam Hocevar's avatar
 
Sam Hocevar committed
190
    dvdcss->p_titles = NULL;
191
    dvdcss->psz_device = (char *)strdup( psz_target );
Sam Hocevar's avatar
 
Sam Hocevar committed
192
    dvdcss->psz_error = "no error";
193
    dvdcss->i_method = DVDCSS_METHOD_KEY;
194
    dvdcss->psz_cachefile[0] = '\0';
Sam Hocevar's avatar
 
Sam Hocevar committed
195
    dvdcss->b_debug = 0;
196
    dvdcss->b_errors = 0;
Sam Hocevar's avatar
 
Sam Hocevar committed
197

198
199
200
201
202
    /*
     *  Find verbosity from DVDCSS_VERBOSE environment variable
     */
    if( psz_verbose != NULL )
    {
203
204
        int i = atoi( psz_verbose );

205
        if( i >= 2 ) dvdcss->b_debug = i;
206
        if( i >= 1 ) dvdcss->b_errors = 1;
207
208
209
210
211
    }

    /*
     *  Find method from DVDCSS_METHOD environment variable
     */
Sam Hocevar's avatar
 
Sam Hocevar committed
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
    if( psz_method != NULL )
    {
        if( !strncmp( psz_method, "key", 4 ) )
        {
            dvdcss->i_method = DVDCSS_METHOD_KEY;
        }
        else if( !strncmp( psz_method, "disc", 5 ) )
        {
            dvdcss->i_method = DVDCSS_METHOD_DISC;
        }
        else if( !strncmp( psz_method, "title", 5 ) )
        {
            dvdcss->i_method = DVDCSS_METHOD_TITLE;
        }
        else
        {
228
229
            print_error( dvdcss, "unknown decrypt method, please choose "
                                 "from 'title', 'key' or 'disc'" );
230
            free( dvdcss->psz_device );
Sam Hocevar's avatar
 
Sam Hocevar committed
231
232
233
234
235
            free( dvdcss );
            return NULL;
        }
    }

236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
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
    /*
     *  If DVDCSS_CACHE was not set, try to guess a default value
     */
    if( psz_cache == NULL || psz_cache[0] == '\0' )
    {
#ifdef HAVE_DIRECT_H
        typedef HRESULT( WINAPI *SHGETFOLDERPATH )
                       ( HWND, int, HANDLE, DWORD, LPTSTR );

#   define CSIDL_FLAG_CREATE 0x8000
#   define CSIDL_APPDATA 0x1A
#   define SHGFP_TYPE_CURRENT 0

        char psz_home[MAX_PATH];
        HINSTANCE p_dll;
        SHGETFOLDERPATH p_getpath;

        *psz_home = '\0';

        /* Load the shfolder dll to retrieve SHGetFolderPath */
        p_dll = LoadLibrary( "shfolder.dll" );
        if( p_dll )
        {
            p_getpath = (void*)GetProcAddress( p_dll, "SHGetFolderPathA" );
            if( p_getpath )
            {
                /* Get the "Application Data" folder for the current user */
                if( p_getpath( NULL, CSIDL_APPDATA | CSIDL_FLAG_CREATE,
                               NULL, SHGFP_TYPE_CURRENT, psz_home ) == S_OK )
                {
                    FreeLibrary( p_dll );
                }
                else
                {
                    *psz_home = '\0';
                }
            }
            FreeLibrary( p_dll );
        }

        /* Cache our keys in
         * C:\Documents and Settings\$USER\Application Data\dvdcss\ */
        if( *psz_home )
        {
            snprintf( psz_buffer, PATH_MAX, "%s/dvdcss", psz_home );
            psz_buffer[PATH_MAX-1] = '\0';
            psz_cache = psz_buffer;
        }
#else
        char *psz_home = NULL;
#   ifdef HAVE_PWD_H
        struct passwd *p_pwd;

        /* Try looking in password file for home dir. */
        p_pwd = getpwuid(getuid());
        if( p_pwd )
        {
            psz_home = p_pwd->pw_dir;
        }
#   endif

        if( psz_home == NULL )
        {
            psz_home = getenv( "HOME" );
        }
301
302
303
304
        if( psz_home == NULL )
        {
            psz_home = getenv( "USERPROFILE" );
        }
305
306
307
308

        /* Cache our keys in ${HOME}/.dvdcss/ */
        if( psz_home )
        {
KO Myung-Hun's avatar
KO Myung-Hun committed
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
            int home_pos = 0;

#ifdef SYS_OS2
            if( *psz_home == '/' || *psz_home == '\\')
            {
                char *psz_unixroot = getenv("UNIXROOT");

                if( psz_unixroot &&
                    psz_unixroot[0] &&
                    psz_unixroot[1] == ':'  &&
                    psz_unixroot[2] == '\0')
                {
                    strcpy( psz_buffer, psz_unixroot );
                    home_pos = 2;
                }
            }
#endif
            snprintf( psz_buffer + home_pos, PATH_MAX - home_pos,
                      "%s/.dvdcss", psz_home );
328
329
330
331
332
333
            psz_buffer[PATH_MAX-1] = '\0';
            psz_cache = psz_buffer;
        }
#endif
    }

334
335
336
337
338
    /*
     *  Find cache dir from the DVDCSS_CACHE environment variable
     */
    if( psz_cache != NULL )
    {
339
        if( psz_cache[0] == '\0' || !strcmp( psz_cache, "off" ) )
340
341
342
343
        {
            psz_cache = NULL;
        }
        /* Check that we can add the ID directory and the block filename */
Sam Hocevar's avatar
Sam Hocevar committed
344
345
        else if( strlen( psz_cache ) + 1 + 32 + 1 + (KEY_SIZE * 2) + 10 + 1
                  > PATH_MAX )
346
        {
347
            print_error( dvdcss, "cache directory name is too long" );
348
349
350
351
            psz_cache = NULL;
        }
    }

352
353
354
    /*
     *  Open device
     */
355
    _dvdcss_check( dvdcss );
356
    i_ret = _dvdcss_open( dvdcss );
Sam Hocevar's avatar
 
Sam Hocevar committed
357
358
    if( i_ret < 0 )
    {
359
        free( dvdcss->psz_device );
Sam Hocevar's avatar
 
Sam Hocevar committed
360
361
362
        free( dvdcss );
        return NULL;
    }
363

364
    dvdcss->b_scrambled = 1; /* Assume the worst */
365
    dvdcss->b_ioctls = _dvdcss_use_ioctls( dvdcss );
Sam Hocevar's avatar
 
Sam Hocevar committed
366

367
    if( dvdcss->b_ioctls )
Sam Hocevar's avatar
 
Sam Hocevar committed
368
    {
369
        i_ret = _dvdcss_test( dvdcss );
370

371
        if( i_ret == -3 )
372
        {
373
374
375
            print_debug( dvdcss, "scrambled disc on a region-free RPC-II "
                                 "drive: possible failure, but continuing "
                                 "anyway" );
376
377
        }
        else if( i_ret < 0 )
Sam Hocevar's avatar
Sam Hocevar committed
378
379
        {
            /* Disable the CSS ioctls and hope that it works? */
380
381
            print_debug( dvdcss,
                         "could not check whether the disc was scrambled" );
Sam Hocevar's avatar
Sam Hocevar committed
382
383
384
385
            dvdcss->b_ioctls = 0;
        }
        else
        {
386
387
            print_debug( dvdcss, i_ret ? "disc is scrambled"
                                       : "disc is unscrambled" );
Sam Hocevar's avatar
Sam Hocevar committed
388
389
            dvdcss->b_scrambled = i_ret;
        }
Sam Hocevar's avatar
 
Sam Hocevar committed
390
391
    }

392
    memset( dvdcss->css.p_disc_key, 0, KEY_SIZE );
Sam Hocevar's avatar
 
Sam Hocevar committed
393
    /* If disc is CSS protected and the ioctls work, authenticate the drive */
394
    if( dvdcss->b_scrambled && dvdcss->b_ioctls )
Sam Hocevar's avatar
 
Sam Hocevar committed
395
    {
396
        i_ret = _dvdcss_disckey( dvdcss );
Sam Hocevar's avatar
 
Sam Hocevar committed
397
398
399

        if( i_ret < 0 )
        {
400
            print_debug( dvdcss, "could not get disc key" );
Sam Hocevar's avatar
 
Sam Hocevar committed
401
402
403
        }
    }

Sam Hocevar's avatar
Sam Hocevar committed
404
405
406
407
408
409
410
    /* If the cache is enabled, write the cache directory tag */
    if( psz_cache )
    {
        char *psz_tag = "Signature: 8a477f597d28d172789f06886806bc55\r\n"
            "# This file is a cache directory tag created by libdvdcss.\r\n"
            "# For information about cache directory tags, see:\r\n"
            "#   http://www.brynosaurus.com/cachedir/\r\n";
411
        char psz_tagfile[PATH_MAX + 1 + 12 + 1];
Sam Hocevar's avatar
Sam Hocevar committed
412
413
414
        int i_fd;

        sprintf( psz_tagfile, "%s/CACHEDIR.TAG", psz_cache );
Sam Hocevar's avatar
Sam Hocevar committed
415
        i_fd = open( psz_tagfile, O_RDWR|O_CREAT, 0644 );
Sam Hocevar's avatar
Sam Hocevar committed
416
417
418
419
420
421
422
        if( i_fd >= 0 )
        {
            write( i_fd, psz_tag, strlen(psz_tag) );
            close( i_fd );
        }
    }

423
424
425
    /* If the cache is enabled, extract a unique disc ID */
    if( psz_cache )
    {
426
        uint8_t p_sector[DVDCSS_BLOCK_SIZE];
427
        char psz_key[1 + KEY_SIZE * 2 + 1];
Ivan Kalvachev's avatar
   
Ivan Kalvachev committed
428
429
        char *psz_title;
        uint8_t *psz_serial;
430
431
        int i;

432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
        /* We read sector 0. If it starts with 0x000001ba (BE), we are
         * reading a VOB file, and we should not cache anything. */

        i_ret = dvdcss->pf_seek( dvdcss, 0 );
        if( i_ret != 0 )
        {
            goto nocache;
        }

        i_ret = dvdcss->pf_read( dvdcss, p_sector, 1 );
        if( i_ret != 1 )
        {
            goto nocache;
        }

        if( p_sector[0] == 0x00 && p_sector[1] == 0x00
             && p_sector[2] == 0x01 && p_sector[3] == 0xba )
        {
            goto nocache;
        }

453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
        /* The data we are looking for is at sector 16 (32768 bytes):
         *  - offset 40: disc title (32 uppercase chars)
         *  - offset 813: manufacturing date + serial no (16 digits) */

        i_ret = dvdcss->pf_seek( dvdcss, 16 );
        if( i_ret != 16 )
        {
            goto nocache;
        }

        i_ret = dvdcss->pf_read( dvdcss, p_sector, 1 );
        if( i_ret != 1 )
        {
            goto nocache;
        }

        /* Get the disc title */
470
        psz_title = (char *)p_sector + 40;
Michael Roitzsch's avatar
   
Michael Roitzsch committed
471
        psz_title[32] = '\0';
472
473
474

        for( i = 0 ; i < 32 ; i++ )
        {
Michael Roitzsch's avatar
   
Michael Roitzsch committed
475
            if( psz_title[i] <= ' ' )
476
            {
Michael Roitzsch's avatar
   
Michael Roitzsch committed
477
                psz_title[i] = '\0';
478
479
                break;
            }
Michael Roitzsch's avatar
   
Michael Roitzsch committed
480
            else if( psz_title[i] == '/' || psz_title[i] == '\\' )
481
            {
Michael Roitzsch's avatar
   
Michael Roitzsch committed
482
                psz_title[i] = '-';
483
484
485
            }
        }

Michael Roitzsch's avatar
   
Michael Roitzsch committed
486
        /* Get the date + serial */
Ivan Kalvachev's avatar
   
Ivan Kalvachev committed
487
        psz_serial = p_sector + 813;
Michael Roitzsch's avatar
   
Michael Roitzsch committed
488
        psz_serial[16] = '\0';
489

Michael Roitzsch's avatar
   
Michael Roitzsch committed
490
491
492
493
        /* Check that all characters are digits, otherwise convert. */
        for( i = 0 ; i < 16 ; i++ )
        {
            if( psz_serial[i] < '0' || psz_serial[i] > '9' )
494
            {
495
                char psz_tmp[16 + 1];
Sam Hocevar's avatar
Sam Hocevar committed
496
497
                sprintf( psz_tmp,
                         "%.2x%.2x%.2x%.2x%.2x%.2x%.2x%.2x",
Michael Roitzsch's avatar
   
Michael Roitzsch committed
498
499
500
                         psz_serial[0], psz_serial[1], psz_serial[2],
                         psz_serial[3], psz_serial[4], psz_serial[5],
                         psz_serial[6], psz_serial[7] );
Sam Hocevar's avatar
Sam Hocevar committed
501
                memcpy( psz_serial, psz_tmp, 16 );
Michael Roitzsch's avatar
   
Michael Roitzsch committed
502
                break;
503
504
505
            }
        }

Sam Hocevar's avatar
Sam Hocevar committed
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
        /* Get disk key, since some discs have got same title, manufacturing
         * date and serial number, but different keys */
        if( dvdcss->b_scrambled )
        {
             psz_key[0] = '-';
             for( i = 0; i < KEY_SIZE; i++ )
             {
                 sprintf( &psz_key[1+i*2], "%.2x", dvdcss->css.p_disc_key[i] );
             }
             psz_key[1 + KEY_SIZE * 2] = '\0';
        }
        else
        {
             psz_key[0] = 0;
        }

522
523
        /* We have a disc name or ID, we can create the cache dir */
        i = sprintf( dvdcss->psz_cachefile, "%s", psz_cache );
524
#if !defined( WIN32 ) || defined( SYS_CYGWIN )
525
        i_ret = mkdir( dvdcss->psz_cachefile, 0755 );
526
527
528
#else
        i_ret = mkdir( dvdcss->psz_cachefile );
#endif
529
530
        if( i_ret < 0 && errno != EEXIST )
        {
531
            print_error( dvdcss, "failed creating cache directory" );
532
533
534
535
            dvdcss->psz_cachefile[0] = '\0';
            goto nocache;
        }

Sam Hocevar's avatar
Sam Hocevar committed
536
537
        i += sprintf( dvdcss->psz_cachefile + i, "/%s-%s%s", psz_title,
                      psz_serial, psz_key );
538
#if !defined( WIN32 ) || defined( SYS_CYGWIN )
539
        i_ret = mkdir( dvdcss->psz_cachefile, 0755 );
540
541
542
#else
        i_ret = mkdir( dvdcss->psz_cachefile );
#endif
543
544
        if( i_ret < 0 && errno != EEXIST )
        {
545
            print_error( dvdcss, "failed creating cache subdirectory" );
546
547
548
            dvdcss->psz_cachefile[0] = '\0';
            goto nocache;
        }
Christopher Richards's avatar
   
Christopher Richards committed
549
        i += sprintf( dvdcss->psz_cachefile + i, "/");
550
551
552
553

        /* Pointer to the filename we will use. */
        dvdcss->psz_block = dvdcss->psz_cachefile + i;

554
555
        print_debug( dvdcss, "using CSS key cache dir: %s",
                             dvdcss->psz_cachefile );
556
557
558
    }
    nocache:

KO Myung-Hun's avatar
KO Myung-Hun committed
559
#if !defined(WIN32) && !defined(SYS_OS2)
Michael Roitzsch's avatar
   
Michael Roitzsch committed
560
561
562
563
564
565
    if( psz_raw_device != NULL )
    {
        _dvdcss_raw_open( dvdcss, psz_raw_device );
    }
#endif

566
567
568
    /* Seek at the beginning, just for safety. */
    dvdcss->pf_seek( dvdcss, 0 );

Sam Hocevar's avatar
 
Sam Hocevar committed
569
570
571
    return dvdcss;
}

572
/**
573
 * \brief Return a string containing the latest error that occurred in the
574
575
576
577
578
579
 *        given \e libdvdcss instance.
 *
 * \param dvdcss a \e libdvdcss instance.
 * \return a null-terminated string containing the latest error message.
 *
 * This function returns a constant string containing the latest error that
580
 * occurred in \e libdvdcss. It can be used to format error messages at your
581
582
 * convenience in your application.
 */
583
LIBDVDCSS_EXPORT char * dvdcss_error ( dvdcss_t dvdcss )
Sam Hocevar's avatar
 
Sam Hocevar committed
584
585
586
587
{
    return dvdcss->psz_error;
}

588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
/**
 * \brief Seek in the disc and change the current key if requested.
 *
 * \param dvdcss a \e libdvdcss instance.
 * \param i_blocks an absolute block offset to seek to.
 * \param i_flags #DVDCSS_NOFLAGS, optionally ored with one of #DVDCSS_SEEK_KEY
 *        or #DVDCSS_SEEK_MPEG.
 * \return the new position in blocks, or a negative value in case an error
 *         happened.
 *
 * This function seeks to the requested position, in logical blocks.
 *
 * You typically set \p i_flags to #DVDCSS_NOFLAGS when seeking in a .IFO.
 *
 * If #DVDCSS_SEEK_MPEG is specified in \p i_flags and if \e libdvdcss finds it
 * reasonable to do so (ie, if the dvdcss method is not "title"), the current
 * title key will be checked and a new one will be calculated if necessary.
 * This flag is typically used when reading data from a VOB.
 *
 * If #DVDCSS_SEEK_KEY is specified, the title key will be always checked,
 * even with the "title" method. This is equivalent to using the now
 * deprecated dvdcss_title() call. This flag is typically used when seeking
 * in a new title.
 */
612
LIBDVDCSS_EXPORT int dvdcss_seek ( dvdcss_t dvdcss, int i_blocks, int i_flags )
Sam Hocevar's avatar
 
Sam Hocevar committed
613
614
615
{
    /* title cracking method is too slow to be used at each seek */
    if( ( ( i_flags & DVDCSS_SEEK_MPEG )
616
             && ( dvdcss->i_method != DVDCSS_METHOD_TITLE ) )
Sam Hocevar's avatar
 
Sam Hocevar committed
617
618
619
       || ( i_flags & DVDCSS_SEEK_KEY ) )
    {
        /* check the title key */
620
        if( _dvdcss_title( dvdcss, i_blocks ) )
Sam Hocevar's avatar
 
Sam Hocevar committed
621
622
623
624
625
        {
            return -1;
        }
    }

626
    return dvdcss->pf_seek( dvdcss, i_blocks );
Sam Hocevar's avatar
 
Sam Hocevar committed
627
628
}

629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
/**
 * \brief Read from the disc and decrypt data if requested.
 *
 * \param dvdcss a \e libdvdcss instance.
 * \param p_buffer a buffer that will contain the data read from the disc.
 * \param i_blocks the amount of blocks to read.
 * \param i_flags #DVDCSS_NOFLAGS, optionally ored with #DVDCSS_READ_DECRYPT.
 * \return the amount of blocks read, or a negative value in case an
 *         error happened.
 *
 * This function reads \p i_blocks logical blocks from the DVD.
 *
 * You typically set \p i_flags to #DVDCSS_NOFLAGS when reading data from a
 * .IFO file on the DVD.
 *
 * If #DVDCSS_READ_DECRYPT is specified in \p i_flags, dvdcss_read() will
 * automatically decrypt scrambled sectors. This flag is typically used when
 * reading data from a .VOB file on the DVD. It has no effect on unscrambled
 * discs or unscrambled sectors, and can be safely used on those.
 *
 * \warning dvdcss_read() expects to be able to write \p i_blocks *
 *          #DVDCSS_BLOCK_SIZE bytes in \p p_buffer.
 */
652
LIBDVDCSS_EXPORT int dvdcss_read ( dvdcss_t dvdcss, void *p_buffer,
653
654
                                          int i_blocks,
                                          int i_flags )
Sam Hocevar's avatar
 
Sam Hocevar committed
655
656
657
{
    int i_ret, i_index;

658
    i_ret = dvdcss->pf_read( dvdcss, p_buffer, i_blocks );
Sam Hocevar's avatar
 
Sam Hocevar committed
659
660

    if( i_ret <= 0
661
         || !dvdcss->b_scrambled
Sam Hocevar's avatar
 
Sam Hocevar committed
662
663
664
665
666
         || !(i_flags & DVDCSS_READ_DECRYPT) )
    {
        return i_ret;
    }

667
    if( ! memcmp( dvdcss->css.p_title_key, "\0\0\0\0\0", 5 ) )
Sam Hocevar's avatar
 
Sam Hocevar committed
668
    {
669
        /* For what we believe is an unencrypted title,
Sam Hocevar's avatar
Sam Hocevar committed
670
         * check that there are no encrypted blocks */
Sam Hocevar's avatar
 
Sam Hocevar committed
671
672
        for( i_index = i_ret; i_index; i_index-- )
        {
673
            if( ((uint8_t*)p_buffer)[0x14] & 0x30 )
Sam Hocevar's avatar
 
Sam Hocevar committed
674
            {
675
                print_error( dvdcss, "no key but found encrypted block" );
Sam Hocevar's avatar
 
Sam Hocevar committed
676
677
                /* Only return the initial range of unscrambled blocks? */
                /* or fail completely? return 0; */
Sam Hocevar's avatar
Sam Hocevar committed
678
                break;
Sam Hocevar's avatar
 
Sam Hocevar committed
679
            }
680
            p_buffer = (void *) ((uint8_t *)p_buffer + DVDCSS_BLOCK_SIZE);
Sam Hocevar's avatar
 
Sam Hocevar committed
681
682
        }
    }
683
    else
Sam Hocevar's avatar
 
Sam Hocevar committed
684
    {
685
686
        /* Decrypt the blocks we managed to read */
        for( i_index = i_ret; i_index; i_index-- )
Sam Hocevar's avatar
Sam Hocevar committed
687
688
689
        {
            _dvdcss_unscramble( dvdcss->css.p_title_key, p_buffer );
            ((uint8_t*)p_buffer)[0x14] &= 0x8f;
690
            p_buffer = (void *) ((uint8_t *)p_buffer + DVDCSS_BLOCK_SIZE);
Sam Hocevar's avatar
Sam Hocevar committed
691
        }
Sam Hocevar's avatar
 
Sam Hocevar committed
692
    }
693

Sam Hocevar's avatar
 
Sam Hocevar committed
694
695
696
    return i_ret;
}

697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
/**
 * \brief Read from the disc into multiple buffers and decrypt data if
 *        requested.
 *
 * \param dvdcss a \e libdvdcss instance.
 * \param p_iovec a pointer to an array of iovec structures that will contain
 *        the data read from the disc.
 * \param i_blocks the amount of blocks to read.
 * \param i_flags #DVDCSS_NOFLAGS, optionally ored with #DVDCSS_READ_DECRYPT.
 * \return the amount of blocks read, or a negative value in case an
 *         error happened.
 *
 * This function reads \p i_blocks logical blocks from the DVD and writes them
 * to an array of iovec structures.
 *
 * You typically set \p i_flags to #DVDCSS_NOFLAGS when reading data from a
 * .IFO file on the DVD.
 *
 * If #DVDCSS_READ_DECRYPT is specified in \p i_flags, dvdcss_readv() will
 * automatically decrypt scrambled sectors. This flag is typically used when
 * reading data from a .VOB file on the DVD. It has no effect on unscrambled
 * discs or unscrambled sectors, and can be safely used on those.
 *
 * \warning dvdcss_readv() expects to be able to write \p i_blocks *
 *          #DVDCSS_BLOCK_SIZE bytes in the buffers pointed by \p p_iovec.
 *          Moreover, all iov_len members of the iovec structures should be
 *          multiples of #DVDCSS_BLOCK_SIZE.
 */
725
LIBDVDCSS_EXPORT int dvdcss_readv ( dvdcss_t dvdcss, void *p_iovec,
726
727
                                           int i_blocks,
                                           int i_flags )
Sam Hocevar's avatar
 
Sam Hocevar committed
728
{
729
    struct iovec *_p_iovec = (struct iovec *)p_iovec;
Sam Hocevar's avatar
 
Sam Hocevar committed
730
731
732
733
    int i_ret, i_index;
    void *iov_base;
    size_t iov_len;

734
    i_ret = dvdcss->pf_readv( dvdcss, _p_iovec, i_blocks );
Sam Hocevar's avatar
 
Sam Hocevar committed
735
736

    if( i_ret <= 0
737
         || !dvdcss->b_scrambled
Sam Hocevar's avatar
 
Sam Hocevar committed
738
739
740
741
742
743
         || !(i_flags & DVDCSS_READ_DECRYPT) )
    {
        return i_ret;
    }

    /* Initialize loop for decryption */
744
745
    iov_base = _p_iovec->iov_base;
    iov_len = _p_iovec->iov_len;
Sam Hocevar's avatar
 
Sam Hocevar committed
746
747
748
749
750
751
752
753
754
755
756
757

    /* Decrypt the blocks we managed to read */
    for( i_index = i_ret; i_index; i_index-- )
    {
        /* Check that iov_len is a multiple of 2048 */
        if( iov_len & 0x7ff )
        {
            return -1;
        }

        while( iov_len == 0 )
        {
758
759
760
            _p_iovec++;
            iov_base = _p_iovec->iov_base;
            iov_len = _p_iovec->iov_len;
Sam Hocevar's avatar
 
Sam Hocevar committed
761
762
        }

763
        _dvdcss_unscramble( dvdcss->css.p_title_key, iov_base );
764
        ((uint8_t*)iov_base)[0x14] &= 0x8f;
Sam Hocevar's avatar
 
Sam Hocevar committed
765

766
        iov_base = (void *) ((uint8_t*)iov_base + DVDCSS_BLOCK_SIZE);
767
        iov_len -= DVDCSS_BLOCK_SIZE;
Sam Hocevar's avatar
 
Sam Hocevar committed
768
769
770
771
772
    }

    return i_ret;
}

773
774
775
776
777
778
779
/**
 * \brief Close the DVD and clean up the library.
 *
 * \param dvdcss a \e libdvdcss instance.
 * \return zero in case of success, a negative value otherwise.
 *
 * This function closes the DVD device and frees all the memory allocated
780
 * by \e libdvdcss. On return, the #dvdcss_t is invalidated and may not be
781
782
 * used again.
 */
783
LIBDVDCSS_EXPORT int dvdcss_close ( dvdcss_t dvdcss )
Sam Hocevar's avatar
 
Sam Hocevar committed
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
{
    dvd_title_t *p_title;
    int i_ret;

    /* Free our list of keys */
    p_title = dvdcss->p_titles;
    while( p_title )
    {
        dvd_title_t *p_tmptitle = p_title->p_next;
        free( p_title );
        p_title = p_tmptitle;
    }

    i_ret = _dvdcss_close( dvdcss );

    if( i_ret < 0 )
    {
        return i_ret;
    }

804
    free( dvdcss->psz_device );
Sam Hocevar's avatar
 
Sam Hocevar committed
805
806
807
808
809
    free( dvdcss );

    return 0;
}

810
811
812
813
/*
 *  Deprecated. See dvdcss_seek().
 */
#undef dvdcss_title
814
LIBDVDCSS_EXPORT int dvdcss_title ( dvdcss_t dvdcss, int i_block )
815
816
817
818
{
    return _dvdcss_title( dvdcss, i_block );
}

819
820
821
822
823
824
825
826
827
828
829
830
/**
 * \brief Return 1 if the DVD is scrambled, 0 otherwise.
 *
 * \param dvdcss a \e libdvdcss instance.
 * \return 1 if the DVD is scrambled, 0 otherwise.
 *
 * This function returns whether the DVD is scrambled.
 */
LIBDVDCSS_EXPORT int dvdcss_is_scrambled ( dvdcss_t dvdcss )
{
    return dvdcss->b_scrambled;
}
Ivan Kalvachev's avatar
   
Ivan Kalvachev committed
831