libdvdcss.c 23.8 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
8
 *
9
 * libdvdcss is free software; you can redistribute it and/or modify
Sam Hocevar's avatar
 
Sam Hocevar committed
10
11
12
 * 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
 * libdvdcss is distributed in the hope that it will be useful,
Sam Hocevar's avatar
 
Sam Hocevar committed
15
16
17
18
 * 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
19
 * You should have received a copy of the GNU General Public License along
20
 * with libdvdcss; if not, write to the Free Software Foundation, Inc.,
Diego Biurrun's avatar
Diego Biurrun committed
21
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
22
23
 */

24
/**
25
26
27
28
29
30
31
 * \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:
32
 * \li portability: Currently supported platforms are GNU/Linux, FreeBSD,
33
 *     NetBSD, OpenBSD, Haiku, Mac OS X, Solaris, QNX, OS/2, and Windows
34
 *     NT 4.0 SP4 (with IE 5.0) or later.
35
 * \li adaptability: Unlike most similar projects, libdvdcss does not require
36
37
 *     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.
38
 * \li simplicity: A DVD player can be built around the \e libdvdcss API using
39
40
 *     no more than 4 or 5 library calls.
 *
41
 * \e libdvdcss is free software, released under the GNU General Public License.
42
43
44
45
46
47
48
49
50
51
 * 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
 *
52
 * Some environment variables can be used to change the behavior of
53
54
55
 * \e libdvdcss without having to modify the program which uses it. These
 * variables are:
 *
56
 * \li \b DVDCSS_VERBOSE: Sets the verbosity level.
57
58
59
60
 *     - \c 0 outputs no messages at all.
 *     - \c 1 outputs error messages to stderr.
 *     - \c 2 outputs error messages and debug messages to stderr.
 *
61
 * \li \b DVDCSS_METHOD: Sets the authentication and decryption method
62
63
64
65
66
67
68
69
70
71
72
 *     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
73
 *       crypto attack to guess the title key. In rare cases this may fail
74
 *       because there is not enough encrypted data on the disc to perform
75
 *       a statistical attack, but on the other hand it is the only way to
76
77
78
 *       decrypt a DVD stored on a hard disc, or a DVD with the wrong region
 *       on an RPC2 drive.
 *
79
 * \li \b DVDCSS_RAW_DEVICE: Specify the raw device to use. Exact usage will
80
81
82
83
 *     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).
84
 *
85
 * \li \b DVDCSS_CACHE: Specify a directory in which to cache title key
86
87
88
 *     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
89
90
91
92
 *     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.
93
 */
Sam Hocevar's avatar
 
Sam Hocevar committed
94

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

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

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

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

122
123
124
125
#if defined(_WIN32_IE) && _WIN32_IE >= 0x500
#   include <shlobj.h>
#endif

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

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

134
#ifdef HAVE_BROKEN_MKDIR
135
#include <direct.h>
136
137
138
#define mkdir(a, b) _mkdir(a)
#endif

139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
static void set_verbosity( dvdcss_t dvdcss )
{
    const char *psz_verbose = getenv( "DVDCSS_VERBOSE" );

    dvdcss->b_debug  = 0;
    dvdcss->b_errors = 0;

    if( psz_verbose != NULL )
    {
        int i = atoi( psz_verbose );

        if( i >= 2 )
            dvdcss->b_debug  = 1;
        if( i >= 1 )
            dvdcss->b_errors = 1;
    }
}

157
158
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
static int set_access_method( dvdcss_t dvdcss )
{
    const char *psz_method = getenv( "DVDCSS_METHOD" );

    if( !psz_method )
        return 0;

    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
    {
        print_error( dvdcss, "unknown decrypt method, please choose "
                     "from 'title', 'key' or 'disc'" );
        return -1;
    }
    return 0;
}

185
186
187
188
/**
 * \brief Open a DVD device or directory and return a dvdcss instance.
 *
 * \param psz_target a string containing the target name, for instance
189
 *        "/dev/hdc" or "E:"
190
191
 * \return a handle to a dvdcss instance or NULL on error.
 *
192
193
194
 * Initialize the \e libdvdcss library, open the requested DVD device or
 * directory, and return a handle to be used for all subsequent \e libdvdcss
 * calls. \e libdvdcss checks whether ioctls can be performed on the disc,
195
196
 * and when possible, the disc key is retrieved.
 */
197
LIBDVDCSS_EXPORT dvdcss_t dvdcss_open ( const char *psz_target )
Sam Hocevar's avatar
 
Sam Hocevar committed
198
199
200
{
    int i_ret;

201
    const char *psz_cache = getenv( "DVDCSS_CACHE" );
202
#ifdef DVDCSS_RAW_OPEN
203
    const char *psz_raw_device = getenv( "DVDCSS_RAW_DEVICE" );
Sam Hocevar's avatar
 
Sam Hocevar committed
204
205
#endif

206
    /* Allocate the library structure. */
207
    dvdcss_t dvdcss = malloc( sizeof( *dvdcss ) );
Sam Hocevar's avatar
 
Sam Hocevar committed
208
209
210
211
212
    if( dvdcss == NULL )
    {
        return NULL;
    }

213
    /* Initialize structure with default values. */
214
#ifdef DVDCSS_RAW_OPEN
215
    dvdcss->i_raw_fd = -1;
216
#endif
Sam Hocevar's avatar
 
Sam Hocevar committed
217
    dvdcss->p_titles = NULL;
218
    dvdcss->psz_device = strdup( psz_target );
Sam Hocevar's avatar
 
Sam Hocevar committed
219
    dvdcss->psz_error = "no error";
220
    dvdcss->i_method = DVDCSS_METHOD_KEY;
221
    dvdcss->psz_cachefile[0] = '\0';
Sam Hocevar's avatar
 
Sam Hocevar committed
222

223
    /* Set library verbosity from DVDCSS_VERBOSE environment variable. */
224
    set_verbosity( dvdcss );
225

226
    /* Set DVD access method from DVDCSS_METHOD environment variable. */
227
    if( set_access_method( dvdcss ) < 0 )
Sam Hocevar's avatar
 
Sam Hocevar committed
228
    {
229
        goto error;
Sam Hocevar's avatar
 
Sam Hocevar committed
230
231
    }

232
    /* Set CSS key cache directory. */
233
234
    if( psz_cache == NULL || psz_cache[0] == '\0' )
    {
235
#if defined(_WIN32_IE) && _WIN32_IE >= 0x500
236
        char psz_home[PATH_MAX];
237
238
239

        /* Cache our keys in
         * C:\Documents and Settings\$USER\Application Data\dvdcss\ */
240
241
        if (SHGetFolderPathA (NULL, CSIDL_APPDATA | CSIDL_FLAG_CREATE,
                              NULL, SHGFP_TYPE_CURRENT, psz_home ) == S_OK)
242
        {
243
244
245
            snprintf( dvdcss->psz_cachefile, PATH_MAX, "%s\\dvdcss", psz_home );
            dvdcss->psz_cachefile[PATH_MAX - 1] = '\0';
            psz_cache = dvdcss->psz_cachefile;
246
247
248
        }
#else
        char *psz_home = NULL;
249
#ifdef HAVE_PWD_H
250
251
252
253
254
255
256
257
        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;
        }
258
#endif /* HAVE_PWD_H */
259
260
261
262
263

        if( psz_home == NULL )
        {
            psz_home = getenv( "HOME" );
        }
264
265
266
267
        if( psz_home == NULL )
        {
            psz_home = getenv( "USERPROFILE" );
        }
268
269
270
271

        /* Cache our keys in ${HOME}/.dvdcss/ */
        if( psz_home )
        {
KO Myung-Hun's avatar
KO Myung-Hun committed
272
273
            int home_pos = 0;

274
#ifdef __OS2__
KO Myung-Hun's avatar
KO Myung-Hun committed
275
276
            if( *psz_home == '/' || *psz_home == '\\')
            {
277
                const char *psz_unixroot = getenv("UNIXROOT");
KO Myung-Hun's avatar
KO Myung-Hun committed
278
279
280
281
282
283

                if( psz_unixroot &&
                    psz_unixroot[0] &&
                    psz_unixroot[1] == ':'  &&
                    psz_unixroot[2] == '\0')
                {
284
                    strcpy( dvdcss->psz_cachefile, psz_unixroot );
KO Myung-Hun's avatar
KO Myung-Hun committed
285
286
287
                    home_pos = 2;
                }
            }
288
#endif /* __OS2__ */
289
            snprintf( dvdcss->psz_cachefile + home_pos, PATH_MAX - home_pos,
KO Myung-Hun's avatar
KO Myung-Hun committed
290
                      "%s/.dvdcss", psz_home );
291
292
            dvdcss->psz_cachefile[PATH_MAX - 1] = '\0';
            psz_cache = dvdcss->psz_cachefile;
293
        }
294
#endif /* ! defined(_WIN32_IE) && _WIN32_IE >= 0x500 */
295
296
    }

297
    /* Sanity check psz_cache value. */
298
299
    if( psz_cache != NULL )
    {
300
        if( psz_cache[0] == '\0' || !strcmp( psz_cache, "off" ) )
301
302
303
304
        {
            psz_cache = NULL;
        }
        /* Check that we can add the ID directory and the block filename */
Sam Hocevar's avatar
Sam Hocevar committed
305
306
        else if( strlen( psz_cache ) + 1 + 32 + 1 + (KEY_SIZE * 2) + 10 + 1
                  > PATH_MAX )
307
        {
308
            print_error( dvdcss, "cache directory name is too long" );
309
310
311
312
            psz_cache = NULL;
        }
    }

313
    /* Open device. */
314
315
    dvdcss_check_device( dvdcss );
    i_ret = dvdcss_open_device( dvdcss );
Sam Hocevar's avatar
 
Sam Hocevar committed
316
317
    if( i_ret < 0 )
    {
318
        goto error;
Sam Hocevar's avatar
 
Sam Hocevar committed
319
    }
320

321
    dvdcss->b_scrambled = 1; /* Assume the worst */
322
    dvdcss->b_ioctls = dvdcss_use_ioctls( dvdcss );
Sam Hocevar's avatar
 
Sam Hocevar committed
323

324
    if( dvdcss->b_ioctls )
Sam Hocevar's avatar
 
Sam Hocevar committed
325
    {
326
        i_ret = dvdcss_test( dvdcss );
327

328
        if( i_ret == -3 )
329
        {
330
331
332
            print_debug( dvdcss, "scrambled disc on a region-free RPC-II "
                                 "drive: possible failure, but continuing "
                                 "anyway" );
333
334
        }
        else if( i_ret < 0 )
Sam Hocevar's avatar
Sam Hocevar committed
335
336
        {
            /* Disable the CSS ioctls and hope that it works? */
337
338
            print_debug( dvdcss,
                         "could not check whether the disc was scrambled" );
Sam Hocevar's avatar
Sam Hocevar committed
339
340
341
342
            dvdcss->b_ioctls = 0;
        }
        else
        {
343
344
            print_debug( dvdcss, i_ret ? "disc is scrambled"
                                       : "disc is unscrambled" );
Sam Hocevar's avatar
Sam Hocevar committed
345
346
            dvdcss->b_scrambled = i_ret;
        }
Sam Hocevar's avatar
 
Sam Hocevar committed
347
348
    }

349
    memset( dvdcss->css.p_disc_key, 0, KEY_SIZE );
Sam Hocevar's avatar
 
Sam Hocevar committed
350
    /* If disc is CSS protected and the ioctls work, authenticate the drive */
351
    if( dvdcss->b_scrambled && dvdcss->b_ioctls )
Sam Hocevar's avatar
 
Sam Hocevar committed
352
    {
353
        i_ret = dvdcss_disckey( dvdcss );
Sam Hocevar's avatar
 
Sam Hocevar committed
354
355
356

        if( i_ret < 0 )
        {
357
            print_debug( dvdcss, "could not get disc key" );
Sam Hocevar's avatar
 
Sam Hocevar committed
358
359
360
        }
    }

Sam Hocevar's avatar
Sam Hocevar committed
361
362
363
    /* If the cache is enabled, write the cache directory tag */
    if( psz_cache )
    {
364
365
        static const char psz_tag[] =
            "Signature: 8a477f597d28d172789f06886806bc55\r\n"
Sam Hocevar's avatar
Sam Hocevar committed
366
367
368
            "# 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";
369
        char psz_tagfile[PATH_MAX + 1 + 12 + 1];
Sam Hocevar's avatar
Sam Hocevar committed
370
371
        int i_fd;

372
373
374
375
376
377
378
        i_ret = mkdir( psz_cache, 0755 );
        if( i_ret < 0 && errno != EEXIST )
        {
            print_error( dvdcss, "failed creating cache directory" );
            goto nocache;
        }

Sam Hocevar's avatar
Sam Hocevar committed
379
        sprintf( psz_tagfile, "%s/CACHEDIR.TAG", psz_cache );
Sam Hocevar's avatar
Sam Hocevar committed
380
        i_fd = open( psz_tagfile, O_RDWR|O_CREAT, 0644 );
Sam Hocevar's avatar
Sam Hocevar committed
381
382
        if( i_fd >= 0 )
        {
383
384
            ssize_t len = strlen(psz_tag);
            if( write( i_fd, psz_tag, len ) < len )
385
386
387
388
            {
                print_error( dvdcss,
                             "Error writing cache directory tag, continuing..\n" );
            }
Sam Hocevar's avatar
Sam Hocevar committed
389
390
391
392
            close( i_fd );
        }
    }

393
394
395
    /* If the cache is enabled, extract a unique disc ID */
    if( psz_cache )
    {
396
        uint8_t p_sector[DVDCSS_BLOCK_SIZE];
397
        char psz_key[1 + KEY_SIZE * 2 + 1];
Ivan Kalvachev's avatar
   
Ivan Kalvachev committed
398
399
        char *psz_title;
        uint8_t *psz_serial;
400
401
        int i;

402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
        /* 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;
        }

423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
        /* 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 */
440
        psz_title = (char *)p_sector + 40;
Michael Roitzsch's avatar
   
Michael Roitzsch committed
441
        psz_title[32] = '\0';
442
443
444

        for( i = 0 ; i < 32 ; i++ )
        {
Michael Roitzsch's avatar
   
Michael Roitzsch committed
445
            if( psz_title[i] <= ' ' )
446
            {
Michael Roitzsch's avatar
   
Michael Roitzsch committed
447
                psz_title[i] = '\0';
448
449
                break;
            }
Michael Roitzsch's avatar
   
Michael Roitzsch committed
450
            else if( psz_title[i] == '/' || psz_title[i] == '\\' )
451
            {
Michael Roitzsch's avatar
   
Michael Roitzsch committed
452
                psz_title[i] = '-';
453
454
455
            }
        }

Michael Roitzsch's avatar
   
Michael Roitzsch committed
456
        /* Get the date + serial */
Ivan Kalvachev's avatar
   
Ivan Kalvachev committed
457
        psz_serial = p_sector + 813;
Michael Roitzsch's avatar
   
Michael Roitzsch committed
458
        psz_serial[16] = '\0';
459

Michael Roitzsch's avatar
   
Michael Roitzsch committed
460
461
462
463
        /* Check that all characters are digits, otherwise convert. */
        for( i = 0 ; i < 16 ; i++ )
        {
            if( psz_serial[i] < '0' || psz_serial[i] > '9' )
464
            {
465
                char psz_tmp[16 + 1];
Sam Hocevar's avatar
Sam Hocevar committed
466
467
                sprintf( psz_tmp,
                         "%.2x%.2x%.2x%.2x%.2x%.2x%.2x%.2x",
Michael Roitzsch's avatar
   
Michael Roitzsch committed
468
469
470
                         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
471
                memcpy( psz_serial, psz_tmp, 16 );
Michael Roitzsch's avatar
   
Michael Roitzsch committed
472
                break;
473
474
475
            }
        }

476
477
        /* Get disk key, since some discs have the same title, manufacturing
         * date and serial number, but different keys. */
Sam Hocevar's avatar
Sam Hocevar committed
478
479
480
481
        if( dvdcss->b_scrambled )
        {
             for( i = 0; i < KEY_SIZE; i++ )
             {
482
                 sprintf( &psz_key[i * 2], "%.2x", dvdcss->css.p_disc_key[i] );
Sam Hocevar's avatar
Sam Hocevar committed
483
             }
484
             psz_key[KEY_SIZE * 2] = '\0';
Sam Hocevar's avatar
Sam Hocevar committed
485
486
487
488
489
490
        }
        else
        {
             psz_key[0] = 0;
        }

491
        /* We have a disc name or ID, we can create the cache subdirectory. */
492
        i = sprintf( dvdcss->psz_cachefile, "%s/%s-%s-%s",
493
                     psz_cache, psz_title, psz_serial, psz_key );
494
495
496
        i_ret = mkdir( dvdcss->psz_cachefile, 0755 );
        if( i_ret < 0 && errno != EEXIST )
        {
497
            print_error( dvdcss, "failed creating cache subdirectory" );
498
499
500
            dvdcss->psz_cachefile[0] = '\0';
            goto nocache;
        }
Christopher Richards's avatar
   
Christopher Richards committed
501
        i += sprintf( dvdcss->psz_cachefile + i, "/");
502
503
504
505

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

506
507
        print_debug( dvdcss, "using CSS key cache dir: %s",
                             dvdcss->psz_cachefile );
508
509
510
    }
    nocache:

511
#ifdef DVDCSS_RAW_OPEN
Michael Roitzsch's avatar
   
Michael Roitzsch committed
512
513
    if( psz_raw_device != NULL )
    {
514
        dvdcss_raw_open( dvdcss, psz_raw_device );
Michael Roitzsch's avatar
   
Michael Roitzsch committed
515
    }
516
#endif /* DVDCSS_RAW_OPEN */
Michael Roitzsch's avatar
   
Michael Roitzsch committed
517

518
    /* Seek to the beginning, just for safety. */
519
520
    dvdcss->pf_seek( dvdcss, 0 );

Sam Hocevar's avatar
 
Sam Hocevar committed
521
    return dvdcss;
522
523
524
525
526

error:
    free( dvdcss->psz_device );
    free( dvdcss );
    return NULL;
Sam Hocevar's avatar
 
Sam Hocevar committed
527
528
}

529
/**
530
 * \brief Return a string containing the last error that occurred in the
531
532
 *        given \e libdvdcss instance.
 *
533
534
 * \param dvdcss a \e libdvdcss instance
 * \return a NULL-terminated string containing the last error message.
535
 *
536
537
 * Return a string with the last error message produced by \e libdvdcss.
 * Useful to conveniently format error messages in external applications.
538
 */
539
LIBDVDCSS_EXPORT char * dvdcss_error ( dvdcss_t dvdcss )
Sam Hocevar's avatar
 
Sam Hocevar committed
540
541
542
543
{
    return dvdcss->psz_error;
}

544
545
546
/**
 * \brief Seek in the disc and change the current key if requested.
 *
547
548
 * \param dvdcss a \e libdvdcss instance
 * \param i_blocks an absolute block offset to seek to
549
 * \param i_flags #DVDCSS_NOFLAGS, optionally ORed with one of #DVDCSS_SEEK_KEY
550
551
 *        or #DVDCSS_SEEK_MPEG
 * \return the new position in blocks or a negative value in case an error
552
553
554
555
556
557
558
 *         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
559
 * reasonable to do so (i.e., if the dvdcss method is not "title"), the current
560
 * title key will be checked and a new one will be calculated if necessary.
561
 * This flag is typically used when reading data from a .VOB file.
562
 *
563
 * If #DVDCSS_SEEK_KEY is specified, the title key will always be checked,
564
 * even with the "title" method. This flag is typically used when seeking
565
566
 * in a new title.
 */
567
LIBDVDCSS_EXPORT int dvdcss_seek ( dvdcss_t dvdcss, int i_blocks, int i_flags )
Sam Hocevar's avatar
 
Sam Hocevar committed
568
569
570
{
    /* title cracking method is too slow to be used at each seek */
    if( ( ( i_flags & DVDCSS_SEEK_MPEG )
571
             && ( dvdcss->i_method != DVDCSS_METHOD_TITLE ) )
Sam Hocevar's avatar
 
Sam Hocevar committed
572
573
574
       || ( i_flags & DVDCSS_SEEK_KEY ) )
    {
        /* check the title key */
575
        if( dvdcss_title( dvdcss, i_blocks ) )
Sam Hocevar's avatar
 
Sam Hocevar committed
576
577
578
579
580
        {
            return -1;
        }
    }

581
    return dvdcss->pf_seek( dvdcss, i_blocks );
Sam Hocevar's avatar
 
Sam Hocevar committed
582
583
}

584
585
586
/**
 * \brief Read from the disc and decrypt data if requested.
 *
587
588
589
590
591
 * \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
592
593
 *         error happened.
 *
594
 * Read \p i_blocks logical blocks from the DVD.
595
596
597
598
599
600
601
 *
 * 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
602
 * discs or unscrambled sectors and can be safely used on those.
603
604
 *
 * \warning dvdcss_read() expects to be able to write \p i_blocks *
605
 *          #DVDCSS_BLOCK_SIZE bytes into \p p_buffer.
606
 */
607
LIBDVDCSS_EXPORT int dvdcss_read ( dvdcss_t dvdcss, void *p_buffer,
608
609
                                          int i_blocks,
                                          int i_flags )
Sam Hocevar's avatar
 
Sam Hocevar committed
610
611
612
{
    int i_ret, i_index;

613
    i_ret = dvdcss->pf_read( dvdcss, p_buffer, i_blocks );
Sam Hocevar's avatar
 
Sam Hocevar committed
614
615

    if( i_ret <= 0
616
         || !dvdcss->b_scrambled
Sam Hocevar's avatar
 
Sam Hocevar committed
617
618
619
620
621
         || !(i_flags & DVDCSS_READ_DECRYPT) )
    {
        return i_ret;
    }

622
    if( ! memcmp( dvdcss->css.p_title_key, "\0\0\0\0\0", 5 ) )
Sam Hocevar's avatar
 
Sam Hocevar committed
623
    {
624
        /* For what we believe is an unencrypted title,
Sam Hocevar's avatar
Sam Hocevar committed
625
         * check that there are no encrypted blocks */
Sam Hocevar's avatar
 
Sam Hocevar committed
626
627
        for( i_index = i_ret; i_index; i_index-- )
        {
628
            if( ((uint8_t*)p_buffer)[0x14] & 0x30 )
Sam Hocevar's avatar
 
Sam Hocevar committed
629
            {
630
                print_error( dvdcss, "no key but found encrypted block" );
Sam Hocevar's avatar
 
Sam Hocevar committed
631
632
                /* Only return the initial range of unscrambled blocks? */
                /* or fail completely? return 0; */
Sam Hocevar's avatar
Sam Hocevar committed
633
                break;
Sam Hocevar's avatar
 
Sam Hocevar committed
634
            }
635
            p_buffer = (uint8_t *)p_buffer + DVDCSS_BLOCK_SIZE;
Sam Hocevar's avatar
 
Sam Hocevar committed
636
637
        }
    }
638
    else
Sam Hocevar's avatar
 
Sam Hocevar committed
639
    {
640
641
        /* Decrypt the blocks we managed to read */
        for( i_index = i_ret; i_index; i_index-- )
Sam Hocevar's avatar
Sam Hocevar committed
642
        {
643
            dvdcss_unscramble( dvdcss->css.p_title_key, p_buffer );
Sam Hocevar's avatar
Sam Hocevar committed
644
            ((uint8_t*)p_buffer)[0x14] &= 0x8f;
645
            p_buffer = (uint8_t *)p_buffer + DVDCSS_BLOCK_SIZE;
Sam Hocevar's avatar
Sam Hocevar committed
646
        }
Sam Hocevar's avatar
 
Sam Hocevar committed
647
    }
648

Sam Hocevar's avatar
 
Sam Hocevar committed
649
650
651
    return i_ret;
}

652
/**
653
 * \brief Read data from the disc into multiple buffers and decrypt data if
654
655
 *        requested.
 *
656
 * \param dvdcss a \e libdvdcss instance
657
 * \param p_iovec a pointer to an array of iovec structures that will contain
658
659
660
661
 *        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
662
663
 *         error happened.
 *
664
 * Read \p i_blocks logical blocks from the DVD and write them
665
666
667
668
669
670
671
672
 * 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
673
 * discs or unscrambled sectors and can be safely used on those.
674
675
 *
 * \warning dvdcss_readv() expects to be able to write \p i_blocks *
676
 *          #DVDCSS_BLOCK_SIZE bytes into the buffers pointed by \p p_iovec.
677
678
679
 *          Moreover, all iov_len members of the iovec structures should be
 *          multiples of #DVDCSS_BLOCK_SIZE.
 */
680
LIBDVDCSS_EXPORT int dvdcss_readv ( dvdcss_t dvdcss, void *p_iovec,
681
682
                                           int i_blocks,
                                           int i_flags )
Sam Hocevar's avatar
 
Sam Hocevar committed
683
{
684
    struct iovec *_p_iovec = p_iovec;
Sam Hocevar's avatar
 
Sam Hocevar committed
685
686
687
688
    int i_ret, i_index;
    void *iov_base;
    size_t iov_len;

689
    i_ret = dvdcss->pf_readv( dvdcss, _p_iovec, i_blocks );
Sam Hocevar's avatar
 
Sam Hocevar committed
690
691

    if( i_ret <= 0
692
         || !dvdcss->b_scrambled
Sam Hocevar's avatar
 
Sam Hocevar committed
693
694
695
696
697
698
         || !(i_flags & DVDCSS_READ_DECRYPT) )
    {
        return i_ret;
    }

    /* Initialize loop for decryption */
699
700
    iov_base = _p_iovec->iov_base;
    iov_len = _p_iovec->iov_len;
Sam Hocevar's avatar
 
Sam Hocevar committed
701
702
703
704
705
706
707
708
709
710
711
712

    /* 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 )
        {
713
714
715
            _p_iovec++;
            iov_base = _p_iovec->iov_base;
            iov_len = _p_iovec->iov_len;
Sam Hocevar's avatar
 
Sam Hocevar committed
716
717
        }

718
        dvdcss_unscramble( dvdcss->css.p_title_key, iov_base );
719
        ((uint8_t*)iov_base)[0x14] &= 0x8f;
Sam Hocevar's avatar
 
Sam Hocevar committed
720

721
        iov_base = (uint8_t*)iov_base + DVDCSS_BLOCK_SIZE;
722
        iov_len -= DVDCSS_BLOCK_SIZE;
Sam Hocevar's avatar
 
Sam Hocevar committed
723
724
725
726
727
    }

    return i_ret;
}

728
/**
729
 * \brief Clean up library state and structures.
730
 *
731
 * \param dvdcss a \e libdvdcss instance
732
733
 * \return zero in case of success, a negative value otherwise.
 *
734
735
 * Close the DVD device and free all the memory allocated by \e libdvdcss.
 * On return, the #dvdcss_t is invalidated and may not be used again.
736
 */
737
LIBDVDCSS_EXPORT int dvdcss_close ( dvdcss_t dvdcss )
Sam Hocevar's avatar
 
Sam Hocevar committed
738
739
740
741
742
743
744
745
746
747
748
749
750
{
    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;
    }

751
    i_ret = dvdcss_close_device( dvdcss );
Sam Hocevar's avatar
 
Sam Hocevar committed
752
753
754
755
756
757

    if( i_ret < 0 )
    {
        return i_ret;
    }

758
    free( dvdcss->psz_device );
Sam Hocevar's avatar
 
Sam Hocevar committed
759
760
761
762
763
    free( dvdcss );

    return 0;
}

764
/**
765
 * \brief Detect whether or not a DVD is scrambled
766
767
768
769
770
771
772
773
 *
 * \param dvdcss a \e libdvdcss instance.
 * \return 1 if the DVD is scrambled, 0 otherwise.
 */
LIBDVDCSS_EXPORT int dvdcss_is_scrambled ( dvdcss_t dvdcss )
{
    return dvdcss->b_scrambled;
}